james 0.0.6-universal-darwin-10 → 0.0.7-universal-darwin-10

data/bin/james

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 #
 
-# james joke phonebook quote
+# james joke phonebook quote # Uses just the described ones.
 # OR
-# james # Uses Dir.pwd
+# james # Uses all it can find.
 #
 
 begin

data/lib/james.rb

@@ -1,13 +1,27 @@
 module James; end
 
-require File.expand_path '../james/timer', __FILE__
+# require File.expand_path '../james/timer', __FILE__
+
+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/dialogues', __FILE__
 
 require File.expand_path '../james/dialogue_api', __FILE__
 require File.expand_path '../james/dialogue_internals', __FILE__
 
+require File.expand_path '../james/dialogues', __FILE__
+
+require File.expand_path '../james/inputs/base', __FILE__
+require File.expand_path '../james/inputs/audio', __FILE__
+require File.expand_path '../james/inputs/terminal', __FILE__
+
+require File.expand_path '../james/outputs/audio', __FILE__
+require File.expand_path '../james/outputs/terminal', __FILE__
+
+require File.expand_path '../james/builtin/core_dialogue', __FILE__
+
 require File.expand_path '../james/controller', __FILE__
 
 module James

data/lib/james/builtin/core_dialogue.rb

@@ -1,22 +1,43 @@
+# This is the core dialogue every dialogue will be hooking into.
+#
+# Eventually, the design should be such that everyone can use
+# the design and core dialogue they like best.
+#
+# But to get going, this suffices for now.
+#
 class CoreDialogue
 
   include James::Dialogue
 
+  # The alert state.
+  # When James is in this state, he should be
+  # open for user dialogues.
+  #
   state :awake do
-    chainable # If James is awake, he offers more dialogues on this state, if there are any.
+    # If James is awake, he offers more dialogues
+    # on this state, if there are any hooked into this state.
+    #
+    chainable
 
-    hear 'I need some time alone, James.'          => :away,
-         "Good night, James."                      => :exit,
-         ["Thank you, James.", "Thanks, James."]   => :awake
+    hear 'I need some time alone, James.' => :away,
+         "Good night, James."             => :exit,
+         "Thank you, James."              => :awake
     into { "Sir?" }
   end
 
+  # The away state. James does not listen to any
+  # user dialogue hooks, but only for his name
+  # or the good night, i.e. exit phrase.
+  #
   state :away do
     hear 'James?'             => :awake,
          "Good night, James." => :exit
     into { "Of course, Sir!" }
   end
 
+  # This is not a real state. It just exists to Kernel.exit
+  # James when he enters this state.
+  #
   state :exit do
     into do
       puts "James: Exits through a side door."

data/lib/james/controller.rb

@@ -1,14 +1,5 @@
 framework 'AppKit'
 
-require File.expand_path '../inputs/base', __FILE__
-require File.expand_path '../inputs/audio', __FILE__
-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
@@ -36,18 +27,7 @@ module James
     # Load voices from yaml.
     #
     def load_voices
-      # yaml_voices = ''
-      # File.open('voices.yml') do |f| yaml_voices << f.read end
-      # voices = YAML.load(yaml_voices)
-      # @male_voice = voices['male']
-      # @female_voice = voices['female']
-      # Commented voices are Apple built-in voices. Can be changed by replacing the last part e.g.'Vicki' with e.g.'Laura'
-      # much better female voice from iVox:
-      # female: com.acapela.iVox.voice.iVoxHeather22k
-      # much better male voice from iVox:
-      # male: com.acapela.iVox.voice.iVoxRyan22k
-      # female: com.apple.speech.synthesis.voice.Vicki
-      # male: com.apple.speech.synthesis.voice.Bruce
+      # TODO
     end
 
     # Initialize and "parse" the
@@ -61,7 +41,7 @@ module James
     # Start recognizing words.
     #
     def start_input
-      @input = Inputs::Audio.new self
+      @input = Inputs::Terminal.new self
       @input.listen
     end
     # Start speaking.

data/lib/james/dialogue_api.rb

@@ -16,6 +16,10 @@ module James
   #
   module Dialogue; end
 
+  # We don't care about the spelling.
+  #
+  Dialog = Dialogue
+
   class << self
 
     def dialogue &block

data/lib/james/dialogue_internals.rb

@@ -1,7 +1,3 @@
-require File.expand_path '../state_api', __FILE__
-require File.expand_path '../state_internals', __FILE__
-require File.expand_path '../dialogues', __FILE__
-
 module James
 
   # A dialogue is just a container object
