nilify_blanks 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,9 @@
+== [2010-10-15] 1.0.0 Major Updates
+
+* Finally updated to be a Gem
+* Internal refactoring
+* Converted tests to RSpec
+* Added support for Rails 3.0
+
+== 0.1.2 Fixed issue with table not existing.
+== 0.1.0 Initial Version

data/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,40 @@
+== 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
+
+  Include the gem using bundler in your Gemfile:
+
+    gem "nilify_blanks"
+
+== 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,23 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = Rake::FileList["spec/**/*_spec.rb"]
+  t.spec_opts = ["-c"]
+end
+
+task :default => :spec
+
+desc "Generate documentation for the plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "nilify_blanks"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Dir["#{File.dirname(__FILE__)}/lib/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

@@ -0,0 +1,3 @@
+require "nilify_blanks"
+
+NilifyBlanks::Railtie.insert

data/lib/nilify_blanks.rb

@@ -0,0 +1,48 @@
+module NilifyBlanks
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    def nilify_blanks(options = {})
+      return if self.included_modules.include?(NilifyBlanks::InstanceMethods)
+      return unless self.table_exists?
+      
+      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
+
+require "nilify_blanks/railtie"

data/lib/nilify_blanks/railtie.rb

@@ -0,0 +1,19 @@
+module NilifyBlanks
+  if defined?(Rails::Railtie)
+    require "rails"
+    
+    class Railtie < Rails::Railtie
+      initializer "nilify_blanks.extend_active_record" do
+        ActiveSupport.on_load(:active_record) do
+          NilifyBlanks::Railtie.insert
+        end
+      end
+    end
+  end
+  
+  class Railtie
+    def self.insert
+      ActiveRecord::Base.send(:include, NilifyBlanks)
+    end
+  end
+end

data/lib/nilify_blanks/version.rb

@@ -0,0 +1,3 @@
+module NilifyBlanks
+  VERSION = "1.0.0"
+end

data/spec/db/database.yml

@@ -0,0 +1,21 @@
+sqlite:
+  adapter: sqlite
+  database: spec/db/test.sqlite
+
+sqlite3:
+  adapter: sqlite3
+  database: spec/db/test.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/spec/db/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/spec/nilify_blanks_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+describe NilifyBlanks do
+  
+  context "Model with nilify_blanks" do
+    before(:all) do
+      class Post < ActiveRecord::Base
+        nilify_blanks
+      end
+      
+      @post = Post.new(:first_name => '', :last_name => '', :title => '', :summary => '', :body => '', :views => 0)
+      @post.save
+    end
+    
+    it "should recognize all non-null columns" do
+      ['first_name', 'title', 'summary', 'body', 'views'].should == Post.nilify_blanks_columns
+    end
+    
+    it "should convert all blanks to nils" do
+      @post.first_name.should be_nil
+      @post.title.should be_nil
+      @post.summary.should be_nil
+      @post.body.should be_nil
+    end
+    
+    it "should leave not-null last name field alone" do
+      @post.last_name.should == ""
+    end
+    
+    it "should leave integer views field alone" do
+      @post.views.should == 0
+    end
+  end
+  
+  context "Model with nilify_blanks :only => [:first_name, :title]" do
+    before(:all) 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
+    
+    it "should recognize only first_name and title" do
+      ['first_name', 'title'].should == PostOnlyFirstNameAndTitle.nilify_blanks_columns
+    end
+    
+    it "should convert first_name and title blanks to nils" do
+      @post.first_name.should be_nil
+      @post.title.should be_nil
+    end
+    
+    it "should leave other fields alone" do
+      @post.summary.should == ""
+      @post.body.should == ""
+    end
+  end
+  
+  context "Model with nilify_blanks :except => [:first_name, :title]" do
+    before(:all) 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
+    
+    it "should recognize only summary, body, and views" do
+      ['summary', 'body', 'views'].should == PostExceptFirstNameAndTitle.nilify_blanks_columns
+    end
+    
+    it "should convert summary and body blanks to nils" do
+      @post.summary.should be_nil
+      @post.body.should be_nil
+    end
+    
+    it "should leave other fields alone" do
+      @post.first_name.should == ""
+      @post.title.should == ""
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "nilify_blanks"
+require "active_support"
+require "active_record"
+
+# Establish DB Connection
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'db', 'database.yml')))
+ActiveRecord::Base.configurations = {'test' => config[ENV['DB'] || 'sqlite3']}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+
+# Load Test Schema into the Database
+load(File.dirname(__FILE__) + "/db/schema.rb")
+
+require File.dirname(__FILE__) + '/../init'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: nilify_blanks
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-14 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+description: Often times you'll end up with empty strings where you really want nil at the database level.  This plugin automatically converts blanks to nil and is configurable.
+email: ben@railsgarden.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/nilify_blanks/railtie.rb
+- lib/nilify_blanks/version.rb
+- lib/nilify_blanks.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/db/test.sqlite3
+- spec/nilify_blanks_spec.rb
+- spec/spec_helper.rb
+- CHANGELOG.rdoc
+- LICENSE
+- Rakefile
+- README.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/rubiety/nilify_blanks
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 19
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: nilify_blanks
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Auto-convert blank fields to nil.
+test_files: []
+