nilly_vanilly 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1,9 @@
+spec/debug.log
+nilly_vanilly.sqlite3
+coverage
+rdoc
+doc
+.yardoc
+.bundle
+pkg
+spec/db/database.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.1.0 (January 2011)
+
+Initial release
+Made the plugin available as a gem.
+
+Features:
+
+  - Nillyfily Active Record plugins
+  - Rake task to identify attributes to be nillified

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'activerecord', '>= 2'
+gem 'rspec'
+gem 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    nilly_vanilly (0.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.12)
+      activesupport (= 2.3.12)
+    activesupport (2.3.12)
+    diff-lcs (1.1.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sqlite3 (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 2)
+  nilly_vanilly!
+  rspec
+  sqlite3

data/README.markdown

@@ -1,7 +1,7 @@
 NillyVanilly
 ============
 
-This plugin stores NULL in your database when you try to store an empty string.
+This Rails gem/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.
@@ -25,8 +25,26 @@ Example
 Installation
 ============
 
+The preferred method of installation is now as a gem.
+
+    config.gem 'nilly_vanilly'
+
+or, for Rails 3 with Bundler in your Gemfile:
+
+    gem 'nilly_vanilly'
+
+Previous versions of Nilly Vanilly were distributed as a Rails plugin. For Rails
+2 apps this might still work, but is not supported. If you absolutely need the
+Rake task in your Rails 2 app, you can:
+
     ./script/plugin install git://github.com/tilsammans/nilly_vanilly.git
 
+Installation as a plugin in Rails 2 adds a rake task you can run to find suitable
+columns for nillification. For Rails 3, I will add this task in a future version.
+Until then you can find the same information by running:
+
+    ./script/runner "NillyVanilly::Inspect.print"
+
 
 Inspection
 ==========
@@ -43,6 +61,26 @@ This does not take into account any validations you might have.
 When a column has already been nillified, it will be indicated with [OK].
 
 
+But WHY?!!
+==========
+
+You: who cares that empty strings are stored in the database?
+Me: if you don't care, just move along. And would I recommend you nillify
+every attribute in your application? No. But beside from the fact that NULL
+is the "correct" value for something you don't know, enforcing this is
+required if you have a unique index on that column. Unique indexes are the
+fastest you can have, and they deal great with NULL values. Empty strings?
+Not so much so.
+
+
+Contributing
+============
+
+Fork and clone the repo and hack away.
+
+It is very important you *must* run the specs before sending a pull request.
+
+
 Author
 ======
 

data/Rakefile

@@ -1,63 +1,7 @@
-require 'rake'
-require 'rake/rdoctask'
+require 'bundler/gem_tasks'
 
-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
+require 'rspec/core/rake_task'
 
-  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'
+RSpec::Core::RakeTask.new('spec')
 
-  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
+task :default => :spec

data/lib/nilly_vanilly.rb

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

data/lib/nilly_vanilly/inspect.rb

@@ -0,0 +1,35 @@
+module NillyVanilly
+  # Inspect the database schema, in a quest to find columns suitable for nillification.
+  class Inspect
+    def initialize
+      @results = []
+    end
+    
+    # A nested array with one row for each column suitable for nillification.
+    def results
+      ActiveRecord::Base.connection.tables.each do |table|
+        model = table.classify.constantize rescue next
+        
+        model.columns.each do |column|
+          present = model.respond_to?(:nillify_attributes) && model.nillify_attributes.include?(column.name.to_sym)
+
+          @results << [present, model.name, column.name] if include_column(column)
+        end
+      end
+      
+      @results
+    end
+    
+    # Print an inspection report to stdout.
+    def self.print
+      new.results.each do |result|
+        puts [result[0] ? "[OK]" : "[  ]", result[1].ljust(20), result[2]].join(" ")
+      end
+    end
+    
+    private
+      def include_column(column)
+        column.text? && column.null && column.default.nil?
+      end
+  end
+end

data/lib/nilly_vanilly/version.rb

@@ -0,0 +1,3 @@
+module NillyVanilly
+  VERSION = "0.2.0"
+end

data/lib/tasks/nilly_vanilly.rake

@@ -1,21 +1,7 @@
 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
+      NillyVanilly::Inspect.print
     end
   end
 end

data/nilly_vanilly.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nilly_vanilly/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nilly_vanilly"
+  s.version     = NillyVanilly::VERSION
+  s.authors     = ["Joost Baaij"]
+  s.email       = ["joost@spacebabies.nl"]
+  s.homepage    = "https://github.com/tilsammans/nilly_vanilly"
+  s.summary     = %q{This plugin stores NULL in your database when you try to store an empty string.}
+  s.description = %q{This plugin stores NULL in your database when you try to store an empty string.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/nilly_vanilly/inspect_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe NillyVanilly::Inspect do
+  it "returns array of models/columns" do
+    subject.results.first.should == [true, "Post", "title"]
+  end
+end

data/spec/spec_helper.rb

@@ -1,32 +1,12 @@
-$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+require 'rubygems'
+require 'bundler/setup'
 
-require 'yaml'
-require File.dirname(__FILE__) + '/../rails/init.rb'
+require 'nilly_vanilly'
 
-ENV['DB'] ||= 'sqlite3'
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
-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!
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/support/database.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+
+ENV['DB'] ||= 'sqlite3'
+
+database_yml = File.expand_path('../../db/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__) + '/../db/schema.rb')
+    load(File.dirname(__FILE__) + '/../db/models.rb')
+  end  
+  
+else
+  raise "Please create #{database_yml} first to configure your database. Take a look at: #{database_yml}.example"
+end
+
+def clean_database!
+  [Post, Comment].each do |model|
+    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+  end
+end
+
+clean_database!

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: nilly_vanilly
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors: 
 - Joost Baaij
@@ -15,79 +10,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-21 00:00:00 +01:00
+date: 2011-08-12 00:00:00 +02: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
+dependencies: []
+
+description: This plugin stores NULL in your database when you try to store an empty string.
+email: 
+- joost@spacebabies.nl
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.markdown
+extra_rdoc_files: []
+
 files: 
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - README.markdown
 - Rakefile
-- VERSION
 - lib/nilly_vanilly.rb
+- lib/nilly_vanilly/inspect.rb
 - lib/nilly_vanilly/nillify.rb
+- lib/nilly_vanilly/version.rb
 - lib/tasks/nilly_vanilly.rake
-- rails/init.rb
-- spec/database.yml
-- spec/models.rb
+- nilly_vanilly.gemspec
+- spec/db/database.yml.example
+- spec/db/models.rb
+- spec/db/schema.rb
+- spec/nilly_vanilly/inspect_spec.rb
 - spec/nilly_vanilly_spec.rb
-- spec/schema.rb
 - spec/spec_helper.rb
+- spec/support/database.rb
 has_rdoc: true
-homepage: http://github.com/tilsammans/nilly_vanilly
+homepage: https://github.com/tilsammans/nilly_vanilly
 licenses: []
 
 post_install_message: 
@@ -100,28 +58,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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
+rubygems_version: 1.6.2
 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/db/database.yml.example
+- spec/db/models.rb
+- spec/db/schema.rb
+- spec/nilly_vanilly/inspect_spec.rb
 - spec/nilly_vanilly_spec.rb
-- spec/schema.rb
 - spec/spec_helper.rb
+- spec/support/database.rb

data/VERSION

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

data/rails/init.rb

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