scopie 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8eb723af17f363d0f3f18392dbea1492a4f050ad
-  data.tar.gz: 1d2208c697295d9bbed888170226c6bfae654b86
+  metadata.gz: 81e654437e834ed3e40a66765512129901f09d97
+  data.tar.gz: ecf9f776853e9bc5f7f4a2eb9c43382a5c6be232
 SHA512:
-  metadata.gz: 07433bdc51620e60a85cc5542292f82ee4081282d96504af74e9cf4565a02a30bea8864325d558c71ecf9b36bd42c2060e23055d97892bfc16d123de6f863f5f
-  data.tar.gz: d43d8893ae350428da51c45f9efbae62d1667bbbeb479bba5cf7e60cc08eeabc1b4796ec32c50d97d3bcdd102068dfe07d5a18b3c51f7de0b09e162eb467e2b2
+  metadata.gz: e9507e247d4134b177dbe1d469cbb4108919c78f55e1bf67f91a8093234ef9819c67bf0b19d143739422b4025be0f1180652093549c1fa931adfdb0dcaae8e78
+  data.tar.gz: 2927c25d5d98354ae2e9523fdbf6d09e206204ae2dd8cffb4fec759f94ddb582a9c50ff8f75a48a104b8a148150cfe9ce199982e70286e38e65b31be285225f2

data/README.md

@@ -1,2 +1,73 @@
-# scopie
-Minimal mapping of incoming parameters to named scopes in your resources through OO design and pure Ruby classes
+## 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.
+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) }
+end
+```
+
+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
+  
+  def by_period(scope, value, _hash)
+    scope.by_period(value[:started_at], value[:ended_at])
+  end
+end
+```
+
+Now, if you want to apply them to an specific resource, you just need to call `apply_scopes`:
+
+```ruby
+class GraduationsController < ApplicationController
+  def index
+    @graduations = Scopie.apply_scopes(Graduation, method: :index, scopie: Scopies::GraduationsScopie.new).all
+  end
+end
+```
+
+Then for each request:
+
+```
+/graduations
+#=> acts like a normal request
+
+/graduations?featured=true
+#=> calls the named scope and bring featured graduations
+
+/graduations?by_period[started_at]=20100701&by_period[ended_at]=20101013
+#=> brings graduations in the given period
+
+/graduations?featured=true&by_degree=phd
+#=> brings featured graduations with phd degree
+```
+
+## Installation
+
+Add `scopie` to your Gemfile or install it from Rubygems.
+
+```ruby
+gem 'scopie
+```
+
+## Options
+
+Scopie supports several options:
+
+* `:type` - Checks the type of the parameter sent.
+
+* `:only` - In which actions the scope is applied.
+
+* `:except` - In which actions the scope is not applied.
+
+* `:default` - Default value for the scope. Whenever supplied the scope is always called.

data/lib/scopie/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 class Scopie::Base
+  TRUE_VALUES = ['true', true, '1', 1]
 
   def self.scopes_configuration
     instance_variable_get(:@scopes_configuration) || {}
@@ -31,10 +32,19 @@ class Scopie::Base
   private
 
   def scope_value(scope_name, options, hash)
-    return hash[scope_name] if hash.key?(scope_name)
+    return coerce_value_type(hash[scope_name], options[:type]) if hash.key?(scope_name)
     options[:default]
   end
 
+  def coerce_value_type(value, type)
+    return value unless type
+    send("coerce_to_#{type}", value)
+  end
+
+  def coerce_to_boolean(value)
+    TRUE_VALUES.include? value
+  end
+
   def scope_applicable?(scope_name, options, hash, method)
     methods_white_list = Array(options[:only])
     methods_black_list = Array(options[:except])

data/lib/scopie/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scopie
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Yury Kotov
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Minimal mapping of incoming parameters to named scopes in your resources
   through OO design and pure Ruby classes
 email: