RubyGems - HTML-AutoTag - Versions diffs - 1.0.1 → 1.0.2 - Mend

HTML-AutoTag 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8652395df3490769d14bdcfac34679723b0d5abc
-  data.tar.gz: 40b6c324542c872274c7bea5523cfa46cf7d6edd
+  metadata.gz: 0caa4fef9425233c5a1a220bd50232abfb982264
+  data.tar.gz: 864955619111973f765e34217ac008de48e09afc
 SHA512:
-  metadata.gz: df802abd00b4ba155e883f60988c206fdd37df168be5713d63904683443dabeb9941b2fbc131d791561c5887da3cff8ba4ecebf81018db805efd26c0d868ab02
-  data.tar.gz: 5a907014bbfbe83a65cd4f376537f0f977b45d6ee91c7a46f6d1fafe471407a6e4c57591b49843462f134eda9a05207c3399231229f0e5f30f8ee67a03d84898
+  metadata.gz: edd4ad4e0173a37124a390b69b35ad1d82377914a4d160b4cd8727d5a322de7e6e4c8bcfbedb48434aba65d07b2c14255e29ecf35cbf745a8b08220576e77e93
+  data.tar.gz: 742447f30494ba9a30a7136f69b51a1b6a9cf301f0243a59f59ca5a13f6a4e3967285658ae7818209bf15b75e6566c53dbf1dadc3cbb248963401e9e3ee66340

data/Changes CHANGED Viewed

@@ -1,5 +1,8 @@
 Revision history for html-autotag-ruby
+1.0.2
+    - added README for rubydoc.info
 1.0.1
     - fixed ridiculous typo introduced by trying to document

data/HTML-AutoTag.gemspec CHANGED Viewed

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.extra_rdoc_files  = ["README"]
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/README ADDED Viewed

@@ -0,0 +1,112 @@
+h1. HTML::AutoTag
+p. Just another HTML tag and attribute generator for ruby.
+h1. Description
+p. Generate HTML tags and attributes with ease (HTML4, XHTML and HTML5). Handles rotating attributes.
+h1. Installation
+bc. gem install HTML-AutoTag
+h1. Synopsis
+bc.  require 'HTML/AutoTag'
+  auto = 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' } )
+  attr = { 'style' => { 'color' => %w{ odd even } } }
+  puts auto.tag(
+    'tag'   => 'ol',
+    'attr'  => { 'reversed' => 'reversed' },
+    'cdata' => %w{ 1 2 3 4 5 }.map{ |d| { 'tag' => 'li', 'attr' => attr, 'cdata' => d } }
+  )
+end
+p. Also includes HTML::AutoAttr which provides rotating attributes:
+bc. require 'HTML/AutoAttr'
+  attr = HTML::AutoAttr.new( { 'foo' => ['bar','baz','qux'] } )
+  4.times { puts attr.to_s }
+end
+h1. Dependencies
+* htmlentities
+h1. Methods
+p. With the exception of new, all methods return an HTML table as a string.
+* new( params )
+  * encodes=(boolean)
+    Encode HTML entities (via htmlentities)
+  * indent=(string)
+    Pretty print results.
+  * level=(integer)
+    Indentation level to start at.
+  * sorted=(boolean)
+    Sort attribute names of the tag alphabetically.
+* tag( params )
+  * tag=(string)
+    The name of the tag.
+  * attr=(hash)
+    Attribute names and values for the tag.
+  * cdata=(string,hash,array)
+    The value wrapped by the tag.
+      * 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
+h1. More Complex Example
+p. The follow will render an HTML table with row that have alternating class names and cells that have alternating background colors:
+bc. require 'HTML/AutoTag'
+  auto = HTML::AutoTag.new
+  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 },
+        },
+      },
+    ]
+  )
+end
+p. See Spreadsheet-HTML for generating HTML tables.
+h1. License
+p. MIT
+h1. Copyright
+p. (C) 2015 Jeff Anderson -- All Rights Reserved
+h1. Warranty
+p. This package is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.
+h1. Author
+p. Jeff Anderson jeffa@cpan.org

data/lib/HTML/AutoAttr.rb CHANGED Viewed

@@ -89,31 +89,6 @@ end
 =begin rdoc
-= NAME
-HTML::AutoAttr - Just another HTML attribute generator.
-== DESCRIPTION
-This module will translate nested hash keys and values into HTML
-tag attributes that can have ther values automatically rotated.
-== SEE ALSO
-* http://www.w3.org/TR/html5/syntax.html#attributes-0
-* http://www.w3.org/TR/html-markup/syntax.html#syntax-attributes
-== GITHUB
-The Github project is https://github.com/jeffa/html-autotag-ruby
-== SUPPORT
-You can find documentation for this module with the ri command.
-ri HTML::AutoAttr
 == AUTHOR
 Jeff Anderson, <jeffa at cpan.org>

data/lib/HTML/AutoTag.rb CHANGED Viewed

@@ -8,19 +8,6 @@ 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']  || ''
@@ -30,70 +17,58 @@ 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 )
-                attr = params['attr']
-            else
-                attr = HTML::AutoAttr.new( params['attr'] || {}, @sorted )
+        def tag( params )
+            # TODO: make these method args if possible
+            tag   = params['tag']
+            attr  = params['attr']
+            cdata = params['cdata']
+            unless attr.kind_of?( HTML::AutoAttr )
+                attr = HTML::AutoAttr.new( attr, @sorted )
             end
             # emtpy tag
-            unless params['cdata'] and params['cdata'].to_s.length
-                return ( @indent * @level ) + '<' + params['tag'] + attr.to_s + ' />' + @newline
+            unless cdata and cdata.to_s.length
+                return ( @indent * @level ) + '<' + tag + attr.to_s + ' />' + @newline
             end
-            cdata = ''
+            rendered       = ''
             no_post_indent = 0
-            if params['cdata'].kind_of?( Array )
-                if params['cdata'][0].kind_of?( Hash )
+            if cdata.kind_of?( Array )
+                if cdata[0].kind_of?( Hash )
                     @level += 1
-                    cdata = @newline
+                    rendered = @newline
-                    params['cdata'].each do |hash|
-                        cdata += tag( hash )
+                    cdata.each do |hash|
+                        rendered += tag( 'tag' => hash['tag'], 'attr' => hash['attr'], 'cdata' => hash['cdata'] )
                     end
                     @level -= 1
                 else
                     str = ''
-                    params['cdata'].each do |scalar|
-                        str += tag( 'tag' => params['tag'], 'attr' => attr, 'cdata' => scalar )
+                    cdata.each do |scalar|
+                        str += tag( 'tag' => tag, 'attr' => attr, 'cdata' => scalar )
                     end
                     return str
                 end
-            elsif params['cdata'].kind_of?( Hash )
+            elsif cdata.kind_of?( Hash )
                 @level += 1
-                cdata = @newline + tag( params['cdata'] )
+                rendered = @newline + tag( 'tag' => cdata['tag'], 'attr' => cdata['attr'], 'cdata' => cdata['cdata'] )
                 @level -= 1
             else
-                cdata = params['cdata']
-                cdata = @encoder.encode( cdata ) if @encodes == 1
+                rendered = cdata
+                rendered = @encoder.encode( rendered ) if @encodes == 1
                 no_post_indent = 1
             end
             return (@indent * @level)  \
-                + '<' + params['tag'] + attr.to_s + '>'  \
-                + cdata.to_s + ( no_post_indent == 1 ? '' : ( @indent * @level ) )  \
-                + '</' + params['tag'] + '>' + @newline
+                + '<' + tag + attr.to_s + '>'  \
+                + rendered.to_s + ( no_post_indent == 1 ? '' : ( @indent * @level ) )  \
+                + '</' + tag + '>' + @newline
         end
@@ -103,29 +78,6 @@ end
 =begin rdoc
-= NAME
-HTML::AutoTag - Just another HTML tag generator.
-== DESCRIPTION
-Generate nested HTML (HTML4, XHTML and HTML5) tags with custom indentation,
-custom encoding and automatic attribute value rotation.
-== SEE ALSO
-* http://www.w3.org/TR/html5/syntax.html
-== GITHUB
-The Github project is https://github.com/jeffa/html-autotag-ruby
-== SUPPORT
-You can find documentation for this module with the ri command.
-ri HTML::AutoTag
 == AUTHOR
 Jeff Anderson, <jeffa at cpan.org>

data/lib/HTML/AutoTag/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module HTML
   class AutoTag
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: HTML-AutoTag
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - jeffa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,7 +57,8 @@ email:
 - jeffa@cpan.org
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README
 files:
 - ".gitignore"
 - ".travis.yml"
@@ -65,6 +66,7 @@ files:
 - Gemfile
 - HTML-AutoTag.gemspec
 - License.md
+- README
 - Rakefile
 - lib/HTML/AutoAttr.rb
 - lib/HTML/AutoTag.rb