filterism 1.0.0 → 2.0.0

data/lib/filterism/parsers/params_parser.rb

@@ -0,0 +1,51 @@
+module Filterism
+  class ConditionParser
+    attr_accessor :comparators
+    def initialize
+      @comparators = {
+        'equal_to' => '=',
+        'not_equal_to' => '!=',
+
+        'greater_than' => '>',
+        'gt' => '>',
+        'after' => '>',
+        'greater_than_or_equal_to' => '>=',
+        'gtet' => '>=',
+
+        'less_than' => '<',
+        'lt' => '<',
+        'before' => '<',
+        'less_than_or_equal_to' => '<=',
+        'ltet' => '<=',
+
+        'like' => 'LIKE',
+
+        'in' => 'IN'
+      }
+    end
+
+    def parse(params)
+      conditions = []
+      params.each do |key, value|
+        keysplit = key.to_s.split('_is_')
+        if @comparators.keys.include?(keysplit[1])
+          conditions <<
+          {
+            key: keysplit[0],
+            comparator: @comparators[keysplit[1]],
+            value: value
+          }
+        end
+      end
+      return conditions
+    end
+
+    def add_comparator(comparator)
+      @comparators = @comparators.merge(comparator)
+    end
+
+    def delete_comparator(comparator_key)
+      @comparators.delete(comparator_key)
+    end
+  end
+end

data/lib/filterism/version.rb

@@ -1,3 +1,3 @@
 module Filterism
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/spec/adapters/active_record_adapter_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'support/active_record'
+
+describe Filterism do
+  describe "#filter" do
+    ActiveRecord::Base.include(Filterism)
+
+    class User < ActiveRecord::Base
+    end
+
+    it "filters for equals" do
+      user = User.where("name = 'Phil Spitler'").first
+      expect(User.filter([
+        {key: 'name', comparator: '=', value: 'Phil Spitler'},
+      ]).first).
+      to eq(user)
+    end
+
+    it "filters for LIKE" do
+      user = User.where("name LIKE '%Billy%'").first
+      expect(User.filter([
+        {key: 'name', comparator: 'LIKE', value: 'Billy'},
+      ]).first).
+      to eq(user)
+    end
+
+    it "filters for IN" do
+      user = User.where("name IN ('Phil Spitler','Joe Stuffypants')")
+      expect(User.filter([
+        {key: 'name', comparator: 'IN', value: 'Phil Spitler,Joe Stuffypants'},
+      ]).to_a).
+      to eq(user.to_a)
+    end
+
+    it "filters for booleans" do
+      user = User.where(is_young_at_heart: true)
+      expect(User.filter([
+        {key: 'is_young_at_heart', comparator: '=', value: 'true'},
+      ]).to_a).
+      to eq(user.to_a)
+    end
+
+    context "with filterable fields" do
+      it "filters only on filterable fields" do
+        class User < ActiveRecord::Base
+          filterable_fields :age, :is_young_at_heart
+        end
+
+        user = User.all.to_a
+        expect(User.filter([
+          {key: 'name', comparator: '=', value: 'Phil Spitler'},
+        ]).to_a).
+        to eq(user)
+
+        user = User.where(is_young_at_heart: true)
+        expect(User.filter([
+          {key: 'is_young_at_heart', comparator: '=', value: "true"}
+        ]).to_a).
+        to eq(user)
+      end
+    end
+
+    context "with unfilterable fields" do
+      it "filters only on unfilterable fields" do
+        class User < ActiveRecord::Base
+          unfilterable_fields :name
+        end
+
+        user = User.all.to_a
+        expect(User.filter([
+          {key: 'name', comparator: '=', value: 'Phil Spitler'},
+        ]).to_a).
+        to eq(user)
+
+        user = User.where(is_young_at_heart: true)
+        expect(User.filter([
+          {key: 'is_young_at_heart', comparator: '=', value: "true"}
+        ]).to_a).
+        to eq(user)
+      end
+    end
+
+  end
+end

data/spec/db/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.string :name
+    t.string :age
+    t.string :is_young_at_heart
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory :user do
+    name "Phil Spitler"
+    age 37
+    is_young_at_heart true
+  end
+end
+

