queryable 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f519477ea7a61d9e99c9cff819433102ac236bcd
-  data.tar.gz: 47402fda61136b8ceaae98d9c214b12ffb586df1
+  metadata.gz: d01fa7b43b3b44643d009f15e6438ef3fd4a665f
+  data.tar.gz: 75164b6c8f28fb3db7e6b182a3f18bf50aa386f8
 SHA512:
-  metadata.gz: 632bbebc1ce1e6765892f2ac67d56fd91b0a71f57bc00dc057f502075095ec090298b00f7a7f174360dfda8cea8978c16595208f705f6a8955f0052fe662c63b
-  data.tar.gz: 2b7d37a7463b29fbd5c81fb27bf948f914fff896cc286320eae3ba12686609a268c83d26dcd9dd5993a304ecaee5448d6913f8bf78665d2dd409c4024655cd18
+  metadata.gz: 994927851ef85e8a225f3cb8c21cac6eb21d9d97ac336ca7992d0b4594d8aafab58130e3d60e590b044f331fd7214b99b14fa00b5d56995b3bf0594d001c1b67
+  data.tar.gz: 4f0c6d2d977f9d5ba763c414f2fe434da06c089a8ca628e6358fba8899396fbd3c6a3fd0bfb80a597e44117a163b0e9870a417f6eb1ec5aef22080f76e8a77ea

data/README.md

@@ -1,10 +1,100 @@
 Queryable
 =====================
+[![Gem Version](https://badge.fury.io/rb/queryable.svg)](http://badge.fury.io/rb/queryable)
+[![Build Status](https://travis-ci.org/ElMassimo/queryable.svg)](https://travis-ci.org/ElMassimo/queryable)
 [![Coverage Status](https://coveralls.io/repos/ElMassimo/queryable/badge.png)](https://coveralls.io/r/ElMassimo/queryable)
+<!-- [![Code Climate](https://codeclimate.com/github/ElMassimo/queryable.png)](https://codeclimate.com/github/ElMassimo/queryable) -->
 
-
-Allows you to easily define query objects with chainable scopes.
+Queryable is a mixin that allows you to easily define query objects with chainable scopes.
 
 ## Usage
+```ruby
+class CustomerQuery
+  include Queryable
+
+  scope(:recent) { desc(:logged_in_at) }
+
+  scope :active, ->{ where(status: 'active') }
+
+  scope :favourite_brand do |product, brand|
+    where("favourites.#{product}": brand)
+  end
+
+  def current
+    recent.active
+  end
+
+  def miller_fans
+    favourite_brand(:beer, :Miller)
+  end
+
+  def search_in_current(field_values)
+    define_query do |customers|
+      field_values.inject(customers) { |customers, (field, value)|
+        customers.where(field => /#{value}/i)
+      }
+    end.current
+  end
+end
+
+
+CustomerQuery.new(shop.customers).miller_fans.search_in_current(last_name: 'M')
+```
+
+### Scopes
+
+Scopes serve to encapsulate reusable business rules, a method is defined with
+the selected name and block (or proc)
+
+### Define Query
+
+While scopes are great because of their terseness, they can be limiting because
+the block executes in the context of the internal query, so methods, constants,
+and variables of the Queryable are not accessible.
+
+For those cases, you can use `define_query`, which is a convenience setter for
+the internal query, that also takes care of returning `self` at the end of the
+call to make the methods chainable.
+
+## Advantages
+
+* Query objects are easy to understand.
+* You can inherit, mixin, and chain queries in a very natural way.
+* Increased testability, pretty close to being ORM/ODM agnostic.
+
+## Testing
+
+You can check the [specs](https://github.com/ElMassimo/queryable/tree/master/spec) of the project
+to check how to test query objects without even having to require the ORM/ODM, or
+you can test by requiring your ORM/ODM and executing queries as usual.
+
+## RDocs
+
+You can view the **Queryable** documentation in RDoc format here:
+
+http://rubydoc.info/github/ElMassimo/queryable/master/frames
+
+
+License
+--------
+
+    Copyright (c) 2014 Máximo Mussini
+
+    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.
 
-## Background
+    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/lib/queryable.rb

@@ -1,6 +1,3 @@
-require 'active_support/concern'
-require 'active_support/core_ext/module/delegation'
-
 # Public: Mixin that adds Queryable functionality to a plain ruby object.
 # A Queryable manages an internal query object, and defines chainable methods
 # that interact with the query object, modifying its value.
@@ -14,13 +11,18 @@ require 'active_support/core_ext/module/delegation'
 #   end
 #
 module Queryable
-  extend ActiveSupport::Concern
 
-  included do
-    # Public: Gets/Sets the internal query.
-    attr_accessor :query
+  # Internal: Adds class methods, a query accessor, and method delegation.
+  def self.included(base)
+    base.extend ClassMethods
+    base.extend Forwardable
+    base.class_eval do
+
+      # Public: Gets/Sets the internal query.
+      attr_accessor :query
 
-    delegate *delegated_methods, to: :query
+      def_delegators :query, *delegated_methods
+    end
   end
 
   # Public: Initialize a Queryable with a query.
@@ -54,9 +56,9 @@ module Queryable
   #
   #   # Extracted from a scope for clarity.
   #   def search(field_values)
-  #     define_query do |user|
-  #       field_values.inject(user) { |user, (field, value)|
-  #         user.where(field => /#{value}/i)
+  #     define_query do |users|
+  #       field_values.inject(users) { |users, (field, value)|
+  #         users.where(field => /#{value}/i)
   #       }
   #     end
   #   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: queryable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Máximo Mussini
@@ -9,21 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-04-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+dependencies: []
 description: Queryable is a module that encapsulates query building so you don't have
   to tuck scopes inside your models.
 email: