trailblazer-finder 0.3.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9d592b6bddb7a2a1a4013bce8a5243f2f2bb095a49dbe9107e1196d54d10571
-  data.tar.gz: 025da1c9e5eb3457ecac611a86cba86ae571476a2d5ee7e7e7c22a935531f838
+  metadata.gz: bb1a6d3df9380459d5e21c54c7525b0848e63ef921251d9560d6e51aba373b71
+  data.tar.gz: 9255d7b252793df093f83e4d46a4a3b777011374e75e245c5673a4c9deccc49c
 SHA512:
-  metadata.gz: 40e4ff1dfbd936fad7accb42f6d5496e49494b0772785518967fc75dc63d1328b8b10e5982f5574039361c2cb5fabab60f6b4814f7196fcf7328bc0d168efbfd
-  data.tar.gz: 94b01a12cb4b867900a1a8033761080a6c5494d72587db79fa11f6a2b3bf84778da6c2ae8ef094d067eb11bb84242eea73a8f31e5386544f6eb9c140725e2907
+  metadata.gz: 246da8f4eb7de635a9eb692f03fdafdaae1154a4b2e2e40f647227571e83a6ce366ac4062ae88b177befc50dcdaf94de262f726d1dee9b5f2b756f94ede0097f
+  data.tar.gz: a63b631f720310717e83798cf891bbb8e3fd31f06e545c068942640a277486791d749c1bd47b17f73cc715bda036bf99dc86de2d23d9d5953640243db0091d3e

data/.gitignore

@@ -20,3 +20,5 @@ bitbucket-pipelines.yml
 .byebug_history
 .idea/
 .tool-versions
+*.iml
+.rubocop-https---raw-githubusercontent-com-trailblazer-meta-master-rubocop-yml

data/.travis.yml

@@ -4,7 +4,4 @@ before_install:
   - gem install bundler
 matrix:
   include:
-    - rvm: 2.3.8
-    - rvm: 2.4.6
-    - rvm: 2.5.5
-    - rvm: 2.6.3
+    - rvm: 2.6.5

data/CHANGES.md

@@ -1,3 +1,6 @@
+# 0.10.0
+* Support Trailblazer 2.1.0 wiring api, drop old api
+
 # 0.3.0
 * Change internal context argument to symbols to match trailblazer 2.1 convention.
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Trailblazer GmbH
+Copyright (c) 2020 Trailblazer GmbH
 
 Trailblazer is an Open Source project licensed under the terms of
 the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>

data/README.md

@@ -1,7 +1,3 @@
-# THIS IS MOSTLY OUT OF DATE
-
-# NEW README AND RELEASE COMING NEXT WEEK
-
 # Trailblazer Finder
 
 Provides DSL for creating [Trailblazer](https://github.com/trailblazer/trailblazer) based Finder Objects. But it is designed to be used on its own as a separate gem. It was influenced by popular [Ransack](https://github.com/activerecord-hackery/ransack) gem, but in addition to [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord), it can be used with [DataMapper](https://github.com/datamapper) or [Sequel](https://github.com/jeremyevans/sequel). It also integrates with [Kaminari](https://github.com/kaminari/kaminari) or [Will Paginate](https://github.com/mislav/will_paginate), as well as [FriendlyId](https://github.com/norman/friendly_id)
@@ -431,9 +427,6 @@ class Post::Finder < Trailblazer::Finder
 end
 ```
 
-### Utils / Helpers
-Coming soon
-
 ## Contributing
 1. Fork it
 2. Create your feature branch

data/lib/trailblazer/finder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "forwardable"
-require "trailblazer-activity"
+require "trailblazer"
 require "dry-types"
 require "ostruct"
 
@@ -21,19 +21,7 @@ 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/activity/prepare/entity"
-require "trailblazer/finder/activity/prepare/properties"
-require "trailblazer/finder/activity/prepare/filters"
-require "trailblazer/finder/activity/prepare/params"
-require "trailblazer/finder/activity/prepare/adapters"
-require "trailblazer/finder/activity/prepare/paging"
-require "trailblazer/finder/activity/prepare/sorting"
 require "trailblazer/finder/activity/prepare"
-require "trailblazer/finder/activity/process/adapters"
-require "trailblazer/finder/activity/process/predicates"
-require "trailblazer/finder/activity/process/paging"
-require "trailblazer/finder/activity/process/sorting"
-require "trailblazer/finder/activity/process/filters"
 require "trailblazer/finder/activity/process"
 require "trailblazer/finder/activity/find"
 require "trailblazer/finder/helpers/basic"
@@ -41,15 +29,18 @@ require "trailblazer/finder/helpers/sorting"
 require "trailblazer/finder/dsl"
 require "trailblazer/finder/find"
 require "trailblazer/finder/base"
-
-# :nocov:
-require "trailblazer/operation/finder" if Gem.loaded_specs.key?("trailblazer")
-# :nocov:
+require "trailblazer/operation/finder"
 
 module Trailblazer
   class Finder
+    DRY_TYPES_VERSION = Gem::Version.new(Dry::Types::VERSION)
+    LEGACY_DRY_TYPES = DRY_TYPES_VERSION <= Gem::Version.new('1')
     module Types
-      include Dry::Types.module
+      if LEGACY_DRY_TYPES
+        include Dry::Types.module
+      else
+        include Dry.Types(default: :nominal)
+      end
     end
 
     include Base

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

@@ -4,33 +4,12 @@ module Trailblazer
   class Finder
     module Activity
       # Find Activity
-      module Find
+      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
 
-        extend Trailblazer::Activity::Railway()
 
-        module_function
-
-        def fetch_filters(ctx, result, attribute)
-          filter_attribute = ctx[:filters][attribute]
-          result[:filter] = {}
-          result[:name] = attribute
-          result[:filter][:handler] = filter_attribute[:with] || filter_attribute[:block]
-        end
-
-        def fetch_properties(result, attribute, value, properties)
-          splitter = Utils::Splitter.new attribute, value
-          PREDICATES.each do |predicate|
-            next unless splitter.split_key predicate
-            next unless properties.include?(splitter.field.to_sym)
-
-            result[:name] = splitter.field
-            result[:predicate] = predicate
-          end
-        end
-
-        def process_params(ctx, **)
-          ctx[:params].each do |attribute, value|
+        def process_params(ctx, params:,  **)
+          params.each do |attribute, value|
             result = {}
 
             fetch_filters(ctx, result, attribute) || result if ctx[:filters].include?(attribute)
@@ -47,10 +26,29 @@ module Trailblazer
           ctx[:finder] = Finder::Find.new(ctx[:entity], ctx[:params], ctx[:process], ctx[:paging], ctx[:sorting], ctx[:config])
         end
 
-        step Subprocess(Prepare), id: :prepare_finder
-        step method(:process_params), id: :process_params
-        step Subprocess(Process), id: :process_finder
-        step method(:set_finder), id: :set_finder
+        step Subprocess(Prepare)
+        step :process_params
+        step Subprocess(Process)
+        step :set_finder
+
+        private
+          def fetch_filters(ctx, result, attribute)
+            filter_attribute = ctx[:filters][attribute]
+            result[:filter] = {}
+            result[:name] = attribute
+            result[:filter][:handler] = filter_attribute[:with] || filter_attribute[:block]
+          end
+
+          def fetch_properties(result, attribute, value, properties)
+            splitter = Utils::Splitter.new attribute, value
+            PREDICATES.each do |predicate|
+              next unless splitter.split_key predicate
+              next unless properties.include?(splitter.field.to_sym)
+
+              result[:name] = splitter.field
+              result[:predicate] = predicate
+            end
+          end
       end
     end
   end

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

@@ -1,28 +1,31 @@
 # frozen_string_literal: true
 
+require_relative "prepare_adapters"
+require_relative "prepare_entity"
+require_relative "prepare_properties"
+require_relative "prepare_filters"
+require_relative "prepare_params"
+require_relative "prepare_paging"
+require_relative "prepare_sorting"
+
 module Trailblazer
   class Finder
     module Activity
       # Prepare Activity
-      module Prepare
-        extend Trailblazer::Activity::Railway()
-
-        module_function
-
+      class Prepare < Trailblazer::Activity::Railway
         def clean_ctx((ctx, flow_options), **)
-          # ctx.delete(:config)
           ctx.delete(:options)
           [Trailblazer::Activity::Right, [ctx, flow_options]]
         end
 
-        step Subprocess(Prepare::Adapters), id: :prepare_adapters
-        step Subprocess(Prepare::Entity), id: :prepare_entity
-        step Subprocess(Prepare::Properties), id: :prepare_properties
-        step Subprocess(Prepare::Filters), id: :prepare_filters
-        step Subprocess(Prepare::Params), id: :prepare_params
-        step Subprocess(Prepare::Paging), id: :prepare_paging
-        step Subprocess(Prepare::Sorting), id: :prepare_sorting
-        step method(:clean_ctx), id: :clean_ctx
+        step Subprocess(PrepareAdapters)
+        step Subprocess(PrepareEntity)
+        step Subprocess(PrepareProperties)
+        step Subprocess(PrepareFilters)
+        step Subprocess(PrepareParams)
+        step Subprocess(PreparePaging)
+        step Subprocess(PrepareSorting)
+        step :clean_ctx
       end
     end
   end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Trailblazer
+  class Finder
+    module Activity
+      # 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

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Trailblazer
+  class Finder
+    module Activity
+      class PrepareEntity < Trailblazer::Activity::Railway
+        def validate_entity(ctx, **)
+          ctx.dig(:options,:entity) || ctx.dig(: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])
+        end
+
+        step (:validate_entity)
+        fail (:invalid_entity_error)
+        step (:set_entity)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Trailblazer
+  class Finder
+    module Activity
+      class PreparePaging < Trailblazer::Activity::Railway
+        def check_paging(ctx, **)
+          paging = ctx[:config][:paging] || nil
+          return false if ctx[:config][:paging].empty? || paging.nil?
+
+          true
+        end
+
+        def set_paging(ctx, **)
+          ctx[:paging] = ctx.dig(:config,:paging) || {}
+          ctx[:paging][:current_page] = ctx.dig(:params,:page) || 1
+          return true unless ctx[:params][:per_page]
+
+          ctx[:paging][:per_page] = ctx[:params][:per_page].to_i || ctx[:paging][:per_page]
+          ctx[:paging][:per_page] = ctx[:paging][:max_per_page] if ctx[:paging][:per_page] > ctx[:paging][:max_per_page]
+          ctx[:paging][:per_page] = ctx[:paging][:min_per_page] if ctx[:paging][:per_page] < ctx[:paging][:min_per_page]
+          true
+        end
+
+        def clear_paging(ctx, **)
+          ctx[:params].delete(:page) unless ctx[:params][:page].nil?
+          true
+        end
+
+        step (:check_paging),
+             Output(:failure) => Track(:end_paging)
+        step (:set_paging),
+             Output(:success) => Track(:end_paging),
+             Output(:failure) => Track(:failure)
+        step (:clear_paging),
+             magnetic_to: :end_paging,
+             Output(:success) => Track(:success),
+             Output(:failure) => Track(:failure)
+      end
+    end
+  end
+end

data/lib/trailblazer/finder/activity/prepare_params.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Trailblazer
+  class Finder
+    module Activity
+      # Params Activity
+      class PrepareParams < Trailblazer::Activity::Railway
+        def validate_params(_ctx, **)
+          # Should probably validate some things here at some point
+          true
+        end
+
+        def invalid_params_error(_ctx, **)
+          # (ctx[:errors] ||= []) << {params: "One or more parameters are invalid"}
+        end
+
+        def set_params(ctx, **)
+          ctx[:params] = ctx[:options][:params] || {}
+        end
+
+        step (:validate_params)
+        fail (:invalid_params_error)
+        step (:set_params)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Trailblazer
+  class Finder
+    module Activity
+      class PrepareProperties < Trailblazer::Activity::Railway
+        def check_property_types(ctx, **)
+          properties = ctx[:config][:properties] || {}
+          return true if properties.empty?
+
+          properties.each do |key, _value|
+            return !properties[key][:type].nil?
+          end
+        end
+
+        def validate_property_types(ctx, **)
+          properties = ctx[:config][:properties] || {}
+          return true if properties.empty?
+
+          properties.each do |key, _value|
+            if LEGACY_DRY_TYPES
+              return properties[key][:type].class.ancestors.include?(::Dry::Types::Definition)
+            else
+              return properties[key][:type].class.ancestors.include?(::Dry::Types::Nominal)
+            end
+          end
+        end
+
+        def invalid_properties_error(ctx, **)
+          (ctx[:errors] ||= []) << {properties: "One or more properties are missing a valid type"}
+        end
+
+        def set_properties(ctx, **)
+          ctx[:properties] = ctx[:config][:properties]
+        end
+
+        step :check_property_types
+        step :validate_property_types
+        fail :invalid_properties_error
+        step :set_properties
+      end
+    end
+  end
+end