trailblazer-operation 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3347429bc2a448f6f41390b5d70aea2076d32235acb78f51563fbcb8f935f8e
-  data.tar.gz: 68200b340b34a5965cd773921b8282a4eb0f0ad56ae87e1b7ad2585a362cc02a
+  metadata.gz: 228e261fc19eec5d741437141b0eae01552aaaf08caa617c2ad2a3f226e5fa94
+  data.tar.gz: f316ca1a182fc7f8b730f89d59b0e575e9a43365b571486079f7b95e6749717d
 SHA512:
-  metadata.gz: 6824c50e6c8f48b587afc1e8a2f08b3b1813379c811f6b1017c6088bdd9836c445839a20cec3ac1407b33290ea5c4a1d3ee47da77854de8bfde7bf24a4230662
-  data.tar.gz: b0fb9530502238b3bfab54311c93793a4c4f028091ba72a7f9e71a3eb1f760edb077577d2e542d06d6650c392b160f464a44c6f1c7d90d79b9447e468f6935c3
+  metadata.gz: ca04555c63aabc959539399ae7daf3e11b79c5ffb946326abb9abbf1db284379f4bacc19f7ee9013bacbb7735f35b350e42f2e17b38278fed9f9c259524264b1
+  data.tar.gz: 54ba90ec3dd1f4977fffc95ab20a93a625b341fd74f110416ae4dd28cd3a9fb2e6960378e6e3deb93ac7b39decccc4011c7e5716233ab928ca70e0295206c628

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from:
+  - https://raw.githubusercontent.com/trailblazer/meta/master/rubocop.yml
+  - .rubocop_todo.yml
+
+Naming/MethodName:
+  Exclude:
+    - 'lib/trailblazer/operation/inject.rb'
+    - 'lib/trailblazer/operation.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,223 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-04-05 17:28:56 +1100 using RuboCop version 0.58.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'trailblazer-operation.gemspec'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Layout/CommentIndentation:
+  Exclude:
+    - 'lib/trailblazer/operation/version.rb'
+    - 'test/wiring/defaults_test.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAdjacentOneLineDefs, NumberOfEmptyLines.
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - 'lib/trailblazer/operation.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'lib/trailblazer/operation.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'lib/trailblazer/operation.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/SpaceBeforeSemicolon:
+  Exclude:
+    - 'lib/trailblazer/operation.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceInsideParens:
+  Exclude:
+    - 'lib/trailblazer/operation.rb'
+
+# Offense count: 2
+Lint/ShadowingOuterLocalVariable:
+  Exclude:
+    - 'lib/trailblazer/operation/deprecated_macro.rb'
+    - 'lib/trailblazer/operation/public_call.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'lib/trailblazer/operation/inspect.rb'
+
+# Offense count: 2
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/trailblazer/operation/public_call.rb'
+    - 'lib/trailblazer/operation/trace.rb'
+
+# Offense count: 46
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 255
+
+# Offense count: 2
+Naming/ConstantName:
+  Exclude:
+    - 'lib/trailblazer/operation/inspect.rb'
+    - 'lib/trailblazer/operation/version.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/StringReplacement:
+  Exclude:
+    - 'lib/trailblazer/operation/inspect.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/BlockComments:
+  Exclude:
+    - 'test/docs/wiring_test.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# IgnoredMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'lib/trailblazer/operation/inspect.rb'
+    - 'test/step_test.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: braces, no_braces, context_dependent
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'lib/trailblazer/operation/public_call.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: is_a?, kind_of?
+Style/ClassCheck:
+  Exclude:
+    - 'lib/trailblazer/operation/railway.rb'
+
+# Offense count: 2
+Style/CommentedKeyword:
+  Exclude:
+    - 'lib/trailblazer/operation/railway.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/DefWithParentheses:
+  Exclude:
+    - 'lib/trailblazer/operation.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'trailblazer-operation.gemspec'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: format, sprintf, percent
+Style/FormatString:
+  Exclude:
+    - 'lib/trailblazer/operation/inspect.rb'
+
+# Offense count: 1
+# Configuration parameters: .
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+# Offense count: 3
+Style/MethodCalledOnDoEndBlock:
+  Exclude:
+    - 'lib/trailblazer/operation/inspect.rb'
+    - 'test/step_test.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/trailblazer/operation/inspect.rb'
+    - 'lib/trailblazer/operation/version.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ParallelAssignment:
+  Exclude:
+    - 'lib/trailblazer/operation/result.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: only_raise, only_fail, semantic
+Style/SignalException:
+  Exclude:
+    - 'test/operation_test.rb'
+    - 'test/ruby-2.0.0/operation_test.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: use_perl_names, use_english_names
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'trailblazer-operation.gemspec'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'trailblazer-operation.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInHashLiteral:
+  Exclude:
+    - 'lib/trailblazer/operation.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'trailblazer-operation.gemspec'

data/.travis.yml

@@ -1,17 +1,16 @@
 language: ruby
 before_install:
-  - gem install bundler
+  - gem install bundler -v 1.17.3
 matrix:
   include:
-    # - rvm: 2.0.0
-    #   gemfile: "test/gemfiles/Gemfile.ruby-2.0"
-    - rvm: 2.1
-      gemfile: Gemfile
+    # - rvm: 2.1.0
+    #   gemfile: Gemfile
     - rvm: 2.2.4
       gemfile: Gemfile
     - rvm: 2.3.3
       gemfile: Gemfile
     - rvm: 2.4.0
       gemfile: Gemfile
-    - rvm: jruby-9.1.13.0
-      env: JRUBY_OPTS="--profile.api"
+    - rvm: 2.5.0
+      gemfile: Gemfile
+      script: bundle exec rake test

data/CHANGES.md

@@ -1,18 +1,22 @@
-TODO:
-* api to add your own task.
+## 0.6.0
 
-lots of work on the DSL specific parts.
-    Graph and Sequence to make it easier to wire anything.
-    macros can now add/modify the wiring, e.g. their end to the our end or the next task.
-    [ use circuit for actual step_args/initialize process, too? ]
-    You can now add an unlimited number of "your own" end events, which can then be interpreted on the outside (e.g. Endpoint)
-* Introduced the `fast_track: true` option for steps. If you were returning `Railway.fail_fast!` and the like, you now need to declare that option, e.g.
+* Require newest `activity` gem.
 
-        ```ruby
-        step :my_validate!, fast_track: true
-        ```
+## 0.5.3
 
-params:, rest: ..
+* New `context` API.
+
+## 0.5.2
+
+* Use `trailblazer-activity-dsl-linear-0.1.6.`
+
+## 0.5.1
+
+* Remove Inspect. this now sits in the `developer` gem as `Developer.railway`.
+
+## 0.5.0
+
+* Minimal API around `Activity::FastTrack` to support the old public call style.
 
 
 ## 0.4.1

data/Gemfile

@@ -7,9 +7,11 @@ gem "multi_json"
 
 gem "dry-auto_inject"
 
-gem "minitest-line"
 gem "benchmark-ips"
+gem "minitest-line"
 
-# gem "trailblazer-developer", path: "../developer"
+# gem "trailblazer-developer", path: "../trailblazer-developer"
 # gem "trailblazer-developer", git: "https://github.com/trailblazer/trailblazer-developer"
-gem "trailblazer-activity", path: "../trailblazer-activity"
+# 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

@@ -1,6 +1,17 @@
-## Goal
+# Trailblazer-operation
 
-* Make `Operation` an imutable object without having to expose @instance variables. This is now done via the Result object.
+_Trailblazer's Operation implementation._
+
+## Overview
+
+An operation is a pattern from the Trailblazer architecture. It implements a public function such as "create user" or "archive blog post". Internally, an operation is simply a generic _activity_ that uses an existing DSL to help you creating the operation's flow.
+
+An operation is identical to an activity with two additions.
+
+* A public `call` method with a simplified signature `Create.call(params: params, current_user: @user)`
+* It produces a `Result` object with the popular `success?` API.
+
+An operation can be used exaclty like an activity, including nesting, tracing, etc.
 
 ## Copyright
 

data/Rakefile

@@ -1,8 +1,6 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-task :default => [:test]
-
 Rake::TestTask.new(:test) do |test|
   test.libs << "test"
   test.verbose = true
@@ -19,3 +17,5 @@ Rake::TestTask.new(:test) do |test|
 
   test.test_files = test_files
 end
+
+task :default => %i[test]

data/lib/trailblazer/operation.rb

@@ -1,91 +1,76 @@
-require "forwardable"
-
-# trailblazer-context
 require "trailblazer/option"
 require "trailblazer/context"
 require "trailblazer/container_chain"
 
 require "trailblazer/activity"
-require "trailblazer/activity/dsl/magnetic"
-
-
-require "trailblazer/operation/callable"
+require "trailblazer/activity/dsl/linear"
 
