trailblazer 2.1.0.beta4 → 2.1.0.beta5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer
 version: !ruby/object:Gem::Version
-  version: 2.1.0.beta4
+  version: 2.1.0.beta5
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-operation
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.4
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.3.0
@@ -26,50 +26,50 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.4
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: trailblazer-activity
+  name: trailblazer-macro
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 2.1.0.beta2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 2.1.0.beta2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: reform
+  name: trailblazer-macro-contract
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.1.0.beta2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.1.0.beta2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: declarative
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +182,7 @@ files:
 - ".travis.yml"
 - CHANGES.md
 - COMM-LICENSE
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -195,54 +196,25 @@ files:
 - lib/trailblazer/deprecation/context.rb
 - lib/trailblazer/dsl.rb
 - lib/trailblazer/operation/auto_inject.rb
-- lib/trailblazer/operation/contract.rb
 - lib/trailblazer/operation/deprecations.rb
-- lib/trailblazer/operation/guard.rb
 - lib/trailblazer/operation/input_output.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/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
 - test/docs/fast_test.rb
-- test/docs/guard_test.rb
 - test/docs/input_output_test.rb
-- test/docs/macro_test.rb
-- test/docs/model_test.rb
-- test/docs/nested_test.rb
 - test/docs/operation_test.rb
-- test/docs/policy_test.rb
-- 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/dsl/contract_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/nested_test.rb
-- test/operation/contract_test.rb
-- test/operation/dsl/contract_test.rb
-- test/operation/dsl/representer_test.rb
-- test/operation/model_test.rb
-- test/operation/persist_test.rb
-- test/operation/pundit_test.rb
-- test/operation/representer_test.rb
 - test/test_helper.rb
 - test/variables_test.rb
 - trailblazer.gemspec
@@ -276,32 +248,14 @@ test_files:
 - 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
 - test/docs/fast_test.rb
-- test/docs/guard_test.rb
 - test/docs/input_output_test.rb
-- test/docs/macro_test.rb
-- test/docs/model_test.rb
-- test/docs/nested_test.rb
 - test/docs/operation_test.rb
-- test/docs/policy_test.rb
-- 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/dsl/contract_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/nested_test.rb
-- test/operation/contract_test.rb
-- test/operation/dsl/contract_test.rb
-- test/operation/dsl/representer_test.rb
-- test/operation/model_test.rb
-- test/operation/persist_test.rb
-- test/operation/pundit_test.rb
-- test/operation/representer_test.rb
 - test/test_helper.rb
 - test/variables_test.rb

data/lib/trailblazer/operation/contract.rb

