trailblazer-finder 0.1.0

data/spec/trailblazer/finder/adapters/active_record/base_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper_active_record'
+
+module Trailblazer
+  class Finder
+    module Adapters
+      describe ActiveRecord do
+        # it_behaves_like 'a base orm adapter'
+
+        after do
+          Product.delete_all
+        end
+
+        def define_finder_class(&block)
+          Class.new(Trailblazer::Finder) do
+            class_eval(&block)
+          end
+        end
+
+        def finder_class(&block) # rubocop:disable Metrics/MethodLength
+          define_finder_class do
+            adapters ActiveRecord
+
+            entity_type { Product }
+
+            filter_by :id
+            filter_by :name
+            filter_by :slug
+
+            if block.nil?
+              filter_by :value do |entity_type, value|
+                entity_type.where(slug: value)
+              end
+            else
+              class_eval(&block)
+            end
+          end
+        end
+
+        def finder_with_filter(key = nil, name = nil, &block)
+          finder_class(&block).new filter: { key => name }
+        end
+
+        describe 'filter_by' do
+          it 'has a default filter' do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = finder_with_filter :name, 'product_2'
+
+            expect(finder.results.first.name).to eq 'product_2'
+          end
+
+          it 'has another default filter' do
+            10.times { |i| Product.create slug: "product_#{i}" }
+            finder = finder_with_filter :value, 'product_2'
+
+            expect(finder.results.first.slug).to eq 'product_2'
+          end
+        end
+
+        it 'can use methods from the object' do
+          2.times { |i| Product.create name: "product_#{i}" }
+          finder1 = finder_with_filter :id, 1 do
+            filter_by :id do |entity_type, value|
+              some_instance_method(entity_type, value)
+            end
+
+            private
+
+            def some_instance_method(entity_type, value)
+              entity_type.where(id: value)
+            end
+          end
+
+          expect(finder1.results.first.id).to eq 1
+        end
+
+        it 'can dispatch with instance methods' do
+          2.times { |i| Product.create name: "product_#{i}" }
+          finder = finder_with_filter :id, 3 do
+            filter_by :id, with: :some_instance_method
+
+            private
+
+            def some_instance_method(entity_type, value)
+              entity_type.where(id: value)
+            end
+          end
+
+          expect(finder.results.first.id).to eq 3
+        end
+
+        describe 'filter_by attributes' do
+          it 'accesses filter values' do
+            finder = finder_with_filter :value, 1
+            expect(finder.value).to eq 1
+          end
+
+          it 'returns default filter value if filter_by is not specified' do
+            finder = finder_with_filter do
+              filter_by :value, 1
+            end
+            expect(finder.value).to eq 1
+          end
+
+          it 'does not include invalid filters' do
+            finder = finder_with_filter invalid: 'option'
+            expect { finder.invalid }.to raise_error NoMethodError
+          end
+        end
+      end
+    end
+  end
+end

data/spec/trailblazer/finder/adapters/active_record/paging_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper_active_record'
+
+module Trailblazer
+  class Finder
+    module Adapters
+      module ActiveRecord
+        describe Paging do
+          it_behaves_like 'a paging feature'
+
+          after do
+            Product.delete_all
+          end
+
+          def define_finder_class(&block)
+            Class.new do
+              include Trailblazer::Finder::Base
+              include Trailblazer::Finder::Features::Paging
+              include Trailblazer::Finder::Adapters::ActiveRecord
+
+              instance_eval(&block) if block_given?
+            end
+          end
+
+          def finder_class
+            define_finder_class do
+              entity_type { Product }
+
+              per_page 2
+
+              min_per_page 2
+              max_per_page 10
+            end
+          end
+
+          def finder_with_page(page = nil, per_page = nil)
+            finder_class.new page: page, per_page: per_page
+          end
+
+          it 'can be inherited' do
+            child_class = Class.new(finder_class)
+            expect(child_class.new.per_page).to eq 2
+          end
+
+          describe '#results' do
+            it 'paginates results' do
+              6.times { |i| Product.create name: "product_#{i}" }
+              finder = finder_with_page 2, 2
+
+              expect(finder.results.map(&:name)).to eq %w[product_2 product_3]
+            end
+          end
+
+          describe '#count' do
+            it 'gives the real count' do
+              10.times { |i| Product.create name: "product_#{i}" }
+              finder = finder_with_page 1
+              expect(finder.count).to eq 10
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/trailblazer/finder/adapters/active_record/sorting_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper_active_record'
+
+module Trailblazer
+  class Finder
+    module Adapters
+      module ActiveRecord
+        describe Sorting do
+          def finder_class
+            Class.new do
+              include Trailblazer::Finder::Base
+              include Trailblazer::Finder::Features::Sorting
+              include Trailblazer::Finder::Adapters::ActiveRecord
+
+              entity_type { Product.all }
+
+              sortable_by :name, :price, :created_at
+
+              filter_by :name
+              filter_by :price
+              filter_by(:category) { |entity_type, _| entity_type.joins(:category) }
+            end
+          end
+
+          def finder_with_sort(sort = nil, filters = {})
+            finder_class.new filter: { sort: sort }.merge(filters)
+          end
+
+          it 'can be inherited' do
+            child_class = Class.new(finder_class)
+            expect(child_class.new.sort_attribute).to eq 'name'
+          end
+
+          describe 'sorting' do
+            after do
+              Product.delete_all
+            end
+
+            it 'sorts results based on the sort option desc' do
+              5.times { |i| Product.create! price: i }
+
+              finder = finder_with_sort 'price desc'
+              expect(finder.results.map(&:price)).to eq [4, 3, 2, 1, 0]
+            end
+
+            it 'sorts results based on the sort option asc' do
+              5.times { |i| Product.create! price: i }
+
+              finder = finder_with_sort 'price asc'
+              expect(finder.results.map(&:price)).to eq [0, 1, 2, 3, 4]
+            end
+
+            it 'defaults to first sort by option' do
+              5.times { |i| Product.create! name: "Name#{i}" }
+
+              finder = finder_with_sort
+              expect(finder.results.map(&:name)).to eq %w[Name4 Name3 Name2 Name1 Name0]
+            end
+
+            it 'ignores invalid sort values' do
+              finder = finder_with_sort 'invalid attribute'
+              expect { finder.results.to_a }.not_to raise_error
+            end
+
+            it 'can handle renames of sorting in joins' do
+              older_category = Category.create! title: 'older'
+              newer_category = Category.create! title: 'newer'
+
+              product_of_newer_category = Product.create! name: 'older product', category: newer_category
+              product_of_older_category = Product.create! name: 'newer product', category: older_category
+
+              finder = finder_with_sort 'created_at desc', category: ''
+
+              expect(finder.results.map(&:name)).to eq [product_of_older_category.name, product_of_newer_category.name]
+            end
+          end
+
+          it_behaves_like 'a sorting feature'
+        end
+      end
+    end
+  end
+end

data/spec/trailblazer/finder/adapters/data_mapper/base_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper_data_mapper'
+
+module Trailblazer
+  class Finder
+    module Adapters
+      describe DataMapper do
+        # it_behaves_like 'a base orm adapter'
+
+        after do
+          DProduct.all.destroy
+        end
+
+        def define_finder_class(&block)
+          Class.new(Trailblazer::Finder) do
+            class_eval(&block)
+          end
+        end
+
+        def finder_class(&block) # rubocop:disable Metrics/MethodLength
+          define_finder_class do
+            adapters DataMapper
+
+            entity_type { DProduct }
+
+            filter_by :id
+            filter_by :name
+            filter_by :slug
+
+            if block.nil?
+              filter_by :value do |entity_type, value|
+                entity_type.all(slug: value)
+              end
+            else
+              class_eval(&block)
+            end
+          end
+        end
+
+        def finder_with_filter(key = nil, name = nil, &block)
+          finder_class(&block).new filter: { key => name }
+        end
+
+        describe 'filter_by' do
+          it 'has a default filter' do
+            10.times { |i| DProduct.create name: "product_#{i}" }
+            finder = finder_with_filter :name, 'product_2'
+
+            expect(finder.results.first.name).to eq 'product_2'
+          end
+
+          it 'has another default filter' do
+            10.times { |i| DProduct.create slug: "product_#{i}" }
+            finder = finder_with_filter :value, 'product_2'
+
+            expect(finder.results.first.slug).to eq 'product_2'
+          end
+        end
+
+        it 'can use methods from the object' do
+          2.times { |i| DProduct.create name: "product_#{i}" }
+          finder1 = finder_with_filter :id, 1 do
+            filter_by :id do |entity_type, value|
+              some_instance_method(entity_type, value)
+            end
+
+            private
+
+            def some_instance_method(entity_type, value)
+              entity_type.all(id: value)
+            end
+          end
+
+          expect(finder1.results.first.id).to eq 1
+        end
+
+        it 'can dispatch with instance methods' do
+          2.times { |i| DProduct.create name: "product_#{i}" }
+          finder = finder_with_filter :id, 3 do
+            filter_by :id, with: :some_instance_method
+
+            private
+
+            def some_instance_method(entity_type, value)
+              entity_type.all(id: value)
+            end
+          end
+
+          expect(finder.results.first.id).to eq 3
+        end
+
+        describe 'filter_by attributes' do
+          it 'accesses filter values' do
+            finder = finder_with_filter :value, 1
+            expect(finder.value).to eq 1
+          end
+
+          it 'returns default filter value if filter_by is not specified' do
+            finder = finder_with_filter do
+              filter_by :value, 1
+            end
+            expect(finder.value).to eq 1
+          end
+
+          it 'does not include invalid filters' do
+            finder = finder_with_filter invalid: 'option'
+            expect { finder.invalid }.to raise_error NoMethodError
+          end
+        end
+      end
+    end
+  end
+end

data/spec/trailblazer/finder/adapters/data_mapper/paging_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper_data_mapper'
+
+module Trailblazer
+  class Finder
+    module Adapters
+      module DataMapper
+        describe Paging do
+          it_behaves_like 'a paging feature'
+
+          after do
+            DProduct.all.destroy
+          end
+
+          def define_finder_class(&block)
+            Class.new do
+              include Trailblazer::Finder::Base
+              include Trailblazer::Finder::Features::Paging
+              include Trailblazer::Finder::Adapters::DataMapper
+
+              instance_eval(&block) if block_given?
+            end
+          end
+
+          def finder_class
+            define_finder_class do
+              entity_type { DProduct }
+
+              per_page 2
+
+              min_per_page 2
+              max_per_page 10
+            end
+          end
+
+          def finder_with_page(page = nil, per_page = nil)
+            finder_class.new page: page, per_page: per_page
+          end
+
+          it 'can be inherited' do
+            child_class = Class.new(finder_class)
+            expect(child_class.new.per_page).to eq 2
+          end
+
+          describe '#results' do
+            it 'paginates results' do
+              6.times { |i| DProduct.create name: "product_#{i}" }
+              finder = finder_with_page 2, 2
+
+              expect(finder.results.map(&:name)).to eq %w[product_2 product_3]
+            end
+          end
+
+          describe '#count' do
+            it 'gives the real count' do
+              10.times { |i| DProduct.create name: "product_#{i}" }
+              finder = finder_with_page 1
+              expect(finder.count).to eq 10
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/trailblazer/finder/adapters/data_mapper/sorting_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper_data_mapper'
+
+module Trailblazer
+  class Finder
+    module Adapters
+      module DataMapper
+        describe Sorting do
+          def finder_class
+            Class.new do
+              include Trailblazer::Finder::Base
+              include Trailblazer::Finder::Features::Sorting
+              include Trailblazer::Finder::Adapters::DataMapper
+
+              entity_type { DProduct }
+
+              sortable_by :name, :price, :created_at
+
+              filter_by :name
+              filter_by :price
+
+              # # Need to find a fix for this, not sure how to handle joins with data mapper properly
+              # filter_by(:d_category) { |entity_type, _| entity_type }
+            end
+          end
+
+          def finder_with_sort(sort = nil, filters = {})
+            finder_class.new filter: { sort: sort }.merge(filters)
+          end
+
+          it 'can be inherited' do
+            child_class = Class.new(finder_class)
+            expect(child_class.new.sort_attribute).to eq 'name'
+          end
+
+          describe 'sorting' do
+            after do
+              DProduct.all.destroy
+            end
+
+            it 'sorts results based on the sort option desc' do
+              5.times { |i| DProduct.create price: i }
+
+              finder = finder_with_sort 'price desc'
+              expect(finder.results.map(&:price)).to eq [4, 3, 2, 1, 0]
+            end
+
+            it 'sorts results based on the sort option asc' do
+              5.times { |i| DProduct.create price: i }
+
+              finder = finder_with_sort 'price asc'
+              expect(finder.results.map(&:price)).to eq [0, 1, 2, 3, 4]
+            end
+
+            it 'defaults to first sort by option' do
+              5.times { |i| DProduct.create name: "Name#{i}" }
+
+              finder = finder_with_sort
+              expect(finder.results.map(&:name)).to eq %w[Name4 Name3 Name2 Name1 Name0]
+            end
+
+            it 'ignores invalid sort values' do
+              finder = finder_with_sort 'invalid attribute'
+              expect { finder.results.to_a }.not_to raise_error
+            end
+
+            # TODO: Need to find a fix for this, not sure how to handle joins with data mapper properly
+            it 'can handle renames of sorting in joins' do
+              #   older_category = DCategory.create title: 'older'
+              #   newer_category = DCategory.create title: 'newer'
+              #
+              #   product_of_newer_category = DProduct.create name: 'older product', d_category: newer_category
+              #   product_of_older_category = DProduct.create name: 'newer product', d_category: older_category
+              #
+              #   finder = finder_with_sort 'created_at desc', d_category: ''
+              #
+              #   expect(finder.results.map(&:name)).to eq [product_of_older_category.name, product_of_newer_category.name]
+            end
+          end
+
+          it_behaves_like 'a sorting feature'
+        end
+      end
+    end
+  end
+end

data/spec/trailblazer/finder/adapters/friendly_id_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper_active_record'
+
+module Trailblazer
+  class Finder
+    module Adapters
+      describe FriendlyId do
+        after do
+          Product.delete_all
+        end
+
+        def finder_class
+          Class.new(Trailblazer::Finder) do
+            adapters ActiveRecord, FriendlyId
+
+            entity_type { Product }
+
+            filter_by :name
+            filter_by :price
+          end
+        end
+
+        def finder_with_slug(slug = nil, filters = {})
+          finder_class.new filter: { id: slug }.merge(filters)
+        end
+
+        it 'filters by slug' do
+          2.times { |i| Product.create name: "Product #{i}", price: i, slug: "product_#{i}" }
+          finder = finder_with_slug 'product_1'
+          expect(finder.results.map(&:name)).to eq ['Product 1']
+        end
+
+        it 'filters by id' do
+          2.times { |i| Product.create name: "Product #{i}", price: i, slug: "product_#{i}" }
+          finder = finder_with_slug Product.last.id
+          expect(finder.results.map(&:name)).to match_array([Product.last.name])
+        end
+
+        it 'returns no records when slug is not found' do
+          2.times { |i| Product.create name: "Product #{i}", price: i, slug: "product_#{i}" }
+          finder = finder_with_slug 'unknown_1'
+          expect(finder.count).to eq 0
+        end
+      end
+    end
+  end
+end

data/spec/trailblazer/finder/adapters/kaminari_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper_active_record'
+require 'kaminari'
+
+module Trailblazer
+  class Finder
+    module Adapters
+      describe Kaminari do
+        it_behaves_like 'a paging feature'
+
+        after do
+          Product.delete_all
+        end
+
+        def define_finder_class(&block)
+          Class.new do
+            include Trailblazer::Finder::Base
+            include Trailblazer::Finder::Features::Paging
+            include Trailblazer::Finder::Adapters::ActiveRecord
+            include Trailblazer::Finder::Adapters::Kaminari
+
+            instance_eval(&block) if block_given?
+          end
+        end
+
+        def finder_class
+          define_finder_class do
+            entity_type { Product }
+
+            per_page 2
+
+            min_per_page 2
+            max_per_page 10
+          end
+        end
+
+        def finder_with_page(page = nil, per_page = nil)
+          finder_class.new page: page, per_page: per_page
+        end
+
+        it 'can be inherited' do
+          child_class = Class.new(finder_class)
+          expect(child_class.new.per_page).to eq 2
+        end
+
+        describe '#results' do
+          it 'paginates results' do
+            6.times { |i| Product.create name: "product_#{i}" }
+            finder = finder_with_page 2, 2
+
+            expect(finder.results.map(&:name)).to eq %w[product_2 product_3]
+          end
+        end
+
+        describe '#count' do
+          it 'gives the real count' do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = finder_with_page 1
+            expect(finder.count).to eq 10
+          end
+        end
+      end
+    end
+  end
+end