HTML-AutoTag 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28724c56df2f0e66243bc3042c3798af380edcbc
-  data.tar.gz: 6abfeb49b8548f994d508fa3ff4e0c8f072a1c8a
+  metadata.gz: fb83f536fbdc2af2549f681476bffd8a32dca63a
+  data.tar.gz: 329e0118abbc2912b8e3e0a86d1d337d789430f0
 SHA512:
-  metadata.gz: 35d3838467c0fb0fed4571e3cc86a7bfecba7b0f898ea24a64b21fce8b3526d4a2b2499cd7bdfe0040d1b52e9761bd742306f22de45f394f470ec50f7279551d
-  data.tar.gz: 7b2851ccad5bc32183932507df0d3317a9e8212c579f02762670b6f257ca11c063d72ddf9ebbc57332f2ddc650a9fc295841aa184646155b1de3ad6a9b86ef99
+  metadata.gz: 80bc6faa0dcb51294abc07acfe8017db7e0868d75a0a346449d78976d433e49635e144606d37306b0a3c92fc6c3337185465682750afec419b7e221bdd8e73d6
+  data.tar.gz: 11b7b16d6e36c54c582122dc2130a0510b99b6a3295ebf43619fb2c264e0f332ed7a1e766ed4f4c88c6dba10f9d6ef10b86b78028f6b7d3daeeb8a904dacacbc

data/Changes

@@ -1,6 +1,10 @@
 Revision history for html-autotag-ruby
 
+1.0.0
+    - ready for production
+
 0.0.6
+    - fixed attr bug for deeply nested data structures
 
 0.0.5
     - fixed encode bug (basic encoding works)

data/lib/HTML/AutoAttr.rb

@@ -4,11 +4,20 @@ module HTML
 
         attr_accessor 'hash', 'sorted'
 
+        # expects the following arguments
+        #   * hash
+        #       Contains attribute keys and values
+        #
+        #   * sorted
+        #       Boolean. Whether or not to render attributes in alphabetical order.
+        #
         def initialize( hash = {}, sorted = 0 )
             @hash   = hash
             @sorted = sorted
         end
 
+        # expects no arguments, emits string containing rendered key/value pairs
+        #
         def to_s
 
             return '' unless @hash.kind_of?( Hash )
@@ -29,24 +38,29 @@ module HTML
             return str
         end
 
