james 0.1.0-universal-darwin-10 → 0.1.1-universal-darwin-10

data/aux/james/cli.rb

@@ -5,6 +5,10 @@ module James
   class CLI
 
     def execute *patterns
+      silent        = patterns.delete '-s'
+      silent_input  = patterns.delete '-si'
+      silent_output = patterns.delete '-so'
+
       dialogs = find_dialogs_for patterns
 
       puts "James: I haven't found anything to talk about (No files found). Exiting." or exit!(1) if dialogs.empty?
@@ -12,7 +16,11 @@ module James
 
       load_all dialogs
 
-      James.listen
+      options = {}
+      options[:input]  = Inputs::Terminal  if silent || silent_input
+      options[:output] = Outputs::Terminal if silent || silent_output
+
+      James.listen options
     end
     def find_dialogs_for patterns
       patterns = ["**/*_dialog{,ue}.rb"] if patterns.empty?

data/bin/james

@@ -7,6 +7,11 @@
 # OR
 # james # Uses all dialogs it can find in this dir and subdirs.
 #
+# Options:
+#  * -s  # Silent input and output (same as "-si -so").
+#  * -si # Silent input.
+#  * -so # Silent output.
+#
 
 begin
   require 'james/cli'

data/lib/james.rb

@@ -1,7 +1,5 @@
 module James; end
 
-# require File.expand_path '../james/timer', __FILE__
-
 require File.expand_path '../james/state_api', __FILE__
 require File.expand_path '../james/state_internals', __FILE__
 
@@ -35,18 +33,18 @@ module James
     dialogs.each { |dialog| controller.add_dialog dialog }
   end
 
-  # Start a new controller and listen.
+  # Start listening.
   #
   # Will not listen again if already listening.
   #
-  def self.listen
-    controller.listen unless controller.listening?
+  def self.listen options
+    controller.listen options
   end
 
   # Controller instance.
   #
   def self.controller
-    @controller ||= Controller.new
+    Controller.instance
   end
 
 end

data/lib/james/controller.rb

@@ -2,21 +2,34 @@ module James
 
   class Controller
 
-    attr_reader :visitor
+    attr_reader :visitor, :listening
+
+    # Singleton reader.
+    #
+    def self.instance
+      @controller ||= new
+    end
 
     # This puts together the core dialog and the user
     # ones that are hooked into it.
     #
     # TODO Rewrite this. Design needs some refactoring.
+    #      Should the user visitor be created dynamically? (Probably yes.)
     #
     def initialize
-      @user_dialogs  = Dialogs.new
-      system_visitor = Visitor.new CoreDialog.new.state_for(:awake)
-      @visitor       = Visitors.new system_visitor, @user_dialogs.visitor
+      @user_dialogs = Dialogs.new
+      @visitor      = Visitors.new system_visitor, user_visitor
+    end
+    def system_visitor
+      Visitor.new CoreDialog.new.state_for(:awake)
+    end
+    def user_visitor
+      @user_dialogs.visitor
     end
 
+    # MacRuby callback functions.
+    #
     def applicationDidFinishLaunching notification
-      load_voices
       start_output
       start_input
     end
@@ -24,12 +37,6 @@ module James
       exit
     end
 
-    # Load voices from yaml.
-    #
-    def load_voices
-      # TODO
-    end
-
     # Add a dialog to the current system.
     #
     def add_dialog dialog
@@ -39,13 +46,13 @@ module James
     # Start recognizing words.
     #
     def start_input
-      @input = Inputs::Audio.new self
+      @input = @input_class.new self
       @input.listen
     end
     # Start speaking.
     #
     def start_output
-      @output = Outputs::Audio.new
+      @output = @output_class.new @output_options
     end
 
     # Callback method from dialog.
@@ -62,38 +69,28 @@ module James
       visitor.expects
     end
 
-    def listen
+    # Start listening using the provided options.
+    #
+    # Options:
+    #  * input  # Inputs::Terminal or Inputs::Audio (default).
+    #  * output # Outputs::Terminal or Outputs::Audio (default).
+    #
+    def listen options = {}
+      return if listening
+
+      @input_class    = options[:input]  || Inputs::Audio
+      @output_class   = options[:output] || Outputs::Audio
+
+      @output_options ||= {}
+      @output_options[:voice] = options[:voice] || 'com.apple.speech.synthesis.voice.Alex'
+
       app = NSApplication.sharedApplication
       app.delegate = self
 
-      # window = NSWindow.alloc.initWithContentRect([100, 300, 300, 100],
-      #     styleMask:NSTitledWindowMask|NSClosableWindowMask|NSMiniaturizableWindowMask,
-      #     backing:NSBackingStoreBuffered,
-      #     defer:false)
-      # 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:'
-      #
-      # window.contentView.addSubview(@button)
-
-      # window.display
-      # window.orderFrontRegardless
-
       @listening = true
 
       app.run
     end
-    # If listen has been called, it is listening.
-    #
-    def listening?
-      !!@listening
-    end
 
   end
 

data/lib/james/dialog_api.rb

@@ -2,7 +2,7 @@ module James
 
   # A dialog can be instantiated in two ways:
   #
-  # The simple way, will directly add itself to James.
+  # The simple way will directly add itself to James.
   #
   # James.use_dialog(optional_args_for_initialize) do
   #   # Your dialog.
@@ -10,12 +10,16 @@ module James
   # end
   #
   # class MyDialog
+  #
   #   include James::Dialog
   #
-  #   # Your dialog.
+  #   # Your dialog definition.
   #   #
+  #
   # end
   #
+  # # Tell James to use the dialog.
+  # #
   # James.use MyDialog.new
   #
   module Dialog; end

data/lib/james/inputs/audio.rb

@@ -33,7 +33,10 @@ module James
       end
       def recognize_new_commands
         possibilities = controller.expects
-        puts "Possibilities:\n  #{possibilities.join("\n  ")}"
+        puts "Possibilities:\n"
+        possibilities.each_with_index do |possibility, index|
+          puts "#{index + 1})  #{possibility}"
+        end
         @recognizer.setCommands possibilities
       end
 

data/lib/james/inputs/base.rb

@@ -13,11 +13,18 @@ module James
       # Call this method if you heard something in the subclass.
       #
       def heard command
-        # Call dialog.
-        #
         controller.hear command
       end
 
+      # Shows possible commands in the terminal.
+      #
+      def show_possibilities possibilities
+        puts "Possibilities:\n"
+        possibilities.each_with_index do |possibility, index|
+          puts "#{index + 1})  #{possibility}"
+        end
+      end
+
     end
 
   end

data/lib/james/inputs/terminal.rb

@@ -6,17 +6,30 @@ module James
     #
     class Terminal < Base
 
+      # Start listening to commands by the user.
+      #
       def listen
         sleep 2
         loop do
           possibilities = controller.expects
-          puts "Possibilities:\n  #{possibilities.join("\n  ")}"
-          command = gets.chop
+          show_possibilities possibilities
+          command = get_command
           puts "I heard '#{command}'."
+          command = possibilities[command.to_i-1] unless command.to_i.zero?
           heard command if possibilities.include? command
         end
       end
 
+      # Get the next command by the user.
+      #
+      def get_command
+        STDIN.gets.chop
+      rescue IOError
+        puts "Wait a second, please, Sir, I am busy."
+        sleep 1
+        retry
+      end
+
     end
 
   end

data/lib/james/outputs/audio.rb

@@ -4,11 +4,17 @@ module James
 
     class Audio
 
-
-      def initialize voice = nil
-        @output = NSSpeechSynthesizer.alloc.initWithVoice voice || 'com.apple.speech.synthesis.voice.Alex'
+      # Create a new audio output.
+      #
+      # Options:
+      #  * voice # Default is 'com.apple.speech.synthesis.voice.Alex'.
+      #
+      def initialize options = {}
+        @output = NSSpeechSynthesizer.alloc.initWithVoice options[:voice] || 'com.apple.speech.synthesis.voice.Alex'
       end
 
+      # Say the given text out loud.
+      #
       def say text
         @output.startSpeakingString text
       end

data/lib/james/outputs/terminal.rb

@@ -6,8 +6,18 @@ module James
     #
     class Terminal
 
+      #
+      #
+      def initialize options = {}
+
+      end
+
+      # Say the given text in the terminal.
+      #
       def say text
+        puts
         p text
+        puts
       end
 
     end

data/lib/james/visitor.rb

@@ -6,10 +6,6 @@ module James
   # too much time passes without input.
   #
   # Note: A visitor should generally be very stupid.
-  # Note 2: We could call this Hearing, or Ear ;)
-  #
-  # TODO Add a timer which resets the state to the
-  #      initial state.
   #
   class Visitor
 
@@ -18,17 +14,15 @@ module James
 
     # Pass in an initial state to start from.
     #
-    def initialize initial, timer = nil
+    def initialize initial
       @current = initial
 
       @initial = initial
-      # @timer   = timer || Timer.new
     end
 
     # Resets the current state back to the initial.
     #
     def reset
-      # timer.stop
       self.current = initial
     end
 
@@ -59,7 +53,6 @@ module James
     end
     def hear phrase, &block
       return unless hears? phrase
-      # timer.restart
       exit_text = exit &block
       transition phrase
       check &block

data/lib/james/visitors.rb

@@ -22,10 +22,6 @@ module James
       @visitors = visitors
     end
 
-    def add_dialog dialog
-
-    end
-
     # Hear tries all visitors in order
     # until one hears a phrase he knows.
     #
@@ -38,18 +34,18 @@ module James
         visitor.hear phrase, &block and break
       end
 
-      while visitor = enumerator.shift
+      enumerator.each do |visitor|
         visitor.reset
       end
     end
 
-    # Enter enters the first dialog.
+    # Enter enters the first visitor.
     #
     def enter
       visitors.first.enter
     end
 
-    # Simply returns the sum of what phrases all dialogs expect.
+    # 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.
     #

data/spec/lib/james/controller_spec.rb

@@ -7,6 +7,9 @@ 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

data/spec/lib/james/dialog_spec.rb

@@ -9,10 +9,6 @@ require File.expand_path '../../../../lib/james/dialogs', __FILE__
 
 describe James::Dialog do
   
-  it 'can haz merkin spellink' do
-    James::Dialog.should == James::Dialog
-  end
-  
   context 'units' do
     let(:dialog) do
       James.use_dialog do
@@ -89,15 +85,6 @@ describe James::Dialog do
         end
       end.to_not raise_error
     end
-    it 'can haz merkin spellink' 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

@@ -0,0 +1,18 @@
+# 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

@@ -0,0 +1,12 @@
+# 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

metadata

@@ -2,14 +2,14 @@
 name: james
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: universal-darwin-10
 authors:
 - Florian Hanke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-21 00:00:00 +10:00
+date: 2011-05-29 00:00:00 +10:00
 default_executable: james
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -49,7 +49,6 @@ files:
 - lib/james/outputs/terminal.rb
 - lib/james/state_api.rb
 - lib/james/state_internals.rb
-- lib/james/timer.rb
 - lib/james/visitor.rb
 - lib/james/visitors.rb
 - lib/james.rb
@@ -58,6 +57,8 @@ files:
 - 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
@@ -92,6 +93,8 @@ test_files:
 - 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

data/lib/james/timer.rb

@@ -1,14 +0,0 @@
-module James
-
-  class Timer
-
-    def stop
-
-    end
-    def restart
-
-    end
-
-  end
-
-end