ntl-orchestra 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e96984bfe46ae0b8f9769e7d2a63fcfc2d3efc04
-  data.tar.gz: 35665deb648f6be6360f566d4d504b7e609e28d0
+  metadata.gz: 3c1897824735843933375a596888e93eb404fe49
+  data.tar.gz: d29cfbda3e69e845132c79b2cc7784c410851b39
 SHA512:
-  metadata.gz: 9af68198925832621e1a08a4fb34c2da7881a44aab59f350485c2a4e6845ecdbd2631e089315e392bf5047453ae67a20eaf07bdf5ce3535bf148c4445cfaf646
-  data.tar.gz: 99e4ed20368788e954eab33f8bd79ddc7c329cf0fec6ef13fc7fec550fe06b78df1b9362c7f7d5093d21a2b0422bd6c139d49b72a435b871798ca5a000db5f6a
+  metadata.gz: f870d33006961640028804fb1103a04815a81d631dc11ea1ac71801fb22da9ca1a87e56cce78de5e9d3488dc73c532d3737164dace444ba3eecb72e8f6b75a2f
+  data.tar.gz: 6dbcb3009f801d14e81447d00a86793c61253284f7f8ac863a06e6d113de53811da672867382ab3e59b41040ca6c19cbe08fd2307b44f60eac01dda4060381af

data/README.md

@@ -491,13 +491,13 @@ recording.output # <-- the usual output is attached to the recording itself
 And a recording can be replayed:
 
 ```ruby
-Orchestra.replay_recording InvitationService, recording
+recording.replay InvitationService
 ```
 
 You can override the inputs passed in when replaying:
 
 ```ruby
-Orchestra.replay_recording InvitationService, recording, :account_name => "dhh"
+recording.replay InvitationService, :account_name => "dhh"
 ```
 
 If you want to serialize/persist the recording, just use `JSON.dump`:
@@ -511,8 +511,8 @@ You can replay the recording using `JSON.load`:
 
 ```ruby
 json = File.read "tmp/recording.json"
-recording = JSON.load json
-Orchestra.replay_recording InvitationService, recording
+recording = Orchestra::Recording(JSON.load json, symbolize_names: true)
+recording.replay InvitationService
 ```
 
 ## Installation

data/lib/orchestra.rb

@@ -1,7 +1,6 @@
 require "forwardable"
 require "invokr"
 require "observer"
-require "securerandom"
 
 module Orchestra
   extend self
@@ -14,16 +13,5 @@ module Orchestra
     Conductor.new.execute operation, inputs
   end
 
-  def replay_recording operation, store, input = {}
-    store = Util.recursively_symbolize store
-    input = input.merge store[:input]
-    svc_recordings = store[:service_recordings]
-    Recording.replay operation, input, svc_recordings
-  end
-
-  load File.expand_path('../orchestra/errors.rb', __FILE__)
-end
-
-Dir[File.expand_path '../orchestra/**/*.rb', __FILE__].each do |rb_file|
-  load rb_file
+  Dir[File.expand_path '../orchestra/**/*.rb', __FILE__].each &method(:load)
 end

data/lib/orchestra/conductor.rb

@@ -7,6 +7,9 @@ module Orchestra
       @thread_pool = ThreadPool.new
       @observers = Set.new
       self.thread_count = Configuration.thread_count
+      if block_given?
+        raise ArgumentError, "Supplied block to Conductor.new; did you mean to invoke Orchestra::Operation.new do … end?"
+      end
     end
 
     def execute operation, input = {}
@@ -17,7 +20,7 @@ module Orchestra
     end
 
     def record *args
-      recording = Recording.new
+      recording = Recording.fresh
       add_observer recording
       execute *args do |execution|
         execution.add_observer recording
@@ -91,10 +94,10 @@ module Orchestra
         alias_method :__getobj__, :service
         alias_method :__setobj__, :service=
 
-          def initialize service, recording
-            super service
-            @recording = recording
-          end
+        def initialize service, recording
+          super service
+          @recording = recording
+        end
 
         def kind_of? klass
           super or service.kind_of? klass

data/lib/orchestra/dsl/operations.rb

@@ -20,7 +20,6 @@ module Orchestra
 
         def add_step name_or_object, args = {}, &block
           name, step = case name_or_object
-          when nil then build_anonymous_step block
           when Operation then build_embedded_operation_step name_or_object
           when ::String, ::Symbol then build_inline_step name_or_object, block
           else build_object_step name_or_object, args
@@ -37,15 +36,6 @@ module Orchestra
           step.freeze
         end
 
-        def build_anonymous_step block
-          step = Step::InlineStep.build &block
-          unless step.provisions.size == 1
-            raise ArgumentError, "Could not infer name for step from a provision"
-          end
-          name = step.provisions.fetch 0
-          [name, step]
-        end
-
         def build_embedded_operation_step operation
           name = object_name operation
           [name || operation.result, operation]
@@ -92,7 +82,7 @@ module Orchestra
         end
 
         def result *args, &block
-          args << nil if args.empty?
+          args << :result if args.empty?
           step = @builder.add_step *args, &block
           name ||= step.provisions.fetch 0
           self.result = name

data/lib/orchestra/errors.rb

@@ -13,12 +13,18 @@ module Orchestra
   end
 
   class MissingProvisionError < Error
+    attr_writer :name
+
     def initialize missing_provisions
       @missing_provisions = missing_provisions
     end
 
+    def name
+      @name ||= "<anonymous>"
+    end
+
     def to_s
-      "failed to supply output: #{list_out @missing_provisions}"
+      "Node `#{name}' failed to supply output: #{list_out @missing_provisions}"
     end
   end
 

data/lib/orchestra/execution.rb

@@ -4,12 +4,12 @@ module Orchestra
 
     def build operation, conductor, input = {}
       run_list = RunList.build operation.steps, operation.result, input.keys
-      node = Node.new run_list, operation.name, input
+      node = Recording::Node.new run_list, operation.name, input
       Operation.new conductor, run_list, input, node
     end
 
     def execute_step step, input
-      node = Node.new step, 'anonymous', input
+      node = Recording::Node.new step, 'anonymous', input
       operation_execution = Operation.new Conductor.new, {}, input, node
       Step.execute step, node.name, operation_execution
     end
@@ -50,6 +50,9 @@ module Orchestra
       def process name, step
         output = Step.execute step, name, self
         state.merge! output
+      rescue MissingProvisionError => error
+        error.name = name.inspect
+        raise error
       end
 
       def ensure_inputs_are_present!
@@ -95,7 +98,7 @@ module Orchestra
       end
 
       def execute
-        @node = Node.new step, name, input
+        @node = Recording::Node.new step, name, input
         operation_execution.publish :step_entered, node, node.input
         output = step.process invoke
         operation_execution.publish :step_exited, node, output

data/lib/orchestra/recording.rb

@@ -1,9 +1,15 @@
 module Orchestra
   class Recording
-    attr :input, :output, :services
+    def self.fresh
+      services = Hash.new do |hsh, service_name| hsh[service_name] = [] end
+      new services
+    end
+
+    attr_accessor :input, :output
+    attr :services
 
-    def initialize
-      @services = Hash.new do |hsh, service_name| hsh[service_name] = [] end
+    def initialize services
+      @services = services
     end
 
     def update event_name, *args
@@ -19,10 +25,14 @@ module Orchestra
       end
     end
 
+    def [] attr
+      to_h[attr]
+    end
+
     def to_h
       {
-        :input => input,
-        :output => output,
+        :input              => input,
+        :output             => output,
         :service_recordings => services,
       }
     end
@@ -31,13 +41,20 @@ module Orchestra
       generator.generate to_h
     end
 
-    def self.replay operation, input, service_recordings
+    def replay operation, override_input = {}
       replayed_services = {}
-      service_recordings.each do |svc, service_recording|
+      services.each do |svc, service_recording|
         replayed_services[svc] = Playback.build service_recording
       end
       conductor = Conductor.new replayed_services
-      conductor.execute operation, input
+      conductor.execute operation, input.merge(override_input)
     end
   end
+
+  def Recording serialized_recording
+    recording = Recording.new serialized_recording[:service_recordings]
+    recording.input = serialized_recording[:input]
+    recording.output = serialized_recording[:output]
+    recording.freeze
+  end
 end

data/lib/orchestra/recording/node.rb

@@ -0,0 +1,54 @@
+module Orchestra
+  class Recording
+    # 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
+end

data/lib/orchestra/run_list.rb

@@ -61,7 +61,7 @@ module Orchestra
       def initialize result, input_names = []
         @input_names = input_names
         @steps_hash = {}
-        @required = [result]
+        @required = Set.new [result]
         @result = result
         freeze
       end
@@ -109,8 +109,10 @@ module Orchestra
 
       def require step
         supplied_by_input = input_names.method :include?
-        deps = step.required_dependencies.reject &supplied_by_input
-        @required.concat deps
+        required_deps = step.required_dependencies.reject &supplied_by_input
+        @required.merge required_deps
+        required = @required.method :include?
+        @required.merge step.optional_dependencies.reject &required
         true
       end
 

data/lib/orchestra/util.rb

@@ -23,18 +23,6 @@ module Orchestra
       [hsh, ary]
     end
 
-    def recursively_symbolize obj
-      case obj
-      when Array
-        obj.map &method(:recursively_symbolize)
-      when Hash then
-        obj.each_with_object Hash.new do |(k, v), out_hsh|
-          out_hsh[k.to_sym] = recursively_symbolize v
-        end
-      else obj
-      end
-    end
-
     def to_lazy_thunk obj
       if obj.respond_to? :to_proc and not obj.is_a? Symbol
         obj

data/lib/orchestra/version.rb

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

data/orchestra.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^test/})
   spec.require_paths = %w(lib)
 
-  spec.add_dependency "invokr"
+  spec.add_dependency "invokr", "~> 0.9.7"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "pry"

data/test/examples/fizz_buzz.rb

@@ -21,12 +21,28 @@ module Examples
       end
     end
 
-    finally :print do
-      depends_on :io
+    finally do
+      depends_on :stdout
       iterates_over :fizzbuzz
       execute do |str|
-        io.puts str
+        stdout.puts str
       end
     end
   end
+
+  InteractiveFizzBuzz = Orchestra::Operation.new do
+    step :prompt_user do
+      depends_on :stdin, :stdout
+      provides :up_to
+      execute do
+        stdout.puts "How high would you like to go?"
+        stdout.print " => "
+        stdout.flush
+        value = stdin.gets
+        value.to_i
+      end
+    end
+
+    finally Examples::FizzBuzz
+  end
 end

data/test/examples/invitation_service.rb

@@ -8,7 +8,7 @@ module Examples
       provides :followers
       execute do
         json = http.get "flutter.io", "/users/#{account_name}/followers"
-          JSON.parse json
+        JSON.parse json
       end
     end
 

data/test/integration/recording_telemetry_test.rb

@@ -46,7 +46,7 @@ class RecordingTelemetryTest < Minitest::Test
             ],
           },
         },
-        :print => {
+        :__finally__ => {
           :input => {
             :fizzbuzz => [
               "1",
@@ -66,15 +66,15 @@ class RecordingTelemetryTest < Minitest::Test
               "FizzBuzz",
             ],
           },
-          :output => { :print => [] },
+          :output => { :__finally__ => [] },
         }
       },
       :output => [],
     }
   end
 
-  def execute_with_telemetry telemetry, io
-    conductor = Orchestra::Conductor.new :io => io
+  def execute_with_telemetry telemetry, stdout
+    conductor = Orchestra::Conductor.new :stdout => stdout
 
     conductor.add_observer TelemetryRecorder.new telemetry
 

data/test/integration/replayable_operation_test.rb

@@ -1,3 +1,5 @@
+require "yaml"
+
 class ReplayableOperationTest < Minitest::Test
   include Examples::InvitationService::TestSetup
 
@@ -6,16 +8,20 @@ class ReplayableOperationTest < Minitest::Test
     recording = execute_for_real
 
     # Write the recording out to a file. In this case, a StringIO is used for
-    # simplicity, and we serialize into JSON
+    # simplicity, and we serialize into JSON. The to_h is important as
+    # hashes can be coerced back into Recording objects.
     file = StringIO.new
     file.write JSON.dump recording
     file.rewind
 
+    # Re-load the recording from JSON using Orchestra::Recording()
+    parsed_json = JSON.parse file.read, symbolize_names: true
+    recording = Orchestra::Recording(parsed_json)
+
     # Replay the operation, directing SMTP to an alternative service object
     smtp_service = build_example_smtp
