james 0.1.1-universal-darwin-10 → 0.2.0-universal-darwin-10

data/lib/james/state_internals.rb

@@ -2,18 +2,28 @@ module James
 
   class State
 
-    attr_reader :transitions
+    # Transitions are internal transitions & external transitions.
+    #
+    def transitions
+      @transitions
+    end
 
-    # Returns all possible phrases that lead
-    # away from this state.
     #
-    def phrases
+    #
+    def expects
       transitions.keys
     end
 
+    #
+    #
+    def internal_expects
+      transitions.select { |phrase, target| target.respond_to?(:to_sym) || target == self.context }.keys
+    end
+
+
     # Returns the next state for the given phrase.
     #
-    # It accesses the context (aka Dialog(ue)) to get a full object state.
+    # It accesses the context (aka Dialog) to get a full object state.
     #
     # If it is a Symbol, James will try to get the real state.
     # If not, it will just return it (a State already, or lambda).
@@ -23,15 +33,26 @@ module James
       state.respond_to?(:id2name) ? context.state_for(state) : state
     end
 
-    def __into__
-      @into_block && context.instance_eval(&@into_block)
-    end
-    def __exit__
-      @exit_block && context.instance_eval(&@exit_block)
-    end
-    def __transition__ &block
-      context.instance_eval &block
-    end
+    # The naughty privates.
+    #
+
+      # Called by the visitor visiting this state.
+      #
+      def __into__
+        @into_block && context.instance_eval(&@into_block)
+      end
+
+      # Called by the visitor visiting this state.
+      #
+      def __exit__
+        @exit_block && context.instance_eval(&@exit_block)
+      end
+
+      # Called by the visitor visiting this state.
+      #
+      def __transition__ &block
+        context.instance_eval &block
+      end
 
   end
 

data/lib/james.rb

@@ -3,8 +3,10 @@ module James; end
 require File.expand_path '../james/state_api', __FILE__
 require File.expand_path '../james/state_internals', __FILE__
 
-require File.expand_path '../james/visitor', __FILE__
-require File.expand_path '../james/visitors', __FILE__
+require File.expand_path '../james/markers/marker', __FILE__
+require File.expand_path '../james/markers/current', __FILE__
+require File.expand_path '../james/markers/memory', __FILE__
+require File.expand_path '../james/conversation', __FILE__
 
 require File.expand_path '../james/dialog_api', __FILE__
 require File.expand_path '../james/dialog_internals', __FILE__
@@ -30,13 +32,11 @@ module James
   # If called twice or more, will just add more dialogs.
   #
   def self.use *dialogs
-    dialogs.each { |dialog| controller.add_dialog dialog }
+    dialogs.each { |dialog| controller << dialog}
   end
 
   # Start listening.
   #
-  # Will not listen again if already listening.
-  #
   def self.listen options
     controller.listen options
   end

metadata

@@ -2,14 +2,14 @@
 name: james
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.1.1
+  version: 0.2.0
 platform: universal-darwin-10
 authors:
 - Florian Hanke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-29 00:00:00 +10:00
+date: 2011-06-08 00:00:00 +10:00
 default_executable: james
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -38,6 +38,7 @@ extra_rdoc_files: []
 files:
 - lib/james/builtin/core_dialog.rb
 - lib/james/controller.rb
+- lib/james/conversation.rb
 - lib/james/dialog_api.rb
 - lib/james/dialog_internals.rb
 - lib/james/dialogs.rb
@@ -45,23 +46,15 @@ files:
 - lib/james/inputs/audio.rb
 - lib/james/inputs/base.rb
 - lib/james/inputs/terminal.rb
+- lib/james/markers/current.rb
+- lib/james/markers/marker.rb
+- lib/james/markers/memory.rb
 - lib/james/outputs/audio.rb
 - lib/james/outputs/terminal.rb
 - lib/james/state_api.rb
 - lib/james/state_internals.rb
-- lib/james/visitor.rb
-- lib/james/visitors.rb
 - lib/james.rb
 - aux/james/cli.rb
-- spec/aux/james/cli_spec.rb
-- spec/integration/test_dialogue_spec.rb
-- spec/lib/james/controller_spec.rb
-- spec/lib/james/dialog_spec.rb
-- spec/lib/james/inputs/audio_spec.rb
-- spec/lib/james/inputs/terminal_spec.rb
-- spec/lib/james/state_spec.rb
-- spec/lib/james/visitor_spec.rb
-- spec/lib/james/visitors_spec.rb
 - bin/james
 has_rdoc: true
 homepage: http://floere.github.com/james
@@ -88,13 +81,4 @@ rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: 'James: Modular Electronic Butler with modular Dialogs.'
-test_files:
-- spec/aux/james/cli_spec.rb
-- spec/integration/test_dialogue_spec.rb
-- spec/lib/james/controller_spec.rb
-- spec/lib/james/dialog_spec.rb
-- spec/lib/james/inputs/audio_spec.rb
-- spec/lib/james/inputs/terminal_spec.rb
-- spec/lib/james/state_spec.rb
-- spec/lib/james/visitor_spec.rb
-- spec/lib/james/visitors_spec.rb
+test_files: []

data/lib/james/visitor.rb

@@ -1,80 +0,0 @@
-module James
-
-  # The visitor knows where in the conversation we are.
-  #
-  # It also remembers where it has to go back to if
-  # too much time passes without input.
-  #
-  # Note: A visitor should generally be very stupid.
-  #
-  class Visitor
-
-    attr_reader   :initial, :timer
-    attr_accessor :current
-
-    # Pass in an initial state to start from.
-    #
-    def initialize initial
-      @current = initial
-
-      @initial = initial
-    end
-
-    # Resets the current state back to the initial.
-    #
-    def reset
-      self.current = initial
-    end
-
-    # We hear a phrase.
-    #
-    # Also used to start the whole process.
-    #
-    def enter
-      result = current.__into__
-      yield result if result && block_given?
-      result
-    end
-    def exit
-      result = current.__exit__
-      yield result if result && block_given?
-      result
-    end
-    def transition phrase
-      state_or_lambda = current.next_for phrase
-      if state_or_lambda.respond_to?(:call)
-        current.__transition__ &state_or_lambda # Don't transition.
-      else
-        self.current = state_or_lambda
-      end
-    end
-    def check
-      reset && yield("Whoops. That led nowhere. Perhaps you didn't define the target state?") unless self.current
-    end
-    def hear phrase, &block
-      return unless hears? phrase
-      exit_text = exit &block
-      transition phrase
-      check &block
-      into_text = enter &block
-      exit_text || into_text
-    end
-    def hears? phrase
-      expects.include? phrase
-    end
-    def expects
-      current.phrases
-    end
-    # Does the current state allow penetration into another dialog?
-    #
-    def chainable?
-      current.chainable?
-    end
-
-    def to_s
-      "#{self.class.name}(#{initial}, current: #{current})"
-    end
-
-  end
-
-end

data/lib/james/visitors.rb

@@ -1,62 +0,0 @@
-module James
-
-  # The visitors class has a number of visitors, whose
-  # dialogs are visited in order of preference.
-  #
-  # Why?
-  # Discussions have multiple points where they can be.
-  # (Politics, then this joke, then back again, finally "Oh, bye I have to go!")
-  #
-  # In James, though, it is much simpler.
-  # We just have a visitor in an entry scenario
-  # (James!, Sleep, Wake up, Something completely different)
-  # and one in any specific user-given scenario.
-  #
-  # Visitors is a proxy object for visitors.
-  #
-  class Visitors
-
-    attr_reader :visitors
-
-    def initialize *visitors
-      @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
-      enumerator = visitors.dup
-
-      while visitor = enumerator.shift
-        visitor.hear phrase, &block and break
-      end
-
-      enumerator.each do |visitor|
-        visitor.reset
-      end
-    end
-
-    # Enter enters the first visitor.
-    #
-    def enter
-      visitors.first.enter
-    end
-
-    # Simply returns the sum of what phrases all dialogs do expect, front-to-back.
-    #
-    # Stops as soon as a visitor is not in a chainable state anymore.
-    #
-    def expects
-      visitors.inject([]) do |expects, visitor|
-        total = visitor.expects + expects
-        break total unless visitor.chainable?
-        total
-      end
-    end
-
-  end
-
-end

data/spec/aux/james/cli_spec.rb

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

data/spec/integration/test_dialogue_spec.rb

@@ -1,67 +0,0 @@
-# encoding: utf-8
-#
-require File.expand_path '../../../lib/james', __FILE__
-
-describe 'TestDialog' do
-
-  context 'unit' do
-    let(:dialog) do
-
-      Class.new do
-        include James::Dialog
-
-        hear ['test1', 'test2'] => :first
-        
-        state :first do
-          hear 'go' => :second, 'stay' => :first
-        end
-        
-        state :second do
-          hear 'go' => :third, 'back' => :first
-        end
-      end.new
-
-    end
-    let(:visitor) do
-      James::Visitor.new dialog.state_for(:first)
-    end
-
-    describe "integration" do
-      it 'works correctly' do
-        visitor.current.name.should == :first
-        visitor.hear('go') {}
-        visitor.current.name.should == :second
-        visitor.hear('back') {}
-        visitor.current.name.should == :first
-        visitor.hear('stay') {}
-        visitor.current.name.should == :first
-      end
-    end
-  end
-  
-  # context 'integration' do
-  #   let(:dialog) do
-  #     dialog = Class.new do
-  #       include James::Dialog
-  # 
-  #       hear ['test1', 'test2'] => :first
-  #       state :first do
-  #         hear 'go' => :second, 'stay' => :first
-  #       end
-  #       state :second do
-  #         hear 'go' => :third, 'back' => :first
-  #       end
-  #     end.new
-  #   end
-  #   it 'works correctly' do
-  #     dialog.state.name.should == :awake
-  #     dialog.hear 'sleep'
-  #     dialog.state.name.should == :sleeping
-  #   end
-  #   it 'delegates correctly' do
-  #     dialog.state.name.should == :awake
-  #     dialog.hear 'test1'
-  #   end
-  # end
-
-end

data/spec/lib/james/controller_spec.rb

@@ -1,35 +0,0 @@
-# encoding: utf-8
-#
-require File.expand_path '../../../../lib/james/dialog_api', __FILE__
-require File.expand_path '../../../../lib/james/dialog_internals', __FILE__
-require File.expand_path '../../../../lib/james/builtin/core_dialog', __FILE__
-require File.expand_path '../../../../lib/james/visitors', __FILE__
-require File.expand_path '../../../../lib/james/visitor', __FILE__
-require File.expand_path '../../../../lib/james/state_api', __FILE__
-require File.expand_path '../../../../lib/james/dialogs', __FILE__
-require File.expand_path '../../../../lib/james/inputs/base', __FILE__
-require File.expand_path '../../../../lib/james/inputs/terminal', __FILE__
-require File.expand_path '../../../../lib/james/inputs/audio', __FILE__
-require File.expand_path '../../../../lib/james/controller', __FILE__
-
-describe James::Controller do
-  
-  let(:controller) { described_class.new }
-  
-  describe 'listening?' do
-    it 'is correct' do
-      controller.listening?.should == false
-    end
-  end
-  describe 'expects' do
-    it 'delegates' do
-      visitor = stub! :visitor
-      controller.stub! :visitor => visitor
-      
-      visitor.should_receive(:expects).once.with()
-      
-      controller.expects
-    end
-  end
-  
-end

data/spec/lib/james/dialog_spec.rb

@@ -1,90 +0,0 @@
-# encoding: utf-8
-#
-require File.expand_path '../../../../lib/james', __FILE__
-require File.expand_path '../../../../lib/james/state_api', __FILE__
-require File.expand_path '../../../../lib/james/dialog_api', __FILE__
-require File.expand_path '../../../../lib/james/dialog_internals', __FILE__
-require File.expand_path '../../../../lib/james/builtin/core_dialog', __FILE__
-require File.expand_path '../../../../lib/james/dialogs', __FILE__
-
-describe James::Dialog do
-  
-  context 'units' do
-    let(:dialog) do
-      James.use_dialog do
-        
-        hear 'something' => :first
-        
-        state :first do
-          hear 'something else' => :second
-          into {}
-          exit {}
-        end
-        
-        state :second do
-          hear 'yet something else' => :first
-          into {}
-          exit {}
-        end
-        
-      end
-    end
-    describe 'state_for' do
-      it 'delegates to the class, adding itself' do
-        new_dialog = dialog.new
-        dialog.should_receive(:state_for).once.with :some_name, new_dialog
-        
-        new_dialog.state_for :some_name
-      end
-      it 'returns nil on not found' do
-        dialog.new.state_for(:nonexistent).should == nil
-      end
-    end
-  end
-  
-  describe 'hear with lambda' do
-    let(:dialog) do
-      class Test
-        include James::Dialog
-        
-        def initialize
-          @bla = 'some bla'
-        end
-        
-        state :test do
-          hear 'bla' => ->(){ @bla }
-        end
-      end
-      Test.new
-    end
-    it "is instance eval'd" do
-      test_state = dialog.state_for :test
-      test_state.hear 'bla' do |result|
-        result.should == 'some bla'
-      end
-    end
-  end
-  
-  describe 'initialization' do
-    it 'can be included' do
-      expect do
-        class Test
-          include James::Dialog
-          
-          hear 'something' => :some_state
-        end
-      end.to_not raise_error
-    end
-    
-    it 'can be defined' do
-      expect do
-        James.dialog do
-          
-          hear 'something' => :some_state
-          
-        end
-      end.to_not raise_error
-    end
-  end
-  
-end

data/spec/lib/james/inputs/audio_spec.rb

@@ -1,18 +0,0 @@
-# encoding: utf-8
-#
-require File.expand_path '../../../../../lib/james/inputs/base', __FILE__
-require File.expand_path '../../../../../lib/james/inputs/audio', __FILE__
-
-describe James::Inputs::Audio do
-  
-  let(:input) { described_class.new }
-  
-  describe 'speechRecognizer' do
-    it 'does something' do
-      sender = stub :sender
-      
-      input.speechRecognizer sender
-    end
-  end
-  
-end

data/spec/lib/james/inputs/terminal_spec.rb

@@ -1,12 +0,0 @@
-# encoding: utf-8
-#
-require File.expand_path '../../../../../lib/james/inputs/base', __FILE__
-require File.expand_path '../../../../../lib/james/inputs/terminal', __FILE__
-
-describe James::Inputs::Terminal do
-  
-  let(:input) { described_class.new }
-  
-  
-  
-end