data/spec/parsers/params_parser_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Filterism::ConditionParser do
+  before(:all) do
+    @condition_parser = Filterism::ConditionParser.new
+  end
+
+  describe "#parse" do
+    it "has the parse method" do
+      expect(@condition_parser).to respond_to(:parse)
+    end
+    subject { -> (params) { return @condition_parser.parse(params) }}
+
+    it "returns a hash" do
+      expect(subject.call({ name_is_equal_to: 'David' })).to be_an(Array)
+    end
+
+    it "has the keys 'key, comparator, value'" do
+      expect(subject.call({ name_is_equal_to: 'David' })[0].keys.sort).
+        to eq([:comparator, :key, :value])
+    end
+
+    specify "the returned hashes are derived from the hash which was passed in" do
+      conditions = subject.call({ name_is_equal_to: 'John' }).first
+      expect(conditions[:key]).to eq "name"
+      expect(conditions[:comparator]).to eq "="
+      expect(conditions[:value]).to eq "John"
+    end
+  end
+
+  describe "#add_comparator" do
+    it "has the add_comparator method" do
+      expect(@condition_parser).to respond_to(:add_comparator).with(1).argument
+    end
+
+    it "adds the new comparator to the comparators Hash" do
+      expect(@condition_parser.add_comparator({"equals_to" => "="})).to include("equals_to" => "=")
+    end
+  end
+
+  describe "#delete_comparator" do
+    it "has the delete_comparator method" do
+      expect(@condition_parser).to respond_to(:delete_comparator).with(1).argument
+    end
+
+    it "deletes the comparator from the comparators Hash" do
+      @condition_parser.add_comparator({"equals_to" => "="})
+      expect(@condition_parser.delete_comparator("equals_to")).not_to include("equals_to")
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'simplecov'
+SimpleCov.add_filter '.bundle'
+SimpleCov.start
+require 'filterism'
+require 'factory_girl'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.include FactoryGirl::Syntax::Methods
+  #config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/active_record.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+load "spec/db/schema.rb"
+
+FactoryGirl.find_definitions
+
+class User < ActiveRecord::Base
+end
+
+FactoryGirl.create(:user)
+
+FactoryGirl.create(:user, {
+  name: 'Billy Bob',
+  age: 18,
+  is_young_at_heart: true
+})
+
+FactoryGirl.create(:user, {
+  name: 'Joe Stuffypants',
+  age: 27,
+  is_young_at_heart: false
+})

metadata

@@ -1,187 +1,189 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: filterism
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Phil Spitler
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-09 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: maruku
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        version: "0.6"
+date: 2014-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 6
-        version: "2.6"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bond
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
-        version: "0.4"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 7
-        version: "0.7"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 1
-        version: 3.0.1
-  type: :runtime
-  version_requirements: *id007
-description: ""
-email: pspitler@gmail.com
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: ''
+email:
+- pspitler@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .autotest
-- .gemtest
-- .gitignore
-- .rspec
-- .yardopts
+files:
+- ".autotest"
+- ".gemtest"
+- ".gitignore"
+- ".irbrc"
+- ".rspec"
+- ".yardopts"
 - Gemfile
 - LICENSE.md
+- LICENSE.txt
 - README.md
 - Rakefile
+- exec/autospec
+- exec/htmldiff
+- exec/ldiff
+- exec/rake
+- exec/rspec
 - filterism.gemspec
 - lib/filterism.rb
+- lib/filterism/adapters/active_record_adapter.rb
+- lib/filterism/parsers/params_parser.rb
 - lib/filterism/version.rb
-- spec/filterism_spec.rb
-- spec/finders/activerecord_test_connector.rb
-- spec/fixtures/post.rb
-- spec/fixtures/posts.yml
-- spec/fixtures/schema.rb
-- spec/fixtures/user.rb
-- spec/fixtures/users.yml
-- spec/helper.rb
-has_rdoc: true
-homepage: https://github.com/philspitler/filterism
-licenses: []
-
+- spec/adapters/active_record_adapter_spec.rb
+- spec/db/schema.rb
+- spec/factories.rb
+- spec/parsers/params_parser_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: http://sproutkey.com
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: A DSL for filtering active record results based on hash keys with the term _is_ in them.
-test_files: 
-- spec/filterism_spec.rb
-- spec/finders/activerecord_test_connector.rb
-- spec/fixtures/post.rb
-- spec/fixtures/posts.yml
-- spec/fixtures/schema.rb
-- spec/fixtures/user.rb
-- spec/fixtures/users.yml
-- spec/helper.rb
+specification_version: 4
+summary: DSL for communicating filter intent via HTTP parameters in the URL
+test_files:
+- spec/adapters/active_record_adapter_spec.rb
+- spec/db/schema.rb
+- spec/factories.rb
+- spec/parsers/params_parser_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb