scopie 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b007c093187a56143ba81168c7c5b2c5b9aed7c1
-  data.tar.gz: 71e9a5ad63b40ae3a066326cd39038f507a38086
+  metadata.gz: d0543b2ee6bdc2a9394156391427b022282d8669
+  data.tar.gz: 73a8eee4d9b96d7fae75907bb353f6842aa6b755
 SHA512:
-  metadata.gz: fa6aeb12cf0a6fac877ee7adf85efff85c8f921140e86e40e9f837933d73444e8d899daa384b5e5944ea2f2c58a8b5afb0daa0fdb97ef21fbb447a805e4d100d
-  data.tar.gz: d0f0529ff9a2f70398913b3b1a99161305a0fa9185db1f615f80fb53103654b687832f0c1e9baecce0d01ddeace6e99dc3672f8e14f076dcbf583bf3c60fff24
+  metadata.gz: 4ea45fea31644d7f1d0d02a4c3054abb02f7646c5ac0aa95f342793c9c8d03cf83ecb561c7234d2ef8ea2d126358eb1478d4ef8dea747db3b86cc9868480fcb9
+  data.tar.gz: 24fbffa8dfb94e38d017489c24e7cc39bb9dbf92aebec3ff7e5394c0db367b1111be87ce530dd3c17584856f78324188d06da303fbe5c59e74b75c1c6a1408e3

data/README.md

@@ -90,7 +90,7 @@ Now, if you want to apply them to an specific resource, you just need to call `a
 class GraduationsController < ApplicationController
 
   def index
-    @graduations = Scopie.apply_scopes(Graduation, method: :index, scopie: Scopies::GraduationsScopie.new).all
+    @graduations = Scopie.apply_scopes(Graduation, method: :index, scopie: GraduationsScopie.new).all
   end
 
 end
@@ -123,6 +123,10 @@ Add `scopie` to your Gemfile or install it from Rubygems.
 gem 'scopie'
 ```
 
+## Mutation testing
+
+    mutant --include lib --require scopie --use rspec Scopie*
+
 ## Options
 
 Scopie supports several options:

data/lib/scopie.rb

@@ -1,17 +1,31 @@
 # frozen_string_literal: true
 
 module Scopie
-  class InvalidOptionError < StandardError; end
-
   RESULTS_TO_IGNORE = [true, false].freeze
 
+  require 'scopie/version'
+  require 'scopie/invalid_type_error'
   require 'scopie/value'
   require 'scopie/base'
 
+  # Receives an object where scopes will be applied to.
+  #
+  #   class GraduationsScopie < Scopie::Base
+  #     has_scope :featured, type: :boolean
+  #     has_scope :by_degree, :by_period
+  #   end
+  #
+  #   class GraduationsController < ApplicationController
+  #     def index
+  #       @graduations = Scopie.apply_scopes(Graduation, method: :index, scopie: GraduationsScopie.new).all
+  #     end
+  #   end
+  #
   def self.apply_scopes(target, hash, method: nil, scopie: Scopie::Base.new)
     scopie.apply_scopes(target, hash, method)
   end
 
+  # Returns the scopes used in this action.
   def self.current_scopes(hash, method: nil, scopie: Scopie::Base.new)
     scopie.current_scopes(hash, method)
   end

data/lib/scopie/base.rb

@@ -10,8 +10,46 @@ class Scopie::Base
     self.class.scopes_configuration
   end
 
+  # Detects params from url and apply as scopes to your classes.
+  #
+  # == Options
+  #
+  # * <tt>:type</tt> - Coerces the type of the parameter sent.
+  #
+  # * <tt>:only</tt> - In which actions the scope is applied.
+  #
+  # * <tt>:except</tt> - In which actions the scope is not applied.
+  #
+  # * <tt>:as</tt> - The key in the params hash expected to find the scope.
+  #                  Defaults to the scope name.
+  #
+  # * <tt>:default</tt> - Default value for the scope. Whenever supplied the scope
+  #                       is always called.
+  #
+  # * <tt>:allow_blank</tt> - Blank values are not sent to scopes by default. Set to true to overwrite.
+  #
+  # == Method usage
+  #
+  # You can also define a method having the same name as a scope. The current scope, value and params are yielded
+  # to the block so the user can apply the scope on its own. The method can return new scope or the boolean value.
+  # In the latter case will be used not modified scope. This is useful in case we
+  # need to manipulate the given value:
+  #
+  #   has_scope :category
+  #
+  #   def category(scope, value, _hash)
+  #     value != 'all' && scope.by_category(value)
+  #   end
+  #
+  #   has_scope :not_voted_by_me, type: :boolean
+  #
+  #   def not_voted_by_me(scope, _value, _hash)
+  #     scope.not_voted_by(controller.current_user.id) # The controller method is available in the scopie_rails gem
+  #   end
+  #
   def self.has_scope(*scopes, **options)
     @scopes_configuration ||= {}
+    normalize_options!(options)
 
     scopes.each do |scope|
       @scopes_configuration[scope.to_sym] = options
@@ -47,8 +85,11 @@ class Scopie::Base
                target.public_send(scope_name, value)
              end
 
-    return target if Scopie::RESULTS_TO_IGNORE.include?(result)
-    result
+    if Scopie::RESULTS_TO_IGNORE.include?(result)
+      target
+    else
+      result
+    end
   end
 
   def key_name(scope_name, options)
@@ -78,12 +119,13 @@ class Scopie::Base
 
   def method_applicable?(method, options)
     return true unless method
+    action = method.to_s
 
-    methods_white_list = Array(options[:only])
-    methods_black_list = Array(options[:except])
+    methods_white_list = options[:only]
+    methods_black_list = options[:except]
 
-    return false if methods_black_list.include?(method)
-    return false if methods_white_list.any? && !methods_white_list.include?(method)
+    return false if methods_black_list.include?(action)
+    return false if methods_white_list.any? && !methods_white_list.include?(action)
 
     true
   end
@@ -94,4 +136,15 @@ class Scopie::Base
 
   private_class_method :reset_scopes_configuration!
 
+  def self.normalize_options!(options)
+    [:only, :except].each do |key|
+      options[key] = Array(options[key]).map(&:to_s)
+      options[key].reject!(&:empty?)
+    end
+
+    options
+  end
+
+  private_class_method :normalize_options!
+
 end

data/lib/scopie/invalid_type_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Scopie::InvalidTypeError < StandardError
+
+  def initialize(type)
+    @type = type
+  end
+
+  def message
+    "Unknown value for option 'type' provided: :#{@type}"
+  end
+
+end

data/lib/scopie/value.rb

@@ -11,14 +11,24 @@ class Scopie::Value
   end
 
   def raw
-    return @hash[@key_name] if @hash.key?(@key_name)
-    fetch_default
+    @hash.fetch(@key_name) { fetch_default }
   end
 
   def coerced
     coerce_to_type(raw, fetch_type)
   end
 
+  def given?
+    key_passed? || has_default?
+  end
+
+  def present?
+    value = raw
+    value.respond_to?(:empty?) ? !value.empty? : !!value
+  end
+
+  private
+
   def fetch_type
     @options[:type]
   end
@@ -31,27 +41,16 @@ class Scopie::Value
     @options.key?(:default)
   end
 
-  def given?
-    key_passed? || has_default?
-  end
-
   def key_passed?
     @hash.key?(@key_name)
   end
 
-  def present?
-    value = raw
-    value.respond_to?(:empty?) ? !value.empty? : !!value
-  end
-
-  private
-
   def coerce_to_type(value, type)
     return value unless type
 
     coercion_method_name = "coerce_to_#{type}"
 
-    respond_to?(coercion_method_name, true) || raise(Scopie::InvalidOptionError, "Unknown value for option 'type' provided: :#{type}")
+    respond_to?(coercion_method_name, true) || raise(Scopie::InvalidTypeError.new(type))
 
     send(coercion_method_name, value)
   end

data/lib/scopie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Scopie
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scopie
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Yury Kotov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-07-04 00:00:00.000000000 Z
 dependencies: []
 description: Minimal mapping of incoming parameters to named scopes in your resources
   through OO design and pure Ruby classes
@@ -22,6 +22,7 @@ files:
 - README.md
 - lib/scopie.rb
 - lib/scopie/base.rb
+- lib/scopie/invalid_type_error.rb
 - lib/scopie/value.rb
 - lib/scopie/version.rb
 homepage: https://github.com/beorc/scopie
@@ -44,8 +45,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Maps HTTP-parameters to your resource scopes
 test_files: []
+has_rdoc: