lita 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f7cb3c5b605c35c60bdff103c47df2488814712
-  data.tar.gz: 22be31cadc4608c676923ea7253a9a3b6456e5ad
+  metadata.gz: 24b9a37965d639387442b0a419f4c1c860f726b9
+  data.tar.gz: 59d805329cc2aeab6724473f78dda55e01a1e970
 SHA512:
-  metadata.gz: 5f11b1e00ff16c75e0a5c56a7c96b6d658d27ef207444deb2808265471409f5fc5d6c2d3c585b3c56434e8097515ce5eee85f7d02de983979e005a47435e415b
-  data.tar.gz: 2bb7b4fd5497735d4e4a78559b26878f4de79e016901bf1c123c56b78fa37bc6d3c1e7b430875fd7fd820f55026b5f66e3d54ac1ee7be13a96c74a7941304eb3
+  metadata.gz: 06734db0a8f1de6b83acabcea2546db17df71900876ee1864ef524c7607c60a3a223919dbb9aa30602915bce5d10aeacdedf84e6f7da324575d3bc0701eb305b
+  data.tar.gz: c94be903e979b6a5a0d3c3eae0cfcf8d1d457d5895c087d5b64070fddcf0cf88b647c425123e427d0caae149b188863f3fc1e9b0f7395189a0516093b222d382

data/lib/lita.rb

@@ -94,6 +94,8 @@ require_relative "lita/logger"
 require_relative "lita/callback"
 require_relative "lita/configurable"
 require_relative "lita/namespace"
+require_relative "lita/template"
+require_relative "lita/template_resolver"
 require_relative "lita/handler/common"
 require_relative "lita/handler/chat_router"
 require_relative "lita/handler/http_router"

data/lib/lita/cli.rb

@@ -172,6 +172,9 @@ module Lita
       )
       template("plugin/spec/spec_helper.tt", "#{target}/spec/spec_helper.rb", config)
       template("plugin/locales/en.yml.tt", "#{target}/locales/en.yml", config)
+      if config[:plugin_type] == "handler"
+        copy_file("plugin/templates/gitkeep", "#{target}/templates/.gitkeep")
+      end
       copy_file("plugin/Gemfile", "#{target}/Gemfile")
       template("plugin/gemspec.tt", "#{target}/#{gem_name}.gemspec", config)
       copy_file("plugin/gitignore", "#{target}/.gitignore")

data/lib/lita/errors.rb

@@ -11,4 +11,13 @@ module Lita
   # An exception raised when Lita can't connect to Redis in test mode.
   # @since 4.0.3
   class RedisError < Error; end
+
+  # An exception raised when attempting to resolve a template that doesn't exist.
+  # @since 4.2.0
+  class MissingTemplateError < Error; end
+
+  # An exception raised when a handler attempts to render a template without having set its
+  # template root.
+  # @since 4.2.0
+  class MissingTemplateRootError < Error; end
 end

data/lib/lita/handler/common.rb

@@ -13,6 +13,20 @@ module Lita
 
       # Common class-level methods for all handlers.
       module ClassMethods
+        # Gets (and optionally sets) the directory where the handler's templates are stored.
+        # @param path [String] If provided, sets the template root to this value.
+        # @return [String] The template root path.
+        # @raise [MissingTemplateRootError] If accessed without setting a value first.
+        def template_root(path = nil)
+          @template_root = path if path
+
+          if defined?(@template_root)
+            return @template_root
+          else
+            raise MissingTemplateRootError
+          end
+        end
+
         # Returns the translation for a key, automatically namespaced to the handler.
         # @param key [String] The key of the translation.
         # @param hash [Hash] An optional hash of values to be interpolated in the string.
@@ -90,6 +104,10 @@ module Lita
         Lita.logger
       end
 
+      def render_template(template_name, variables = {})
+        Template.from_file(file_for_template(template_name)).render(variables)
+      end
+
       # @see .translate
       def translate(*args)
         self.class.translate(*args)
@@ -105,6 +123,14 @@ module Lita
         { headers: { "User-Agent" => "Lita v#{VERSION}" } }
       end
 
+      def file_for_template(template_name)
+        TemplateResolver.new(
+          self.class.template_root,
+          template_name,
+          robot.config.robot.adapter
+        ).resolve
+      end
+
       # The handler's namespace for Redis.
       def redis_namespace
         "handlers:#{self.class.namespace}"

data/lib/lita/template.rb

@@ -0,0 +1,53 @@
+module Lita
+  # A simple wrapper around ERB to render text from files or strings.
+  # @since 4.2.0
+  class Template
+    # A clean room object to use as the binding for ERB rendering.
+    # @api private
+    class TemplateEvaluationContext
+      # Returns the evaluation context's binding.
+      # @return [Binding] The binding.
+      def __get_binding
+        binding
+      end
+    end
+
+    class << self
+      # Initializes a new Template with the contents of the file at the given path.
+      # @param path [String] The path to the file to use as the template content.
+      # @return Template
+      def from_file(path)
+        new(File.read(path).chomp)
+      end
+    end
+
+    # @param source [String] A string to use as the template's content.
+    def initialize(source)
+      @erb = ERB.new(source, $SAFE, "<>")
+    end
+
+    # Render the template with the provided variables.
+    # @param variables [Hash] A collection of variables for interpolation. Each key-value pair will
+    #   make the value available inside the template as an instance variable with the key as its
+    #   name.
+    def render(variables = {})
+      erb.result(context_binding(variables))
+    end
+
+    private
+
+    # Create an empty object to use as the ERB context and set any provided variables in it.
+    def context_binding(variables)
+      context = TemplateEvaluationContext.new
+
+      variables.each do |k, v|
+        context.instance_variable_set("@#{k}", v)
+      end
+
+      context.__get_binding
+    end
+
+    # The underlying ERB object.
+    attr_reader :erb
+  end
+end

data/lib/lita/template_resolver.rb

@@ -0,0 +1,45 @@
+module Lita
+  # Finds the file path of the most appropriate template for the given adapter.
+  # @api private
+  # @since 4.2.0
+  class TemplateResolver
+    # @param template_root [String] The directory to search for templates.
+    # @param template_name [String] The name of the template to search for.
+    # @param adapter_name [String, Symbol] The name of the current adapter.
+    def initialize(template_root, template_name, adapter_name)
+      @template_root = template_root
+      @template_name = template_name
+      @adapter_name = adapter_name
+    end
+
+    # Returns the adapter-specific template, falling back to a generic template.
+    # @return [String] The path of the template to use.
+    # @raises [MissingTemplateError] If no templates with the given name exist.
+    def resolve
+      return adapter_template if File.exist?(adapter_template)
+      return generic_template if File.exist?(generic_template)
+      raise MissingTemplateError, I18n.t("lita.template.missing_template", path: generic_template)
+    end
+
+    private
+
+    # The directory to search for templates.
+    attr_reader :template_root
+
+    # The name of the template to search for.
+    attr_reader :template_name
+
+    # The name of the current adapter.
+    attr_reader :adapter_name
+
+    # Path to the adapter-specific template.
+    def adapter_template
+      @adapter_template ||= File.join(template_root, "#{template_name}.#{adapter_name}.erb")
+    end
+
+    # Path to the generic template.
+    def generic_template
+      @generic_template ||= File.join(template_root, "#{template_name}.erb")
+    end
+  end
+end

data/lib/lita/version.rb

@@ -1,4 +1,4 @@
 module Lita
   # The current version of Lita.
-  VERSION = "4.1.0"
+  VERSION = "4.2.0"
 end

data/spec/lita/handler/common_spec.rb

@@ -171,6 +171,33 @@ describe Lita::Handler::Common, lita: true do
     end
   end
 
+  describe "#render_template" do
+    context "with the template root set" do
+      before do
+        handler.template_root(File.expand_path(File.join("..", "..", "..", "templates"), __FILE__))
+      end
+
+      it "renders the given template to a string" do
+        expect(subject.render_template("basic")).to eq("Template rendered from a file!")
+      end
+
+      it "interpolates variables into the rendered template" do
+        result = subject.render_template("interpolated", first: "Carl", last: "Pug")
+
+        expect(result).to eq("I love Carl Pug!")
+      end
+
+      it "renders adapter-specific templates if available" do
+        robot.config.robot.adapter = :irc
+        expect(subject.render_template("basic")).to eq("IRC template rendered from a file!")
+      end
+    end
+
+    it "raises an exception if the template root hasn't been set" do
+      expect { subject.render_template("basic") }.to raise_error(Lita::MissingTemplateRootError)
+    end
+  end
+
   describe "timer methods" do
     let(:queue) { Queue.new }
 

data/spec/lita/template_resolver_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Lita::TemplateResolver do
+  subject do
+    described_class.new(template_root, template_name, adapter_name)
+  end
+
+  let(:adapter_name) { :shell }
+  let(:generic_template) { File.join(template_root, "basic.erb") }
+  let(:irc_template) { File.join(template_root, "basic.irc.erb") }
+  let(:template_name) { "basic" }
+  let(:template_root) { File.expand_path(File.join("..", "..", "templates"), __FILE__) }
+
+  describe "#resolve" do
+    context "when there is a template for the adapter" do
+      let(:adapter_name) { :irc }
+
+      it "returns the path to the adapter-specific template" do
+        expect(subject.resolve).to eq(irc_template)
+      end
+    end
+
+    context "when there is no template for the adapter" do
+      it "returns the path for the generic template" do
+        expect(subject.resolve).to eq(generic_template)
+      end
+    end
+
+    context "when there is no template with the given name" do
+      let(:template_name) { "nonexistent" }
+
+      it "raises an exception" do
+        expect { subject.resolve }.to raise_error(
+          Lita::MissingTemplateError,
+          %r{templates/nonexistent\.erb}
+        )
+      end
+    end
+  end
+end

data/spec/lita/template_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Lita::Template do
+  describe ".from_file" do
+    context "with a path to an ERB template" do
+      subject do
+        described_class.from_file(File.expand_path("../../templates/basic.erb", __FILE__))
+      end
+
+      it "uses the source in the file" do
+        expect(subject.render).to eq("Template rendered from a file!")
+      end
+    end
+  end
+
+  describe "#render" do
+    context "with a static source template" do
+      subject { described_class.new("Hello, Lita!") }
+
+      it "renders the text" do
+        expect(subject.render).to eq("Hello, Lita!")
+      end
+    end
+
+    context "with interpolation variables" do
+      subject { described_class.new("Hello, <%= @name %>!") }
+
+      it "renders the text with interpolated values" do
+        expect(subject.render(name: "Carl")).to eq("Hello, Carl!")
+      end
+    end
+  end
+end

data/spec/templates/basic.erb

@@ -0,0 +1 @@
+Template rendered from a file!

data/spec/templates/basic.irc.erb

@@ -0,0 +1 @@
+IRC template rendered from a file!

data/spec/templates/interpolated.erb

@@ -0,0 +1 @@
+I love <%= @first %> <%= @last %>!

data/templates/locales/en.yml

@@ -152,3 +152,5 @@ en:
         `%{old_method}` is deprecated and will be removed in Lita 5.0. Use `%{new_method}` instead.
     source:
       user_or_room_required: Either a user or a room is required.
+    template:
+      missing_template: Missing template file at %{path}.

data/templates/plugin/README.tt

@@ -18,7 +18,7 @@ gem "<%= config[:gem_name] %>"
 ```
 <%- end -%>
 
-<%- unless config[:plugin_type] == "extension" %>
+<%- unless config[:plugin_type] == "extension" -%>
 ## Configuration
 
 TODO: Describe any configuration attributes the plugin exposes.

data/templates/plugin/lib/plugin.tt

@@ -5,3 +5,10 @@ Lita.load_locales Dir[File.expand_path(
 )]
 
 require "lita/<%= config[:namespace] %>/<%= config[:name] %>"
+<%- if config[:plugin_type] == "handler" -%>
+
+Lita::<%= config[:constant_namespace] %>::<%= config[:constant_name] %>.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)
+<%- end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-11 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -323,6 +323,8 @@ files:
 - lib/lita/rspec/matchers/event_route_matcher.rb
 - lib/lita/rspec/matchers/http_route_matcher.rb
 - lib/lita/source.rb
+- lib/lita/template.rb
+- lib/lita/template_resolver.rb
 - lib/lita/timer.rb
 - lib/lita/user.rb
 - lib/lita/util.rb
@@ -354,11 +356,16 @@ files:
 - spec/lita/robot_spec.rb
 - spec/lita/rspec_spec.rb
 - spec/lita/source_spec.rb
+- spec/lita/template_resolver_spec.rb
+- spec/lita/template_spec.rb
 - spec/lita/timer_spec.rb
 - spec/lita/user_spec.rb
 - spec/lita/util_spec.rb
 - spec/lita_spec.rb
 - spec/spec_helper.rb
+- spec/templates/basic.erb
+- spec/templates/basic.irc.erb
+- spec/templates/interpolated.erb
 - templates/locales/en.yml
 - templates/plugin/Gemfile
 - templates/plugin/LICENSE.tt
@@ -371,6 +378,7 @@ files:
 - templates/plugin/locales/en.yml.tt
 - templates/plugin/spec/lita/plugin_type/plugin_spec.tt
 - templates/plugin/spec/spec_helper.tt
+- templates/plugin/templates/gitkeep
 - templates/plugin/travis.yml
 - templates/robot/Gemfile
 - templates/robot/lita_config.rb
@@ -425,8 +433,14 @@ test_files:
 - spec/lita/robot_spec.rb
 - spec/lita/rspec_spec.rb
 - spec/lita/source_spec.rb
+- spec/lita/template_resolver_spec.rb
+- spec/lita/template_spec.rb
 - spec/lita/timer_spec.rb
 - spec/lita/user_spec.rb
 - spec/lita/util_spec.rb
 - spec/lita_spec.rb
 - spec/spec_helper.rb
+- spec/templates/basic.erb
+- spec/templates/basic.irc.erb
+- spec/templates/interpolated.erb
+has_rdoc: