railsgarden-nilify_blanks 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+* [0.1.0] Initial Version

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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,39 @@
+== Nilify Blanks
+
+In Rails when saving a model from a form and values are not provided by the user, an empty string is recorded to the database instead of a NULL as many would prefer (mixing blanks and NULLs can become confusing).  This plugin allows you to specify a list of attributes (or exceptions from all the attributes) that will be converted to nil if they are blank before a model is saved.  
+
+Only attributes responding to empty? with a value of true will be converted to nil.  Therefore, this does not work with integer fields with the value of 0, for example.  Usage is best shown through examples:
+
+== Install
+
+  # In environment.rb
+  config.gem 'railsgarden-nilify_blanks', :lib => 'nilify_blanks', :source => 'http://gems.github.com'
+
+== Basic Examples
+
+  # Checks and converts all fields in the model
+  class Post < ActiveRecord::Base
+    nilify_blanks
+  end
+  
+  # Checks and converts only the title and author fields
+  class Post < ActiveRecord::Base
+    nilify_blanks :only => [:author, :title]
+  end
+  
+  # Checks and converts all fields except for title and author
+  class Post < ActiveRecord::Base
+    nilify_blanks :except => [:author, :title]
+  end
+  
+== Specifying a Callback
+
+Checking uses an ActiveRecord before_save filter by default, but you can specify a different filter with the :before option.  Any filter will work - just first remove the "before_" prefix from the name.
+
+  class Post < ActiveRecord::Base
+    nilify_blanks :before => :create
+  end
+  
+  class Post < ActiveRecord::Before
+    nilify_blanks :before => :validation_on_update
+  end

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'echoe'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the nilify_blanks plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the nilify_blanks plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NilifyBlanks'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Echoe.new('nilify_blanks', '0.1.0') do |p|
+  p.description    = "Auto-convert blank fields to nil."
+  p.url            = "http://github.com/railsgarden/nilify_blanks"
+  p.author         = "Ben Hughes"
+  p.email          = "ben@railsgarden.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/init.rb

@@ -0,0 +1,3 @@
+require 'nilify_blanks'
+
+ActiveRecord::Base.send(:include, Rubiety::NilifyBlanks)

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/nilify_blanks.rb

@@ -0,0 +1,46 @@
+module Rubiety
+  module NilifyBlanks
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def nilify_blanks(options = {})
+        return if self.included_modules.include?(NilifyBlanks::InstanceMethods)
+        include NilifyBlanks::InstanceMethods
+        
+        if options[:only]
+          options[:only] = [options[:only]] unless options[:only].is_a?(Array)
+          options[:only] = options[:only].map(&:to_s)
+        end
+        
+        if options[:except]
+          options[:except] = [options[:except]] unless options[:except].is_a?(Array)
+          options[:except] = options[:except].map(&:to_s)
+        end
+        
+        cattr_accessor :nilify_blanks_columns
+        
+        self.nilify_blanks_columns = self.content_columns.reject {|c| !c.null }.map {|c| c.name.to_s }
+        self.nilify_blanks_columns = self.nilify_blanks_columns.select {|c| options[:only].include?(c) } if options[:only]
+        self.nilify_blanks_columns -= options[:except] if options[:except]
+        self.nilify_blanks_columns = self.nilify_blanks_columns.map(&:to_s)
+        
+        options[:before] ||= :save
+        class_eval "before_#{options[:before]} :nilify_blanks"
+      end
+    end
+    
+    module InstanceMethods
+      def nilify_blanks
+        (self.nilify_blanks_columns || []).each do |column|
+          value = read_attribute(column)
+          next unless value.is_a?(String)
+          next unless value.nil? or !value.respond_to?(:blank)
+          
+          write_attribute(column, nil) if value.blank?
+        end
+      end
+    end
+  end
+end

data/nilify_blanks.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nilify_blanks}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Hughes"]
+  s.date = %q{2009-01-16}
+  s.description = %q{Auto-convert blank fields to nil.}
+  s.email = %q{ben@railsgarden.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/nilify_blanks.rb", "README.rdoc", "tasks/nilify_blanks_tasks.rake"]
+  s.files = ["CHANGELOG", "init.rb", "install.rb", "lib/nilify_blanks.rb", "Manifest", "MIT-LICENSE", "nilify_blanks.gemspec", "nilify_blanks_plugin.sqlite3", "Rakefile", "README.rdoc", "tasks/nilify_blanks_tasks.rake", "test/config/database.yml", "test/nilify_blanks_plugin.sqlite3", "test/nilify_blanks_test.rb", "test/schema.rb", "test/test_helper.rb", "uninstall.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/railsgarden/nilify_blanks}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Nilify_blanks", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{nilify_blanks}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Auto-convert blank fields to nil.}
+  s.test_files = ["test/nilify_blanks_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/nilify_blanks_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :nilify_blanks do
+#   # Task goes here
+# end

data/test/config/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: nilify_blanks_plugin.sqlite
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: nilify_blanks_plugin.sqlite3
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: nilify_blanks_plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password:
+  :database: nilify_blanks_plugin_test

data/test/nilify_blanks_test.rb

@@ -0,0 +1,85 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class NilifyBlanksTest < Test::Unit::TestCase
+  context "Model with nilify_blanks" do
+    setup do
+      class Post < ActiveRecord::Base
+        nilify_blanks
+      end
+      
+      @post = Post.new(:first_name => '', :last_name => '', :title => '', :summary => '', :body => '', :views => 0)
+      @post.save
+    end
+    
+    should "recognize all non-null columns" do
+      assert_equal ['first_name', 'title', 'summary', 'body', 'views'], Post.nilify_blanks_columns
+    end
+    
+    should "convert all blanks to nils" do
+      assert_equal nil, @post.first_name
+      assert_equal nil, @post.title
+      assert_equal nil, @post.summary
+      assert_equal nil, @post.body
+    end
+    
+    should "leave not-null last name field alone" do
+      assert_equal '', @post.last_name
+    end
+    
+    should "leave integer views field alone" do
+      assert_equal 0, @post.views
+    end
+  end
+  
+  context "Model with nilify_blanks :only => [:first_name, :title]" do
+    setup do
+      class PostOnlyFirstNameAndTitle < ActiveRecord::Base
+        set_table_name :posts
+        nilify_blanks :only => [:first_name, :title]
+      end
+      
+      @post = PostOnlyFirstNameAndTitle.new(:first_name => '', :last_name => '', :title => '', :summary => '', :body => '', :views => 0)
+      @post.save
+    end
+    
+    should "recognize only first_name and title" do
+      assert_equal ['first_name', 'title'], PostOnlyFirstNameAndTitle.nilify_blanks_columns
+    end
+    
+    should "convert first_name and title blanks to nils" do
+      assert_equal nil, @post.first_name
+      assert_equal nil, @post.title
+    end
+    
+    should "leave other fields alone" do
+      assert_equal '', @post.summary
+      assert_equal '', @post.body
+    end
+  end
+  
+  context "Model with nilify_blanks :except => [:first_name, :title]" do
+    setup do
+      class PostExceptFirstNameAndTitle < ActiveRecord::Base
+        set_table_name :posts
+        nilify_blanks :except => [:first_name, :title]
+      end
+      
+      @post = PostExceptFirstNameAndTitle.new(:first_name => '', :last_name => '', :title => '', :summary => '', :body => '', :views => 0)
+      @post.save
+    end
+    
+    should "recognize only summary, body, and views" do
+      assert_equal ['summary', 'body', 'views'], PostExceptFirstNameAndTitle.nilify_blanks_columns
+    end
+    
+    should "convert summary and body blanks to nils" do
+      assert_equal nil, @post.summary
+      assert_equal nil, @post.body
+    end
+    
+    should "leave other fields alone" do
+      assert_equal '', @post.first_name
+      assert_equal '', @post.title
+    end
+  end
+end

data/test/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Schema.define(:version => 0) do
+  
+  create_table :posts, :force => true do |t|
+    t.string :first_name
+    t.string :last_name, :null => false
+    t.string :title
+    t.text :summary
+    t.text :body
+    t.integer :views
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+require 'active_record/fixtures'
+require 'shoulda/rails'
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/nilify_blanks'))
+
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'config', '/database.yml')))
+ActiveRecord::Base.configurations = {'test' => config[ENV['DB'] || 'sqlite3']}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../init'))

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: railsgarden-nilify_blanks
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-16 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Auto-convert blank fields to nil.
+email: ben@railsgarden.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/nilify_blanks.rb
+- README.rdoc
+- tasks/nilify_blanks_tasks.rake
+files: 
+- CHANGELOG
+- init.rb
+- install.rb
+- lib/nilify_blanks.rb
+- Manifest
+- MIT-LICENSE
+- nilify_blanks.gemspec
+- nilify_blanks_plugin.sqlite3
+- Rakefile
+- README.rdoc
+- tasks/nilify_blanks_tasks.rake
+- test/config/database.yml
+- test/nilify_blanks_plugin.sqlite3
+- test/nilify_blanks_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/railsgarden/nilify_blanks
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Nilify_blanks
+- --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: nilify_blanks
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Auto-convert blank fields to nil.
+test_files: 
+- test/nilify_blanks_test.rb
+- test/test_helper.rb