scoped_from 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 482df1de6489956c47825b4fbd71aba7d503181d
-  data.tar.gz: 4b3270b8efce564533f32dc13ba9ca2c02052459
+  metadata.gz: 4b56a3a6c6ec63c95e922a48d886843747725f4a
+  data.tar.gz: 44a3f95dcb98a946af1b6f20f0319f23fd372595
 SHA512:
-  metadata.gz: 4fe4a20776a1eaf41754dea44011fb2269082bb4c44707919e7a5b3bd7a1fb3a9ba544fe71d0af11036dd7c510681414638ddaef667fb2960ac7a571aef46d72
-  data.tar.gz: da4e358a921c96fabc986c52323c58e4f1515d420d4029bba8fbbf59e28ebbb224918ddc28c2d4d6acd87b8a055b891f8468903989f467b2d21a475a71227a91
+  metadata.gz: 3d1153e12c34cac02f2e43e2e73245602c9b06395e8077b50662edbc1fdfcabfd2d17c29cfa37a687cb6565fa74dac3fea9755e77d13e284a1078fc130e7eded
+  data.tar.gz: 8e349b84d70e4b3ab0f492d0689392b366290e85276e882a0e5d52b927a2ad1f622e3ca463aab0cc9fb0a9dc40259153123cbe6ea2c3c10b8e1689204e03a4c4

data/.gitignore

@@ -1,6 +1,6 @@
 .DS_Store
-.bundle
-.ruby-version
-Gemfile.lock
-pkg/*
-spec/test.sqlite3
+/.bundle/
+/.ruby-version
+/Gemfile.lock
+/pkg/
+/spec/test.sqlite3

data/README.mdown

@@ -7,7 +7,9 @@ Provides a simple mapping between scopes and controller parameters for
 
 Just add this into your `Gemfile`:
 
-    gem 'scoped_from'
+```ruby
+gem 'scoped_from'
+```
 
 Then, just run `bundle install`.
 
@@ -15,39 +17,45 @@ Then, just run `bundle install`.
 
 First, a model with some scopes:
 
-    class Post < ActiveRecord::Base
+```ruby
+class Post < ActiveRecord::Base
 
-      scope :commented, where('comments_count > 0')
+  scope :commented, where('comments_count > 0')
 
-      scope :created_between, lambda { |after, before|
-        where('created_at >= ? AND created_at <= ?', after, before)
-      }
+  scope :created_between, lambda { |after, before|
+    where('created_at >= ? AND created_at <= ?', after, before)
+  }
 
-      scope :search, lambda { |pattern|
-        where('body LIKE ?', "%#{pattern}%")
-      }
+  scope :search, lambda { |pattern|
+    where('body LIKE ?', "%#{pattern}%")
+  }
 
-      scope :with_category, lambda { |category_id|
-        where(:category_id, category_id)
-      }
+  scope :with_category, lambda { |category_id|
+    where(:category_id, category_id)
+  }
 
-    end
+end
+```
 
 After, a controller:
 
-    class PostsController < ActionController::Base
+```ruby
+class PostsController < ActionController::Base
 
-      def index
-        @posts = Post.scoped_from(params)
-      end
+  def index
+    @posts = Post.scoped_from(params)
+  end
 
-    end
+end
+```
 
 Then, it just filter your model from params:
 
-    /posts?commented=1
-    /posts?search=rails
-    /posts?search=rails&commented=1&with_category=42
+```
+/posts?commented=1
+/posts?search=rails
+/posts?search=rails&commented=1&with_category=42
+```
 
 ## Accepted scopes
 
@@ -64,21 +72,29 @@ Columns are also automatically scoped.
 
 You can restrict mapping to some scopes with `:only` option:
 
-    @posts = Post.scoped_from(params, only: ['commented', 'search'])
+```ruby
+@posts = Post.scoped_from(params, only: ['commented', 'search'])
+```
 
 You can also exclude some scopes from mapping with `:except` option:
 
-    @posts = Post.scoped_from(params, except: 'commented')
+```ruby
+@posts = Post.scoped_from(params, except: 'commented')
+```
 
 ## Mapping order
 
 If you need to map an SQL order, just pass `order` parameter:
 
-    @posts = Post.scoped_from(order: 'created_at')
+```ruby
+@posts = Post.scoped_from(order: 'created_at')
+```
 
 Order direction can be specified using a dot, space or `:` as delimiter:
 
-    @posts = Post.scoped_from(order: 'created_at.desc')
+```ruby
+@posts = Post.scoped_from(order: 'created_at.desc')
+```
 
 Note that order is SQL safe with `scoped_from` method (columns names are
 checked).
@@ -88,26 +104,36 @@ checked).
 If your provide an array as parameter value, scope is invoked with each item
 of the array:
 
-    @posts = Post.scoped_from(search: ['bar', 'foo'])
+```ruby
+@posts = Post.scoped_from(search: ['bar', 'foo'])
+```
 
 is equivalent to
 
-    @posts = Post.search('bar').search('foo')
+```ruby
+@posts = Post.search('bar').search('foo')
+```
 
 You may also not want to filter on columns, just specify `:exclude_columns`
 option:
 
-    @posts = Post.scoped_from(params, exclude_columns: true)
+```ruby
+@posts = Post.scoped_from(params, exclude_columns: true)
+```
 
 A query string can also be given to `scoped_from` method:
 
-    @posts = Post.scoped_from('with_category=24&search[]=foo&search[]=bar')
+```ruby
+@posts = Post.scoped_from('with_category=24&search[]=foo&search[]=bar')
+```
 
 Returned scope from `scoped_from` method gives access to an internal query
 object:
 
-    @posts = Post.scoped_from(params)
-    @query = @posts.query
+```ruby
+@posts = Post.scoped_from(params)
+@query = @posts.query
+```
 
 This query provides you some convenience methods like `params`, `order_column`
 and `order_direction`. This object can also be used to save user's search into
@@ -117,23 +143,27 @@ But, you may also have to subclass this query class. You have to create a
 subclass of `ScopedFrom::Query` named `#{RecordClassName}Query`. Here is an
 example:
 
-    class PostQuery < ScopedFrom::Query
+```ruby
+class PostQuery < ScopedFrom::Query
 
-      def category
-        Category.find_by_id(params[:with_category]) if params[:with_category]
-      end
+  def category
+    Category.find_by_id(params[:with_category]) if params[:with_category]
+  end
 
-    end
+end
+```
 
 This class has to be in load path.
 
 Then into a view:
 
-    <% if @query.category %>
-      <p>All posts of category <%= @query.category.name %></p>
-    <% else %>
-      <p>All posts</p>
-    <% end %>
+```erb
+<% if @query.category %>
+  <p>All posts of category <%= @query.category.name %></p>
+<% else %>
+  <p>All posts</p>
+<% end %>
+```
 
 ## Executing test suite
 

data/VERSION

@@ -1 +1 @@
-0.9.0
+1.0.0

data/lib/scoped_from/active_record.rb

@@ -9,7 +9,7 @@ module ScopedFrom
       base.scope_arities = ActiveSupport::HashWithIndifferentAccess.new
     end
 
-    module ClassMethods
+    class_methods do
 
       def scope(name, scope_options, &block)
         super

data/scoped_from.gemspec

@@ -16,11 +16,11 @@ Gem::Specification.new do |s|
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'activerecord', '>= 4.1.0', '< 4.3.0'
-  s.add_dependency 'activesupport', '>= 4.1.0', '< 4.3.0'
+  s.add_dependency 'activerecord', '>= 5.0.0', '< 5.1.0'
+  s.add_dependency 'activesupport', '>= 5.0.0', '< 5.1.0'
 
-  s.add_development_dependency 'byebug', '>= 3.2.0', '< 3.6.0'
-  s.add_development_dependency 'rake', '>= 10.3.0', '< 10.5.0'
-  s.add_development_dependency 'rspec', '>= 3.1.0', '< 3.2.0'
+  s.add_development_dependency 'byebug', '>= 3.2.0', '< 10.0.0'
+  s.add_development_dependency 'rake', '>= 10.3.0', '< 12.0.0'
+  s.add_development_dependency 'rspec', '>= 3.1.0', '< 3.6.0'
   s.add_development_dependency 'sqlite3-ruby', '>= 1.3.0', '< 1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scoped_from
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,7 @@ dependencies:
         version: 3.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 10.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,7 +69,7 @@ dependencies:
         version: 3.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 10.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +79,7 @@ dependencies:
         version: 10.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 10.5.0
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ dependencies:
         version: 10.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 10.5.0
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ dependencies:
         version: 3.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -109,7 +109,7 @@ dependencies:
         version: 3.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scoped_from
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Mapping between scopes and parameters for Rails