htmlentities 4.3.1 → 4.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6afa4d22af6c783ac7932aaeda0e3369bfb0648
+  data.tar.gz: eced509ca635c31969ab270199beb23f1d08e653
+SHA512:
+  metadata.gz: 77876c708e3db5def2ccebfb2ce11fd216e645acc4844b7215d872e162d139c5d0f797721b52b418df9104b08f51fc2565b505e93b5a7a48732ac89f9a53a83e
+  data.tar.gz: 7f37a24c747c9dd56735ae247ff60b9a7b29f10bac0f261709e3d9b3371fc805d00cd91670b9f712759eb571d14b78de106f9b110a139cfe8469ea0b7f776ee4

data/COPYING.txt

@@ -1,6 +1,6 @@
 == Licence (MIT)
 
-Copyright (c) 2005-2009 Paul Battley
+Copyright (c) 2005-2013 Paul Battley
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/htmlentities/decoder.rb

@@ -21,24 +21,17 @@ class HTMLEntities
     end
 
   private
-    if "1.9".respond_to?(:encoding)
-      def prepare(string) #:nodoc:
-        string.to_s.encode(Encoding::UTF_8)
-      end
-    else
-      def prepare(string) #:nodoc:
-        string.to_s
-      end
+    def prepare(string) #:nodoc:
+      string.to_s.encode(Encoding::UTF_8)
     end
 
     def entity_regexp
       key_lengths = @map.keys.map{ |k| k.length }
-      entity_name_pattern =
-        if @flavor == 'expanded'
-          '(?:b\.)?[a-z][a-z0-9]'
-        else
-          '[a-z][a-z0-9]'
-        end
+      if @flavor == 'expanded'
+        entity_name_pattern = '(?:b\.)?[a-z][a-z0-9]'
+      else
+        entity_name_pattern = '[a-z][a-z0-9]'
+      end
       /&(?:(#{entity_name_pattern}{#{key_lengths.min - 1},#{key_lengths.max - 1}})|#([0-9]{1,7})|#x([0-9a-f]{1,6}));/i
     end
   end

data/lib/htmlentities/encoder.rb

@@ -7,69 +7,66 @@ class HTMLEntities
     def initialize(flavor, instructions)
       @flavor = flavor
       instructions = [:basic] if instructions.empty?
-      validate_instructions(instructions)
-      build_basic_entity_encoder(instructions)
-      build_extended_entity_encoder(instructions)
+      validate_instructions instructions
+      build_basic_entity_encoder instructions
+      build_extended_entity_encoder instructions
     end
 
     def encode(source)
-      post_process(
-        prepare(source).
-          gsub(basic_entity_regexp){ |match| encode_basic(match) }.
-          gsub(extended_entity_regexp){ |match| encode_extended(match) }
-      )
+      minimize_encoding(
+        replace_extended(
+          replace_basic(
+            prepare(source))))
     end
 
   private
 
-    if "1.9".respond_to?(:encoding)
-      def prepare(string) #:nodoc:
-        string.to_s.encode(Encoding::UTF_8)
-      end
-
-      def post_process(string)
-        if string.encoding != Encoding::ASCII && string.match(/\A[\x01-\x7F]*\z/)
-          string.encode(Encoding::ASCII)
-        else
-          string
-        end
-      end
-    else
-      def prepare(string) #:nodoc:
-        string.to_s
-      end
+    def prepare(string)
+      string.to_s.encode(Encoding::UTF_8)
+    end
 
-      def post_process(string)
+    def minimize_encoding(string)
+      if string.encoding != Encoding::ASCII && contains_only_ascii?(string)
+        string.encode(Encoding::ASCII)
+      else
         string
       end
     end
 
+    def contains_only_ascii?(string)
+      string.match(/\A[\x01-\x7F]*\z/)
+    end
+
     def basic_entity_regexp
       @basic_entity_regexp ||= @flavor.match(/^html/) ? /[<>"&]/ : /[<>'"&]/
     end
 
     def extended_entity_regexp
       @extended_entity_regexp ||= (
-        options = [nil]
-        if encoding_aware?
-          pattern = '[^\u{20}-\u{7E}]'
-        else
-          pattern = '[^\x20-\x7E]'
-          options << "U"
-        end
+        pattern = '[^\u{20}-\u{7E}]'
         pattern << "|'" if @flavor == 'html4'
-        Regexp.new(pattern, *options)
+        Regexp.new(pattern)
       )
     end
 
+    def replace_basic(string)
+      string.gsub(basic_entity_regexp){ |match| encode_basic(match) }
+    end
+
+    def replace_extended(string)
+      string.gsub(extended_entity_regexp){ |match| encode_extended(match) }
+    end
+
     def validate_instructions(instructions)
       unknown_instructions = instructions - INSTRUCTIONS
       if unknown_instructions.any?
-        raise InstructionError, "unknown encode_entities command(s): #{unknown_instructions.inspect}"
+        raise InstructionError,
+          "unknown encode_entities command(s): #{unknown_instructions.inspect}"
       end
 
-      if (instructions.include?(:decimal) && instructions.include?(:hexadecimal))
-        raise InstructionError, "hexadecimal and decimal encoding are mutually exclusive"
+      if instructions.include?(:decimal) && instructions.include?(:hexadecimal)
+        raise InstructionError,
+          "hexadecimal and decimal encoding are mutually exclusive"
       end
     end
 
@@ -81,18 +78,24 @@ class HTMLEntities
       elsif instructions.include?(:hexadecimal)
         method = :encode_hexadecimal
       end
-      instance_eval "def encode_basic(char)\n#{method}(char)\nend"
+      instance_eval <<-END
+        def encode_basic(char)
+          #{method}(char)
+        end
+      END
     end
 
     def build_extended_entity_encoder(instructions)
-      definition = "def encode_extended(char)\n"
-      ([:named, :decimal, :hexadecimal] & instructions).each do |encoder|
-        definition << "encoded = encode_#{encoder}(char)\n"
-        definition << "return encoded if encoded\n"
-      end
-      definition << "char\n"
-      definition << "end"
-      instance_eval definition
+      operations = [:named, :decimal, :hexadecimal] & instructions
+      instance_eval <<-END
+        def encode_extended(char)
+          #{operations.map{ |encoder| %{
+            encoded = encode_#{encoder}(char)
+            return encoded if encoded
+          }}.join("\n")}
+          char
+        end
+      END
     end
 
     def encode_named(char)
@@ -116,9 +119,5 @@ class HTMLEntities
         uniqmap.invert
       )
     end
-
-    def encoding_aware?
-      "1.9".respond_to?(:encoding)
-    end
   end
 end

data/lib/htmlentities/version.rb

@@ -2,7 +2,7 @@ class HTMLEntities
   module VERSION #:nodoc:
     MAJOR = 4
     MINOR = 3
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/perf/profile.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 $KCODE = 'u' unless "1.9".respond_to?(:encoding)
 
-require File.join(File.dirname(__FILE__), "performance")
+require File.expand_path("../performance", __FILE__)
 require "profiler"
 
 job = HTMLEntitiesJob.new

data/test/decoding_test.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require File.expand_path("../common", __FILE__)
+require_relative "./test_helper"
 
 class HTMLEntities::DecodingTest < Test::Unit::TestCase
 

data/test/encoding_test.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require File.expand_path("../common", __FILE__)
+require_relative "./test_helper"
 
 class HTMLEntities::EncodingTest < Test::Unit::TestCase
 

data/test/entities_test.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require File.expand_path("../common", __FILE__)
+require_relative "./test_helper"
 
 class HTMLEntities::EntitiesTest < Test::Unit::TestCase
 

data/test/expanded_test.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require File.expand_path("../common", __FILE__)
+require_relative "./test_helper"
 
 class HTMLEntities::ExpandedTest < Test::Unit::TestCase
 

data/test/html4_test.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require File.expand_path("../common", __FILE__)
+require_relative "./test_helper"
 
 class HTML4Test < Test::Unit::TestCase
 

data/test/interoperability_test.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require File.expand_path("../common", __FILE__)
+require_relative "./test_helper"
 
 if ENV["RUN_INTEROPERABILITY_TESTS"]
   class HTMLEntities::InteroperabilityTest < Test::Unit::TestCase

data/test/roundtrip_test.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require File.expand_path("../common", __FILE__)
+require_relative "./test_helper"
 
 class HTMLEntities::RoundtripTest < Test::Unit::TestCase
 

data/test/string_encodings_test.rb

@@ -0,0 +1,68 @@
+# encoding: UTF-8
+require_relative "./test_helper"
+
+class HTMLEntities::StringEncodingsTest < Test::Unit::TestCase
+
+  def test_should_encode_ascii_to_ascii
+    s = "<elan>".encode(Encoding::US_ASCII)
+    assert_equal Encoding::US_ASCII, s.encoding
+
+    t = HTMLEntities.new.encode(s)
+    assert_equal "&lt;elan&gt;", t
+    assert_equal Encoding::US_ASCII, t.encoding
+  end
+
+  def test_should_encode_utf8_to_utf8_if_needed
+    s = "<élan>"
+    assert_equal Encoding::UTF_8, s.encoding
+
+    t = HTMLEntities.new.encode(s)
+    assert_equal "&lt;élan&gt;", t
+    assert_equal Encoding::UTF_8, t.encoding
+  end
+
+  def test_should_encode_utf8_to_ascii_if_possible
+    s = "<elan>"
+    assert_equal Encoding::UTF_8, s.encoding
+
+    t = HTMLEntities.new.encode(s)
+    assert_equal "&lt;elan&gt;", t
+    assert_equal Encoding::US_ASCII, t.encoding
+  end
+
+  def test_should_encode_other_encoding_to_utf8
+    s = "<élan>".encode(Encoding::ISO_8859_1)
+    assert_equal Encoding::ISO_8859_1, s.encoding
+
+    t = HTMLEntities.new.encode(s)
+    assert_equal "&lt;élan&gt;", t
+    assert_equal Encoding::UTF_8, t.encoding
+  end
+
+  def test_should_decode_ascii_to_utf8
+    s = "&lt;&eacute;lan&gt;".encode(Encoding::US_ASCII)
+    assert_equal Encoding::US_ASCII, s.encoding
+
+    t = HTMLEntities.new.decode(s)
+    assert_equal "<élan>", t
+    assert_equal Encoding::UTF_8, t.encoding
+  end
+
+  def test_should_decode_utf8_to_utf8
+    s = "&lt;&eacute;lan&gt;".encode(Encoding::UTF_8)
+    assert_equal Encoding::UTF_8, s.encoding
+
+    t = HTMLEntities.new.decode(s)
+    assert_equal "<élan>", t
+    assert_equal Encoding::UTF_8, t.encoding
+  end
+
+  def test_should_decode_other_encoding_to_utf8
+    s = "&lt;&eacute;lan&gt;".encode(Encoding::ISO_8859_1)
+    assert_equal Encoding::ISO_8859_1, s.encoding
+
+    t = HTMLEntities.new.decode(s)
+    assert_equal "<élan>", t
+    assert_equal Encoding::UTF_8, t.encoding
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'test/unit'
+require 'htmlentities'

data/test/xhtml1_test.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require File.expand_path("../common", __FILE__)
+require_relative "./test_helper"
 
 class HTMLEntities::XHTML1Test < Test::Unit::TestCase
 

metadata

@@ -1,87 +1,91 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: htmlentities
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 4.3.1
+version: !ruby/object:Gem::Version
+  version: 4.3.2
 platform: ruby
-authors: 
+authors:
 - Paul Battley
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-30 00:00:00 Z
-dependencies: []
-
-description: 
+date: 2014-05-30 00:00:00.000000000 Z
+dependencies:
+- !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: A module for encoding and decoding (X)HTML entities.
 email: pbattley@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - COPYING.txt
-files: 
-- lib/htmlentities/encoder.rb
+files:
+- COPYING.txt
+- History.txt
+- lib/htmlentities.rb
 - lib/htmlentities/decoder.rb
-- lib/htmlentities/mappings/xhtml1.rb
+- lib/htmlentities/encoder.rb
+- lib/htmlentities/flavors.rb
 - lib/htmlentities/mappings/expanded.rb
 - lib/htmlentities/mappings/html4.rb
-- lib/htmlentities/flavors.rb
+- lib/htmlentities/mappings/xhtml1.rb
 - lib/htmlentities/version.rb
-- lib/htmlentities.rb
-- test/html4_test.rb
-- test/ruby_1_8_test.rb
-- test/roundtrip_test.rb
-- test/encoding_test.rb
-- test/common.rb
-- test/xhtml1_test.rb
-- test/decoding_test.rb
-- test/ruby_1_9_test.rb
-- test/expanded_test.rb
-- test/entities_test.rb
-- test/interoperability_test.rb
 - perf/benchmark.rb
 - perf/performance.rb
 - perf/profile.rb
-- History.txt
-- COPYING.txt
+- test/decoding_test.rb
+- test/encoding_test.rb
+- test/entities_test.rb
+- test/expanded_test.rb
+- test/html4_test.rb
+- test/interoperability_test.rb
+- test/roundtrip_test.rb
+- test/string_encodings_test.rb
+- test/test_helper.rb
+- test/xhtml1_test.rb
 homepage: https://github.com/threedaymonk/htmlentities
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: A module for encoding and decoding (X)HTML entities.
-test_files: 
-- test/html4_test.rb
-- test/ruby_1_8_test.rb
-- test/roundtrip_test.rb
+specification_version: 4
+summary: Encode/decode HTML entities
+test_files:
+- test/interoperability_test.rb
 - test/encoding_test.rb