-require "trailblazer/operation/heritage"
-require "trailblazer/operation/public_call"      # TODO: Remove in 3.0.
-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/operation/railway/fast_track"
-require "trailblazer/operation/railway/normalizer"
-require "trailblazer/operation/trace"
-
-require "trailblazer/operation/railway/macaroni"
 
 module Trailblazer
-  # The Trailblazer-style operation.
-  # Note that you don't have to use our "opinionated" version with result object, skills, etc.
-  class Operation
-
-    module FastTrackActivity
-      builder_options = {
-        track_end:     Railway::End::Success.new(semantic: :success),
-        failure_end:   Railway::End::Failure.new(semantic: :failure),
-        pass_fast_end: Railway::End::PassFast.new(semantic: :pass_fast),
-        fail_fast_end: Railway::End::FailFast.new(semantic: :fail_fast),
-      }
-
-      extend Activity::FastTrack( pipeline: Railway::Normalizer::Pipeline, builder_options: builder_options )
+  # DISCUSS: I don't know where else to put this. It's not part of the {Activity} concept
+  class Activity
+    class Railway
+      module End
+        # @private
+        class Success < Activity::End; end
+        class Failure < Activity::End; end
+
+        class FailFast < Failure; end
+        class PassFast < Success; end
+      end
     end
 
-    extend Skill::Accessors        # ::[] and ::[]= # TODO: fade out this usage.
-
-    def self.inherited(subclass)
-      super
-      subclass.initialize!
-      heritage.(subclass)
+    module Operation
+      def self.OptionsForState()
+        {
+          end_task:      Activity::Railway::End::Success.new(semantic: :success),
+          failure_end:   Activity::Railway::End::Failure.new(semantic: :failure),
+          fail_fast_end: Activity::Railway::End::FailFast.new(semantic: :fail_fast),
+          pass_fast_end: Activity::Railway::End::PassFast.new(semantic: :pass_fast),
+        }
+      end
     end
+  end
 
-    def self.initialize!
-      @activity = FastTrackActivity.clone
+  def self.Operation(options)
+    Class.new(Activity::FastTrack( Activity::Operation.OptionsForState.merge(options) )) do
+      extend Operation::PublicCall
     end
+  end
 
+  # The Trailblazer-style operation.
+  # Note that you don't have to use our "opinionated" version with result object, skills, etc.
+  class Operation < Activity::FastTrack(Activity::Operation.OptionsForState)
+    # extend Skill::Accessors # ::[] and ::[]= # TODO: fade out this usage.
 
-    extend Activity::Interface
-
-    module Process
-      def to_h
-        @activity.to_h.merge( activity: @activity )
-      end
+    class << self
+      alias_method :strategy_call, :call
     end
 
-    extend Process # make ::call etc. class methods on Operation.
+    require "trailblazer/operation/public_call"      # TODO: Remove in 3.0.
+    extend PublicCall              # ::call(params, { current_user: .. })
 
-    extend Heritage::Accessor
+    require "trailblazer/operation/trace"
+    extend Trace                   # ::trace
 
-    class << self
-      extend Forwardable # TODO: test those helpers
-      def_delegators :@activity, :Path, :Output, :End, :Track
-      def_delegators :@activity, :outputs
+    module Railway
+      def self.fail!     ; Activity::Left  end
+      def self.pass!     ; Activity::Right end
+      def self.fail_fast!; Activity::FastTrack::FailFast end
+      def self.pass_fast!; Activity::FastTrack::PassFast end
+    end
+  end
+end
 
-      def step(task, options={}, &block); add_task!(:step, task, options, &block) end
-      def pass(task, options={}, &block); add_task!(:pass, task, options, &block) end
-      def fail(task, options={}, &block); add_task!(:fail, task, options, &block) end
+require "trailblazer/operation/class_dependencies"
+require "trailblazer/operation/deprecated_macro" # TODO: remove in 2.2.
 
-      alias_method :success, :pass
-      alias_method :failure, :fail
+require "trailblazer/operation/result"
+require "trailblazer/operation/railway"
 
-      def add_task!(name, task, options, &block)
-        heritage.record(name, task, options, &block)
-        @activity.send(name, task, options, &block)
-      end
-    end
+require "trailblazer/developer"
+require "trailblazer/operation/trace"
 
-    extend PublicCall              # ::call(params, { current_user: .. })
-    extend Trace                   # ::trace
-  end
-end
+require "trailblazer/operation/railway/macaroni"
 
-require "trailblazer/operation/inspect"
+require "trailblazer/operation/container"