filter_factory 0.0.2 → 0.0.3

data/README.md

@@ -33,7 +33,19 @@ Describe your filter:
       # ...
     end
 
-Render form as you want in your view:
+Alternate way to create your filter:
+
+    @filter = FilterFactory.create do
+        # type filter type as method and field name as an argument
+        eq :author
+        gte :views
+
+        # supply options after field name
+        gte :created_at, alias: :created_at_gte
+        lte :created_at, alias: :created_at_lte
+    end
+
+Render form as you want in your view (use aliases instead of field names if specified):
 
     <%= form_for @filter, as: :filter do |f| %>
     <div>

data/lib/filter_factory/field.rb

@@ -4,9 +4,18 @@ module FilterFactory
     attr_accessor :value
 
     def initialize(name, condition, options = {})
+      raise ArgumentError unless FilterFactory::Filter::CONDITIONS.include?(condition)
+
       valid_options = [:alias]
       @name, @condition, @options = name, condition, options.reject{|k,v| !valid_options.include?(k)}
       @alias = @options[:alias] || @name
     end
+
+    def ==(obj)
+      return false unless obj.is_a?(self.class)
+      [:name, :condition, :alias].inject(true) do |acc,attr|
+        acc && public_send(attr) == obj.public_send(attr)
+      end
+    end
   end
 end

data/lib/filter_factory/filter.rb

@@ -7,6 +7,8 @@ module FilterFactory
 
     attr_reader :fields
 
+    CONDITIONS = [:eq, :ne, :lt, :lte, :gt, :gte, :all, :in, :nin, :regex, :exists, :presents]
+
     def initialize
       @fields = []
     end
@@ -29,13 +31,25 @@ module FilterFactory
       fields.select{|f| !f.value.nil? && f.value != ''}
     end
 
+    def get_field(name)
+      fields.find{|f| f.name == name}
+    end
+
     def persisted?
       false
     end
 
+    CONDITIONS.each do |condition|
+      define_method condition do |name,options={}|
+        field(name, condition, options)
+      end
+    end
+
     private
     def field(name, condition, options={})
       Field.new(name, condition, options).tap do |field|
+        raise DuplicateFieldError if fields.include?(field)
+
         define_singleton_method(field.alias){ field.value }
         define_singleton_method("#{field.alias}="){|val| field.value = val }
 
@@ -48,5 +62,7 @@ module FilterFactory
         new.tap{|filter| filter.instance_eval &block}
       end
     end
+
+    class DuplicateFieldError < StandardError; end
   end
 end

data/lib/filter_factory/version.rb

@@ -1,3 +1,3 @@
 module FilterFactory
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/filter_factory/field_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+describe FilterFactory::Field do
+  describe "#initialize" do
+    it "should create field with name & condition specified" do
+      field = described_class.new(:name, :eq)
+      field.should be_instance_of(described_class)
+      field.alias.should == :name
+      field.name.should == :name
+      field.condition.should == :eq
+    end
+
+    it "should create field with name, condition & options specified" do
+      field = described_class.new(:name, :eq, alias: :my_name)
+      field.should be_instance_of(described_class)
+      field.alias.should == :my_name
+      field.name.should == :name
+      field.condition.should == :eq
+    end
+
+    it "should raise error if name is not specified" do
+      expect{ described_class.new }.to raise_error(ArgumentError)
+    end
+
+    it "should raise error if condition is not specified" do
+      expect{ described_class.new(:name) }.to raise_error(ArgumentError)
+    end
+
+    it "should raise error if wrong condition specified" do
+      expect{ described_class.new(:name, :my_eq) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#==" do
+    it "should be equal to obj if it is an instance of Field & it has equal name, condition & alias" do
+      f1 = described_class.new(:name, :eq)
+      f2 = described_class.new(:name, :eq, alias: :name)
+      f1.should == f2
+    end
+
+    it "should not be equal to obj if it is not an instance of Field" do
+      f = described_class.new(:name, :eq)
+      f.should_not == []
+      f.should_not == {}
+      f.should_not == 0
+    end
+
+    it "should not be equal to obj if it is an instance of Field & it does not have equal name" do
+      described_class.new(:name, :eq).should_not == described_class.new(:my_name, :eq)
+    end
+
+    it "should not be equal to obj if it is an instance of Field & it does not have equal condition" do
+      described_class.new(:name, :eq).should_not == described_class.new(:name, :ne)
+    end
+
+    it "should not be equal to obj if it is an instance of Field & it does not have equal alias" do
+      described_class.new(:name, :eq).should_not == described_class.new(:name, :eq, alias: :my_name)
+    end
+  end
+end

data/spec/filter_factory/filter_spec.rb

@@ -67,6 +67,43 @@ describe FilterFactory::Filter do
     filter.attributes.should == HashWithIndifferentAccess.new({name: "test name", last_name: nil})
   end
 
+  it "should raise error if duplicate field definition found" do
+    expect do
+      described_class.create do
+        field :name, :eq
+        field :surname, :regex, alias: :last_name
+        field :name, :eq, alias: :name
+      end
+    end.to raise_error(FilterFactory::Filter::DuplicateFieldError)
+  end
+
+  it "should respond to #get_field method" do
+    should respond_to(:get_field)
+  end
+
+  it "should return valid field by calling #get_field" do
+    filter = described_class.create do
+      field :name, :eq
+      field :surname, :regex, alias: :last_name
+    end
+    filter.get_field(:name).should be_instance_of(FilterFactory::Field)
+    filter.get_field(:name).condition.should == :eq
+    filter.get_field(:surname).should be_instance_of(FilterFactory::Field)
+    filter.get_field(:surname).condition.should == :regex
+    filter.get_field(:my_name).should be_nil
+  end
+
+  described_class::CONDITIONS.each do |condition|
+    it "should respond to #{condition} method" do
+      should respond_to(condition)
+    end
+
+    it "should define field with '#{condition}' condition" do
+      filter = described_class.create{ public_send(condition, :name) }
+      filter.get_field(:name).condition.should == condition
+    end
+  end
+
   it "should fill filter values from hash" do
     filter = described_class.create do
       field :name, :eq

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filter_factory
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-07 00:00:00.000000000 Z
+date: 2013-02-13 00:00:00.000000000 Z
 dependencies: []
 description: Gem for easy ActiveRecord/Mongoid models filtering
 email: 
@@ -34,6 +34,7 @@ files:
 - lib/filter_factory/version.rb
 - spec/factories/factories.rb
 - spec/filter_factory/active_record/model_spec.rb
+- spec/filter_factory/field_spec.rb
 - spec/filter_factory/filter_spec.rb
 - spec/filter_factory/mongoid/model_spec.rb
 - spec/models/ar_post.rb
@@ -67,6 +68,7 @@ summary: FilterFactory allows you to easily fetch ActiveRecord/Mongoid models th
 test_files:
 - spec/factories/factories.rb
 - spec/filter_factory/active_record/model_spec.rb
+- spec/filter_factory/field_spec.rb
 - spec/filter_factory/filter_spec.rb
 - spec/filter_factory/mongoid/model_spec.rb
 - spec/models/ar_post.rb