trailblazer-operation 0.5.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cc08959bec35098c45918f83eba640b3557e77f995864c58d3b1a02f199b946
-  data.tar.gz: f1ce8be398f2156b2b3d5bebf2ee62cf36b4c9e661c9cfc88fbffa9c9f0832ce
+  metadata.gz: b3e5248a8515b6f1255116f82ba2b0fc2836b373dcbe03d38fb5c0b93f94c82a
+  data.tar.gz: 185922dd1990ae902d2ed5fd4639c0d2788913d63036eb71542945b15eb1995c
 SHA512:
-  metadata.gz: 73d31c57d4c5c5e8e35d2f2e4a9da147ce62a4238918bbd8922b5d479918a3ca20dd5437eebe3dcb88f5f0ab97977693f50252676ee312a9759b6201e58e0447
-  data.tar.gz: 110a6eea4813a1c6e22595bd5be9fd6bd0d3bbe4040f938bb0aac92396570a9565b4a7baca44ad50729881627872135b698532045938eccb31a67adab1e0f301
+  metadata.gz: a4f01d8601c8e97e72f1cabb52adabd9371d416472fa1784573aa13cc1252108f2c5a6f12157e7e3379f21cfb7b7ebe2d5f1213813473a6796f05a6652b8cc55
+  data.tar.gz: ff7522a5ec8c73ad8ec76ef2e3f2019309fa2d9f708463c9e6b96a83cc07ac8cc6878714b4f730d4701848b69ceec11a999b65c5576514292f0da1b56c27b41a

data/.gitignore

@@ -15,3 +15,4 @@ test/tmp
 test/version_tmp
 tmp
 /**/*.log
+.rubocop-*yml

data/CHANGES.md

@@ -1,3 +1,23 @@
+## 0.6.3
+
+* Require forwardable module from standard lib.
+
+## 0.6.2
+
+* Fix Trace so it works with Ruby <= 2.4
+
+## 0.6.1
+
+* Reintroduce `ClassDependencies` by leveraging `State.fields`.
+
+## 0.6.0
+
+* Require newest `activity` gem.
+
+## 0.5.3
+
+* New `context` API.
+
 ## 0.5.2
 
 * Use `trailblazer-activity-dsl-linear-0.1.6.`

data/Gemfile

@@ -10,9 +10,8 @@ gem "dry-auto_inject"
 gem "benchmark-ips"
 gem "minitest-line"
 
-gem "trailblazer-developer", path: "../trailblazer-developer"
+# gem "trailblazer-developer", path: "../developer"
 # gem "trailblazer-developer", git: "https://github.com/trailblazer/trailblazer-developer"
-gem "trailblazer-activity", path: "../trailblazer-activity"
-gem "trailblazer-context", path: "../trailblazer-context"
-gem "trailblazer-activity-dsl-linear", path: "../trailblazer-activity-dsl-linear"
+# gem "trailblazer-activity", path: "../trailblazer-activity"
+# gem "trailblazer-activity-dsl-linear", path: "../trailblazer-activity-dsl-linear"
 # gem "trailblazer-activity", github: "trailblazer/trailblazer-activity"

data/README.md

@@ -15,6 +15,6 @@ An operation can be used exaclty like an activity, including nesting, tracing, e
 
 ## Copyright
 
-Copyright (c) 2016 Nick Sutterer <apotonick@gmail.com>
+Copyright (c) 2016-2020 Nick Sutterer <apotonick@gmail.com>
 
 `trailblazer-operation` is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/trailblazer/operation.rb

@@ -1,11 +1,10 @@
+require 'forwardable'
 require "trailblazer/option"
 require "trailblazer/context"
 require "trailblazer/container_chain"
 
-require "trailblazer/activity"
 require "trailblazer/activity/dsl/linear"
 
-
 module Trailblazer
   # DISCUSS: I don't know where else to put this. It's not part of the {Activity} concept
   class Activity
@@ -62,12 +61,15 @@ module Trailblazer
   end
 end
 
+require 'trailblazer/operation/version'
+
 require "trailblazer/operation/class_dependencies"
 require "trailblazer/operation/deprecated_macro" # TODO: remove in 2.2.
 
 require "trailblazer/operation/result"
 require "trailblazer/operation/railway"
 
+require "trailblazer/developer"
 require "trailblazer/operation/trace"
 
 require "trailblazer/operation/railway/macaroni"

data/lib/trailblazer/operation/class_dependencies.rb

@@ -1,25 +1,34 @@
 # Dependencies can be defined on the operation. class level
 class Trailblazer::Operation
-  module Skill
-    # The class-level skill container: Operation::[], ::[]=.
-    module Accessors
-      # :private:
-      def skills
-        @skills ||= {}
-      end
+  # The use of this module is currently not encouraged and it is only here for backward-compatibility.
+  # Instead, please pass dependencies via containers, locals, or macros into the respective steps.
+  module ClassDependencies
+    def [](field)
+      @state.to_h[:fields][field]
+    end
 
-      extend Forwardable
-      def_delegators :skills, :[], :[]=
+    def []=(field, value)
+      options = @state.to_h[:fields].merge(field => value)
+      @state.update_options(options)
+    end
+
+    def options_for_public_call(options, *)
+      ctx = super
+      context_for_fields(class_fields, ctx)
+    end
+
+    private def class_fields
+      @state.to_h[:fields]
+    end
+
+    private def context_for_fields(fields, ctx)
+      ctx_with_fields = Trailblazer::Context.implementation.build(fields, ctx, [ctx, {}], {}) # TODO: redundant to otions_for_public_call. how to inject aliasing etc?
     end
-  end
 
-  # The use of this module is not encouraged and it is only here for backward-compatibility.
-  # Instead, please pass dependencies via containers, locals, or macros into the respective steps.
-  module ClassDependencies
     def call_with_circuit_interface((ctx, flow_options), **circuit_options)
-      @skills.each { |name, value| ctx[name] ||= value } # this resembles the behavior in 2.0. we didn't say we liked it.
+      ctx_with_fields = context_for_fields(class_fields, ctx)
 
-      super
+      super([ctx_with_fields, flow_options], circuit_options) # FIXME: should we unwrap here?
     end
   end
 end

data/lib/trailblazer/operation/public_call.rb

@@ -13,21 +13,21 @@ module Trailblazer
     #
     # @note Do not override this method as it will be removed in future versions. Also, you will break tracing.
     # @return Operation::Railway::Result binary result object
-    def call(*args)
-      return call_with_circuit_interface(*args) if args.any? && args[0].is_a?(Array) # This is kind of a hack that could be well hidden if Ruby had method overloading. Goal is to simplify the call/__call__ thing as we're fading out Operation::call anyway.
+    def call(options = {}, *args)
+      return call_with_circuit_interface(options, *args) if options.is_a?(Array) # This is kind of a hack that could be well hidden if Ruby had method overloading. Goal is to simplify the call/__call__ thing as we're fading out Operation::call anyway.
 
-      call_with_public_interface(*args)
+      call_with_public_interface(options, *args)
     end
 
     def call_with_public_interface(*args)
-      ctx = options_for_public_call(*args)
+      ctx = options_for_public_call(*args, flow_options())
 
       # call the activity.
       # This will result in invoking {::call_with_circuit_interface}.
       # last_signal, (options, flow_options) = Activity::TaskWrap.invoke(self, [ctx, {}], {})
       signal, (ctx, flow_options) = Activity::TaskWrap.invoke(
         @activity,
-        [ctx, {}],
+        [ctx, flow_options()],
         exec_context: new
       )
 
@@ -46,8 +46,13 @@ module Trailblazer
 
     # Compile a Context object to be passed into the Activity::call.
     # @private
-    def self.options_for_public_call(options={})
-      Trailblazer::Context.for(options, [options, {}], {})
+    def self.options_for_public_call(options, **flow_options)
+      Trailblazer::Context.for_circuit(options, {}, [options, flow_options], {})
+    end
+
+    # @semi=public
+    def flow_options
+      {context_alias: {}}
     end
   end
 end

data/lib/trailblazer/operation/trace.rb

@@ -1,11 +1,13 @@
+require 'delegate'
+
 module Trailblazer
   class Operation
     module Trace
       # @note The problem in this method is, we have redundancy with Operation::PublicCall
-      def self.call(operation, *args)
-        ctx = PublicCall.options_for_public_call(*args) # redundant with PublicCall::call.
+      def self.call(operation, options)
+        ctx = PublicCall.options_for_public_call(options) # redundant with PublicCall::call.
 
-        stack, signal, (ctx, _flow_options) = Activity::Trace.(operation, [ctx, {}])
+        stack, signal, (ctx, _flow_options) = Developer::Trace.(operation, [ctx, {}])
 
         result = Railway::Result(signal, ctx) # redundant with PublicCall::call.
 
@@ -18,20 +20,20 @@ module Trailblazer
       # @public
       #
       #   Operation.trace(params, current_user: current_user).wtf
-      def trace(*args)
-        Trace.(self, *args)
+      def trace(options)
+        Trace.(self, options)
       end
 
       # Presentation of the traced stack via the returned result object.
       # This object is wrapped around the original result in {Trace.call}.
-      class Result < SimpleDelegator
+      class Result < ::SimpleDelegator
         def initialize(result, stack)
           super(result)
           @stack = stack
         end
 
         def wtf
-          Trailblazer::Activity::Trace::Present.(@stack)
+          Developer::Trace::Present.(@stack)
         end
 
         def wtf?

data/lib/trailblazer/operation/version.rb

@@ -1,7 +1,5 @@
 module Trailblazer
-  module Version
-    module Operation
-      VERSION = "0.5.2"
-    end
+  class Operation
+    VERSION = "0.6.3"
   end
 end

data/test/call_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+  require "test_helper"
 
 class CallTest < Minitest::Spec
   class Create < Trailblazer::Operation

data/test/class_dependencies_test.rb

@@ -3,13 +3,32 @@ require "test_helper"
 class ClassDependenciesTest < Minitest::Spec
   #- Operation[] and Operation[]=
 
-  # class Index < Trailblazer::Operation
-  #   extend ClassDependencies
+  class Index < Trailblazer::Operation
+    extend ClassDependencies
 
-  #   self["model.class"] = Module
+    self["model.class"] = Module
 
-  #   step ->(options, **) { options["a"] = options["model.class"] }
-  # end
+    step ->(options, **) { options["a"] = options["model.class"] }
+  end
 
-  it { skip "https://trello.com/c/t8bUJlqb/25-op-class-dependencies"; Index.({}).inspect("a", "model.class").must_equal %{<Result:true [Module, Module] >} }
+  it { Index.({}).inspect("a", "model.class").must_equal %{<Result:true [Module, Module] >} }
+
+  it "creates separate ctx for circuit interface" do
+    signal, (ctx, _) = Index.([{}, {}], {})
+
+    ctx["model.class"].inspect.must_equal %{Module} # FIXME: should this be here?
+    ctx[:a].inspect.must_equal %{Module}
+  end
+
+  describe "inheritance" do
+    it "reader/setter read from separate config" do
+      subclass = Class.new(Index)
+
+      subclass["model.class"].must_equal Module
+      subclass["model.class"] = Class
+      subclass["model.class"].must_equal Class
+      Index["model.class"].must_equal Module
+    end
+
+  end
 end

data/test/docs/class_dependencies_test.rb

@@ -0,0 +1,54 @@
+require "test_helper"
+
+class DocsClassFieldsTest < Minitest::Spec
+  module A
+    class AlwaysTrue
+      def self.call(params)
+        true
+      end
+    end
+
+
+    class Insert < Trailblazer::Operation
+      extend ClassDependencies
+
+      self[:name] = :insert
+    end
+
+    #:create
+    class Create < Trailblazer::Operation
+      extend ClassDependencies
+
+      # Configure some dependency on class level
+      self[:validator] = AlwaysTrue
+
+      step :validate
+      step Subprocess(Insert)
+
+      #:validate
+      def validate(ctx, validator:, params:, **)
+        validator.(params)
+      end
+      #:validate end
+    end
+    #:create end
+  end
+
+  it "what" do
+    Create = A::Create
+
+    ctx = {params: {name: "Yogi"}}
+
+    #:invoke
+    signal, (ctx, _) = Create.([ctx, {}])
+
+    puts ctx[:validator] #=> AlwaysTrue
+    #:invoke end
+
+    puts ctx[:name]      #=> insert
+
+    signal.inspect.must_equal %{#<Trailblazer::Activity::Railway::End::Success semantic=:success>}
+    ctx[:validator].inspect.must_equal %{DocsClassFieldsTest::A::AlwaysTrue}
+    ctx[:name].inspect.must_equal %{:insert}
+  end
+end

data/test/step_test.rb

@@ -173,11 +173,12 @@ class StepTest < Minitest::Spec
   #-
   # not existent :name
   it do
-    assert_raises Trailblazer::Activity::DSL::Linear::Sequence::IndexError do
+    op = assert_raises Trailblazer::Activity::DSL::Linear::Sequence::IndexError do
       Class.new(Trailblazer::Operation) do
         step :a, before: "I don't exist!"
       end
-    end.inspect.must_equal %{#<Trailblazer::Activity::DSL::Linear::Sequence::IndexError: "I don't exist!">}
+    end
+    assert_match /<Trailblazer::Activity::DSL::Linear::Sequence::IndexError: "I don't exist!" is not a valid step ID. Did you mean any of these ?/, op.inspect
   end
 
   #---

data/test/test_helper.rb

@@ -1,7 +1,9 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "trailblazer/operation"
+
 require "pp"
 
 require "minitest/autorun"
-require "trailblazer/operation"
 require "trailblazer/activity/testing"
 require "trailblazer/developer/render/linear"
 

data/test/trace_test.rb

@@ -14,44 +14,39 @@ class TraceTest < Minitest::Spec
   end
   # raise Create["__task_wraps__"].inspect
 
-  it "allows using low-level Activity::Trace" do
-    ->(*args) { puts "@@@@@ #{args.last.inspect}"; Create.__call__(*args) }
-
-    stack, = Trailblazer::Activity::Trace.(
+  it "allows using low-level Operation::Trace" do
+    result = Trailblazer::Operation::Trace.(
       Create,
-      [
-        {a_return: true, params: {}},
-        {}
-      ]
+      { a_return: true, params: {} },
     )
 
-    puts output = Trailblazer::Activity::Trace::Present.(stack)
+    output = result.wtf
 
     output.gsub(/0x\w+/, "").gsub(/@.+_test/, "").must_equal %{`-- TraceTest::Create
-   |-- Start.default
-   |-- Create.task.a
-   |-- MyNested
-   |   |-- Start.default
-   |   |-- B.task.b
-   |   |-- B.task.e
-   |   `-- End.success
-   |-- Create.task.c
-   |-- Create.task.params
-   `-- End.failure}
+    |-- Start.default
+    |-- Create.task.a
+    |-- MyNested
+    |   |-- Start.default
+    |   |-- B.task.b
+    |   |-- B.task.e
+    |   `-- End.success
+    |-- Create.task.c
+    |-- Create.task.params
+    `-- End.failure}
   end
 
   it "Operation::trace" do
     result = Create.trace(params: {x: 1}, a_return: true)
     result.wtf.gsub(/0x\w+/, "").gsub(/@.+_test/, "").must_equal %{`-- TraceTest::Create
-   |-- Start.default
-   |-- Create.task.a
-   |-- MyNested
-   |   |-- Start.default
-   |   |-- B.task.b
-   |   |-- B.task.e
-   |   `-- End.success
-   |-- Create.task.c
-   |-- Create.task.params
-   `-- End.success}
+    |-- Start.default
+    |-- Create.task.a
+    |-- MyNested
+    |   |-- Start.default
+    |   |-- B.task.b
+    |   |-- B.task.e
+    |   `-- End.success
+    |-- Create.task.c
+    |-- Create.task.params
+    `-- End.success}
   end
 end

data/trailblazer-operation.gemspec

@@ -4,7 +4,7 @@ require 'trailblazer/operation/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "trailblazer-operation"
-  spec.version       = Trailblazer::Version::Operation::VERSION
+  spec.version       = Trailblazer::Operation::VERSION
   spec.authors       = ["Nick Sutterer"]
   spec.email         = ["apotonick@gmail.com"]
   spec.description   = %q(Trailblazer's operation object.)
@@ -14,16 +14,17 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 0.1.6", "< 1.0.0"
+  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 0.2.6", "< 1.0.0"
+  spec.add_dependency "trailblazer-activity", ">= 0.10.0", "< 1.0.0"
+  spec.add_dependency "trailblazer-developer", ">= 0.0.8"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "trailblazer-developer", ">= 0.0.3"
 
   spec.required_ruby_version = ">= 2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-operation
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-19 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-activity-dsl-linear
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.2.6
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -26,26 +26,46 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.2.6
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: trailblazer-activity
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: trailblazer-developer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,7 +79,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,7 +93,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,19 +107,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: trailblazer-developer
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '0'
 description: Trailblazer's operation object.
 email:
 - apotonick@gmail.com
@@ -130,6 +150,7 @@ files:
 - test/call_test.rb
 - test/callable_test.rb
 - test/class_dependencies_test.rb
+- test/docs/class_dependencies_test.rb
 - test/docs/doormat_test.rb
 - test/docs/macaroni_test.rb
 - test/docs/operation_test.rb
@@ -173,8 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Trailblazer's operation object with railway flow and integrated error handling.
@@ -183,6 +203,7 @@ test_files:
 - test/call_test.rb
 - test/callable_test.rb
 - test/class_dependencies_test.rb
+- test/docs/class_dependencies_test.rb
 - test/docs/doormat_test.rb
 - test/docs/macaroni_test.rb
 - test/docs/operation_test.rb