keynote 0.2.0pre1 → 0.2.0pre2

data/gemfiles/rails4.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.0.0rc1"
+gem "activerecord-deprecated_finders", "~> 1.0.2"
+gem "journey", "~> 1.0.4"
+
+gemspec :path=>"../"

data/gemfiles/rails4.gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: /Users/rfitz/src/keynote
+  specs:
+    keynote (0.2.0pre1)
+      rails (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.0.rc1)
+      actionpack (= 4.0.0.rc1)
+      mail (~> 2.5.3)
+    actionpack (4.0.0.rc1)
+      activesupport (= 4.0.0.rc1)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0.rc1)
+      activesupport (= 4.0.0.rc1)
+      builder (~> 3.1.0)
+    activerecord (4.0.0.rc1)
+      activemodel (= 4.0.0.rc1)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0.rc1)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.2)
+    activesupport (4.0.0.rc1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    appraisal (0.5.2)
+      bundler
+      rake
+    arel (4.0.0)
+    atomic (1.1.8)
+    builder (3.1.4)
+    coderay (1.0.9)
+    erubis (2.7.0)
+    haml (4.0.2)
+      tilt
+    hike (1.2.2)
+    i18n (0.6.4)
+    journey (1.0.4)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    method_source (0.8.1)
+    mime-types (1.23)
+    minitest (4.7.4)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.2)
+    polyglot (0.3.3)
+    pry (0.9.12.1)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0.rc1)
+      actionmailer (= 4.0.0.rc1)
+      actionpack (= 4.0.0.rc1)
+      activerecord (= 4.0.0.rc1)
+      activesupport (= 4.0.0.rc1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0.rc1)
+      sprockets-rails (~> 2.0.0.rc4)
+    railties (4.0.0.rc1)
+      actionpack (= 4.0.0.rc1)
+      activesupport (= 4.0.0.rc1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.0.4)
+    redcarpet (2.2.2)
+    slim (1.0.1)
+      temple (~> 0.3.0)
+      tilt (~> 1.2)
+    slop (3.4.4)
+    sprockets (2.9.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.0.rc4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    temple (0.3.5)
+    thor (0.18.1)
+    thread_safe (0.1.0)
+      atomic
+    tilt (1.4.0)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+    yard (0.8.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-deprecated_finders (~> 1.0.2)
+  appraisal
+  haml
+  journey (~> 1.0.4)
+  keynote!
+  minitest
+  mocha (~> 0.13.3)
+  pry
+  rails (= 4.0.0rc1)
+  redcarpet
+  slim
+  yard

data/keynote.gemspec

@@ -23,8 +23,11 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'appraisal'
   gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'mocha', '~> 0.13.3'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'redcarpet'
   gem.add_development_dependency 'yard'
+
+  gem.add_development_dependency 'slim'
+  gem.add_development_dependency 'haml'
 end

data/lib/keynote.rb

@@ -2,6 +2,7 @@
 
 require "keynote/version"
 require "keynote/rumble"
+require "keynote/inline"
 require "keynote/presenter"
 require "keynote/controller"
 require "keynote/helper"

data/lib/keynote/inline.rb

@@ -0,0 +1,207 @@
+# encoding: UTF-8
+
+require "thread"
+
+module Keynote
+  # The `Inline` mixin lets you write inline templates as comments inside the
+  # body of a presenter method. You can use any template language supported by
+  # Rails.
+  #
+  # ## The `inline` method
+  #
+  # First, you have to declare what template languages you want to use by
+  # calling the {Keynote::Inline#inline} method on a presenter class:
+  #
+  #     class MyPresenter < Keynote::Presenter
+  #       presents :user, :account
+  #       inline :haml
+  #     end
+  #
+  # This defines a `#haml` instance method on the `MyPresenter` class.
+  #
+  # If you want to make inline templates available to all of your presenters,
+  # you can add an initializer like this to your application:
+  #
+  #     class Keynote::Presenter
+  #       inline :erb, :haml, :slim
+  #     end
+  #
+  # This will add `#erb`, `#haml`, and `#slim` instance methods to all of your
+  # presenters.
+  #
+  # ## Basic usage
+  #
+  # After defining one or more instance methods by calling `inline`, you can
+  # generate HTML by calling one of those methods and immediately following it
+  # with a block of comments containing your template:
+  #
+  #     def link
+  #       erb
+  #       # <%= link_to user_url(current_user) do %>
+  #       #   <%= image_tag("image1.jpg") %>
+  #       #   <%= image_tag("image2.jpg") %>
+  #       # <% end %>
+  #     end
+  #
+  # Calling this method renders the ERB template, including passing the calls
+  # to `link_to`, `user_url`, `current_user`, and `image_tag` back to the
+  # presenter object (and then to the view).
+  #
+  # ## Passing variables
+  #
+  # There are a couple of different ways to pass local variables into an inline
+  # template. The easiest is to pass the `binding` object into the template
+  # method, giving access to all local variables:
+  #
+  #     def local_binding
+  #       x = 1
+  #       y = 2
+  #
+  #       erb binding
+  #       # <%= x + y %>
+  #     end
+  #
+  # You can also pass a hash of variable names and values instead:
+  #
+  #     def local_binding
+  #       erb x: 1, y: 2
+  #       # <%= x + y %>
+  #     end
+  module Inline
+    # For each template format given as a parameter, add an instance method
+    # that can be called to render an inline template in that format. Any
+    # file extension supported by Rails is a valid parameter.
+    # @example
+    #   class UserPresenter < Keynote::Presenter
+    #     presents :user
+    #     inline :haml
+    #
+    #     def header
+    #       full_name = "#{user.first_name} #{user.last_name}"
+    #
+    #       haml binding
+    #       # div#header
+    #       #   h1= full_name
+    #       #   h3= user.most_recent_status
+    #     end
+    #   end
+    def inline(*formats)
+      require "action_view"
+      require "action_view/context"
+
+      Array(formats).each do |format|
+        define_method format do |locals = {}|
+          Renderer.new(self, locals, caller(1)[0], format).render
+        end
+      end
+    end
+
+    # @private
+    class Renderer
+      def initialize(presenter, locals, caller_line, format)
+        @presenter = presenter
+        @locals = extract_locals(locals)
+        @template = Cache.fetch(*parse_caller(caller_line), format, @locals)
+      end
+
+      def render
+        @template.render(@presenter, @locals)
+      end
+
+      private
+
+      def extract_locals(locals)
+        return locals unless locals.is_a?(Binding)
+
+        Hash[locals.eval("local_variables").map do |local|
+          [local, locals.eval(local.to_s)]
+        end]
+      end
+
+      def parse_caller(caller_line)
+        file, rest = caller_line.split ":", 2
+        line, _    = rest.split " ", 2
+
+        [file.strip, line.to_i]
+      end
+    end
+
+    # @private
+    class Cache
+      COMMENTED_LINE = /^\s*#(.*)$/
+
+      def self.fetch(source_file, line, format, locals)
+        instance = (Thread.current[:_keynote_template_cache] ||= Cache.new)
+        instance.fetch(source_file, line, format, locals)
+      end
+
+      def self.reset
+        Thread.current[:_keynote_template_cache] = nil
+      end
+
+      def initialize
+        @cache = {}
+      end
+
+      def fetch(source_file, line, format, locals)
+        local_names = locals.keys.sort
+        cache_key   = ["#{source_file}:#{line}", *local_names].freeze
+        new_mtime   = File.mtime(source_file).to_f
+
+        template, mtime = @cache[cache_key]
+
+        if new_mtime != mtime
+          source = read_template(source_file, line)
+
+          template = ActionView::Template.new(source, cache_key[0],
+            handler_for_format(format), locals: local_names)
+
+          @cache[cache_key] = [template, new_mtime]
+        end
+
+        template
+      end
+
+      private
+
+      def read_template(source_file, line)
+        result = ""
+
+        File.foreach(source_file).drop(line).each do |line|
+          if line =~ COMMENTED_LINE
+            result << $1
+          else
+            break
+          end
+        end
+
+        unindent result
+      end
+
+      # Borrowed from Pry, which borrowed it from Python.
+      def unindent(text, left_padding = 0)
+        margin = text.scan(/^[ \t]*(?=[^ \t\n])/).inject do |current_margin, next_indent|
+          if next_indent.start_with?(current_margin)
+            current_margin
+          elsif current_margin.start_with?(next_indent)
+            next_indent
+          else
+            ""
+          end
+        end
+
+        text.gsub(/^#{margin}/, ' ' * left_padding)
+      end
+
+      if Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 0
+        def handler_for_format(format)
+          ActionView::Template.handler_class_for_extension(format.to_s)
+        end
+      else
+        def handler_for_format(format)
+          ActionView::Template.handler_for_extension(format.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/keynote/presenter.rb

@@ -9,6 +9,8 @@ module Keynote
     include Keynote::Rumble
 
     class << self
+      attr_writer :object_names
+
       # Define the names and number of the objects presented by this class.
       # This replaces the default one-parameter constructor with one that takes
       # an extra parameter for each presented object.
@@ -29,6 +31,8 @@ module Keynote
       #   presenter.author    # == @some_user
       #
       def presents(*objects)
+        self.object_names = objects.dup
+
         objects.unshift :view
         attr_reader *objects
 
@@ -47,6 +51,14 @@ module Keynote
       def use_html_5_tags
         Rumble.use_html_5_tags(self)
       end
+
+      # List the object names this presenter wraps. The default is an empty
+      # array; calling `presents :foo, :bar` in the presenter's class body will
+      # cause `object_names` to return `[:foo, :bar]`.
+      # @return [Array<Symbol>]
+      def object_names
+        @object_names ||= []
+      end
     end
 
     # @private (used by Keynote::Cache to keep the view context up-to-date)
@@ -67,6 +79,18 @@ module Keynote
     end
     alias k present
 
+    # @private
+    def inspect
+      objects = self.class.object_names
+      render  = proc { |name| "#{name}: #{send(name).inspect}" }
+
+      if objects.any?
+        "#<#{self.class} #{objects.map(&render).join(", ")}>"
+      else
+        "#<#{self.class}>"
+      end
+    end
+
     # @private
     def respond_to_missing?(method_name, include_private = true)
       @view.respond_to?(method_name, true)
@@ -89,6 +113,13 @@ module Keynote
       end
     end
 
+    # @private
+    # We have to make a logger method available so that ActionView::Template
+    # can safely treat a presenter as a view object.
+    def logger
+      Rails.logger
+    end
+
     private
 
     # We have to explicitly proxy `#capture` because ActiveSupport creates a

data/lib/keynote/version.rb

@@ -2,5 +2,5 @@
 
 module Keynote
   # @private
-  VERSION = "0.2.0pre1"
+  VERSION = "0.2.0pre2"
 end

data/spec/benchmarks.rb

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+
+require "rails"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "rails/test_unit/railtie"
+require "keynote"
+require "benchmark"
+
+class MyPresenter < Keynote::Presenter
+  inline :erb
+
+  def my_string
+    "a" + "b" + "c"
+  end
+
+  def rumble
+    a_local = 1000
+
+    build_html do
+      div.foobar.baz! do
+        p { my_string }
+        p { a_local }
+      end
+    end
+  end
+
+  def erb_hash
+    a_local = 1000
+
+    erb a_local: a_local
+    # <div class="foobar" id="baz">
+    #   <p><%= my_string %></p>
+    #   <p><%= a_local %></p>
+    # </div>
+  end
+
+  def erb_binding
+    a_local = 1000
+
+    erb binding
+    # <div class="foobar" id="baz">
+    #   <p><%= my_string %></p>
+    #   <p><%= a_local %></p>
+    # </div>
+  end
+
+  def raw_erb_template
+    source = %{
+      <div class="foobar" id="baz">
+        <p><%= my_string %></p>
+        <p><%= a_local %></p>
+      </div>
+    }
+    template = ActionView::Template.new(
+      source, "raw_erb_template",
+      ActionView::Template.handler_for_extension(:erb),
+      locals: [:a_local]
+    )
+    TESTS.times { template.render(self, a_local: 1000) }
+  end
+end
+
+TESTS = 1_000
+presenter = MyPresenter.new(:view)
+
+Benchmark.bmbm do |results|
+  results.report("rumble") { TESTS.times { presenter.rumble } }
+  results.report("erb_hash") { TESTS.times { presenter.erb_hash } }
+  results.report("erb_binding") { TESTS.times { presenter.erb_binding } }
+  results.report("raw_erb_template") { presenter.raw_erb_template }
+end