html_helpers 1.1.3

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/CHANGELOG

@@ -0,0 +1,14 @@
+*1.1.2* 28 May 2008
+
+* Me <Thomas Maurer> pushed the plugin to GitHub (mainly for using as git submodule)
+* module Leftbee::HTMLHelpers renamed to generic and consitent way of classes in 
+  Rails (like HTML::Sanitizer): HTML::EntityCoder
+
+*1.1.1* 22 August 2006
+
+* module Leftbee::HTMLHelper renamed to Leftbee::HTMLHelpers to be consistent with the name of the plugin and the documentation!
+
+
+*1.1* 21 August 2006
+
+* Slight refactoring to allow the inclusion of the helpers in any class more easily.

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gemspec
+
+group :dev do
+  gem 'rake'
+  gem 'actionpack', '~>3'
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.5)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rake (0.8.7)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3)
+  rake

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2006 Ruben Nine
+HTMLEntities is copyright (c) 2005-2006 Paul Battley
+
+The 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/README

@@ -0,0 +1,44 @@
+HTML::EntityCoder
+=================
+
+This plugin lets you encode and decode (UTF-8) strings using HTML entities.
+Two new methods will be automatically available in your views:
+
+* encode_entities: Encodes a string into a string with HTML entities:
+
+>> <%= encode_entities("Über geek") %>
+=> "&Uuml;ber geek"
+
+* decode_entities: Decodes a string with HTML entities into a string:
+
+>> <%= decode_entities("&Uuml;ber geek") %>
+=> "Über geek"
+
+
+Using Anywhere
+==============
+
+Now it's possible to include the helpers in other classes easily by just including HTML::EntityCoder in your class.
+
+If you *really* need to to use the helpers in a model you can do it like this:
+
+class Person < ActiveRecord::Base
+  include HTML::EntityCoder
+end
+
+or a controller:
+
+class PersonController < ApplicationController
+  include HTML::EntityCoder
+end
+
+etc.
+
+
+Note: Don't feed the helpers with anything else but UTF-8. If you really need to, convert your string to UTF-8 first using Iconv (http://www.ruby-doc.org/stdlib/libdoc/iconv/rdoc/index.html)
+
+A basic test unit is included.
+
+
+HTMLHelpers is copyright (c) 2006 Ruben Nine (ruben.nine@gmail.com), released under the MIT license
+HTMLEntities is copyright (c) 2005-2006 Paul Battley, released under the MIT license

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the html_helpers plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the html_helpers plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HtmlHelpers'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/about.yml

@@ -0,0 +1,7 @@
+author: Ruben Nine
+summary: Encode and decode HTML entities in your views and other classes.
+homepage: http://www.leftbee.net
+plugin: git://github.com/tma/html_helpers.git
+license: MIT
+version: 1.1.1
+rails_version: 1.0+

data/html_helpers.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "html_helpers"
+  s.version     = '1.1.3'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ruben Nine", "Thomas Maurer"]
+  s.email       = ["tma@freshbit.ch"]
+  s.homepage    = "https://github.com/tma/html_helpers"
+  s.summary     = %q{Rails Plugin with Helpers to en- and decode HTML Entities}
+  s.description = %q{Encode and decode HTML entities in your views and other classes}
+  s.license     = 'MIT'
+  
+  s.rubyforge_project = "html_helpers"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/init.rb

@@ -0,0 +1,2 @@
+require "htmlentities"
+require "html_helpers"

data/lib/html_helpers.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2006 Ruben Nine
+#
+# 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.
+
+module HTML
+  module EntityCoder
+    def encode_entities(string)
+      HTMLEntities.encode_entities(string, :basic, :named)
+    end
+
+    def decode_entities(string)
+      HTMLEntities.decode_entities(string)
+    end
+  end
+end
+
+ActionView::Base.send(:include, HTML::EntityCoder) if defined?(ActionView)

data/lib/htmlentities.rb