+        # expects one argument: the key to scrub
         def key( key )
             key = key.gsub( /\s+/, '' )
             key = key.gsub( /["'>=\/]/, '' )
             return key
         end
 
+        # expects one argument: the value to scrub
         def val( val )
             return '' if val.match( /^\s+$/ )
             val = val.gsub( /"/, '' )
             return val
         end
 
+        # expects one argument: the array to rotate
+        # returns the first element before array is rotated
         def rotate( array )
             val = array.shift
             array.push( val )
             return val
         end
 
+        # expects one argument: the hash to 'stringify'
         def stringify( hash )
 
             keys = @sorted ? hash.keys.sort : hash.keys
@@ -75,15 +89,6 @@ end
 
 HTML::AutoAttr - Just another HTML attribute generator.
 
-== SYNOPSIS
-
-<code>
-require 'HTML/AutoAttr'
-attr = HTML::AutoAttr.new( { 'foo' => ['bar','baz','qux'] } )
-
-4.times { puts attr.to_s }
-</code>
-
 == DESCRIPTION
 
 This module will translate nested hash keys and values into HTML

data/lib/HTML/AutoTag/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class AutoTag
-    VERSION = "0.0.6"
+    VERSION = "1.0.0"
   end
 end

data/lib/HTML/AutoTag.rb

@@ -8,6 +8,19 @@ module HTML
 
         attr_accessor 'encodes', 'indent', 'level', 'sorted', 'newline'
 
+        # params expects the following keys:
+        #   * encodes
+        #       Endcode HTML entities. (boolean)
+        #
+        #   * indent
+        #       Pretty print results. (string)
+        #
+        #   * level
+        #       Indentation level to start at. (integer)
+        #
+        #   * sorted
+        #
+        Sort attribute names of the tag alphabetically. (boolean)
         def initialize( params = {} )
             @encodes    = params['encodes'] ? 1 : 0
             @indent     = params['indent']  || ''
@@ -17,6 +30,20 @@ module HTML
             @encoder    = HTMLEntities.new
         end
 
+        # params expects the following keys:
+        #
+        #   * tag
+        #       The name of the tag. (string)
+        #
+        #   * attr
+        #       Attributes and values for the tag (hash)
+        #
+        #   * cdata
+        #       The value wrapped by the tag. Types allowed are:
+        #       * scalar - the string to be wrapped by the tag
+        #       * hash - another tag with its own cdata and attributes
+        #       * array - list of scalars or list of more hashes
+        #
         def tag( params = {} )
 
             if params['attr'].kind_of?( HTML::AutoAttr )
@@ -80,106 +107,11 @@ end
 
 HTML::AutoTag - Just another HTML tag generator.
 
-== SYNOPSIS
-
-<code>
-require 'HTML/AutoTag'
-tag = HTML::AutoTag.new
-
-puts auto.tag( 'tag' => 'hr' )
-puts auto.tag( 'tag' => 'h1', 'cdata' => 'heading' )
-puts auto.tag( 'tag' => 'p', 'cdata' => 'paragraph', 'attr' => { 'class' => 'para' } )
-
-puts auto.tag(
-    'tag'   => 'ol',
-    'attr'  => { 'reversed' => 'reversed' },
-    'cdata' => data.map{ |d| { 'tag' => 'li', 'attr' => attr, 'cdata' => d } }
-)
-
-puts auto.tag(
-    'tag'   => 'table',
-    'attr'  => { 'class' => 'spreadsheet' },
-    'cdata' => Array[
-        {
-            'tag'   => 'tr',
-            'attr'  => tr_attr,
-            'cdata' => {
-                'tag'  => 'th',
-                'attr' => { 'style' => { 'color' => %w{ red green } } },
-                'cdata' => data,
-            },
-        },
-        {
-            'tag'   => 'tr',
-            'attr'  => tr_attr,
-            'cdata' => {
-                'tag'  => 'td',
-                'attr' => { 'style' => { 'color' => %w{ green blue } } },
-                'cdata' => data,
-            },
-        },
-        {
-            'tag'   => 'tr',
-            'attr'  => tr_attr,
-            'cdata' => {
-                'tag'  => 'td',
-                'attr' => { 'style' => { 'color' => %w{ red green } } },
-                'cdata' => data,
-            },
-        },
-    ]
-)
-</code>
-
 == DESCRIPTION
 
 Generate nested HTML (HTML4, XHTML and HTML5) tags with custom indentation,
 custom encoding and automatic attribute value rotation.
 
-== METHODS
-
-* new
-
-Accepts 4 arguments:
-
-    * encodes
-
-        Endcode HTML entities. (boolean)
-
-    * indent
-
-        Pretty print results. (string)
-
-    * level
-
-        Indentation level to start at. (integer)
-
-    * sorted
-
-        Sort attribute names of the tag alphabetically. (boolean)
-
-* tag
-
-Accepts 3 arguments:
-
-    * tag
-
-        The name of the tag. (string)
-
-    * attr
-
-        Attributes and values for the tag (hash)
-
-    * cdata
-
-        The value wrapped by the tag. Types allowed are:
-
-        * scalar - the string to be wrapped by the tag
-
-        * hash - another tag with its own cdata and attributes
-
-        * array - list of scalars or list of more hashes
-
 == SEE ALSO
 
 * http://www.w3.org/TR/html5/syntax.html

data/readme.md

@@ -10,26 +10,68 @@ Synopsis
 --------
 ```ruby
 require 'HTML/AutoTag'
+auto = HTML::AutoTag.new
 
-auto = HTML::AutoTag.new( 'indent' => '    ' )
-
-puts auto.tag( 'tag' => 'p', 'cdata' => 'a paragraph' )
-
-attr = { 'style' => { 'color' => %w{ red green } } }
-data = %w{ one two three four five six seven eight }
+puts auto.tag( 'tag' => 'hr' )
+puts auto.tag( 'tag' => 'h1', 'cdata' => 'heading' )
+puts auto.tag( 'tag' => 'p', 'cdata' => 'paragraph', 'attr' => { 'class' => 'para' } )
 
+attr = { 'style' => { 'color' => %w{ odd even } } }
 puts auto.tag(
     'tag'   => 'ol',
     'attr'  => { 'reversed' => 'reversed' },
-    'cdata' => data.map{ |d| { 'tag' => 'li', 'attr' => attr, 'cdata' => d } }
+    'cdata' => %w{ 1 2 3 4 5 }.map{ |d| { 'tag' => 'li', 'attr' => attr, 'cdata' => d } }
+)
+
+tr_attr = { 'class' => %w{ odd even } }
+puts auto.tag(
+    'tag'   => 'table',
+    'attr'  => { 'class' => 'spreadsheet' },
+    'cdata' => Array[
+        {
+            'tag'   => 'tr',
+            'attr'  => tr_attr,
+            'cdata' => {
+                'tag'  => 'th',
+                'attr' => { 'style' => { 'color' => %w{ red green } } },
+                'cdata' => %w{ one two three },
+            },
+        },
+        {
+            'tag'   => 'tr',
+            'attr'  => tr_attr,
+            'cdata' => {
+                'tag'  => 'td',
+                'attr' => { 'style' => { 'color' => %w{ green blue } } },
+                'cdata' => %w{ four five six },
+            },
+        },
+        {
+            'tag'   => 'tr',
+            'attr'  => tr_attr,
+            'cdata' => {
+                'tag'  => 'td',
+                'attr' => { 'style' => { 'color' => %w{ red green } } },
+                'cdata' => %w{ seven eight nine },
+            },
+        },
+    ]
 )
 ```
+Also includes HTML::AutoAttr which provides rotating attributes:
+```ruby
+require 'HTML/AutoAttr'
+
+attr = HTML::AutoAttr.new( { 'foo' => ['bar','baz','qux'] } )
+
+4.times { puts attr.to_s }
+```
 
 Installation
 ------------
-While you are encouraged to install, please note that this Gem is in Alpha release.
-
-* gem install HTML-AutoTag
+```
+gem install HTML-AutoTag
+```
 
 License and Copyright
 ---------------------

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: HTML-AutoTag
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - jeffa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler