query_filter 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f281a64c42dfafb2f5478b7dc850e4d09fbc177357d85590a45e2abaa55b91ea
-  data.tar.gz: c9823c4351c0757a97eeb0d851e22980da495ecdc13784002f6e2ef3390f6403
+  metadata.gz: 6fe7cf9e804b940444eefcf3fbced4b24099d52d32f71d896bcb401fcb1e9e43
+  data.tar.gz: e61f5e207c0a6c7fccae4d44a6a5990cde48f2432d0f520ea47767a417323504
 SHA512:
-  metadata.gz: 38bdd2e28381998445c90a2c86fff1f0d3513df6b995ffbafc1399cf3b3460d5fb25b462602ff3b48426597e0a1aba0951e2adcc4cc3eb4c42ca943bf0c0bff8
-  data.tar.gz: a1aeac38a34238ecb73269246e716501e01897f420181c1a1cdd632a2b5b803a976d26c6d6e012389e9ca2e7b681f573081835df489ed9acbe85959aae928cc8
+  metadata.gz: caa899332d0b1034baf784a418c1788d70220380d783069edf8b653729d47bdacd67016828546dfe41a078e0000e72b54379b5f60a67f5bf1e4823f4e8e72862
+  data.tar.gz: 931eed522f0e6d00cab63631967f70729f5d22067016d12a89220d34ee38513213c47ced8090c1062e10f9d0001490dffdc9913b9cc3a0dc84c4395e3bd4e2b0

data/Gemfile.lock

@@ -1,83 +1,47 @@
 PATH
   remote: .
   specs:
-    query_filter (0.2.0)
+    query_filter (0.2.2)
       activesupport (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
-      arel (>= 9.0)
-    activesupport (5.2.3)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (9.0.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    ffi (1.10.0)
-    formatador (0.2.5)
-    guard (2.15.0)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    i18n (1.6.0)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.2)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.13)
-    method_source (0.9.2)
-    minitest (5.11.3)
-    nenv (0.3.0)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    rb-fsevent (0.9.8)
-    rb-inotify (0.10.0)
-      ffi (~> 1.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    minitest (5.14.1)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    ruby_dep (1.5.0)
-    shellany (0.0.1)
-    sqlite3 (1.4.1)
-    thor (0.20.3)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    sqlite3 (1.4.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -85,12 +49,10 @@ PLATFORMS
 DEPENDENCIES
   activerecord (>= 4.0)
   bundler (~> 1.15)
-  guard-rspec (~> 4.7, >= 4.7.3)
   query_filter!
-  rake (~> 10.0)
-  rb-fsevent (= 0.9.8)
+  rake (>= 12.3.3)
   rspec (~> 3.0)
   sqlite3 (~> 1.3, >= 1.3.13)
 
 BUNDLED WITH
-   1.16.2
+   1.17.3

data/README.md

@@ -236,6 +236,62 @@ QueryFilter.setup do |config|
 end
 ```
 
+## Testing
+
+query_filter gem defines some custom RSpec matchers. Include them to your project:
+
+```ruby
+# spec/support/query_filter.rb
+
+require "query_filter/rspec_matchers"
+
+RSpec.configure do |config|
+  config.include QueryFilter::RSpecMatchers, type: :query_filter
+end
+```
+
+Custom matchers will be available to use in specs:
+
+```ruby
+# spec/filters/order_filter_spec.rb
+
+describe OrderFilter, type: :query_filter do
+  context "scope deleted" do
+    it "performs query" do
+      expect { filter(deleted: true) }.to perform_query(deleted: true)
+    end
+
+    it "doesn't perform query with wrong params" do
+      expect { filter(deleted: "invalid_param") }.to_not perform_query
+    end
+  end
+
+  it "performs query by state" do
+    expect(relation).to receive(:with_state).with(:pending)
+    filter(state: :pending)
+  end
+
+  it "reorders by sort_column" do
+    expect { filter(sort_column: :id, sort_mode: :desc) }
+      .to reorder.by("orders.id DESC NULLS LAST")
+  end
+
+  context "query against the database" do
+    let(:order) { create(:order, state: :pending) }
+
+    # relation is a double by default, but can be redefined to an actual ActiveRecord::Relation:
+    before do
+      relation Order.all
+    end
+
+    it "finds the order" do
+      expect(filter(state: :pending)).to contain_exactly(order)
+      expect(filter(state: :invalid_state)).to be_empty
+    end
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/query_filter/rspec_matchers.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  module QueryFilter::RSpecMatchers
+    extend RSpec::Matchers::DSL
+
+    def relation(override = nil)
+      @relation ||= override || double('ActiveRecord::Relation')
+    end
+
+    def filter(params)
+      described_class.new(relation, params).to_query
+    end
+
+    # Usage:
+    #
+    # expect { filter(username: "joe") }.to perform_query(users: { username: "joe" })
+    # expect { filter(field: :invalid_value) }.to_not perform_query
+    #
+    matcher :perform_query do |*params_for_where|
+      def supports_block_expectations?
+        true
+      end
+
+      match do |block|
+        expect(relation).to receive(:where).with(*params_for_where)
+        block.call
+      end
+
+      match_when_negated do |block|
+        expect(relation).to_not receive(:where)
+        block.call
+      end
+    end
+
+    # Usage:
+    #
+    # expect { filter(sort: :asc) }.to reorder.by("users.created_at" => "asc")
+    # expect { filter(sort: :invalid_value) }.to_not reorder
+    #
+    matcher :reorder do
+      def supports_block_expectations?
+        true
+      end
+
+      match do |block|
+        expect(relation).to receive(:reorder).with(@params_for_reorder)
+        block.call
+      end
+
+      match_when_negated do |block|
+        expect(relation).to_not receive(:reorder)
+        block.call
+      end
+
+      chain :by do |conditions|
+        @params_for_reorder = conditions
+      end
+    end
+  end
+
+  config.after do
+    @relation = nil
+  end
+end

data/lib/query_filter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QueryFilter
-  VERSION = '0.2.0'
+  VERSION = '0.2.2'
 end

data/query_filter.gemspec

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
-# coding: utf-8
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'query_filter/version'
 
@@ -23,12 +22,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'activerecord', '>= 4.0'
   spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'guard-rspec', '~> 4.7', '>= 4.7.3'
-  spec.add_development_dependency 'rb-fsevent', '0.9.8'
-  spec.add_development_dependency 'activerecord', '>= 4.0'
   spec.add_development_dependency 'sqlite3', '~> 1.3', '>= 1.3.13'
 
   spec.add_dependency 'activesupport', '>= 4.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: query_filter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Igor Galeta
@@ -9,98 +9,64 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.7.3
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.7.3
-- !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.8
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +124,7 @@ files:
 - bin/setup
 - lib/query_filter.rb
 - lib/query_filter/base.rb
+- lib/query_filter/rspec_matchers.rb
 - lib/query_filter/rules/date_range.rb
 - lib/query_filter/rules/order_by.rb
 - lib/query_filter/rules/range.rb