nullify_blanks 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/CHANGELOG

@@ -0,0 +1,3 @@
+*1.0.0 (July 13th, 2009)
+
+* First release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andrew White
+
+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

@@ -0,0 +1,10 @@
+== NullifyBlanks
+
+This plugin makes ActiveRecord write blank strings as null to
+nullable columns in the database rather than zero length strings.
+
+Just drop the plugin into your plugins folder and that’s all there
+is to it. There’s a rake task to nullify zero length strings in
+existing records if required.
+
+Copyright (c) 2009 Andrew White, released under the MIT license

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the nullify_blanks plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the nullify_blanks plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NullifyBlanks'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "nullify_blanks"
+    gemspec.summary = "Nullify blank columns in ActiveRecord"
+    gemspec.email = "andyw@pixeltrix.co.uk"
+    gemspec.homepage = "http://github.com/pixeltrix/nullify_blanks/"
+    gemspec.description = "Ruby on Rails plugin to ensure nullable databases columns are set to null rather than empty strings."
+    gemspec.authors = ["Andrew White"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/nullify_blanks.rb

@@ -0,0 +1,32 @@
+# == NullifyBlanks
+#
+# This plugin makes ActiveRecord write blank strings as null to
+# nullable columns in the database rather than zero length strings.
+#
+# Just drop the plugin into your plugins folder and that’s all there
+# is to it. There’s a rake task to nullify zero length strings in
+# existing records if required.
+#
+# Copyright (c) 2009 Andrew White, released under the MIT license
+
+module NullifyBlanks
+  def self.included(base) #:nodoc:
+    base.class_eval do
+
+      def write_attribute_with_nullify(attr_name, value) #:nodoc:
+        write_attribute_without_nullify(attr_name, nullify?(attr_name, value) ? nil : value)
+      end
+
+      alias_method_chain :write_attribute, :nullify
+
+      private
+
+        def nullify?(attr_name, value) #:nodoc:
+          value.blank? && ((column = column_for_attribute(attr_name)) && column.text? && column.null)
+        end
+
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, NullifyBlanks

data/nullify_blanks.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nullify_blanks}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew White"]
+  s.date = %q{2009-10-05}
+  s.description = %q{Ruby on Rails plugin to ensure nullable databases columns are set to null rather than empty strings.}
+  s.email = %q{andyw@pixeltrix.co.uk}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/nullify_blanks.rb",
+     "nullify_blanks.gemspec",
+     "rails/init.rb",
+     "tasks/nullify_blanks_tasks.rake",
+     "test/fixtures/products.yml",
+     "test/nullify_blanks_test.rb"
+  ]
+  s.homepage = %q{http://github.com/pixeltrix/nullify_blanks/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Nullify blank columns in ActiveRecord}
+  s.test_files = [
+    "test/nullify_blanks_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/rails/init.rb

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

data/tasks/nullify_blanks_tasks.rake

@@ -0,0 +1,12 @@
+desc "Nullify all the nullable text columns in the model specified in MODEL"
+task :nullify_blanks do
+  raise RuntimeError, "Please specify a model to nullify" if ENV["MODEL"].blank?
+
+  Rake::Task[:environment].invoke
+
+  klass = ENV["MODEL"].constantize
+  klass.columns.each do |column|
+    quoted_column = klass.connection.quote_column_name(column.name)
+    klass.update_all("#{quoted_column} = NULL", "#{quoted_column} = ''") if column.text? && column.null
+  end
+end

data/test/fixtures/products.yml

@@ -0,0 +1,4 @@
+product:
+  id: 1
+  name: "Name"
+  description: "Description"

data/test/nullify_blanks_test.rb

@@ -0,0 +1,85 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+require 'active_record/fixtures'
+require File.dirname(__FILE__) + '/../lib/nullify_blanks'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+def setup_db
+  ActiveRecord::Migration.suppress_messages do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :products do |t|
+        t.string :name, :limit => 100, :null => false
+        t.string :description, :limit => 255, :null => true
+      end
+    end
+  end
+
+  Fixtures.create_fixtures(File.dirname(__FILE__) + '/fixtures', ActiveRecord::Base.connection.tables)
+end
+
+def teardown_db
+  ActiveRecord::Migration.suppress_messages do
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  Fixtures.reset_cache
+end
+
+class Product < ActiveRecord::Base
+end
+
+class NullifyBlanksTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_nullable_column_is_nullified_when_assigned_an_empty_string
+    product = Product.find(1)
+    assert !product.description.blank?
+    product.update_attributes!(:description => "")
+    product.reload
+    assert product.description.nil?
+  end
+
+  def test_nullable_column_is_nullified_when_assigned_a_nil_value
+    product = Product.find(1)
+    assert !product.description.blank?
+    product.update_attributes!(:description => nil)
+    product.reload
+    assert product.description.nil?
+  end
+
+  def test_nullable_column_is_not_nullified_when_assigned_a_non_empty_string
+    product = Product.find(1)
+    assert !product.description.blank?
+    product.update_attributes!(:description => "Description")
+    product.reload
+    assert !product.description.nil?
+  end
+
+  def test_not_null_column_is_not_nullified_when_assigned_an_empty_string
+    product = Product.find(1)
+    assert !product.name.blank?
+    product.update_attributes!(:name => "")
+    product.reload
+    assert !product.name.nil?
+  end
+
+  def test_not_null_column_is_not_nullified_when_assigned_a_non_empty_string
+    product = Product.find(1)
+    assert !product.name.blank?
+    product.update_attributes!(:name => "Name")
+    product.reload
+    assert !product.name.nil?
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: nullify_blanks
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrew White
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Ruby on Rails plugin to ensure nullable databases columns are set to null rather than empty strings.
+email: andyw@pixeltrix.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- CHANGELOG
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/nullify_blanks.rb
+- nullify_blanks.gemspec
+- rails/init.rb
+- tasks/nullify_blanks_tasks.rake
+- test/fixtures/products.yml
+- test/nullify_blanks_test.rb
+has_rdoc: true
+homepage: http://github.com/pixeltrix/nullify_blanks/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Nullify blank columns in ActiveRecord
+test_files: 
+- test/nullify_blanks_test.rb