+- test/string_encodings_test.rb
+- test/entities_test.rb
+- test/html4_test.rb
 - test/xhtml1_test.rb
-- test/decoding_test.rb
-- test/ruby_1_9_test.rb
 - test/expanded_test.rb
-- test/entities_test.rb
-- test/interoperability_test.rb
+- test/decoding_test.rb
+- test/roundtrip_test.rb

data/test/common.rb

@@ -1,6 +0,0 @@
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'test/unit'
-require 'htmlentities'
-
-ENCODING_AWARE_RUBY = "1.9".respond_to?(:encoding)
-$KCODE = 'u' unless ENCODING_AWARE_RUBY

data/test/ruby_1_8_test.rb

@@ -1,18 +0,0 @@
-# encoding: UTF-8
-require File.expand_path("../common", __FILE__)
-
-unless ENCODING_AWARE_RUBY
-  class HTMLEntities::Ruby18Test < Test::Unit::TestCase
-
-    # Reported by Benoit Larroque
-    def test_should_encode_without_error_when_KCODE_is_not_UTF_8
-      kcode = $KCODE
-      $KCODE = "n"
-      coder = HTMLEntities.new
-      text = [8212].pack('U')
-      assert_equal "&#8212;", coder.encode(text, :decimal)
-      $KCODE = kcode
-    end
-
-  end
-end

data/test/ruby_1_9_test.rb

@@ -1,70 +0,0 @@
-# encoding: UTF-8
-require File.expand_path("../common", __FILE__)
-
-if ENCODING_AWARE_RUBY
-  class HTMLEntities::Ruby19Test < Test::Unit::TestCase
-
-    def test_should_encode_ascii_to_ascii
-      s = "<elan>".encode(Encoding::US_ASCII)
-      assert_equal Encoding::US_ASCII, s.encoding
-
-      t = HTMLEntities.new.encode(s)
-      assert_equal "&lt;elan&gt;", t
-      assert_equal Encoding::US_ASCII, t.encoding
-    end
-
-    def test_should_encode_utf8_to_utf8_if_needed
-      s = "<élan>"
-      assert_equal Encoding::UTF_8, s.encoding
-
-      t = HTMLEntities.new.encode(s)
-      assert_equal "&lt;élan&gt;", t
-      assert_equal Encoding::UTF_8, t.encoding
-    end
-
-    def test_should_encode_utf8_to_ascii_if_possible
-      s = "<elan>"
-      assert_equal Encoding::UTF_8, s.encoding
-
-      t = HTMLEntities.new.encode(s)
-      assert_equal "&lt;elan&gt;", t
-      assert_equal Encoding::US_ASCII, t.encoding
-    end
-
-    def test_should_encode_other_encoding_to_utf8
-      s = "<élan>".encode(Encoding::ISO_8859_1)
-      assert_equal Encoding::ISO_8859_1, s.encoding
-
-      t = HTMLEntities.new.encode(s)
-      assert_equal "&lt;élan&gt;", t
-      assert_equal Encoding::UTF_8, t.encoding
-    end
-
-    def test_should_decode_ascii_to_utf8
-      s = "&lt;&eacute;lan&gt;".encode(Encoding::US_ASCII)
-      assert_equal Encoding::US_ASCII, s.encoding
-
-      t = HTMLEntities.new.decode(s)
-      assert_equal "<élan>", t
-      assert_equal Encoding::UTF_8, t.encoding
-    end
-
-    def test_should_decode_utf8_to_utf8
-      s = "&lt;&eacute;lan&gt;".encode(Encoding::UTF_8)
-      assert_equal Encoding::UTF_8, s.encoding
-
-      t = HTMLEntities.new.decode(s)
-      assert_equal "<élan>", t
-      assert_equal Encoding::UTF_8, t.encoding
-    end
-
-    def test_should_decode_other_encoding_to_utf8
-      s = "&lt;&eacute;lan&gt;".encode(Encoding::ISO_8859_1)
-      assert_equal Encoding::ISO_8859_1, s.encoding
-
-      t = HTMLEntities.new.decode(s)
-      assert_equal "<élan>", t
-      assert_equal Encoding::UTF_8, t.encoding
-    end
-  end
-end