trailblazer-operation 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e11de8247c38298cb548d31fb21ca138949204da
-  data.tar.gz: fd3a2a39355bc6e064d174e098d542f69e8f0fbc
+  metadata.gz: 7d1a238c8c4bb3a49a8adad7d2ffc709f1f4766d
+  data.tar.gz: d3495a92e3fc1519b7e847ccd8f1ad2ff84d41a7
 SHA512:
-  metadata.gz: 2b65963cfacea4a758ee64ede04d7c67a6e84433503d0278ebf8e163509205c1a75360fad353a76a271eb2392f5bdeecba66faebe6d78438b6c9b9d1eda36834
-  data.tar.gz: e8edfcc04c39863635ee3123e90c9ea1a024240b61b54ea3356906a687c62a4929041949dad345f9e214ef104b4a6060d655d4461ecff637966d73c495e676a5
+  metadata.gz: 2f922d3d9a2ebbe3abdc6eb919cf6c99dbd66ffa990f041ba9a1aea6de1a2c56c5f1c436388978c434017213d6eb370059a03846613a3704a1617615d2168435
+  data.tar.gz: 60eabb5de8f611edc69a9c81003dc78a29c4734ba316e4cdcc6497ba7075ff4c7d1a732dca8660af1c9a327e582bb4c27ccc494820f5495c1b2b93a5fe8022a8

data/CHANGES.md

@@ -14,6 +14,10 @@ lots of work on the DSL specific parts.
 
 params:, rest: ..
 
+## 0.1.2
+
+* Add @mensfeld's "Macaroni" step style for a keyword-only signature for steps.
+
 ## 0.1.0
 
 inspect: failure is << and success is >>

data/Gemfile

@@ -20,5 +20,5 @@ gem "trailblazer-developer", git: "https://github.com/trailblazer/trailblazer-de
 
 # gem "declarative", path: "../declarative"
 
-gem "trailblazer-activity", path: "../circuit"
+# gem "trailblazer-activity", path: "../circuit"
 # gem "trailblazer-activity", git: "https://github.com/trailblazer/trailblazer-activity"

data/lib/trailblazer/operation.rb

@@ -50,7 +50,7 @@ module Trailblazer
           fail_fast_end: Railway::End::FailFast.new(:fail_fast, semantic: :fail_fast),
         }
 
-        @builder, @adds = Activity::Magnetic::Builder::FastTrack.for( Railway::Normalizer, builder_options )
+        @builder, @adds = Activity::Magnetic::Builder::FastTrack.for( build_normalizer.freeze, builder_options )
         @debug          = {}
       end
 
@@ -68,6 +68,12 @@ module Trailblazer
       def __call__(args, circuit_options={})
         @process.( args, circuit_options.merge( exec_context: new ) )
       end
+
+      private
+
+      def build_normalizer
+        Railway::Normalizer.new
+      end
     end
 
     extend Process # make ::call etc. class methods on Operation.

data/lib/trailblazer/operation/railway/macaroni.rb

@@ -0,0 +1,21 @@
+module Trailblazer
+  module Operation::Railway
+    # Call the user's steps with a differing API (inspired by Maciej Mensfeld) that
+    # only receives keyword args. The `options` keyword is the stateful context object
+    #
+    #   def my_step( params:, ** )
+    #   def my_step( params:, options:, ** )
+    module Macaroni
+      def self.call(user_proc)
+        Task.new( Trailblazer::Option.build( Macaroni::Option, user_proc ), user_proc )
+      end
+
+      class Option < Trailblazer::Option
+        # The Option#call! method prepares the arguments.
+        def self.call!(proc, options, *)
+          proc.( **options.to_hash.merge( options: options ) )
+        end
+      end
+    end
+  end
+end

data/lib/trailblazer/operation/railway/normalizer.rb

@@ -5,8 +5,12 @@ module Trailblazer
     # task via {TaskBuilder} in order to translate true/false to `Right` or `Left`.
     #
     # The Normalizer sits in the `@builder`, which receives all DSL calls from the Operation subclass.
-    module Normalizer
-      def self.call(task, options, unknown_options, sequence_options)
+    class Normalizer
+      def initialize(task_builder: TaskBuilder, **options)
+        @task_builder = task_builder
+      end
+
+      def call(task, options, unknown_options, sequence_options)
         wrapped_task, options =
           if task.is_a?(::Hash) # macro.
             [
@@ -17,7 +21,7 @@ module Trailblazer
             Operation::DeprecatedMacro.( *task )
           else # user step
             [
-              TaskBuilder.(task),
+              @task_builder.(task),
               { id: task }.merge(options) # default :id
             ]
           end
@@ -35,28 +39,28 @@ module Trailblazer
       end
 
       # Merge user options over defaults.
-      def self.defaultize(task, options)
+      def defaultize(task, options)
         {
           plus_poles: InitialPlusPoles(),
         }.merge(options)
       end
 
       # Handle the :override option which is specific to Operation.
-      def self.override(task, options, sequence_options)
+      def override(task, options, sequence_options)
         options, locals  = Activity::Magnetic::Builder.normalize(options, [:override])
         sequence_options = sequence_options.merge( replace: options[:id] ) if locals[:override]
 
         return options, locals, sequence_options
       end
 
-      def self.InitialPlusPoles
+      def InitialPlusPoles
         Activity::Magnetic::DSL::PlusPoles.new.merge(
           Activity.Output(Activity::Right, :success) => nil,
           Activity.Output(Activity::Left,  :failure) => nil,
         )
       end
 
-      def self.deprecate_name(options, unknown_options) # TODO remove in 2.2
+      def deprecate_name(options, unknown_options) # TODO remove in 2.2
         unknown_options, deprecated_options = Activity::Magnetic::Builder.normalize(unknown_options, [:name])
 
         options = options.merge( name: deprecated_options[:name] ) if deprecated_options[:name]

data/lib/trailblazer/operation/railway/task_builder.rb

@@ -5,39 +5,33 @@ module Trailblazer
     # Output direction binary: true=>Right, false=>Left.
     # Passes through all subclasses of Direction.~~~~~~~~~~~~~~~~~
     module TaskBuilder
-      class Task < Proc
-        def initialize(source_location, &block)
-          @source_location = source_location
-          super &block
-        end
-
-        def to_s
-          "<Railway::Task{#{@source_location}}>"
-        end
+      def self.call(user_proc)
+        Task.new( Trailblazer::Option::KW( user_proc ), user_proc )
+      end
 
-        def inspect
-          to_s
-        end
+      # Translates the return value of the user step into a valid signal.
+      # Note that it passes through subclasses of {Signal}.
+      def self.binary_direction_for(result, on_true, on_false)
+        result.is_a?(Class) && result < Activity::Signal ? result : (result ? on_true : on_false)
       end
+    end
 
-# TODO: make this class replaceable so @Mensfeld gets his own call style. :trollface:
+    class Task
+      def initialize(task, user_proc)
+        @task      = task
+        @user_proc = user_proc
 
-      def self.call(step, on_true=Activity::Right, on_false=Activity::Left)
-        Task.new step, &->( (options, *args), **circuit_args ) do
-          # Execute the user step with TRB's kw args.
-          result = Trailblazer::Option::KW(step).(options, **circuit_args) # circuit_args contains :exec_context.
+        freeze
+      end
 
-          # Return an appropriate signal which direction to go next.
-          direction = binary_direction_for(result, on_true, on_false)
+      def call( (options, *args), **circuit_args )
+        # Execute the user step with TRB's kw args.
+        result = @task.( options, **circuit_args ) # circuit_args contains :exec_context.
 
-          [ direction, [ options, *args ], **circuit_args ]
-        end
-      end
+        # Return an appropriate signal which direction to go next.
+        direction = TaskBuilder.binary_direction_for( result, Activity::Right, Activity::Left )
 
-      # Translates the return value of the user step into a valid signal.
-      # Note that it passes through subclasses of {Signal}.
-      def self.binary_direction_for(result, on_true, on_false)
-        result.is_a?(Class) && result < Activity::Signal ? result : (result ? on_true : on_false)
+        [ direction, [ options, *args ], **circuit_args ]
       end
     end
   end

data/lib/trailblazer/operation/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   class Operation
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/test/docs/macaroni_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+require "trailblazer/operation/railway/macaroni"
+
+class MacaroniTaskBuilderTest < Minitest::Spec
+  module Memo; end
+
+  class Memo::Create < Trailblazer::Operation
+    Normalizer = Railway::Normalizer.new( task_builder: Railway::Macaroni )
+
+    step :create_model, normalizer: Normalizer
+    step :save,         normalizer: Normalizer
+
+    def create_model(params:, options:, **)
+      options[:model] = params[:title]
+    end
+
+    def save(model:, **)
+      model.reverse!
+    end
+  end
+
+  it "allows optional macaroni call style" do
+    Memo::Create.( params: { title: "Wow!" } ).inspect(:model).must_equal %{<Result:true ["!woW"] >}
+  end
+end

data/trailblazer-operation.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trailblazer-activity", ">= 0.3.0", "< 0.4.0"
+  spec.add_dependency "trailblazer-activity", ">= 0.3.1", "< 0.4.0"
   spec.add_dependency "trailblazer-context", ">= 0.1.1", "< 0.3.0"
 
   spec.add_development_dependency "bundler"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-operation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nick Sutterer
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.4.0
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.4.0
@@ -112,6 +112,7 @@ files:
 - lib/trailblazer/operation/public_call.rb
 - lib/trailblazer/operation/railway.rb
 - lib/trailblazer/operation/railway/fast_track.rb
+- lib/trailblazer/operation/railway/macaroni.rb
 - lib/trailblazer/operation/railway/normalizer.rb
 - lib/trailblazer/operation/railway/task_builder.rb
 - lib/trailblazer/operation/result.rb
@@ -124,6 +125,7 @@ files:
 - test/call_test.rb
 - test/class_dependencies_test.rb
 - test/docs/doormat_test.rb
+- test/docs/macaroni_test.rb
 - test/docs/wiring_test.rb
 - test/dry_container_test.rb
 - test/fast_track_test.rb
@@ -178,6 +180,7 @@ test_files:
 - test/call_test.rb
 - test/class_dependencies_test.rb
 - test/docs/doormat_test.rb
+- test/docs/macaroni_test.rb
 - test/docs/wiring_test.rb
 - test/dry_container_test.rb
 - test/fast_track_test.rb