usefull_scopes 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in usefull_scopes.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mokevnin Kirill
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# UsefullScopes
+
+This gem provides additional scopes for your ActiveRecord models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'usefull_scopes'
+
+Or install it yourself as:
+
+    $ gem install usefull_scopes
+
+## Usage
+
+In order to use these scopes, we need to include `UsefullScopes` module in our model.
+
+    class User < ActiveRecord::Base
+      include UsefullScopes
+    end
+
+### Global scopes
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>random</td>
+    <td>Fetches a random record</td>
+  </tr>
+  <tr>
+    <td>exclude</td>
+    <td>Selects only those records who are not in a given array (you could also provide a single object as an argument)</td>
+  </tr>
+  <tr>
+    <td>with</td>
+    <td>Returns records, where attributes' values are corresponding to a given hash.</td>
+  </tr>
+  <tr>
+    <td>without</td>
+    <td>Returns records, where attributes' values are `NULL` or aren't equal to values from a given hash.</td>
+  </tr>
+</table>
+
+### Scopes per attribute
+
+These are the scopes created for each model's attribute.
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>by_attribute</td>
+    <td>Returns records ordered by `attribute` in descending order</td>
+  </tr>
+  <tr>
+    <td>asc_by_attribute</td>
+    <td>Returns records ordered by `attribute` in ascending order</td>
+  </tr>
+  <tr>
+    <td>like_by_attribute</td>
+    <td>Returns records, where attribute's value like a given term </td>
+  </tr>
+  <tr>
+    <td>ilike_by_attribute</td>
+    <td>Сase insensitive implementation of `like_by_attribute`</td>
+  </tr>
+  <tr>
+    <td>with_attribute</td>
+    <td>Returns records, where attribute's value is equal to a given value.<br/><b>Note: this scope is deprecated and will be removed in the following versions. Please, use `with` scope instead.</b></td>
+  </tr>
+  <tr>
+    <td>without_attribute</td>
+    <td>Returns records, where attribute's value is `NULL`.<br/><b>Note: this scope is deprecated and will be removed in the following versions. Please, use `without` scope instead.</b></td>
+  </tr>
+</table>
+
+### Example
+
+Now, it is time to play with our model!
+
+    User.create([{name: 'Mike'}, {name: 'Paul'}])
+
+    user = User.random
+    user.name
+      => 'Mike'
+
+    User.asc_by_name.map(&:name)
+      => ['Mike', 'Paul']
+
+    User.by_name.map(&:name)
+      => ['Paul', 'Mike']
+
+    users = User.with_name('Mike')
+    users.map(&:name)
+      => ['Mike']
+
+    users = User.with(name: 'Mike')
+      => SELECT "users".* FROM "users" WHERE ("users"."name" = 'Mike')
+    users.map(&:name)
+      => ['Mike']
+
+    users = User.without(name: ['Mike', 'Paul'])
+      => SELECT "users".* FROM "users" WHERE ("users"."name" NOT IN ('Mike','Paul'))
+    users
+      => []
+
+    users = User.without(:name, :id)
+      => SELECT "users".* FROM "users" WHERE ("users"."name" IS NULL AND "users"."id" IS NULL)
+    users.count
+      => 2
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/usefull_scopes.rb

@@ -0,0 +1,65 @@
+module UsefullScopes
+  autoload :Version, 'usefull_scopes/version'
+  extend ActiveSupport::Concern
+
+  included do
+    scope :random, order("RANDOM()")
+    scope :exclude, lambda {|collection_or_object|
+      collection = Array(collection_or_object)
+      values = collection.map do |id_or_object|
+        id_or_object.is_a?(ActiveRecord::Base) ? id_or_object.id : id_or_object
+      end
+      return scoped unless values.any?
+      where("#{quoted_table_name}.id not in (?)", values)
+    }
+
+    scope :with, lambda {|attrs_hash|
+      case attrs_hash
+      when Hash
+        where(attrs_hash)
+      else
+        raise TypeError, "Hash is expected"
+      end
+    }
+
+    scope :without, lambda {|*attrs|
+      attrs_hash = attrs.extract_options!
+      query_params = []
+
+      attrs.each do |attr_name|
+        query_params << "#{quoted_table_name}.#{attr_name} IS NULL"
+      end
+
+      attrs_hash.each do |attr_name, attr_value|
+        query_params << "#{quoted_table_name}.#{attr_name} NOT IN (:#{attr_name})"
+      end
+
+      return scoped if query_params.blank?
+      where query_params.join(" AND "), attrs_hash
+    }
+
+    attribute_names.each do |a|
+      scope "by_#{a}", order("#{quoted_table_name}.#{a} DESC")
+      scope "asc_by_#{a}", order("#{quoted_table_name}.#{a} ASC")
+
+      scope "like_by_#{a}", lambda {|term|
+        quoted_term = connection.quote(term + '%')
+        where("lower(#{quoted_table_name}.#{a}) like #{quoted_term}")
+      }
+      scope "ilike_by_#{a}", lambda {|term|
+        quoted_term = connection.quote(term + '%')
+        where("#{quoted_table_name}.#{a} ilike #{quoted_term}")
+      }
+
+      scope "with_#{a}", lambda { |value|
+        puts "*** DEPRECATION WARNING: Scope `with_#{a}` is deprecated and will be removed in the following versions. Please, use `with` scope instead."
+        where("#{quoted_table_name}.#{a} = ?", value)
+      }
+      scope "without_#{a}", lambda {
+        puts "*** DEPRECATION WARNING: Scope `without_#{a}` is deprecated and will be removed in the following versions. Please, use `without` scope instead."
+        where("#{quoted_table_name}.#{a} IS NULL")
+      }
+    end
+  end
+end
+

data/lib/usefull_scopes/version.rb

@@ -0,0 +1,3 @@
+module UsefullScopes
+  VERSION = "0.0.1"
+end

data/usefull_scopes.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "usefull_scopes/version"
+
+Gem::Specification.new do |s|
+  s.name        = "usefull_scopes"
+  s.version     = UsefullScopes::VERSION
+  s.authors     = ["Kaize Team"]
+  s.email       = ["info@kaize.ru"]
+  s.homepage    = "http://github.com/kaize/usefull_scopes"
+  s.summary     = "Additional scopes for Active:Record models."
+  s.description = "This gem provides additional scopes for your Active:Record models within Ruby on Rails framework."
+
+  s.rubyforge_project = "usefull_scopes"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: usefull_scopes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kaize Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-21 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides additional scopes for your Active:Record models within
+  Ruby on Rails framework.
+email:
+- info@kaize.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/usefull_scopes.rb
+- lib/usefull_scopes/version.rb
+- usefull_scopes.gemspec
+homepage: http://github.com/kaize/usefull_scopes
+licenses: []
+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: usefull_scopes
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Additional scopes for Active:Record models.
+test_files: []
+has_rdoc: