scopie 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec17cfb9b778cf068fc1905662711130a5f6546a
-  data.tar.gz: 1174d72fcb851d8230d067850edb28291c110c0b
+  metadata.gz: a712c48ae4d6541f9de46f7161944622035f5dca
+  data.tar.gz: a3ab1963d878729f75219ee9f8a48891c208abba
 SHA512:
-  metadata.gz: 12163b288818fc99ebf0d8eecd9b4dce713d30b48f45dd5ca9886c5528123d5a462204ef292fbb8074180a7081bf28df00993dcaadd99230def4a667e887dd12
-  data.tar.gz: 1a69b907b51c68978b7a9a3223f4e9dbce973ddaea07d1bf542dee48007a68fd815c2cb80f52be59e14d44afe081fb1ec09e14a7b258a613ff97a414e5da5139
+  metadata.gz: 13f994ef566f8d582a1e28f1213a25463b0aed03ec3c0131fc97760bed5897768835e7eb1fa5e12f4feb4966f0e799ddbb655f74658e205914f2466191cfc296
+  data.tar.gz: 0e37d4f423664bceb1d44c9f3e2db4906fd4f591040ae8814662289364a08787f369eca26e4d4572e236725fc3c6d9bcb5552cb08ad8f28f76403db442138375

data/README.md

@@ -1,36 +1,72 @@
 ## Scopie
+
+[![Code Climate](https://codeclimate.com/github/beorc/scopie/badges/gpa.svg)](https://codeclimate.com/github/beorc/scopie)
+
 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.
+It is similar to [has_scope](http://github.com/plataformatec/has_scope).
+
+The key differences are:
+
+* Dedicated class where the scopes are defined, so that your controller will be skinny.
+* 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
 class Graduation < ActiveRecord::Base
-  scope :featured, -> { where(:featured => true) }
-  scope :by_degree, -> degree { where(:degree => degree) }
-  scope :by_period, -> started_at, ended_at { where("started_at = ? AND ended_at = ?", started_at, ended_at) }
+
+  scope :featured, -> { where(featured: true) }
+  scope :by_degree, -> (degree) { where(degree: degree) }
+  scope :by_period, -> (started_at, ended_at) { where('started_at = ? AND ended_at = ?', started_at, ended_at) }
+
+  scope :created_at_greater_than, ->(date) { where('entities.created_at >= ?', date.beginning_of_day) }
+  scope :created_at_less_than, ->(date) { where('entities.created_at <= ?', date.end_of_day) }
+  scope :updated_at_greater_than, ->(date) { where('entities.updated_at >= ?', date.beginning_of_day) }
+  scope :updated_at_less_than, ->(date) { where('entities.updated_at <= ?', date.end_of_day) }
+
 end
 ```
 
 You can use those named scopes as filters by declaring them on your scopie:
 
 ```ruby
-class Scopies::GraduationsScopie < Scopie::Base
+class GraduationsScopie < Scopie::Base
+
   has_scope :featured, type: :boolean
   has_scope :by_degree, :by_period
+
+  has_scope :created_at_greater_than, in: :created_at, as: :start_at
+  has_scope :created_at_less_than, in: :created_at, as: :end_at
+
   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])
+    started_at = value[:started_at]
+    ended_at = value[:ended_at]
+
+    started_at && ended_at && scope.by_period(started_at, ended_at)
   end
+
+  def created_at_greater_than(scope, value, _hash)
+    scope.created_at_greater_than(parse_date(value))
+  end
+
+  def created_at_less_than(scope, value, _hash)
+    scope.created_at_less_than(parse_date(value))
+  end
+
+  private
+
+  def parse_date(value)
+    Date.parse(value)
+  end
+
 end
 ```
 
@@ -38,9 +74,11 @@ Now, if you want to apply them to an specific resource, you just need to call `a
 
 ```ruby
 class GraduationsController < ApplicationController
+
   def index
     @graduations = Scopie.apply_scopes(Graduation, method: :index, scopie: Scopies::GraduationsScopie.new).all
   end
+
 end
 ```
 
@@ -56,6 +94,9 @@ Then for each request:
 /graduations?by_period[started_at]=20100701&by_period[ended_at]=20101013
 #=> brings graduations in the given period
 
+/graduations?created_at[start_at]=2016-06-01&created_at[end_at]=2016-06-02
+#=> brings graduations created in the given period
+
 /graduations?featured=true&by_degree=phd
 #=> brings featured graduations with phd degree
 ```
@@ -72,7 +113,7 @@ gem 'scopie'
 
 Scopie supports several options:
 
-* `:type` - Checks the type of the parameter sent.
+* `:type` - Coerces the type of the parameter sent. Available options: boolean, integer, date.
 
 * `:only` - In which actions the scope is applied.
 

data/lib/scopie/base.rb

@@ -30,9 +30,10 @@ class Scopie::Base
 
   def current_scopes(hash, method = nil)
     scopes = scopes_configuration.map do |scope_name, options|
-      next unless scope_applicable?(scope_name, options, hash, method)
       value = scope_value(scope_name, options, hash)
-      [scope_name, value]
+      next unless scope_applicable?(value, options, method)
+
+      [scope_name, coerce_value_type(value, options[:type])]
     end
 
     scopes.compact!
@@ -43,10 +44,10 @@ class Scopie::Base
 
   def apply_scope(scope_name, target, value, hash)
     result = if respond_to?(scope_name)
-      public_send(scope_name, target, value, hash)
-    else
-      target.public_send(scope_name, value)
-    end
+               public_send(scope_name, target, value, hash)
+             else
+               target.public_send(scope_name, value)
+             end
 
     result || target
   end
@@ -61,7 +62,7 @@ class Scopie::Base
     key_name = key_name(scope_name, options)
     reduced_hash = reduced_hash(hash, options)
 
-    return coerce_value_type(reduced_hash[key_name], options[:type]) if reduced_hash.key?(key_name)
+    return reduced_hash[key_name] if reduced_hash.key?(key_name)
     options[:default]
   end
 
@@ -74,10 +75,17 @@ class Scopie::Base
     TRUE_VALUES.include? value
   end
 
-  def scope_applicable?(scope_name, options, hash, method)
+  def coerce_to_integer(value)
+    Integer(value)
+  end
+
+  def coerce_to_date(value)
+    Date.parse(value)
+  end
+
+  def scope_applicable?(value, options, method)
     return false unless method_applicable?(method, options)
 
-    value = scope_value(scope_name, options, hash)
     is_value_present = value.respond_to?(:empty?) ? !value.empty? : !!value
 
     is_value_present || !!options[:allow_blank]

data/lib/scopie/version.rb

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

metadata

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