RubyGems - guess_html_encoding - Versions diffs - 0.0.3 → 0.0.4 - Mend

guess_html_encoding 0.0.3 → 0.0.4

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 (7) hide show

data/Gemfile.lock +1 -1
data/LICENSE +19 -0
data/README.markdown +46 -52
data/lib/guess_html_encoding/version.rb +1 -1
data/lib/guess_html_encoding.rb +10 -9
data/spec/guess_html_encoding_spec.rb +4 -1
metadata +5 -4

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    guess_html_encoding (0.0.2)
+    guess_html_encoding (0.0.4)
 GEM
   remote: http://rubygems.org/

data/LICENSE ADDED Viewed

@@ -0,0 +1,19 @@
+Copyright (c) 2012, Andrew Cantino (Iteration Labs, LLC)
+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/README.markdown CHANGED Viewed

@@ -1,52 +1,46 @@
-GuessHtmlEncoding is a simple library to guess the HTML encodings in Ruby 1.9
-describe "GuessHtmlEncoding" do
-  describe "#guess" do
-    it "can use headers" do
-      guess = GuessHtmlEncoding.guess("<html><body><div>hi!</div></body></html>",
-                                      "Hello: world\nContent-Type: text/html; charset=LATIN1\nFoo: bar")
-      guess.should == "ISO-8859-1"
-    end
-    it "accepts headers as a hash as well" do
-      guess = GuessHtmlEncoding.guess("<html><body><div>hi!</div></body></html>",
-          {"Hello" => "world", "Content-Type" => "text/html; charset=LATIN1", "Foo" => "bar"})
-      guess.should == "ISO-8859-1"
-    end
-    it "accepts meta tags" do
-      guess = GuessHtmlEncoding.guess('<html><head><meta http-equiv="content-type" content="text/html; charset=LATIN1"></head><body><div>hi!</div></body></html>')
-      guess.should == "ISO-8859-1"
-    end
-    ...
-  end
-  describe "#encode" do
-    it "should work on correctly encoded pages" do
-      data = "<html><head><meta http-equiv='content-type' content='text/html; charset=utf8;'></head><body><div>hi!♥</div></body></html>"
-      data.force_encoding("ASCII-8BIT")
-      data.should be_valid_encoding # everything is valid in binary
-      GuessHtmlEncoding.guess(data).should == "UTF-8" # because the page says so!
-      data.force_encoding("UTF-8").should be_valid_encoding # because it really is utf-8
-      encoded = GuessHtmlEncoding.encode(data)
-      encoded.encoding.to_s.should == "UTF-8"
-      encoded.should be_valid_encoding
-    end
-    it "should work on incorrectly encoded pages" do
-      data = "<html><head><meta http-equiv='content-type' content='text/html; charset=utf8;'></head><body><div>hi!\xc2</div></body></html>"
-      data.force_encoding("ASCII-8BIT")
-      data.should be_valid_encoding # everything is valid in binary
-      GuessHtmlEncoding.guess(data).should == "UTF-8" # because the page says so!
-      data.force_encoding("UTF-8").should_not be_valid_encoding # because of the bad byte sequence \xc2 which is not valid UTF-8
-      encoded = GuessHtmlEncoding.encode(data)
-      encoded.encoding.to_s.should == "UTF-8"
-      encoded.should be_valid_encoding
-    end
-  end
-end
+# GuessHTMLEncoding
+GuessHTMLEncoding is a simple library to guess HTML encodings in Ruby 1.9.  It considers HTTP headers and META tags.
+# Install
+    (sudo) gem install guess_html_encoding
+# Usage
+GuessHTMLEncoding can guess the encoding of an HTML file based on the http-equiv content-type:
+    require 'rubygems'
+    require 'guess_html_encoding'
+    guess = GuessHtmlEncoding.guess(<<-HTML)
+      <html>
+        <head>
+          <meta http-equiv="content-type" content="text/html; charset=LATIN1">
+        </head>
+        <body>
+          <div>hi!</div>
+        </body>
+      </html>
+    HTML
+    guess.should == "ISO-8859-1"
+You can also give it HTTP headers to guess from, which it will prefer, both as a string or as a hash:
+    guess = GuessHtmlEncoding.guess("<html><body><div>hi!</div></body></html>",
+                                    "Hello: world\nContent-Type: text/html; charset=LATIN1\nFoo: bar")
+    guess.should == "ISO-8859-1"
+    guess = GuessHtmlEncoding.guess("<html><body><div>hi!</div></body></html>",
+                                    {"Hello" => "world", "Content-Type" => "text/html; charset=LATIN1", "Foo" => "bar"})
+    guess.should == "ISO-8859-1"
+It's likely that you want to force the encoding of the given HTML into the guessed encoding.  This is easy to do:
+    data = "<html><head><meta http-equiv='content-type' content='text/html; charset=utf8;'></head><body><div>hi!♥</div></body></html>"
+    encoded = GuessHtmlEncoding.encode(data)
+    encoded.encoding.to_s.should == "UTF-8"
+If an encoding cannot be guessed, or Ruby doesn't understand it, UTF-8 will be used and unknown characters will be ignored.
+# Pull requests welcome!

data/lib/guess_html_encoding/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module GuessHtmlEncoding
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/guess_html_encoding.rb CHANGED Viewed

@@ -26,10 +26,10 @@ module GuessHtmlEncoding
     # Translate encodings with other names.
     if out
-      out = "UTF-8" if ["DEFAULT", "UTF8", "UNICODE"].include?(out.upcase)
-      out = "CP1251" if out.upcase == "CP-1251"
-      out = "ISO-8859-1" if ["LATIN1", "LATIN-1"].include?(out.upcase)
-      out = "Windows-1250" if ["WIN-1251", "WIN1251"].include?(out.upcase)
+      out = "UTF-8" if %w[DEFAULT UTF8 UNICODE].include?(out)
+      out = "CP1251" if out == "CP-1251"
+      out = "ISO-8859-1" if %w[LATIN1 LATIN-1].include?(out)
+      out = "Windows-1250" if %w[WIN-1251 WIN1251].include?(out)
     end
     out
@@ -37,12 +37,13 @@ module GuessHtmlEncoding
   # Force an HTML string into a guessed encoding.
   def self.encode(html, headers = nil)
-    encoding = guess(html, (headers || '').gsub(/[\r\n]+/, "\n"))
-    html.force_encoding(encoding_loaded?(encoding) ? encoding : "UTF-8")
-    if html.valid_encoding?
-      html
+    html_copy = html.dup
+    encoding = guess(html_copy, (headers || '').gsub(/[\r\n]+/, "\n"))
+    html_copy.force_encoding(encoding_loaded?(encoding) ? encoding : "UTF-8")
+    if html_copy.valid_encoding?
+      html_copy
     else
-      html.force_encoding('ASCII-8BIT').encode('UTF-8', :undef => :replace, :invalid => :replace)
+      html_copy.force_encoding('ASCII-8BIT').encode('UTF-8', :undef => :replace, :invalid => :replace)
     end
   end

data/spec/guess_html_encoding_spec.rb CHANGED Viewed

@@ -76,7 +76,7 @@ describe "GuessHtmlEncoding" do
       encoded.should be_valid_encoding
     end
-    it "should work on pages encoded with an unloaded encoding" do
+    it "should work on pages encoded with an unknown encoding by forcing them to utf8" do
       data = "<html><head><meta http-equiv='content-type' content='text/html; charset=x-mac-roman;'></head><body><div>hi!</div></body></html>"
       data.force_encoding("ASCII-8BIT")
       data.should be_valid_encoding # everything is valid in binary
@@ -86,6 +86,8 @@ describe "GuessHtmlEncoding" do
       encoded = GuessHtmlEncoding.encode(data)
       encoded.encoding.to_s.should == "UTF-8"
       encoded.should be_valid_encoding
+      data.encoding.to_s.should == "ASCII-8BIT"
     end
   end
@@ -95,6 +97,7 @@ describe "GuessHtmlEncoding" do
         GuessHtmlEncoding.encoding_loaded?(name).should be_true
       end
     end
     it 'returns false for irregular or unloaded encoding' do
       GuessHtmlEncoding.encoding_loaded?('_WHY').should be_false
     end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guess_html_encoding
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease:
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000Z
+date: 2012-04-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70293930 !ruby/object:Gem::Requirement
+  requirement: &75762100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70293930
+  version_requirements: *75762100
 description: This gem helps guess the encoding of an HTML page.
 email:
 - andrew@iterationlabs.com
@@ -33,6 +33,7 @@ files:
 - .rvmrc
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.markdown
 - Rakefile
 - guess_html_encoding.gemspec