scrubby 0.1.0 → 0.1.1

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+test/*.db

data/Rakefile

@@ -1,45 +1,53 @@
 require 'rubygems'
 require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
 
 begin
   require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "scrubby"
-    gem.summary = %Q{Clean up your incoming ActiveRecord model attributes}
-    gem.description = %Q{Clean up your incoming ActiveRecord model attributes}
-    gem.email = "steve.richert@gmail.com"
-    gem.homepage = "http://github.com/laserlemon/scrubby"
-    gem.authors = ["laserlemon"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  Jeweler::Tasks.new do |g|
+    g.name = 'scrubby'
+    g.summary = %(Clean up your incoming ActiveRecord model attributes)
+    g.description = %(Clean up your incoming ActiveRecord model attributes)
+    g.email = 'steve.richert@gmail.com'
+    g.homepage = 'http://github.com/laserlemon/scrubby'
+    g.authors = ['Steve Richert']
+    g.add_dependency 'activerecord'
+    g.add_development_dependency 'shoulda'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = true
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.pattern = 'test/**/test_*.rb'
+    t.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort 'RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov'
+  end
 end
 
-task :spec => :check_dependencies
+task :test => :check_dependencies
 
-task :default => :spec
+task :default => :test
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+Rake::RDocTask.new do |r|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "scrubby #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  r.rdoc_dir = 'rdoc'
+  r.title = "scrubby #{version}"
+  r.rdoc_files.include('README*')
+  r.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/scrubby.rb

@@ -1,19 +1,18 @@
 module Scrubby
   def self.included(base)
     base.class_eval do
+      class_inheritable_hash :scrubbers
+      self.scrubbers = {}
+
       extend ClassMethods
+      include InstanceMethods
+
+      alias_method_chain :write_attribute, :scrub
     end
   end
 
   module ClassMethods
     def scrub(*attributes, &block)
-      unless respond_to?(:scrubbers)
-        class_inheritable_hash :scrubbers
-
-        include InstanceMethods
-        alias_method_chain :write_attribute, :scrub
-      end
-
       scrubber = block_given? ? block : instance_method(:scrub)
       self.scrubbers = attributes.inject({}){|s,a| s.merge!(a.to_s => scrubber) }
     end
@@ -29,6 +28,8 @@ module Scrubby
     end
 
     def scrub(value)
+      value = value.dup if value.duplicable?
+
       case value
         when String
           value.strip!

