nilly_vanilly 0.1.0

data/README.markdown

@@ -0,0 +1,51 @@
+NillyVanilly
+============
+
+This plugin stores NULL in your database when you try to store an empty string.
+
+It only works for columns you explicitly mention inside your model. It comes
+with a rake task which prints out all the columns eligible for nillification.
+
+Since HTTP parameters are always strings, an empty string is sent by form
+values for which you did not mean to enter any value. This plugin makes sure
+to save NULL in database varchar columns that are defined with DEFAULT NULL.
+
+
+Example
+=======
+
+    class Comment < ActiveRecord::Base
+      nillify :author_url
+    end
+
+    comment = Comment.create :author_url => ""
+    comment.author_url        # -> nil
+  
+
+Installation
+============
+
+    ./script/plugin install git://github.com/tilsammans/nilly_vanilly.git
+
+
+Inspection
+==========
+
+To see what columns are eligible for nillification, run the following:
+
+    rake nilly:vanilly:inspect
+
+This will print a list of all tables in your database, cross-referenced with
+the models in your application. All text columns which may be NULL and are
+nil by default are shown, i.e. all these columns should be safe to nillify.
+This does not take into account any validations you might have.
+
+When a column has already been nillified, it will be indicated with [OK].
+
+
+Author
+======
+
+Joost Baaij
+<joost@spacebabies.nl>
+[www.spacebabies.nl](http://www.spacebabies.nl/)

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rake'
+require 'rake/rdoctask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "nilly_vanilly"
+  gem.homepage = "http://github.com/tilsammans/nilly_vanilly"
+  gem.summary = %Q{This plugin stores NULL in your database when you try to store an empty string.}
+  gem.email = "joost@spacebabies.nl"
+  gem.authors = ["Joost Baaij"]
+  gem.add_runtime_dependency 'activerecord', '~> 2.3'
+  gem.add_development_dependency 'rspec', '~> 1.3.1'
+  gem.add_development_dependency 'jeweler', '~> 0.5.2'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+begin
+  # Rspec 1.3.0
+  require 'spec/rake/spectask'
+
+  desc 'Default: run specs'
+  task :default => :spec
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_files = FileList["spec/**/*_spec.rb"]
+  end
+
+  Spec::Rake::SpecTask.new('rcov') do |t|
+    t.spec_files = FileList["spec/**/*_spec.rb"]
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+  
+rescue LoadError
+  # Rspec 2.0
+  require 'rspec/core/rake_task'
+
+  desc 'Default: run specs'
+  task :default => :spec  
+  Rspec::Core::RakeTask.new do |t|
+    t.pattern = "spec/**/*_spec.rb"
+  end
+  
+  Rspec::Core::RakeTask.new('rcov') do |t|
+    t.pattern = "spec/**/*_spec.rb"
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+
+rescue LoadError
+  puts "Rspec not available. Install it with: gem install rspec"  
+end
+
+desc 'Generate documentation for the nilly_vanilly plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NillyVanilly'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/nilly_vanilly.rb

@@ -0,0 +1,6 @@
+require "active_record"
+require 'nilly_vanilly/nillify'
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send :include, NillyVanilly::Nillify
+end

data/lib/nilly_vanilly/nillify.rb

@@ -0,0 +1,28 @@
+module NillyVanilly
+  module Nillify
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def nillify(*attributes)
+        class_eval do
+          before_save :nillification
+        end
+        
+        cattr_accessor :nillify_attributes
+        self.nillify_attributes = attributes        
+
+        include InstanceMethods
+      end
+    end
+    
+    module InstanceMethods
+      def nillification
+        for attribute in self.class.nillify_attributes
+          self.send("#{attribute}=", nil) if self.send(attribute) == ""
+        end
+      end
+    end
+  end
+end

data/lib/tasks/nilly_vanilly.rake

@@ -0,0 +1,21 @@
+namespace :nilly do
+  namespace :vanilly do
+    task :inspect => :environment do
+      ActiveRecord::Base.connection.tables.each do |table|
+        model = table.classify.constantize rescue next
+        
+        model.columns.each do |column|
+          if model.respond_to?(:nillify_attributes) && model.nillify_attributes.include?(column.name.to_sym)
+            present = "[OK]"
+          else
+            present = "[  ]"
+          end
+
+          if column.text? && column.null && column.default.nil?
+            puts [present, model.name.ljust(20), column.name].join(" ")
+          end
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

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

data/spec/database.yml

@@ -0,0 +1,17 @@
+sqlite3:
+  adapter: sqlite3
+  database: nilly_vanilly.sqlite3
+
+mysql:
+  adapter: mysql
+  hostname: localhost
+  username: root
+  password:
+  database: nilly_vanilly
+
+postgresql:
+  adapter: postgresql
+  hostname: localhost
+  username: postgres
+  password:
+  database: nilly_vanilly

data/spec/models.rb

@@ -0,0 +1,7 @@
+class Post < ActiveRecord::Base
+  nillify :title
+end
+
+class Comment < ActiveRecord::Base
+  nillify :author, :author_email
+end

data/spec/nilly_vanilly_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe NillyVanilly do
+  describe "model with one column" do
+    it "stores class methods" do
+      Post.nillify_attributes.should == [:title]
+    end
+
+    it "stores nil for empty string" do
+      post = Post.create! :title => ""
+      post.title.should be_nil
+    end
+  end
+  
+  describe "model with two columns" do
+    it "stores class methods" do
+      Comment.nillify_attributes.should == [:author, :author_email]
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts, :force => true do |t|
+    t.string :title, :default => nil, :null => true
+  end
+  
+  create_table :comments, :force => true do |t|
+    t.string :author, :default => nil, :null => true
+    t.string :author_email, :default => nil, :null => true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+
+require 'yaml'
+require File.dirname(__FILE__) + '/../rails/init.rb'
+
+ENV['DB'] ||= 'sqlite3'
+
+database_yml = File.expand_path('../database.yml', __FILE__)
+if File.exists?(database_yml)
+  active_record_configuration = YAML.load_file(database_yml)[ENV['DB']]
+  
+  ActiveRecord::Base.establish_connection(active_record_configuration)
+  ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+  
+  ActiveRecord::Base.silence do
+    ActiveRecord::Migration.verbose = false
+    
+    load(File.dirname(__FILE__) + '/schema.rb')
+    load(File.dirname(__FILE__) + '/models.rb')
+  end  
+  
+else
+  raise "Please create #{database_yml} first to configure your database. Take a look at: #{database_yml}.sample"
+end
+
+def clean_database!
+  [Post, Comment].each do |model|
+    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+  end
+end
+
+clean_database!

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: nilly_vanilly
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Joost Baaij
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-21 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :development
+  version_requirements: *id003
+description: 
+email: joost@spacebabies.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- lib/nilly_vanilly.rb
+- lib/nilly_vanilly/nillify.rb
+- lib/tasks/nilly_vanilly.rake
+- rails/init.rb
+- spec/database.yml
+- spec/models.rb
+- spec/nilly_vanilly_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tilsammans/nilly_vanilly
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This plugin stores NULL in your database when you try to store an empty string.
+test_files: 
+- spec/models.rb
+- spec/nilly_vanilly_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb