parascope 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17594187c5a94c9a523d77dba587407268717be5
-  data.tar.gz: 3f956433561618eac287109648fc34763227b6b2
+  metadata.gz: 6caa45deb0d23160ab7595714e4517eed4306e10
+  data.tar.gz: e407dc5cb9e132c3c814ce43ad94ea64a1c57fb4
 SHA512:
-  metadata.gz: 705365aac8d26e59124e501142ef6858f808ffbe7a28d527bca39694dfcdb40ede594bc0a9b5510993357d6d4c40d4bbcc631c09122fdede9de74483738613fc
-  data.tar.gz: f3c944dae562511bd8b7951ce2b1fa02ecb91ead2b5a602ad638df0c06072fe0c55db8bd4e7f60c7f89023c7cd33ddd762f46633dca804f9d46eaae712d740db
+  metadata.gz: 6af3bf60ea924a9b8326f962424f08ce71b0623fdc5c6277109e0eee70077ccd368ca1b2193a2a5410dda1fc2f619232fcbd8039f18caee79c2e60d1effc3126
+  data.tar.gz: baedb425a6571abd713856e34bd3859a75d4c38a2146ccaa96efc56ca9b56924f9c70f13bfb7c713cdaba3848132852c613f5f316d47d33e19988e2c64219904

data/README.md

@@ -136,6 +136,8 @@ end
   top-level base scope is yielded to the method block. Note that `base_scope` will
   not be called if query is initialized with a given scope.
 
+  *Alias:* `base_dataset`
+
 *Examples:*
 
 ```ruby
@@ -180,8 +182,7 @@ end
 - `build(scope: nil, **attributes)` initializes a query with empty params. Handy when
   query depends only passed attributes and internal logic. Also useful in specs.
 
-  *Examples:*
-
+*Examples:*
 
 ```ruby
 query = UsersQuery.build(scope: users_scope)
@@ -190,9 +191,10 @@ query = UsersQuery.build(scope: users_scope)
 
 #### Instance Methods
 
-- `initialize(params, scope: nil, **attributes)` initializes a query with `params`,
-  an optional scope (that if passed, is used instead of `base_scope`). All additionally
-  passed options are accessible via reader methods in query blocks and elsewhere.
+- `initialize(params, scope: nil, dataset: nil, **attributes)` initializes a query with
+  `params`, an optional scope can be passed as `:scope` or `:dataset` option. If passed,
+  it will be used instead of `base_scope`. All additionally passed options are accessible
+  via reader methods in query blocks and elsewhere.
 
 *Examples:*
 
@@ -207,6 +209,8 @@ query = UsersQuery.new(query_params, company: company)
   to base scope. Primary usage is to call this method in `query_by` blocks and return
   it's mutated version corresponding to passed `query_by` arguments.
 
+  *Alias:* `dataset`
+
 - `guard(&block)` executes a passed `block`. If this execution returns falsy value,
   `GuardViolationError` is raised. You can use this method to ensure safety of param
   values interpolation to a SQL string in a `query_by` block for example.
@@ -231,6 +235,8 @@ end
   `resolved_scope(with_projects: true)`). It's the main `Query` instance method that
   returns the sole purpose of it's instances.
 
+  *Aliases:* `resolved_dataset`, `resolve`
+
 *Examples:*
 
 ```ruby

data/lib/parascope/query.rb

@@ -21,9 +21,9 @@ module Parascope
       new({}, **attrs)
     end
 
-    def initialize(params, scope: nil, **attrs)
+    def initialize(params, scope: nil, dataset: nil, **attrs)
       @params = Hashie::Mash.new(klass.defaults).merge(params || {})
-      @scope  = scope unless scope.nil?
+      @scope  = scope || dataset unless scope.nil? && dataset.nil?
       @attrs  = attrs.freeze
       @base_params = @params
       define_attr_readers
@@ -32,6 +32,7 @@ module Parascope
     def scope
       @scope ||= base_scope
     end
+    alias_method :dataset, :scope
 
     def base_scope
       scope = klass.ancestors
@@ -47,6 +48,7 @@ module Parascope
 
       scope
     end
+    alias_method :base_dataset, :base_scope
 
     def resolved_scope(*args)
       arg_params = args.pop if args.last.is_a?(Hash)
@@ -54,6 +56,8 @@ module Parascope
 
       clone_with_params(trues(args).merge(arg_params || {})).resolved_scope
     end
+    alias_method :resolved_dataset, :resolved_scope
+    alias_method :resolve, :resolved_scope
 
     def klass
       sifted? ? singleton_class : self.class

data/lib/parascope/query/api_methods.rb

@@ -5,6 +5,7 @@ module Parascope
 
       @base_scope = block
     end
+    alias_method :base_dataset, :base_scope
 
     def defaults(params = nil)
       @defaults ||= {}

data/lib/parascope/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parascope
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Artem Kuzko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2018-01-13 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.6.13
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Builds a params-sifted scope