scopie 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81e654437e834ed3e40a66765512129901f09d97
-  data.tar.gz: ecf9f776853e9bc5f7f4a2eb9c43382a5c6be232
+  metadata.gz: e4dc1d9c52050baf32e9de66d52508da37b2b6d2
+  data.tar.gz: 6c5abc0c7f5a27e0784db9607cb1e9331c757788
 SHA512:
-  metadata.gz: e9507e247d4134b177dbe1d469cbb4108919c78f55e1bf67f91a8093234ef9819c67bf0b19d143739422b4025be0f1180652093549c1fa931adfdb0dcaae8e78
-  data.tar.gz: 2927c25d5d98354ae2e9523fdbf6d09e206204ae2dd8cffb4fec759f94ddb582a9c50ff8f75a48a104b8a148150cfe9ce199982e70286e38e65b31be285225f2
+  metadata.gz: 86efafe4d7843c496ce6dd6c1b6e13f5600184cec5773e4dd90f087f4edf61df0e1cebf94429f4adb5ee4af62b219e34f8609966ec963428a892383f39e191d1
+  data.tar.gz: ded02f636fa57c71e24bf0bdc70b17d9ceafa0f58d7f5372db265e1887430cbc9d5f785a3d65dad83fb6a23e46fc730fa0b55a1161d005689663b8bdf2d5bb10

data/README.md

@@ -2,6 +2,13 @@
 Minimal mapping of incoming parameters to named scopes in your resources through OO design
 
 Scopie allows you to map incoming controller parameters to named scopes in your resources.
+
+Scopie is the yet another implementation of [has_scope](http://github.com/plataformatec/has_scope). The key differences is dedicated class where
+the scopes are defined. Also, it doesn't depend from ActiveSupport or ActionPack. Please have, a look at [scopie_rails](http://github.com/beorc/scopie_rails)
+if you are using Ruby on Rails framework.
+To override default mapping behavior you don't need to pass a block - just define a method with the same name as scope.
+You can DRY your custom scopes mapping logic by using helper methods defined in scopie class and use the same scopie class in multiple controllers.
+
 Imagine the following model called graduations:
 
 ```ruby
@@ -17,8 +24,9 @@ You can use those named scopes as filters by declaring them on your scopie:
 ```ruby
 class Scopies::GraduationsScopie < Scopie::Base
   has_scope :featured, type: :boolean
-  has_scope :by_degree
-  has_scope :by_period
+  has_scope :by_degree, :by_period
+  has_scope :page, default: 1
+  has_scope :per, default: 30
   
   def by_period(scope, value, _hash)
     scope.by_period(value[:started_at], value[:ended_at])
@@ -57,7 +65,7 @@ Then for each request:
 Add `scopie` to your Gemfile or install it from Rubygems.
 
 ```ruby
-gem 'scopie
+gem 'scopie'
 ```
 
 ## Options
@@ -70,4 +78,12 @@ Scopie supports several options:
 
 * `:except` - In which actions the scope is not applied.
 
+* `:as` - The key in the params hash expected to find the scope. Defaults to the scope name.
+
 * `:default` - Default value for the scope. Whenever supplied the scope is always called.
+
+## Thanks
+
+Scopie was inspired by [has_scope](http://github.com/plataformatec/has_scope) and [pundit](http://github.com/elabs/pubdit).
+
+Thanks to both.

data/lib/scopie/base.rb

@@ -31,8 +31,15 @@ class Scopie::Base
 
   private
 
+  def key_name(scope_name, options)
+    key_name = scope_name
+    key_name = options[:as] if options.key?(:as)
+    key_name
+  end
+
   def scope_value(scope_name, options, hash)
-    return coerce_value_type(hash[scope_name], options[:type]) if hash.key?(scope_name)
+    key_name = key_name(scope_name, options)
+    return coerce_value_type(hash[key_name], options[:type]) if hash.key?(key_name)
     options[:default]
   end
 
@@ -54,7 +61,8 @@ class Scopie::Base
       return false if methods_white_list.any? && !methods_white_list.include?(method)
     end
 
-    hash.key?(scope_name) || options.key?(:default)
+    key_name = key_name(scope_name, options)
+    hash.key?(key_name) || options.key?(:default)
   end
 
   def self.reset_scopes_configuration!

data/lib/scopie/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Scopie
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scopie
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yury Kotov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec