ellen 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2de2c293649270b33753969b8e1b504eb63ca821
-  data.tar.gz: 2f0cbbadad308168ca053235d503c86dfca3a7f7
+  metadata.gz: 96e3c30b37c53dec2a1f1b781a9bbb8d21dbcb4b
+  data.tar.gz: ae06dedaad859870eb47f91bc121ce94bbf5e040
 SHA512:
-  metadata.gz: 652d8b2f4d97172ef2d72c2877528eeca0f0e4a8cd0b10c7a18aa8f7b3cdbe769fa58033f3f4f748a6e44335173d8d6d639e629836954ccfed5868dd3425d0d4
-  data.tar.gz: 1b04c2c135b32f78fa9a7765718477345d5fd0b6d4b72fefb454253597b0e64c635f0a2e42bca14ead4a9128f189f7905accd6916b29897a6a29132d923c9b74
+  metadata.gz: d6daf3ce130b28062a9f998b5a930f1699210f913d0786f93116dcd8594d48462a7cfd0ea754647232de3b0dda202439c19037229e0b45bffa35b8c9667511fe
+  data.tar.gz: cba65d6007a7d5fb66d970ce99914ecf93a9ebaea6254c8414a6e511ec2605dbdee15ea49c71083b0dcaa37e3e32909a7ecbbdbe445622de9a96de7a286f4adf

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.1
+* Improve Brain interface
+
 ## 0.1.0
 * Deprecate --adapter option
 

data/lib/ellen.rb

@@ -1,3 +1,4 @@
+require "active_support/concern"
 require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/string/inflections"
 require "bundler"
@@ -18,20 +19,22 @@ module Ellen
       exit(1)
     end
 
-    def adapters
-      {}
-    end
-    memoize :adapters
-
     def handlers
       []
     end
     memoize :handlers
+
+    def actions
+      handlers.map(&:actions).flatten.sort_by(&:all?)
+    end
   end
 end
 
 require "ellen/action"
 require "ellen/adapter_builder"
+require "ellen/env"
+require "ellen/env/missing_required_key_error"
+require "ellen/env/validatable"
 require "ellen/adapters/base"
 require "ellen/adapters/shell"
 require "ellen/brains/base"
@@ -40,7 +43,6 @@ require "ellen/command_builder"
 require "ellen/commands/base"
 require "ellen/commands/generate"
 require "ellen/commands/run"
-require "ellen/env"
 require "ellen/handlers/base"
 require "ellen/handlers/help"
 require "ellen/handlers/ping"

data/lib/ellen/adapters/base.rb

@@ -12,39 +12,24 @@
 module Ellen
   module Adapters
     class Base
+      include Env::Validatable
+
       class << self
         def inherited(child_class)
           Ellen::AdapterBuilder.adapter_classes << child_class
         end
-
-        def env(key, description, options = {})
-          envs << Env.new(key, description, options)
-        end
-
-        def envs
-          @envs ||= []
-        end
-
-        def usage
-          envs.map(&:to_usage).join("\n")
-        end
       end
 
       attr_reader :robot
 
       def initialize(robot)
         @robot = robot
+        validate
       end
 
       def say(body, options = {})
         Ellen.logger.info("Not implemented #{self.class}##{__method__} was called")
       end
-
-      def validate
-        self.class.envs.each(&:validate)
-      rescue Env::MissingRequiredKeyError => exception
-        Ellen.die("#{exception}\n#{self.class.usage}")
-      end
     end
   end
 end

data/lib/ellen/adapters/shell.rb

@@ -3,51 +3,54 @@ require "readline"
 module Ellen
   module Adapters
     class Shell < Base
+      PROMPT = "> "
+
+      SOURCE = "shell"
+
+      USAGE = "Type `exit` or `quit` to end the session."
+
+      attr_accessor :stopped
+
       def run
         explain
         listen
       end
 
       def say(body, options = {})
-        puts body
+        Ellen.logger.info(body)
       end
 
       private
 
       def explain
-        puts "Type `exit` or `quit` to end the session."
-      end
-
-      def prompt
-        @prompt ||= "> "
-      end
-
-      def prompt=(str)
-        @prompt = str
+        Ellen.logger.info(USAGE)
       end
 
       def read
-        Readline.readline(prompt, true)
+        Readline.readline(PROMPT, true)
       end
 
       def listen
-        loop { step }
+        step until stopped?
       rescue Interrupt
-        exit
+        stop
       end
 
       def step
-        prompt
         case body = read
         when "exit", "quit"
-          exit
+          stop
         else
-          robot.receive(body: body, source: source, command: true)
+          robot.receive(body: body, source: SOURCE)
         end
       end
 
-      def source
-        "shell user"
+      def stopped?
+        !!stopped
+      end
+
+      def stop
+        self.stopped = true
       end
     end
   end

data/lib/ellen/brains/base.rb

@@ -1,6 +1,8 @@
 module Ellen
   module Brains
     class Base
+      include Env::Validatable
+
       class << self
         def inherited(child)
           brain_classes << child
@@ -17,8 +19,8 @@ module Ellen
         end
       end
 
-      def data
-        @data ||= {}
+      def initialize
+        validate
       end
     end
   end

data/lib/ellen/brains/null.rb

@@ -1,7 +1,8 @@
 module Ellen
   module Brains
     class Null < Base
-      def save
+      def data
+        @data ||= {}
       end
     end
   end

data/lib/ellen/env.rb

@@ -29,8 +29,5 @@ module Ellen
     def error
       raise MissingRequiredKeyError, %<ENV["#{key}"] is required but missing>
     end
-
-    class MissingRequiredKeyError < StandardError
-    end
   end
 end

data/lib/ellen/env/missing_required_key_error.rb

@@ -0,0 +1,6 @@
+module Ellen
+  class Env
+    class MissingRequiredKeyError < StandardError
+    end
+  end
+end

data/lib/ellen/env/validatable.rb

@@ -0,0 +1,27 @@
+module Ellen
+  class Env
+    module Validatable
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def envs
+          @envs ||= []
+        end
+
+        def env(key, description, options = {})
+          envs << Env.new(key, description, options)
+        end
+
+        def usage
+          envs.map(&:to_usage).join("\n")
+        end
+      end
+
+      def validate
+        self.class.envs.each(&:validate)
+      rescue MissingRequiredKeyError => exception
+        Ellen.die("#{exception}\n#{self.class.usage}")
+      end
+    end
+  end
+end

data/lib/ellen/handlers/help.rb

@@ -4,12 +4,9 @@ module Ellen
       on /help\z/i, name: "help", description: "Show this help message"
 
       def help(message)
-        lines = Ellen.handlers.map(&:actions).flatten.sort_by(&:all?).map do |action|
-          prefix = "@#{robot.name} " unless action.all?
-          line = "%-30s - #{action.description}" % "#{prefix}#{action.pattern.inspect}"
-          line
-        end
-        robot.say lines.join("\n")
+        robot.say Ellen.actions.map {|action|
+          "%-30s - #{action.description}" % "#{robot.name unless action.all?} #{action.pattern.inspect}"
+        }.join("\n")
       end
     end
   end

data/lib/ellen/robot.rb

@@ -8,7 +8,7 @@ module Ellen
 
     attr_reader :options
 
-    def initialize(options)
+    def initialize(options = {})
       @options = options
     end
 
@@ -16,7 +16,7 @@ module Ellen
       dotenv
       bundle
       setup
-      validate
+      remember
       adapt
     end
 
@@ -64,8 +64,8 @@ module Ellen
     end
     memoize :handlers
 
-    def validate
-      adapter.validate
+    def remember
+      brain
     end
   end
 end

data/lib/ellen/version.rb

@@ -1,3 +1,3 @@
 module Ellen
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/ellen/adapter_builder_spec.rb

@@ -6,11 +6,7 @@ describe Ellen::AdapterBuilder do
   end
 
   let(:robot) do
