trailblazer-future 2.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fbd09ac23c1b1b27633ad25bd1da7375c58987cc9d705aaa3cad826f5bd5467
+  data.tar.gz: a99e5277b29b7d2423ed106494ce5939c9f29789aae9571c32fdfdfd80a21719
+SHA512:
+  metadata.gz: cf4d9f163f3a7b43638fc9b5a7a50eaadd36c3bbe6c29946748c9cd69dcedba7fab0399982b05456a3bdbfb4efd97986f15eb03dba60011d330f35e9e53dd204
+  data.tar.gz: a697eacd1a5fb4997903a7ad362710bf0fa12e76aaf60dc6a6ce084a37c36c019dbdbb514bf18caa00c403578a15bcb014dae85a23b35638bc3d964a5f5dc56a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+*.iml
+gems.locked
+test/**/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1
+script: cd test/rails5.0 && bundle && rake

data/CHANGES.md

@@ -0,0 +1,4 @@
+# 2.1.0.rc1
+
+* First release (check trailblazer/v2_1/versions.txt)
+

data/LICENSE.txt

@@ -0,0 +1,9 @@
+Copyright (c) 2018 Trailblazer GmbH
+
+Trailblazer is an Open Source project licensed under the terms of
+the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.
+
+Trailblazer Enterprise has a commercial-friendly license allowing private forks
+and modifications of Trailblazer.  Please see http://trailblazer.to/enterprise/ for
+more detail.  You can find the commercial license terms in COMM-LICENSE.

data/README.md

@@ -0,0 +1,48 @@
+# Trailblazer::Future
+[![Build Status](https://travis-ci.org/trailblazer/trailblazer-future.svg)](https://travis-ci.org/trailblazer/trailblazer-future)
+[![Gem Version](https://badge.fury.io/rb/trailblazer-future.svg)](http://badge.fury.io/rb/trailblazer-future)
+
+## Installation
+
+- Step 1
+
+Update `trailblazer` to it latest patch version `~> 2.0.7`
+
+- Step 2
+
+Test your build and remove any deprecation warning
+
+- Optional step (recommended)
+
+Feed a homeless person
+
+- Step 3
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trailblazer-future'
+```
+
+## Usage
+
+1) Inherit operation from `Trailblazer::V2_1::Operation`
+```ruby
+class MyOP < Trailblazer::V2_1::Operation
+end
+```
+2) Migrate to TRB 2.1 following the [migration path](http://trailblazer.to/api-docs/#trailblazer-migration-path), here a quick summary of the breaking changes:
+    - new API using keyword arguments: `MyOP.(params)` -> `MyOp.(params: params)` (more [here](http://trailblazer.to/api-docs/#operation-call))
+    - using `symbol` instead of `string` for `:model` and `:current_user`: `result['model']` -> `result[:model]`
+    - Replace `Railway::Right/Left` with `Trailblazer::Activity::Right/Left`
+    - Add option `fast_track: true` for the steps that uses `pass_fast!` or `fail_fast!` (check the new [wiring API](http://trailblazer.to/api-docs/#activity-wiring-api))
+    - Nested macro now gets the all result object so use `:input` and `:output` to filter data in/out
+
+## Notes
+
+1) Operations of different versions cannot be nested
+2) Rails controller's `run` is for V2.0. Use `run_v21` for the migrated operations
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "trailblazer/future"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gems.rb

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+gemspec

data/lib/trailblazer/future.rb

@@ -0,0 +1,9 @@
+require "trailblazer/future/version"
+require "trailblazer"
+require "trailblazer/v2_1/macro"
+require "trailblazer/v2_1/macro/contract"
+require "trailblazer/v2_1/dsl"
+
+require "trailblazer/v2_1/operation/deprecations"
+require "trailblazer/v2_1/operation/inject"
+

data/lib/trailblazer/future/version.rb

@@ -0,0 +1,5 @@
+module Trailblazer
+  module Future
+    VERSION = "2.1.0.rc1"
+  end
+end

data/lib/trailblazer/v2_1/activity.rb

@@ -0,0 +1,123 @@
+module Trailblazer::V2_1
+  class Activity < Module
+    attr_reader :initial_state
+
+    def initialize(implementation, options)
+      builder, adds, circuit, outputs, options = BuildState.build_state_for( implementation.config, options)
+
+      @initial_state = State::Config.build(
+        builder: builder,
+        options: options,
+        adds:    adds,
+        circuit: circuit,
+        outputs: outputs,
+      )
+
+      include *options[:extend] # include the DSL methods.
+      include PublicAPI
+    end
+
+    # Injects the initial configuration into the module defining a new activity.
+    def extended(extended)
+      super
+      extended.instance_variable_set(:@state, initial_state)
+    end
+
+
+    module Inspect
+      def inspect
+        "#<Trailblazer::V2_1::Activity: {#{name || self[:options][:name]}}>"
+      end
+
+      alias_method :to_s, :inspect
+    end
+
+
+    require "trailblazer/v2_1/activity/dsl/helper"
+    # Helpers such as Path, Output, End to be included into {Activity}.
+    module DSLHelper
+      extend Forwardable
+      def_delegators :@builder, :Path
+      def_delegators DSL, :Output, :End, :Subprocess, :Track
+
+      def Path(*args, &block)
+        self[:builder].Path(*args, &block)
+      end
+    end
+
+    # Reader and writer method for DSL objects.
+    # The writer {dsl[:key] = "value"} exposes immutable behavior and will replace the old
+    # @state with a new, modified copy.
+    #
+    # Always use the DSL::Accessor accessors to avoid leaking state to other components
+    # due to mutable write operations.
+    module Accessor
+      def []=(*args)
+        @state = State::Config.send(:[]=, @state, *args)
+      end
+
+      def [](*args)
+        State::Config[@state, *args]
+      end
+    end
+
+    # FIXME: still to be decided
+    # By including those modules, we create instance methods.
+    # Later, this module is `extended` in Path, Railway and FastTrack, and
+    # imports the DSL methods as class methods.
+    module PublicAPI
+      include Accessor
+
+    require "trailblazer/v2_1/activity/dsl/add_task"
+      include DSL::AddTask
+
+    require "trailblazer/v2_1/activity/interface"
+      include Activity::Interface # DISCUSS
+
+      include DSLHelper # DISCUSS
+
+      include Activity::Inspect # DISCUSS
+
+    require "trailblazer/v2_1/activity/dsl/magnetic/merge"
+      include Magnetic::Merge # Activity#merge!
+
+      # @private Note that {Activity.call} is considered private until the public API is stable.
+      def call(args, circuit_options={})
+        self[:circuit].( args, circuit_options.merge(activity: self) )
+      end
+    end
+
+  end # Activity
+end
+
+require "trailblazer/v2_1/circuit"
+require "trailblazer/v2_1/activity/structures"
+require "trailblazer/v2_1/activity/config"
+
+require "trailblazer/v2_1/activity/dsl/strategy/build_state"
+require "trailblazer/v2_1/activity/dsl/strategy/path"
+require "trailblazer/v2_1/activity/dsl/strategy/plan"
+require "trailblazer/v2_1/activity/dsl/strategy/railway"
+require "trailblazer/v2_1/activity/dsl/strategy/fast_track"
+
+require "trailblazer/v2_1/activity/task_wrap"
+require "trailblazer/v2_1/activity/task_wrap/call_task"
+require "trailblazer/v2_1/activity/task_wrap/trace"
+require "trailblazer/v2_1/activity/task_wrap/runner"
+require "trailblazer/v2_1/activity/task_wrap/merge"
+require "trailblazer/v2_1/activity/task_wrap/variable_mapping"
+
+require "trailblazer/v2_1/activity/trace"
+require "trailblazer/v2_1/activity/present"
+
+require "trailblazer/v2_1/activity/introspect"
+
+require "trailblazer/v2_1/activity/dsl/magnetic/builder/state"
+require "trailblazer/v2_1/activity/dsl/magnetic" # the "magnetic" DSL
+
+require "trailblazer/v2_1/activity/dsl/schema/sequence"
+require "trailblazer/v2_1/activity/dsl/schema/dependencies"
+
+require "trailblazer/v2_1/activity/dsl/magnetic/builder/normalizer" # DISCUSS: name and location are odd. This one uses Activity ;)
+
+require "trailblazer/v2_1/activity/dsl/record"

data/lib/trailblazer/v2_1/activity/config.rb

@@ -0,0 +1,37 @@
+module Trailblazer::V2_1
+  module Activity::State
+    # Compile-time
+    #
+    # DISCUSS: we could replace parts with Hamster::Hash.
+    class Config
+      def self.build(variables={})
+        Hash[ variables.collect { |k,v| [k, v.freeze] } ].freeze
+      end
+
+      def self.[]=(state, *args)
+        if args.size == 2
+          key, value = *args
+
+          state = state.merge(key => value)
+        else
+          directive, key, value = *args
+
+          state = state.merge( directive => {}.freeze ) unless state.key?(directive)
+
+          directive_hash = state[directive].merge(key => value)
+          state = state.merge( directive => directive_hash.freeze )
+        end
+
+        state
+      end
+
+      def self.[](state, *args)
+        directive, key = *args
+
+        return state[directive] if args.size == 1
+        return state[directive][key] if state.key?(directive)
+        nil
+      end
+    end
+  end
+end

data/lib/trailblazer/v2_1/activity/dsl/add_task.rb

@@ -0,0 +1,22 @@
+class Trailblazer::V2_1::Activity < Module
+  module DSL
+    module AddTask
+      def add_task!(strategy, polarizer, name, task, options, &block)
+        # The beautiful thing about State.add is it doesn't mutate anything.
+        # We're changing state here, on the outside, by overriding the ivars.
+        # That in turn means, the only mutated entity is this module.
+
+        _builder, adds, circuit, outputs, returned_options = Magnetic::Builder::State.add( self[:builder], self[:adds], strategy, polarizer, task, options, &block ) # this could be an extension itself.
+
+        self[:adds]    = adds
+        self[:circuit] = circuit
+        self[:outputs] = outputs
+
+        _, local_options, connections, sequence_options, extension_options = returned_options
+
+        # {Extension API} call all extensions.
+        extension_options.keys.collect { |ext| ext.( self, *returned_options, original_dsl_args: [name, task, options, block] ) }
+      end
+    end
+  end
+end

data/lib/trailblazer/v2_1/activity/dsl/helper.rb

@@ -0,0 +1,68 @@
+module Trailblazer::V2_1
+  module Activity::DSL
+    # Create a new method (e.g. Activity::step) that delegates to its builder, recompiles
+    # the circuit, etc. Method comes in a module so it can be overridden via modules.
+    #
+    # This approach assumes you maintain a {#add_task!} method.
+    def self.def_dsl(_name, strategy, polarizer)
+      Module.new do
+        define_method(_name) do |task, options={}, &block|
+          builder, adds, circuit, outputs, options = add_task!(strategy, polarizer, _name, task, options, &block)
+        end
+      end
+    end
+
+    # @api private
+    OutputSemantic = Struct.new(:value)
+    Track          = Struct.new(:color)
+    Extension      = Struct.new(:callable) do
+      def call(*args, &block)
+        callable.(*args, &block)
+      end
+    end
+
+    # Shortcut functions for the DSL. These have no state.
+    module_function
+
+    #   Output( Left, :failure )
+    #   Output( :failure ) #=> Output::Semantic
+    def Output(signal, semantic=nil)
+      return OutputSemantic.new(signal) if semantic.nil?
+
+      Activity.Output(signal, semantic)
+    end
+
+    def End(semantic)
+      Activity.End(semantic)
+    end
+
+    def Track(color)
+      Track.new(color).freeze
+    end
+
+    def Path(normalizer, track_color: "track_#{rand}", end_semantic: track_color, **options)
+      options = options.merge(track_color: track_color, end_semantic: end_semantic)
+
+      # Build an anonymous class which will be where the block is evaluated in.
+      # We use the same normalizer here, so DSL calls in the inner block have the same behavior.
+      path = Module.new do
+        extend Activity::Path( options.merge( normalizer: normalizer ) )
+      end
+
+      # this block is called in DSL::ProcessTuples. This could be improved somehow.
+      ->(block) {
+        path.instance_exec(&block)
+
+        [ track_color, path ]
+      }
+    end
+
+    # Computes the :outputs options for {activity}
+    def Subprocess(activity)
+      {
+        task:    activity,
+        outputs: activity.outputs
+      }
+    end
+  end
+end

data/lib/trailblazer/v2_1/activity/dsl/magnetic.rb

@@ -0,0 +1,36 @@
+module Trailblazer::V2_1
+  class Activity < Module   # all code related to the magnetic building of a circuit hash lives in this namespace.
+    module Magnetic
+      # PlusPole "radiates" a color that MinusPoles are attracted to.
+      #
+      # This datastructure is produced by the DSL and sits in an ADDS.
+      PlusPole = Struct.new(:output, :color) do
+        private :output
+
+        def signal
+          output.signal
+        end
+      end # PlusPole
+    end
+  end
+end
+
+require "trailblazer/v2_1/activity/dsl/magnetic/process_options"
+require "trailblazer/v2_1/activity/dsl/magnetic/structure/plus_poles"
+require "trailblazer/v2_1/activity/dsl/magnetic/structure/polarization"
+require "trailblazer/v2_1/activity/dsl/magnetic/structure/alterations"
+
+require "trailblazer/v2_1/activity/dsl/magnetic"
+require "trailblazer/v2_1/activity/dsl/magnetic/builder"
+# require "trailblazer/v2_1/activity/dsl/magnetic/builder/dsl_helper"
+# require "trailblazer/v2_1/activity/dsl/magnetic/dsl_helper"
+
+require "trailblazer/v2_1/option"
+require "trailblazer/v2_1/activity/task_builder"
+require "trailblazer/v2_1/activity/dsl/magnetic/builder/default_normalizer"
+require "trailblazer/v2_1/activity/dsl/magnetic/builder/path"
+require "trailblazer/v2_1/activity/dsl/magnetic/builder/railway"
+require "trailblazer/v2_1/activity/dsl/magnetic/builder/fast_track" # TODO: move to Operation gem.
+
+require "trailblazer/v2_1/activity/dsl/magnetic/generate"
+require "trailblazer/v2_1/activity/dsl/magnetic/finalizer"