lupa 1.0.0

data/test/array_search_test.rb

@@ -0,0 +1,131 @@
+require 'test_helper'
+
+class ArraySearch < Lupa::Search
+  class Scope
+    def even_numbers
+      if search_attributes[:even_numbers]
+        scope.collect { |number| number if number.even? }.compact
+      else
+        scope
+      end
+    end
+
+    def reverse
+      if search_attributes[:reverse]
+        scope.reverse
+      else
+        scope
+      end
+    end
+  end
+end
+
+describe Lupa::Search do
+  before do
+    @array = [1, 2, 3, 4, 5, 6, 7, 8]
+    @search_attributes = { even_numbers: true }
+  end
+
+  describe '#search_attributes' do
+    context 'when passing search params' do
+      it 'returns search attributes' do
+        search = ArraySearch.new(@array).search(@search_attributes)
+        search.search_attributes.must_equal @search_attributes
+      end
+    end
+
+    context 'when not passing search params' do
+      it 'returns nil' do
+        search = ArraySearch.new(@array)
+        search.search_attributes.must_equal nil
+      end
+    end
+
+    context 'when passing an empty hash to search params' do
+      it 'returns an empty hash' do
+        params = {}
+        search = ArraySearch.new(@array).search(params)
+        search.search_attributes.must_equal params
+      end
+    end
+
+    context 'when passing search params with empty values' do
+      it 'removes empty values from the search params' do
+        params = { even_numbers: true, reverse: { one: '', two: '' }, blank: { an_array: [''] }}
+        search = ArraySearch.new(@array).search(params)
+        search.search_attributes.must_equal @search_attributes
+      end
+    end
+
+    context 'when search params contains keys as strings' do
+      it 'converts the strings into symbols' do
+        params = { 'even_numbers' => true, reverse: { one: '', two: '' }, blank: { an_array: [''] }}
+        search = ArraySearch.new(@array).search(params)
+        search.search_attributes.must_equal @search_attributes
+      end
+    end
+
+    context 'when passing another object rather than a hash to search params' do
+      it 'raises a Lupa::SearchAttributesError' do
+        proc { ArraySearch.new(@array).search(1) }.must_raise Lupa::SearchAttributesError
+      end
+    end
+  end
+
+  describe '#search' do
+    context 'when passing valid params' do
+      it 'sets search attributes' do
+        search = ArraySearch.new(@array).search(@search_attributes)
+        search.search_attributes.must_equal @search_attributes
+      end
+    end
+
+    context 'when passing invalid params' do
+      it 'raises a Lupa::ScopeMethodNotImplementedError' do
+        params = { even_numbers: true, not_existing_search: 2 }
+        proc { ArraySearch.new(@array).search(params) }.must_raise Lupa::ScopeMethodNotImplementedError
+      end
+    end
+  end
+
+  describe '#results' do
+    context 'when passing search attributes' do
+      it 'returns the search results' do
+        search = ArraySearch.new(@array).search(@search_attributes)
+        search.results.must_equal [2, 4, 6, 8]
+      end
+    end
+
+    context 'when not passing search attributes' do
+      it 'returns the default scope' do
+        search = ArraySearch.new(@array)
+        proc { search.results }.must_raise Lupa::SearchAttributesError
+      end
+    end
+
+    context 'when passing multiple search attributes' do
+      it 'returns the search results' do
+        params = { even_numbers: true, reverse: true }
+        search = ArraySearch.new(@array).search(params)
+        search.results.must_equal [8, 6, 4, 2]
+      end
+    end
+  end
+
+  describe '#method_missing' do
+    context 'when result respond to method' do
+      it 'applies method to the resulting scope' do
+        search = ArraySearch.new(@array).search(@search_attributes)
+        search.first.must_equal 2
+      end
+    end
+
+    context 'when result not respond to method' do
+      it 'raises a Lupa::ResultMethodNotImplementedError exception' do
+        search = ArraySearch.new(@array).search(@search_attributes)
+        proc { search.not_existing_method }.must_raise Lupa::ResultMethodNotImplementedError
+      end
+    end
+  end
+
+end

data/test/composition_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class ReverseSearch < Lupa::Search
+
+  class Scope
+    def reverse
+      scope.reverse
+    end
+  end
+
+end
+
+class EvenSearch < Lupa::Search
+
+  class Scope
+    def even
+      scope.map { |number| number if number.even? }.compact
+    end
+
+    def reverse
+      ReverseSearch.new(scope).search(reverse: true)
+    end
+  end
+
+  def initialize(scope = [1, 2, 3, 4])
+    @scope = scope
+  end
+
+end
+
+
+describe Lupa::Search do
+
+  describe 'Composition' do
+    it 'calls another search class inside of it' do
+      results = EvenSearch.search(even: true, reverse: true).results
+      results.first.must_equal 4
+    end
+  end
+
+end

data/test/default_scope_search_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class ClassWithDefaultScopeSearch < Lupa::Search
+
+  class Scope
+    def reverse
+      if search_attributes[:reverse]
+        scope.reverse
+      end
+    end
+  end
+
+  def initialize(scope = [1, 2, 3, 4])
+    @scope = scope
+  end
+
+end
+
+class ClassWithoutDefaultScopeSearch < Lupa::Search
+
+  class Scope
+    def reverse; end
+  end
+
+end
+
+
+describe Lupa::Search do
+  before do
+    @array = [1, 2, 3, 4]
+    @search_attributes = { reverse: true }
+  end
+
+  describe '.search' do
+    context 'when class has a default scope' do
+      context 'when passing search params' do
+        it 'creates an instance of it class' do
+          results = ClassWithDefaultScopeSearch.search(@search_attributes).results
+          results.must_equal [4, 3, 2, 1]
+        end
+      end
+
+      context 'when not passing search params' do
+        it 'returns the default scope' do
+          results = ClassWithDefaultScopeSearch.search({}).results
+          results.must_equal [1, 2, 3, 4]
+        end
+      end
+    end
+
+    context 'when class does not have a default scope' do
+      it 'raises a Lupa::DefaultScopeError exception' do
+        proc { ClassWithoutDefaultScopeSearch.search(@search_attributes) }.must_raise Lupa::DefaultScopeError
+      end
+    end
+  end
+end

data/test/default_search_attributes_search_test.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+
+class ClassWithDefaultSearchAttributesSearch < Lupa::Search
+
+  class Scope
+    def reverse
+      if search_attributes[:reverse]
+        scope.reverse
+      end
+    end
+  end
+
+  def initialize(scope = [1, 2, 3, 4])
+    @scope = scope
+  end
+
+  def default_search_attributes
+    { reverse: true }
+  end
+
+end
+
+class ClassWithoutDefaultSearchAttributesSearch < Lupa::Search
+
+  class Scope
+    def reverse; end
+  end
+
+  def initialize(scope = [1, 2, 3, 4])
+    @scope = scope
+  end
+
+end
+
+
+describe Lupa::Search do
+  before do
+    @default_search_attributes = { reverse: true }
+  end
+
+  describe '#default_search_attributes' do
+    context 'when class has a default search attributes' do
+      it 'returns a hash containing default search attributes' do
+        search = ClassWithDefaultSearchAttributesSearch.search({})
+        search.default_search_attributes.must_equal @default_search_attributes
+      end
+    end
+
+    context 'when overriding default search attributes' do
+      it 'returns a hash with the default search attribute overwritten' do
+        params = { reverse: false }
+        search = ClassWithDefaultSearchAttributesSearch.search(params)
+        search.search_attributes.must_equal params
+      end
+    end
+
+    context 'when class does not have default search attributes' do
+      it 'returns an empty hash' do
+        params = {}
+        search = ClassWithoutDefaultSearchAttributesSearch.search({})
+        search.default_search_attributes.must_equal params
+      end
+    end
+  end
+
+  describe '#results' do
+    context 'when class has a default search attributes' do
+      it 'applies default search methods to scope' do
+        results = ClassWithDefaultSearchAttributesSearch.search({}).results
+        results.must_equal [4, 3, 2, 1]
+      end
+    end
+
+    context 'when class does not have default search attributes' do
+      it 'does not applies default search methods to scope' do
+        results = ClassWithoutDefaultSearchAttributesSearch.search({}).results
+        results.must_equal [1, 2, 3, 4]
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+
+def context(*args, &block)
+  describe(*args, &block)
+end
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'lupa'
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: lupa
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ezequiel Delpero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lupa lets you create simple, robust and scaleable search filters with
+  ease using regular Ruby classes and object oriented design patterns.
+email:
+- edelpero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lupa.rb
+- lib/lupa/scope_methods.rb
+- lib/lupa/search.rb
+- lib/lupa/version.rb
+- lupa.gemspec
+- lupa.png
+- test/array_search_test.rb
+- test/composition_test.rb
+- test/default_scope_search_test.rb
+- test/default_search_attributes_search_test.rb
+- test/test_helper.rb
+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: 
+specification_version: 4
+summary: Search Filters using Object Oriented Design.
+test_files:
+- test/array_search_test.rb
+- test/composition_test.rb
+- test/default_scope_search_test.rb
+- test/default_search_attributes_search_test.rb
+- test/test_helper.rb