replace_entities 1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 James Healy
+
+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.rdoc

@@ -0,0 +1,52 @@
+== Replace Entities
+
+If you import data from confused sources you may end up with HTMLish entites
+littering your model data. I'm looking at you ®
+
+If you don't want them, then replace them with the appropriate UTF-8 character
+before they make it into your database.
+
+
+=== Examples
+
+  class Product < ActiveRecord::Base
+    replace_entities!
+  end
+
+  class Product < ActiveRecord::Base
+    replace_entities!, :except => :title
+  end
+
+  class Product < ActiveRecord::Base
+    replace_entities!, :only => :description
+  end
+
+=== Installation
+
+Option 1. Load the plugin as a gem
+
+  gem install replace_entities
+  add "config.gem 'replace_entities'" to your environment.rb
+
+Option 2. Use the standard Rails plugin install (assuming Rails >= 2.1).
+
+  ./script/plugin install git://github.com/yob/replace_entities.git
+
+=== Caveats
+
+The entities are replaced with UTF-8 characters. If you're not expecting UTF-8
+data, you may end up with invalid strings.
+
+=== Credits
+
+This plugin is essentially a fork of the strip attributes plugin, released
+under the MIT License by Ryan McGeary.
+
+http://github.com/rmm5t/strip_attributes
+
+=== License
+
+Copyright (c) 2007-2008 Ryan McGeary released under the MIT license
+Copyright (c) 2010 James Healy released under the MIT license
+
+http://en.wikipedia.org/wiki/MIT_License

data/Rakefile

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

data/init.rb

@@ -0,0 +1,2 @@
+require 'replace_entities'
+ActiveRecord::Base.extend(ReplaceEntities)

data/lib/replace_entities.rb

@@ -0,0 +1,34 @@
+require 'htmlentities'
+
+module ReplaceEntities
+  # Strips ASCII control chars from attributes before they get saved
+  def replace_entities!(options = nil)
+    before_validation do |record|
+      attributes = ReplaceEntities.narrow(record.attributes, options)
+      attributes.each do |attr, value|
+        if value.is_a?(String)
+          coder = HTMLEntities.new
+          record[attr] = coder.decode(value)
+        end
+      end
+    end
+  end
+
+  # Necessary because Rails has removed the narrowing of attributes using :only
+  # and :except on Base#attributes
+  def self.narrow(attributes, options)
+    if options.nil?
+      attributes
+    else
+      if except = options[:except]
+        except = Array(except).collect { |attribute| attribute.to_s }
+        attributes.except(*except)
+      elsif only = options[:only]
+        only = Array(only).collect { |attribute| attribute.to_s }
+        attributes.slice(*only)
+      else
+        raise ArgumentError, "Options does not specify :except or :only (#{options.keys.inspect})"
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'replace_entities'
+ActiveRecord::Base.extend(ReplaceEntities)

data/test/replace_entities_test.rb

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+require "#{File.dirname(__FILE__)}/test_helper"
+
+module MockAttributes
+  def self.included(base)
+    base.column :foo, :string
+    base.column :bar, :string
+    base.column :biz, :string
+    base.column :baz, :string
+  end
+end
+
+class ConvertAllMockRecord < ActiveRecord::Base
+  include MockAttributes
+  replace_entities!
+end
+
+class ConvertOnlyOneMockRecord < ActiveRecord::Base
+  include MockAttributes
+  replace_entities! :only => :foo
+end
+
+class ConvertOnlyThreeMockRecord < ActiveRecord::Base
+  include MockAttributes
+  replace_entities! :only => [:foo, :bar, :biz]
+end
+
+class ConvertExceptOneMockRecord < ActiveRecord::Base
+  include MockAttributes
+  replace_entities! :except => :foo
+end
+
+class ConvertExceptThreeMockRecord < ActiveRecord::Base
+  include MockAttributes
+  replace_entities! :except => [:foo, :bar, :biz]
+end
+
+class ReplaceEntitiesTest < Test::Unit::TestCase
+  def setup
+    @init_params = { :foo => "foo&reg;", :bar => "bar&copy;", :biz => "biz&lt;", :baz => "baz&gt;" }
+  end
+
+  def test_should_exist
+    assert Object.const_defined?(:ReplaceEntities)
+  end
+
+  def test_should_fix_all_fields
+    record = ConvertAllMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "foo®", record.foo
+    assert_equal "bar©", record.bar
+    assert_equal "biz<", record.biz
+    assert_equal "baz>", record.baz
+  end
+
+  def test_should_convert_only_one_field
+    record = ConvertOnlyOneMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "foo®", record.foo
+    assert_equal "bar&copy;", record.bar
+    assert_equal "biz&lt;", record.biz
+    assert_equal "baz&gt;", record.baz
+  end
+
+  def test_should_convert_only_three_fields
+    record = ConvertOnlyThreeMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "foo®", record.foo
+    assert_equal "bar©", record.bar
+    assert_equal "biz<", record.biz
+    assert_equal "baz&gt;", record.baz
+  end
+
+  def test_should_convert_all_except_one_field
+    record = ConvertExceptOneMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "foo&reg;", record.foo
+    assert_equal "bar©", record.bar
+    assert_equal "biz<", record.biz
+    assert_equal "baz>", record.baz
+  end
+
+  def test_should_convert_all_except_three_fields
+    record = ConvertExceptThreeMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "foo&reg;", record.foo
+    assert_equal "bar&copy;", record.bar
+    assert_equal "biz&lt;", record.biz
+    assert_equal "baz>", record.baz
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+
+PLUGIN_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+$LOAD_PATH.unshift "#{PLUGIN_ROOT}/lib"
+require "#{PLUGIN_ROOT}/init"
+
+class ActiveRecord::Base
+  alias_method :save, :valid?
+  def self.columns()
+    @columns ||= []
+  end
+
+  def self.column(name, sql_type = nil, default = nil, null = true)
+    @columns ||= []
+    @columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type, null)
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: replace_entities
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-03 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: htmlentities
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: a small ActiveRecord plugin that removes common HTML entities from attributes
+email: james@yob.id.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- init.rb
+- rails/init.rb
+- lib/replace_entities.rb
+- Rakefile
+- MIT-LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/yob/replace_entities
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Replace Entities
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: a small ActiveRecord plugin that removes common HTML entities from attributes
+test_files: 
+- test/replace_entities_test.rb
+- test/test_helper.rb