HTML-AutoTag 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efb0d13dd8dbda045953096fb70847a370eb073c
-  data.tar.gz: c7d4c78fe89a7b973d18a2bb09d471452b4ae58c
+  metadata.gz: 4e62c12acd8d530e8e9d7fb5a8bd3ad917b0b13f
+  data.tar.gz: 654a095d32d9e1c1c592163cb56c93814bf0d835
 SHA512:
-  metadata.gz: ea13dfdb575f7f3caab7fb20b3aecee404b6b476b33824a7044f82f47c417623d1328f7988da05f0eb4c9b303f488923028890b441c4901e386b2c23ebaa3737
-  data.tar.gz: 8563123b26d7276f1985ba9cb9c1f807b294f74a06509305fe3c540151e5b7a6c5673ab8035a57d59d786f59a13c9180c28e35ecb53fa32c5d07afb37f46f94e
+  metadata.gz: 8f4cf5d79e775ea646d56a4fdca1f9be040829033bbe66454ca7a9173ce8ba4d7ea74824f046034dfc4c92777d2b9f9fbd4424a4c97abba5c6daf2384e443b10
+  data.tar.gz: 393be2a6b9ecd0a34233599312525285fa642d974c013e4f8cbdaf1f8b9d0b30f54c33c374e1b02449229dc00f402fa05fac46fba090fe54491b08b5b755ce12

data/Changes

@@ -1,5 +1,9 @@
 Revision history for html-autotag-ruby
 
+1.0.6
+    - more true implementation of Perl's HTML::Entities
+    - removed dependency from docs
+
 1.0.5
     - fixed double ampersand encoding bug
 

data/README

@@ -28,15 +28,15 @@ Also includes HTML::AutoAttr which provides rotating attributes:
   attr = HTML::AutoAttr.new( { 'foo' => ['bar','baz','qux'] } )
   4.times { puts attr.to_s }
 
-== Dependencies
-* htmlentities
-
 == Methods
 With the exception of new, all methods return an HTML table as a string.
 
 * new( params )
+  * encode=(boolean)
+    Whether or not to Encode entities.
   * encodes=(string)
-    Encode HTML entities. Pass empty string for default HTML entity encoding or a string with chars you want encoded.
+    Encode these HTML entities. Pass string with chars you want encoded
+    or leave blank for default control and high bit chars and <>!'"
   * indent=(string)
     Pretty print results.
   * level=(integer)

data/lib/HTML/AutoTag/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class AutoTag
-    VERSION = "1.0.5"
+    VERSION = "1.0.6"
   end
 end

data/lib/HTML/AutoTag.rb

@@ -6,12 +6,13 @@ module HTML
 
   class AutoTag
 
-        attr_accessor 'encodes', 'indent', 'level', 'sorted', 'newline'
+        attr_accessor 'encode', 'encodes', 'indent', 'level', 'sorted', 'newline'
 
         # Defaults to empty string which produces no encoding.
 
         def initialize( params = {} )
-            @encodes    = params.has_key?('encodes') ? params['encodes'] : ''
+            @encodes    = params['encodes']
+            @encode     = params['encode']  || !@encodes.nil?
             @indent     = params['indent']  || ''
             @level      = params['level']   || 0
             @sorted     = params['sorted']  ? 1 : 0
@@ -62,7 +63,7 @@ module HTML
                 @level -= 1
 
             else
-                rendered = @encoder.encode( cdata, @encodes )
+                rendered = @encode ? @encoder.encode( cdata, @encodes ) : cdata
                 no_post_indent = 1
             end
 

data/lib/HTML/Encoder.rb

@@ -93,7 +93,7 @@ module HTML
                 'uml'    => 168.chr,
                 'ordf'   => 170.chr,
                 'laquo'  => 171.chr,
-                'not'    => 172.chr,    # not is a keyword in perl
+                'not'    => 172.chr,
                 'shy'    => 173.chr,
                 'macr'   => 175.chr,
                 'deg'    => 176.chr,
@@ -112,7 +112,7 @@ module HTML
                 'frac12' => 189.chr,
                 'frac34' => 190.chr,
                 'iquest' => 191.chr,
-                'times'  => 215.chr,    # times is a keyword in perl
+                'times'  => 215.chr,
                 'divide' => 247.chr,
             }
 
@@ -132,26 +132,22 @@ module HTML
 
         end
 
-        def encode( *args )
+        def encode( string, *args )
 
-            string = args[0]
-            chars  = args[1].nil? ? '&<>"\'' : args[1]
-
-            lookup = {}
-            chars.to_s.each_char{ |c|
-                lookup[c] = @char2entity[c] || num_entity(c)
-            }
-
-            encoded = ''
-            string.to_s.each_char { |c|
-                if lookup[c]
-                    encoded += @char2entity[c] || num_entity(c)
-                else
-                    encoded += c
-                end
-            }
+            if (! args[0].nil? and ! args[0].to_s.empty?)
+                lookup = {}
+                args[0].to_s.each_char{ |c|
+                    lookup[c] = @char2entity[c].nil? ? num_entity(c) : @char2entity[c]
+                }
+                string = string.to_s.gsub( /./ ) {|c| lookup[c].nil? ? c : lookup[c] }
+            else             
+                # Encode control chars, high bit chars and '<', '&', '>', ''' and '"'
+                string = string.to_s.gsub( /([^\n\r\t !\#\$%\(-;=?-~])/ ) {|c| 
+                    @char2entity[c].nil? ? num_entity(c) : @char2entity[c]
+                }
+            end
 
-            return encoded
+            return string
 
         end
 

data/t/02-tag.rb

@@ -5,14 +5,16 @@ 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' => nil, 'indent' => '   ' )
-        assert_equal( nil, auto.encodes,      "encodes set correct" )
+        assert_equal( false, auto.encode,   "no args encode correct" )
+        assert_equal( nil, 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( true, auto.encode,    "encode set correct" )
+        assert_equal( '<>', auto.encodes,   "encodes set correct" )
         assert_equal( '   ', auto.indent,   "indent set correct" )
         assert_equal( "\n", auto.newline,   "newline set correct" )
     end
@@ -48,7 +50,7 @@ class TestTag < Test::Unit::TestCase
         assert_equal( '<p>&lt;0&gt;</p>', auto.tag( 'tag' => 'p', 'cdata' => '<0>' ),  "specific encodes work" )
 
         auto = HTML::AutoTag.new( 'encodes' => nil )
-        assert_equal( '<p>&lt;&quot;0&apos;&amp;&gt;</p>', auto.tag( 'tag' => 'p', 'cdata' => '<"0\'&>' ),  "default encodes work" )
+        assert_equal( '<p><"0\'&></p>', auto.tag( 'tag' => 'p', 'cdata' => '<"0\'&>' ),  "no encoding when encodes is nil" )
 
         auto = HTML::AutoTag.new( 'encodes' => 0 )
         assert_equal( '<p><&#48;></p>', auto.tag( 'tag' => 'p', 'cdata' => '<0>' ),  "zero only encode work" )

data/t/05-encode.rb

@@ -10,13 +10,13 @@ class TestHTML_Encoder < Test::Unit::TestCase
         assert_equal(
             '&amp;&lt;&gt;&quot;&apos;',
             encoder.encode( '&<>"\'' ),
-            'default chars encoded correctly'
+            'default chars encoded when chars is nil'
         )
 
         assert_equal(
-            '&<>"\'',
+            '&amp;&lt;&gt;&quot;&apos;',
             encoder.encode( '&<>"\'', '' ),
-            'no encodes when chars is empty'
+            'encodes when chars is empty'
         )
 
         assert_equal(
@@ -40,13 +40,13 @@ class TestHTML_Encoder < Test::Unit::TestCase
         assert_equal(
             'hello',
             encoder.encode( 'hello' ),
-            'no encodes when default chars requested'
+            'no encodes when default chars is nil'
         )
 
         assert_equal(
             'hello',
             encoder.encode( 'hello', '' ),
-            'no chars encoded when no chars requested'
+            'no encodes when default chars is empty'
         )
 
         deadbeef = 222.chr + 173.chr + 190.chr + 239.chr
@@ -58,15 +58,15 @@ class TestHTML_Encoder < Test::Unit::TestCase
         )
 
         assert_equal(
-            deadbeef,
+            '&THORN;&shy;&frac34;&iuml;',
             encoder.encode( deadbeef ),
-            'no encodes when default chars requested'
+            'hex codes encoded correctly when chars is nil'
         )
 
         assert_equal(
-            deadbeef,
+            '&THORN;&shy;&frac34;&iuml;',
             encoder.encode( deadbeef, '' ),
-            'no encodes when no chars requested'
+            'hex codes encoded correctly when chars is empty'
         )
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: HTML-AutoTag
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - jeffa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler