ellington 0.0.1 → 0.0.2

data/test/route_test.rb

@@ -0,0 +1,51 @@
+require_relative "test_helper"
+
+class RouteTest < MicroTest::Test
+
+  before do
+    @route = BasicMath.new
+  end
+
+  test "lines on class" do
+    assert @route.lines.length == 3
+    assert @route.lines[0].is_a?(Addition)
+    assert @route.lines[1].is_a?(Division)
+    assert @route.lines[2].is_a?(Multiplication)
+  end
+
+  test "type of lines must be unique" do
+    begin
+      @route.lines << Addition.new
+    rescue Ellington::ListAlreadyContainsType => e
+    end
+    assert !e.nil?
+  end
+
+  test "lines are assigned route" do
+    @route.lines.each do |line|
+      assert line.route == BasicMath
+    end
+  end
+
+  test "goal" do
+    goals = @route.goal & [@route.lines[1].goal, @route.lines[2].goal].flatten
+    assert @route.goal.length == goals.length
+  end
+
+  test "fail_target" do
+    assert !@route.fail_target.empty?
+    assert((@route.fail_target & @route.pass_target).empty?)
+    expected = (@route.states.keys - @route.pass_target).delete_if do |state|
+      state.to_s =~ /\AERROR/
+    end
+    assert @route.fail_target == expected
+  end
+
+  test "connections" do
+    assert @route.connections.first.line == @route.lines[1]
+    assert @route.connections.first.states == @route.lines[0].pass_target
+    assert @route.connections.last.line == @route.lines[2]
+    assert @route.connections.last.states == @route.lines[0].fail_target
+  end
+
+end

data/test/station_test.rb

@@ -0,0 +1,115 @@
+require_relative "test_helper"
+
+class StationTest < 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
+    @passenger.lock
+  end
+
+  test "name" do
+    assert @station.name == "Add10::Addition"
+  end
+
+  test "state_name" do
+    assert @station.state_name(:foo) == "FOO Add10::Addition"
+  end
+
+  test "passed" do
+    assert @station.passed == "PASS Add10::Addition"
+  end
+
+  test "failed" do
+    assert @station.failed == "FAIL Add10::Addition"
+  end
+
+  test "errored" do
+    assert @station.errored == "ERROR Add10::Addition"
+  end
+
+  test "states keys" do
+    assert @station.states.keys == [
+      @station.passed,
+      @station.failed,
+      @station.errored
+    ]
+  end
+
+  test "error state can transition to passed" do
+    assert @station.states.can_transition?(@station.errored => @station.passed)
+  end
+
+  test "error state can transition to failed" do
+    assert @station.states.can_transition?(@station.errored => @station.failed)
+  end
+
+  test "pass state is terminating" do
+    assert @station.states[@station.passed].nil?
+    assert !@station.states.can_transition?(@station.passed => @station.failed)
+    assert !@station.states.can_transition?(@station.passed => @station.errored)
+  end
+
+  test "fail state is terminating" do
+    assert @station.states[@station.failed].nil?
+    assert !@station.states.can_transition?(@station.failed => @station.passed)
+    assert !@station.states.can_transition?(@station.failed => @station.errored)
+  end
+
+  test "pass properly transitions passenger's state" do
+    @passenger.current_state = @route.initial_state
+    @station.pass @passenger
+    assert @passenger.current_state == @station.passed
+  end
+
+  test "fail properly transitions passenger's state" do
+    @passenger.current_state = @route.initial_state
+    @station.fail @passenger
+    assert @passenger.current_state == @station.failed
+  end
+
+  test "error properly transitions passenger's state" do
+    @passenger.current_state = @route.initial_state
+    @station.error @passenger
+    assert @passenger.current_state == @station.errored
+  end
+
+  test "can_engage? returns true for the expected inital state" do
+    @passenger.current_state = @route.initial_state
+    assert @station.can_engage?(@passenger)
+  end
+
+  test "can_engage? returns false for unexpected inital states" do
+    @passenger.current_state = @line.stations.last.passed
+    assert !@station.can_engage?(@passenger)
+    @passenger.current_state = :unexpected
+    assert !@station.can_engage?(@passenger)
+  end
+
+  test "engage" do
+    @passenger.current_state = @route.initial_state
+    @station.engage(@passenger, :pass => true)
+    assert @passenger.current_state == @station.passed
+  end
+
+  test "observers are notified after a station completes" do
+    observer = MicroMock.make.new
+    observer.attr :callbacks, []
+    observer.def :update do |info|
+      callbacks << info
+    end
+    @station.add_observer observer
+    @passenger.current_state = @route.initial_state
+    @station.call(@passenger, :pass => true)
+    assert observer.callbacks.length == 1
+    info = observer.callbacks.first
+    assert info.station == @station
+    assert info.passenger == @passenger
+    assert info.transition.old_state == @route.initial_state
+    assert info.transition.new_state == @station.passed
+  end
+
+end

