ntl-orchestra 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 04d7c524d1821f1d2dcaec41a3a567c906b69830
-  data.tar.gz: 7be0bf35060a1714d0edb8d6489d49f46011ac13
-SHA512: 
-  metadata.gz: 82a9d1d61b21cbd09464027b6a72c43fc433979ec851be8906b3f7eb590c7baad62ef200cae5cb21a86ab4a20551c34c744aa801d30601d9d7e2b147fb9a0d89
-  data.tar.gz: b8101d3196af1ffbb1f7faa578c3f665d76d102395331fcda4242b6b9e0e48cfa5d71976c91cc24f00ecdd3d0a91508733eb4be58b89e587b32df799d5f2f70a
+---
+SHA1:
+  metadata.gz: e96984bfe46ae0b8f9769e7d2a63fcfc2d3efc04
+  data.tar.gz: 35665deb648f6be6360f566d4d504b7e609e28d0
+SHA512:
+  metadata.gz: 9af68198925832621e1a08a4fb34c2da7881a44aab59f350485c2a4e6845ecdbd2631e089315e392bf5047453ae67a20eaf07bdf5ce3535bf148c4445cfaf646
+  data.tar.gz: 99e4ed20368788e954eab33f8bd79ddc7c329cf0fec6ef13fc7fec550fe06b78df1b9362c7f7d5093d21a2b0422bd6c139d49b72a435b871798ca5a000db5f6a

data/README.md

@@ -466,14 +466,14 @@ end
 
 The arguments passed to `update` will vary based on the event:
 
-| Event                    | First argument                       | Second argument                   |
-| ------------------------ | ------------------------------------ | --------------------------------- |
-| `:operation_entered`     | The name of the operation starting   | Input going into the operation    |
-| `:operation_exited`      | The name of the operation finishing  | Output of the operation           |
-| `:step_entered`          | The name of the step                 | Input going into the step         |
-| `:step_exited`           | The name of the step                 | Output of the step                |
-| `:error_raised`          | The error itself                     | `nil`                             |
-| `:service_accessed`      | The name of the service              | Recording of the service call     |
+| Event                    | First argument          | Second argument                   |
+| ------------------------ | ----------------------- | --------------------------------- |
+| `:operation_entered`     | The Operation starting  | Input going into the operation    |
+| `:operation_exited`      | The Operation finishing | Output of the operation           |
+| `:step_entered`          | The Step                | Input going into the step         |
+| `:step_exited`           | The Step                | Output of the step                |
+| `:error_raised`          | The error itself        | `nil`                             |
+| `:service_accessed`      | The name of the service | Recording of the service call     |
 
 All observers attached to the execution of the outer operation will also attach to the inner operation.
 

data/lib/orchestra/dsl/object_adapter.rb

@@ -42,6 +42,14 @@ module Orchestra
       def dependencies
         [collection, *object_method.dependencies].compact
       end
+
+      def name
+        if method_name == :execute
+          object.name
+        else
+          "#{object.name}##{method_name}"
+        end
+      end
     end
 
     class SingletonAdapter < ObjectAdapter

data/lib/orchestra/dsl/operations.rb

@@ -57,15 +57,15 @@ module Orchestra
         end
 
         def build_object_step object, args
-          name = object_name object
           step = ObjectAdapter.build_step object, args
+          name = object_name step.adapter
           [name, step]
         end
 
         private
 
         def object_name object
-          object.name and Util.to_snake_case Util.demodulize object.name
+          object.name and Util.to_snake_case object.name
         end
       end
 
@@ -91,8 +91,9 @@ module Orchestra
           nil
         end
 
-        def result name = nil, &block
-          step = @builder.add_step name, &block
+        def result *args, &block
+          args << nil if args.empty?
+          step = @builder.add_step *args, &block
           name ||= step.provisions.fetch 0
           self.result = name
         end

data/lib/orchestra/execution.rb

@@ -2,13 +2,16 @@ module Orchestra
   module Execution
     extend self
 
-    def start_operation *args
-      Operation.new *args
+    def build operation, conductor, input = {}
+      run_list = RunList.build operation.steps, operation.result, input.keys
+      node = Node.new run_list, operation.name, input
+      Operation.new conductor, run_list, input, node
     end
 
     def execute_step step, input
-      operation_execution = Operation.new Conductor.new, {}, input
-      Step.execute step, 'anonymous', operation_execution
+      node = Node.new step, 'anonymous', input
+      operation_execution = Operation.new Conductor.new, {}, input, node
+      Step.execute step, node.name, operation_execution
     end
 
     class Operation
@@ -18,24 +21,32 @@ module Orchestra
       def_delegators :@run_list, :provisions, :dependencies,
         :optional_dependencies, :required_dependencies
 
-      attr :conductor, :input, :state, :registry, :run_list
+      attr :conductor, :input, :node, :registry, :run_list, :state
 
-      def initialize conductor, run_list, input
+      def initialize conductor, run_list, input, node
         @conductor = conductor
         @input = input.dup
