laserlemon-nullify 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Steve Richert
+
+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/Manifest

@@ -0,0 +1,11 @@
+init.rb
+lib/nullify.rb
+Manifest
+MIT-LICENSE
+nullify.gemspec
+Rakefile
+README.rdoc
+tasks/nullify_tasks.rake
+test/nullify_test.rb
+test/test_helper.rb
+VERSION.yml

data/README.rdoc

@@ -0,0 +1,45 @@
+= nullify
+
+<tt>nullify</tt> makes it easy to clean up blank attributes that result from creating ActiveRecord objects directly from form params. You may specify any number of attributes (including non-column attributes) to nullify.
+
+== Installation
+
+  script/plugin install git://github.com/laserlemon/nullify.git
+
+== Example
+
+In your model:
+
+  class User < ActiveRecord::Base
+    validates_presence_of :first_name, :last_name
+    nullify :middle_name
+    
+    def name
+      [first_name, middle_name, last_name].compact.join(' ')
+    end
+  end
+
+In your "new" view:
+
+  <% form_for @user do |f| %>
+    <%= f.text_field :first_name %>
+    <%= f.text_field :middle_name %>
+    <%= f.text_field :last_name %>
+    <%= submit_tag 'Save' %>
+  <% end %>
+
+In your controller:
+
+  def create
+    @user = User.create(params[:user])
+  end
+
+In your "show" view:
+
+  <%=h @user.name %>
+
+== Tips
+
+* Performs its nullification before validation, allowing for easy use of +allow_nil+ validation options
+* Uses ActiveRecord's dynamic getters and setters, meaning it will also work for your own custom, non-column getters/setters
+* Works for non-string attributes that respond to <tt>blank?</tt>

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('nullify', '0.1.0') do |g|
+  g.description = %(Nuke blank values in ActiveRecord models)
+  g.url = 'http://github.com/laserlemon/nullify'
+  g.author = 'Steve Richert'
+  g.email = 'steve@laserlemon.com'
+  g.ignore_pattern = %w(tmp/* script/*)
+  g.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each{|t| load t }

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 1
+:patch: 0

data/init.rb

@@ -0,0 +1 @@
+require 'nullify'

data/lib/nullify.rb

@@ -0,0 +1,27 @@
+module LaserLemon
+  module Nullify
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def nullify(*columns)
+        write_inheritable_array :nullified_columns, columns.map(&:to_sym)
+        class_inheritable_reader :nullified_columns
+        include InstanceMethods
+        before_validation :nullify_columns
+      end
+    end
+    
+    module InstanceMethods
+      def nullify_columns
+        self.class.nullified_columns.each do |column|
+          value = send(column)
+          send("#{column}=", nil) if value.blank? && !value.nil?
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, LaserLemon::Nullify)

data/nullify.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nullify}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steve Richert"]
+  s.date = %q{2009-04-28}
+  s.description = %q{Nuke blank values in ActiveRecord models}
+  s.email = %q{steve@laserlemon.com}
+  s.extra_rdoc_files = ["lib/nullify.rb", "README.rdoc", "tasks/nullify_tasks.rake"]
+  s.files = ["init.rb", "lib/nullify.rb", "Manifest", "MIT-LICENSE", "nullify.gemspec", "Rakefile", "README.rdoc", "tasks/nullify_tasks.rake", "test/nullify_test.rb", "test/test_helper.rb", "VERSION.yml"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/laserlemon/nullify}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Nullify", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{nullify}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Nuke blank values in ActiveRecord models}
+  s.test_files = ["test/nullify_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/tasks/nullify_tasks.rake

@@ -0,0 +1,26 @@
+def get_class
+  klass = ENV['CLASS'] || ENV['class']
+  raise 'Must specify CLASS' unless klass
+  @class = Object.const_get(klass)
+end
+ 
+def get_columns
+  raise "Class #{@class.name} has no nullified columns" unless @class.respond_to?(:nullified_columns)
+  @columns = if column = ENV['COLUMN'] || ENV['column']
+    raise "Class #{@class.name} has no nullified column #{column}" unless @class.nullified_columns.include?(column.to_sym)
+    [column.to_sym]
+  else @class.nullified_columns
+  end
+end
+
+desc 'Sets blank columns to nil for a given CLASS (and optional COLUMN)'
+task :nullify => :environment do
+  get_class and get_columns
+  @class.all.each do |instance|
+    @columns.each do |column|
+      value = instance.send(column)
+      instance.send("#{column}=", nil) if value.blank? && !value.nil?
+    end
+    instance.save
+  end
+end

data/test/nullify_test.rb

@@ -0,0 +1,89 @@
+require 'test/unit'
+
+require 'rubygems'
+require 'active_record'
+
+require "#{File.dirname(__FILE__)}/../init"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :addresses do |t|
+      t.string :street_1, :null => false
+      t.string :street_2, :null => true
+      t.string :city, :null => false
+      t.string :state, :null => false
+      t.string :zip, :null => false
+      t.string :zip_4, :null => true
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Address < ActiveRecord::Base
+  
+  nullify :street_2, :zip_4
+  
+  validates_presence_of :street_1, :city, :zip
+  validates_format_of :zip, :with => /^\d{5}$/, :allow_nil => false
+  validates_format_of :zip_4, :with => /^\d{4}/, :allow_nil => true
+end
+
+class AddressTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+    Address.create!(
+      :street_1 => 'Department of the Teasury',
+      :street_2 => 'Internal Revenue Service',
+      :city => 'Kansas City',
+      :state => 'Missouri',
+      :zip => '64999',
+      :zip_4 => '0102'
+    )
+    Address.create!(
+      :street_1 => '1 Infinite Loop',
+      :city => 'Cupertino',
+      :state => 'California',
+      :zip => '95014'
+    )
+  end
+  
+  def irs
+    Address.first
+  end
+  
+  def apple
+    Address.last
+  end
+
+  def teardown
+    teardown_db
+  end
+  
+  def test_no_nullification_needed
+    before = irs.attributes
+    irs.save
+    after = irs.attributes
+    assert_equal(before, after)
+    before = apple.attributes
+    apple.save
+    after = apple.attributes
+    assert_equal(before, after)
+  end
+  
+  def test_nullification_needed
+    assert(irs.update_attributes(:zip_4 => ''))
+    assert_nil(irs.zip_4)
+    assert(irs.update_attributes(:zip_4 => ' '))
+    assert_nil(irs.zip_4)
+    assert(irs.update_attributes(:zip_4 => '1939'))
+    assert_equal('1939', irs.zip_4)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: laserlemon-nullify
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Steve Richert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Nuke blank values in ActiveRecord models
+email: steve@laserlemon.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/nullify.rb
+- README.rdoc
+- tasks/nullify_tasks.rake
+files: 
+- init.rb
+- lib/nullify.rb
+- Manifest
+- MIT-LICENSE
+- nullify.gemspec
+- Rakefile
+- README.rdoc
+- tasks/nullify_tasks.rake
+- test/nullify_test.rb
+- test/test_helper.rb
+- VERSION.yml
+has_rdoc: true
+homepage: http://github.com/laserlemon/nullify
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Nullify
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: nullify
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Nuke blank values in ActiveRecord models
+test_files: 
+- test/nullify_test.rb
+- test/test_helper.rb