replace_entities 1.1 → 2.0

data/README.rdoc

@@ -23,14 +23,24 @@ before they make it into your database.
 
 === Installation
 
-Option 1. Load the plugin as a gem
+1. On rails 2.3
 
-  gem install replace_entities
-  add "config.gem 'replace_entities'" to your environment.rb
+  * gem install strip_control_chars
+  * add the following to your environment.rb
 
-Option 2. Use the standard Rails plugin install (assuming Rails >= 2.1).
+    config.gem 'replace_entities', version => "<2.0"
 
-  ./script/plugin install git://github.com/yob/replace_entities.git
+2. On rails 3
+
+  * gem install strip_control_chars
+  * add the following to your Gemfile
+
+    gem 'replace_entities', ">=2.0"
+
+=== Compatibility
+
+On rails 2.x you must use version 1.x of this gem. On rails 3.x you must use
+version 2.x of this gem.
 
 === Caveats
 

data/lib/replace_entities.rb

@@ -1,34 +1,2 @@
-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
+require 'replace_entities/ar_extend'
+require 'replace_entities/railtie'

data/lib/replace_entities/ar_extend.rb

@@ -0,0 +1,36 @@
+require 'htmlentities'
+
+module ReplaceEntities
+  module ArExtend
+    # Strips ASCII control chars from attributes before they get saved
+    def replace_entities!(options = nil)
+      before_validation do |record|
+        attributes = ReplaceEntities::ArExtend.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
+end

data/lib/replace_entities/railtie.rb

@@ -0,0 +1,14 @@
+require 'replace_entities'
+require 'rails'
+
+module ReplaceEntities
+  class Railtie < Rails::Railtie
+
+    initializer "replace_entities.active_record" do |app|
+      if defined?(::ActiveRecord)
+        ::ActiveRecord::Base.extend(ReplaceEntities::ArExtend)
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -5,9 +5,10 @@ require 'active_record'
 PLUGIN_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
 
 $LOAD_PATH.unshift "#{PLUGIN_ROOT}/lib"
-require "#{PLUGIN_ROOT}/init"
+require "replace_entities"
 
 class ActiveRecord::Base
+  extend ReplaceEntities::ArExtend
   alias_method :save, :valid?
   def self.columns()
     @columns ||= []

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: replace_entities
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 3
   prerelease: false
   segments: 
-  - 1
-  - 1
-  version: "1.1"
+  - 2
+  - 0
+  version: "2.0"
 platform: ruby
 authors: 
 - James Healy
@@ -37,13 +37,15 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - <=
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 197
+        hash: 7712042
         segments: 
-        - 2
-        - 99
-        version: "2.99"
+        - 3
+        - 0
+        - 0
+        - rc
+        version: 3.0.0.rc
   type: :runtime
   version_requirements: *id002
 description: a small ActiveRecord plugin that removes common HTML entities from attributes
@@ -55,9 +57,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- init.rb
-- rails/init.rb
 - lib/replace_entities.rb
+- lib/replace_entities/ar_extend.rb
+- lib/replace_entities/railtie.rb
 - Rakefile
 - MIT-LICENSE
 - README.rdoc

data/init.rb

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

data/rails/init.rb

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