scopie_rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d709cd41d5dbae30fa15a4dfc02d956433688079
-  data.tar.gz: ed3c1303ce2903a37d8c144edf7b8f23046f71de
+  metadata.gz: 3e56563f6e72158575391b7da2f3a82e22737a46
+  data.tar.gz: 21af9647d32257149b14ddd4878720039d461dc5
 SHA512:
-  metadata.gz: 7d34cd601c277d93720362a3c2a211ad9874f113ff55018b210434c6505c1f0fcb899787ac23c04f8c2e058cbe8bc718af6f281aaf4ef2cb8831945ef4d1b943
-  data.tar.gz: 3c84b48a12da15d8e7fc1955f498bcb44232ab0f135e54e7f676eb0b70edb8b4f4cc16ad9c609a2217f7dfb4c6906c6429f2005550833fb1e98a2a929eedd9cb
+  metadata.gz: c8de2a74842924f0a452664058ee620a676132c75e2dede33bfa10d364a88cf2f173aa3c311dd7f7688f4bc8a3673129cabc4092809d13a1db3369d9f7c12d68
+  data.tar.gz: 0fda698f097b7d25b4e3728e83bfe8ea5536e0f06bc5c7f08615f483be4406035b09fad9b23155fa24f08918e80ad3c9f09ec79b18462a504b54bd46f02e8bd5

data/README.md

@@ -1,2 +1,75 @@
-# scopie_rails
+## ScopieRails
 Scopie for Rails
+
+ScopieRails 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 < ScopieRails::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
+  include ScopieRails::Controller
+
+  def index
+    @graduations = apply_scopes(Graduation).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_rails` to your Gemfile or install it from Rubygems.
+
+```ruby
+gem 'scopie_rails'
+```
+
+## 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_rails.rb

@@ -8,10 +8,10 @@ require 'active_support/core_ext/string/inflections'
 
 module ScopieRails
 
-  SCOPIE_PREFIX = 'Scopies'.freeze
-  SCOPIE_SUFFIX = 'Scopie'.freeze
-  CLASS_NAME_DELIMETER = '::'.freeze
-  CONTROLLER_DELIMETER = 'Controller'.freeze
+  SCOPIE_PREFIX = 'Scopies'
+  SCOPIE_SUFFIX = 'Scopie'
+  CLASS_NAME_DELIMETER = '::'
+  CONTROLLER_DELIMETER = 'Controller'
 
   require 'scopie_rails/base'
   require 'scopie_rails/controller'

data/lib/scopie_rails/controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ScopieRails::Controller
   extend ActiveSupport::Concern
 

data/lib/scopie_rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scopie_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yury Kotov