boty 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1b80fa6a35d917745e219d705ad008950daef3b
-  data.tar.gz: 03fbea6b6493b940a63bcb963ad26c83cc62f756
+  metadata.gz: a7102960a8cdaa6f3a18a7015c1338f2c62a28b7
+  data.tar.gz: dfd326ea4c467506825ac473f47636682e366bab
 SHA512:
-  metadata.gz: 5ffbaa33ad222082cda2865606090e2e4a67051cafdd342a1a0851333594e3fe1514ee516b4b536a96105b54106e86da749ab449c87f1e369cf3009fea6852b4
-  data.tar.gz: af874f7e181697c3fe8e75b0a3f09f963a37c607a4f066655271e3435f6de4fcce479bde4f0f6ae0f15fc540482eb11030ad2fafc183181bc05f4df3e572d262
+  metadata.gz: bab25a32347e1c4e6cb9cc3b8f995fc4d971f094072ef6c5e54018e0d50b5fe37d8c86c9be5e4291a8e4c823cad802ffc2d8f86603a36141eed1ac4adfa7b0da
+  data.tar.gz: fb8d9bfa67bcbf7f624b69dc4f7866e7280ccb3be1a655c7117a124f26147ab7002bec1ec1f6736154ac0a57d33173a0f1a4a50e81d707ac703655586328c007

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/BlockDelimiters:
+  EnforcedStyle: semantic

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boty (0.1.0)
+    boty (0.1.1)
       eventmachine
       faraday
       faye-websocket
@@ -11,6 +11,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
     byebug (8.2.0)
     diff-lcs (1.2.5)
     dotenv (2.0.2)
@@ -23,6 +26,10 @@ GEM
       websocket-driver (>= 0.5.1)
     i18n (0.7.0)
     multipart-post (2.0.0)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
     rake (10.4.2)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
@@ -37,7 +44,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.0)
+    rubocop (0.35.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.3.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      tins (<= 1.6.0)
+    ruby-progressbar (1.7.5)
     thor (0.19.1)
+    tins (1.6.0)
     websocket-driver (0.6.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)
@@ -53,6 +69,7 @@ DEPENDENCIES
   fakefs
   rake (~> 10.0)
   rspec
+  rubocop
 
 BUNDLED WITH
    1.10.6

data/README.md

@@ -642,7 +642,7 @@ implementation is fairly simple. Let's use it as an example of how to write your
 own adapter.
 
 You can extend the ruby _Logger_ class and worry yourself on write the `#add`
-overrite:
+override:
 
 ```ruby
 class Multi < ::Logger
@@ -667,7 +667,7 @@ adapters passed as parameters for the constructor.
 For more information on the `#add` parameters, [check the ruby doc](http://ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html#method-i-add).
 
 _Multi_ also allows you to change the level for all the underlying adapters at
-once, the `#level=` overrite implementation is like this:
+once, the `#level=` overriten implementation is like this:
 
 ```ruby
 def level=(level)
@@ -679,7 +679,34 @@ end
 
 ### I18n
 
- **todo: document**
+The descriptions for the commands and listeners that ship with `Boty` can be
+customized via the [I18n gem mechanics](https://github.com/svenfuchs/i18n).
+`Boty` ships with translations for `:en` and `:pt-br`. If you want to override
+those messages, you can take a look at the files on [`locale`](https://github.com/ricardovaleriano/boty/tree/master/locale).
+
+I'll recomend that you just copy and paste the file that you want to customize
+on the `locale` dir of your project, and them make the editions that you want.
+
+Of course, you can add translations for any language that you want on your
+`locale` dir. And even add any translation that you want for your own
+command descriptions.
+
+To instruct your bot about which language to use, set the `Boty.locale`
+configuration and you're done.
+
+The `bot` executable created on your project generated by `boty new` have the
+following line before the session start:
+
+```ruby
+Boty.locale = ARGV.pop || :en
+```
+
+This means that you can start your bot with a command line argument to tell
+which is the idiom that this session should use. This allows you to have the
+same bot running in different sessions with different idioms. The following
+usage is totally fine:
+
+    ./bot pt-br
 
 ## Development
 
@@ -691,8 +718,17 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ### The local ./bin/bot
 
+The project have a `./bin/bot` executable that should be the product of
+compiling the `template/project/bot.tt` erb file.
+This is an easy way to just run the bot using the same logic that a project
+generated by `bot new` will use to run the bot.
+It's highly recomendable that you test your changes using this approach before
+submit a `PR` or generate a new release. =)
+
 ### Code guidelines
 
+ **todo: add some**
+
 ## Contributing<a name="contributing" />
 
 Bug reports and pull requests are very welcome on GitHub at

data/Rakefile

@@ -1,5 +1,5 @@
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec

data/boty.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'boty/version'
+require "boty/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "boty"
@@ -9,12 +9,15 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ricardo Valeriano"]
   spec.email         = ["ricardo.valeriano@gmail.com"]
 
-  spec.summary       = %q{Boty is a pretty bot specially tailored for Slack.}
-  spec.description   = %q{Boty is intendted to be a framework for construction of automated Slack Bots for your needs.}
+  spec.summary       = %(Boty is a pretty bot specially tailored for Slack.)
+  spec.description   = %(Boty is intendted to be a framework for construction of
+                         automated Slack Bots for your needs.)
   spec.homepage      = "http://github.com/ricardovaleriano/boty"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f|
+    f.match(%r{^(features)/})
+  }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
@@ -32,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "fakefs"
+  spec.add_development_dependency "rubocop"
 end

data/lib/boty.rb

@@ -13,7 +13,7 @@ require "faye/websocket"
 require "i18n"
 require "faraday"
 
-$:.unshift File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
 module Boty
   def self.locale=(lang)
@@ -29,6 +29,7 @@ require "boty/version"
 require "boty/logger"
 require "boty/slack"
 require "boty/session"
+require "boty/action_description"
 require "boty/action"
 require "boty/script_loader"
 require "boty/dsl"

data/lib/boty/action.rb

@@ -1,53 +1,44 @@
 module Boty
+  # Public: Wrap the idea of something that should happen when some regex is
+  # matched.
+  #
+  #
   class Action
     include Boty::Logger
     attr_reader :regex, :desc, :action
 
-    class Description
-      attr_reader :command, :description
-      attr_writer :regex
-
-      def initialize(command, description: nil, regex: nil)
-        if description.nil?
-          @description = command
-        else
-          @command, @description = command, description
-        end
-
-        @regex = regex
-      end
-
-      def command
-        return @command if @command
-
-        match = /\?(i?)-(mx|mix):(.*)\)/.match @regex.to_s
-        "/#{match[3]}/#{match[1]}"
+    def initialize(bot, regex, description, &action)
+      if description
+        description.regex = regex
+      else
+        description = ActionDescription.new(nil, regex: regex)
       end
-    end
 
-    def initialize(regex, desc, &action)
-      desc = Hash(desc)
-      description = Description.new(desc[:command],
-                                    description: desc[:description],
-                                    regex: regex)
-      @regex, @desc, @action = regex, description, action
+      @dsl    = DSL.new bot
+      @regex  = regex
+      @desc   = description
+      @action = action
     end
 
-    def is_this?(regex, block)
+    def this?(regex, block)
       same_regex = regex == self.regex
-      block ? same_regex && block == self.action : same_regex
+      block ? same_regex && block == action : same_regex
     end
 
-    def execute(bot, message)
-      dsl = DSL.new(bot)
-      if match = message.match!(regex)
-        matches = Array(match)
-        matches.shift
-        dsl.instance_exec(*matches, &action)
-      end
+    def execute(message)
+      action_call message.match!(regex)
     rescue => e
       logger.error e.message
       raise e
     end
+
+    private
+
+    def action_call(match)
+      return unless match
+      matches = Array(match)
+      matches.shift
+      @dsl.instance_exec(*matches, &action)
+    end
   end
 end

data/lib/boty/action_description.rb

@@ -0,0 +1,24 @@
+module Boty
+  class ActionDescription
+    attr_reader :command, :description
+    attr_writer :regex
+
+    def initialize(command, description: nil, regex: nil)
+      if description.nil?
+        @description = command
+      else
+        @command = command
+        @description = description
+      end
+
+      @regex = regex
+    end
+
+    def command
+      return @command if @command
+      return unless @regex
+      match = /\?(i?)-(mx|mix):(.*)\)/.match @regex.to_s
+      @command = "/#{match[3]}/#{match[1]}"
+    end
+  end
+end

data/lib/boty/bot.rb

@@ -8,10 +8,14 @@ module Boty
 
     def initialize(bot_info)
       Locale.reload
-      @raw_info, @id, @name = bot_info, bot_info["id"], bot_info["name"]
+      @raw_info = bot_info
+      @id       = bot_info["id"]
+      @name     = bot_info["name"]
+
       @listeners ||= []
       @commands ||= []
       @brain ||= {}
+
       on :message, &method(:message_handler)
       ScriptLoader.new(self).load
     end
@@ -38,7 +42,8 @@ module Boty
     end
 
     def desc(command, description = nil)
-      @current_desc = { command: command, description: description }
+      @current_desc = ActionDescription.new command,
+                                            description: description
     end
 
     def say(message, api_parameters = {})
@@ -49,33 +54,33 @@ module Boty
     end
 
     def im(text, destiny: nil, to: nil, user_id: nil)
-      if destiny = User(user_id) || user_by_name(destiny, to)
-        logger.debug { "Sending #{text} to #{destiny.name}." }
+      destiny = User(user_id) || user_by_name(destiny, to)
+      if destiny
+        logger.debug do "Sending #{text} to #{destiny.name}." end
         Slack.chat.post_im destiny.id, text
       else
-        logger.debug { "User not found, refusing to send im." }
+        logger.debug do "User not found, refusing to send im." end
       end
     end
 
     # TODO: return an Action object instead of a hash
     def know_how
-      descriptions = (Array(@commands) + Array(@listeners)).compact.map(&:desc)
-      descriptions.inject({}) { |hsh, desc|
-        hsh.merge!(desc.command => desc.description)
-      }
+      actions = Array(@commands) + Array(@listeners)
+      actions.sort_by { |action| action.desc.command || "_" }
     end
 
     private
 
     def remove_action(collection, regex = nil, block = nil, command: nil)
       collection.delete_if do |action|
-        action.desc.command == command || action.is_this?(regex, block)
+        action.desc.command == command || action.this?(regex, block)
       end
     end
 
     def user_by_name(destiny, to)
-      if _to = to || destiny
-        Slack.users.by_name _to
+      to ||= destiny
+      if to
+        Slack.users.by_name to
       else
         @trigger_message.user
       end
@@ -83,34 +88,40 @@ module Boty
 
     def create_action(regex, &block)
       regex = Regexp.new(regex) if regex.is_a? String
-      Boty::Action.new(regex, @current_desc, &block).tap {
+      Boty::Action.new(self, regex, @current_desc, &block).tap {
         @current_desc = nil
       }
     end
 
     def message_from_bot_itself?(data)
-      data["user"] == self.id || data["user"] == self.name
+      data["user"] == id || data["user"] == name
     end
 
-    def has_valid_mention?(data)
+    def valid_mention?(data)
       return false if message_from_bot_itself? data
-      !!(/(<@#{id}|#{name}>)/ =~ data["text"])
+
+      if /(<@#{id}|#{name}>)/ =~ data["text"]
+        true
+      else
+        false
+      end
     end
 
     def message_handler(data)
       unless data["text"]
-        return logger.debug "Non text message, just ignoring."
+        return logger.debug do "Non text message, just ignoring." end
       end
+      actions = valid_mention?(data) ? @commands : @listeners
+      execute_all Message.new(data), actions
+    end
 
-      actions = has_valid_mention?(data) ? @commands : @listeners
-      @trigger_message = Message.new data
-      begin
-        Array(actions).each do |action|
-          action.execute self, @trigger_message
-        end
-      ensure
-        @trigger_message = nil
+    def execute_all(message, actions)
+      @trigger_message = message
+      Array(actions).each do |action|
+        action.execute @trigger_message
       end
+    ensure
+      @trigger_message = nil
     end
   end
 end

data/lib/boty/dsl.rb

@@ -7,14 +7,14 @@ module Boty
     INSTANCES = {}
     private_constant :INSTANCES
     class << self
-      alias original_constructor new
+      alias_method :original_constructor, :new
     end
 
     attr_accessor :bot
 
     extend Forwardable
-    def_delegators :bot, :desc, :respond, :name, :brain, :know_how, :im, :say,
-                         :match
+    def_delegators :bot,
+                   :desc, :respond, :name, :brain, :know_how, :im, :say, :match
     def_delegators :message, :user, :channel
 
     def self.new(bot)