strip_control_chars 1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Peter Yandell
+
+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,54 @@
+== Strip Control Chars
+
+At the lower end of the ASCII range are a few control characters that are
+generally innocent but useless. Often benign, they sometimes jump out and bite
+you when you're trying to do something simple like generate some XML.
+
+If you model doesn't need them, then remove them before they even make it into
+your database.
+
+=== Examples
+
+  class Product < ActiveRecord::Base
+    strip_control_chars!
+  end
+
+  class Product < ActiveRecord::Base
+    strip_control_chars!, :except => :title
+  end
+
+  class Product < ActiveRecord::Base
+    strip_control_chars!, :only => :description
+  end
+
+=== Installation
+
+Option 1. Load the plugin as a gem
+
+  gem install strip_control_chars
+  add "config.gem 'strip_control_chars'" to your environment.rb
+
+Option 2. Use the standard Rails plugin install (assuming Rails >= 2.1).
+
+  ./script/plugin install git://github.com/yob/strip_control_chars.git
+
+=== Caveats
+
+The translation is done with raw bytes. If you happen to be using anything other than
+UTF-8 in your models, you're likely to munge data.
+
+This also means it's almost certainly not ruby 1.9 compatible. Patches welcome.
+
+=== 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) 2009 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 dumb quotes plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Dumb Quotes'
+  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 'strip_control_chars'
+ActiveRecord::Base.extend(StripControlChars)

data/lib/strip_control_chars.rb

@@ -0,0 +1,35 @@
+module StripControlChars
+  # Strips ASCII control chars from attributes before they get saved
+  def strip_control_chars!(options = nil)
+    before_validation do |record|
+      attributes = StripControlChars.narrow(record.attributes, options)
+      attributes.each do |attr, value|
+        if value.respond_to?(:tr)
+          value = value.tr("\x00\x01\x02\x03\x04\x05\x06\x07\x08","         ")
+          value = value.tr("\x0B\x0C\x0E\x0F\x10\x11\x12\x13\x14","         ")
+          value = value.tr("\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D","         ")
+          value = value.tr("\x1E\x1F","  ")
+          record[attr] = 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 'strip_control_chars'
+ActiveRecord::Base.extend(StripControlChars)

data/test/strip_control_chars_test.rb

@@ -0,0 +1,90 @@
+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
+  strip_control_chars!
+end
+
+class ConvertOnlyOneMockRecord < ActiveRecord::Base
+  include MockAttributes
+  strip_control_chars! :only => :foo
+end
+
+class ConvertOnlyThreeMockRecord < ActiveRecord::Base
+  include MockAttributes
+  strip_control_chars! :only => [:foo, :bar, :biz]
+end
+
+class ConvertExceptOneMockRecord < ActiveRecord::Base
+  include MockAttributes
+  strip_control_chars! :except => :foo
+end
+
+class ConvertExceptThreeMockRecord < ActiveRecord::Base
+  include MockAttributes
+  strip_control_chars! :except => [:foo, :bar, :biz]
+end
+
+class DumbQuotesTest < Test::Unit::TestCase
+  def setup
+    @init_params = { :foo => "foo\x00", :bar => "bar\x07", :biz => "biz\x09", :baz => "baz\x1E" }
+  end
+
+  def test_should_exist
+    assert Object.const_defined?(:StripControlChars)
+  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\x09", 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\x07", record.bar
+    assert_equal "biz\x09", record.biz
+    assert_equal "baz\x1E", 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\x09", record.biz
+    assert_equal "baz\x1E", record.baz
+  end
+
+  def test_should_convert_all_except_one_field
+    record = ConvertExceptOneMockRecord.new(@init_params)
+    record.valid?
+    assert_equal "foo\x00", record.foo
+    assert_equal "bar ", record.bar
+    assert_equal "biz\x09", 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\x00", record.foo
+    assert_equal "bar\x07", record.bar
+    assert_equal "biz\x09", 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,63 @@
+--- !ruby/object:Gem::Specification 
+name: strip_control_chars
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-06 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: a small ActiveRecord plugin that removes ASCII control chars from attributes
+email: james@yob.id.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- init.rb
+- rails/init.rb
+- lib/strip_control_chars.rb
+- Rakefile
+- MIT-LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/yob/strip_control_chars/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Strip Control Chars
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: yob-projects
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: a small ActiveRecord plugin that removes ASCII control chars from attributes
+test_files: 
+- test/strip_control_chars_test.rb
+- test/test_helper.rb