-    Orchestra.replay_recording(
+    recording.replay(
       Examples::InvitationService,
-      JSON.load(file.read),
       :smtp => smtp_service,
     )
 

data/test/unit/dsl_test.rb

@@ -33,12 +33,10 @@ class DSLTest < Minitest::Test
     end
     assert_equal :foo, operation.result
 
-    error = assert_raises ArgumentError do
-      operation = Orchestra::Operation.new do
-        result do execute do 'foo' end end
-      end
+    operation = Orchestra::Operation.new do
+      result do execute do 'foo' end end
     end
-    assert_equal "Could not infer name for step from a provision", error.message
+    assert_equal :result, operation.result
 
     operation = Orchestra::Operation.new do
       result do
@@ -119,4 +117,14 @@ class DSLTest < Minitest::Test
 
     assert_equal "Must supply at least one step", error.message
   end
+
+  def test_cannot_accidentally_try_to_define_a_conductor_with_dsl
+    error = assert_raises ArgumentError do
+      Orchestra::Conductor.new do
+        self.result = :foo
+      end
+    end
+
+    assert_equal "Supplied block to Conductor.new; did you mean to invoke Orchestra::Operation.new do … end?", error.message
+  end
 end

data/test/unit/node_test.rb

@@ -1,9 +1,13 @@
 class NodeTest < Minitest::Test
   def test_inspect
-    node = Orchestra::Node.new Examples::FizzBuzz, "Examples::FizzBuzz", {}
+    node = Orchestra::Recording::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]>",
+      "#<Orchestra::Node dependencies=[:array, :fizzbuzz, :stdout, :up_to], input={}, name=\"Examples::FizzBuzz\", optional_dependencies=[], provisions=[:__finally__, :array, :fizzbuzz], required_dependencies=[:stdout, :up_to]>",
       node.inspect,
     )
   end

data/test/unit/operation_test.rb

@@ -19,6 +19,24 @@ module OperationTest
       assert_equal %(Missing input :sentence), error.message
     end
 
+    def test_adds_name_to_missing_provision_error
+      operation = Orchestra::Operation.new do
+        result :foo do
+          provides :bar, :baz
+          execute do nil end
+        end
+      end
+
+      error = assert_raises Orchestra::MissingProvisionError do
+        operation.execute
+      end
+
+      assert_equal(
+        "Node `:foo' failed to supply output: :bar and :baz",
+        error.message,
+      )
+    end
+
     def test_mutating_inputs
       operation = build_mutator
 

data/test/unit/run_list_test.rb

@@ -16,6 +16,29 @@ class RunListTest < Minitest::Test
     assert_equal %w(foo⇒bar bar⇒baz baz⇒qux qux⇒res), run_list.step_names
   end
 
+  def test_does_not_discard_steps_that_would_override_defaults
+    steps = {
+      'foo' => OpenStruct.new(
+        :optional_dependencies => [],
+        :required_dependencies => [:bar],
+        :provisions => [:baz],
+      ),
+      'qux' => OpenStruct.new(
+        :optional_dependencies => [:baz],
+        :required_dependencies => [],
+        :provisions => [:res],
+      ),
+    }
+    builder = assemble_builder steps
+    builder.input_names.concat [:bar]
+
+    builder.sort!
+    builder.prune!
+    run_list = builder.build
+
+    assert_equal %w(foo qux), run_list.step_names
+  end
+
   def test_supplying_dependencies
     builder.input_names << :baz
 

data/test/unit/step_test.rb

@@ -78,7 +78,7 @@ class StepTest < Minitest::Test
     error = assert_raises Orchestra::MissingProvisionError do step.execute end
 
     assert_equal(
-      "failed to supply output: :foo, :bar and :baz",
+      "Node `<anonymous>' failed to supply output: :foo, :bar and :baz",
       error.message,
     )
   end
@@ -92,7 +92,7 @@ class StepTest < Minitest::Test
     error = assert_raises Orchestra::MissingProvisionError do step.execute end
 
     assert_equal(
-      "failed to supply output: :foo",
+      "Node `<anonymous>' failed to supply output: :foo",
       error.message,
     )
   end

data/test/unit/util_test.rb

@@ -3,18 +3,4 @@ class UtilTest < Minitest::Test
     assert_equal "foo/bar", Orchestra::Util.to_snake_case("Foo::Bar")
     assert_equal "foo_bar", Orchestra::Util.to_snake_case("FOOBar")
   end
-
-  def test_recursive_symbolizing
-    expected_hsh = {
-      foo: [{
-        bar: { baz: 'qux' },
-      },{
-        ping: ['pong'],
-      }],
-    }
-
-    actual_hsh = Orchestra::Util.recursively_symbolize JSON.load JSON.dump expected_hsh
-
-    assert_equal expected_hsh, actual_hsh
-  end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ntl-orchestra
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - ntl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: invokr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,9 +90,9 @@ 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/node.rb
 - lib/orchestra/recording/playback.rb
 - lib/orchestra/run_list.rb
 - lib/orchestra/step.rb

data/lib/orchestra/node.rb

@@ -1,52 +0,0 @@
-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