ellington 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d975b4f434d7239d4a483522d694c8b420767a8e
-  data.tar.gz: 61411d8204a5a16ef7856d8d98924516d888a953
+  metadata.gz: 1047c36cb4128e723415dcd5e7b74f00a38da00b
+  data.tar.gz: 8077a60871b70d5530847a5f78a653ca9236a11e
 SHA512:
-  metadata.gz: 843468642085243d43bd505000039e5f6ceff8cf45f19d9ac87894443c828beb6070620d6e08ebe0481eb6bda4a122a0839977b790a1cef414582122e108e2ed
-  data.tar.gz: be076bb1dcaf14e7e21e96cd3e157f915024fe42ba6d979ac070d45bae5764487ae2e5e0e5e7309e9212505b81a03aec87807b97799aec48d0e53e8e00f93180
+  metadata.gz: 5f78a52f1504888e376e61e788eb9bb5ac3aafe5e2b2285ba346bb0d9bfed999ebd1c0c8a860befb9d223520c5adef146852cbd012dc8258aae4079cb4e2d3b9
+  data.tar.gz: 44c136a470a26cb649a78285d45728eefd5e4d8dd95197beb4f73182f0c106f5364f67442ca9b962b8bf9a07d48c83395b63eef6506a2c0ae22ff079daebfa90

data/Gemfile.lock

@@ -1,57 +1,60 @@
 PATH
   remote: .
   specs:
-    ellington (0.1.3)
-      hero (~> 0.1.9)
-      ruby-graphviz (~> 1.0.8)
-      state_jacket (~> 0.1.0)
+    ellington (0.2.0)
+      hero (~> 0.2.0)
+      ruby-graphviz (~> 1.2.1)
+      state_jacket (~> 0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    awesome_print (1.1.0)
+    awesome_print (1.2.0)
     binding_of_caller (0.7.2)
       debug_inspector (>= 0.0.1)
-    coderay (1.0.9)
-    colorize (0.5.8)
-    coveralls (0.6.7)
-      colorize
+    coderay (1.1.0)
+    coveralls (0.7.2)
       multi_json (~> 1.3)
-      rest-client
+      rest-client (= 1.6.7)
       simplecov (>= 0.7)
-      thor
+      term-ansicolor (= 1.2.2)
+      thor (= 0.18.1)
     debug_inspector (0.0.2)
-    hero (0.1.9)
-    interception (0.3)
+    docile (1.1.5)
+    hero (0.2.0)
+    interception (0.5)
     method_source (0.8.2)
-    micro_mock (1.1.0)
-    micro_test (0.4.0)
-      os
-    mime-types (1.24)
-    multi_json (1.7.9)
+    mime-types (2.4.3)
+    multi_json (1.10.1)
     os (0.9.6)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-rescue (1.1.1)
-      interception (>= 0.3)
+    pry-rescue (1.4.1)
+      interception (>= 0.5)
       pry
     pry-stack_explorer (0.4.9.1)
       binding_of_caller (>= 0.7)
       pry (>= 0.9.11)
-    rake (10.1.0)
+    pry-test (0.5.5)
+      os
+    rake (10.4.2)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    ruby-graphviz (1.0.9)
-    simplecov (0.7.1)
+    ruby-graphviz (1.2.1)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
       multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    slop (3.4.6)
-    state_jacket (0.1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    spoof (2.0.1)
+    state_jacket (0.1.1)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
     thor (0.18.1)
-    yell (1.4.0)
+    tins (0.13.2)
 
 PLATFORMS
   ruby
@@ -60,10 +63,10 @@ DEPENDENCIES
   awesome_print
   coveralls
   ellington!
-  micro_mock
-  micro_test
+  pry
   pry-rescue
   pry-stack_explorer
+  pry-test
   rake
   simplecov
-  yell
+  spoof

data/README.md

@@ -1,9 +1,11 @@
-# Ellington
+[![Lines of Code](http://img.shields.io/badge/lines_of_code-932-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
+[![Code Status](http://img.shields.io/codeclimate/github/hopsoft/ellington.svg?style=flat)](https://codeclimate.com/github/hopsoft/ellington)
+[![Dependency Status](http://img.shields.io/gemnasium/hopsoft/ellington.svg?style=flat)](https://gemnasium.com/hopsoft/ellington)
+[![Build Status](http://img.shields.io/travis/hopsoft/ellington.svg?style=flat)](https://travis-ci.org/hopsoft/ellington)
+[![Coverage Status](https://img.shields.io/coveralls/hopsoft/ellington.svg?style=flat)](https://coveralls.io/r/hopsoft/ellington?branch=master)
+[![Downloads](http://img.shields.io/gem/dt/ellington.svg?style=flat)](http://rubygems.org/gems/ellington)
 
-[![Build Status](https://travis-ci.org/hopsoft/ellington.png)](https://travis-ci.org/hopsoft/ellington)
-[![Dependency Status](https://gemnasium.com/hopsoft/ellington.png)](https://gemnasium.com/hopsoft/ellington)
-[![Code Climate](https://codeclimate.com/github/hopsoft/ellington.png)](https://codeclimate.com/github/hopsoft/ellington)
-[![Coverage Status](https://coveralls.io/repos/hopsoft/ellington/badge.png?branch=master)](https://coveralls.io/r/hopsoft/ellington?branch=master)
+# Ellington
 
 Named after [Duke Ellington](http://www.dukeellington.com/) whose signature tune was ["Take the 'A' Train"](http://en.wikipedia.org/wiki/Take_the_%22A%22_Train).
 The song was written about [New York City's A train](http://en.wikipedia.org/wiki/A_%28New_York_City_Subway_service%29).
@@ -12,7 +14,7 @@ The song was written about [New York City's A train](http://en.wikipedia.org/wik
 
 #### Ellington is an architecture for modeling complex business processes.
 
-Ellington is a collection of simple concepts designed to bring discipline, organization, and modularity to a project.
+Ellington brings discipline, organization, and modularity to a project.
 
 The nomenclature is taken from [New York's subway system](http://en.wikipedia.org/wiki/New_York_City_Subway).
 We've found that using consistent and cohesive physical metaphors helps people reason more clearly about the complexities of software.

data/Rakefile

@@ -3,5 +3,5 @@ require "bundler/gem_tasks"
 task :default => [:test]
 
 task :test do
-  exec "bundle exec mt"
+  exec "bundle exec pry-test --disable-pry"
 end

data/lib/ellington/errros.rb

@@ -1,22 +1,9 @@
 module Ellington
-  class ListAlreadyContainsType < StandardError
-  end
-
-  class AttendantDisapproves < StandardError
-  end
-
-  class InvalidStateTransition < StandardError
-  end
-
-  class NotImplementedError < StandardError
-  end
-
-  class NoStationsDeclared < StandardError
-  end
-
-  class NoLinesDeclared < StandardError
-  end
-
-  class NoGoalDeclared < StandardError
-  end
+  class ListAlreadyContainsType < StandardError; end
+  class AttendantDisapproves < StandardError; end
+  class InvalidStateTransition < StandardError; end
+  class NotImplementedError < StandardError; end
+  class NoStationsDeclared < StandardError; end
+  class NoLinesDeclared < StandardError; end
+  class NoGoalDeclared < StandardError; end
 end

data/lib/ellington/line.rb

@@ -46,8 +46,8 @@ module Ellington
       stations.first.initial_states
     end
 
-    def board(passenger, options={})
-      formula.run passenger, options
+    def board(passenger)
+      formula.run passenger
     end
 
     def boarded?(passenger)
@@ -94,24 +94,21 @@ module Ellington
           return complete_line(line_info)
       end
 
-      log line_info, :station_completed => true
-      if line_info.passenger.current_state == line_info.station.errored
-        Ellington.logger.info "\n" if Ellington.logger
-      end
+      log line_info.station_completed_message # TODO: add *passenger_attrs
     end
 
     protected
 
     def complete_line(line_info)
-      log line_info, :station_completed => true
-      log line_info, :line_completed => true
+      log line_info.station_completed_message # TODO: add *passenger_attrs
+      log line_info.line_completed_message # TODO: add *passenger_attrs
       changed
       notify_observers line_info
     end
 
-    def log(line_info, options={})
+    def log(message)
       return unless Ellington.logger
-      Ellington.logger.info line_info.log_message(options)
+      Ellington.logger.info message
     end
 
   end

data/lib/ellington/line_info.rb

@@ -14,25 +14,31 @@ module Ellington
       @station_full_name ||= "#{line.route.name} #{line.class.name} #{station.class.name}"
     end
 
-    def log_message(options={})
+    def station_completed_message
       message = []
-      if options[:line_completed]
-        message << "[LINE COMPLETED]"
-        message << "[#{line.state(passenger)}]"
-        message << "[#{line.name}]"
-      end
-      if options[:station_completed]
-        message << "[STATION COMPLETED]"
-        message << "[#{station.state(passenger)}]"
-        message << "[#{station_full_name}]"
-      end
-      line.route.log_options[:passenger].each do |attr|
-        message << "[#{attr}:#{passenger.send(attr)}]"
-      end
-      line.route.log_options[:options].each do |attr|
-        message << "[#{attr}:#{self.options[attr]}]"
-      end
+      message << "[STATION COMPLETED]"
+      message << "[#{station.state(passenger)}]"
+      message << "[#{station_full_name}]"
+      message.concat passenger_message
+      message.join " "
+    end
+
+    def line_completed_message
+      message = []
+      message << "[LINE COMPLETED]"
+      message << "[#{line.state(passenger)}]"
+      message << "[#{line.name}]"
+      message.concat passenger_message
       message.join " "
     end
+
+    def passenger_message
+      line.route.passenger_attrs_to_log.reduce([]) do |memo, attr|
+        value = passenger.send(attr) rescue nil
+        memo << "[#{attr}:#{value}]" unless value.nil?
+        memo
+      end
+    end
+
   end
 end

data/lib/ellington/passenger.rb

@@ -6,11 +6,11 @@ module Ellington
     attr_accessor :context, :ticket
     attr_reader :route, :state_history
 
-    def initialize(context, route, options={})
+    def initialize(context, route: route, ticket: Ellington::Ticket.new, state_history: [])
       @context = context
       @route = route
-      @ticket = options[:ticket] || Ellington::Ticket.new
-      @state_history = options[:state_history] || []
+      @ticket = ticket
+      @state_history = state_history
       super context
     end
 

data/lib/ellington/route.rb

@@ -47,8 +47,8 @@ module Ellington
         @initialized
       end
 
-      def board(passenger, options={})
-        lines.first.board passenger, options
+      def board(passenger)
+        lines.first.board passenger
       end
 
       def lines
@@ -92,18 +92,17 @@ module Ellington
         @connections ||= Ellington::ConnectionList.new
       end
 
-      def connect_to(line, options)
-        type = options.keys.first
-        states = options[type]
-        connections << Ellington::Connection.new(line, type, states)
+      def connect_to(line, if_any: [], if_all: [])
+        connections << Ellington::Connection.new(line, :if_any, if_any) unless if_any.empty?
+        connections << Ellington::Connection.new(line, :if_all, if_all) unless if_all.empty?
       end
 
-      def log_options(options={})
-        @log_options ||= begin
-          options[:passenger] ||= []
-          options[:options] ||= []
-          options
-        end
+      def passenger_attrs_to_log
+        @passenger_attrs_to_log ||= []
+      end
+
+      def set_passenger_attrs_to_log(*attrs)
+        @passenger_attrs_to_log = attrs
       end
 
       def line_completed(line_info)
@@ -111,7 +110,7 @@ module Ellington
         connections = required_connections(route_info.passenger)
         return complete_route(route_info) if connections.empty?
         connections.each do |connection|
-          connection.line.board route_info.passenger, route_info.options
+          connection.line.board route_info.passenger
         end
       end
 
@@ -119,11 +118,10 @@ module Ellington
 
       def complete_route(route_info)
         if passed.satisfied?(route_info.passenger) || failed.satisfied?(route_info.passenger)
-          log route_info
+          log route_info.route_completed_message
           changed
           notify_observers route_info
         end
-        Ellington.logger.info "\n" if Ellington.logger
       end
 
       def required_connections(passenger)
@@ -132,9 +130,9 @@ module Ellington
         end
       end
 
-      def log(route_info)
+      def log(message)
         return unless Ellington.logger
-        Ellington.logger.info route_info.log_message
+        Ellington.logger.info message
       end
 
     end

data/lib/ellington/route_info.rb

@@ -10,19 +10,22 @@ module Ellington
       super line_info
     end
 
-    def log_message(options={})
+    def route_completed_message
       message = []
       message << "[ROUTE COMPLETED]"
       message << "[#{route.state(passenger)}]"
       message << "[#{route.name}]"
-      route.log_options[:passenger].each do |attr|
-        message << "[#{attr}:#{passenger.send(attr)}]"
-      end
-      route.log_options[:options].each do |attr|
-        message << "[#{attr}:#{self.options[attr]}]"
-      end
+      message.concat passenger_message
       message.join " "
     end
+
+    def passenger_message
+      route.passenger_attrs_to_log.reduce([]) do |memo, attr|
+        value = passenger.send(attr) rescue nil
+        memo << "[#{attr}:#{value}]" unless value.nil?
+        memo
+      end
+    end
   end
 end
 

data/lib/ellington/station.rb

@@ -46,25 +46,38 @@ module Ellington
       end
     end
 
-    def can_engage?(passenger, options={})
+    def can_engage?(passenger)
       return false unless route.states.can_transition?(passenger.current_state => states.keys)
       return false if passenger.state_history_includes?(passed)
       true
     end
 
-    def engage(passenger, options={})
+    def engage(passenger)
       raise Ellington::NotImplementedError
     end
 
-    def call(passenger, options={})
+    def engage_and_transition(passenger)
+      begin
+        if !!engage(passenger)
+          pass_passenger passenger
+        else
+          fail_passenger passenger
+        end
+      rescue StandardError => e
+        Ellington.logger.error "Failure while engaging passenger! #{e}" if Ellington.logger
+        error_passenger passenger
+      end
+    end
+
+    def call(passenger, _=nil)
       if can_engage?(passenger)
         attendant = Ellington::Attendant.new(self)
         passenger.add_observer attendant
-        engage passenger, options
+        engage_and_transition passenger
         passenger.delete_observer attendant
         raise Ellington::AttendantDisapproves unless attendant.approve?
         changed
-        notify_observers Ellington::StationInfo.new(self, passenger, attendant.passenger_transitions.first, options)
+        notify_observers Ellington::StationInfo.new(self, passenger, attendant.passenger_transitions.first)
       end
 
       passenger

data/lib/ellington/station_info.rb

@@ -1,11 +1,10 @@
 module Ellington
   class StationInfo
-    attr_reader :station, :passenger, :transition, :options
-    def initialize(station, passenger, transition, options)
+    attr_reader :station, :passenger, :transition
+    def initialize(station, passenger, transition)
       @station = station
       @passenger = passenger
       @transition = transition
-      @options = options
     end
   end
 end

data/lib/ellington/version.rb

@@ -1,3 +1,3 @@
 module Ellington
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/test/attendant_test.rb

@@ -1,12 +1,12 @@
 require_relative "test_helper"
 
-class AttendantTest < MicroTest::Test
+class AttendantTest < PryTest::Test
 
   before do
     route = BasicMath.new
     line = route.lines.first
     @station = line.stations.first
-    @passenger = Ellington::Passenger.new(NumberWithHistory.new(0), route)
+    @passenger = Ellington::Passenger.new(NumberWithHistory.new(0), route: route)
     @passenger.current_state = route.initial_state
     @attendant = Ellington::Attendant.new(@station)
     @passenger.add_observer @attendant

data/test/conductor_test.rb

@@ -1,11 +1,11 @@
 require_relative "test_helper"
 
-class ConductorTest < MicroTest::Test
+class ConductorTest < PryTest::Test
 
   before do
     @route = BasicMath.new
     @conductor = Ellington::Conductor.new(@route)
-    @passenger = Ellington::Passenger.new(NumberWithHistory.new(0), @route)
+    @passenger = Ellington::Passenger.new(NumberWithHistory.new(0), route: @route)
     @passenger.current_state = @route.initial_state
   end
 

data/test/connection_test.rb

@@ -1,6 +1,6 @@
 require_relative "test_helper"
 
-class ConnectionTest < MicroTest::Test
+class ConnectionTest < PryTest::Test
 
   before do
     @route = BasicMath.new

data/test/example.rb

@@ -1,12 +1,6 @@
 require "logger"
 require_relative "../lib/ellington"
 
-#require "yell"
-#Ellington.logger = Yell.new do |logger|
-#  logger.adapter STDOUT, :level => [:info], :format => "%m"
-#end
-#Ellington.logger = Logger.new($stdout)
-
 class NumberWithHistory
   attr_reader :original_value, :current_value, :history
   def initialize(value)
@@ -25,128 +19,65 @@ end
 
 # stations -----------------------------------------------------------------
 class Add10 < Ellington::Station
-  def engage(number, options)
+  def engage(number)
     raise if rand(100) == 0
-    if rand(100) > 5
-      number.calc :+, 10
-      pass_passenger number
-    else
-      fail_passenger number
-    end
-  rescue
-    error_passenger number
+    number.calc :+, 10 if rand(100) > 5
   end
 end
 
 class Add100 < Ellington::Station
-  def engage(number, options)
+  def engage(number)
     raise if rand(100) == 0
-    if rand(100) > 5
-      number.calc :+, 100
-      pass_passenger number
-    else
-      fail_passenger number
-    end
-  rescue
-    error_passenger number
+    number.calc :+, 100 if rand(100) > 5
   end
 end
 
 class Add1000 < Ellington::Station
-  def engage(number, options)
+  def engage(number)
     raise if rand(100) == 0
-    if rand(100) > 5
-      number.calc :+, 1000
-      pass_passenger number
-    else
-      fail_passenger number
-    end
-  rescue
-    error_passenger number
+    number.calc :+, 1000 if rand(100) > 5
   end
 end
 
 class MultiplyBy10 < Ellington::Station
-  def engage(number, options)
+  def engage(number)
     raise if rand(100) == 0
-    if rand(100) > 5
-      number.calc :*, 10
-      pass_passenger number
-    else
-      fail_passenger number
-    end
-  rescue
-    error_passenger number
+    number.calc :*, 10 if rand(100) > 5
   end
 end
 
 class MultiplyBy100 < Ellington::Station
-  def engage(number, options)
+  def engage(number)
     raise if rand(100) == 0
-    if rand(100) > 5
-      number.calc :*, 100
-      pass_passenger number
-    else
-      fail_passenger number
-    end
-  rescue
-    error_passenger number
+    number.calc :*, 100 if rand(100) > 5
   end
 end
 
 class MultiplyBy1000 < Ellington::Station
-  def engage(number, options)
+  def engage(number)
     raise if rand(100) == 0
-    if rand(100) > 5
-      number.calc :*, 1000
-      pass_passenger number
-    else
-      fail_passenger number
-    end
-  rescue
-    error_passenger number
+    number.calc :*, 1000 if rand(100) > 5
   end
 end
 
 class DivideBy10 < Ellington::Station
-  def engage(number, options)
+  def engage(number)
     raise if rand(100) == 0
-    if rand(100) > 5
-      number.calc :/, 10.0
-      pass_passenger number
-    else
-      fail_passenger number
-    end
-  rescue
-    error_passenger number
+    number.calc :/, 10.0 if rand(100) > 5
   end
 end
 
 class DivideBy100 < Ellington::Station
-  def engage(number, options)
+  def engage(number)
     raise if rand(100) == 0
-    if rand(100) > 5
-      number.calc :/, 100.0
-      pass_passenger number
-    else
-      fail_passenger number
-    end
-  rescue
-    error_passenger number
+    number.calc :/, 100.0 if rand(100) > 5
   end
 end
 
 class DivideBy1000 < Ellington::Station
-  def engage(number, options)
+  def engage(number)
     raise if rand(100) == 0
-    if rand(100) > 5
-      number.calc :/, 1000.0
-      pass_passenger number
-    else
-      fail_passenger number
-    end
-  rescue
-    error_passenger number
+    number.calc :/, 1000.0 if rand(100) > 5
   end
 end
 
@@ -174,9 +105,9 @@ end
 
 # route -------------------------------------------------------------------
 class BasicMath < Ellington::Route
-  addition = Addition.new
+  addition       = Addition.new
   multiplication = Multiplication.new
-  division = Division.new
+  division       = Division.new
 
   lines << addition
   lines << division
@@ -187,6 +118,6 @@ class BasicMath < Ellington::Route
   connect_to division, :if_any => addition.passed
   connect_to multiplication, :if_any => addition.failed
 
-  log_options :passenger => [:original_value, :current_value]
+  set_passenger_attrs_to_log :original_value, :current_value
 end