acts_as_filterable 0.1.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rob Ares
+
+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,24 @@
+= acts_as_filterable
+
+== Description
+
+acts_as_filterable is a small ActiveRecord plugin that was thrown together
+to avoid duplicating the same text filtering logic all over the place in a domain model. 
+
+The only filter in place so far is one that will strip everything out of a string except the digit information. You might ask, "Why don't you just change the column type to a numeric one?". That _is_ the right way to go but we were faced with tens of millions of records and a lot of text processing (with a lot of bad data that would be hard to apply a deterministic ruleset to). So putting this in place will avoid the garbage data coming in moving forward.
+  
+I'd like to expand the ruleset moving forward to support different schemes like decimals and so on.
+
+== Install as a gem:
+ 
+  config.gem "rares-acts_as_filterable", :source => "http://gems.github.com"
+
+== To apply to fields on a model, add the following inside the class body:
+ 
+  filter_for_digits :phone_number, :fax_number
+
+if something is broken or it is missing a feature; you know the deal. Don't be part of the problem.
+
+== Copyright
+
+Copyright (c) 2009 Rob Ares. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require "rubygems"
+require "rake"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_filterable"
+    gem.summary = %Q{TODO}
+    gem.email = "rob.ares@gmail.com"
+    gem.homepage = "http://github.com/rares/acts_as_filterable"
+    gem.authors = ["Rob Ares"]
+
+    gem.add_dependency("activerecord", ">= 1.15.0") 
+    gem.add_runtime_dependency("activesupport", ">= 1.4.4")
+    gem.add_development_dependency("Shoulda")
+    gem.add_development_dependency("matchy")   
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = false
+  test.options =  "-v"
+end
+
+begin
+  require "rcov/rcovtask"
+  Rcov::RcovTask.new do |test|
+    test.libs << "test"
+    test.pattern = "test/**/*_test.rb"
+    test.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 :default => :test
+
+require "rake/rdoctask"
+Rake::RDocTask.new do |rdoc|
+  if File.exist?("VERSION.yml")
+    config = YAML.load(File.read("VERSION.yml"))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "acts_as_filterable #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 4

data/acts_as_filterable.gemspec

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_filterable}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rob Ares"]
+  s.date = %q{2009-09-08}
+  s.email = %q{rob.ares@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "acts_as_filterable.gemspec",
+     "init.rb",
+     "lib/acts_as_filterable.rb",
+     "lib/acts_as_filterable/base.rb",
+     "rails/init.rb",
+     "test/acts_as_filterable_integration_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/rares/acts_as_filterable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{An ActiveRecord plugin that allows attribute-based filtering in order to normalize numeric data}
+  s.test_files = [
+    "test/acts_as_filterable_integration_test.rb",
+     "test/test_helper.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
+      s.add_runtime_dependency(%q<activerecord>, [">= 1.15.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 1.4.4"])
+      s.add_development_dependency(%q<Shoulda>, [">= 0"])
+      s.add_development_dependency(%q<matchy>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 1.15.0"])
+      s.add_dependency(%q<activesupport>, [">= 1.4.4"])
+      s.add_dependency(%q<Shoulda>, [">= 0"])
+      s.add_dependency(%q<matchy>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 1.15.0"])
+    s.add_dependency(%q<activesupport>, [">= 1.4.4"])
+    s.add_dependency(%q<Shoulda>, [">= 0"])
+    s.add_dependency(%q<matchy>, [">= 0"])
+  end
+end

data/init.rb

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

data/lib/acts_as_filterable/base.rb

@@ -0,0 +1,69 @@
+module ActsAsFilterable
+  
+  module ActiveRecordExt
+    
+    module Base
+      
+      def self.included(klazz)
+        klazz.extend ClassMethods
+        klazz.before_validation :apply_filters
+      end
+      
+      private 
+      
+      module Language
+        
+        def filter(&blk)
+          instance_eval blk
+        end
+        
+        def digits(*args)
+          filtered_attributes[:digits] |= args unless args.empty?
+        end
+        
+        def lowercase(*args)
+          filtered_attributes[:lowercase] |= args unless args.empty?
+        end
+        
+      end
+      
+      module ClassMethods
+        
+        def filter_for_digits(*args)
+          filtered_attributes[:digits] |= args unless args.empty?
+        end
+        
+        def filters
+          @filters ||= returning(Hash.new([])) do |f|
+            f[:digits]    = Commands::Digits.new
+            f[:lowercase] = Commands::Lowercase.new
+          end.freeze
+        end
+        
+        def filtered_attributes
+          @filtered_attributes ||= Hash.new []
+        end
+        
+      end
+      
+      protected
+      
+      def apply_filters
+        self.class.filtered_attributes.each do |key, value|
+          value.each do |attr|
+           apply_filter self.class.filters[key], attr
+          end
+        end
+      end
+      
+      private
+      
+      def apply_filter(filter, attr)
+        filter.apply self, attr
+      end
+            
+    end
+  
+  end
+  
+end

data/lib/acts_as_filterable.rb

@@ -0,0 +1,8 @@
+module ActsAsFilterable
+  module ActiveRecordExt 
+    autoload :Base, "acts_as_filterable/base"
+    autoload :Commands, "acts_as_filterable/commands"   
+  end
+end
+
+ActiveRecord::Base.send :include, ActsAsFilterable::ActiveRecordExt::Base

data/rails/init.rb

@@ -0,0 +1 @@
+require "acts_as_filterable"

data/test/acts_as_filterable_integration_test.rb

@@ -0,0 +1,122 @@
+require "test_helper"
+
+class ActsAsFilterableIntegrationTest < Test::Unit::TestCase
+
+  context "An ActiveRecord model using acts_as_filterable" do
+    setup do
+      @model = ContactDetail.new do |cd|
+        cd.name = "joe smith"
+        cd.phone_number = "2223334444"
+        cd.discount = 0.25
+      end
+    end
+   
+    should "add an #apply_filters instance method" do
+      @model.send(:apply_filters).nil?.should_not be(true)
+    end
+
+    should "know about the types of filters that will be applied to the attributes" do
+      ContactDetail.respond_to?(:filtered_attributes).should be(true)
+    end
+    
+    should "make it's filters available" do
+      ContactDetail.respond_to?(:filters).should be(true)
+    end
+    
+    should "default filters that don't exist to an empty array" do
+      ContactDetail.filters[:test].empty?.should be(true)
+    end
+    
+    should "contain some filters initially" do
+      ContactDetail.filters[:numeric].nil?.should_not be(true)
+    end
+    
+    should "freeze the macro collection so it cannot be mutated" do
+      lambda { ContactDetail.filters.store(:test, /./) }.should raise_error
+    end
+    
+    should "add a macro to filter non-numeric values from string fields" do
+      ContactDetail.respond_to?(:filter_for_digits).should be(true)
+    end
+    
+    should "be savable with valid data" do
+      @model.save.should be(true)
+    end
+    
+    context "with formatted phone number data" do
+      setup do
+        @model.phone_number = "(222) 333-4444"
+        @model.valid?
+      end
+    
+      should "strip all formatting" do
+        @model.phone_number.should be("2223334444")
+      end
+      
+      should "return a coercable numeric value" do
+        @model.phone_number.to_f.should be(2223334444)
+      end
+    
+    end
+    
+    context "with a nil attribute value" do
+      setup do
+        @model.phone_number = nil
+      end
+      
+      should "not raise any errors due to a nil attribute value" do
+        lambda { @model.valid? }.should_not raise_error
+      end
+      
+      should "not attempt to change the attribute value" do
+        @model.valid?
+        @model.phone_number.nil?.should be(true)
+      end
+    end
+    
+    context "with non-character attributes" do
+      setup do
+        ContactDetail.filter_for_digits :discount
+      end
+      
+      should "not raise any errors due to a non-character attribute value" do
+        lambda { @model.valid? }.should_not raise_error
+      end
+      
+      should "not attempt to change the attribute value" do
+        @model.valid?
+        @model.discount.should be(0.25)
+      end
+      
+    end
+    
+    context "with an attribute value that contains no non-numeric values to be stripped" do
+      setup do 
+        @model.phone_number = "2223334444"
+        @model.valid?
+      end
+      
+      should "not change the attribute value" do
+        @model.phone_number.should be("2223334444")
+      end
+    end
+    
+    context "that has filtered attribute names that are identical to another filtered model" do
+      
+      should "hold seperate collections of filtered_attributes" do
+        User.filtered_attributes.should_not == ContactDetail.filtered_attributes
+      end
+   
+      should "not overwrite attributes for other models" do
+        ContactDetail.filtered_attributes.include?(:fax_number).should_not be(nil)
+      end
+
+      should "not add filtered attributes to models that they are not intended for" do
+        User.filtered_attributes.include?(:phone_number).should_not be(true)
+      end
+
+    end
+    
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+require "test/unit"
+require "activerecord"
+require "shoulda"
+require "matchy"
+
+require "acts_as_filterable"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :contact_details, :force => true do |t|
+    t.string :name
+    t.string :phone_number
+    t.string :fax_number
+    t.float :discount
+  end
+  
+  create_table :user do |t|
+    t.string :handle
+    t.string :phone_number
+  end
+end
+
+class ContactDetail < ActiveRecord::Base
+  filter_for_digits :phone_number, :fax_number
+end
+
+class User < ActiveRecord::Base
+  filter_for_digits :phone_number
+end
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_filterable
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- Rob Ares
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.15.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: Shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: matchy
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: rob.ares@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- acts_as_filterable.gemspec
+- init.rb
+- lib/acts_as_filterable.rb
+- lib/acts_as_filterable/base.rb
+- rails/init.rb
+- test/acts_as_filterable_integration_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rares/acts_as_filterable
+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.4
+signing_key: 
+specification_version: 3
+summary: An ActiveRecord plugin that allows attribute-based filtering in order to normalize numeric data
+test_files: 
+- test/acts_as_filterable_integration_test.rb
+- test/test_helper.rb