trailblazer-activity-dsl-linear 0.3.5 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d438f16110a2a03d05d08edfb0e74be8d92bd031b61818d0c6a87cbe500a9d0
-  data.tar.gz: e4f769408c024853dee3c6b1f8a57a1e2276848c8d7e7e4a35d4e5174f8ffaf5
+  metadata.gz: 9953750b2e208755037a9f48a7847edc3a3ccdf54bd4ab121be8e8666b85e41f
+  data.tar.gz: 1d36eeb6036cf7a7a8fc234c78ccf90507de7f3f380a6a3fd92f432e1efe246f
 SHA512:
-  metadata.gz: 0c0df72aa24b1d7e93767d968d55a16c2f2193fd2819175a28822a5a178e0abb364768bac09a30bb41801b94084c9f44f2ea1fe0356db5a5d33b56f92c572430
-  data.tar.gz: 88b45c45f818435b8484a1aec585a397df887fc8174bdc8e57d7993e905100025bb26642bfae3efdd83b8a5075a439ad11ea59270b6f9c8c6c1246a673c63c12
+  metadata.gz: d50d156f2daed3fccf7c78d978896e4a94d5cf6ef854f9e77ace7186700703c45c1aed21a551b27f0343d4d0ed33694958be936fc6a5651505cf6b368052dd83
+  data.tar.gz: 2b53f6d85d4e0e65407cb90c82ce34be3c55e3ba6b1dfdb25ae64a04be5d19617410c91da532f09cb2ed6058eb7e28e18e11bc3e68d5f83b197ef0792d3e2b15

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.5, 2.6, 2.7, '3.0', head, jruby, jruby-head]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/CHANGES.md

@@ -1,3 +1,20 @@
+# 0.4.3
+
+* Limit `trailblazer-activity` dependency to `< 0.13.0`.
+
+# 0.4.2
+
+* Don't allow duplicate activities in Sequence (#47) :ghost:
+* {:inherit} will only inherit the wirings supported in child activity (#48)
+
+# 0.4.1
+
+* Updrading `trailblazer-activity` to use shiny `trailblazer-option`.
+
+# 0.4.0
+
+* Support for Ruby 3.0.
+
 # 0.3.5
 
 * Retain custom wirings within subprocess while patching.

data/Gemfile

@@ -5,7 +5,8 @@ gemspec
 
 gem "minitest-line"
 
-# gem "trailblazer-context", path: "../trailblazer-context"
+gem "rubocop", require: false
+
 # gem "trailblazer-developer", path: "../trailblazer-developer"
 # gem "trailblazer-activity", path: "../trailblazer-activity"
 # gem "trailblazer-activity", path: "../circuit"

data/lib/trailblazer/activity/dsl/linear/compiler.rb

@@ -19,7 +19,7 @@ module Trailblazer
           def call(sequence, find_stops: method(:find_stop_task_ids), find_start: method(:find_start_task_ids))
             _implementations, intermediate_wiring =
               sequence.inject([[], []]) do |(implementations, intermediates), seq_row|
-                magnetic_to, task, connections, data = seq_row
+                _magnetic_to, task, connections, data = seq_row
                 id = data[:id]
 
                 # execute all {Search}s for one sequence row.

data/lib/trailblazer/activity/dsl/linear/normalizer.rb

@@ -62,7 +62,7 @@ module Trailblazer
 
                         if task.is_a?(Symbol)
                           # step task: :find, id: :load
-                          { **ctx[:options], id: (id || task), task: Trailblazer::Option( task ) }
+                          { **ctx[:options], id: (id || task), task: Trailblazer::Option(task) }
                         else
                           # step task: Callable, ... (Subprocess, Proc, macros etc)
                           ctx[:options] # NOOP
@@ -196,7 +196,7 @@ module Trailblazer
           def add_end(end_event, magnetic_to:, id:)
 
             options = Path::DSL.append_end_options(task: end_event, magnetic_to: magnetic_to, id: id)
-            row     = Linear::Sequence.create_row(options)
+            row     = Linear::Sequence.create_row(**options)
 
             {
               row:    row,
@@ -224,7 +224,7 @@ module Trailblazer
           end
 
           def input_output_dsl((ctx, flow_options), *)
-            config = ctx.select { |k,v| [:input, :output].include?(k) } # TODO: optimize this, we don't have to go through the entire hash.
+            config = ctx.select { |k,v| [:input, :output, :output_with_outer_ctx].include?(k) } # TODO: optimize this, we don't have to go through the entire hash.
 
             return Trailblazer::Activity::Right, [ctx, flow_options] if config.size == 0 # no :input/:output passed.
 
@@ -246,13 +246,21 @@ module Trailblazer
             index = Linear::Insert.find_index(sequence, id)
             row   = sequence[index] # from this row we're inheriting options.
 
-            extensions = (row[3][:extensions]||[]) + (ctx[:extensions]||[]) # FIXME: DEFAULTING, FOR FUCK'S SAKE
+            connections = get_inheritable_connections(ctx, row[3][:connections])
+            extensions  = Array(row[3][:extensions]) + Array(ctx[:extensions])
 
-            ctx = ctx.merge(connections: row[3][:connections], extensions: extensions) # "inherit"
+            ctx = ctx.merge(connections: connections, extensions: extensions) # "inherit"
 
             return Trailblazer::Activity::Right, [ctx, flow_options]
           end
 
+          # return connections from {parent} step which are supported by current step
+          private def get_inheritable_connections(ctx, parent_connections)
+            return parent_connections unless ctx[:outputs]
+
+            parent_connections.slice(*ctx[:outputs].keys)
+          end
+
           # TODO: make this extendable!
           def cleanup_options((ctx, flow_options), *)
             # new_ctx = ctx.reject { |k, v| [:connections, :outputs, :end_id, :step_interface_builder, :failure_end, :track_name, :sequence].include?(k) }

data/lib/trailblazer/activity/dsl/linear/state.rb

@@ -30,7 +30,7 @@ module Trailblazer
           end
 
           def update_sequence(&block)
-            @sequence = yield(to_h)
+            @sequence = yield(**to_h)
           end
 
           def update_options(fields)
@@ -58,7 +58,7 @@ module Trailblazer
             # by the DSL user. This is usually when you call Operation::step.
             def call(name, *args)
               normalizer = @normalizers.fetch(name)
-              signal, (options, _) = normalizer.(*args)
+              _signal, (options, _) = normalizer.(*args)
               options
             end
           end

data/lib/trailblazer/activity/dsl/linear/strategy.rb

@@ -31,7 +31,7 @@ module Trailblazer
               # Compute the sequence rows.
               options = normalizers.(type, normalizer_options: normalizer_options, options: task, user_options: options.merge(sequence: sequence))
 
-              sequence = Activity::DSL::Linear::DSL.apply_adds_from_dsl(sequence, options)
+              sequence = Activity::DSL::Linear::DSL.apply_adds_from_dsl(sequence, **options)
             end
           end
 
@@ -98,10 +98,10 @@ module Trailblazer
           end
 
           # Injects {:exec_context} so that {:instance_method}s work.
-          def call(args, circuit_options={})
+          def call(args, **circuit_options)
             @activity.(
               args,
-              circuit_options.merge(exec_context: new)
+              **circuit_options.merge(exec_context: new)
             )
           end
 

data/lib/trailblazer/activity/dsl/linear/variable_mapping.rb

@@ -4,15 +4,17 @@ module Trailblazer
       module Linear
         # Normalizer-steps to implement {:input} and {:output}
         # Returns an Extension instance to be thrown into the `step` DSL arguments.
-        def self.VariableMapping(input:  VariableMapping.default_input, output: VariableMapping.default_output)
+        def self.VariableMapping(input: VariableMapping.default_input, output: VariableMapping.default_output, output_with_outer_ctx: false)
           input =
             VariableMapping::Input::Scoped.new(
-              Trailblazer::Option::KW( VariableMapping::filter_for(input) )
+              Trailblazer::Option(VariableMapping::filter_for(input))
             )
 
+          unscope_class = output_with_outer_ctx ? VariableMapping::Output::Unscoped::WithOuterContext : VariableMapping::Output::Unscoped
+
           output =
-            VariableMapping::Output::Unscoped.new(
-              Trailblazer::Option::KW( VariableMapping::filter_for(output) )
+            unscope_class.new(
+              Trailblazer::Option(VariableMapping::filter_for(output))
             )
 
           TaskWrap::Extension(
@@ -36,6 +38,7 @@ module Trailblazer
             ->(ctx, **) { ctx }
           end
 
+          # Returns a filter proc to be called in an Option.
           # @private
           def filter_for(filter)
             if filter.is_a?(::Array) || filter.is_a?(::Hash)
@@ -45,13 +48,24 @@ module Trailblazer
             end
           end
 
+          # @private
+          def output_option_for(option, pass_outer_ctx) # DISCUSS: not sure I like this.
+
+            return option if pass_outer_ctx
+            # OutputReceivingInnerCtxOnly =
+
+             # don't pass {outer_ctx}, only {inner_ctx}. this is the default.
+            return ->(inner_ctx, outer_ctx, **kws) { option.(inner_ctx, **kws) }
+          end
+
+
           module DSL
             # The returned filter compiles a new hash for Scoped/Unscoped that only contains
             # the desired i/o variables.
             def self.filter_from_dsl(map)
               hsh = DSL.hash_for(map)
 
-              ->(incoming_ctx, kwargs) { Hash[hsh.collect { |from_name, to_name| [to_name, incoming_ctx[from_name]] }] }
+              ->(incoming_ctx, **kwargs) { Hash[hsh.collect { |from_name, to_name| [to_name, incoming_ctx[from_name]] }] }
             end
 
             def self.hash_for(ary)
@@ -60,7 +74,6 @@ module Trailblazer
             end
           end
 
-
           module Input
             class Scoped
               def initialize(filter)
@@ -69,7 +82,7 @@ module Trailblazer
 
               def call((original_ctx, flow_options), **circuit_options)
                 Trailblazer::Context(
-                  @filter.(original_ctx, **circuit_options),
+                  @filter.(original_ctx, keyword_arguments: original_ctx.to_hash, **circuit_options),
                   {},
                   flow_options[:context_options]
                 )
@@ -87,9 +100,21 @@ module Trailblazer
 
               def call(new_ctx, (original_ctx, flow_options), **circuit_options)
                 original_ctx.merge(
-                  @filter.(new_ctx, **circuit_options)
+                  call_filter(new_ctx, [original_ctx, flow_options], **circuit_options)
                 )
               end
+
+              def call_filter(new_ctx, (original_ctx, flow_options), **circuit_options)
+                # Pass {inner_ctx, **inner_ctx}
+                @filter.(new_ctx, keyword_arguments: new_ctx.to_hash, **circuit_options)
+              end
+
+              class WithOuterContext < Unscoped
+                def call_filter(new_ctx, (original_ctx, flow_options), **circuit_options)
+                  # Pass {inner_ctx, outer_ctx, **inner_ctx}
+                  @filter.(new_ctx, original_ctx, keyword_arguments: new_ctx.to_hash, **circuit_options)
+                end
+              end
             end
           end
         end # VariableMapping

data/lib/trailblazer/activity/dsl/linear/version.rb

@@ -3,7 +3,7 @@ module Trailblazer
     module Activity
       module DSL
         module Linear
-          VERSION = "0.3.5"
+          VERSION = "0.4.3"
         end
       end
     end

data/lib/trailblazer/activity/dsl/linear.rb

@@ -99,7 +99,7 @@ class Trailblazer::Activity
 
         # @private
         def find_in_range(range, target_color)
-          target_seq_row = range.find { |seq_row| seq_row[0] == target_color }
+          _target_seq_row = range.find { |seq_row| seq_row[0] == target_color }
         end
       end # Search
 
@@ -152,7 +152,7 @@ class Trailblazer::Activity
       def Merge(old_seq, new_seq, end_id: "End.success") # DISCUSS: also Insert
         new_seq = strip_start_and_ends(new_seq, end_id: end_id)
 
-        seq = Insert.Prepend(old_seq, new_seq, end_id)
+        _seq = Insert.Prepend(old_seq, new_seq, end_id)
       end
       def strip_start_and_ends(seq, end_id:) # TODO: introduce Merge namespace?
         cut_off_index = end_id.nil? ? seq.size : Insert.find_index(seq, end_id) # find the "first" end.
@@ -170,14 +170,14 @@ class Trailblazer::Activity
           new_row = Sequence.create_row(**options)
 
           # {sequence_insert} is usually a function such as {Linear::Insert::Append} and its arguments.
-          seq = Sequence.insert_row(sequence, row: new_row, insert: sequence_insert)
+          _seq = Sequence.insert_row(sequence, row: new_row, insert: sequence_insert)
         end
 
         # Add one or several rows to the {sequence}.
         # This is usually called from DSL methods such as {step}.
         def apply_adds_from_dsl(sequence, sequence_insert:, adds:, **options)
           # This is the ADDS for the actual task.
-          task_add = {row: Sequence.create_row(options), insert: sequence_insert} # Linear::Insert.method(:Prepend), end_id
+          task_add = {row: Sequence.create_row(**options), insert: sequence_insert} # Linear::Insert.method(:Prepend), end_id
 
           Sequence.apply_adds(sequence, [task_add] + adds)
         end

data/lib/trailblazer/activity/fast_track.rb

@@ -2,7 +2,7 @@ module Trailblazer
   class Activity
     def self.FastTrack(options)
       Class.new(FastTrack) do
-        initialize!(Railway::DSL::State.new(FastTrack::DSL.OptionsForState(options)))
+        initialize!(Railway::DSL::State.new(**FastTrack::DSL.OptionsForState(**options)))
       end
     end
 
@@ -130,8 +130,6 @@ module Trailblazer
           sequence = Path::DSL.append_end(sequence, task: pass_fast_end, magnetic_to: :pass_fast, id: "End.pass_fast")
         end
 
-
-
         # This is slow and should be done only once at compile-time,
         # DISCUSS: maybe make this a function?
         # These are the normalizers for an {Activity}, to be injected into a State.
@@ -142,7 +140,7 @@ module Trailblazer
         )
 
         def self.OptionsForState(normalizers: Normalizers, **options)
-          options = Railway::DSL.OptionsForState(options).
+          options = Railway::DSL.OptionsForState(**options).
               merge(normalizers: normalizers)
 
           initial_sequence = FastTrack::DSL.initial_sequence(**options)
@@ -167,7 +165,7 @@ module Trailblazer
       include Activity::DSL::Linear::Helper
       extend Activity::DSL::Linear::Strategy
 
-      initialize!(Railway::DSL::State.new(DSL.OptionsForState()))
+      initialize!(Railway::DSL::State.new(**DSL.OptionsForState()))
 
     end # FastTrack
   end

data/lib/trailblazer/activity/path.rb

@@ -17,7 +17,7 @@ module Trailblazer
         def start_sequence(track_name:)
           start_default = Activity::Start.new(semantic: :default)
           start_event   = Linear::Sequence.create_row(task: start_default, id: "Start.default", magnetic_to: nil, wirings: [Linear::Search::Forward(unary_outputs[:success], track_name)])
-          sequence      = Linear::Sequence[start_event]
+          _sequence      = Linear::Sequence[start_event]
         end
 
         # DISCUSS: still not sure this should sit here.
@@ -81,12 +81,27 @@ module Trailblazer
           }
         end
 
+        def normalize_duplications((ctx, flow_options), *)
+          return Right, [ctx, flow_options] if ctx[:replace]
+
+          signal, (ctx, flow_options) = raise_on_duplicate_id([ctx, flow_options])
+          signal, (ctx, flow_options) = clone_duplicate_activity([ctx, flow_options])
+
+          return signal, [ctx, flow_options]
+        end
+
         def raise_on_duplicate_id((ctx, flow_options), *)
-          id, sequence, insert = ctx[:id], ctx[:sequence], ctx[:sequence_insert][0] # DISCUSS: should we use Replace here or rather the option(s)?
+          id, sequence = ctx[:id], ctx[:sequence]
+          raise "ID #{id} is already taken. Please specify an `:id`." if sequence.find { |row| row[3][:id] == id }
 
-          if insert != Linear::Insert.method(:Replace)
-            raise "ID #{id} is already taken. Please specify an `:id`." if sequence.find { |row| row[3][:id] == id }
-          end
+          return Right, [ctx, flow_options]
+        end
+
+        def clone_duplicate_activity((ctx, flow_options), *)
+          return Right, [ctx, flow_options] unless ctx[:task].is_a?(Class)
+
+          task, sequence = ctx[:task], ctx[:sequence]
+          ctx = ctx.merge(task: task.clone) if sequence.find { |row| row[1] == task }
 
           return Right, [ctx, flow_options]
         end
@@ -104,12 +119,12 @@ module Trailblazer
           prepend_to_path(
             sequence,
 
-            "path.outputs"          => method(:merge_path_outputs),
-            "path.connections"      => method(:merge_path_connections),
-            "path.sequence_insert"  => method(:normalize_sequence_insert),
-            "path.raise_on_duplicate_id"  => method(:raise_on_duplicate_id),
-            "path.magnetic_to"      => method(:normalize_magnetic_to),
-            "path.wirings"          => Linear::Normalizer.method(:compile_wirings),
+            "path.outputs"                => method(:merge_path_outputs),
+            "path.connections"            => method(:merge_path_connections),
+            "path.sequence_insert"        => method(:normalize_sequence_insert),
+            "path.normalize_duplications" => method(:normalize_duplications),
+            "path.magnetic_to"            => method(:normalize_magnetic_to),
+            "path.wirings"                => Linear::Normalizer.method(:compile_wirings),
           )
         end
 
@@ -121,7 +136,7 @@ module Trailblazer
         end
 
         def append_end(sequence, **options)
-          sequence = Linear::DSL.insert_task(sequence, **append_end_options(options))
+          sequence = Linear::DSL.insert_task(sequence, **append_end_options(**options))
         end
 
         def append_end_options(task:, magnetic_to:, id:, append_to: "End.success")
@@ -171,7 +186,7 @@ module Trailblazer
         #   Path() do  ... end
         class State < Linear::State
           def step(*args)
-            seq = Linear::Strategy.task_for!(self, :step, *args) # mutate @state
+            _seq = Linear::Strategy.task_for!(self, :step, *args) # mutate @state
           end
         end
 
@@ -180,12 +195,12 @@ module Trailblazer
       include DSL::Linear::Helper
       extend DSL::Linear::Strategy
 
-      initialize!(Path::DSL::State.new(DSL.OptionsForState()))
+      initialize!(Path::DSL::State.new(**DSL.OptionsForState()))
     end # Path
 
     def self.Path(options)
       Class.new(Path) do
-        initialize!(Path::DSL::State.new(Path::DSL.OptionsForState(options)))
+        initialize!(Path::DSL::State.new(**Path::DSL.OptionsForState(**options)))
       end
     end
   end

data/lib/trailblazer/activity/railway.rb

@@ -135,7 +135,7 @@ module Trailblazer
         )
 
         def self.OptionsForState(normalizers: Normalizers, failure_end: Activity::End.new(semantic: :failure), **options)
-          options = Path::DSL.OptionsForState(options).
+          options = Path::DSL.OptionsForState(**options).
             merge(normalizers: normalizers, failure_end: failure_end)
 
           initial_sequence = Railway::DSL.initial_sequence(failure_end: failure_end, **options)
@@ -161,13 +161,13 @@ module Trailblazer
       include DSL::Linear::Helper
       extend DSL::Linear::Strategy
 
-      initialize!(Railway::DSL::State.new(DSL.OptionsForState()))
+      initialize!(Railway::DSL::State.new(**DSL.OptionsForState()))
 
     end # Railway
 
     def self.Railway(options)
       Class.new(Railway) do
-        initialize!(Railway::DSL::State.new(Railway::DSL.OptionsForState(options)))
+        initialize!(Railway::DSL::State.new(**Railway::DSL.OptionsForState(**options)))
       end
     end
   end

data/trailblazer-activity-dsl-linear.gemspec

@@ -19,12 +19,12 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trailblazer-activity", ">= 0.11.3", "< 1.0.0"
+  spec.add_dependency "trailblazer-activity", ">= 0.12.2", "< 0.13.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "trailblazer-developer", ">= 0.0.3"
+  spec.add_development_dependency "trailblazer-developer", ">= 0.0.21"
 
   spec.required_ruby_version = '>= 2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-activity-dsl-linear
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.3
 platform: ruby
 authors:
 - Nick Sutterer
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-activity
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 0.12.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 0.12.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.21
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.21
 description: Simple DSL to define Trailblazer activities with arbitrary wirings.
 email:
 - apotonick@gmail.com
@@ -93,8 +93,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGES.md
 - DSL_IDEAS
 - Gemfile
@@ -118,7 +118,7 @@ homepage: http://trailblazer.to
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -133,8 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.2.3
+signing_key: 
 specification_version: 4
 summary: Simple DSL to define Trailblazer activities.
 test_files: []

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  #- ruby-head
-  - 2.6.6
-  - 2.5.1
-  - 2.4.4
-
-cache: bundler