ellington 0.0.2 → 0.0.3

data/README.md

@@ -1,4 +1,4 @@
-# Ellington 
+# 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).
 
@@ -7,7 +7,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.
-The base implementation is very light, weighing in around 500 lines.
+([View the slides from the intro talk.](https://speakerdeck.com/hopsoft/ellington-intro))
 
 The nomenclature is taken from [New York's subway system](http://en.wikipedia.org/wiki/New_York_City_Subway).
 We've found that using cohesive physical metaphors helps people reason more clearly about the complexities of software.
@@ -34,45 +34,3 @@ The Ellington architecture should only be applied **after** a good understanding
 
 ![Ellington Diagram](https://raw.github.com/hopsoft/ellington/master/doc/primary-terms.png)
 
-#### Additional Terms
-
-- **[State Catalog](https://github.com/hopsoft/ellington/wiki/State)** - A collection of states and their transitions.
-- **[State Transition](https://github.com/hopsoft/ellington/wiki/State)** - The `transition`, performed on the `passenger`, from one `state` to another.
-- **[Ticket](https://github.com/hopsoft/ellington/wiki/Ticket)** - An authorization token that indicates the `passenger` can ride a specific `route`.
-- **[Goal](https://github.com/hopsoft/ellington/wiki/Goal)** - A list of expected `states`.
-- **[Connection](https://github.com/hopsoft/ellington/wiki/Connection)** - A link between `lines`.
-- **[Transfer](Transfer)** - A link between `routes`.
-- **[Network](Network)** - An entire system of `routes` & `transfers` designed to work together.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-```
-Route class
-  composed of line instances
-  each line instance holds a ref to this route's class
-
-Line class
-  composed of station instances
-  each station instance holds a ref to this line's class
-
-Station class
-```
-

data/lib/ellington/conductor.rb

@@ -2,40 +2,46 @@ require "thread"
 
 module Ellington
   class Conductor
-    attr_reader :route, :conducting
+    attr_reader :route
 
     def initialize(route)
       @route = route
       @conducting = false
     end
 
-    def start(delay=0)
-      return if conducting
+    def conducting?
+      @conducting
+    end
+
+    def start
+      return if conducting?
 
       mutex.synchronize do
         @stop = false
         @conducting = true
       end
 
-      thread = Thread.new do
+      @thread = Thread.new do
         loop do
           if @stop
             mutex.synchronize { @conducting = false }
-            break
+            Thread.current.exit
           end
           gather_passengers.each do |passenger|
             escort(passenger)
           end
-          sleep delay
         end
       end
-      thread.join
     end
 
     def stop
       mutex.synchronize { @stop = true }
     end
 
+    def wait
+      thread.join
+    end
+
     def verify(passenger)
       true
     end
@@ -49,7 +55,9 @@ module Ellington
       route.lines.first.board passenger
     end
 
-    private
+    protected
+
+    attr_reader :thread
 
     def mutex
       @mutex ||= Mutex.new

data/lib/ellington/connection.rb

@@ -1,10 +1,25 @@
 module Ellington
   class Connection
-    attr_reader :line, :states
+    attr_reader :line, :type, :states
 
-    def initialize(line, states)
+    def initialize(line, type, *states)
       @line = line
-      @states = states
+      @type = type
+      @states = Ellington::Target.new(*states)
+    end
+
+    def required?(passenger)
+      return false if line.boarded?(passenger)
+
+      if type == :if_any
+        return states.satisfied?(passenger) 
+      end
+
+      if type == :if_all
+        return (passenger.state_history & states).length == states.length
+      end
+
+      false
     end
 
   end

data/lib/ellington/errros.rb

@@ -2,10 +2,7 @@ module Ellington
   class ListAlreadyContainsType < StandardError
   end
 
-  class InvalidStates < StandardError
-  end
-
-  class AttendandDisapproves < StandardError
+  class AttendantDisapproves < StandardError
   end
 
   class InvalidStateTransition < StandardError
@@ -14,9 +11,12 @@ module Ellington
   class NotImplementedError < StandardError
   end
 
-  class StationAlreadyBelongsToLine < StandardError
+  class NoStationsDeclared < StandardError
+  end
+
+  class NoLinesDeclared < StandardError
   end
 
-  class PassengerAlreadyAssignedToTicket < StandardError
+  class NoGoalDeclared < StandardError
   end
 end

data/lib/ellington/line.rb

@@ -5,7 +5,6 @@ module Ellington
   class Line
     class << self
       include Observable
-      attr_accessor :route
 
       def stations
         @stations ||= Ellington::StationList.new(self)
@@ -16,30 +15,42 @@ module Ellington
       end
       alias_method :passed, :pass_target
       alias_method :goal, :pass_target
-
-      def connections
-        @connections ||= {}
-      end
     end
 
     extend Forwardable
     include Observable
     include HasTargets
 
+    attr_accessor :route_class, :route
+
     def_delegators :"self.class",
-      :route,
-      :route=,
       :stations,
       :pass_target,
       :passed,
       :goal
 
+    def initialize
+      if stations.empty?
+        message = "#{self.class.name} has no stations!"
+        raise Ellington::NoStationsDeclared.new(message)
+      end
+
+      if goal.empty?
+        message = "#{self.class.name} has no goal!"
+        raise Ellington::NoGoalDeclared.new(message)
+      end
+    end
+
     def board(passenger, options={})
       formula.run passenger, options
     end
 
+    def boarded?(passenger)
+      !(passenger.state_history & states.keys).empty?
+    end
+
     def name
-      @name ||= "#{self.class.name}::#{route.name}"
+      @name ||= "#{self.class.name}::#{route_class.name}"
     end
 
     def formula

data/lib/ellington/line_info.rb

@@ -19,12 +19,13 @@ module Ellington
       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
-      message << "[#{station_full_name}]"
       line.route.log_passenger_attrs.each do |attr|
         message << "[#{attr}:#{passenger.send(attr)}]"
       end

data/lib/ellington/line_list.rb

@@ -2,22 +2,22 @@ require "delegate"
 
 module Ellington
   class LineList < SimpleDelegator
-    attr_reader :route
+    attr_reader :route_class
 
-    def initialize(route)
-      @route = route
+    def initialize(route_class)
+      @route_class = route_class
       @inner_list = UniqueTypeArray.new
       super @inner_list
     end
-    
+
     def push(line)
       value = inner_list << line
-      line.route = route
+      line.route_class = route_class
       value
     end
     alias_method :<<, :push
 
-    protected 
+    protected
 
     attr_reader :inner_list
   end

data/lib/ellington/passenger.rb

@@ -39,6 +39,10 @@ module Ellington
       @current_state = value
     end
 
+    def state_history
+      @state_history ||= []
+    end
+
     def transition_to(new_state)
       if !locked?
         message = "Cannot transition an unlocked #{self.class.name}'s state"
@@ -58,6 +62,8 @@ module Ellington
         self.current_state = new_state
       end
 
+      state_history << new_state
+
       changed
       notify_observers Ellington::TransitionInfo.new(self, old_state, new_state)
       return_value || new_state

data/lib/ellington/route.rb

@@ -5,7 +5,30 @@ module Ellington
 
     def initialize
       super self.class
-      init unless initialized?
+
+      if lines.empty?
+        message = "#{self.class.name} has no lines!"
+        raise Ellington::NoLinesDeclared.new(message)
+      end
+
+      if goal.empty?
+        message = "#{self.class.name} has no lines!"
+        raise Ellington::NoGoalDeclared.new(message)
+      end
+
+      initialize_lines
+      states
+    end
+
+    def initialize_lines
+      lines.each do |line|
+        line.route = self
+        line.add_observer self, :line_completed
+        line.stations.each do |station|
+          station.line = line
+          station.add_observer line, :station_completed
+        end
+      end
     end
 
     class << self
@@ -16,21 +39,6 @@ module Ellington
         @initialized
       end
 
-      def init
-        initialize_lines
-        states
-        @initialized = true
-      end
-
-      def initialize_lines
-        lines.each do |line|
-          line.add_observer self, :line_completed
-          line.stations.each do |station|
-            station.add_observer line, :station_completed
-          end
-        end
-      end
-
       def board(passenger, options={})
         lines.first.board passenger, options
       end
@@ -75,7 +83,9 @@ module Ellington
       end
 
       def connect_to(line, options)
-        connections << Ellington::Connection.new(line, options[:if])
+        type = options.keys.first
+        states = options[type]
+        connections << Ellington::Connection.new(line, type, states)
       end
 
       def log_passenger_attrs(*attrs)
@@ -86,7 +96,7 @@ module Ellington
         route_info = Ellington::RouteInfo.new(self, line_info)
 
         required_connections = connections.select do |connection|
-          connection.states.satisfied?(route_info.passenger)
+          connection.required?(route_info.passenger)
         end
 
         if required_connections.empty?

data/lib/ellington/route_info.rb

@@ -14,7 +14,7 @@ module Ellington
       message = []
       message << "[ROUTE COMPLETED]"
       message << "[#{route.state(passenger)}]"
-      message << "[#{station_full_name}]"
+      message << "[#{route.name}]"
       line.route.log_passenger_attrs.each do |attr|
         message << "[#{attr}:#{passenger.send(attr)}]"
       end

data/lib/ellington/station.rb

@@ -6,11 +6,11 @@ module Ellington
   class Station
     extend Forwardable
     include Observable
-    attr_accessor :line
+    attr_accessor :line_class, :line
     def_delegators :line, :route
 
     def name
-      @name ||= "#{self.class.name}::#{line.name}"
+      @name ||= "#{self.class.name}::#{line_class.name}"
     end
 
     def state_name(state)
@@ -55,7 +55,7 @@ module Ellington
         passenger.add_observer attendant
         engage passenger, options
         passenger.delete_observer attendant
-        raise Ellington::AttendandDisapproves unless attendant.approve?
+        raise Ellington::AttendantDisapproves unless attendant.approve?
         changed
         notify_observers Ellington::StationInfo.new(self, passenger, attendant.passenger_transitions.first, options)
       end
@@ -63,15 +63,15 @@ module Ellington
       passenger
     end
 
-    def pass(passenger)
+    def pass_passenger(passenger)
       passenger.transition_to passed
     end
 
-    def fail(passenger)
+    def fail_passenger(passenger)
       passenger.transition_to failed
     end
 
-    def error(passenger)
+    def error_passenger(passenger)
       passenger.transition_to errored
     end
 

data/lib/ellington/station_list.rb

@@ -2,17 +2,17 @@ require "delegate"
 
 module Ellington
   class StationList < SimpleDelegator
-    attr_reader :line
+    attr_reader :line_class
 
-    def initialize(line)
-      @line = line
+    def initialize(line_class)
+      @line_class = line_class
       @inner_list = UniqueTypeArray.new
       super @inner_list
     end
 
     def push(station)
       value = inner_list << station
-      station.line = line
+      station.line_class = line_class
       value
     end
     alias_method :<<, :push

data/lib/ellington/unique_type_array.rb

@@ -13,10 +13,7 @@ module Ellington
       inner_list.push value
     end
 
-    def <<(value)
-      check value
-      inner_list << value
-    end
+    alias_method :<<, :push
 
     def contains_a?(klass)
       each do |entry|

data/lib/ellington/version.rb

@@ -1,3 +1,3 @@
 module Ellington
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/ellington.rb

@@ -1,6 +1,6 @@
 require "bundler"
 Bundler.require
-#Bundler.require :development, :test
+Bundler.require :development, :test if ENV["ELLINGTON_DEV"]
 
 path = File.join(File.dirname(__FILE__), "ellington/**/*.rb")
 Dir[path].each { |file| require file }

data/test/attendant_test.rb

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

data/test/conductor_test.rb

@@ -2,31 +2,60 @@ require_relative "test_helper"
 
 class ConductorTest < MicroTest::Test
 
-  #before do
-  #  route = Ellington::Route.new("Example Route", StateJacket::Catalog.new)
-  #  route.add Ellington::Line.new("A Line")
-  #  route["A Line"] << ConductorTest::Station.new
-  #  @conductor = Ellington::Conductor.new(route)
-  #end
-
-  #test "verify is abstract" do
-  #  error = nil
-  #  begin
-  #    @conductor.verify nil
-  #  rescue Ellington::NotImplementedError => e
-  #    error = e
-  #  end
-  #  assert !error.nil?
-  #end
-
-  #test "gather_passengers is abstract" do
-  #  error = nil
-  #  begin
-  #    @conductor.gather_passengers
-  #  rescue Ellington::NotImplementedError => e
-  #    error = e
-  #  end
-  #  assert !error.nil?
-  #end
+  before do
+    @route = BasicMath.new
+    @conductor = Ellington::Conductor.new(@route)
+    @passenger = Ellington::Passenger.new(NumberWithHistory.new(0), @route)
+    @passenger.current_state = @route.initial_state
+    @passenger.lock
+  end
+
+  test "not conducting" do
+    assert !@conductor.conducting?
+  end
+
+  test "verify" do
+    assert @conductor.verify(@passenger)
+  end
+
+  test "gather_passengers is abstract" do
+    error = nil
+    begin
+      @conductor.gather_passengers
+    rescue Ellington::NotImplementedError => e
+      error = e
+    end
+    assert !error.nil?
+  end
+
+  test "escort" do
+    @conductor.escort(@passenger)
+    assert @passenger.current_state != @route.initial_state
+  end
+
+  test "escort prevented when passenger doesn't verify" do
+    def @conductor.verify(passenger)
+      false
+    end
+    @conductor.escort(@passenger)
+    assert @passenger.current_state == @route.initial_state
+  end
+
+  test "escort prevented when passenger is not locked" do
+    @passenger.unlock
+    assert @passenger.current_state == @route.initial_state
+  end
+
+  test "start/stop with conducting? checks" do
+    def @conductor.gather_passengers
+      sleep 0.1
+      []
+    end
+    @conductor.start
+    assert @conductor.conducting?
+    @conductor.stop
+    sleep 0.2
+    puts !@conductor.conducting?
+  end
 
 end

data/test/connection_test.rb

@@ -0,0 +1,19 @@
+require_relative "test_helper"
+
+class ConnectionTest < MicroTest::Test
+
+  before do
+    @route = BasicMath.new
+    @line = @route.lines.first
+    @connection = Ellington::Connection.new(@route.lines[1], :if_currently, @line.passed)
+  end
+
+  test "line" do
+    assert @connection.line == @route.lines[1]
+  end
+
+  test "states" do
+    assert @connection.states == @line.passed
+  end
+
+end