data/test/target_test.rb

@@ -0,0 +1,54 @@
+require_relative "test_helper"
+
+class TargetTest < MicroTest::Test
+
+  before do
+    @number = NumberWithHistory.new(0)
+  end
+
+  test "basic goal" do
+    goal = Ellington::Target.new(:finished)
+    assert goal.include?(:finished)
+  end
+
+  test "multiple states" do
+    goal = Ellington::Target.new(:one, :two, :three)
+    assert goal.include?(:one)
+    assert goal.include?(:two)
+    assert goal.include?(:three)
+  end
+
+  test "not satisfied for nil passenger" do
+    goal = Ellington::Target.new(:finished)
+    assert !goal.satisfied?(nil)
+  end
+
+  test "not satisfied for passenger in the wrong state" do
+    passenger = Ellington::Passenger.new(@number, Ellington::Ticket.new, StateJacket::Catalog.new)
+    passenger.current_state = :open
+    goal = Ellington::Target.new(:closed)
+    assert !goal.satisfied?(passenger)
+  end
+
+  test "satisfied for passenger in the right state" do
+    passenger = Ellington::Passenger.new(@number, Ellington::Ticket.new, StateJacket::Catalog.new)
+    passenger.current_state = :closed
+    goal = Ellington::Target.new(:closed)
+    assert goal.satisfied?(passenger)
+  end
+
+  test "satisfied for passenger in an expected state" do
+    passenger = Ellington::Passenger.new(@number, Ellington::Ticket.new, StateJacket::Catalog.new)
+    passenger.current_state = :two
+    goal = Ellington::Target.new(:one, :two, :three)
+    assert goal.satisfied?(passenger)
+  end
+
+  test "not satisfied for passenger not in an expected state" do
+    passenger = Ellington::Passenger.new(@number, Ellington::Ticket.new, StateJacket::Catalog.new)
+    passenger.current_state = :four
+    goal = Ellington::Target.new(:one, :two, :three)
+    assert !goal.satisfied?(passenger)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require "logger"
+require "delegate"
+require 'pry-exception_explorer'
+require_relative "../lib/ellington"
+require_relative "example"
+

data/test/ticket_test.rb

@@ -0,0 +1,39 @@
+require_relative "test_helper"
+require "digest"
+
+class TicketTest < MicroTest::Test
+
+  before do
+    @route = BasicMath.new
+    @ticket = Ellington::Ticket.new(Ellington::Target.new(:closed),
+      :user_id => "458e9710-c1c4-495b-b25a-c622e893f6f7",
+      :debit_id => "b834fb69-2eb3-4e57-b313-16b863e91f74",
+      :credit_id => "9a670fce-4826-4a90-aaf7-a58738a4ce5b"
+    )
+    @passenger = Ellington::Passenger.new(0, @route, @ticket)
+  end
+
+  test "basic ticket" do
+    assert @ticket[:user_id] == "458e9710-c1c4-495b-b25a-c622e893f6f7"
+    assert @ticket[:debit_id] == "b834fb69-2eb3-4e57-b313-16b863e91f74"
+    assert @ticket[:credit_id] == "9a670fce-4826-4a90-aaf7-a58738a4ce5b"
+  end
+
+  test "ticket id" do
+    assert @ticket.id == Digest::SHA256.hexdigest(@ticket.values.map(&:to_s).join)
+  end
+
+  test "goal" do
+    assert @ticket.goal.to_a == [:closed]
+  end
+
+  test "goal is not achieved when passenger is not in the correct state" do
+    assert !@ticket.goal.satisfied?(@passenger)
+  end
+
+  test "goal is achieved when passenger is in the correct state" do
+    @passenger.current_state = :closed
+    assert @ticket.goal.satisfied?(@passenger)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ellington
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,92 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
-dependencies: []
-description: Write a gem description
+date: 2013-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hero
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+- !ruby/object:Gem::Dependency
+  name: state_jacket
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+description: ! "\n    Ellington is a collection of simple concepts designed to bring
+  discipline, organization, and modularity to a project.\n\n    The nomenclature is
+  taken from New York's subway system.\n    We've found that using cohesive physical
+  metaphors helps people reason more clearly about the complexities of software.\n
+  \   The subway analogy isn't perfect but gets pretty close.\n\n    The Ellington
+  architecture should only be applied after a good understanding of the problem domain
+  has been established.\n    We recommend spiking a solution to learn your project's
+  requirements and then coming back to Ellington.\n  "
 email:
 - natehop@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- lib/ellington/attendant.rb
+- lib/ellington/conductor.rb
+- lib/ellington/connection.rb
+- lib/ellington/connection_list.rb
+- lib/ellington/errros.rb
+- lib/ellington/has_targets.rb
+- lib/ellington/line.rb
+- lib/ellington/line_info.rb
+- lib/ellington/line_list.rb
+- lib/ellington/logger.rb
+- lib/ellington/passenger.rb
+- lib/ellington/route.rb
+- lib/ellington/route_info.rb
+- lib/ellington/station.rb
+- lib/ellington/station_info.rb
+- lib/ellington/station_list.rb
+- lib/ellington/target.rb
+- lib/ellington/ticket.rb
+- lib/ellington/transition_info.rb
+- lib/ellington/unique_type_array.rb
+- lib/ellington/version.rb
+- lib/ellington.rb
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
-- README.md
 - Rakefile
-- ellington.gemspec
-- lib/ellington.rb
-- lib/ellington/version.rb
-homepage: ''
+- README.md
+- test/attendant_test.rb
+- test/conductor_test.rb
+- test/example.rb
+- test/line_test.rb
+- test/passenger_test.rb
+- test/route_test.rb
+- test/station_test.rb
+- test/target_test.rb
+- test/test_helper.rb
+- test/ticket_test.rb
+homepage: https://github.com/hopsoft/ellington
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -46,9 +114,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Write a gem summary
-test_files: []
-has_rdoc: 
+summary: A framework for moving stateful objects through a complex series of business
+  rules.
+test_files:
+- test/attendant_test.rb
+- test/conductor_test.rb
+- test/example.rb
+- test/line_test.rb
+- test/passenger_test.rb
+- test/route_test.rb
+- test/station_test.rb
+- test/target_test.rb
+- test/test_helper.rb
+- test/ticket_test.rb

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/ellington.gemspec

@@ -1,19 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ellington/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "ellington"
-  gem.version       = Ellington::VERSION
-  gem.authors       = ["Nathan Hopkins"]
-  gem.email         = ["natehop@gmail.com"]
-  gem.description   = %q{Write a gem description}
-  gem.summary       = %q{Write a gem summary}
-  gem.homepage      = ""
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-end