james 0.0.3-universal-darwin-10 → 0.0.4-universal-darwin-10

data/aux/james/cli.rb

@@ -4,18 +4,26 @@ module James
 
   class CLI
 
-    def execute *dialogues
-      all_dialogues = Dir["**/*_dialog{,ue}.rb"]
-      all_dialogues.select! { |dialogue| dialogues.any? { |given| dialogue =~ %r{#{given}_dialog(ue)?.rb$} } } unless dialogues.empty?
+    def execute *given_dialogues
+      dialogues = find_dialogues
+      dialogues.select! { |dialogue| given_dialogues.any? { |given| dialogue =~ %r{#{given}_dialog(ue)?.rb$} } } unless given_dialogues.empty?
 
-      puts "James: Using #{all_dialogues.join(', ')} for our conversation, Sir."
+      puts "James: I haven't found anything to talk about (No *_dialog{ue,}.rb files found). Exiting." or exit!(1) if dialogues.empty?
 
-      all_dialogues.each do |dialogue|
-        require File.expand_path dialogue, Dir.pwd
-      end
+      puts "James: Using #{dialogues.join(', ')} for our conversation, Sir."
+
+      require_all dialogues
 
       James.listen
     end
+    def find_dialogues
+      Dir["**/*_dialog{,ue}.rb"]
+    end
+    def require_all dialogues
+      dialogues.each do |dialogue|
+        require File.expand_path dialogue, Dir.pwd
+      end
+    end
 
   end
 

data/lib/james.rb

@@ -2,6 +2,7 @@ module James; end
 
 require File.expand_path '../james/timer', __FILE__
 require File.expand_path '../james/visitor', __FILE__
+require File.expand_path '../james/visitors', __FILE__
 require File.expand_path '../james/dialogues', __FILE__
 
 require File.expand_path '../james/dialogue_api', __FILE__

data/lib/james/builtin/core_dialogue.rb

@@ -0,0 +1,27 @@
+class CoreDialogue
+
+  include James::Dialogue
+
+  state :awake do
+    chainable # If James is awake, he offers more dialogues on this state, if there are any.
+
+    hear 'Leave me alone, James.'                  => :away,
+         "That's it for today, James."             => :exit,
+         "Something else, James."                  => :awake
+    into { "Sir?" }
+  end
+
+  state :away do
+    hear 'James?'                      => :awake,
+         "That's it for today, James." => :exit
+    into { "Of course, Sir!" }
+  end
+
+  state :exit do
+    into do
+      puts "James: Exits through a side door."
+      Kernel.exit
+    end
+  end
+
+end

data/lib/james/controller.rb

@@ -7,6 +7,8 @@ require File.expand_path '../inputs/terminal', __FILE__
 require File.expand_path '../outputs/audio', __FILE__
 require File.expand_path '../outputs/terminal', __FILE__
 
+require File.expand_path '../builtin/core_dialogue', __FILE__
+
 module James
 
   class Controller
@@ -14,7 +16,9 @@ module James
     attr_reader :visitor
 
     def initialize
-      @visitor = initialize_dialogues.visitor
+      user_visitor   = initialize_dialogues.visitor
+      system_visitor = Visitor.new CoreDialogue.new.state_for(:awake)
+      @visitor       = Visitors.new system_visitor, user_visitor
     end
 
     def applicationDidFinishLaunching notification
@@ -80,29 +84,31 @@ module James
       end
     end
     def expects
-      @visitor.expects
+      possibilities = @visitor.expects
+      puts "Possibilities:\n  #{possibilities.join("\n  ")}"
+      possibilities
     end
 
     def listen
       app = NSApplication.sharedApplication
       app.delegate = self
 
-      # window = NSWindow.alloc.initWithContentRect([200, 300, 300, 100],
+      # window = NSWindow.alloc.initWithContentRect([100, 300, 300, 100],
       #     styleMask:NSTitledWindowMask|NSClosableWindowMask|NSMiniaturizableWindowMask,
       #     backing:NSBackingStoreBuffered,
       #     defer:false)
-      # window.title      = 'MacRuby: The Definitive Guide'
+      # window.title      = 'James Debug/Info'
       # window.level      = 3
       # window.delegate   = app.delegate
+
+      # @button = NSButton.alloc.initWithFrame([10, 10, 400, 10])
+      # @button.bezelStyle = 4
+      # @button.title      = ''
+      # @button.target     = app.delegate
+      # @button.action     = 'say_hello:'
       #
-      # button = NSButton.alloc.initWithFrame([80, 10, 120, 80])
-      # button.bezelStyle = 4
-      # button.title      = 'Hello World!'
-      # button.target     = app.delegate
-      # button.action     = 'say_hello:'
-      #
-      # window.contentView.addSubview(button)
-      #
+      # window.contentView.addSubview(@button)
+
       # window.display
       # window.orderFrontRegardless
 

data/lib/james/dialogue_internals.rb

@@ -11,7 +11,7 @@ module James
 
     def self.included into
       into.extend ClassMethods
-      Dialogues << into
+      Dialogues << into unless into == CoreDialogue # TODO Dirty as hell.
     end
 
     #

data/lib/james/state_api.rb

@@ -58,6 +58,15 @@ module James
       @exit_block = block
     end
 
+    # By default, a state is not chainable.
+    #
+    def chainable?
+      @chainable
+    end
+    def chainable
+      @chainable = true
+    end
+
     # Description of self using name and transitions.
     #
     def to_s

data/lib/james/visitor.rb

@@ -21,13 +21,13 @@ module James
       @current = initial
 
       @initial = initial
-      @timer   = timer || Timer.new
+      # @timer   = timer || Timer.new
     end
 
     # Escapes the current state back to the initial.
     #
-    def escape
-      timer.stop
+    def reset
+      # timer.stop
       self.current = initial
     end
 
@@ -53,7 +53,7 @@ module James
     end
     def hear phrase, &block
       return unless hears? phrase
-      timer.restart
+      # timer.restart
       exit_text = exit &block
       transition phrase
       check &block
@@ -66,6 +66,15 @@ module James
     def expects
       current.phrases
     end
+    # Does the current state allow penetration into another dialogue?
+    #
+    def chainable?
+      current.chainable?
+    end
+
+    def to_s
+      "#{self.class.name}(#{initial}, current: #{current})"
+    end
 
   end
 

data/lib/james/visitors.rb

@@ -22,14 +22,39 @@ module James
       @visitors = visitors
     end
 
+    # Hear tries all visitors in order
+    # until one hears a phrase he knows.
+    #
+    # After that, all remaining visitors are reset.
+    #
     def hear phrase, &block
-      visitors.each do |visitor|
+      enumerator = visitors.dup
+
+      while visitor = enumerator.shift
         visitor.hear phrase, &block and break
       end
+
+      while visitor = enumerator.shift
+        visitor.reset
+      end
     end
 
+    # Enter enters the first dialogue.
+    #
+    def enter
+      visitors.first.enter
+    end
+
+    # Simply returns the sum of what phrases all dialogues expect.
+    #
+    # Stops as soon as a visitor is not in a chainable state anymore.
+    #
     def expects
-      visitors.inject([]) { |expects, visitor| expects + visitor.expects }
+      visitors.inject([]) do |expects, visitor|
+        total = expects + visitor.expects
+        break total unless visitor.chainable?
+        total
+      end
     end
 
   end

data/spec/aux/james/cli_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+#
+require File.expand_path '../../../../aux/james/cli', __FILE__
+
+describe James::CLI do
+  
+  before(:each) do
+    Dir.stub! :[] => ['test_dialogue.rb', 'test_dialog.rb', 'test/test_dialogue.rb']
+  end
+  
+  let(:cli) { James::CLI.new }
+  
+  describe 'find_dialogues' do
+    it 'returns the right ones' do
+      cli.find_dialogues.should == ['test_dialogue.rb', 'test_dialog.rb', 'test/test_dialogue.rb']
+    end
+  end
+  
+end

data/spec/lib/james/visitor_spec.rb

@@ -8,6 +8,30 @@ describe James::Visitor do
   let(:timer)   { stub :timer }
   let(:visitor) { described_class.new initial, timer }
   
+  describe 'reset' do
+    it 'works' do
+      expect { visitor.reset }.to_not raise_error
+    end
+    # it 'calls methods in order' do
+    #   timer.should_receive(:stop).once.with
+    #   visitor.should_receive(:current=).once.with initial
+    # 
+    #   visitor.reset
+    # end
+    it 'survives a functional test' do
+      next_state = stub :next_state
+      initial.stub! :next_for => next_state
+      
+      visitor.current.should == initial
+      visitor.transition :some_phrase
+      visitor.current.should == next_state
+      
+      visitor.reset
+      
+      visitor.current.should == initial
+    end
+  end
+  
   describe 'current' do
     it { visitor.current.should == initial }
   end
@@ -62,19 +86,10 @@ describe James::Visitor do
     end
   end
   
-  describe 'escape' do
-    it 'calls methods in order' do
-      timer.should_receive(:stop).once.with
-      visitor.should_receive(:current=).once.with initial
-      
-      visitor.escape
-    end
-  end
-  
   describe 'hear' do
     it 'calls methods in order' do
       visitor.should_receive(:hears?).once.ordered.with(:some_phrase).and_return true
-      timer.should_receive(:restart).once.ordered.with
+      # timer.should_receive(:restart).once.ordered.with
       visitor.should_receive(:exit).once.ordered.with
       visitor.should_receive(:transition).once.ordered.with :some_phrase
       # visitor.should_receive(:check).once.ordered.with

data/spec/lib/james/visitors_spec.rb

@@ -15,11 +15,14 @@ describe James::Visitors do
         second.stub! :hear => nil
       end
       it 'works' do
+        second.stub! :reset
+        
         visitors.hear 'some phrase'
       end
       it 'calls the second never' do
         first.should_receive(:hear).once.and_return true
         second.should_receive(:hear).never
+        second.should_receive(:reset).once
         
         visitors.hear 'some phrase'
       end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments:
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: universal-darwin-10
 authors:
 - Florian Hanke
@@ -42,7 +42,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/james/builtin/main_dialogue.rb
+- lib/james/builtin/core_dialogue.rb
 - lib/james/controller.rb
 - lib/james/dialogue_api.rb
 - lib/james/dialogue_internals.rb
@@ -50,7 +50,6 @@ files:
 - lib/james/inputs/audio.rb
 - lib/james/inputs/base.rb
 - lib/james/inputs/terminal.rb
-- lib/james/main_dialogue.rb
 - lib/james/outputs/audio.rb
 - lib/james/outputs/terminal.rb
 - lib/james/state_api.rb
@@ -90,6 +89,7 @@ signing_key:
 specification_version: 3
 summary: 'James: Modular Electronic Butler.'
 test_files:
+- spec/aux/james/cli_spec.rb
 - spec/integration/test_dialogue_spec.rb
 - spec/lib/james/controller_spec.rb
 - spec/lib/james/dialogue_spec.rb

data/lib/james/builtin/main_dialogue.rb

@@ -1,25 +0,0 @@
-class Bla
-
-  include James::Dialogue
-
-  hear 'James?' => :awake
-
-  state :awake do
-    hear 'Leave me alone, James' => :away
-    into { "Sir?" }
-  end
-
-  state :away do
-    hear 'Are you there, James?' => :awake,
-         "That's it for today, James" => :exit
-    into { "Goodbye, Sir" }
-  end
-
-  state :exit do
-    into do
-      puts "James: Exits through a side door."
-      Kernel.exit
-    end
-  end
-
-end

data/lib/james/main_dialogue.rb

@@ -1,15 +0,0 @@
-module James
-
-  # MainDialogue for first visitor.
-  #
-  module MainDialogue
-
-    extend Dialogue
-
-    def self.included into
-      into.extend ClassMethods
-    end
-
-  end
-
-end