acts_as_filterable 0.1.4 → 0.2.0

data/README.rdoc

@@ -11,7 +11,7 @@ I'd like to expand the ruleset moving forward to support different schemes like
 
 == Install as a gem:
  
-  config.gem "rares-acts_as_filterable", :source => "http://gems.github.com"
+  config.gem "acts_as_filterable", :source => "http://gemcutter.org"
 
 == To apply to fields on a model, add the following inside the class body:
  

data/Rakefile

@@ -1,19 +1,18 @@
-require "rubygems"
 require "rake"
 
 begin
   require "jeweler"
   Jeweler::Tasks.new do |gem|
     gem.name = "acts_as_filterable"
-    gem.summary = %Q{TODO}
+    gem.summary = %Q{Filter attributes and stuff.}
     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")   
+    gem.add_development_dependency("Shoulda", ">= 0")
+    gem.add_development_dependency("matchy", ">= 0")   
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION.yml

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

data/acts_as_filterable.gemspec

@@ -1,12 +1,15 @@
+# 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{acts_as_filterable}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   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.date = %q{2009-10-29}
   s.email = %q{rob.ares@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -25,16 +28,17 @@ Gem::Specification.new do |s|
      "lib/acts_as_filterable/base.rb",
      "rails/init.rb",
      "test/acts_as_filterable_integration_test.rb",
+     "test/filter_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.rubygems_version = %q{1.3.5}
+  s.summary = %q{Filter attributes and stuff.}
   s.test_files = [
     "test/acts_as_filterable_integration_test.rb",
+     "test/filter_test.rb",
      "test/test_helper.rb"
   ]
 

data/lib/acts_as_filterable/base.rb

@@ -1,5 +1,12 @@
 module ActsAsFilterable
   
+  Filters = returning Hash.new([]) do |f|
+    f[:digits]     = lambda { |attr| attr.gsub!(/[^\d]*/, "") }
+    f[:lowercase]  = lambda { |attr| attr.downcase! }
+    f[:uppercase]  = lambda { |attr| attr.upcase! }
+    f[:whitespace] = lambda { |attr| attr.gsub!(/\s+/, " "); attr.strip! }
+  end.freeze
+  
   module ActiveRecordExt
     
     module Base
@@ -9,57 +16,38 @@ module ActsAsFilterable
         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
+        def self.extended(klazz)
+          ActsAsFilterable::Filters.each_key do |key|
+            klazz.class_eval <<-MACROS, __FILE__, __LINE__ + 1
+              def self.filter_for_#{key}(*args)
+                filtered_attributes[:#{key}] |= args unless args.empty?
+              end
+            MACROS
+          end
         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
+            apply_filter self, attr, ActsAsFilterable::Filters[key]
           end
         end
       end
       
       private
       
-      def apply_filter(filter, attr)
-        filter.apply self, attr
+      def apply_filter(record, attr, filter)
+        filter.call(record[attr]) if record[attr].is_a?(String)
       end
             
     end

data/lib/acts_as_filterable.rb

@@ -1,7 +1,6 @@
 module ActsAsFilterable
   module ActiveRecordExt 
     autoload :Base, "acts_as_filterable/base"
-    autoload :Commands, "acts_as_filterable/commands"   
   end
 end
 

data/test/acts_as_filterable_integration_test.rb

@@ -1,7 +1,7 @@
 require "test_helper"
 
 class ActsAsFilterableIntegrationTest < Test::Unit::TestCase
-
+  
   context "An ActiveRecord model using acts_as_filterable" do
     setup do
       @model = ContactDetail.new do |cd|
@@ -19,25 +19,13 @@ class ActsAsFilterableIntegrationTest < Test::Unit::TestCase
       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 "add a macro to filter values to lowercase from string fields" do
+      ContactDetail.respond_to?(:filter_for_lowercase).should be(true)
+    end
     
     should "be savable with valid data" do
       @model.save.should be(true)
@@ -74,12 +62,12 @@ class ActsAsFilterableIntegrationTest < Test::Unit::TestCase
       end
     end
     
-    context "with non-character attributes" do
+    context "with non-string attributes" do
       setup do
         ContactDetail.filter_for_digits :discount
       end
       
-      should "not raise any errors due to a non-character attribute value" do
+      should "not raise any errors due to a non-string attribute value" do
         lambda { @model.valid? }.should_not raise_error
       end
       
@@ -90,7 +78,7 @@ class ActsAsFilterableIntegrationTest < Test::Unit::TestCase
       
     end
     
-    context "with an attribute value that contains no non-numeric values to be stripped" do
+    context "with an attribute value that contains no values to be stripped" do
       setup do 
         @model.phone_number = "2223334444"
         @model.valid?
@@ -104,15 +92,11 @@ class ActsAsFilterableIntegrationTest < Test::Unit::TestCase
     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
+        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)
+      should "not add attributes to other models errantly" do
+        ContactDetail.filtered_attributes[:digits].should_not include(:handle)
       end
 
     end

data/test/filter_test.rb

@@ -0,0 +1,129 @@
+require "test_helper"
+
+class FilterTest < Test::Unit::TestCase
+
+  def assert_identity_after_filter(filter, value)
+    identity = value.object_id
+    filter.call(value)
+    identity.should == value.object_id
+  end
+
+  context "Filters" do
+    should "default filters that don't exist to an empty array" do
+      ActsAsFilterable::Filters[:test].empty?.should be(true)
+    end
+  
+    should "contain some filters initially" do
+      ActsAsFilterable::Filters[:numeric].nil?.should_not be(true)
+      ActsAsFilterable::Filters[:lowercase].nil?.should_not be(true)
+    end
+  
+    should "freeze the macro collection so it cannot be mutated" do
+      lambda { ActsAsFilterable::Filters.store(:test, /./) }.should raise_error
+    end
+  end
+
+  context "When applying the" do
+    
+    context "digit filter, it" do
+      setup do
+        @filter = ActsAsFilterable::Filters[:digits]
+      end
+      
+      should "strip any non-digit values from the string" do
+        value = "45tr.,2"
+        @filter.call(value)
+        value.should be("452")
+      end
+      
+      should "not lose digit values" do
+        value = "432099132"
+        @filter.call(value)
+        value.should be("432099132")
+      end
+      
+      should "return a coercable numerica value" do
+        value = "4"
+        @filter.call(value)
+        value.to_i.should be(4)
+      end
+      
+      should "not create extra string objects when replacing values" do
+        assert_identity_after_filter @filter, "54tr"
+      end
+    
+      should "not create extra string objects when no values are to be replaced" do
+        assert_identity_after_filter @filter, "54"
+      end
+    
+    end
+    
+    context "lowercase filter, it" do
+      setup do
+        @filter = ActsAsFilterable::Filters[:lowercase]
+      end
+
+      should "lowercase all alpha values" do
+        value = "FAIl STRING"
+        @filter.call(value)
+        value.should be("fail string")
+      end
+      
+      should "not create extra string objects when replacing values" do
+        assert_identity_after_filter @filter, "TRANSLATE"
+      end
+    
+      should "not create extra string objects when no values are to be replaced" do
+        assert_identity_after_filter @filter, "43"
+      end
+    end
+
+    context "uppercase filter, it" do
+      setup do
+        @filter = ActsAsFilterable::Filters[:uppercase]
+      end
+
+      should "uppercase all alpha values" do
+        value = "lowercase string"
+        @filter.call(value)
+        value.should be("LOWERCASE STRING")
+      end
+      
+      should "not create extra string objects when replacing values" do
+        assert_identity_after_filter @filter, "translate"
+      end
+    
+      should "not create extra string objects when no values are to be replaced" do
+        assert_identity_after_filter @filter, "43"
+      end
+    end
+
+    context "whitesapce filter, it" do
+      setup do
+        @filter = ActsAsFilterable::Filters[:whitespace]
+      end
+
+      should "replace all un-neccessary whitespace" do
+        value = "\t hai!    this is neat\n\nok?  \t"
+        @filter.call(value)
+        value.should be("hai! this is neat ok?")
+      end
+      
+      should "trim the ends of the string" do
+        value = " this "
+        @filter.call(value)
+        value.should be("this")
+      end
+      
+      should "not create extra string objects when replacing values" do
+        assert_identity_after_filter @filter, "TRANSLATE"
+      end
+    
+      should "not create extra string objects when no values are to be replaced" do
+        assert_identity_after_filter @filter, "43"
+      end
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -16,7 +16,7 @@ ActiveRecord::Schema.define do
     t.float :discount
   end
   
-  create_table :user do |t|
+  create_table :users, :force => true do |t|
     t.string :handle
     t.string :phone_number
   end
@@ -28,6 +28,7 @@ end
 
 class User < ActiveRecord::Base
   filter_for_digits :phone_number
+  filter_for_lowercase :handle
 end
 
 class Test::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_filterable
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rob Ares
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-08 00:00:00 -04:00
+date: 2009-10-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,6 +74,7 @@ files:
 - lib/acts_as_filterable/base.rb
 - rails/init.rb
 - test/acts_as_filterable_integration_test.rb
+- test/filter_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/rares/acts_as_filterable
@@ -99,10 +100,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: An ActiveRecord plugin that allows attribute-based filtering in order to normalize numeric data
+summary: Filter attributes and stuff.
 test_files: 
 - test/acts_as_filterable_integration_test.rb
+- test/filter_test.rb
 - test/test_helper.rb