@@ -54,8 +50,4 @@ module James
 
   end
 
-  # We don't care about the spelling.
-  #
-  Dialog = Dialogue
-
 end

data/lib/james/dialogues.rb

@@ -1,5 +1,3 @@
-require File.expand_path '../visitor', __FILE__
-
 module James
 
   # Registers all dialogues and connects their states.
@@ -42,6 +40,8 @@ module James
         end
       end
 
+      # Hook all user dialogues into the initial state.
+      #
       initial.hear resolved_entries
     end
 

data/lib/james/inputs/audio.rb

@@ -26,6 +26,8 @@ module James
 
       # Callback method from the speech interface.
       #
+      # Note: Uses a MacRuby only form.
+      #
       def speechRecognizer sender, didRecognizeCommand: command
         heard command
       end

data/lib/james/inputs/base.rb

@@ -10,6 +10,8 @@ module James
         @controller = controller
       end
 
+      # Call this method if you heard something in the subclass.
+      #
       def heard command
         # Call dialogue.
         #

data/lib/james/inputs/terminal.rb

@@ -7,6 +7,7 @@ module James
     class Terminal < Base
 
       def listen
+        sleep 2
         loop do
           possibilities = controller.expects
           puts "Possibilities:\n  #{possibilities.join("\n  ")}"

data/lib/james/state_api.rb

@@ -43,7 +43,7 @@ module James
     #
     def hear transitions
       transitions = { transitions => name } unless transitions.respond_to?(:to_hash)
-      @transitions = expand transitions
+      @transitions.merge! expand(transitions)
     end
 
     # Execute this block when entering this state.

data/lib/james/state_internals.rb

@@ -13,11 +13,14 @@ module James
 
     # Returns the next state for the given phrase.
     #
-    # It accesses the context (Dialog(ue)) to get a full object state.
+    # It accesses the context (aka Dialog(ue)) 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).
     #
     def next_for phrase
       state = self.transitions[phrase]
-      state.respond_to?(:phrases) ? state : context.state_for(state)
+      state.respond_to?(:id2name) ? context.state_for(state) : state
     end
 
     def __into__

data/lib/james/visitor.rb

@@ -1,5 +1,3 @@
-require File.expand_path '../timer', __FILE__
-
 module James
 
   # The visitor knows where in the conversation we are.
@@ -46,10 +44,15 @@ module James
       result
     end
     def transition phrase
-      self.current = current.next_for phrase
+      state_or_lambda = current.next_for phrase
+      if state_or_lambda.respond_to?(:call)
+        state_or_lambda.call # Don't transition.
+      else
+        self.current = state_or_lambda
+      end
     end
     def check
-      escape && yield("That led nowhere.") unless current
+      escape && yield("That led nowhere.") unless self.current
     end
     def hear phrase, &block
       return unless hears? phrase

data/spec/lib/james/dialogue_spec.rb

@@ -2,6 +2,8 @@
 #
 require File.expand_path '../../../../lib/james/dialogue_api', __FILE__
 require File.expand_path '../../../../lib/james/dialogue_internals', __FILE__
+require File.expand_path '../../../../lib/james/builtin/core_dialogue', __FILE__
+require File.expand_path '../../../../lib/james/dialogues', __FILE__
 
 describe James::Dialogue do
   

data/spec/lib/james/state_spec.rb

@@ -76,6 +76,17 @@ describe James::State do
     end
   end
   
+  context 'with a returning transition' do
+    let(:state) do
+      described_class.new :some_name, @context do
+        hear 'transition one' => lambda { "I do this and return to :some_name" }
+      end
+    end
+    describe 'phrases' do
+      it { state.phrases.should == ['transition one'] }
+    end
+  end
+  
   context 'with 1 transition and into and exit' do
     let(:state) do
       described_class.new :some_name, @context do
@@ -106,12 +117,12 @@ describe James::State do
     end
   end
   
-  context 'with multiple transition' do
+  context 'with multiple transition and separate hears' do
     let(:state) do
       described_class.new :some_name, @context do
         hear 'transition one'   => :next_state1,
-             'transition two'   => :next_state2,
-             'transition three' => :next_state3
+             'transition two'   => :next_state2
+        hear 'transition three' => :next_state3
       end
     end
     describe 'phrases' do
@@ -121,6 +132,24 @@ describe James::State do
       it { state.to_s.should == 'James::State(some_name, some_context, {"transition one"=>:next_state1, "transition two"=>:next_state2, "transition three"=>:next_state3})' }
     end
     it { state.next_for('transition two').should == :some_state_object2 }
+    it { state.next_for('transition three').should == :some_state_object3 }
+    it { state.next_for('non-existent').should == nil }
+  end
+  
+  context 'with self-transitions' do
+    some_proc = ->(){ "Going back to where I came from" }
+    let(:state) do
+      described_class.new :some_name, @context do
+        hear 'transition one' => some_proc
+      end
+    end
+    describe 'phrases' do
+      it { state.phrases.should == ['transition one'] }
+    end
+    describe 'to_s' do
+      it { state.to_s.should == "James::State(some_name, some_context, {\"transition one\"=>#{some_proc}})" }
+    end
+    it { state.next_for('transition one').should == some_proc }
     it { state.next_for('non-existent').should == nil }
   end
   

data/spec/lib/james/visitors_spec.rb

@@ -45,11 +45,20 @@ describe James::Visitors do
   end
   
   describe 'expects' do
-    before(:each) do
-      first.stub!  :expects => [:a, :b]
-      second.stub! :expects => [:c, :d, :e]
+    context 'chainable' do
+      before(:each) do
+        first.stub!  :expects => [:a, :b], :chainable? => true
+        second.stub! :expects => [:c, :d, :e], :chainable? => true
+      end
+      it { visitors.expects.should == [:a, :b, :c, :d, :e] }
+    end
+    context 'not chainable' do
+      before(:each) do
+        first.stub!  :expects => [:a, :b], :chainable? => false
+        second.stub! :expects => [:c, :d, :e], :chainable? => false
+      end
+      it { visitors.expects.should == [:a, :b] }
     end
-    it { visitors.expects.should == [:a, :b, :c, :d, :e] }
   end
 
 end

metadata

@@ -1,38 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: james
 version: !ruby/object:Gem::Version
-  prerelease: false
-  segments:
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
+  prerelease: 
+  version: 0.0.7
 platform: universal-darwin-10
 authors:
 - Florian Hanke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-10 00:00:00 +10:00
+date: 2011-05-13 00:00:00 +10:00
 default_executable: james
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        segments:
-        - 0
         version: "0"
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        segments:
-        - 0
         version: "0"
 description: Modular Electronic Butler. Using a simple dialogue system where you can
   easily add more dialogues.
@@ -58,9 +52,15 @@ files:
 - lib/james/visitor.rb
 - lib/james/visitors.rb
 - lib/james.rb
-- lib/old/main.rb
-- lib/old/main_dialogue.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/dialogue_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
 licenses: []
@@ -69,22 +69,20 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
       version: "0"
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: 'James: Modular Electronic Butler with modular Dialogues.'

data/lib/old/main.rb

@@ -1,30 +0,0 @@
-# Instead of this, check for __main__.
-#
-
-require File.expand_path '../../james', __FILE__
-
-app = NSApplication.sharedApplication
-app.delegate = James::Controller.new
-
-# window = NSWindow.alloc.initWithContentRect([200, 300, 300, 100],
-#     styleMask:NSTitledWindowMask|NSClosableWindowMask|NSMiniaturizableWindowMask,
-#     backing:NSBackingStoreBuffered,
-#     defer:false)
-# window.title      = 'MacRuby: The Definitive Guide'
-# window.level      = 3
-# window.delegate   = app.delegate
-#
-# 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.display
-# window.orderFrontRegardless
-
-app.delegate.applicationDidFinishLaunching nil
-
-app.run

data/lib/old/main_dialogue.rb

@@ -1,47 +0,0 @@
-module James
-
-  # This is the default main dialogue.
-  #
-  # It is a proxy to the internal dialogues.
-  #
-  class MainDialogue
-    include Dialogue
-
-    hear 'wake up james' => :awake
-
-    # Create Protostate with block. Then, create instance instance_evaling block.
-    #
-    state :awake do
-      hear 'sleep james' => :sleeping
-      hear 'my options?' { |the_next| the_next.phrases.join ' ' }
-      into { "At your service" }
-      exit { "Right away" }
-    end
-
-    state :sleeping do
-      hear 'wake up james' => :awake
-      into { "Good night, Sir" }
-    end
-
-    # state :awake, {
-    #   'sleep james' => :sleeping
-    #   # 'james, my options?' => lambda { || } # stays in this state but executes.
-    # }
-    # state :sleeping, {
-    #   'wake up james' => :awake
-    # }
-    # entry 'wake up james' => :awake
-    #
-    # def enter_sleeping
-    #   "Good night, Sir"
-    # end
-    # def enter_awake
-    #   "At your service"
-    # end
-    # def exit_awake
-    #   "Right away"
-    # end
-
-  end
-
-end