magic_scopes 1.1.1 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5d9345a05c0300bf73e385b9b5295d48becd2b7
+  data.tar.gz: 568857c953e14d9c0e3016e1511a13d521890a85
+SHA512:
+  metadata.gz: 0fe3ec398d18b7adc935177eefd3859f2a80ee4f06e2499129f81cb7e997ecc78717ac93c9dbb67f0c1a4f120f37a59d62ceb696f33b4667b5f9482c9b95bf9a
+  data.tar.gz: bf5401a1ee1d38bb16365db4a3663b7a41ffe265fa22634f5ca04cbe7dee96291b6c91711581f83626f17a5a6d3e06197e6d9a61a4cdaf485104db5c28df144d

data/README.md

@@ -0,0 +1,51 @@
+# MagicScopes
+
+MagicScopes is the scopes generator for ActiveRecord.
+It adds magic_scopes method (and nothing else) to ActiveRecord::Base.
+It depends on ActiveRecord and ActiveSupport and can be used without Rails.
+MagicScopes module should be included manually in the latter case.
+It also has support for the StateMachine gem and can generate scopes for states.
+
+Code speaks much louder than words, so I show you some usage examples at first.
+
+## Usage examples
+
+* Call to `magic_scopes` without parameters generates all possible scopes for all attributes, belongs_to associations and states. It also generates asc, sorted, desc, recent, random standard scopes (read further for details). By specifying parameters you tell magic_scopes to generate only the scopes you need.
+
+* You can customize change by specifying list of attributes and options, (all options accept strings, symbols and arrays as arguments).
+
+* `magic_scopes :title, :bogus` generates all possible scopes for title and bogus attributes.
+
+* You can specify in (stands for include) and ex (for exclude) options, so:
+  * `magic_scopes in: %w(with by), std: %w(recent random)` generates 'with' and 'by' scopes for all suitable attributes and 'recent' and 'random' standard scopes.
+  * `magic_scopes ex: %w(with by)` generates all possible scopes except 'with' and 'by' ones when 'ex' option is specified.
+  * `magic_scopes :title, :bogus, in: %w(with by)` generates 'with' and 'by' scopes for all suitable attributes in specified list when both attributes list and in options are cpecified:
+  * You can also override scopes that should be generated per attribute:
+      `magic_scopes :title, :rating, bogus: :by_desc, in: %w(with by)` generates with and by scopes for title and rating attributes and by_desc scope for bogus attribute.
+  * Also you can specify scope name for scope type per attribute, like so: `magic_scopes :title, rating: {by_desc: :by_popularity}`. It generates all possible scopes for title attribute and 'by_popularity' scope that sorts relation by rating, desc.
+
+
+## MagicScopes can generate these scopes:
+
+* **with** and **without** options generates scopes such as **with_rating**, **without_rating** that will look for non-null and null values, respectively. For state attributes they redefine corresponding state_machine scopes so they can be called without parameters to check against null and non-null. (You can use it in the normal way too, of course). These scopes can be used with boolean, state, integer, decimal, time, date, datetime, float and string attributes. For integer, decimal, time, date, datetime and string attributes value(s) can be passed to the scope so the check will be performed against passed values (not against null/non-null vakues). (ex.: with_rating(1,2,3), without_rating([5,4,3]))
+* **is** and **not** options generates scopes such as **published**, **not_published** ("is" is the one option that is not reflected in the name of the generated scope) that look for true and and false or null values for boolean attributes and for the specified state and for state that is not the specifieed one no null for state attributes.
+* **eq** (stands for equal), **ne** (not equal), **gt** (greater than), **gte** (greater than or equal), **lt** (lesser than), **lte** (lesser than or equal) options generate scopes with corresponding suffixes and accept list of values or array as parameteters. Options names are self explanatory. These scopes can be used with integer, decimal, time, date and datetime attributes. lt and gt options can be used with float attributes.
+* for string attributes **like** and **ilike** options can be specified which generate scopes like **title_like**, **title_ilike** which accept list or array of arguments and look for values like the specified ones, case sensitive and insensitive, respectively.
+* **by** and **by_desc** options can be used with integer, decimal, time, date, datetime, float and string attributes and generate scopes like **by_created_at** and **by_created_at_desc**, which sort by created at asc and created at desc, respectively.
+* **for** and **not_for** scopes can be used with belongs_to associations (including polymorphic ones) and generate scopes like **for_user**, **not_for_commentable**. They can accept list or array of associations. Also, hash(es) with id and type keys can be specified for polymorphic associations.
+
+
+## Standard scopes
+
+In addition, some standard scopes can be specified using :std option, they are:
+asc and sorted sort by id asc, desc and recent sort by id desc and random sorts in random order.
+ex.: magic_scopes :title, :bogus, in: %w(with without), std: %w(recent rendom)
+magic_scopes generate all possible standard scopes unless std option is specified.
+
+MagicScopes is thoroughly tested and ready for production.
+It works with ActiveRecord >= 3.0 and ruby 1.9. (1.8 is not supported).
+
+## Authors
+  * Dmitry Afanasyev (dimarzio1986@gmail.com), please do not hesitate to contact me if you have any questions or suggestions.
+
+This project rocks and uses MIT-LICENSE.

data/lib/magic_scopes/scopes_generators/boolean.rb

@@ -4,11 +4,11 @@ module MagicScopes
     include PresenceScopes
 
     def is(name)
-      scope name || @attr, where("#{@key}" => true)
+      scope name || @attr, -> { where("#{@key}" => true) }
     end
 
     def not(name)
-      scope name || "not_#{@attr}", where("#{@key}" => [false, nil])
+      scope name || "not_#{@attr}", -> { where("#{@key}" => [false, nil]) }
     end
   end
 end

data/lib/magic_scopes/scopes_generators/mixins/equality_scopes.rb

@@ -9,7 +9,7 @@ module MagicScopes
     end
 
     def without(name)
-      scope name || "without_#{@attr}", where("#{@key} IS NULL")
+      scope name || "without_#{@attr}", -> { where("#{@key} IS NULL") }
     end
 
     def ne(name)

data/lib/magic_scopes/scopes_generators/mixins/order_scopes.rb

@@ -1,11 +1,11 @@
 module MagicScopes
   module OrderScopes
     def by(name)
-      scope name || "by_#{@attr}", order("#{@attr} ASC")
+      scope name || "by_#{@attr}", -> { order("#{@attr} ASC") }
     end
 
     def by_desc(name)
-      scope name || "by_#{@attr}_desc", order("#{@attr} DESC")
+      scope name || "by_#{@attr}_desc", -> { order("#{@attr} DESC") }
     end
   end
 end

data/lib/magic_scopes/scopes_generators/mixins/presence_scopes.rb

@@ -1,11 +1,11 @@
 module MagicScopes
   module PresenceScopes
     def with(name)
-      scope name || "with_#{@attr}", where("#{@key} IS NOT NULL")
+      scope name || "with_#{@attr}", -> { where("#{@key} IS NOT NULL") }
     end
 
     def without(name)
-      scope name || "without_#{@attr}", where("#{@key} IS NULL")
+      scope name || "without_#{@attr}", -> { where("#{@key} IS NULL") }
     end
   end
 end

data/lib/magic_scopes/scopes_generators/state.rb

@@ -8,11 +8,11 @@ if defined?(StateMachine)
       end
 
       def is(name)
-        scope name || @state, where("#{@key}" => @state)
+        scope name || @state, -> { where("#{@key}" => @state) }
       end
 
       def not(name)
-        scope name || "not_#{@state}", where("#{@key} != ? OR #{@key} IS NULL", @state)
+        scope name || "not_#{@state}", -> { where("#{@key} != ? OR #{@key} IS NULL", @state) }
       end
 
       def with(name)

data/lib/magic_scopes/standard_scopes.rb

@@ -9,23 +9,23 @@ module MagicScopes
     private
 
     def asc_scope
-      scope :asc, order(:id)
+      scope :asc, -> { order(:id) }
     end
 
     def sorted_scope
-      scope :sorted, order(:id)
+      scope :sorted, -> { order(:id) }
     end
 
     def desc_scope
-      scope :desc,  order('id DESC')
+      scope :desc,  -> { order('id DESC') }
     end
 
     def recent_scope
-      scope :recent, order('id DESC')
+      scope :recent, -> { order('id DESC') }
     end
 
     def random_scope
-      scope :random, order('RANDOM()')
+      scope :random, -> { order('RANDOM()') }
     end
   end
 end

data/lib/magic_scopes/version.rb

@@ -1,3 +1,3 @@
 module MagicScopes
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: magic_scopes
 version: !ruby/object:Gem::Version
