joenoon-strip_attributes 1.1.3

data/README.rdoc

@@ -0,0 +1,56 @@
+== StripAttributes
+
+StripAttributes is a Rails plugin that automatically strips all ActiveRecord
+model attributes of leading and trailing whitespace before validation. If the
+attribute is blank, it strips the value to +nil+.
+
+It works by adding a before_validation hook to the record.  By default, all
+attributes are stripped of whitespace, but <tt>:only</tt> and <tt>:except</tt>
+options can be used to limit which attributes are stripped.  Both options accept
+a single attribute (<tt>:only => :field</tt>) or arrays of attributes (<tt>:except =>
+[:field1, :field2, :field3]</tt>).
+
+=== Changes from the original StripAttributes
+
+Defaults to all models get stripping, and options per-model can be overrriden.  Inspired by the xss_terminate style.
+
+=== Examples
+
+  # all attributes will be stripped (default)
+  class DrunkPokerPlayer < ActiveRecord::Base
+  end
+
+  # all attributes will be stripped except :boxers
+  class SoberPokerPlayer < ActiveRecord::Base
+    strip_attributes! :except => :boxers
+  end
+
+  # only :shoe, :sock, and :glove will be stripped
+  class ConservativePokerPlayer < ActiveRecord::Base
+    strip_attributes! :only => [:shoe, :sock, :glove]
+  end
+
+=== Installation
+  
+  gem 'strip_attributes', :git => 'http://github.com/joenoon/strip_attributes.git'
+
+=== Credits
+
+StripAttributes source is hosted on GitHub[http://github.com/]:
+http://github.com/joenoon/strip_attributes
+
+Original Credits:
+
+The idea was triggered by the information at
+http://wiki.rubyonrails.org/rails/pages/HowToStripWhitespaceFromModelFields
+but was modified from the original to include more idiomatic ruby and rails
+support.
+
+Original StripAttributes source is hosted on GitHub[http://github.com/]:
+http://github.com/rmm5t/strip_attributes
+
+=== License
+
+Copyright (c) 2009-2010 Joe Noon released under the MIT license
+Copyright (c) 2007-2008 Ryan McGeary released under the MIT license
+http://en.wikipedia.org/wiki/MIT_License

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the stripattributes plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the stripattributes plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Stripattributes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Publishes rdoc to rubyforge server'
+task :publish_rdoc => :rdoc do
+  cmd = "scp -r rdoc/* rmm5t@rubyforge.org:/var/www/gforge-projects/stripattributes"
+  puts "\nPublishing rdoc: #{cmd}\n\n"
+  system(cmd)
+end
+

data/lib/strip_attributes.rb

@@ -0,0 +1,47 @@
+module StripAttributes
+
+  def self.included(klass)
+    klass.send :extend, ClassMethods
+    # sets up default of stripping for all fields
+    klass.send :strip_attributes!
+    klass.class_inheritable_reader :strip_attributes_options
+    klass.send :include, InstanceMethods
+  end
+
+  module ClassMethods
+    def strip_attributes!(options = {})
+      write_inheritable_attribute(:strip_attributes_options, {
+        :except => Array(options[:except] || []),
+        :only => Array(options[:only] || [])
+      })
+    end
+  end
+  
+  module InstanceMethods
+
+    def strip_attributes!
+      return if strip_attributes_options.nil?
+      
+      self.class.columns.each do |column|
+        next unless (column.type == :string || column.type == :text)
+        
+        field = column.name.to_sym
+        value = self[field]
+
+        if !value.respond_to?(:strip)
+          next
+        elsif strip_attributes_options[:except].include?(field)
+          next
+        elsif strip_attributes_options[:only].any? && !strip_attributes_options[:only].include?(field)
+          next
+        else
+          self[field] = (value.blank?) ? nil : value.strip
+        end
+      end
+      
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, StripAttributes
+ActiveRecord::Base.before_validation :strip_attributes!

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: joenoon-strip_attributes
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 3
+  version: 1.1.3
+platform: ruby
+authors: 
+- Joe Noon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-23 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: StripAttributes is a Rails plugin that automatically strips all ActiveRecord model attributes of leading and trailing whitespace before validation. If the attribute is blank, it strips the value to nil.
+email: joenoon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.rdoc
+- lib/strip_attributes.rb
+has_rdoc: true
+homepage: http://github.com/joenoon
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: strip_attributes
+test_files: []
+