@@ -1,82 +0,0 @@
-# Best practices for using contract.
-#
-# * inject contract instance via constructor to #contract
-# * allow contract setup and memo via #contract(model, options)
-# * allow implicit automatic setup via #contract and class.contract_class
-#
-# Needs Operation#model.
-# Needs #[], #[]= skill dependency.
-module Trailblazer
-  class Operation
-    module Contract
-      def self.Build(name: "default", constant: nil, builder: nil)
-        task = ->((options, flow_options), **circuit_options) do
-          result = Build.(options, circuit_options, name: name, constant: constant, builder: builder)
-
-          return Activity::TaskBuilder::Binary.binary_direction_for( result, Activity::Right, Activity::Left ),
-            [options, flow_options]
-        end
-
-        { task: task, id: "contract.build" }
-      end
-
-      module Build
-        # Build contract at runtime.
-        def self.call(options, circuit_options, name: "default", constant: nil, builder: nil)
-          # TODO: we could probably clean this up a bit at some point.
-          contract_class = constant || options["contract.#{name}.class"] # DISCUSS: Injection possible here?
-          model          = options[:model]
-          name           = "contract.#{name}"
-
-          options[name] =
-            if builder
-              call_builder( options, circuit_options, builder: builder, constant: contract_class, name: name )
-            else
-              contract_class.new(model)
-            end
-        end
-
-        def self.call_builder(options, circuit_options, builder:raise, constant:raise, name:raise)
-          # builder_options = Trailblazer::Context( options, constant: constant, name: name ) # options.merge( .. )
-
-          # Trailblazer::Option::KW(builder).(builder_options, circuit_options)
-
-
-
-
-
-
-
-
-          # FIXME: almost identical with Option::KW.
-          # FIXME: see Nested::Options::Dynamic, the same shit
-          tmp_options =  options.to_hash.merge(
-            constant: constant,
-            name:     name
-          )
-
-          Trailblazer::Option(builder).( options, tmp_options, circuit_options )
-        end
-      end
-
-      module DSL
-        def self.extended(extender)
-          extender.extend(ClassDependencies)
-          warn "[Trailblazer] Using `contract do...end` is deprecated. Please use a form class and the Builder( constant: <Form> ) option."
-        end
-        # This is the class level DSL method.
-        #   Op.contract #=> returns contract class
-        #   Op.contract do .. end # defines contract
-        #   Op.contract CommentForm # copies (and subclasses) external contract.
-        #   Op.contract CommentForm do .. end # copies and extends contract.
-        def contract(name=:default, constant=nil, base: Reform::Form, &block)
-          heritage.record(:contract, name, constant, &block)
-
-          path, form_class = Trailblazer::DSL::Build.new.({ prefix: :contract, class: base, container: self }, name, constant, block)
-
-          self[path] = form_class
-        end
-      end # Contract
-    end
-  end
-end

data/lib/trailblazer/operation/guard.rb

@@ -1,18 +0,0 @@
-class Trailblazer::Operation
-  module Policy
-    def self.Guard(proc, name: :default, &block)
-      Policy.step( Guard.build(proc), name: name )
-    end
-
-    module Guard
-      def self.build(callable)
-        option = Trailblazer::Option::KW(callable)
-
-        # this gets wrapped in a Operation::Result object.
-        ->( (options, *), circuit_args ) do
-          Result.new( !!option.(options, circuit_args), {} )
-        end
-      end
-    end # Guard
-  end
-end

data/lib/trailblazer/operation/model.rb

@@ -1,65 +0,0 @@
-class Trailblazer::Operation
-  def self.Model(model_class, action=nil)
-    # step = Pipetree::Step.new(step, "model.class" => model_class, "model.action" => action)
-
-    task = Trailblazer::Activity::TaskBuilder::Binary.( Model.new )
-
-    extension = Trailblazer::Activity::TaskWrap::Merge.new(
-      Wrap::Inject::Defaults(
-        "model.class"  => model_class,
-        "model.action" => action
-      )
-    )
-
-    { task: task, id: "model.build", extension: [extension] }
-  end
-
-  class Model
-    def call(options, params:,  **)
-      builder = Model::Builder.new
-
-      options[:model] = model = builder.(options, params)
-
-      options["result.model"] = result = Result.new(!model.nil?, {})
-
-      result.success?
-    end
-
-    class Builder
-      def call(options, params)
-        deprecate_update!(options)
-        action      = options["model.action"] || :new
-        model_class = options["model.class"]
-
-        action = :pass_through unless [:new, :find_by, :find].include?(action)
-
-        send("#{action}!", model_class, params, options["model.action"])
-      end
-
-      def new!(model_class, params, *)
-        model_class.new
-      end
-
-      def find!(model_class, params, *)
-        model_class.find(params[:id])
-      end
-
-      # Doesn't throw an exception and will return false to divert to Left.
-      def find_by!(model_class, params, *)
-        model_class.find_by(id: params[:id])
-      end
-
-      # Call any method on the model class and pass :id.
-      def pass_through!(model_class, params, action)
-        model_class.send(action, params[:id])
-      end
-
-    private
-      def deprecate_update!(options) # TODO: remove in 2.1.
-        return unless options["model.action"] == :update
-        options["model.action"] = :find
-        warn "[Trailblazer] Model( .., :update ) is deprecated, please use :find or :find_by."
-      end
-    end
-  end
-end

data/lib/trailblazer/operation/nested.rb

@@ -1,91 +0,0 @@
-# per default, everything we pass into a circuit is immutable. it's the ops/act's job to allow writing (via a Context)
-module Trailblazer
-  class Operation
-    # {Nested} macro.
-    def self.Nested(callable, input:nil, output:nil, id: "Nested(#{callable})")
-      task_wrap_extensions        = Module.new do
-        extend Activity::Path::Plan()
-      end
-
-      task, operation, is_dynamic = Nested.build(callable)
-
-      if input || output # TODO: move this to the generic step DSL
-        task_wrap_extensions = InputOutput.plan( input, output )
-      end
-
-      if is_dynamic
-        # task_wrap_extensions += Activity::Magnetic::Builder::Path.plan do
-          task_wrap_extensions.task task.method(:compute_nested_activity), id: ".compute_nested_activity",  after: "Start.default", group: :start
-          task_wrap_extensions.task task.method(:compute_return_signal),   id: ".compute_return_signal",    after: "task_wrap.call_task"
-        # end
-      end
-
-      {
-        task:      task,
-        id:        id,
-        extension: [ Trailblazer::Activity::TaskWrap::Merge.new(task_wrap_extensions) ],
-        outputs:   operation.outputs
-      }
-    end
-
-    # @private
-    module Nested
-      def self.build(nested_operation) # DISCUSS: use builders here?
-        return dynamic = Dynamic.new(nested_operation), dynamic, true unless nestable_object?(nested_operation)
-
-        # The returned {Nested} instance is a valid circuit element and will be `call`ed in the circuit.
-        # It simply returns the nested activity's `signal,options,flow_options` return set.
-        # The actual wiring - where to go with that - is done by the step DSL.
-        return Trailblazer::Operation::Callable(nested_operation, call: :__call__), nested_operation, false
-      end
-
-      def self.nestable_object?(object)
-        object.is_a?( Trailblazer::Activity::Interface )
-      end
-
-      def self.operation_class
-        Operation
-      end
-
-      private
-
-      # For dynamic `Nested`s that do not expose an {Activity} interface.
-      # Since we do not know its outputs, we have to map them to :success and :failure, only.
-      #
-      # This is what {Nested} in 2.0 used to do, where the outcome could only be true/false (or success/failure).
-      class Dynamic
-        def initialize(nested_activity)
-          @nested_activity = Trailblazer::Option::KW(nested_activity)
-          @outputs         = {
-            :success => Activity::Output( Railway::End::Success.new(semantic: :success), :success ),
-            :failure => Activity::Output( Railway::End::Failure.new(semantic: :failure), :failure ),
-          }
-        end
-
-        attr_reader :outputs
-
-        # TaskWrap step.
-        def compute_nested_activity( (wrap_ctx, original_args), **circuit_options )
-          (ctx, _), original_circuit_options = original_args
-
-          activity = @nested_activity.( ctx, original_circuit_options ) # evaluate the option to get the actual "object" to call.
-
-          # overwrite :task so task_wrap.call_task will call this activity. This is a trick so we don't have to repeat
-          # logic from #call_task here.
-          wrap_ctx[:task] = Trailblazer::Operation::Callable( activity, call: :__call__ )
-
-          return Activity::Right, [ wrap_ctx, original_args ]
-        end
-
-        def compute_return_signal( (wrap_ctx, original_args), **circuit_options )
-          # Translate the genuine nested signal to the generic Dynamic end (success/failure, only).
-          # Note that here we lose information about what specific event was emitted.
-          wrap_ctx[:return_signal] = wrap_ctx[:return_signal].kind_of?(Railway::End::Success) ?
-            @outputs[:success].signal : @outputs[:failure].signal
-
-          return Activity::Right, [ wrap_ctx, original_args ]
-        end
-      end
-    end
-  end # Operation
-end

data/lib/trailblazer/operation/persist.rb

@@ -1,14 +0,0 @@
-module Trailblazer
-  class Operation
-    module Contract
-      def self.Persist(method: :save, name: "default")
-        path = "contract.#{name}"
-        step = ->(options, **) { options[path].send(method) }
-
-        task = Activity::TaskBuilder::Binary.( step )
-
-        { task: task, id: "persist.save" }
-      end
-    end
-  end
-end

data/lib/trailblazer/operation/policy.rb

@@ -1,44 +0,0 @@
-class Trailblazer::Operation
-  module Policy
-    # Step: This generically `call`s a policy and then pushes its result to `options`.
-    # You can use any callable object as a policy with this step.
-    class Eval
-      def initialize(name:nil, path:nil)
-        @name = name
-        @path = path
-      end
-
-      # incoming low-level {Task API}.
-      # outgoing Task::Binary API.
-      def call((options, flow_options), **circuit_options)
-        condition = options[ @path ] # this allows dependency injection.
-        result    = condition.( [options, flow_options], **circuit_options )
-
-        options["policy.#{@name}"]        = result["policy"] # assign the policy as a skill.
-        options["result.policy.#{@name}"] = result
-
-        # flow control
-        signal = result.success? ? Trailblazer::Activity::Right : Trailblazer::Activity::Left # since we & this, it's only executed OnRight and the return boolean decides the direction, input is passed straight through.
-
-        return signal, [ options, flow_options ]
-      end
-    end
-
-    # Adds the `yield` result to the pipe and treats it like a
-    # policy-compatible  object at runtime.
-    def self.step(condition, options, &block)
-      name = options[:name]
-      path = "policy.#{name}.eval"
-
-      task = Eval.new( name: name, path: path )
-
-      extension = Trailblazer::Activity::TaskWrap::Merge.new(
-        Trailblazer::Operation::Wrap::Inject::Defaults(
-          path => condition
-        )
-      )
-
-      { task: task, id: path, extension: [extension] }
-    end
-  end
-end

data/lib/trailblazer/operation/pundit.rb

@@ -1,38 +0,0 @@
-class Trailblazer::Operation
-  module Policy
-    def self.Pundit(policy_class, action, name: :default)
-      Policy.step( Pundit.build(policy_class, action), name: name )
-    end
-
-    module Pundit
-      def self.build(*args, &block)
-        Condition.new(*args, &block)
-      end
-
-      # Pundit::Condition is invoked at runtime when iterating the pipe.
-      class Condition
-        def initialize(policy_class, action)
-          @policy_class, @action = policy_class, action
-        end
-
-        # Instantiate the actual policy object, and call it.
-        def call((options), *)
-          policy = build_policy(options)          # this translates to Pundit interface.
-          result!(policy.send(@action), policy)
-        end
-
-      private
-        def build_policy(options)
-          @policy_class.new(options[:current_user], options[:model])
-        end
-
-        def result!(success, policy)
-          data = { "policy" => policy }
-          data["message"] = "Breach" if !success # TODO: how to allow messages here?
-
-          Result.new(success, data)
-        end
-      end
-    end
-  end
-end

data/lib/trailblazer/operation/representer.rb

@@ -1,36 +0,0 @@
-class Trailblazer::Operation
-  module Representer
-    def self.infer(contract_class, format:Representable::JSON)
-      Disposable::Rescheme.from(contract_class,
-        include:          [format],
-        options_from:     :deserializer, # use :instance etc. in deserializer.
-        superclass:       Representable::Decorator,
-        definitions_from: lambda { |inline| inline.definitions },
-        exclude_options:  [:default, :populator], # TODO: test with populator: in an operation.
-        exclude_properties: [:persisted?]
-      )
-    end
-
-    module DSL
-      def self.extended(extender)
-        extender.extend(ClassDependencies)
-        warn "[Trailblazer] Using `representer do...end` is deprecated. Please use a dedicated representer class."
-      end
-
-      def representer(name=:default, constant=nil, &block)
-        heritage.record(:representer, 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!
-        path, representer_class = Trailblazer::DSL::Build.new.({ prefix: :representer, class: representer_base_class, container: self }, name, constant, block)
-
-        self[path] = representer_class
-      end
-
-      # TODO: make engine configurable?
-      def representer_base_class
-        Class.new(Representable::Decorator) { include Representable::JSON; self }
-      end
-    end
-  end
-end

data/lib/trailblazer/operation/rescue.rb

@@ -1,24 +0,0 @@
-class Trailblazer::Operation
-  NoopHandler = lambda { |*| }
-
-  def self.Rescue(*exceptions, handler: NoopHandler, &block)
-    exceptions = [StandardError] unless exceptions.any?
-    handler    = Trailblazer::Option(handler)
-
-    # This block is evaluated by {Wrap} which currently expects a binary return type.
-    rescue_block = ->(options, flow_options, **circuit_options, &nested_activity) {
-      begin
-        nested_activity.call
-      rescue *exceptions => exception
-        # DISCUSS: should we deprecate this signature and rather apply the Task API here?
-        handler.call(exception, options, **circuit_options) # FIXME: when there's an error here, it shows the wrong exception!
-        false
-      end
-    }
-
-    Wrap(rescue_block, id: "Rescue(#{rand(100)})", &block)
-    # FIXME: name
-    # [ step, name: "Rescue:#{block.source_location.last}" ]
-  end
-end
-

data/lib/trailblazer/operation/validate.rb

@@ -1,74 +0,0 @@
-module Trailblazer
-  class Operation
-    module Contract
-      # result.contract = {..}
-      # result.contract.errors = {..}
-      # Deviate to left track if optional key is not found in params.
-      # Deviate to left if validation result falsey.
-      def self.Validate(skip_extract: false, name: "default", representer: false, key: nil) # DISCUSS: should we introduce something like Validate::Deserializer?
-        params_path = "contract.#{name}.params" # extract_params! save extracted params here.
-
-        extract  = Validate::Extract.new( key: key, params_path: params_path ).freeze
-        validate = Validate.new( name: name, representer: representer, params_path: params_path ).freeze
-
-        # Build a simple Railway {Activity} for the internal flow.
-        activity = Module.new do
-          extend Activity::Railway()
-
-          step extract,  id: "#{params_path}_extract" unless skip_extract || representer
-          step validate, id: "contract.#{name}.call"
-        end
-
-        # activity, _ = activity.decompose
-
-        # DISCUSS: use Nested here?
-        { task: activity, id: "contract.#{name}.validate", outputs: activity.outputs }
-      end
-
-      class Validate
-        # Task: extract the contract's input from params by reading `:key`.
-        class Extract
-          def initialize(key:nil, params_path:nil)
-            @key, @params_path = key, params_path
-          end
-
-          def call( ctx, params:, ** )
-            ctx[@params_path] = @key ? params[@key] : params
-          end
-        end
-
-        def initialize(name:"default", representer:false, params_path:nil)
-          @name, @representer, @params_path = name, representer, params_path
-        end
-
-        # Task: Validates contract `:name`.
-        def call( ctx, ** )
-          validate!(
-            ctx,
-            representer: ctx["representer.#{@name}.class"] ||= @representer, # FIXME: maybe @representer should use DI.
-            params_path: @params_path
-          )
-        end
-
-        def validate!(options, representer:false, from: :document, params_path:nil)
-          path     = "contract.#{@name}"
-          contract = options[path]
-
-          # this is for 1.1-style compatibility and should be removed once we have Deserializer in place:
-          options["result.#{path}"] = result =
-            if representer
-              # use :document as the body and let the representer deserialize to the contract.
-              # this will be simplified once we have Deserializer.
-              # translates to contract.("{document: bla}") { MyRepresenter.new(contract).from_json .. }
-              contract.(options[from]) { |document| representer.new(contract).parse(document) }
-            else
-              # let Reform handle the deserialization.
-              contract.(options[params_path])
-            end
-
-          result.success?
-        end
-      end
-    end
-  end # Operation
-end