-  version: 1.1.1
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Dmitry Afanasyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-11 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,65 +55,43 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: state_machine
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-debugger
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: ActiveRecord scopes generators
@@ -149,30 +120,29 @@ files:
 - lib/magic_scopes.rb
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 homepage: http://github.com/icrowley
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ActiveRecord scopes generators
 test_files: []
 has_rdoc: 

data/README.rdoc

@@ -1,55 +0,0 @@
-= MagicScopes
-
-MagicScopes is the scopes generator for ActiveRecord.
-
-It adds magic_scopes method (and nothing else) to ActiveRecord::Base.
-
-It depends on ActiveRecord and ActiveSupport and can be used without Rails.
-MagicScopes module should be included manually in the latter case.
-
-It also has support for the StateMachine gem and can generate scopes for states.
-
-
-== MagicScopes can generate these scopes:
-
-* <b>with</b> and <b>without</b> options will generate scopes such as <b>with_rating</b>, <b>without_rating</b> that will look for non null and null values, respectively. For state attributes thee redefine corresponding state_machine scopes so they can be called without parameters to check against null and non null. (You can use it in the normal way too, of course). These scopes can be used with boolean, state, integer, decimal, time, date, datetime, float and string attributes. For integer, decimal, time, date, datetime and string attributes value(s) can be passed to the scope so the check will be performed against passed values (not against null/non null vakues). (ex.: with_rating(1,2,3), without_rating([5,4,3]))
-* <b>is</b> and <b>not</b> options will generate scopes such as <b>published</b>, <b>not_published</b> ("is" is the one option that is not reflected in the name of the generated scope) that look for true and and false or null values for boolean attributes and for the specified state and for state that is not the specifieed one no null for state attributes.
-* <b>eq</b> (stands for equal), <b>ne</b> (not equal), <b>gt</b> (greater than), <b>gte</b> (greater than or equal), <b>lt</b> (lesser than), <b>lte</b> (lesser than or equal) options generate scopes with corresponding suffixes and accept list of values or array as parameteters. Options names are self explanatory. These scopes can be used with integer, decimal, time, date and datetime attributes. lt and gt options can be used with float attributes.
-* for string attributes <b>like</b> and <b>ilike</b> options can be specified which generate scopes like <b>title_like</b>, <b>title_ilike</b> which accept list or array of arguments and look for values like the specified ones, case sensitive and insensitive, respectively.
-* <b>by</b> and <b>by_desc</b> options can be used with integer, decimal, time, date, datetime, float and string attributes and generate scopes like <b>by_created_at</b> and <b>by_created_at_desc</b>, which sort by created at asc and created at desc, respectively.
-* <b>for</b> and <b>not_for</b> scopes can be used with belongs_to associations (including polymorphic ones) and generate scopes like <b>for_user</b>, <b>not_for_commentable</b>. They can accept list or array of associations. Also, hash(es) with id and type keys can be specified for polymorphic associations.
-
-
-== Usage examples
-
-* Call to magic_scopes without parameters will generate all possible scopes for all attributes, belongs_to associations and states. By specifying parameters you tell magic_scopes to generate only the scopes you need.
-    magic_scopes
-
-* With specified attributes it will generate all possible scopes for title and bogus attributes.
-    magic_scopes :title, :bogus
-
-* You can specify in (stands for include) and ex (for exclude) options, so:
-  * it will generate with and by scopes for all suitable attributes when in option is specified.
-      magic_scopes in: %w(with by)
-  * It will generate generate all possible scopes except with and by ones when ex option is specified.
-      magic_scopes ex: %w(with by)
-  * It will generate with and by scopes for all suitable attributes in specified list when both attributes list and in options are cpecified:
-      magic_scopes :title, :bogus, in: %w(with by)
-  * You can also override scopes that should be generated per attribute:
-      magic_scopes :title, :rating, bogus: :by_desc, in: %w(with by)
-    It will generate with and by scopes for title and rating attributes and by_desc scope for bogus attribute.
-
-  * All options accept strings, symbols and arrays as arguments.
-
-
-== Standard scopes
-
-In addition, some standard scopes can be specified using :std option, they are:
-asc and sorted sort by id asc, desc and recent sort by id desc and random sorts in random order.
-ex.: magic_scopes :title, :bogus, in: %w(with without), std: %w(recent rendom)
-magic_scopes generate all possible standard scopes unless std option is specified.
-
-MagicScopes is thoroughly tested and ready for production.
-It works with ActiveRecord >= 3.0 and ruby 1.9. (1.8 is not supported).
-
-This project rocks and uses MIT-LICENSE.