-    Ellen::Robot.new(options)
-  end
-
-  let(:options) do
-    {}
+    Ellen::Robot.new
   end
 
   describe "#build" do

data/spec/ellen/adapters/shell_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe Ellen::Adapters::Shell do
+  before do
+    Ellen.logger.stub(:info)
+  end
+
+  let(:adapter) do
+    described_class.new(robot)
+  end
+
+  let(:robot) do
+    Ellen::Robot.new
+  end
+
+  describe "#run" do
+    context "with `exit`" do
+      it "stops" do
+        Readline.stub(readline: "exit")
+        adapter.should_receive(:stop).and_call_original
+        adapter.run
+      end
+    end
+
+    context "with `quit`" do
+      it "stops" do
+        Readline.stub(readline: "exit")
+        adapter.should_receive(:stop).and_call_original
+        adapter.run
+      end
+    end
+
+    context "with Inturrupt from console" do
+      it "stops" do
+        Readline.stub(:readline).and_raise(Interrupt)
+        adapter.should_receive(:stop).and_call_original
+        adapter.run
+      end
+    end
+
+    context "without `exit` nor `quit`" do
+      it "passes given message to robot" do
+        Readline.stub(:readline).and_return("a", "exit")
+        robot.should_receive(:receive).with(body: "a", source: described_class::SOURCE)
+        adapter.run
+      end
+    end
+  end
+
+  describe "#say" do
+    it "shows given message body on stdout" do
+      Ellen.logger.should_receive(:info).with("a")
+      adapter.say("a")
+    end
+  end
+end

data/spec/ellen/handlers/help_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe Ellen::Handlers::Help do
+  let(:robot) do
+    Ellen::Robot.new
+  end
+
+  describe "#help" do
+    it "responds to `@ellen help` and says each handler's usage" do
+      robot.should_receive(:say).with(%r<ellen /help\\z/i +- Show this help message>)
+      robot.receive(body: "@ellen help")
+    end
+  end
+end

data/spec/ellen/handlers/ping_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Ellen::Handlers::Ping do
+  let(:robot) do
+    Ellen::Robot.new
+  end
+
+  describe "#ping" do
+    {
+      "@ellen ping" => "pong",
+      "@ellen Ping" => "Pong",
+      "@ellen PING" => "PONG",
+    }.each do |input, output|
+      it "responds to `#{input}` and says `#{output}`" do
+        robot.should_receive(:say).with(output)
+        robot.receive(body: input)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ellen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-21 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -180,6 +180,8 @@ files:
 - lib/ellen/commands/generate.rb
 - lib/ellen/commands/run.rb
 - lib/ellen/env.rb
+- lib/ellen/env/missing_required_key_error.rb
+- lib/ellen/env/validatable.rb
 - lib/ellen/handlers/base.rb
 - lib/ellen/handlers/help.rb
 - lib/ellen/handlers/ping.rb
@@ -188,8 +190,11 @@ files:
 - lib/ellen/robot.rb
 - lib/ellen/version.rb
 - spec/ellen/adapter_builder_spec.rb
+- spec/ellen/adapters/shell_spec.rb
 - spec/ellen/commands/generate_spec.rb
 - spec/ellen/commands/run_spec.rb
+- spec/ellen/handlers/help_spec.rb
+- spec/ellen/handlers/ping_spec.rb
 - spec/ellen/robot_spec.rb
 - spec/spec_helper.rb
 - templates/Gemfile
@@ -219,7 +224,11 @@ specification_version: 4
 summary: A chatterbot framework, inspired by Hubot
 test_files:
 - spec/ellen/adapter_builder_spec.rb
+- spec/ellen/adapters/shell_spec.rb
 - spec/ellen/commands/generate_spec.rb
 - spec/ellen/commands/run_spec.rb
+- spec/ellen/handlers/help_spec.rb
+- spec/ellen/handlers/ping_spec.rb
 - spec/ellen/robot_spec.rb
 - spec/spec_helper.rb
+has_rdoc: