trailblazer-finder 0.10.3 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1878b1acf62f66eb1c410b476037ab0c0aa45b761805f151fe987f6d81b24ecc
-  data.tar.gz: 27e69700c5507481a8c06828889d451c98976c92a1b8542602565ecf438461e0
+  metadata.gz: cfcac8d017065a8faea558faebaa1bd9e742b7ceb9444a50eafd79d2c759bbfc
+  data.tar.gz: fdfafe463cba185afb34934f981b3428bb357a4031f941e22cb44e1c45608e11
 SHA512:
-  metadata.gz: fe66baf784a25237ee917eee6c261af6dba12e4f5e63df164a1cc37d268fad4b893c315594c2aea9d4083fc20ab3fedab50baf52a447dc198ea19ae0b260cc38
-  data.tar.gz: 50051b6a1e6a8413c1d4d70d455310fa2f4114e598737c0334fe1f1a0124906227c77f42d01e4722e76b352fc6ca55af1beef90f50309bf2d8ffd8690e034f4a
+  metadata.gz: 89c313cc891e5ef6b1d6e07145e23541d74698b543e47f4213d621e21925ec18c60d01d66cdbc2c6fe9d2ddbbfc4d5ef201f1bb80a1264ffe70c01f3e37772e0
+  data.tar.gz: 2a00366ecc9c10ae045ce1d1c69f455cc7a8b101be8bb360228cf8cb148833502ea6039ce30740781bd93f97c8cabf878a6129beeb072c9e4e6e0b13b5c3128f

data/CHANGES.md

@@ -1,3 +1,6 @@
+# 0.50.0
+* Breaking change: Use adapter and paginator configs instead of mixing them in adapters config.
+
 # 0.10.3
 * Add support for strings in filters keys.
 

data/README.md

@@ -78,7 +78,7 @@ Basically for most use cases, Entity is the entity/model/array of hashes you wis
 ```ruby
 class Post::Finder < Trailblazer::Finder
   # Without defining an ORM everything defaults to dealing with hash objects
-  adapters :ActiveRecord
+  adapter :ActiveRecord
 
   # Optional if you use it as option in the caller, Model/Entity or Array with Hashes
   entity { Post }
@@ -364,7 +364,7 @@ You can specify the adapters you wish to use inside your enherited Finder class.
 ### Adapters Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-  adapters :ActiveRecord
+  adapter "ActiveRecord"
 end
 ```
 
@@ -374,7 +374,7 @@ The only thing the [ActiveRecord](https://github.com/rails/rails/tree/master/act
 #### Active Record Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-  adapters :ActiveRecord
+  adapter "ActiveRecord"
 end
 ```
 
@@ -384,7 +384,7 @@ The only thing the [Sequel](https://github.com/jeremyevans/sequel) adapter does,
 #### Sequel Example
 ```ruby
 class Post::Finder < Trailblazer::Finder
-  adapters :Sequel
+  adapter "Sequel"
 end
 ```
 

data/lib/trailblazer/finder/activities/find.rb

@@ -3,7 +3,6 @@
 module Trailblazer
   class Finder
     module Activities
-      # Find Activity
       class Find < Trailblazer::Activity::Railway
         PREDICATES = %w[eq not_eq blank not_blank lt lte gt gte sw not_sw ew not_ew cont not_cont].freeze
 

data/lib/trailblazer/finder/activities/prepare.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "prepare_adapters"
+require_relative "prepare_adapter"
 require_relative "prepare_entity"
 require_relative "prepare_properties"
 require_relative "prepare_filters"
@@ -11,14 +11,13 @@ require_relative "prepare_sorting"
 module Trailblazer
   class Finder
     module Activities
-      # Prepare Activity
       class Prepare < Trailblazer::Activity::Railway
         def clean_ctx((ctx, flow_options), **)
           ctx.delete(:options)
           [Activity::Right, [ctx, flow_options]]
         end
 
-        step Subprocess(PrepareAdapters)
+        step Subprocess(PrepareAdapter)
         step Subprocess(PrepareEntity)
         step Subprocess(PrepareProperties)
         step Subprocess(PrepareFilters)

data/lib/trailblazer/finder/activities/prepare_adapter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Trailblazer
+  class Finder
+    module Activities
+      class PrepareAdapter < Trailblazer::Activity::Railway
+
+        def set_adapter(ctx, **)
+          ctx[:adapter] = ctx.dig(:config, :adapter) || "Basic"
+        end
+
+        def validate_adapter(_ctx, adapter:, **)
+          (ORM_ADAPTERS + ["Basic"]).include? adapter.to_s
+        end
+
+        def is_invalid?((ctx, _flow_options), **_circuit_options)
+          (ctx[:errors] ||= []) << {adapter: "The specified adapter are invalid"}
+        end
+
+        step :set_adapter
+        step :validate_adapter
+        fail :is_invalid?
+      end
+    end
+  end
+end

data/lib/trailblazer/finder/activities/process.rb

@@ -9,7 +9,6 @@ require_relative "process_filters"
 module Trailblazer
   class Finder
     module Activities
-      # Process Activity
       class Process < Trailblazer::Activity::Railway
         step Subprocess(ProcessAdapters)
         step Subprocess(ProcessPredicates)

data/lib/trailblazer/finder/activities/process_adapters.rb

@@ -4,36 +4,32 @@ module Trailblazer
   class Finder
     module Activities
       class ProcessAdapters < Trailblazer::Activity::Railway
-        def set_orm_adapters(ctx, **)
-          ctx[:adapters].each do |adapter|
-            next unless (ORM_ADAPTERS + ["Basic"]).include?(adapter)
-
-            ctx[:orm] = {}
-            ctx[:orm][:adapter] = adapter
-            ctx[:orm][:predicates] = "Trailblazer::Finder::Adapters::#{adapter}::Predicates"
-            ctx[:orm][:paging] = "Trailblazer::Finder::Adapters::#{adapter}::Paging"
-            ctx[:orm][:sorting] = "Trailblazer::Finder::Adapters::#{adapter}::Sorting"
-            return true
-          end
+        def set_adapter((ctx, flow_options), **)
+          adapter = ctx[:adapter]
+          ctx[:orm] = {}
+          ctx[:orm][:adapter] = adapter
+          ctx[:orm][:predicates] = "Trailblazer::Finder::Adapters::#{adapter}::Predicates"
+          ctx[:orm][:paging] = "Trailblazer::Finder::Adapters::#{adapter}::Paging"
+          ctx[:orm][:sorting] = "Trailblazer::Finder::Adapters::#{adapter}::Sorting"
+          true
         end
 
-        def set_paging_adapters(ctx, **)
-          ctx[:adapters].each do |adapter|
-            next unless PAGING_ADAPTERS.include?(adapter)
-            return false if ctx[:adapters].include?("Basic")
-            ctx[:orm][:paging] = "Trailblazer::Finder::Adapters::#{adapter}::Paging"
-            return true
-          end
+        def set_paginator(ctx, **)
+          paginator = ctx.dig(:config, :paginator)
+          return true unless paginator
+          return false unless ORM_ADAPTERS.include?(ctx[:orm][:adapter])
+          return false unless PAGING_ADAPTERS.include?(paginator)
+          ctx[:orm][:paging] = "Trailblazer::Finder::Adapters::#{paginator}::Paging"
           true
         end
 
-        def invalid_paging_adapter_error(ctx, **)
-          (ctx[:errors] ||= []) << {adapters: "Can't use paging adapters like Kaminari without using an ORM like ActiveRecord or Sequel"}
+        def invalid_paginator_error(ctx, **)
+          (ctx[:errors] ||= []) << {paginator: "Can't use paginator #{ctx.dig(:config, :paginator)} without using an ORM like ActiveRecord or Sequel"}
         end
 
-        step :set_orm_adapters
-        step :set_paging_adapters
-        fail :invalid_paging_adapter_error
+        step :set_adapter, fast_track: true
+        step :set_paginator
+        fail :invalid_paginator_error
       end
     end
   end

data/lib/trailblazer/finder/adapters/kaminari/paging.rb

@@ -3,9 +3,8 @@
 module Trailblazer
   class Finder
     module Adapters
-      # ActiveRecord Adapter
       module Kaminari
-        # Kaminari Paging Adapter
+        # Kaminari Paginator
         module Paging
           module_function
 

data/lib/trailblazer/finder/adapters/will_paginate/paging.rb

@@ -3,9 +3,8 @@
 module Trailblazer
   class Finder
     module Adapters
-      # ActiveRecord Adapter
       module WillPaginate
-        # Kaminari Paging Adapter
+        # Kaminari Paginator
         module Paging
           module_function
 

data/lib/trailblazer/finder/dsl.rb

@@ -33,10 +33,12 @@ module Trailblazer
         config[:filters][filter_name][:block] = block || nil
       end
 
-      def adapters(*adapters)
-        adapters.each do |adapter|
-          config[:adapters].push adapter.to_s.split("::").last.gsub("}>", "") if config[:adapters]
-        end
+      def adapter(adapter)
+        config[:adapter] = adapter.to_s
+      end
+
+      def paginator(paginator)
+        config[:paginator] = paginator.to_s
       end
 
       def apply_config(options, **)

data/lib/trailblazer/finder/version.rb

@@ -2,6 +2,6 @@
 
 module Trailblazer
   class Finder
-    VERSION = "0.10.3".freeze
+    VERSION = "0.50.0".freeze
   end
 end

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

@@ -13,7 +13,7 @@ module Trailblazer
 
         def define_finder_class(&block)
           Class.new(Trailblazer::Finder) do
-            adapters ActiveRecord
+            adapter "ActiveRecord"
             entity { Product }
 
             class_eval(&block)

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

@@ -32,15 +32,15 @@ module Trailblazer
           finder_class(&block).new params: filter
         end
 
-        describe "#adapters" do
+        describe "#adapter" do
           it "cannot use kaminari without an actual orm" do
             10.times { |i| Product.create name: "product_#{i}" }
             finder = new_finder do
-              adapters Kaminari
+              paginator :Kaminari
               paging per_page: 2, min_per_page: 1, max_per_page: 5
             end
 
-            expect(finder.errors).to eq [{adapters: "Can't use paging adapters like Kaminari without using an ORM like ActiveRecord or Sequel"}]
+            expect(finder.errors).to eq [{paginator: "Can't use paginator Kaminari without using an ORM like ActiveRecord or Sequel"}]
           end
         end
 
@@ -48,7 +48,8 @@ module Trailblazer
           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
-              adapters ActiveRecord, Kaminari
+              adapter :ActiveRecord
+              paginator "Kaminari"
               paging per_page: 2, min_per_page: 1, max_per_page: 5
             end
 
@@ -58,7 +59,8 @@ module Trailblazer
           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
-              adapters ActiveRecord, Kaminari
+               adapter "ActiveRecord"
+              paginator "Kaminari"
               paging per_page: 5, min_per_page: 2, max_per_page: 8
             end
 
@@ -69,7 +71,8 @@ module Trailblazer
           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
-              adapters ActiveRecord, Kaminari
+              adapter "ActiveRecord"
+              paginator "Kaminari"
               paging per_page: 5, min_per_page: 2, max_per_page: 8
             end
 
@@ -80,7 +83,8 @@ module Trailblazer
           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
-              adapters ActiveRecord, Kaminari
+              adapter "ActiveRecord"
+              paginator "Kaminari"
               paging per_page: 5, min_per_page: 2, max_per_page: 8
             end
 
@@ -94,7 +98,8 @@ module Trailblazer
             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
-              adapters ActiveRecord, Kaminari
+              adapter "ActiveRecord"
+              paginator "Kaminari"
               paging per_page: 2, min_per_page: 1, max_per_page: 5
               property :name, type: Types::String
               property :id, type: Types::Integer, sortable: true

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

@@ -13,7 +13,7 @@ module Trailblazer
 
         def define_finder_class(&block)
           Class.new(Trailblazer::Finder) do
-            adapters Sequel
+            adapter "Sequel"
             entity { SProduct }
 
             class_eval(&block)

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

@@ -38,11 +38,11 @@ module Trailblazer
           it "cannot use kaminari without an actual orm" do
             10.times { |i| Product.create name: "product_#{i}" }
             finder = new_finder do
-              adapters WillPaginate
+              paginator "WillPaginate"
               paging per_page: 2, min_per_page: 1, max_per_page: 5
             end
 
-            expect(finder.errors).to eq [{adapters: "Can't use paging adapters like Kaminari without using an ORM like ActiveRecord or Sequel"}]
+            expect(finder.errors).to eq [{paginator: "Can't use paginator WillPaginate without using an ORM like ActiveRecord or Sequel"}]
           end
         end
 
@@ -50,7 +50,8 @@ module Trailblazer
           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
-              adapters ActiveRecord, WillPaginate
+              adapter "ActiveRecord"
+              paginator "WillPaginate"
               paging per_page: 2, min_per_page: 1, max_per_page: 5
             end
 
@@ -60,7 +61,8 @@ module Trailblazer
           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
-              adapters ActiveRecord, WillPaginate
+              adapter "ActiveRecord"
+              paginator "WillPaginate"
               paging per_page: 5, min_per_page: 2, max_per_page: 8
             end
 
@@ -71,7 +73,8 @@ module Trailblazer
           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
-              adapters ActiveRecord, WillPaginate
+              adapter "ActiveRecord"
+              paginator "WillPaginate"
               paging per_page: 5, min_per_page: 2, max_per_page: 8
             end
 
@@ -82,7 +85,8 @@ module Trailblazer
           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
-              adapters ActiveRecord, WillPaginate
+              adapter "ActiveRecord"
+              paginator "WillPaginate"
               paging per_page: 5, min_per_page: 2, max_per_page: 8
             end
 
@@ -96,7 +100,8 @@ module Trailblazer
             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
-              adapters ActiveRecord, WillPaginate
+              adapter "ActiveRecord"
+              paginator "WillPaginate"
               paging per_page: 2, min_per_page: 1, max_per_page: 5
               property :name, type: Types::String
               property :id, type: Types::Integer, sortable: true

data/spec/trailblazer/finder/dsl_spec.rb

@@ -60,29 +60,20 @@ module Trailblazer
         it "checks for a valid adapter and returns an error" 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
-            adapters :NonExisting
+            adapter :NonExisting
           end
 
-          expect(finder.errors).to eq [{adapters: "One or more of the specified adapters are invalid"}]
-        end
-
-        it "checks if multiple orm adapters are requested and returns an error" 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
-            adapters :ActiveRecord, :Sequel
-          end
-
-          expect(finder.errors).to eq [{adapters: "More then one ORM adapter specified"}]
+          expect(finder.errors).to eq [{adapter: "The specified adapter are invalid"}]
         end
 
         it "sets the adapter in the config" 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
-            adapters ActiveRecord
+            adapter "ActiveRecord"
             property :value, type: Base
           end
 
-          expect(finder.class.config[:adapters]).to eq ["ActiveRecord"]
+          expect(finder.class.config[:adapter]).to eq "ActiveRecord"
         end
       end
 

data/spec/trailblazer/operation/finder_spec.rb

@@ -5,7 +5,7 @@ require "trailblazer"
 require "spec_helper_active_record"
 
 class Product::FinderNoEntity < Trailblazer::Finder
-  adapters ActiveRecord
+  adapter "ActiveRecord"
 
   property :id, type: Types::Integer
   property :name, type: Types::String, sortable: true
@@ -19,7 +19,7 @@ class Product::FinderNoEntity < Trailblazer::Finder
 end
 
 class Product::FinderWithEntity < Trailblazer::Finder
-  adapters ActiveRecord
+  adapter "ActiveRecord"
 
   entity { Product }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-finder
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.50.0
 platform: ruby
 authors:
 - Nick Sutterer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -275,7 +275,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGES.md
 - Gemfile
@@ -285,7 +284,7 @@ files:
 - lib/trailblazer/finder.rb
 - lib/trailblazer/finder/activities/find.rb
 - lib/trailblazer/finder/activities/prepare.rb
-- lib/trailblazer/finder/activities/prepare_adapters.rb
+- lib/trailblazer/finder/activities/prepare_adapter.rb
 - lib/trailblazer/finder/activities/prepare_entity.rb
 - lib/trailblazer/finder/activities/prepare_filters.rb
 - lib/trailblazer/finder/activities/prepare_paging.rb

data/.rubocop_todo.yml

@@ -1,78 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2018-08-23 00:10:15 +0200 using RuboCop version 0.58.2.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-Metrics/AbcSize:
-  Max: 31
-
-# Offense count: 2
-Metrics/CyclomaticComplexity:
-  Max: 7
-
-# Offense count: 13
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 283
-
-# Offense count: 1
-# Configuration parameters: CountKeywordArgs.
-Metrics/ParameterLists:
-  Max: 6
-
-# Offense count: 1
-RSpec/DescribeClass:
-  Exclude:
-    - 'spec/trailblazer/operation/finder_spec.rb'
-
-# Offense count: 78
-# Configuration parameters: Max.
-RSpec/ExampleLength:
-  Exclude:
-    - 'spec/trailblazer/finder/adapters/active_record_spec.rb'
-    - 'spec/trailblazer/finder/adapters/basic_spec.rb'
-    - 'spec/trailblazer/finder/adapters/kaminari_spec.rb'
-    - 'spec/trailblazer/finder/adapters/sequel_spec.rb'
-    - 'spec/trailblazer/finder/adapters/will_paginate_spec.rb'
-    - 'spec/trailblazer/finder/base_spec.rb'
-    - 'spec/trailblazer/finder/dsl_spec.rb'
-    - 'spec/trailblazer/finder/utils/string_spec.rb'
-
-# Offense count: 62
-# Configuration parameters: AggregateFailuresByDefault.
-RSpec/MultipleExpectations:
-  Max: 7
-
-# Offense count: 2
-RSpec/RepeatedDescription:
-  Exclude:
-    - 'spec/trailblazer/finder/adapters/basic_spec.rb'
-
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, EnforcedStyle.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'spec/trailblazer/operation/finder_spec.rb'
-
-# Offense count: 1
-# Configuration parameters: SuspiciousParamNames.
-# SuspiciousParamNames: options, opts, args, params, parameters
-Style/OptionHash:
-  Exclude:
-    - 'lib/trailblazer/finder/dsl.rb'
-
-# Offense count: 3
-Style/Send:
-  Exclude:
-    - 'lib/trailblazer/finder/adapters/sequel/sorting.rb'
-    - 'lib/trailblazer/operation/finder.rb'
-
-RSpec/DescribedClass:
-  SkipBlocks: true

data/lib/trailblazer/finder/activities/prepare_adapters.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Trailblazer
-  class Finder
-    module Activities
-      # Adapters Activity
-      class PrepareAdapters < Trailblazer::Activity::Railway
-        def check_for_adapters(ctx, **)
-          adapters = ctx.dig(:config, :adapters)
-          return true if adapters.empty?
-
-          adapters.each do |adapter|
-            return true if Finder::Adapters.constants.include?(adapter.to_sym)
-          end
-          false
-        end
-
-        ## Only one ORM can be accepted
-        def validate_adapters(ctx, **)
-          adapters = ctx.dig(:config, :adapters)
-          return true if adapters.empty?
-
-          adapters.each do |adapter|
-            if ORM_ADAPTERS.include?(adapter)
-              return false if (adapters & (ORM_ADAPTERS - [adapter])).any?
-            end
-          end
-          true
-        end
-
-        def invalid_adapters_error((ctx, flow_options), **_circuit_options)
-          (ctx[:errors] ||= []) << {adapters: "One or more of the specified adapters are invalid"}
-        end
-
-        def multiple_orm_error((ctx, flow_options), **_circuit_options)
-          (ctx[:errors] ||= []) << {adapters: "More then one ORM adapter specified"}
-        end
-
-        def set_adapters(ctx, **)
-          adapters = ctx.dig(:config, :adapters)
-          ctx[:adapters] = (ORM_ADAPTERS & adapters).any? ? adapters : ["Basic"] + adapters
-        end
-
-        step :check_for_adapters
-        fail :invalid_adapters_error, Output(:success) => End(:failure)
-        step :validate_adapters
-        fail :multiple_orm_error
-        step :set_adapters
-      end
-    end
-  end
-end