parascope 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ae9437f9c91dc9a6f126c16b6f3c4a2c745634d
-  data.tar.gz: 859be0e8b38ecc4e6af3d9fb0d379e464f54ab7e
+  metadata.gz: 17594187c5a94c9a523d77dba587407268717be5
+  data.tar.gz: 3f956433561618eac287109648fc34763227b6b2
 SHA512:
-  metadata.gz: 49ad2eccded8195f771ad943704a9df0fbf56c62fc52ca00474311140b366f42a98e093c55f1a5ae4c89151640747286f93464f6790ccef1a52918afd7ee15ae
-  data.tar.gz: 73c4988ec96e88e9973f6031d3ecd9bd48474777f3271d7f83ffd29c0ba7107dd278cc09c9dfe3ebd821684780d594b1647bd92ab2cc22670ce09c33a50e6a3d
+  metadata.gz: 705365aac8d26e59124e501142ef6858f808ffbe7a28d527bca39694dfcdb40ede594bc0a9b5510993357d6d4c40d4bbcc631c09122fdede9de74483738613fc
+  data.tar.gz: f3c944dae562511bd8b7951ce2b1fa02ecb91ead2b5a602ad638df0c06072fe0c55db8bd4e7f60c7f89023c7cd33ddd762f46633dca804f9d46eaae712d740db

data/CHANGELOG

@@ -1,5 +1,7 @@
 === master
 
+Improve :index option support, add query_by! and sift_by! methods
+
 === 1.0.3
 
 Explicitly apply query blocks in definition order

data/README.md

@@ -5,7 +5,7 @@ Param-based scope generation.
 [![build status](https://secure.travis-ci.org/akuzko/parascope.png)](http://travis-ci.org/akuzko/parascope)
 [![github release](https://img.shields.io/github/release/akuzko/parascope.svg)](https://github.com/akuzko/parascope/releases)
 
---
+---
 
 This gem provides a `Parascope::Query` class with a declarative and convenient API
 to build scopes (ActiveRecord relations or arbitrary objects) dynamically, based
@@ -51,15 +51,22 @@ scope manipulations using `query_by`, `sift_by` and other class methods bellow.
   returns a non-nil value, it becomes a new scope for subsequent processing. Of course,
   there can be multiple `query_by` block definitions. Methods accepts additional options:
   - `:index` - allows to specify order of query block applications. By default all query
-    blocks have index of 0;
+    blocks have index of 0. This option also accepts special values `:first` and `:last` for
+    more convenient usage. Queries with the same value of `:index` option are applied in
+    order of declaration.
   - `:if` - specifies condition according to which query should be applied. If Symbol
     or String is passed, calls corresponding method. If Proc is passed, it is executed
     in context of query object. Note that this is optional condition, and does not
     overwrite original param-based condition for a query block that should always be met.
   - `:unless` - the same as `:if` option, but with reversed boolean check.
 
-- `query(&block)` declares scope-generation block that is always executed. As `query_by`,
-  accepts `:index`, `:if` and `:unless` options.
+- `query_by!(*fields, &block)` declares scope-generation block that is always executed
+  (unless `:if` and/or `:unless` options are used). All values in params at `fields` keys are
+  yielded to the block. As `query_by`, accepts `:index`, `:if` and `:unless` options.
+
+- `query(&block)` declares scope-generation block that is always executed (unless `:if`
+  and/or `:unless` options are used). As `query_by`, accepts `:index`, `:if` and `:unless`
+  options.
 
 *Examples:*
 
@@ -90,8 +97,12 @@ end
 - `sift_by(*presence_fields, **value_fields, &block)` method is used to hoist sets of
   query definitions that should be applied if, and only if, all specified values
   match criteria in the same way as in `query_by` method. Just like `query_by` method,
-  values of specified fields are yielded to the block. Such `sift_by` definitions
-  may be nested in any depth.
+  values of specified fields are yielded to the block. Accepts the same options as
+  it's `query_by` counterpart. Such `sift_by` definitions may be nested in any depth.
+
+- `sift_by!(*fields, &block)` declares a sifter block that is always applied (unless
+  `:if` and/or `:unless` options are used). All values in params at specified `fields`
+  are yielded to the block.
 
 - `sifter` alias for `sift_by`. Results in a more readable construct when a single
   presence field is passed. For example, `sifter(:paginated)`.

data/lib/parascope/query/api_block.rb

@@ -3,17 +3,18 @@ module Parascope
     OPTION_KEYS = %i[index if unless].freeze
     private_constant :OPTION_KEYS
 
-    attr_reader :presence_fields, :value_fields, :block, :options
+    attr_reader :presence_fields, :value_fields, :block, :force, :options
 
-    def initialize(presence_fields:, value_fields:, block:)
+    def initialize(presence_fields:, value_fields:, block:, force: false)
       @options = extract_options!(value_fields)
 
-      @presence_fields, @value_fields, @block =
-        presence_fields, value_fields, block
+      @presence_fields, @value_fields, @block, @force =
+        presence_fields, value_fields, block, force
     end
 
     def fits?(query)
       return false unless conditions_met_by?(query)
+      return true if force
 
       (presence_fields.size == 0 && value_fields.size == 0) ||
         values_for(query.params).all?{ |value| present?(value) }
@@ -28,7 +29,12 @@ module Parascope
     end
 
     def index
-      options[:index] || 0
+      case options[:index]
+      when :first  then -Float::INFINITY
+      when :last   then Float::INFINITY
+      when Numeric then options[:index]
+      else 0
+      end
     end
 
     private

data/lib/parascope/query/api_methods.rb

@@ -33,6 +33,27 @@ module Parascope
     alias_method :sifter, :sift_by
     alias_method :query, :query_by
 
+    def sift_by!(*presence_fields, &block)
+      sift_blocks.push Query::ApiBlock.new(
+        presence_fields: presence_fields,
+        value_fields:    {},
+        block:           block,
+        force:           true
+      )
+    end
+
+    def query_by!(*presence_fields, &block)
+      query_blocks.push Query::ApiBlock.new(
+        presence_fields: presence_fields,
+        value_fields:    {},
+        block:           block,
+        force:           true
+      )
+    end
+
+    alias_method :sifter!, :sift_by!
+    alias_method :query!, :query_by!
+
     def guard(&block)
       guard_blocks.push block
     end

data/lib/parascope/version.rb

@@ -1,3 +1,3 @@
 module Parascope
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parascope
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Artem Kuzko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-09 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Builds a params-sifted scope