+        @node = node
         @run_list = run_list
         @registry = conductor.build_registry self
         @state = registry.merge input
       end
 
       def execute
+        publish :operation_entered, node, node.input if node
         ensure_inputs_are_present!
         run_list.each do |name, step| process name, step end
+        publish :operation_exited, node, output if node
+        output
       rescue => error
         publish :error_raised, error
         raise error
       end
 
+      def output
+        state.fetch run_list.result
+      end
+
       def process name, step
         output = Step.execute step, name, self
         state.merge! output
@@ -47,10 +58,6 @@ module Orchestra
         raise MissingInputError.new missing_input unless missing_input.empty?
       end
 
-      def extract_result result
-        state.fetch result
-      end
-
       def publish event, *payload
         changed
         notify_observers event, *payload
@@ -78,7 +85,7 @@ module Orchestra
         instance
       end
 
-      attr :context, :name, :operation_execution, :step
+      attr :context, :name, :node, :operation_execution, :step
 
       def initialize step, name, operation_execution
         @name = name
@@ -88,9 +95,10 @@ module Orchestra
       end
 
       def execute
-        operation_execution.publish :step_entered, name, input
+        @node = Node.new step, name, input
+        operation_execution.publish :step_entered, node, node.input
         output = step.process invoke
-        operation_execution.publish :step_exited, name, output
+        operation_execution.publish :step_exited, node, output
         output
       end
 
@@ -108,6 +116,10 @@ module Orchestra
       def build_context
         step.build_context operation_execution.state
       end
+
+      def to_node
+        Node.new step, name
+      end
     end
 
     class CollectionStep < Step

data/lib/orchestra/node.rb

@@ -0,0 +1,52 @@
+module Orchestra
+  # Reader object to expose operations and steps to the outside world
+  class Node
+    attr :input, :name
+
+    extend Forwardable
+
+    def_delegators :@node, :provisions, :dependencies, :optional_dependencies,
+      :required_dependencies
+
+    def initialize step_or_operation, name, input
+      @name = name
+      @node = step_or_operation
+      @input = format_input input
+      freeze
+    end
+
+    def to_h
+      {
+        dependencies: dependencies,
+        input: input,
+        name: name,
+        optional_dependencies: optional_dependencies,
+        provisions: provisions,
+        required_dependencies: required_dependencies,
+      }
+    end
+
+    def inspect
+      params = to_h.each_with_object [] do |(key, val), list|
+        list << "#{key}=#{val.inspect}"
+      end
+      "#<Orchestra::Node #{params.join ', '}>"
+    end
+
+    def operation?
+      @node.is_a? Operation
+    end
+
+    def step?
+      not operation?
+    end
+
+    private
+
+    def format_input input
+      @node.dependencies.each_with_object Hash.new do |dep, hsh|
+        hsh[dep] = input[dep] if input.has_key? dep
+      end
+    end
+  end
+end

data/lib/orchestra/operation.rb

@@ -27,23 +27,19 @@ module Orchestra
       output.select do |key, _| key = result end
     end
 
+    def execute *args, &block
+      execution = start_execution *args, &block
+      output = execution.execute
+      @command ? nil : output
+    end
+
     def start_execution *args
       conductor, input = extract_args args
-      run_list = RunList.build steps, result, input.keys
-      execution = Execution.start_operation conductor, run_list, input
+      execution = Execution.build self, conductor, input
       yield execution if block_given?
-      execution.publish :operation_entered, name, input
       execution
     end
 
-    def execute *args, &block
-      execution = start_execution *args, &block
-      execution.execute
-      output = execution.extract_result result
-      execution.publish :operation_exited, name, output
-      @command ? nil : output
-    end
-
     def command?
       @command ? true : false
     end

data/lib/orchestra/run_list.rb

@@ -6,9 +6,12 @@ module Orchestra
       builder.build
     end
 
+    attr :result
+
     include Enumerable
 
-    def initialize steps
+    def initialize steps, result
+      @result = result
       @steps = steps
       @steps.freeze
       freeze
@@ -84,7 +87,7 @@ module Orchestra
       def build
         sort!
         prune!
-        RunList.new @steps_hash
+        RunList.new @steps_hash, @result
       end
 
       def sort!

data/lib/orchestra/version.rb

@@ -1,3 +1,3 @@
 module Orchestra
-  VERSION = "0.9.3" unless defined? VERSION
+  VERSION = "0.9.4" unless defined? VERSION
 end

data/test/support/telemetry_recorder.rb

@@ -14,29 +14,29 @@ class TelemetryRecorder
     @embedded
   end
 
-  def handle_operation_entered operation_name, input
+  def handle_operation_entered operation, input
     return if embedded?
     @steps = Hash.new do |hsh, key| hsh[key] = {} end
     @store.update(
       :input => input,
       :movements => @steps,
-      :operation_name => operation_name,
+      :operation_name => operation.name,
       :service_calls => [],
     )
     @embedded = true
   end
 
-  def handle_operation_exited operation_name, output
+  def handle_operation_exited operation, output
     @store[:output] = output
     @embedded = false
   end
 
-  def handle_step_entered name, input
-    @steps[name][:input] = input
+  def handle_step_entered step, input
+    @steps[step.name][:input] = input
   end
 
-  def handle_step_exited name, output
-    @steps[name][:output] = output
+  def handle_step_exited step, output
+    @steps[step.name][:output] = output
   end
 
   def handle_error_raised error

data/test/unit/node_test.rb

@@ -0,0 +1,10 @@
+class NodeTest < Minitest::Test
+  def test_inspect
+    node = Orchestra::Node.new Examples::FizzBuzz, "Examples::FizzBuzz", {}
+
+    assert_equal(
+      "#<Orchestra::Node dependencies=[:array, :fizzbuzz, :io, :up_to], input={}, name=\"Examples::FizzBuzz\", optional_dependencies=[], provisions=[:array, :fizzbuzz, :print], required_dependencies=[:io, :up_to]>",
+      node.inspect,
+    )
+  end
+end

data/test/unit/object_adapter_test.rb

@@ -27,13 +27,7 @@ class ObjectAdapterTest < Minitest::Test
   end
 
   def test_executing_an_operation_with_integrated_objects
-    operation = Orchestra::Operation.new do
-      step Splitter, :provides => :words
-      step Upcaser, :iterates_over => :words, :provides => :upcased_words, :method => :call
-      step Bolder, :iterates_over => :upcased_words, :provides => :bolded_words, :method => :call
-      step Joiner, :method => :join
-      self.result = :joiner
-    end
+    operation = integrated_objects_operation
 
     result = Orchestra.execute(
       operation,
@@ -60,10 +54,36 @@ class ObjectAdapterTest < Minitest::Test
     )
   end
 
+  def test_name_includes_method_when_not_using_execute
+    assert_equal(
+      %i(
+        object_adapter_test/splitter
+        object_adapter_test/upcaser#call
+        object_adapter_test/bolder#call
+        object_adapter_test/joiner#join
+      ),
+      integrated_objects_operation.steps.keys,
+    )
+  end
+
+  private
+
+  def integrated_objects_operation
+    Orchestra::Operation.new do
+      step Splitter, :provides => :words
+      step Upcaser, :iterates_over => :words, :provides => :upcased_words, :method => :call
+      step Bolder, :iterates_over => :upcased_words, :provides => :bolded_words, :method => :call
+      result Joiner, :method => :join
+    end
+  end
+
   module Splitter
-    def self.execute sentence
+    extend self
+
+    def execute sentence
       sentence.split %r{[[:space:]]+}
     end
+    alias_method :call, :execute
   end
 
   class Upcaser

metadata

@@ -1,67 +1,81 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ntl-orchestra
-version: !ruby/object:Gem::Version 
-  version: 0.9.3
+version: !ruby/object:Gem::Version
+  version: 0.9.4
 platform: ruby
-authors: 
+authors:
 - ntl
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2015-01-08 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id003 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+date: 2015-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: invokr
-  prerelease: false
-  version_requirements: *id001
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.6"
-  name: bundler
   prerelease: false
-  version_requirements: *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id003
-  name: pry
   prerelease: false
-  version_requirements: *id004
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "10.0"
-  name: rake
   prerelease: false
-  version_requirements: *id005
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
   type: :development
-description: Orchestra is an orchestration framework for designing complex operations in an object oriented fashion.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Orchestra is an orchestration framework for designing complex operations
+  in an object oriented fashion.
+email:
 - nathanladd+github@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .travis.yml
+files:
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -76,6 +90,7 @@ files:
 - lib/orchestra/dsl/steps.rb
 - lib/orchestra/errors.rb
 - lib/orchestra/execution.rb
+- lib/orchestra/node.rb
 - lib/orchestra/operation.rb
 - lib/orchestra/recording.rb
 - lib/orchestra/recording/playback.rb
@@ -97,6 +112,7 @@ files:
 - test/test_helper.rb
 - test/unit/conductor_test.rb
 - test/unit/dsl_test.rb
+- test/unit/node_test.rb
 - test/unit/object_adapter_test.rb
 - test/unit/operation_test.rb
 - test/unit/run_list_test.rb
@@ -105,29 +121,30 @@ files:
 - test/unit/util_test.rb
 - tmp/.keep
 homepage: https://github.com/ntl/orchestra
-licenses: 
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id003
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id003
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Orchestrate complex operations with ease.
-test_files: 
+test_files:
 - test/examples/fizz_buzz.rb
 - test/examples/invitation_service.rb
 - test/integration/multithreading_test.rb
@@ -139,6 +156,7 @@ test_files:
 - test/test_helper.rb
 - test/unit/conductor_test.rb
 - test/unit/dsl_test.rb
+- test/unit/node_test.rb
 - test/unit/object_adapter_test.rb
 - test/unit/operation_test.rb
 - test/unit/run_list_test.rb