james 0.0.12-universal-darwin-10 → 0.1.0-universal-darwin-10

data/aux/james/cli.rb

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

data/bin/james

@@ -1,9 +1,11 @@
 #!/usr/bin/env ruby
 #
 
-# james joke phonebook quote # Uses just the described ones.
+# james joke_dialog.rb phonebook_dialog.rb quote_dialog.rb # Uses just the described ones.
 # OR
-# james # Uses all it can find.
+# james j*.rb # Uses all the dialogs matching the pattern.
+# OR
+# james # Uses all dialogs it can find in this dir and subdirs.
 #
 
 begin

data/lib/james.rb

@@ -8,10 +8,10 @@ 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/dialogue_api', __FILE__
-require File.expand_path '../james/dialogue_internals', __FILE__
+require File.expand_path '../james/dialog_api', __FILE__
+require File.expand_path '../james/dialog_internals', __FILE__
 
-require File.expand_path '../james/dialogues', __FILE__
+require File.expand_path '../james/dialogs', __FILE__
 
 require File.expand_path '../james/inputs/base', __FILE__
 require File.expand_path '../james/inputs/audio', __FILE__
@@ -20,20 +20,33 @@ 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/builtin/core_dialog', __FILE__
 
+require File.expand_path '../james/framework', __FILE__
 require File.expand_path '../james/controller', __FILE__
 
 module James
 
+  # Use the given dialogs.
+  #
+  # If called twice or more, will just add more dialogs.
+  #
+  def self.use *dialogs
+    dialogs.each { |dialog| controller.add_dialog dialog }
+  end
+
   # Start a new controller and listen.
   #
   # Will not listen again if already listening.
   #
   def self.listen
-    return if @controller && @controller.listening?
+    controller.listen unless controller.listening?
+  end
+
+  # Controller instance.
+  #
+  def self.controller
     @controller ||= Controller.new
-    @controller.listen
   end
 
 end

data/lib/james/builtin/{core_dialogue.rb → core_dialog.rb}

@@ -1,20 +1,20 @@
-# This is the core dialogue every dialogue will be hooking into.
+# This is the core dialog every dialog will be hooking into.
 #
 # Eventually, the design should be such that everyone can use
-# the design and core dialogue they like best.
+# the design and core dialog they like best.
 #
 # But to get going, this suffices for now.
 #
-class CoreDialogue
+class CoreDialog
 
-  include James::Dialogue
+  include James::Dialog
 
   # The alert state.
   # When James is in this state, he should be
-  # open for user dialogues.
+  # open for user dialogs.
   #
   state :awake do
-    # If James is awake, he offers more dialogues
+    # If James is awake, he offers more dialogs
     # on this state, if there are any hooked into this state.
     #
     chainable
@@ -26,7 +26,7 @@ class CoreDialogue
   end
 
   # The away state. James does not listen to any
-  # user dialogue hooks, but only for his name
+  # user dialog hooks, but only for his name
   # or the good night, i.e. exit phrase.
   #
   state :away do

data/lib/james/controller.rb

@@ -1,18 +1,18 @@
-framework 'AppKit'
-
 module James
 
   class Controller
 
     attr_reader :visitor
 
-    # This puts together the core dialogue and the user
+    # This puts together the core dialog and the user
     # ones that are hooked into it.
     #
+    # TODO Rewrite this. Design needs some refactoring.
+    #
     def initialize
-      user_visitor   = initialize_dialogues.visitor
-      system_visitor = Visitor.new CoreDialogue.new.state_for(:awake)
-      @visitor       = Visitors.new system_visitor, user_visitor
+      @user_dialogs  = Dialogs.new
+      system_visitor = Visitor.new CoreDialog.new.state_for(:awake)
+      @visitor       = Visitors.new system_visitor, @user_dialogs.visitor
     end
 
     def applicationDidFinishLaunching notification
@@ -30,14 +30,12 @@ module James
       # TODO
     end
 
-    # Initialize and "parse" the
-    # dialogues.
+    # Add a dialog to the current system.
     #
-    def initialize_dialogues
-      dialogues = Dialogues.new
-      dialogues.resolve
-      dialogues
+    def add_dialog dialog
+      @user_dialogs << dialog
     end
+
     # Start recognizing words.
     #
     def start_input
@@ -50,18 +48,18 @@ module James
       @output = Outputs::Audio.new
     end
 
-    # Callback method from dialogue.
+    # Callback method from dialog.
     #
     def say text
       @output.say text
     end
     def hear text
