trailblazer-finder 0.1.4 → 0.2.5

data/spec/spec_helper.rb

@@ -1,16 +1,10 @@
-require 'bundler/setup'
-require 'simplecov'
-SimpleCov.start do
-  add_group 'Trailblazer-Finder', 'lib'
-  add_group 'Tests', 'spec'
-end
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pry-byebug"
 
 RSpec.configure do |config|
   config.expect_with(:rspec) { |c| c.syntax = :expect }
 end
 
-# require 'coveralls'
-# Coveralls.wear!
-
-require_relative 'support/sorting_shared_example'
-require 'trailblazer/finder'
+require "trailblazer/finder"

data/spec/spec_helper_active_record.rb

@@ -1,8 +1,9 @@
-require_relative 'spec_helper'
-require_relative 'support/paging_shared_example'
-require 'active_record'
+# frozen_string_literal: true
 
-ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+require_relative "spec_helper"
+require "active_record"
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 
 ActiveRecord::Schema.define do
   self.verbose = false
@@ -35,14 +36,12 @@ module ActiveRecord
   class Base
     def self.reset_pk_sequence
       case ActiveRecord::Base.connection.adapter_name
-      when 'SQLite'
-        new_max = maximum(primary_key) || 0
-        update_seq_sql = "update sqlite_sequence set seq = #{new_max} where name = '#{table_name}';"
-        ActiveRecord::Base.connection.execute(update_seq_sql)
-      when 'PostgreSQL'
-        ActiveRecord::Base.connection.reset_pk_sequence!(table_name)
-      else
-        raise 'Task not implemented for this DB adapter'
+        when "SQLite"
+          new_max = maximum(primary_key) || 0
+          update_seq_sql = "update sqlite_sequence set seq = #{new_max} where name = '#{table_name}';"
+          ActiveRecord::Base.connection.execute(update_seq_sql)
+        else
+          exit(1)
       end
     end
   end

data/spec/spec_helper_sequel.rb

@@ -1,7 +1,7 @@
-require_relative 'spec_helper'
-require_relative 'support/paging_shared_example'
-require_relative 'support/sorting_shared_example'
-require 'sequel'
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "sequel"
 Sequel::Model.plugin :timestamps
 
 DB = Sequel.sqlite

data/spec/spec_helper_will_paginate.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+if defined?(WillPaginate)
+  module WillPaginate
+    module ActiveRecord
+      module RelationMethods
+        def per(value = nil)
+          per_page(value)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+require "spec_helper_active_record"
+
+module Trailblazer
+  class Finder
+    module Adapters
+      describe ActiveRecord do
+        after do
+          Product.delete_all
+          Product.reset_pk_sequence
+        end
+
+        def define_finder_class(&block)
+          Class.new(Trailblazer::Finder) do
+            adapters ActiveRecord
+            entity { Product }
+
+            class_eval(&block)
+          end
+        end
+
+        def finder_class(&block)
+          define_finder_class do
+            class_eval(&block) unless block.nil?
+          end
+        end
+
+        def new_finder(filter = {}, &block)
+          finder_class(&block).new params: filter
+        end
+
+        describe "#property" do
+          it "sets the property and works with eq predicate" do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = new_finder name_eq: "product_2" do
+              property :name, type: Types::String
+            end
+
+            expect(finder.result.first.id).to eq 3
+            expect(finder.result.count).to eq 1
+          end
+
+          it "sets the property and works with not_eq predicate" do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = new_finder name_not_eq: "product_2" do
+              property :name, type: Types::String
+            end
+
+            expect(finder.result.count).to eq 9
+          end
+
+          it "sets the property and works with blank predicate" do
+            9.times { |i| Product.create name: "product_#{i}" }
+            Product.create name: "", slug: "Blank Test"
+            finder = new_finder name_blank: true do
+              property :name, type: Types::String
+            end
+
+            expect(finder.result.count).to eq 1
+            expect(finder.result.first.slug).to eq "Blank Test"
+            expect(finder.result.first.id).to eq 10
+          end
+
+          it "sets the property and works with not blank predicate" do
+            9.times { |i| Product.create name: "product_#{i}" }
+            Product.create name: "", slug: "Blank Test"
+            finder = new_finder name_not_blank: true do
+              property :name, type: Types::String
+            end
+
+            expect(finder.result.count).to eq 9
+          end
+
+          it "sets the property and works with gt (greater than) predicate" do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = new_finder id_gt: 3 do
+              property :id, type: Types::Integer
+            end
+
+            expect(finder.result.count).to eq 7
+          end
+
+          it "sets the property and works with gte (greater than or equal to) predicate" do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = new_finder id_gte: 3 do
+              property :id, type: Types::Integer
+            end
+
+            expect(finder.result.count).to eq 8
+          end
+
+          it "sets the property and works with lt (less than) predicate" do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = new_finder id_lt: 3 do
+              property :id, type: Types::Integer
+            end
+
+            expect(finder.result.count).to eq 2
+          end
+
+          it "sets the property and works with lte (less than or equal to) predicate" do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = new_finder id_lte: 3 do
+              property :id, type: Types::Integer
+            end
+
+            expect(finder.result.count).to eq 3
+          end
+
+          it "sets the property and works with cont predicate" do
+            5.times { |i| Product.create name: "product_#{i}" }
+            5.times { |i| Product.create name: "none_#{i}" }
+            finder = new_finder name_cont: "product" do
+              property :name, type: Types::String
+            end
+
+            expect(finder.result.first.id).to eq 1
+            expect(finder.result.count).to eq 5
+          end
+
+          it "sets the property and works with not_cont predicate" do
+            5.times { |i| Product.create name: "product_#{i}" }
+            5.times { |i| Product.create name: "none_#{i}" }
+            finder = new_finder name_not_cont: "product" do
+              property :name, type: Types::String
+            end
+
+            expect(finder.result.first.id).to eq 6
+            expect(finder.result.count).to eq 5
+          end
+
+          it "sets the property and works with sw predicate" do
+            5.times { |i| Product.create name: "product_#{i}" }
+            1.times { |i| Product.create name: "predicate_#{i}" }
+            4.times { |i| Product.create name: "none_#{i}" }
+            finder = new_finder name_sw: "pr" do
+              property :name, type: Types::String
+            end
+
+            expect(finder.result.first.id).to eq 1
+            expect(finder.result.count).to eq 6
+          end
+
+          it "sets the property and works with not_sw predicate" do
+            5.times { |i| Product.create name: "product_#{i}" }
+            1.times { |i| Product.create name: "predicate_#{i}" }
+            4.times { |i| Product.create name: "none_#{i}" }
+            finder = new_finder name_not_sw: "pr" do
+              property :name, type: Types::String
+            end
+
+            expect(finder.result.first.id).to eq 7
+            expect(finder.result.count).to eq 4
+          end
+
+          it "sets the property and works with ew predicate" do
+            5.times { |i| Product.create name: "product_#{i}_end" }
+            1.times { |i| Product.create name: "predicate_#{i}_endwow" }
+            4.times { |i| Product.create name: "none_#{i}" }
+            finder = new_finder name_ew: "end" do
+              property :name, type: Types::String
+            end
+
+            expect(finder.result.first.id).to eq 1
+            expect(finder.result.count).to eq 5
+          end
+
+          it "sets the property and works with not_ew predicate" do
+            5.times { |i| Product.create name: "product_#{i}_end" }
+            1.times { |i| Product.create name: "predicate_#{i}_endwow" }
+            4.times { |i| Product.create name: "none_#{i}" }
+            finder = new_finder name_not_ew: "end" do
+              property :name, type: Types::String
+            end
+
+            expect(finder.result.first.id).to eq 6
+            expect(finder.result.count).to eq 5
+          end
+        end
+
+        describe "#paging" do
+          it "sets the paging values and shows only the first page results" do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = new_finder do
+              paging per_page: 2, min_per_page: 1, max_per_page: 5
+            end
+
+            expect(finder.result.map { |n| n[:name] }).to eq %w[product_0 product_1]
+          end
+
+          it "accepts per_page as a parameter" do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = new_finder page: 2, per_page: 4 do
+              paging per_page: 5, min_per_page: 2, max_per_page: 8
+            end
+
+            expect(finder.result.first.id).to eq 5
+            expect(finder.result.map(&:id)).to eq [5, 6, 7, 8]
+          end
+
+          it "uses max_per_page in finder as maximum per_page" do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = new_finder page: 2, per_page: 9 do
+              paging per_page: 5, min_per_page: 2, max_per_page: 8
+            end
+
+            expect(finder.result.first.id).to eq 9
+            expect(finder.result.map(&:id)).to eq [9, 10]
+          end
+
+          it "uses min_per_page in finder as minimum per_page" do
+            10.times { |i| Product.create name: "product_#{i}" }
+            finder = new_finder page: 2, per_page: 1 do
+              paging per_page: 5, min_per_page: 2, max_per_page: 8
+            end
+
+            expect(finder.result.first.id).to eq 3
+            expect(finder.result.map(&:id)).to eq [3, 4]
+          end
+        end
+
+        describe "#sorting" do
+          it "sets the property and works with eq predicate and sorting" do
+            5.times { |i| Product.create name: "product_#{i}" }
+            5.times { |_i| Product.create name: "product" }
+            finder = new_finder name_eq: "product", sort: "id desc" do
+              property :name, type: Types::String
+              property :id, type: Types::Integer, sortable: true
+            end
+
+            expect(finder.result.first.id).to eq 10
+            expect(finder.result.count).to eq 5
+          end
+
+          it "sets the property and sorts by multiple columns" do
+            5.times { |i| Product.create name: "product_#{i}", slug: "slug #{i}" }
+            5.times { |i| Product.create name: "product", slug: "slug #{i}" }
+            finder = new_finder sort: "name asc, slug desc" do
+              property :name, type: Types::String, sortable: true
+              property :slug, type: Types::String, sortable: true
+              property :id, type: Types::Integer, sortable: true
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [10, 9, 8, 7, 6, 1, 2, 3, 4, 5]
+            expect(finder.result.count).to eq 10
+          end
+        end
+
+        describe "Predicates, Paging and Sorting together" do
+          it "sets the property and works with eq predicate and paging" do
+            5.times { |i| Product.create name: "product_#{i}" }
+            5.times { |_i| Product.create name: "product" }
+            finder = new_finder name_eq: "product", sort: "id desc", page: 2 do
+              paging per_page: 2, min_per_page: 1, max_per_page: 5
+              property :name, type: Types::String
+              property :id, type: Types::Integer, sortable: true
+            end
+
+            expect(finder.result.first.id).to eq 8
+            expect(finder.result.map(&:id)).to eq [8, 7]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Trailblazer
+  class Finder
+    module Adapters
+      describe Basic do
+        def define_finder_class(&block)
+          Class.new(Trailblazer::Finder) do
+            class_eval(&block)
+          end
+        end
+
+        def finder_class(default_entity = [], &block)
+          define_finder_class do
+            entity { default_entity }
+
+            class_eval(&block) unless block.nil?
+          end
+        end
+
+        def new_finder(default_entity = [], filter = {}, &block)
+          finder_class(default_entity, &block).new params: filter
+        end
+
+        describe "#property" do
+          it "sets the property and works with eq predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: "Test 3"}]
+            finder = new_finder entity, value_eq: "Test 1" do
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:value] }).to eq ["Test 1"]
+          end
+
+          it "sets the property and works with not_eq predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: "Test 3"}]
+            finder = new_finder entity, value_not_eq: "Test 1" do
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:value] }).to eq ["Test 2", "Test 3"]
+          end
+
+          it "sets the property and works with blank predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: ""}, {id: 4, value: "Test 4"}]
+            finder = new_finder entity, value_blank: true do
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [3]
+          end
+
+          it "sets the property and works with not_blank predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: ""}, {id: 4, value: "Test 4"}]
+            finder = new_finder entity, value_not_blank: true do
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [1, 2, 4]
+          end
+
+          it "sets the property and works gt (greater than) predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: ""}, {id: 4, value: "Test 4"}]
+            finder = new_finder entity, id_gt: 1 do
+              property :id, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [2, 3, 4]
+          end
+
+          it "sets the property and works gte (greater than or equal to) predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: ""}, {id: 4, value: "Test 4"}]
+            finder = new_finder entity, id_gte: 2 do
+              property :id, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [2, 3, 4]
+          end
+
+          it "sets the property and works lt (less than) predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: ""}, {id: 4, value: "Test 4"}]
+            finder = new_finder entity, id_lt: 4 do
+              property :id, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [1, 2, 3]
+          end
+
+          it "sets the property and works lte (lesss than or equal to) predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: ""}, {id: 4, value: "Test 4"}]
+            finder = new_finder entity, id_lte: 3 do
+              property :id, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [1, 2, 3]
+          end
+
+          it "sets the property and works lte (lesss than or equal to) predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: ""}, {id: 4, value: "Test 4"}]
+            finder = new_finder entity, id_ltse: 3 do
+              property :id, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [1, 2, 3, 4]
+          end
+
+          it "sets the property and works with cont predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "None 2"}, {id: 3, value: "Test 3"}]
+            finder = new_finder entity, value_cont: "Test" do
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:value] }).to eq ["Test 1", "Test 3"]
+          end
+
+          it "sets the property and works with not_cont predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "None 2"}, {id: 3, value: "Test 3"}]
+            finder = new_finder entity, value_not_cont: "Test" do
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:value] }).to eq ["None 2"]
+          end
+
+          it "sets the property and works with sw predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "None 2"}, {id: 3, value: "Testical 3"}]
+            finder = new_finder entity, value_sw: "Test" do
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:value] }).to eq ["Test 1", "Testical 3"]
+          end
+
+          it "sets the property and works with not_sw predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "None 2"}, {id: 3, value: "ATest 3"}]
+            finder = new_finder entity, value_not_sw: "Test" do
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:value] }).to eq ["None 2", "ATest 3"]
+          end
+
+          it "sets the property and works with ew predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "None 1"}, {id: 3, value: "Test 3"}]
+            finder = new_finder entity, value_ew: "1" do
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:value] }).to eq ["Test 1", "None 1"]
+          end
+
+          it "sets the property and works with not_ew predicate" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "None 1"}, {id: 3, value: "ATest 3"}]
+            finder = new_finder entity, value_not_ew: "1" do
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:value] }).to eq ["ATest 3"]
+          end
+        end
+
+        describe "#paging" do
+          it "sets the paging values and shows only the first page results" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: "Test 3"}]
+            finder = new_finder entity do
+              paging per_page: 2, min_per_page: 1, max_per_page: 5
+              property :value, type: Types::String
+            end
+
+            expect(finder.result.map { |n| n[:value] }).to eq ["Test 1", "Test 2"]
+          end
+
+          it "accepts per_page as a parameter" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: "Test 3"}, {id: 4, value: "Test 4"}, {id: 5, value: "Test 5"}, {id: 6, value: "Test 6"}, {id: 7, value: "Test 7"}, {id: 8, value: "Test 8"}, {id: 9, value: "Test 9"}, {id: 10, value: "Test 10"}]
+            finder = new_finder entity, page: 2, per_page: 4 do
+              paging per_page: 5, min_per_page: 2, max_per_page: 8
+            end
+
+            expect(finder.result.first.id).to eq 5
+            expect(finder.result.map(&:id)).to eq [5, 6, 7, 8]
+          end
+
+          it "uses max_per_page in finder as maximum per_page" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: "Test 3"}, {id: 4, value: "Test 4"}, {id: 5, value: "Test 5"}, {id: 6, value: "Test 6"}, {id: 7, value: "Test 7"}, {id: 8, value: "Test 8"}, {id: 9, value: "Test 9"}, {id: 10, value: "Test 10"}]
+            finder = new_finder entity, page: 2, per_page: 9 do
+              paging per_page: 5, min_per_page: 2, max_per_page: 8
+            end
+
+            expect(finder.result.first.id).to eq 9
+            expect(finder.result.map(&:id)).to eq [9, 10]
+          end
+
+          it "uses min_per_page in finder as minimum per_page" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 2"}, {id: 3, value: "Test 3"}, {id: 4, value: "Test 4"}, {id: 5, value: "Test 5"}, {id: 6, value: "Test 6"}, {id: 7, value: "Test 7"}, {id: 8, value: "Test 8"}, {id: 9, value: "Test 9"}, {id: 10, value: "Test 10"}]
+            finder = new_finder entity, page: 2, per_page: 1 do
+              paging per_page: 5, min_per_page: 2, max_per_page: 8
+            end
+
+            expect(finder.result.first.id).to eq 3
+            expect(finder.result.map(&:id)).to eq [3, 4]
+          end
+        end
+
+        describe "#sorting" do
+          it "sets the property and works with eq predicate and sorting" do
+            entity = [{id: 1, value: "Test 1"}, {id: 2, value: "Test 1"}, {id: 3, value: "Test 3"}]
+            finder = new_finder entity, value_eq: "Test 1", sort: "id desc" do
+              property :value, type: Types::String, sortable: true
+              property :id, type: Types::Integer, sortable: true
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [2, 1]
+          end
+
+          it "sets the property and works with eq predicate and sorting by multiple columns" do
+            entity = [{id: 1, value: "Test 1", slug: 4}, {id: 2, value: "Test 2", slug: 1}, {id: 3, value: "Test 1", slug: 2}]
+            finder = new_finder entity, value_eq: "Test 1", sort: "slug asc, id desc" do
+              property :value, type: Types::String, sortable: true
+              property :id, type: Types::Integer, sortable: true
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [3, 1]
+          end
+        end
+
+        describe "Predicates, Paging and Sorting together" do
+          it "sets the property and works with eq predicate and paging" do
+            entity = [
+              {id: 1, value: "Test 1"},
+              {id: 2, value: "Test 2"},
+              {id: 3, value: "Test 1"},
+              {id: 4, value: "Test 4"},
+              {id: 5, value: "Test 1"}
+            ]
+
+            finder = new_finder entity, value_eq: "Test 1", sort: "id desc", page: 2 do
+              paging per_page: 2, min_per_page: 1, max_per_page: 5
+              property :value, type: Types::String, sortable: true
+              property :id, type: Types::Integer, sortable: true
+            end
+
+            expect(finder.result.map { |n| n[:id] }).to eq [1]
+            expect(finder.count).to eq 1
+          end
+        end
+      end
+    end
+  end
+end