scopable 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee3745951007ea46ec4850feed0954b54162d07c
-  data.tar.gz: b5d0532406671734b01ff7373ae02a741202b35c
+  metadata.gz: 2f2ceee764d1cb24f319eb1013a1e99af71f2e51
+  data.tar.gz: 8d79497d0ac281967f13c74c41d0f6b7c7ab7af3
 SHA512:
-  metadata.gz: 7662d0e1425ceba03fcd6dc6a078d1921b1063798764eb8506f1198a381726f3f65672775a20db60e8be9ac84f9935eceb68cb1a98d54f768c51c969a019bbb2
-  data.tar.gz: 0a2cbca03aa015da8b912f4030544f9745abb006e110a7ddfe47804cb0a5095bc7008ffb48e71188db721b3b5aa85e4b97ac468625a2c583e00abdb1173bf5cc
+  metadata.gz: cb49a404433b3bd4124fddc3843e0c2e374b9d8f82c1ff856fd70bf34de6d829cfe63a0049d7569485bb9688482ebec2048145a64ff14695a13cc7b7175654a7
+  data.tar.gz: e38b3c2f659179047f611aa63b74203e50eb2a77580aae139a446589c55e6b4a415c428f5cdff4858e5b12961e301eb730b28c75158aa79343241c4558c6ac8c

data/.travis.yml

@@ -1,4 +1,4 @@
 ---
 language: ruby
 rvm:
-  - 2.3.1
+  - 2.3.4

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 gemspec
 group :test do
-  gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
 end

data/README.md

@@ -1,7 +1,7 @@
-[![RubyGems](https://img.shields.io/gem/dt/scopable.svg)](https://rubygems.org/gems/scopable)
-[![Build](https://img.shields.io/travis/haggen/scopable.svg)](https://travis-ci.org/haggen/scopable)
-[![Code Climate](https://img.shields.io/codeclimate/github/haggen/scopable.svg)](https://codeclimate.com/github/haggen/scopable)
-[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/haggen/scopable.svg)](https://codeclimate.com/github/haggen/scopable/coverage)
+[![RubyGems](https://img.shields.io/gem/dt/scopable.svg?style=flat-square)](https://rubygems.org/gems/scopable)
+[![Build](https://img.shields.io/travis/corenzan/scopable.svg?style=flat-square)](https://travis-ci.org/corenzan/scopable)
+[![Code Climate](https://img.shields.io/codeclimate/github/corenzan/scopable.svg?style=flat-square)](https://codeclimate.com/github/corenzan/scopable)
+[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/corenzan/scopable.svg?style=flat-square)](https://codeclimate.com/github/corenzan/scopable/coverage)
 
 # Scopable
 
@@ -18,7 +18,7 @@ gem 'scopable'
 And then execute:
 
 ```shell
-$ bundle
+$ bundle install
 ```
 
 Or install it yourself with:
@@ -29,7 +29,7 @@ $ gem install scopable
 
 ## Usage
 
-Configure scopes in your controller:
+First you need to set scopes in your controller:
 
 ```ruby
 class PostsController < ApplicationController
@@ -41,28 +41,48 @@ class PostsController < ApplicationController
 end
 ```
 
-Then apply it to your model:
+Then apply them when querying the model:
 
 ```ruby
-def index
-  @posts = scoped(Post, params)
+class PostsController < ApplicationController
+  include Scopable
+
+  scope :search, param: :q
+
+  def index
+    @posts = scoped(Post, params)
+  end
 end
 ```
 
-Now whenever the parameter `q` is present in `params`, `#search` will be called on your model passing the parameter's value as argument.
+Now whenever the parameter `q` is present in `params`, the scope `#search` will be called on your model and given the value of `params[:q]` as argument. Otherwise you would have to write something like this:
+
+```ruby
+  if params[:q].present?
+    @posts = Post.search(params[:q])
+  else
+    @posts = Post.all
+  end
+```
 
-Another example:
+What would be fine, except you usually have multiple scopes, that might get combined depending on the presence or absence of parameters to produce the final query. Look how simple it becomes when using Scopable:
 
 ```ruby
 class PostController < ApplicationController
   include Scopable
 
-  scope :by_date, param: :date do |relation, value|
-    relation.where(created_at: Date.parse(value))
+  # Filter by category.
+  scope :category do |relation, value|
+    relation.where(category_id: value.to_i)
   end
 
-  scope :by_author, param: :author
+  # Fix N+1.
+  scope :includes, force: :author
+
+  # Pagination.
+  scope :page, default: 1
 
+  # Sort by creation date.
   scope :order, force: { created_at: :desc }
 
   def index
@@ -71,39 +91,23 @@ class PostController < ApplicationController
 end
 ```
 
-Now say your URL look like this:
+Now say a request is made looking like this:
 
 ```
-/posts?date=2016-1-6&author=2
+/posts?category=2
 ```
 
-The resulting relation would be:
+The resulting query would be:
 
 ```ruby
-Post.where(created_at: '6/1/2016').by_author(2).order(created_at: :desc)
+Post.where(category_id: 2).includes(:author).page(1).order(created_at: :desc)
 ```
 
-**Note that order matters!** The scopes will be applied in the same order they are configured.
+Please note that **order matters**. The scopes will be applied in the same order they are configured.
 
-Also note values like `true/false`, `on/off`, `yes/no` are treated like boolean, and when the value is evaluated to `true` or `false` the scope is called with no arguments, or skipped, respectively.
+Also values like `true/false`, `on/off`, `yes/no` are **cast as boolean**, and when given a boolean value the scope is either called with no arguments or skipped entirely. For instance, if you set a scope like `scope :draft` then request the URL `/posts?draft=yes` it would be like just calling `Post.draft`. But if you request `/posts?draft=no` it does nothing.
 
-```ruby
-scope :active
-```
-
-With a URL like this:
-
-```ruby
-/?active=yes
-```
-
-Would be equivalent to:
-
-```ruby
-Model.active
-```
-
-## Options
+### Options
 
 No option is required. By default it assumes both scope and parameter have the same name.
 
@@ -112,19 +116,11 @@ Key         | Description
 `:param`    | Name of the parameter that activates the scope.
 `:default`  | Default value for the scope in case the parameter is missing.
 `:force`    | Force a value to the scope regardless of the request parameters.
-`:required` | Calls `#none` on the model if parameter is absent and no default value is given.
-`:only`     | The scope will only be applied to these actions.
-`:except`   | The scope will be applied to all actions except these.
-`&block`    | Block will be called in the context of the action and will be given the current relation and evaluated value.
+`:required` | Calls `#none` on the model if parameter is absent (blank or nil) and there's no default value set.
+`:only`     | String, Symbol or an Array of those. The scope will **only** be applied to these actions.
+`:except`   | String, Symbol or an Array of those. The scope will be applied to all actions **except** these.
+`&block`    | Block will be called in the context of the controller's action and will be given two parameters: the current relation and evaluated value.
 
 ## License
 
 See [LICENSE](LICENSE).
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/scopable/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/lib/scopable/version.rb

@@ -1,3 +1,3 @@
 module Scopable
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
 end

data/scopable.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Arthur Corenzan']
   spec.email         = ['arthur@corenzan.com']
   spec.summary       = %q{Apply or skip model scopes based on options and request parameters.}
-  # spec.description   = %q{}
-  spec.homepage      = 'https://github.com/haggen/scopable'
+  spec.description   = %q{}
+  spec.homepage      = 'https://github.com/corenzan/scopable'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.2'
 
-  spec.add_runtime_dependency 'activesupport', '>= 3.2', '<= 5.0.0'
+  spec.add_runtime_dependency 'activesupport', '>= 3.2'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scopable
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Arthur Corenzan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-28 00:00:00.000000000 Z
+date: 2017-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-description: 
+description: ''
 email:
 - arthur@corenzan.com
 executables: []
@@ -95,7 +89,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/controller.rb
 - spec/support/model.rb
-homepage: https://github.com/haggen/scopable
+homepage: https://github.com/corenzan/scopable
 licenses:
 - MIT
 metadata: {}