trailblazer-finder 0.90.0 → 0.92.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c3605d464db4d05bd07e54aec870bd62820657704a730ebc02d11f904dcd964
-  data.tar.gz: e0c677b1cf39def27bef24b5787cf0cc6a475afb9adf227baa77315ee447208b
+  metadata.gz: d5aa468a471c2d9bb6f7f0196e46a14905a557956a18da87723eb74a3f897b10
+  data.tar.gz: 6d236f533affcf4eb828704e438b2ec9f30270d61626be709aa29d64c5489d5d
 SHA512:
-  metadata.gz: 251cf565e7ca50200c70a997bbbe8c96d28232b28d8bd8001129612194ee2065f57b6198b965cb60f19420f988ad1af17cdcd50c4ad23a50d6eff2241d4a2845
-  data.tar.gz: dcad67e86a906c097f00b88b6b051b296819287a1401db159c401121142e794028a0a0406b8836fc74f590c368ac6a21045f39ed869d36e7b1f6642495c8ae91
+  metadata.gz: 8067cad54995bf7b42b522dc10fc3574dcb7a0a62ad3548e207785c647737192059c0193dd80420891d7e9ab0e96ae13f66c18f0edee94bd29b211139c6457b6
+  data.tar.gz: 9da38615d6276c0c886ab89396da5e0dcf776eefe8ed8e369d439ce38af3113d477c39dee6482c28d6110a9f4e880aa0c3f4b0a704140ed419ea66a83f06b410

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

@@ -5,20 +5,21 @@ module Trailblazer
     module Activities
       class PrepareAdapter < Trailblazer::Activity::Railway
         def set_adapter(ctx, **)
-          ctx[:adapter] = ctx.dig(:config, :adapter) || "Basic"
+          ctx[:adapter] = ctx[:config].adapter
         end
 
         def validate_adapter(_ctx, adapter:, **)
-          (ORM_ADAPTERS + ["Basic"]).include? adapter.to_s
+          ORM_ADAPTERS.(adapter.to_s)
         end
 
-        def invalid?((ctx, _flow_options), **_circuit_options)
+        def invalid?(_e, (ctx, _flow_options), **_circuit_options)
           (ctx[:errors] ||= []) << {adapter: "The specified adapter are invalid"}
         end
 
         step :set_adapter
-        step :validate_adapter
-        fail :invalid?
+        step Rescue(Dry::Types::ConstraintError, handler: :invalid?) {
+          step :validate_adapter
+        }
       end
     end
   end

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

@@ -4,16 +4,16 @@ module Trailblazer
   class Finder
     module Activities
       class PrepareEntity < Trailblazer::Activity::Railway
-        def validate_entity(ctx, **)
-          ctx.dig(:options, :entity) || ctx.dig(:config, :entity)
+        def validate_entity(ctx, config:, **)
+          ctx.dig(:options, :entity) || config.entity
         end
 
         def invalid_entity_error(ctx, **)
           (ctx[:errors] ||= []) << {entity: "Invalid entity specified"}
         end
 
-        def set_entity(ctx, **)
-          ctx[:entity] = ctx.dig(:options, :entity) || instance_eval(&ctx[:config][:entity])
+        def set_entity(ctx, config:, **)
+          ctx[:entity] = ctx.dig(:options, :entity)  || instance_eval(&config.entity)
         end
 
         step :validate_entity

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

@@ -4,8 +4,8 @@ module Trailblazer
   class Finder
     module Activities
       class PrepareFilters < Trailblazer::Activity::Railway
-        def validate_filters(ctx, **)
-          filters = ctx.dig(:config, :filters)
+        def validate_filters(_ctx, config:, **)
+          filters = config.filters
           filters.each do |key, _value|
             return false if !filters[key][:with].nil? && !filters[key][:with].is_a?(Symbol)
           end
@@ -16,8 +16,8 @@ module Trailblazer
           (ctx[:errors] ||= []) << {filters: "One or more filters are missing a with method definition"}
         end
 
-        def set_filters(ctx, **)
-          ctx[:filters] = ctx[:config][:filters]
+        def set_filters(ctx, config:, **)
+          ctx[:filters] = config.filters
         end
 
         step :validate_filters

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

@@ -4,15 +4,15 @@ module Trailblazer
   class Finder
     module Activities
       class PreparePaging < Trailblazer::Activity::Railway
-        def check_paging(ctx, **)
-          paging = ctx[:config][:paging] || nil
-          return false if ctx[:config][:paging].empty? || paging.nil?
+        def check_paging(_ctx, config:, **)
+          paging = config.paging
+          return false if config.paging.empty? || paging.nil?
 
           true
         end
 
-        def set_paging(ctx, **)
-          ctx[:paging] = ctx.dig(:config, :paging) || {}
+        def set_paging(ctx, config:, **)
+          ctx[:paging] = config.paging
           ctx[:paging][:current_page] = ctx.dig(:params, :page) || 1
           return true unless ctx[:params][:per_page]
 

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

@@ -4,8 +4,8 @@ module Trailblazer
   class Finder
     module Activities
       class PrepareProperties < Trailblazer::Activity::Railway
-        def check_property_types(ctx, **)
-          properties = ctx[:config][:properties] || {}
+        def check_property_types(_ctx, config:, **)
+          properties = config.properties
           return true if properties.empty?
 
           properties.each do |key, _value|
@@ -13,8 +13,8 @@ module Trailblazer
           end
         end
 
-        def validate_property_types(ctx, **)
-          properties = ctx[:config][:properties] || {}
+        def validate_property_types(_ctx, config:, **)
+          properties = config.properties
           return true if properties.empty?
 
           properties.each do |key, _value|
@@ -26,8 +26,8 @@ module Trailblazer
           (ctx[:errors] ||= []) << {properties: "One or more properties are missing a valid type"}
         end
 
-        def set_properties(ctx, **)
-          ctx[:properties] = ctx[:config][:properties]
+        def set_properties(ctx, config:, **)
+          ctx[:properties] = config.properties
         end
 
         step :check_property_types

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

@@ -4,20 +4,20 @@ module Trailblazer
   class Finder
     module Activities
       class PrepareSorting < Trailblazer::Activity::Railway
-        def check_sorting(ctx, **)
-          sorting = ctx[:config][:sorting] || nil
-          return true unless ctx[:config][:sorting].empty? || sorting.nil?
+        def check_sorting(_ctx, config:, **)
+          sorting = config.sorting
+          return true unless sorting.empty? || sorting.nil?
         end
 
-        def set_sorting(ctx, **)
+        def set_sorting(ctx, config:, **)
           return true if ctx[:params][:sort].nil?
 
           sorting = ctx[:params][:sort]
-          config = ctx[:config][:sorting]
+          sorting_config = config.sorting
           ctx[:sorting] = ctx[:sorting] || {}
           sorting.split(",").each do |sorter|
             spt = sorter.split
-            ctx[:sorting][spt[0]] = fetch_sort_direction(config[spt[0].to_sym], spt[1]) if config.include?(spt[0].to_sym)
+            ctx[:sorting][spt[0]] = fetch_sort_direction(sorting_config[spt[0].to_sym], spt[1]) if sorting_config.include?(spt[0].to_sym)
           end
         end
 

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

@@ -15,10 +15,10 @@ module Trailblazer
         end
 
         def set_paginator(ctx, **)
-          paginator = ctx.dig(:config, :paginator)
+          paginator = ctx[:config].paginator
           return true unless paginator
-          return false unless ORM_ADAPTERS.include?(ctx[:orm][:adapter])
-          return false unless PAGING_ADAPTERS.include?(paginator)
+          return false unless EXT_ORM_ADAPTERS.(ctx[:orm][:adapter])
+          return false unless PAGING_ADAPTERS.(paginator)
 
           ctx[:orm][:paging] = "Trailblazer::Finder::Adapters::#{paginator}::Paging"
           true
@@ -26,16 +26,19 @@ module Trailblazer
 
         def invalid_paginator_error(ctx, **)
           (ctx[:errors] ||= []) << {
-            paginator: "Can't use paginator #{ctx.dig(
-              :config,
-              :paginator
-            )} without using an ORM like ActiveRecord or Sequel"
+            paginator: "Can't use paginator #{ctx[:config].paginator} without using an ORM like ActiveRecord or Sequel"
           }
         end
 
+        def invalid_paginator_handler(_e, (ctx, _flow_options), **)
+          invalid_paginator_error(ctx)
+        end
+
         step :set_adapter, fast_track: true
-        step :set_paginator
-        fail :invalid_paginator_error
+        step Rescue(Dry::Types::ConstraintError, handler: :invalid_paginator_handler) {
+          step :set_paginator
+          fail :invalid_paginator_error
+        }
       end
     end
   end

data/lib/trailblazer/finder/base.rb

@@ -2,8 +2,6 @@
 
 module Trailblazer
   class Finder
-    ORM_ADAPTERS = %w[ActiveRecord Sequel].freeze
-    PAGING_ADAPTERS = %w[Kaminari WillPaginate].freeze
 
     module Base
       def self.included(base)

data/lib/trailblazer/finder/dsl.rb

@@ -1,59 +1,95 @@
-# frozen_string_literal: true
-
 module Trailblazer
   class Finder
+    class Configuration
+      attr_accessor :entity, :paging, :properties, :sorting,
+                    :filters, :adapter, :paginator
+
+      def initialize
+        @paging = {}
+        @properties = {}
+        @sorting = {}
+        @filters = {}
+        @paginator = nil
+        @adapter = "Basic"
+      end
+
+      def clone
+        new_config = Configuration.new
+        new_config.entity = entity
+        new_config.paging = paging.clone
+        new_config.properties = properties.clone
+        new_config.sorting = sorting.clone
+        new_config.filters = filters.clone
+        new_config.adapter = adapter
+        new_config.paginator = paginator
+        new_config
+      end
+    end
+
     module Dsl
-      attr_reader :config
+      def config
+        @config ||= Configuration.new
+      end
+
 
       def inherited(base)
-        base.instance_variable_set "@config", apply_config({})
+        ## We don't want to inherit the config from Trailblazer::Finder
+        return if name == 'Trailblazer::Finder'
+
+        base.config = config.clone
       end
 
       def entity(&block)
-        config[:entity] = block
+        config.entity = block
       end
 
-      def paging(**options)
-        config[:paging][:per_page] = options[:per_page] || 25
-        config[:paging][:min_per_page] = options[:min_per_page] || 10
-        config[:paging][:max_per_page] = options[:max_per_page] || 100
+      def paging(per_page: 25, min_per_page: 10, max_per_page: 100)
+        config.paging[:per_page] = per_page
+        config.paging[:min_per_page] = min_per_page
+        config.paging[:max_per_page] = max_per_page
       end
 
       def property(name, options = {})
-        config[:properties][name] = options
-        config[:properties][name][:type] = options[:type] || Types::String
-        config[:sorting][name] = options[:sort_direction] || :desc if options[:sortable]
+        config.properties[name] = options
+        config.properties[name][:type] = options[:type] || Types::String
+        config.sorting[name] = options[:sort_direction] || :desc if options[:sortable]
       end
 
       def filter_by(name, options = {}, &block)
         filter_name = name.to_sym
-        config[:filters][filter_name] = {}
-        config[:filters][filter_name][:name] = name
-        config[:filters][filter_name][:with] = options[:with] if options.include?(:with)
-        config[:filters][filter_name][:block] = block || nil
+        config.filters[filter_name] = {}
+        config.filters[filter_name][:name] = name
+        config.filters[filter_name][:with] = options[:with] if options.include?(:with)
+        config.filters[filter_name][:block] = block || nil
+      end
+
+      def adapter(adapter_name)
+        config.adapter = adapter_name.to_s
+      end
+
+      def paginator(paginator_name)
+        config.paginator = paginator_name.to_s
       end
 
-      def adapter(adapter)
-        config[:adapter] = adapter.to_s
+      def current_adapter
+        config.adapter
       end
 
-      def paginator(paginator)
-        config[:paginator] = paginator.to_s
+      def current_paginator
+        config.paginator
       end
 
-      def apply_config(options, **)
-        return @config = options unless options.empty?
+      def filters_count
+        config.filters.count
+      end
 
-        @config = {
-          actions:    {},
-          entity:     nil,
-          properties: {},
-          filters:    {},
-          paging:     {},
-          sorting:    {},
-          adapters:   []
-        }
+      def properties_count
+        config.properties.count
       end
+
+      protected
+
+      attr_writer :config
     end
   end
 end

data/lib/trailblazer/finder/version.rb

@@ -2,6 +2,6 @@
 
 module Trailblazer
   class Finder
-    VERSION = "0.90.0"
+    VERSION = "0.92.0"
   end
 end

data/lib/trailblazer/finder.rb

@@ -5,37 +5,40 @@ require "trailblazer"
 require "dry-types"
 require "ostruct"
 
-require "trailblazer/finder/utils/array"
-require "trailblazer/finder/utils/hash"
-require "trailblazer/finder/utils/string"
-require "trailblazer/finder/utils/splitter"
-require "trailblazer/finder/utils/extra"
-require "trailblazer/finder/adapters/active_record/predicates"
-require "trailblazer/finder/adapters/active_record/paging"
-require "trailblazer/finder/adapters/active_record/sorting"
-require "trailblazer/finder/adapters/kaminari/paging"
-require "trailblazer/finder/adapters/will_paginate/paging"
-require "trailblazer/finder/adapters/sequel/predicates"
-require "trailblazer/finder/adapters/sequel/paging"
-require "trailblazer/finder/adapters/sequel/sorting"
-require "trailblazer/finder/adapters/basic/predicates"
-require "trailblazer/finder/adapters/basic/paging"
-require "trailblazer/finder/adapters/basic/sorting"
-require "trailblazer/finder/activities/prepare"
-require "trailblazer/finder/activities/process"
-require "trailblazer/finder/activities/find"
-require "trailblazer/finder/helpers/basic"
-require "trailblazer/finder/helpers/sorting"
-require "trailblazer/finder/dsl"
-require "trailblazer/finder/find"
-require "trailblazer/finder/base"
-require "trailblazer/operation/finder"
+require_relative "finder/utils/array"
+require_relative "finder/utils/hash"
+require_relative "finder/utils/string"
+require_relative "finder/utils/splitter"
+require_relative "finder/utils/extra"
+require_relative "finder/adapters/active_record/predicates"
+require_relative "finder/adapters/active_record/paging"
+require_relative "finder/adapters/active_record/sorting"
+require_relative "finder/adapters/kaminari/paging"
+require_relative "finder/adapters/will_paginate/paging"
+require_relative "finder/adapters/sequel/predicates"
+require_relative "finder/adapters/sequel/paging"
+require_relative "finder/adapters/sequel/sorting"
+require_relative "finder/adapters/basic/predicates"
+require_relative "finder/adapters/basic/paging"
+require_relative "finder/adapters/basic/sorting"
+require_relative "finder/activities/prepare"
+require_relative "finder/activities/process"
+require_relative "finder/activities/find"
+require_relative "finder/helpers/basic"
+require_relative "finder/helpers/sorting"
+require_relative "finder/dsl"
+require_relative "finder/find"
+require_relative "finder/base"
+require_relative "operation/finder"
 
 module Trailblazer
   class Finder
     module Types
       include Dry.Types(default: :nominal)
     end
+    EXT_ORM_ADAPTERS = Types::Strict::String.enum("ActiveRecord", "Sequel")
+    ORM_ADAPTERS = EXT_ORM_ADAPTERS | Types::Strict::String.enum("Basic")
+    PAGING_ADAPTERS = Types::Strict::String.enum("Kaminari", "WillPaginate")
 
     include Base
   end

data/lib/trailblazer/operation/finder.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   class Operation
     def self.Finder(finder_class, action = nil, entity = nil)
-      task = Trailblazer::Activity::TaskBuilder::Binary(Finder.new)
+      task = Trailblazer::Activity::Circuit::TaskAdapter.for_step(Finder.new, binary: true)
       injections = [
         :params,
         {:"finder.class" => ->(*) { finder_class }},

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-finder
 version: !ruby/object:Gem::Version
-  version: 0.90.0
+  version: 0.92.0
 platform: ruby
 authors:
 - Nick Sutterer
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -111,21 +111,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: maxitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -139,21 +125,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-mocks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -167,7 +139,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -181,21 +153,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sequel
+  name: trailblazer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: trailblazer-developer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -209,21 +181,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: trailblazer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: trailblazer-developer
+  name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -237,7 +195,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: will_paginate
+  name: minitest-trailblazer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -298,11 +256,11 @@ files:
 - lib/trailblazer/finder/utils/string.rb
 - lib/trailblazer/finder/version.rb
 - lib/trailblazer/operation/finder.rb
-- trailblazer-finder.gemspec
-homepage: http://trailblazer.to
+homepage: https://trailblazer.to
 licenses:
 - LGPL-3.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -318,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Trailblazer based finder objects. It is designed to be used on its own as

data/trailblazer-finder.gemspec

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "trailblazer/finder/version"
-
-Gem::Specification.new do |spec|
-  spec.name           = "trailblazer-finder"
-  spec.version        = Trailblazer::Finder::VERSION
-  spec.description    = "Trailblazer Finder Objects"
-  spec.summary        = "Trailblazer based finder objects. It is designed to be used on its own as a separate gem. It was influenced by popular Ransack gem, but in addition to ActiveRecord, it can be used with Sequel, Hash objects, and RomRB."
-  spec.authors        = ["Nick Sutterer", "Marc Tich", "Abdelkader Boudih"]
-  spec.email          = %w[apotonick@gmail.com marc@mudsu.com terminale@gmail.com]
-  spec.homepage       = "http://trailblazer.to"
-  spec.license        = "LGPL-3.0"
-  spec.files          = Dir.glob("lib/**/*")
-  spec.files << ["trailblazer-finder.gemspec"]
-  spec.test_files     = spec.files.grep(%r{^(test)/})
-  spec.require_paths  = ["lib"]
-
-  spec.add_dependency "dry-types", ">= 1.0.0"
-  spec.add_dependency "trailblazer-activity", ">= 0.13.0"
-
-  spec.add_development_dependency "activerecord"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "kaminari"
-  spec.add_development_dependency "kaminari-activerecord"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.5"
-  spec.add_development_dependency "rspec_junit_formatter"
-  spec.add_development_dependency "rspec-mocks", "~> 3.5"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "rubocop-rspec"
-  spec.add_development_dependency "sequel"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "trailblazer", "~> 2.1.0"
-  spec.add_development_dependency "trailblazer-developer"
-  spec.add_development_dependency "will_paginate"
-
-  spec.required_ruby_version = ">= 2.5.0"
-end