activerecord-where-any-of 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21cdcf0e5b019222b778393fe10e65d57796a3b3
-  data.tar.gz: ca0c4ae26fb2aa08e56ed62b76632d1d43234d50
+  metadata.gz: d0e626da34af089d9f92dcf9ee6d5b97395ffdb4
+  data.tar.gz: 891e420029939a94032a74d6f937caddf6177dc2
 SHA512:
-  metadata.gz: fe382b7a5b770bda3ca9f6094c9880bbf7f3f45f84289a02cc30e848f488fee4295902600c5ebc07d7cf4c9441a4558284ad01098fc0b8079207b5491547da18
-  data.tar.gz: a5970759d887334f936c72003fa6d9b284a1d992cbfaa3f9a086605c1b8ed920897b090b2d96869acee6da4aece663347083a2832b073763170c6807cea2f027
+  metadata.gz: 75c4e9ad19c7ab0132add54522a76d2815143ef36059b340f5f181c8d0a0d55989bfbc38aba429bcfb5ab95cbee685739538bd95f56c3528cc4aa096e55cea06
+  data.tar.gz: 784d559cd7de12e7a60599eed0ecaeb5c3cf95c2b448bb19537ef07260cdfad17f5db4e7bdd9aecaab2e523f6bc685626e54973f369396d5de177aaff7ca8396

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+.bundle
+.config
+.dat*
+.repl_history
+.rvmrc
+.yardoc
+/.bundle/
+/.config
+/.yardoc/
+/InstalledFiles
+/_yardoc/
+/coverage/
+/doc/
+/lib/bundler/man/
+/pkg/
+/rdoc/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+InstalledFiles
+_yardoc
+build/
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2014-2015 David McCullars<david.mccullars@gmail.com>
+
+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,72 @@
+activerecord-where-any-of
+=========================
+
+Description:
+-----------
+
+Provides a mechanism for OR'ing together one or more AREL relations.  Normally when
+one performs `SomeModel.where(condition_1).where(condition_2)`, the result is to AND
+those conditions together.  Unfortunately, there is no good way of OR'ing them without
+converting the conditions into manual SQL.  This mixin addresses that issue.
+
+Usage:
+------
+
+`where_any_of` accepts any number of relations, symbols, or strings.  For symbols and strings,
+the corresponding method is called (unscoped) which is expected to return a relation.
+
+```rb
+class SomeRecord < ActiveRecord::Base
+
+  default_scope do
+    where('extra is not null')
+  end
+
+  def self.owned_by(user)
+    where(:owner => user)
+  end
+
+  def self.active
+    where(:active => true)
+  end
+
+  def self.pending
+    where(:pending => true)
+  end
+
+  def self.active_or_pending
+    # Use symbols to make sure calls are unscoped
+    where_any_of(:active, :pending)
+  end
+
+end
+```
+
+```rb
+puts SomeRecord.owned_by('Fred').active_or_pending.to_sql
+```
+
+> SELECT "some_records".* FROM "some_records"
+> WHERE "some_records"."owner" = 'Fred' AND (extra is not null) AND (("some_records"."active" = 't' OR "some_records"."pending" = 't'))
+
+```rb
+puts SomeRecord.where_any_of(
+  SomeRecord.where(:extra => 'A'),
+  SomeRecord.owned_by('Bill'),
+  'active'
+).to_sql
+```
+
+> SELECT "some_records".* FROM "some_records"
+> WHERE (extra is not null) AND ((("some_records"."extra" = 'A' OR "some_records"."owner" = 'Bill') OR "some_records"."active" = 't'))
+
+Install:
+--------
+
+In your app, add this line to your `Gemfile`:
+
+```rb
+gem "activerecord-where-any-of"
+```
+
+Then type `bundle`.

data/Rakefile

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

data/activerecord-where-any-of.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name = 'activerecord-where-any-of'
+  s.version = '1.0.5'
+  s.license = 'MIT'
+  s.date = '2014-07-24'
+  s.summary = 'A simple mixin to ActiveRecord::Base that allows use of OR arel relations.'
+  s.description = '...'
+  s.description = File.read(File.expand_path('../README.md', __FILE__))[/Description:\n-+\s*(.*?)\n\n/m, 1]
+  s.authors = ['David McCullars']
+  s.email = ['david.mccullars@gmail.com']
+
+  s.require_paths = ['lib']
+  s.files         = `git ls-files -z`.split("\x0")
+
+  s.add_runtime_dependency 'activerecord', '>= 3.0'
+  s.add_development_dependency 'bundler', '>= 1.3'
+  s.add_development_dependency 'rake'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-where-any-of
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - David McCullars
@@ -63,10 +63,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-where-any-of.gemspec
 - lib/active_record/where-any-of-mixin.rb
 - lib/activerecord-where-any-of.rb
 homepage: 
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -87,5 +94,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A simple mixin to ActiveRecord::Base that allows OR'ing arel relations.
+summary: A simple mixin to ActiveRecord::Base that allows use of OR arel relations.
 test_files: []