lupa 1.0.0 → 1.0.2

data/lib/lupa/version.rb

@@ -1,3 +1,3 @@
 module Lupa
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

data/lib/lupa.rb

@@ -1,10 +1,135 @@
 require "lupa/version"
 
+# Lupa is a Ruby gem that lets you create simple, robust and scaleable search
+# filters with ease using regular Ruby classes and object oriented design patterns.
+#
+# Lupa is Framework and ORM agnostic. It will work with any ORM or Object that
+# can build a query using chained method calls, like ActiveRecord.
+#
+# @example Basic usage with ActiveRecord
+#   class ProductSearch < Lupa::Search
+#     class Scope
+#       def name
+#         scope.where('name LIKE ?', "%#{search_attributes[:name]}%")
+#       end
+#
+#       def category
+#         scope.where(category_id: search_attributes[:category])
+#       end
+#     end
+#   end
+#
+#   # Using the search class
+#   products = ProductSearch.new(Product.all).search(name: 'chair', category: '23')
+#   products.each do |product|
+#     puts product.name
+#   end
+#
+# @example With default scope
+#   class ProductSearch < Lupa::Search
+#     class Scope
+#       def name
+#         scope.where('name LIKE ?', "%#{search_attributes[:name]}%")
+#       end
+#     end
+#
+#     def initialize(scope = Product.all)
+#       @scope = scope
+#     end
+#   end
+#
+#   # Can now use the class method
+#   products = ProductSearch.search(name: 'chair')
+#
+# @author Emanuel Del Pero
+# @since 0.1.0
 module Lupa
-  DefaultScopeError               = Class.new(StandardError)
-  ScopeMethodNotImplementedError  = Class.new(NotImplementedError)
+  # Raised when attempting to use the class method `search` without defining
+  # a default scope in the initializer.
+  #
+  # @example
+  #   class ProductSearch < Lupa::Search
+  #     class Scope
+  #       def name
+  #         scope.where(name: search_attributes[:name])
+  #       end
+  #     end
+  #   end
+  #
+  #   # This will raise DefaultScopeError because no default scope is defined
+  #   ProductSearch.search(name: 'chair')
+  #   # => Lupa::DefaultScopeError: You need to define a default scope in order to user search class method.
+  DefaultScopeError = Class.new(StandardError)
+
+  # Raised when the `default_search_attributes` method doesn't return a Hash.
+  #
+  # @example
+  #   class ProductSearch < Lupa::Search
+  #     class Scope
+  #       def category
+  #         scope.where(category_id: search_attributes[:category])
+  #       end
+  #     end
+  #
+  #     def default_search_attributes
+  #       "not a hash"  # This will raise DefaultSearchAttributesError
+  #     end
+  #   end
+  #
+  #   ProductSearch.search(name: 'chair')
+  #   # => Lupa::DefaultSearchAttributesError: default_search_attributes doesn't return a Hash.
+  DefaultSearchAttributesError = Class.new(StandardError)
+
+  # Raised when a search attribute is passed that doesn't have a corresponding
+  # method defined in the Scope class.
+  #
+  # @example
+  #   class ProductSearch < Lupa::Search
+  #     class Scope
+  #       def name
+  #         scope.where(name: search_attributes[:name])
+  #       end
+  #     end
+  #   end
+  #
+  #   # This will raise ScopeMethodNotImplementedError because 'color' method is not defined
+  #   ProductSearch.new(Product.all).search(name: 'chair', color: 'red')
+  #   # => Lupa::ScopeMethodNotImplementedError: color is not defined on your ProductSearch::Scope class.
+  ScopeMethodNotImplementedError = Class.new(NotImplementedError)
+
+  # Raised when attempting to call a method on the search results that the
+  # resulting scope doesn't respond to.
+  #
+  # @example
+  #   class ProductSearch < Lupa::Search
+  #     class Scope
+  #       def name
+  #         scope.where(name: search_attributes[:name])
+  #       end
+  #     end
+  #   end
+  #
+  #   search = ProductSearch.new(Product.all).search(name: 'chair')
+  #   search.non_existent_method
+  #   # => Lupa::ResultMethodNotImplementedError: The resulting scope does not respond to non_existent_method method.
   ResultMethodNotImplementedError = Class.new(NotImplementedError)
-  SearchAttributesError           = Class.new(StandardError)
+
+  # Raised when search attributes passed are not a Hash or Hash-like object
+  # that responds to the `keys` method.
+  #
+  # @example
+  #   class ProductSearch < Lupa::Search
+  #     class Scope
+  #       def name
+  #         scope.where(name: search_attributes[:name])
+  #       end
+  #     end
+  #   end
+  #
+  #   # This will raise SearchAttributesError because "not a hash" doesn't respond to :keys
+  #   ProductSearch.new(Product.all).search("not a hash")
+  #   # => Lupa::SearchAttributesError: Your search params needs to be a hash.
+  SearchAttributesError = Class.new(StandardError)
 end
 
 require "lupa/scope_methods"

data/lupa.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "minitest", "~> 5.5.1"
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.5"
+  spec.add_development_dependency "bundler", ">= 1.6"
+  spec.add_development_dependency "rake", ">= 10.0"
 end

data/test/default_search_attributes_search_test.rb

@@ -32,6 +32,22 @@ class ClassWithoutDefaultSearchAttributesSearch < Lupa::Search
 
 end
 
+class ClassWithInvalidDefaultSearchAttributesSearch < Lupa::Search
+
+  class Scope
+    def reverse; end
+  end
+
+  def initialize(scope = [1, 2, 3, 4])
+    @scope = scope
+  end
+
+  def default_search_attributes
+    1
+  end
+
+end
+
 
 describe Lupa::Search do
   before do
@@ -61,6 +77,12 @@ describe Lupa::Search do
         search.default_search_attributes.must_equal params
       end
     end
+
+    context 'when default_search_attributes does not return a Hash' do
+      it 'raises a Lupa::DefaultSearchAttributesError exception' do
+        proc { ClassWithInvalidDefaultSearchAttributesSearch.search({}).results }.must_raise Lupa::DefaultSearchAttributesError
+      end
+    end
   end
 
   describe '#results' do

data/test/test_helper.rb

@@ -1,3 +1,10 @@
+# Coveralls gem uses Hash#slice which was added in Ruby 2.5
+# Only load Coveralls for Ruby 2.5+
+if RUBY_VERSION >= '2.5.0'
+  require 'coveralls'
+  Coveralls.wear!
+end
+
 require 'minitest/autorun'
 
 def context(*args, &block)

metadata

@@ -1,57 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: lupa
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Ezequiel Delpero
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.5.1
+        version: '5.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.5.1
+        version: '5.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 description: Lupa lets you create simple, robust and scaleable search filters with
   ease using regular Ruby classes and object oriented design patterns.
 email:
@@ -60,7 +59,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -80,24 +82,21 @@ homepage: https://github.com/edelpero/lupa
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Search Filters using Object Oriented Design.
 test_files: