ellen 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68effc45fa07d901ab5c73e05ef6612af60896e7
-  data.tar.gz: c7118f7d04d83ba6d88d23e778b231754c29e186
+  metadata.gz: 2de2c293649270b33753969b8e1b504eb63ca821
+  data.tar.gz: 2f0cbbadad308168ca053235d503c86dfca3a7f7
 SHA512:
-  metadata.gz: e678204e7c3106be6fc37334b281c54fe8f3e10ff4c71eba06cfd8d607d73884866f50a0925d023ce324d693faab5de7a496022b329326c7959b436bf59263fc
-  data.tar.gz: 469c183efdae2967d3ee15aff961fa85a15d9bf602fedfae6b8c4e953e0587f6327369894fe186c96298315e0c31561e73cba484425431da778cf28cfd779efc
+  metadata.gz: 652d8b2f4d97172ef2d72c2877528eeca0f0e4a8cd0b10c7a18aa8f7b3cdbe769fa58033f3f4f748a6e44335173d8d6d639e629836954ccfed5868dd3425d0d4
+  data.tar.gz: 1b04c2c135b32f78fa9a7765718477345d5fd0b6d4b72fefb454253597b0e64c635f0a2e42bca14ead4a9128f189f7905accd6916b29897a6a29132d923c9b74

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.0
+* Deprecate --adapter option
+
 ## 0.0.9
 * Adapt mention name to `@<name>: <text>` format
 

data/README.md

@@ -11,6 +11,7 @@ You can create your own favorite adapter from
 class with #run method. Please see the following real examples for more details.
 
 * [Ellen::Adapters::Shell](https://github.com/r7kamura/ellen/blob/master/lib/ellen/adapters/shell.rb)
+* [Ellen::Adapters::Slack](https://github.com/r7kamura/ellen-slack)
 * [Ellen::Adapters::Hipchat](https://github.com/r7kamura/ellen-hipchat)
 * [Ellen::Adapters::Twitter](https://github.com/r7kamura/ellen-twitter)
 
@@ -29,9 +30,9 @@ Ellen will load them before running.
 
 ```ruby
 # Gemfile
-gem "ellen-foo"
-gem "ellen-bar"
-gem "ellen-baz"
+gem "ellen-cron"
+gem "ellen-google_image"
+gem "ellen-slack"
 ```
 
 ## Config
@@ -47,15 +48,15 @@ $ gem install ellen
 $ ellen --generate
 $ cd ellen
 $ echo 'gem "ellen-my_adapter"' >> Gemfile
-$ echo 'bot: bundle exec ellen --adapter my_adapter' >> Procfile
+$ echo 'bot: bundle exec ellen' >> Procfile
 $ bundle install
 $ git init
 $ git add .
 $ git commit -m "Initial commit"
 $ heroku create
-$ heroku scale bot=1
 $ heroku config:set FOO=1 BAR=2 BAZ=3
 $ git push heroku master
+$ heroku scale bot=1
 ```
 
 ## Screenshot

data/lib/ellen/adapter_builder.rb

@@ -1,32 +1,23 @@
 module Ellen
   class AdapterBuilder
-    attr_reader :robot, :options
+    def self.adapter_classes
+      @adapter_classes ||= []
+    end
+
+    attr_reader :robot
 
-    def initialize(robot, options)
+    def initialize(robot)
       @robot = robot
-      @options = options
     end
 
     def build
-      adapter_class.new(robot, options)
+      adapter_class.new(robot)
     end
 
     private
 
     def adapter_class
-      Ellen.adapters[name] or die
-    end
-
-    def name
-      options[:adapter] || default_name
-    end
-
-    def default_name
-      "shell"
-    end
-
-    def die
-      Ellen.die("No adapter is defined for `#{name}`")
+      self.class.adapter_classes.last
     end
   end
 end

data/lib/ellen/adapters/base.rb

@@ -13,8 +13,8 @@ module Ellen
   module Adapters
     class Base
       class << self
-        def inherited(child)
-          Ellen.adapters[child.name.split("::").last.underscore] = child
+        def inherited(child_class)
+          Ellen::AdapterBuilder.adapter_classes << child_class
         end
 
         def env(key, description, options = {})
@@ -30,11 +30,10 @@ module Ellen
         end
       end
 
-      attr_reader :robot, :options
+      attr_reader :robot
 
-      def initialize(robot, options)
+      def initialize(robot)
         @robot = robot
-        @options = options
       end
 
       def say(body, options = {})

data/lib/ellen/command_builder.rb

@@ -20,7 +20,6 @@ module Ellen
 
     def options
       Slop.parse!(arguments, help: true) do
-        on("a", "adapter=", "Take adapter name.")
         on("dotenv", "Load .env before running.")
         on("g", "generate", "Generate a new chatterbot with ./ellen/ directory if specified.")
         on("l", "load=", "Load a ruby file before running.")

data/lib/ellen/robot.rb

@@ -43,7 +43,7 @@ module Ellen
     end
 
     def adapter
-      AdapterBuilder.new(self, options).build
+      AdapterBuilder.new(self).build
     end
     memoize :adapter
 

data/lib/ellen/version.rb

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

data/spec/ellen/adapter_builder_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Ellen::AdapterBuilder do
+  let(:builder) do
+    described_class.new(robot)
+  end
+
+  let(:robot) do
+    Ellen::Robot.new(options)
+  end
+
+  let(:options) do
+    {}
+  end
+
+  describe "#build" do
+    context "with no other adapter class definition" do
+      it "returns a Ellen::Adapters::Shell as a default adapter" do
+        builder.build.should be_a Ellen::Adapters::Shell
+      end
+    end
+
+    context "with another adapter class definition" do
+      after do
+        Ellen::AdapterBuilder.adapter_classes.pop
+      end
+
+      let!(:another_adapter_class) do
+        Class.new(Ellen::Adapters::Base) do
+          def run
+          end
+        end
+      end
+
+      it "returns an instance of that adapter class" do
+        builder.build.should be_a another_adapter_class
+      end
+    end
+  end
+end

data/spec/ellen/commands/run_spec.rb

@@ -11,40 +11,12 @@ describe Ellen::Commands::Run do
     end
 
     let(:arguments) do
-      ["--adapter", adapter_name]
+      []
     end
 
-    let(:adapter_name) do
-      "shell"
-    end
-
-    context "with no adapter name" do
-      before do
-        arguments.clear
-      end
-
-      it "defaults to shell adapter" do
-        Ellen::Adapters::Shell.any_instance.should_receive(:run)
-        call
-      end
-    end
-
-    context "with registered name" do
-      it "runs the adapter" do
-        Ellen::Adapters::Shell.any_instance.should_receive(:run)
-        call
-      end
-    end
-
-    context "with unregistered adapter name" do
-      let(:adapter_name) do
-        "unregistered"
-      end
-
-      it "exits with dying message" do
-        Ellen.logger.should_receive(:error).with("Error: No adapter is defined for `unregistered`")
-        expect { call }.to raise_error(SystemExit)
-      end
+    it "creates an adapter and calls .run to it" do
+      Ellen::Adapters::Shell.any_instance.should_receive(:run)
+      call
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ellen
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -187,6 +187,7 @@ files:
 - lib/ellen/message.rb
 - lib/ellen/robot.rb
 - lib/ellen/version.rb
+- spec/ellen/adapter_builder_spec.rb
 - spec/ellen/commands/generate_spec.rb
 - spec/ellen/commands/run_spec.rb
 - spec/ellen/robot_spec.rb
@@ -217,6 +218,7 @@ signing_key:
 specification_version: 4
 summary: A chatterbot framework, inspired by Hubot
 test_files:
+- spec/ellen/adapter_builder_spec.rb
 - spec/ellen/commands/generate_spec.rb
 - spec/ellen/commands/run_spec.rb
 - spec/ellen/robot_spec.rb