HTML-AutoTag 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8b3e9d049b5f87041ab173a6525b100d9691176
+  data.tar.gz: 05ff1a5a8e3e8c7dc66e900810d571164c82f246
+SHA512:
+  metadata.gz: ca81f53e28caf46f5860ca0d07dddcb0d4bdada52a41e3e4a11bf759d40a5f55972f9a5bb0e222704d1398c15c99e65c845b79f8ca14f6c93ed1d9344ba41340
+  data.tar.gz: 3d4de05a33d46cf030cca71a3a760f966d3b1d3ef7e6951f72644ae626db09ea301d68b0eb101dc32e2bdc4ce6640e0701d82d7b1127d7ebf71ec478311d79ca

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - jruby-18mode
+  - jruby-19mode
+  - 1.9.3
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in HTML-AutoTag.gemspec
+gemspec

data/HTML-AutoTag.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'HTML/AutoTag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "HTML-AutoTag"
+  spec.version       = HTML::AutoTag::VERSION
+  spec.authors       = ["jeffa"]
+  spec.email         = ["jeffa@cpan.org"]
+  spec.description   = %q{Just another HTML tag generator for ruby.}
+  spec.summary       = %q{Generate HTML tags with ease (HTML4, HTML5, XHTML and SVG).}
+  spec.homepage      = "https://github.com/jeffa/html-autotag-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/License.md

@@ -0,0 +1,23 @@
+Copyright (c) 2015 Jeff Anderson
+================================
+
+MIT License
+-----------
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :default => [:test]
+
+task :test do
+    Dir.glob( './t/*.rb' ).each { |file| require file }
+end

data/lib/HTML/AutoAttr.rb

@@ -0,0 +1,115 @@
+module HTML
+
+    class AutoAttr
+
+        attr_accessor 'hash', 'sorted'
+
+        def initialize( hash = {}, sorted = 0 )
+            @hash   = hash
+            @sorted = sorted
+        end
+
+        def to_s
+
+            keys = @sorted ? @hash.keys.sort : @hash.keys
+            str  = ''
+            seen = {}
+
+            keys.each do |key|
+                unless seen.has_key?( key )
+                    val = @hash[key]
+                    val = stringify( val )  if val.kind_of?( Hash )
+                    val = rotate( val )     if val.kind_of?( Array )
+                    str += sprintf( ' %s="%s"', key( key ), val( val ) )
+                end
+                seen[key] = 1
+            end
+
+            return str
+        end
+
+        def key( key )
+            key = key.gsub( /\s+/, '' )
+            key = key.gsub( /["'>=\/]/, '' )
+            return key
+        end
+
+        def val( val )
+            return '' if val.match( /^\s+$/ )
+            val = val.gsub( /"/, '' )
+            return val
+        end
+
+        def rotate( array )
+            val = array.shift
+            array.push( val )
+            return val
+        end
+
+        def stringify( hash )
+
+            keys = @sorted ? hash.keys.sort : hash.keys
+            vals = keys.map{ |key|
+                val = ''
+                if hash[key].kind_of?( Array ) 
+                    val = rotate( hash[key] )
+                elsif hash[key].kind_of?( Hash )
+                    val = @sorted ? hash[key].keys.sort[0] : hash[key].keys[0]
+                else
+                    val = hash[key]
+                end
+                "#{key}: #{val}"
+            }
+            return vals.join( '; ' ) + (vals.length ? ';' : '')
+
+        end
+
+    end
+
+end
+
+=begin rdoc
+
+= NAME
+
+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
+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>
+
+== LICENSE AND COPYRIGHT
+
+Copyright 2015 Jeff Anderson. (See License.md shipped with distro)
+
+=end

data/lib/HTML/AutoTag/version.rb

@@ -0,0 +1,5 @@
+module HTML
+  class AutoTag
+    VERSION = "0.0.1"
+  end
+end

data/lib/HTML/AutoTag.rb

@@ -0,0 +1,114 @@
+require "HTML/AutoTag/version"
+require "HTML/AutoAttr"
+
+module HTML
+
+  class AutoTag
+
+        attr_accessor 'encodes', 'indent', 'level', 'sorted', 'newline'
+
+        def initialize( params = {} )
+            @encodes    = params['encodes'] || ''
+            @indent     = params['indent']  || ''
+            @level      = params['level']   || 0
+            @sorted     = params['sorted']  || 0
+            @newline    = params['indent'] ? "\n" : ''
+
+        end
+
+        def tag( params = {} )
+
+            attr = HTML::AutoAttr.new( params['attr'] || {}, @sorted )
+
+            # emtpy tag
+            unless params['cdata'] and params['cdata'].to_s.length
+                return '<' + params['tag'] + ' />' + @newline
+            end
+
+            cdata = ''
+            no_post_indent = 0
+            if params['cdata'].kind_of?( Array )
+
+                if params['cdata'][0].kind_of?( Hash )
+
+                    @level += 1
+                    cdata = @newline
+
+                    params['cdata'].each do |hash|
+                        cdata += tag( hash )
+                    end
+                    @level -= 1
+
+                else
+                    str = ''
+                    params['data'].each do |scalar|
+                        str += tag( 'tag' => params['tag'], 'attr' => attr, 'cdata' => scalar )
+                    end
+                    return str
+                end
+
+            elsif params['cdata'].kind_of?( Hash )
+                @level += 1
+                cdata = @newline + tag( params['cdata'] )
+                @level -= 1
+
+            else
+                # do encoding here
+                cdata = params['cdata']
+                no_post_indent = 1
+            end
+
+            return (@indent * @level)  \
+                + '<' + params['tag'] + attr.to_s + '>'  \
+                + cdata.to_s + ( no_post_indent ? '' : ( @indent * @level ) )  \
+                + '</' + params['tag'] + '>' + @newline
+
+        end
+
+  end
+
+end
+
+=begin rdoc
+
+= NAME
+
+HTML::AutoTag - Just another HTML tag generator.
+
+== SYNOPSIS
+
+<code>
+require 'HTML/AutoTag'
+tag = HTML::AutoTag.new
+
+puts auto.tag( 'tag' => 'p', 'cdata' => 'paragraph' )
+</code>
+
+== DESCRIPTION
+
+Generate nested HTML (HTML4, XHTML and HTML5) tags with custom indentation,
+custom encoding and automatic attribute value rotation.
+
+== SEE ALSO
+
+* ttp://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>
+
+== LICENSE AND COPYRIGHT
+
+Copyright 2015 Jeff Anderson. (See License.md shipped with distro)
+
+=end

data/readme.md

@@ -0,0 +1,29 @@
+HTML-AutoTag (ruby)
+===================
+Just another HTML tag generator for ruby.
+
+Description
+-----------
+Generate HTML tags with ease (HTML4, HTML5, XHTML and SVG).
+
+Synopsis
+--------
+```ruby
+require 'HTML/AutoTag'
+
+auto = HTML::AutoTag.new
+
+puts auto.tag( 'tag' => 'p', 'cdata' => 'a paragraph' )
+```
+
+Installation
+------------
+We are currently pre-Alpha, so installation is not recommended.
+
+* rake test
+* rake build
+* ~~rake install~~ :skull:
+
+License and Copyright
+---------------------
+See [License](License.md).

data/t/01-load.rb

@@ -0,0 +1,10 @@
+require "test/unit"
+
+class TestLoad < Test::Unit::TestCase
+
+  def test_load
+    assert_nothing_raised { require "HTML/AutoTag.rb" }
+    assert_nothing_raised { require "HTML/AutoAttr.rb" }
+  end
+
+end

data/t/02-tag.rb

@@ -0,0 +1,46 @@
+require "test/unit"
+require "HTML/AutoTag"
+
+class TestTag < Test::Unit::TestCase
+
+    def test_init
+        auto = HTML::AutoTag.new
+        assert_equal( '', auto.encodes,  "no args encodes correct" )
+        assert_equal( '', auto.indent,   "no args indent correct" )
+        assert_equal(  0, auto.level,    "no args level correct" )
+        assert_equal(  0, auto.sorted,   "no args sorted correct" )
+        assert_equal( '', auto.newline,  "no args newline correct" )
+
+        auto = HTML::AutoTag.new( 'encodes' => '<=&>', 'indent' => '   ' )
+        assert_equal( '<=&>', auto.encodes, "encodes set correct" )
+        assert_equal( '   ', auto.indent,   "indent set correct" )
+        assert_equal( "\n", auto.newline,   "newline set correct" )
+    end
+
+    def test_empty
+        auto = HTML::AutoTag.new
+        assert_equal( '<hr />', auto.tag( 'tag' => 'hr' ),  "empty tag correct" )
+    end
+
+    def test_nonempty
+        auto = HTML::AutoTag.new
+        assert_equal( '<p>0</p>', auto.tag( 'tag' => 'p', 'cdata' => 0 ),  "paragraph tag correct" )
+        assert_equal( '<ol><li>1</li></ol>', auto.tag( 'tag' => 'ol', 'cdata' => { 'tag' => 'li', 'cdata' => 1 } ),  "ol tag correct" )
+        assert_equal( '<ol><li>1</li><li>2</li></ol>', auto.tag( 'tag' => 'ol', 'cdata' => [{ 'tag' => 'li', 'cdata' => 1 }, { 'tag' => 'li', 'cdata' => 2 }] ),  "ol tag correct" )
+    end
+
+    def test_indent
+        auto = HTML::AutoTag.new( 'indent' => '  ' )
+        assert_equal( "<p>0</p>\n", auto.tag( 'tag' => 'p', 'cdata' => 0 ),  "paragraph tag correct" )
+        assert_equal( "<ol>\n  <li>1</li>\n</ol>\n", auto.tag( 'tag' => 'ol', 'cdata' => { 'tag' => 'li', 'cdata' => 1 } ),  "ol tag correct" )
+        assert_equal( "<ol>\n  <li>1</li>\n  <li>2</li>\n</ol>\n", auto.tag( 'tag' => 'ol', 'cdata' => [{ 'tag' => 'li', 'cdata' => 1 }, { 'tag' => 'li', 'cdata' => 2 }] ),  "ol tag correct" )
+    end
+
+    def test_level
+        auto = HTML::AutoTag.new( 'indent' => ' ',  'level' => 3 )
+        assert_equal( "   <p>0</p>\n", auto.tag( 'tag' => 'p', 'cdata' => 0 ),  "paragraph tag correct" )
+        assert_equal( "   <ol>\n    <li>1</li>\n</ol>\n", auto.tag( 'tag' => 'ol', 'cdata' => { 'tag' => 'li', 'cdata' => 1 } ),  "ol tag correct" )
+        assert_equal( "   <ol>\n    <li>1</li>\n    <li>2</li>\n</ol>\n", auto.tag( 'tag' => 'ol', 'cdata' => [{ 'tag' => 'li', 'cdata' => 1 }, { 'tag' => 'li', 'cdata' => 2 }] ),  "ol tag correct" )
+    end
+
+end

data/t/03-attrs.rb

@@ -0,0 +1,45 @@
+require "test/unit"
+require "HTML/AutoAttr"
+
+class TestAttrs < Test::Unit::TestCase
+
+    def test_keys
+
+        attr = HTML::AutoAttr.new
+        assert_equal( '', attr.key( '  ' ),             "only spaces" )
+        assert_equal( 'foobar', attr.key( 'foo bar'),   "with space" )
+        assert_equal( '', attr.key( '">=//=>"' ),       "only scrubbed chars" )
+        assert_equal( 'foo<bar', attr.key( 'foo<bar' ), "does not scrub < char" )
+
+    end
+
+    def test_vals
+
+        attr = HTML::AutoAttr.new
+        assert_equal( '', attr.val( '  ' ),             "only spaces" )
+        assert_equal( 'foo bar', attr.val( 'foo bar'),  "with space" )
+        assert_equal( "'foo'", attr.val( "'foo'" ),     "single quotes are not scrubbed" )
+        assert_equal( 'foo', attr.val( '"foo"' ),       "double quotes are scrubbed" )
+
+    end
+
+    def test_simple_attrs
+        attr = HTML::AutoAttr.new( { 'foo' => 'bar', 'baz' => 'qux' }, 1 )
+        assert_equal( ' baz="qux" foo="bar"', attr.to_s,          "correct simple attrs" )
+    end
+
+    def test_rotate_attrs
+        attr = HTML::AutoAttr.new( { 'foo' => ['bar','baz','qux'], 'baz' => ['foo','qux'] }, 1 )
+        assert_equal( ' baz="foo" foo="bar"', attr.to_s,          "correct rotate attrs 1" )
+        assert_equal( ' baz="qux" foo="baz"', attr.to_s,          "correct rotate attrs 2" )
+        assert_equal( ' baz="foo" foo="qux"', attr.to_s,          "correct rotate attrs 3" )
+        assert_equal( ' baz="qux" foo="bar"', attr.to_s,          "correct rotate attrs 4" )
+        assert_equal( ' baz="foo" foo="baz"', attr.to_s,          "correct rotate attrs 5" )
+    end
+
+    def test_nested_attrs
+        attr = HTML::AutoAttr.new( { 'foo' => { 'bar' => 'baz', 'qux' => 'foo' } }, 1 )
+        assert_equal( ' foo="bar: baz; qux: foo;"', attr.to_s,          "correct nested attrs" )
+    end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: HTML-AutoTag
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jeffa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Just another HTML tag generator for ruby.
+email:
+- jeffa@cpan.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- HTML-AutoTag.gemspec
+- License.md
+- Rakefile
+- lib/HTML/AutoAttr.rb
+- lib/HTML/AutoTag.rb
+- lib/HTML/AutoTag/version.rb
+- readme.md
+- t/01-load.rb
+- t/02-tag.rb
+- t/03-attrs.rb
+homepage: https://github.com/jeffa/html-autotag-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Generate HTML tags with ease (HTML4, HTML5, XHTML and SVG).
+test_files: []