-      @visitor.hear text do |response|
+      visitor.hear text do |response|
         say response
       end
     end
     def expects
-      @visitor.expects
+      visitor.expects
     end
 
     def listen
@@ -87,12 +85,14 @@ module James
       # window.display
       # window.orderFrontRegardless
 
+      @listening = true
+
       app.run
     end
-    # Simply put, if there is a controller, it is listening.
+    # If listen has been called, it is listening.
     #
     def listening?
-      true
+      !!@listening
     end
 
   end

data/lib/james/dialog_api.rb

@@ -0,0 +1,34 @@
+module James
+
+  # A dialog can be instantiated in two ways:
+  #
+  # The simple way, will directly add itself to James.
+  #
+  # James.use_dialog(optional_args_for_initialize) do
+  #   # Your dialog.
+  #   #
+  # end
+  #
+  # class MyDialog
+  #   include James::Dialog
+  #
+  #   # Your dialog.
+  #   #
+  # end
+  #
+  # James.use MyDialog.new
+  #
+  module Dialog; end
+
+  class << self
+
+    def use_dialog *args, &block
+      dialog = Class.new { include James::Dialog }
+      dialog.class_eval &block
+      use dialog.new(*args)
+      dialog
+    end
+
+  end
+
+end

data/lib/james/{dialogue_internals.rb → dialog_internals.rb}

@@ -1,13 +1,12 @@
 module James
 
-  # A dialogue is just a container object
+  # A dialog is just a container object
   # for defining states and executing methods.
   #
-  module Dialogue
+  module Dialog
 
     def self.included into
       into.extend ClassMethods
-      Dialogues << into unless into == CoreDialogue # TODO Dirty as hell.
     end
 
     #

data/lib/james/dialogs.rb

@@ -0,0 +1,43 @@
+module James
+
+  # Registers dialogs and connects their states.
+  #
+  class Dialogs
+
+    attr_reader :initial
+
+    def initialize
+      @initial = State.new :__initial_plugin_state__, nil
+    end
+
+    # Generate the graph for the dialogs.
+    #
+    # Hooks up the entry phrases of the dialog
+    # into the main dialog.
+    #
+    # It raises if the hook phrase of a dialog
+    # is already used.
+    #
+    def << dialog
+      resolved_entries = {}
+
+      dialog.entries.each do |(phrases, state)|
+        resolved_entries[phrases] = state.respond_to?(:phrases) ? state : dialog.state_for(state)
+      end
+
+      # Hook the dialog into the initial state.
+      #
+      initial.hear resolved_entries
+    end
+
+    # Get the visitor.
+    #
+    # Initialized on the initial state.
+    #
+    def visitor
+      @visitor ||= Visitor.new initial
+    end
+
+  end
+
+end

data/lib/james/framework.rb

@@ -0,0 +1 @@
+framework 'AppKit'

data/lib/james/inputs/base.rb

@@ -13,7 +13,7 @@ module James
       # Call this method if you heard something in the subclass.
       #
       def heard command
-        # Call dialogue.
+        # Call dialog.
         #
         controller.hear command
       end

data/lib/james/state_api.rb

@@ -1,6 +1,6 @@
 module James
 
-  # A state is defined in a dialogue.
+  # A state is defined in a dialog.
   #
   # It has a name with which it can be targeted.
   #
@@ -58,16 +58,10 @@ module James
       @exit_block = block
     end
 
-    #
-    #
-    def transition &block
-      
-    end
-
     # By default, a state is not chainable.
     #
     def chainable?
-      @chainable
+      !!@chainable
     end
     def chainable
       @chainable = true

data/lib/james/visitor.rb

@@ -72,7 +72,7 @@ module James
     def expects
       current.phrases
     end
-    # Does the current state allow penetration into another dialogue?
+    # Does the current state allow penetration into another dialog?
     #
     def chainable?
       current.chainable?

data/lib/james/visitors.rb

@@ -1,7 +1,7 @@
 module James
 
   # The visitors class has a number of visitors, whose
-  # dialogues are visited in order of preference.
+  # dialogs are visited in order of preference.
   #
   # Why?
   # Discussions have multiple points where they can be.
@@ -22,6 +22,10 @@ module James
       @visitors = visitors
     end
 
+    def add_dialog dialog
+
+    end
+
     # Hear tries all visitors in order
     # until one hears a phrase he knows.
     #
@@ -39,13 +43,13 @@ module James
       end
     end
 
-    # Enter enters the first dialogue.
+    # Enter enters the first dialog.
     #
     def enter
       visitors.first.enter
     end
 
-    # Simply returns the sum of what phrases all dialogues expect.
+    # Simply returns the sum of what phrases all dialogs expect.
     #
     # Stops as soon as a visitor is not in a chainable state anymore.
     #

data/spec/aux/james/cli_spec.rb

@@ -5,14 +5,14 @@ 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']
+    Dir.stub! :[] => ['test_dialog.rb', 'test_dialog.rb', 'test/test_dialog.rb']
   end
   
   let(:cli) { James::CLI.new }
   
-  describe 'find_dialogues' do
+  describe 'find_dialogs' do
     it 'returns the right ones' do
-      cli.find_dialogues.should == ['test_dialogue.rb', 'test_dialog.rb', 'test/test_dialogue.rb']
+      cli.find_dialogs.should == ['test_dialog.rb', 'test_dialog.rb', 'test/test_dialog.rb']
     end
   end
   

data/spec/integration/test_dialogue_spec.rb

@@ -2,10 +2,10 @@
 #
 require File.expand_path '../../../lib/james', __FILE__
 
-describe 'TestDialogue' do
+describe 'TestDialog' do
 
   context 'unit' do
-    let(:dialogue) do
+    let(:dialog) do
 
       Class.new do
         include James::Dialog
@@ -23,7 +23,7 @@ describe 'TestDialogue' do
 
     end
     let(:visitor) do
-      James::Visitor.new dialogue.state_for(:first)
+      James::Visitor.new dialog.state_for(:first)
     end
 
     describe "integration" do
@@ -40,8 +40,8 @@ describe 'TestDialogue' do
   end
   
   # context 'integration' do
-  #   let(:dialogue) do
-  #     dialogue = Class.new do
+  #   let(:dialog) do
+  #     dialog = Class.new do
   #       include James::Dialog
   # 
   #       hear ['test1', 'test2'] => :first
@@ -54,13 +54,13 @@ describe 'TestDialogue' do
   #     end.new
   #   end
   #   it 'works correctly' do
-  #     dialogue.state.name.should == :awake
-  #     dialogue.hear 'sleep'
-  #     dialogue.state.name.should == :sleeping
+  #     dialog.state.name.should == :awake
+  #     dialog.hear 'sleep'
+  #     dialog.state.name.should == :sleeping
   #   end
   #   it 'delegates correctly' do
-  #     dialogue.state.name.should == :awake
-  #     dialogue.hear 'test1'
+  #     dialog.state.name.should == :awake
+  #     dialog.hear 'test1'
   #   end
   # end
 

data/spec/lib/james/controller_spec.rb

@@ -1,15 +1,32 @@
 # 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/controller', __FILE__
 
 describe James::Controller do
   
-  # let(:controller) { described_class.new }
-  # 
-  # describe 'listening?' do
-  #   it 'is correct' do
-  #     controller.listening?.should == true
-  #   end
-  # end
+  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/{dialogue_spec.rb → dialog_spec.rb}

@@ -1,20 +1,21 @@
 # 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/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__
+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::Dialogue do
+describe James::Dialog do
   
   it 'can haz merkin spellink' do
-    James::Dialogue.should == James::Dialog
+    James::Dialog.should == James::Dialog
   end
   
   context 'units' do
-    let(:dialogue) do
-      James.dialogue do
+    let(:dialog) do
+      James.use_dialog do
         
         hear 'something' => :first
         
@@ -34,21 +35,21 @@ describe James::Dialogue do
     end
     describe 'state_for' do
       it 'delegates to the class, adding itself' do
-        new_dialogue = dialogue.new
-        dialogue.should_receive(:state_for).once.with :some_name, new_dialogue
+        new_dialog = dialog.new
+        dialog.should_receive(:state_for).once.with :some_name, new_dialog
         
-        new_dialogue.state_for :some_name
+        new_dialog.state_for :some_name
       end
       it 'returns nil on not found' do
-        dialogue.new.state_for(:nonexistent).should == nil
+        dialog.new.state_for(:nonexistent).should == nil
       end
     end
   end
   
   describe 'hear with lambda' do
-    let(:dialogue) do
+    let(:dialog) do
       class Test
-        include James::Dialogue
+        include James::Dialog
         
         def initialize
           @bla = 'some bla'
@@ -61,7 +62,7 @@ describe James::Dialogue do
       Test.new
     end
     it "is instance eval'd" do
-      test_state = dialogue.state_for :test
+      test_state = dialog.state_for :test
       test_state.hear 'bla' do |result|
         result.should == 'some bla'
       end
@@ -72,7 +73,7 @@ describe James::Dialogue do
     it 'can be included' do
       expect do
         class Test
-          include James::Dialogue
+          include James::Dialog
           
           hear 'something' => :some_state
         end
@@ -81,7 +82,7 @@ describe James::Dialogue do
     
     it 'can be defined' do
       expect do
-        James.dialogue do
+        James.dialog do
           
           hear 'something' => :some_state
           

metadata

@@ -2,14 +2,14 @@
 name: james
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.12
+  version: 0.1.0
 platform: universal-darwin-10
 authors:
 - Florian Hanke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-17 00:00:00 +10:00
+date: 2011-05-21 00:00:00 +10:00
 default_executable: james
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -28,19 +28,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: "0"
-description: Modular Electronic Butler. Using a simple dialogue system where you can
-  easily add more dialogues.
+description: Modular Electronic Butler. Using a simple dialog system where you can
+  easily add more dialogs.
 email: florian.hanke+james@gmail.com
 executables:
 - james
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/james/builtin/core_dialogue.rb
+- lib/james/builtin/core_dialog.rb
 - lib/james/controller.rb
-- lib/james/dialogue_api.rb
-- lib/james/dialogue_internals.rb
-- lib/james/dialogues.rb
+- lib/james/dialog_api.rb
+- lib/james/dialog_internals.rb
+- lib/james/dialogs.rb
+- lib/james/framework.rb
 - lib/james/inputs/audio.rb
 - lib/james/inputs/base.rb
 - lib/james/inputs/terminal.rb
@@ -56,7 +57,7 @@ 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
+- spec/lib/james/dialog_spec.rb
 - spec/lib/james/state_spec.rb
 - spec/lib/james/visitor_spec.rb
 - spec/lib/james/visitors_spec.rb
@@ -85,12 +86,12 @@ rubyforge_project:
 rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: 'James: Modular Electronic Butler with modular Dialogues.'
+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/dialogue_spec.rb
+- spec/lib/james/dialog_spec.rb
 - spec/lib/james/state_spec.rb
 - spec/lib/james/visitor_spec.rb
 - spec/lib/james/visitors_spec.rb

data/lib/james/dialogue_api.rb

@@ -1,34 +0,0 @@
-module James
-
-  # A dialog(ue) can be instantiated in two ways:
-  #
-  # James.dialogue do
-  #   # Your dialogue.
-  #   #
-  # end
-  #
-  # class MyDialogue
-  #   include James::Dialogue
-  #
-  #   # Your dialogue.
-  #   #
-  # end
-  #
-  module Dialogue; end
-
-  # We don't care about the spelling.
-  #
-  Dialog = Dialogue
-
-  class << self
-
-    def dialogue &block
-      dialogue = Class.new { include James::Dialogue }
-      dialogue.class_eval &block
-      dialogue
-    end
-    alias dialog dialogue
-
-  end
-
-end

data/lib/james/dialogues.rb

@@ -1,58 +0,0 @@
-module James
-
-  # Registers all dialogues and connects their states.
-  #
-  class Dialogues
-
-    attr_reader :initial, :dialogues
-
-    def initialize
-      @initial   = State.new :__initial_plugin_state__, nil
-      @dialogues = self.class.dialogues.map &:new
-    end
-
-    class << self
-
-      attr_reader :dialogues
-
-      def << dialogue
-        @dialogues ||= []
-        @dialogues << dialogue
-      end
-
-    end
-
-    # Generate the graph for the dialogues.
-    #
-    # Hooks up the entry phrases of all dialogues
-    # into the main dialogue.
-    #
-    # It raises if the hook phrase of a dialogue
-    # is already used.
-    #
-    def resolve
-      # Hook dialogues into initial state.
-      #
-      resolved_entries = {}
-      dialogues.each do |dialogue|
-        dialogue.entries.each do |(phrases, state)|
-          resolved_entries[phrases] = state.respond_to?(:phrases) ? state : dialogue.state_for(state)
-        end
-      end
-
-      # Hook all user dialogues into the initial state.
-      #
-      initial.hear resolved_entries
-    end
-
-    # Get the visitor.
-    #
-    # Initialized on the initial state.
-    #
-    def visitor
-      @visitor ||= Visitor.new initial
-    end
-
-  end
-
-end