lupa 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83dad7fde61871e8d0333b609958b6eadaccc23c
+  data.tar.gz: 1a1eb1e14ede2f72d5f7eb029c38b2511e9182f6
+SHA512:
+  metadata.gz: e6f6127f879df5ec3bcee9e4c0c479df20aa53c17389fedf7a10d1403900da7920372a6bf2dab44ddad82843465c71834fe3343e515f506d63f331b4feec23b3
+  data.tar.gz: 84e3f845e779bdb383410f32509b99b4f7ae5fcda658dbb5e3dd49e8110b735c66b47c49ff583a2942822df800fc656fe8315c2f52bdb3b6807e476a5c7b06e0

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.ruby-version

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ezequiel Delpero
+
+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,424 @@
+![](lupa.png)
+
+Lupa means *Magnifier* in spanish.
+
+Lupa lets you create simple, robust and scaleable search filters with ease using regular Ruby classes and object oriented design patterns. It's Framework and ORM agnostic.
+
+## Search Class
+
+### Usage
+
+The example will explain how to use the class on a Rails application:
+
+- Define a custom form:
+
+```haml
+# app/views/products/_search.html.haml
+
+= form_tag products_path, method: :get do
+  = text_field_tag 'name'
+  = select_tag 'category', options_from_collection_for_select(@categories, 'id', 'name')
+  = date_field_tag 'created_between[start_date]'
+  = date_field_tag 'created_between[end_date]'
+  = submit_tag :search
+```
+- Create a new instance of your search class and pass a collection to which all search conditions will be applied and specify the search params you want to apply:
+
+```ruby
+# app/controllers/products_controller.rb
+
+class ProductsController < ApplicationController
+  def index
+    @products = ProductSearch.new(current_user.products).search(search_params)
+  end
+  
+  protected
+    def search_params
+      params.permit(:name, :category, created_between: [:start_date, :end_date])
+    end
+end
+```
+- Loop through the search results on your view.
+
+```haml
+# app/views/products/index.html.haml
+
+%h1 Products
+
+%ul
+  - @products.each do |product|
+    %li
+      = "#{product.name} - #{product.price} - #{product.category}"
+```
+
+### Definition
+To define a search class, your class must inherit from **Lupa::Search** and you must define a **Scope** class inside your search class.
+
+```ruby
+# app/searches/product_search.rb
+
+class ProductSearch < Lupa::Search
+  class Scope
+  end
+end
+```
+Inside your **Scope** class you must define your scope methods. You'll also be able to access to the following methods inside your scope class: **scope** and **search_attributes**.
+
+* **`scope:`** returns the current scope when the scope method is called.
+* **`search_attributes:`** returns a hash containing the all search attributes specified.
+
+<u>**Note:**</u> All keys of **`search_attributes`** are symbolized.
+
+```ruby
+# app/searches/product_search.rb
+
+class ProductSearch < Lupa::Search
+  # Scope class holds all your search methods.
+  class Scope
+  
+    # Search method
+    def name
+      if search_attributes[:name].present?
+        scope.where('name LIKE ?', "%#{search_attributes[:name]}%")
+      end
+    end
+    
+    # Search method
+    def created_between
+      if created_start_date && created_end_date
+        scope.where(created_at: created_start_date..created_end_date)
+      end
+    end
+    
+    # Search method
+    def category
+      scope.where(category_id: search_attributes[:category])    
+    end
+    
+    private
+      # Parses search_attributes[:created_between][:start_date]
+      def created_start_date
+        search_attributes[:created_between] && search_attributes[:created_between][:start_date].try(:to_date)
+      end
+      
+      # Parses search_attributes[:created_between][:end_date]
+      def created_end_date
+        search_attributes[:created_between] && search_attributes[:created_between][:end_date].try(:to_date)
+      end
+  end
+end
+```
+The scope methods specified on the search params will be the only ones applied to the scope. Search params keys must always match the Scope class methods names.
+
+### Public Methods
+
+Your search class has the following public methods:
+
+- **`scope:`** returns the scope to which all search rules will be applied.
+
+```ruby
+search = ProductSearch.new(current_user.products).search(name: 'chair', category: '23')
+search.scope
+
+# => current_user.products
+```
+
+- **`search_attributes:`** returns a hash with all search attributes including default search attributes.
+
+```ruby
+search = ProductSearch.new(current_user.products).search(name: 'chair', category: '23')
+search.search_attributes
+
+# => { name: 'chair', category: '23' }
+```
+- **`default_search_attributes:`** returns a hash with default search attributes. A more detailed explanation about default search attributes can be found below this section.
+
+- **`results:`** returns the resulting scope after all searching rules have been applied.
+
+```ruby
+search = ProductSearch.new(current_user.products).search(name: 'chair', category: '23')
+search.results
+
+# => #<Product::ActiveRecord_Relation:0x007ffda11b7d48>
+```
+
+- **OTHER METHODS** applied to your search class will result in calling to **`results`** and applying that method to the resulting scope. If the resulting scope doesn't respond to the method, an exception will be raised.
+
+```ruby
+search = ProductSearch.new(current_user.products).search(name: 'chair', category: '23')
+
+search.first
+# => #<Product id: 1, name: 'Eames Chair', category_id: 23, created_at: "2015-04-06 18:54:13", updated_at: "2015-04-06 18:54:13" >
+
+search.unexisting_method
+# => Lupa::ResultMethodNotImplementedError: The resulting scope does not respond to unexisting_method method.
+```
+
+## Default Search Scope
+
+You can define a default search scope if you want to use a search class with an specific resource by overriding the initialize method as follows:
+
+```ruby
+# app/searches/product_search.rb
+
+class ProductSearch < Lupa::Search
+  class Scope
+    ...
+  end
+  
+  # Be careful not to change the scope variable name,
+  # otherwise you will experiment some issues.
+  def initialize(scope = Product.all)
+    @scope = scope
+  end
+end
+```
+
+Then you can use your search class without passing the scope:
+
+```ruby
+search = ProductSearch.search(name: 'chair', category: '23')
+
+search.first
+# => #<Product id: 1, name: 'Eames Chair', category_id: 23, created_at: "2015-04-06 18:54:13", updated_at: "2015-04-06 18:54:13" >
+```
+
+## Default Search Attributes
+
+Defining default search attributes will cause the scope method to be invoked always.
+
+```ruby
+# app/searches/product_search.rb
+
+class ProductSearch < Lupa::Search
+  class Scope
+    ...
+  end
+  
+  # This should always return a hash
+  def default_search_attributes
+    { category: 23 }
+  end
+end
+```
+**<u>Note:</u>** You can override default search attributes by passing it to the search params.
+
+``` ruby
+search = ProductSearch.new(current_user.products).search(name: 'chair', category: '42')
+
+search.search_attributes
+# => { name: 'chair', category: 42 }
+```
+
+## Combining Search Classes
+
+You can reuse your search class in order to keep them DRY.
+
+A common example is searching records created between two dates. So lets create a **CreatedAtSearch** class to handle that logic.
+
+```ruby
+# app/searches/created_between_search.rb
+
+class CreatedAtSearch < Lupa::Search
+  class Scope
+  
+    def created_before
+      ...
+    end
+    
+    def created_after
+      ...
+    end
+ 
+    def created_between
+      if created_start_date && created_end_date
+        scope.where(created_at: created_start_date..created_end_date)
+      end
+    end
+  
+    private
+
+      def created_start_date
+        search_attributes[:created_between] && search_attributes[:created_between][:start_date].try(:to_date)
+      end
+      
+      def created_end_date
+        search_attributes[:created_between] && search_attributes[:created_between][:end_date].try(:to_date)
+      end
+  end
+end
+```
+
+Now we can use it in our **ProductSearch** class:
+
+```ruby
+# app/searches/product_search.rb
+
+class ProductSearch < Lupa::Search
+  class Scope
+  
+    def name
+      ...
+    end
+    
+    # We use CreatedAtSearch class to perform the search
+    def created_between
+      if search_attributes[:created_between]
+        CreadtedAtSearch.new(scope).search(created_between: search_attributes[:created_between])
+      end
+    end
+    
+    def category
+      ...
+    end
+    
+  end
+end
+```
+
+## Testing
+
+This is a list of things you should test when creating a search class:
+
+- **Default Scope** if specified.
+- **Default Search Attributes** if specified.
+- **Each Scope Method** individually.
+
+### Testing Default Scope
+
+```ruby
+# app/searches/product_search.rb
+
+class ProductSearch < Lupa::Search
+  class Scope
+    ...
+  end
+
+  def initialize(scope = Product.all)
+    @scope = scope
+  end
+end
+```
+
+```ruby
+# test/searches/product_search_test.rb
+require 'test_helper'
+
+describe ProductSearch do
+  describe 'Default Scope' do
+    context 'when not passing a scope to search initializer and no search params' do
+      it 'returns default scope' do
+        results = ProductSearch.search({}).results
+        results.must_equal Product.all
+      end
+    end
+  end
+end
+```
+
+### Testing Default Search Attributes
+
+```ruby
+# app/searches/product_search.rb
+
+class ProductSearch < Lupa::Search
+  class Scope
+    ...
+  end
+
+  def initialize(scope = Product.all)
+    @scope = scope
+  end
+
+  def default_search_attributes
+    { category: '23' }
+  end
+end
+```
+
+```ruby
+# test/searches/product_search_test.rb
+require 'test_helper'
+
+describe ProductSearch do
+  describe 'Default Search Attributes' do
+    context 'when not overriding default_search_attributes' do
+      it 'returns default default_search_attributes' do
+        default_search_attributes = { category: 23 }
+        search = ProductSearch.search({})
+        search.default_search_attributes.must_equal default_search_attributes
+      end
+    end
+  end
+end
+```
+
+### Testing Each Scope Method Individually
+
+```ruby
+# app/searches/product_search.rb
+
+class ProductSearch < Lupa::Search
+  class Scope
+    def category
+      scope.where(category_id: search_attributes[:category])
+    end
+
+    def name
+      ...
+    end
+  end
+
+  def initialize(scope = Product.all)
+    @scope = scope
+  end
+end
+```
+
+```ruby
+# test/searches/product_search_test.rb
+
+require 'test_helper'
+
+describe ProductSearch do
+  describe 'Scopes' do
+
+    describe '#category' do
+      it 'returns products from specified category' do
+        results = ProductSearch.search(category: '23').results
+        results.must_equal Product.where(category_id: '23')
+      end
+    end
+
+    describe '#name' do
+      it 'returns products that contain specified letters' do
+        ...
+      end
+    end
+
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lupa'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lupa
+
+
+## Contributing
+
+1. Fork it ( https://github.com/edelpero/lupa/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request