data/scrubby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{scrubby}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["laserlemon"]
-  s.date = %q{2010-01-23}
+  s.authors = ["Steve Richert"]
+  s.date = %q{2010-01-24}
   s.description = %q{Clean up your incoming ActiveRecord model attributes}
   s.email = %q{steve.richert@gmail.com}
   s.extra_rdoc_files = [
@@ -26,9 +26,8 @@ Gem::Specification.new do |s|
      "init.rb",
      "lib/scrubby.rb",
      "scrubby.gemspec",
-     "spec/scrubby_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
+     "test/helper.rb",
+     "test/test_scrubby.rb"
   ]
   s.homepage = %q{http://github.com/laserlemon/scrubby}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -36,8 +35,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Clean up your incoming ActiveRecord model attributes}
   s.test_files = [
-    "spec/scrubby_spec.rb",
-     "spec/spec_helper.rb"
+    "test/helper.rb",
+     "test/test_scrubby.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -45,12 +44,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
   end
 end
 

data/test/helper.rb

@@ -0,0 +1,36 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+$: << File.dirname(__FILE__)
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'shoulda'
+require 'mocha'
+require 'scrubby'
+begin; require 'redgreen'; rescue LoadError; end
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => File.join(File.dirname(__FILE__), 'test.db')
+)
+
+class CreateSchema < ActiveRecord::Migration
+  def self.up
+    create_table :users, :force => true do |t|
+      t.string :type
+      t.string :first_name
+      t.string :last_name
+      t.timestamps
+    end
+  end
+end
+
+CreateSchema.suppress_messages do
+  CreateSchema.migrate(:up)
+end
+
+class User < ActiveRecord::Base
+end
+
+class Admin < User
+end

data/test/test_scrubby.rb

@@ -0,0 +1,166 @@
+require 'helper'
+
+class TestScrubby < Test::Unit::TestCase
+  context 'Scrubbing' do
+    context 'an attribute' do
+      setup do
+        User.scrub(:first_name)
+        @user = User.new
+      end
+
+      should 'strip string values' do
+        first_name = 'Steve '
+        @user.first_name = first_name
+        assert_equal first_name.strip, @user.first_name
+      end
+
+      should 'nuke blank string values' do
+        first_name = ' '
+        @user.first_name = first_name
+        assert_nil @user.first_name
+      end
+
+      should 'not edit the given value in place' do
+        first_name = 'Steve '
+        value = first_name.dup
+        @user.first_name = value
+        assert_equal first_name, value
+      end
+
+      should 'clean the underlying attribute' do
+        first_name = 'Steve '
+        @user.first_name = first_name
+        assert_not_equal first_name, @user.first_name
+        assert_equal @user.first_name, @user.attributes['first_name']
+      end
+
+      context 'with a block' do
+        setup do
+          @block = proc{|v| v.titleize }
+          User.scrub(:first_name, &@block)
+          @user = User.new
+        end
+
+        should 'not strip string values' do
+          first_name = 'Steve '
+          @user.first_name = first_name
+          assert_equal first_name, @user.first_name
+        end
+
+        should 'not nuke blank string values' do
+          first_name = ' '
+          @user.first_name = first_name
+          assert_equal first_name, @user.first_name
+        end
+
+        should 'use the the block' do
+          first_name = 'steve'
+          @user.first_name = first_name
+          assert_equal @block.call(first_name), @user.first_name
+        end
+
+        context 'having zero arity' do
+          setup do
+            User.scrub(:first_name){ nil }
+            @user = User.new
+          end
+
+          should 'work just fine' do
+            assert_nothing_raised do
+              @user.first_name = 'Steve'
+            end
+          end
+        end
+      end
+    end
+
+    context 'a virtual attribute' do
+      setup do
+        User.class_eval do
+          attr_accessor :middle_name
+          scrub :middle_name
+        end
+        @user = User.new
+      end
+
+      should 'do nothing' do
+        middle_name = ' Joel Michael '
+        @user.middle_name = middle_name
+        assert_equal middle_name, @user.middle_name
+      end
+    end
+
+    context 'an invalid attribute' do
+      setup do
+        User.scrub(:middle_name)
+        @user = User.new
+      end
+
+      should 'do nothing' do
+        assert_nothing_raised do
+          @user.update_attributes(:first_name => 'Steve', :last_name => 'Richert')
+        end
+      end
+    end
+
+    context 'multiple attributes' do
+      setup do
+        User.scrub(:first_name, :last_name)
+        @user = User.new
+      end
+
+      should 'clean all values' do
+        first_name, last_name = ' Steve', 'Richert '
+        @user.first_name, @user.last_name = first_name, last_name
+        assert_not_equal first_name, @user.first_name
+        assert_not_equal last_name, @user.last_name
+      end
+    end
+
+    context 'an inherited model' do
+      setup do
+        User.scrub(:first_name)
+        User.inherited(Admin) # Reinitializes the scrubber inheritance
+        Admin.scrub(:last_name)
+      end
+
+      should 'respect all scrubbers' do
+        assert_same_elements %w(first_name last_name), Admin.scrubbers.keys
+      end
+
+      should 'not add a parent scrubber' do
+        assert_same_elements %w(first_name), User.scrubbers.keys
+      end
+
+      context 'with overlapping attributes' do
+        setup do
+          @value = nil
+          User.scrub(:first_name)
+          @user = User.new
+          User.inherited(Admin) # Reinitializes the scrubber inheritance
+          Admin.scrub(:first_name){ @value }
+          @admin = Admin.new
+        end
+
+        should 'give priority to the inherited scrubber' do
+          first_name = 'Steve'
+          assert_not_equal @value, first_name
+          @admin.first_name = first_name
+          assert_equal @value, @admin.first_name
+        end
+
+        should 'not clobber the parent scrubber' do
+          first_name = 'Steve'
+          assert_not_equal @value, first_name
+          @user.first_name = first_name
+          assert_not_equal @value, @user.first_name
+        end
+      end
+    end
+
+    teardown do
+      User.inheritable_attributes.delete(:scrubbers)
+      Admin.inheritable_attributes.delete(:scrubbers)
+    end
+  end
+end

metadata

@@ -1,26 +1,36 @@
 --- !ruby/object:Gem::Specification 
 name: scrubby
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
-- laserlemon
+- Steve Richert
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-01-23 00:00:00 -05:00
+date: 2010-01-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.9
+        version: "0"
     version: 
 description: Clean up your incoming ActiveRecord model attributes
 email: steve.richert@gmail.com
@@ -41,9 +51,8 @@ files:
 - init.rb
 - lib/scrubby.rb
 - scrubby.gemspec
-- spec/scrubby_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+- test/helper.rb
+- test/test_scrubby.rb
 has_rdoc: true
 homepage: http://github.com/laserlemon/scrubby
 licenses: []
@@ -73,5 +82,5 @@ signing_key:
 specification_version: 3
 summary: Clean up your incoming ActiveRecord model attributes
 test_files: 
-- spec/scrubby_spec.rb
-- spec/spec_helper.rb
+- test/helper.rb
+- test/test_scrubby.rb

data/spec/scrubby_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Scrubby" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end

data/spec/spec.opts

@@ -1 +0,0 @@
---color

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'scrubby'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-  
-end