@@ -0,0 +1,165 @@
+#
+# HTML entity encoding and decoding for Ruby
+#
+
+module HTMLEntities
+  
+  class InstructionError < RuntimeError
+  end
+
+  module Data #:nodoc:
+
+    #
+    # MAP is a hash of all the HTML entities I could discover, as taken
+    # from the w3schools page on the subject:
+    # http://www.w3schools.com/html/html_entitiesref.asp
+    # The format is 'entity name' => codepoint where entity name is given
+    # without the surrounding ampersand and semicolon.
+    #
+    MAP = {
+      'quot'      => 34,        'apos'      => 39,        'amp'       => 38,
+      'lt'        => 60,        'gt'        => 62,        'nbsp'      => 160,
+      'iexcl'     => 161,       'curren'    => 164,       'cent'      => 162,
+      'pound'     => 163,       'yen'       => 165,       'brvbar'    => 166,
+      'sect'      => 167,       'uml'       => 168,       'copy'      => 169,
+      'ordf'      => 170,       'laquo'     => 171,       'not'       => 172,
+      'shy'       => 173,       'reg'       => 174,       'trade'     => 8482,
+      'macr'      => 175,       'deg'       => 176,       'plusmn'    => 177,
+      'sup2'      => 178,       'sup3'      => 179,       'acute'     => 180,
+      'micro'     => 181,       'para'      => 182,       'middot'    => 183,
+      'cedil'     => 184,       'sup1'      => 185,       'ordm'      => 186,
+      'raquo'     => 187,       'frac14'    => 188,       'frac12'    => 189,
+      'frac34'    => 190,       'iquest'    => 191,       'times'     => 215,
+      'divide'    => 247,       'Agrave'    => 192,       'Aacute'    => 193,
+      'Acirc'     => 194,       'Atilde'    => 195,       'Auml'      => 196,
+      'Aring'     => 197,       'AElig'     => 198,       'Ccedil'    => 199,
+      'Egrave'    => 200,       'Eacute'    => 201,       'Ecirc'     => 202,
+      'Euml'      => 203,       'Igrave'    => 204,       'Iacute'    => 205,
+      'Icirc'     => 206,       'Iuml'      => 207,       'ETH'       => 208,
+      'Ntilde'    => 209,       'Ograve'    => 210,       'Oacute'    => 211,
+      'Ocirc'     => 212,       'Otilde'    => 213,       'Ouml'      => 214,
+      'Oslash'    => 216,       'Ugrave'    => 217,       'Uacute'    => 218,
+      'Ucirc'     => 219,       'Uuml'      => 220,       'Yacute'    => 221,
+      'THORN'     => 222,       'szlig'     => 223,       'agrave'    => 224,
+      'aacute'    => 225,       'acirc'     => 226,       'atilde'    => 227,
+      'auml'      => 228,       'aring'     => 229,       'aelig'     => 230,
+      'ccedil'    => 231,       'egrave'    => 232,       'eacute'    => 233,
+      'ecirc'     => 234,       'euml'      => 235,       'igrave'    => 236,
+      'iacute'    => 237,       'icirc'     => 238,       'iuml'      => 239,
+      'eth'       => 240,       'ntilde'    => 241,       'ograve'    => 242,
+      'oacute'    => 243,       'ocirc'     => 244,       'otilde'    => 245,
+      'ouml'      => 246,       'oslash'    => 248,       'ugrave'    => 249,
+      'uacute'    => 250,       'ucirc'     => 251,       'uuml'      => 252,
+      'yacute'    => 253,       'thorn'     => 254,       'yuml'      => 255,
+      'OElig'     => 338,       'oelig'     => 339,       'Scaron'    => 352,
+      'scaron'    => 353,       'Yuml'      => 376,       'circ'      => 710,
+      'tilde'     => 732,       'ensp'      => 8194,      'emsp'      => 8195,
+      'thinsp'    => 8201,      'zwnj'      => 8204,      'zwj'       => 8205,
+      'lrm'       => 8206,      'rlm'       => 8207,      'ndash'     => 8211,
+      'mdash'     => 8212,      'lsquo'     => 8216,      'rsquo'     => 8217,
+      'sbquo'     => 8218,      'ldquo'     => 8220,      'rdquo'     => 8221,
+      'bdquo'     => 8222,      'dagger'    => 8224,      'Dagger'    => 8225,
+      'hellip'    => 8230,      'permil'    => 8240,      'lsaquo'    => 8249,
+      'rsaquo'    => 8250,      'euro'      => 8364 
+    }
+
+    MIN_LENGTH = MAP.keys.map{ |a| a.length }.min
+    MAX_LENGTH = MAP.keys.map{ |a| a.length }.max
+    NAMED_ENTITY_REGEXP = /&([a-z]{#{MIN_LENGTH},#{MAX_LENGTH}});/i
+    REVERSE_MAP = MAP.invert
+
+    BASIC_ENTITY_REGEXP = /[<>'"&]/
+
+    UTF8_NON_ASCII_REGEXP = /[\x00-\x1f]|[\xc0-\xfd][\x80-\xbf]+/
+
+    ENCODE_ENTITIES_COMMAND_ORDER = { 
+      :basic => 0,
+      :named => 1,
+      :decimal => 2,
+      :hexadecimal => 3
+    }
+  
+  end
+  
+  #
+  # Decode XML and HTML 4.01 entities in a string into their UTF-8
+  # equivalents.  Obviously, if your string is not already in UTF-8, you'd
+  # better convert it before using this method, or the output will be mixed
+  # up.
+  #
+  # Unknown named entities are not converted
+  #
+  def decode_entities(string)
+    return string.gsub(Data::NAMED_ENTITY_REGEXP) { 
+      (cp = Data::MAP[$1]) ? [cp].pack('U') : $& 
+    }.gsub(/&#([0-9]{1,7});|&#x([0-9a-f]{1,6});/i) { 
+      $1 ? [$1.to_i].pack('U') : [$2.to_i(16)].pack('U') 
+    }
+  end
+  
+  #
+  # Encode codepoints into their corresponding entities.  Various operations
+  # are possible, and may be specified in order:
+  #
+  # :basic :: Convert the five XML entities ('"<>&)
+  # :named :: Convert non-ASCII characters to their named HTML 4.01 equivalent
+  # :decimal :: Convert non-ASCII characters to decimal entities (e.g. &#1234;)
+  # :hexadecimal :: Convert non-ASCII characters to hexadecimal entities (e.g. # &#x12ab;)
+  #
+  # You can specify the commands in any order, but they will be executed in
+  # the order listed above to ensure that entity ampersands are not
+  # clobbered and that named entities are replaced before numeric ones.
+  #
+  # If no instructions are specified, :basic will be used.
+  #
+  # Examples:
+  #   encode_entities(str) - XML-safe
+  #   encode_entities(str, :basic, :decimal) - XML-safe and 7-bit clean
+  #   encode_entities(str, :basic, :named, :decimal) - 7-bit clean, with all
+  #   non-ASCII characters replaced with their named entity where possible, and
+  #   decimal equivalents otherwise.
+  #
+  # Note: It is the program's responsibility to ensure that the string
+  # contains valid UTF-8 before calling this method.
+  #
+  def encode_entities(string, *instructions)
+    output = nil
+    if (instructions.empty?)
+      instructions = [:basic] 
+    else
+      instructions = instructions.sort_by { |instruction| 
+        Data::ENCODE_ENTITIES_COMMAND_ORDER[instruction] || 
+        (raise InstructionError, "unknown encode_entities command `#{instruction.inspect}'")
+      }
+    end
+    instructions.each do |instruction|
+      case instruction
+      when :basic
+        # Handled as basic ASCII
+        output = (output || string).gsub(Data::BASIC_ENTITY_REGEXP) {
+          # It's safe to use the simpler [0] here because we know
+          # that the basic entities are ASCII.
+          '&' << Data::REVERSE_MAP[$&[0]] << ';'
+        }
+      when :named
+        # Test everything except printable ASCII 
+        output = (output || string).gsub(Data::UTF8_NON_ASCII_REGEXP) {
+          cp = $&.unpack('U')[0]
+          (e = Data::REVERSE_MAP[cp]) ?  "&#{e};" : $&
+        }
+      when :decimal
+        output = (output || string).gsub(Data::UTF8_NON_ASCII_REGEXP) {
+          "&##{$&.unpack('U')[0]};"
+        }
+      when :hexadecimal
+        output = (output || string).gsub(Data::UTF8_NON_ASCII_REGEXP) {
+          "&#x#{$&.unpack('U')[0].to_s(16)};"
+        }
+      end 
+    end
+    return output
+  end
+  
+  extend self
+  
+end

data/test/html_helpers_test.rb

@@ -0,0 +1,42 @@
+require "test/unit"
+require "action_view"
+require "init"
+
+class HtmlEntityCoderTest < Test::Unit::TestCase
+  include HTML::EntityCoder
+
+  def test_basic_encoding
+    assert_equal encode_entities("This is <em>emphasized</em>!"),
+                                 "This is &lt;em&gt;emphasized&lt;/em&gt;!"
+  end
+
+  def test_basic_decoding
+    assert_equal decode_entities("This is &lt;em&gt;emphasized&lt;/em&gt;!"),
+                                 "This is <em>emphasized</em>!"
+  end
+
+  def test_decoding_numeric_entities
+    assert_equal decode_entities("This is &#60;em&#62;emphasized&#60;/em&#62;!"),
+                                 "This is <em>emphasized</em>!"
+  end
+
+  def test_decoding_hex_entities
+    assert_equal decode_entities("This is &#x3C;em&#x3E;emphasized&#x3C;/em&#x3E;!"),
+                                 "This is <em>emphasized</em>!"
+  end
+
+  def test_decoding_mixed_entities
+    assert_equal decode_entities("This is &lt;em&#x3E;emphasized&lt;/em&#62;!"),
+                                 "This is <em>emphasized</em>!"
+  end
+
+  def test_text_encoding
+    assert_equal encode_entities("Ursache sind die hohen Zuflüsse des Regen, der Teile des Bayerischen Waldes entwässert.\nDort ist immer noch die Schneeschmelze im Gange, außerdem hat es Freitag dort teils kräftige Schauer gegeben."),
+                                 "Ursache sind die hohen Zufl&uuml;sse des Regen, der Teile des Bayerischen Waldes entw&auml;ssert.\nDort ist immer noch die Schneeschmelze im Gange, au&szlig;erdem hat es Freitag dort teils kr&auml;ftige Schauer gegeben."
+  end
+
+  def test_text_decoding
+    assert_equal decode_entities("Ursache sind die hohen Zufl&uuml;sse des Regen, der Teile des Bayerischen Waldes entw&auml;ssert.\nDort ist immer noch die Schneeschmelze im Gange, au&szlig;erdem hat es Freitag dort teils kr&auml;ftige Schauer gegeben."),
+                                 "Ursache sind die hohen Zuflüsse des Regen, der Teile des Bayerischen Waldes entwässert.\nDort ist immer noch die Schneeschmelze im Gange, außerdem hat es Freitag dort teils kräftige Schauer gegeben."
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: html_helpers
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 3
+  version: 1.1.3
+platform: ruby
+authors: 
+- Ruben Nine
+- Thomas Maurer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-13 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Encode and decode HTML entities in your views and other classes
+email: 
+- tma@freshbit.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README
+- Rakefile
+- about.yml
+- html_helpers.gemspec
+- init.rb
+- lib/html_helpers.rb
+- lib/htmlentities.rb
+- test/html_helpers_test.rb
+has_rdoc: true
+homepage: https://github.com/tma/html_helpers
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: html_helpers
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Rails Plugin with Helpers to en- and decode HTML Entities
+test_files: 
+- test/html_helpers_test.rb