trailblazer 2.0.7 → 2.1.0.beta1

data/test/test_helper.rb

@@ -8,8 +8,7 @@ Reform::Form.class_eval do
   include Reform::Form::ActiveModel::Validations
 end
 
-require "trailblazer/operation/callback"
-require "trailblazer/operation/procedural/validate"
+# require "trailblazer/deprecation/context.rb"
 
 module Mock
   class Result
@@ -27,3 +26,7 @@ module Test
   end
   ReturnResult = ->(last, input, options) { input }
 end
+
+require "pp"
+
+Minitest::Spec::Operation = Trailblazer::Operation

data/test/variables_test.rb

@@ -0,0 +1,158 @@
+require "test_helper"
+
+class VariablesTest < Minitest::Spec
+  # Nested op copies values and modifies/amplifies some of them.
+  class Whistleblower < Trailblazer::Operation
+    step ->(options, public_opinion:, **) { options["edward.public_opinion"] = public_opinion.upcase }        , id: "edward.public_opinion"
+    step ->(options, secret:, **)         { options["edward.secret"]         = secret }                       , id: "edward.secret"
+    step ->(options, rumours:, **)        { rumours.nil? ? rumours : options["edward.rumours"] = rumours*2 }  , id: "edward.test"
+    pass ->(options, **)                  { options["edward.public_knowledge"] = options["public_knowledge"] }, id: "edward.read.public_knowledge"
+  end
+
+=begin
+  Everything public. options are simply passed on.
+
+  Both Org and Edward write and read from the same Context instance.
+=end
+  class OpenOrganization < Trailblazer::Operation
+    step ->(options, **) { options["rumours"] = "Bla" }
+    step ->(options, **) { options["secret"]  = "Psst!" }
+
+    step Nested( Whistleblower )
+
+    step ->(options, **) { options["org.rumours"] = options["edward.rumours"] } # what can we see from Edward?
+    step ->(options, **) { options["org.secret"]  = options["edward.secret"] }  # what can we see from Edward?
+  end
+
+  it do
+    result = OpenOrganization.("public_opinion" => "Freedom!", "public_knowledge" => true)
+
+    result.inspect("public_opinion", "rumours", "secret", "edward.public_opinion", "edward.secret", "edward.rumours", "edward.public_knowledge").
+      must_equal %{<Result:true ["Freedom!", "Bla", "Psst!", "FREEDOM!", "Psst!", "BlaBla", true] >}
+  end
+
+  #---
+  #- simply passes on the context
+  class ConsideringButOpenOrganization < Trailblazer::Operation
+    step ->(options, **) { options["rumours"] = "Bla" }
+    step ->(options, **) { options["secret"]  = "Psst!" }
+
+    step Nested( Whistleblower, input: :input! )
+
+    step ->(options, **) { options["org.rumours"] = options["edward.rumours"] } # what can we see from Edward?
+    step ->(options, **) { options["org.secret"]  = options["edward.secret"] }  # what can we see from Edward?
+
+    def input!(options, **)
+      options
+    end
+  end
+
+  it do
+    result = ConsideringButOpenOrganization.("public_opinion" => "Freedom!")
+
+    result.inspect("public_opinion", "rumours", "secret", "edward.public_opinion", "edward.secret", "edward.rumours").
+      must_equal %{<Result:true ["Freedom!", "Bla", "Psst!", "FREEDOM!", "Psst!", "BlaBla"] >}
+  end
+
+=begin
+  Explicitely passes allowed variables, only.
+
+  Edward can only read those three variables and can't see "public_knowledge" or others.
+=end
+  class ProtectedOrganization < ConsideringButOpenOrganization
+    def input!(options, **)
+      {
+         "public_opinion" => options["public_opinion"],
+         "secret"         => 0,
+         "rumours"        => 0.0
+      }
+    end
+  end
+
+  it do
+    result = ProtectedOrganization.( {}, "public_opinion" => "Freedom!", "public_knowledge" => true )
+
+    result.inspect("public_opinion", "rumours", "secret", "edward.public_opinion", "edward.secret", "edward.rumours", "edward.public_knowledge").
+      must_equal %{<Result:true ["Freedom!", "Bla", "Psst!", "FREEDOM!", 0, 0.0, nil] >}
+  end
+
+  #---
+  #- new ctx
+=begin
+:input produces a differing value for an existing key "secret"
+this should only be visible in the nested activity, and the original
+"secret" must be what it was before (unless :output would change that.)
+
+NOTE: i decided it's better to not even allow Context#merge because it
+defeats the idea of hiding information via :input and overcomplicates
+the scoping.
+=end
+  class EncryptedOrganization < ConsideringButOpenOrganization
+    def input!(options, **)
+      options.merge( "secret" => options["secret"]+"XxX" )
+    end
+  end
+
+  it do
+    skip "no options.merge until we know we actually need it"
+    result = EncryptedOrganization.("public_opinion" => "Freedom!")
+
+    result.inspect("public_opinion", "rumours", "secret", "edward.public_opinion", "edward.secret", "edward.rumours").
+      must_equal %{<Result:true ["Freedom!", "Bla", "Psst!", "FREEDOM!", "Psst!XxX", "BlaBla"] >}
+  end
+
+  # TODO write to options and get error
+
+=begin
+  Simply passes on the context to Edward, but applies an :output filter,
+  so that Org can't see several nested values such as "edward.public_knowledge"
+  or "edward.rumours" (see steps in #read-section).
+=end
+  class DiscreetOrganization < Trailblazer::Operation
+    step ->(options, **) { options["rumours"] = "Bla" },    id: "set.rumours"
+    step ->(options, **) { options["secret"]  = "Psst!" },   id: "set.secret"
+
+    step Nested( Whistleblower, input: :input!, output: :output! )
+
+    #read-section
+    pass ->(options, **) { options["org.rumours"] = options["edward.rumours"] }, id: "read.edward.rumours" # what can we see from Edward?
+    step ->(options, **) { options["org.secret"]  = options["edward.secret"] },  id: "read.edward.secret"  # what can we see from Edward?
+
+    def input!(options, **)
+      options
+    end
+
+    def output!(options, **)
+      {
+        "out.keys"    => options.keys,
+        "out.rumours" => options["edward.rumours"].slice(0..2),
+        "out.secret"  => options["edward.secret"].reverse,
+      }
+    end
+  end
+
+  it do
+    result = DiscreetOrganization.("public_opinion" => "Freedom!", "public_knowledge" => true)
+
+    result.inspect("public_opinion", "rumours", "secret", "edward.public_opinion", "edward.secret", "edward.rumours", "out.keys", "out.rumours", "out.secret", "org.rumours", "org.secret", "public_knowledge", "edward.public_knowledge").
+      must_equal %{<Result:false [\"Freedom!\", \"Bla\", \"Psst!\", nil, nil, nil, [\"edward.public_opinion\", \"edward.secret\", \"edward.rumours\", \"edward.public_knowledge\"], \"Bla\", \"!tssP\", nil, nil, true, nil] >}
+  end
+
+  it "with tracing" do
+    result = DiscreetOrganization.trace("public_opinion" => "Freedom!")
+
+    result.wtf.gsub(/0x\w+/, "").gsub(/\d+/, "").must_equal %{|-- #<Trailblazer::Activity::Start:>
+|-- set.rumours
+|-- set.secret
+|-- Nested(VariablesTest::Whistleblower)
+|   |-- #<Trailblazer::Activity::Start:>
+|   |-- edward.public_opinion
+|   |-- edward.secret
+|   |-- edward.test
+|   |-- edward.read.public_knowledge
+|   `-- #<Trailblazer::Operation::Railway::End::Success:>
+|-- read.edward.rumours
+|-- read.edward.secret
+`-- #<Trailblazer::Operation::Railway::End::Failure:>}
+  end
+end

data/trailblazer.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-operation", ">= 0.0.12", "< 0.1.0"
+  spec.add_dependency "trailblazer-operation", ">= 0.1.2", "< 0.2.0"
   spec.add_dependency "reform", ">= 2.2.0", "< 3.0.0"
   spec.add_dependency "declarative"
 

data/untitled

@@ -0,0 +1,33 @@
+
+__call__
+  :params => {}
+  :current_user => ,
+  "contract.default.class" =>
+
+
+
+
+
+skills = Skill(container, container)
+skill[:a]
+  READ-ONLY
+
+ctx = Context(skills)   => Context.new(Skill.new {}, skills)
+ctx[:a] => <skill>
+ctx[:a]= 1
+ctx.merge => new Context
+
+ctx.to_hash
+
+
+
+step(Context options, **)
+
+
+input(Context options, **, Hash::Immutable mutable:, Skill runtime:)
+
+
+
+Hash::Immutable
+
+Skills < Hash::Immutable

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.1.0.beta1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-08 00:00:00.000000000 Z
+date: 2017-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-operation
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: 0.1.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: 0.1.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: reform
   requirement: !ruby/object:Gem::Requirement
@@ -169,25 +169,29 @@ files:
 - doc/operation-2017.png
 - doc/trb.jpg
 - lib/trailblazer.rb
+- lib/trailblazer/deprecation/call.rb
+- lib/trailblazer/deprecation/context.rb
 - lib/trailblazer/dsl.rb
 - lib/trailblazer/operation/auto_inject.rb
-- lib/trailblazer/operation/callback.rb
 - lib/trailblazer/operation/contract.rb
+- lib/trailblazer/operation/deprecations.rb
 - lib/trailblazer/operation/guard.rb
 - lib/trailblazer/operation/model.rb
 - lib/trailblazer/operation/module.rb
 - lib/trailblazer/operation/nested.rb
 - lib/trailblazer/operation/persist.rb
 - lib/trailblazer/operation/policy.rb
-- lib/trailblazer/operation/procedural/contract.rb
-- lib/trailblazer/operation/procedural/validate.rb
 - lib/trailblazer/operation/pundit.rb
 - lib/trailblazer/operation/representer.rb
 - lib/trailblazer/operation/rescue.rb
 - lib/trailblazer/operation/test.rb
 - lib/trailblazer/operation/validate.rb
 - lib/trailblazer/operation/wrap.rb
+- lib/trailblazer/task.rb
 - lib/trailblazer/version.rb
+- test/benchmark.rb
+- test/deprecation/call_test.rb
+- test/deprecation/context_test.rb
 - test/docs/auto_inject_test.rb
 - test/docs/contract_test.rb
 - test/docs/dry_test.rb
@@ -201,28 +205,24 @@ files:
 - test/docs/pundit_test.rb
 - test/docs/representer_test.rb
 - test/docs/rescue_test.rb
+- test/docs/trace_test.rb
 - test/docs/wrap_test.rb
 - test/gemfiles/Gemfile.ruby-1.9
 - test/gemfiles/Gemfile.ruby-2.0
 - test/gemfiles/Gemfile.ruby-2.3
 - test/module_test.rb
-- test/operation/callback_test.rb
+- test/nested_test.rb
 - test/operation/contract_test.rb
-- test/operation/dsl/callback_test.rb
 - test/operation/dsl/contract_test.rb
 - test/operation/dsl/representer_test.rb
 - test/operation/model_test.rb
-- test/operation/params_test.rb
 - test/operation/persist_test.rb
-- test/operation/pipedream_test.rb
-- test/operation/pipetree_test.rb
-- test/operation/present_test.rb
 - test/operation/pundit_test.rb
 - test/operation/representer_test.rb
-- test/operation/resolver_test.rb
-- test/operation_test.rb
 - test/test_helper.rb
+- test/variables_test.rb
 - trailblazer.gemspec
+- untitled
 homepage: http://trailblazer.to
 licenses:
 - LGPL-3.0
@@ -238,9 +238,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8
@@ -248,6 +248,9 @@ signing_key:
 specification_version: 4
 summary: A high-level architecture for Ruby and Rails.
 test_files:
+- test/benchmark.rb
+- test/deprecation/call_test.rb
+- test/deprecation/context_test.rb
 - test/docs/auto_inject_test.rb
 - test/docs/contract_test.rb
 - test/docs/dry_test.rb
@@ -261,24 +264,19 @@ test_files:
 - test/docs/pundit_test.rb
 - test/docs/representer_test.rb
 - test/docs/rescue_test.rb
+- test/docs/trace_test.rb
 - test/docs/wrap_test.rb
 - test/gemfiles/Gemfile.ruby-1.9
 - test/gemfiles/Gemfile.ruby-2.0
 - test/gemfiles/Gemfile.ruby-2.3
 - test/module_test.rb
-- test/operation/callback_test.rb
+- test/nested_test.rb
 - test/operation/contract_test.rb
-- test/operation/dsl/callback_test.rb
 - test/operation/dsl/contract_test.rb
 - test/operation/dsl/representer_test.rb
 - test/operation/model_test.rb
-- test/operation/params_test.rb
 - test/operation/persist_test.rb
-- test/operation/pipedream_test.rb
-- test/operation/pipetree_test.rb
-- test/operation/present_test.rb
 - test/operation/pundit_test.rb
 - test/operation/representer_test.rb
-- test/operation/resolver_test.rb
-- test/operation_test.rb
 - test/test_helper.rb
+- test/variables_test.rb

data/lib/trailblazer/operation/callback.rb

@@ -1,35 +0,0 @@
-require "disposable/callback"
-
-class Trailblazer::Operation
-  def self.Callback(group)
-    step = ->(input, options) { Callback.(group, input, options) }
-
-    [ step, name: "callback.#{group}" ]
-  end
-
-  module Callback
-    def self.call(name=:default, operation, options)
-      config  = options["callback.#{name}.class"] || raise #.fetch(name) # TODO: test exception
-      group   = config[:group].new(options["contract.default"])
-
-      options[:context] ||= (config[:context] == :operation ? operation : group)
-      group.(options)
-
-      options["result.callback.#{name}"] = group
-    end
-
-    module DSL
-      def callback(name=:default, constant=nil, &block)
-        heritage.record(:callback, name, constant, &block)
-
-        # FIXME: make this nicer. we want to extend same-named callback groups.
-        # TODO: allow the same with contract, or better, test it!
-        extended = self["callback.#{name}.class"] && self["callback.#{name}.class"]
-
-        path, group_class = Trailblazer::DSL::Build.new.({ prefix: :callback, class: Disposable::Callback::Group, container: self }, name, constant, block) { |extended| extended[:group] }
-
-        self[path] = { group: group_class, context: constant ? nil : :operation }
-      end
-    end
-  end
-end

data/lib/trailblazer/operation/procedural/contract.rb

@@ -1,15 +0,0 @@
-module Trailblazer::Operation::Procedural
-  # THIS IS UNTESTED, PRIVATE API AND WILL BE REMOVED SOON.
-  module Contract
-    # Instantiate the contract, either by using the user's contract passed into #validate
-    # or infer the Operation contract.
-    def contract_for(model:self["model"], options:{}, contract_class:self["contract.default.class"])
-      contract!(model: model, options: options, contract_class: contract_class)
-    end
-
-    # Override to construct your own contract.
-    def contract!(model:nil, options:{}, contract_class:nil)
-      contract_class.new(model, options)
-    end
-  end
-end

data/lib/trailblazer/operation/procedural/validate.rb

@@ -1,22 +0,0 @@
-module Trailblazer::Operation::Procedural
-  module Validate
-    def validate(params, contract:self["contract.default"], path:"contract.default") # :params
-      # DISCUSS: should we only have path here and then look up contract ourselves?
-      result = validate_contract(contract, params) # run validation.  # FIXME: must be overridable.
-
-      self["result.#{path}"] = result
-
-      if valid = result.success? # FIXME: to_bool or success?
-        yield result if block_given?
-      else
-        # self["errors.#{path}"] = result.errors # TODO: remove me
-      end
-
-      valid
-    end
-
-    def validate_contract(contract, params)
-      contract.(params)
-    end
-  end
-end