keynote 1.1.0 → 2.0.0

data/scenarios.yml

@@ -1,25 +0,0 @@
-project: keynote
-
-shared:
-  from: ruby:2.4
-  cmd: "(bundle check || bundle install) && bundle exec rake"
-  service:
-    volumes:
-      - bundle_{{scenario_name}}:/usr/local/bundle
-    environment:
-      BUNDLE_GEMFILE: scenarios/{{scenario_name}}.gemfile
-  volumes:
-    bundle_{{scenario_name}}:
-
-scenarios:
-  rails31:
-    from: ruby:2.0
-  rails32:
-    from: ruby:2.0
-  rails40:
-    from: ruby:2.3
-  rails41:
-    from: ruby:2.3
-  rails42: {}
-  rails50: {}
-  rails51: {}

data/spec/benchmarks.rb

@@ -1,73 +0,0 @@
-# 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
-  extend Keynote::Inline
-  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

data/spec/generator_spec.rb

@@ -1,159 +0,0 @@
-# encoding: UTF-8
-
-require 'helper'
-require 'rails/generators'
-require 'fileutils'
-
-describe "generators" do
-  def invoke_generator(*args)
-    FileUtils.mkdir_p(output_path)
-
-    args.push '--quiet'
-
-    retval = Rails::Generators.invoke 'presenter', args,
-      :behavior => :invoke,
-      :destination_root => output_path
-
-    assert retval, 'Generator must succeed'
-
-    output_files = Dir["#{output_path}/**/*.rb"]
-
-    yield output_files.map { |path| path.sub("#{output_path}/", '') }.sort
-  ensure
-    FileUtils.rm_rf(output_path)
-  end
-
-  def output_path
-    File.expand_path('../../tmp', __FILE__)
-  end
-
-  def file_contents(path)
-    File.read(File.join(output_path, path))
-  end
-
-  describe "when the test_framework is :test_unit" do
-    before do
-      Rails.application.config.generators do |g|
-        g.test_framework :test_unit
-      end
-    end
-
-    it "generates a presenter and Test::Unit file" do
-      invoke_generator 'post' do |files|
-        files.must_equal %w(
-          app/presenters/post_presenter.rb
-          test/unit/presenters/post_presenter_test.rb
-        )
-
-        file_contents('app/presenters/post_presenter.rb').
-          must_match(/class PostPresenter < Keynote::Presenter/)
-
-        file_contents('test/unit/presenters/post_presenter_test.rb').
-          must_match(/class PostPresenterTest < Keynote::TestCase/)
-      end
-    end
-
-    it "does not add a 'presents' line" do
-      invoke_generator 'post' do |files|
-        file_contents('app/presenters/post_presenter.rb').
-          wont_match(/presents/)
-      end
-    end
-
-    it "generates an appropriate present() call" do
-      invoke_generator 'post' do |files|
-        file_contents('test/unit/presenters/post_presenter_test.rb').
-          must_match(/present\(:post\)/)
-      end
-    end
-
-    describe "when the presenter has one parameter" do
-      it "adds a 'presents' line" do
-        invoke_generator 'post', 'foo' do |files|
-          file_contents('app/presenters/post_presenter.rb').
-            must_match(/presents :foo$/)
-        end
-      end
-
-      it "generates an appropriate present() call" do
-        invoke_generator 'post', 'foo' do |files|
-          file_contents('test/unit/presenters/post_presenter_test.rb').
-            must_match(/present\(:post, :foo\)/)
-        end
-      end
-    end
-
-    describe "when the presenter has two parameters" do
-      it "adds a 'presents' line" do
-        invoke_generator 'post', 'foo', 'bar' do |files|
-          file_contents('app/presenters/post_presenter.rb').
-            must_match(/presents :foo, :bar$/)
-        end
-      end
-
-      it "generates an appropriate present() call" do
-        invoke_generator 'post', 'foo', 'bar' do |files|
-          file_contents('test/unit/presenters/post_presenter_test.rb').
-            must_match(/present\(:post, :foo, :bar\)/)
-        end
-      end
-    end
-  end
-
-  it "generates a presenter and RSpec file" do
-    Rails.application.config.generators do |g|
-      g.test_framework :rspec
-    end
-
-    invoke_generator 'post' do |files|
-      files.must_equal %w(
-        app/presenters/post_presenter.rb
-        spec/presenters/post_presenter_spec.rb
-      )
-
-      file_contents('app/presenters/post_presenter.rb').
-        must_match(/class PostPresenter < Keynote::Presenter/)
-
-      file_contents('spec/presenters/post_presenter_spec.rb').
-        must_match(/describe PostPresenter do/)
-    end
-  end
-
-  it "generates a presenter and MiniTest::Rails spec file" do
-    Rails.application.config.generators do |g|
-      g.test_framework :mini_test, :spec => true
-    end
-
-    invoke_generator 'post' do |files|
-      files.must_equal %w(
-        app/presenters/post_presenter.rb
-        test/presenters/post_presenter_test.rb
-      )
-
-      file_contents('app/presenters/post_presenter.rb').
-        must_match(/class PostPresenter < Keynote::Presenter/)
-
-      file_contents('test/presenters/post_presenter_test.rb').
-        must_match(/describe PostPresenter do/)
-    end
-  end
-
-  it "generates a presenter and MiniTest::Rails unit file" do
-    Rails.application.config.generators do |g|
-      g.test_framework :mini_test, :spec => false
-    end
-
-    invoke_generator 'post' do |files|
-      files.must_equal %w(
-        app/presenters/post_presenter.rb
-        test/presenters/post_presenter_test.rb
-      )
-
-      file_contents('app/presenters/post_presenter.rb').
-        must_match(/class PostPresenter < Keynote::Presenter/)
-
-      file_contents('test/presenters/post_presenter_test.rb').
-        must_match(/class PostPresenterTest < Keynote::TestCase/)
-    end
-  end
-end

data/spec/helper.rb

@@ -1,90 +0,0 @@
-# encoding: UTF-8
-
-if ENV["COVERAGE"]
-  require "simplecov"
-  SimpleCov.start
-end
-
-require 'minitest/autorun'
-require 'minitest/spec'
-require 'minitest/pride'
-require 'mocha/setup'
-
-require 'pry'
-
-require 'rails'
-require 'action_controller/railtie'
-require 'action_mailer/railtie'
-require 'rails/test_unit/railtie'
-
-require 'keynote'
-
-## Initialize our test app (by Jose Valim: https://gist.github.com/1942658)
-
-class TestApp < Rails::Application
-  config.active_support.deprecation = :log
-  config.eager_load = false
-
-  config.secret_token = 'a' * 100
-end
-
-class HelloController < ActionController::Base
-  def world
-    render :text => "Hello world!", :layout => false
-  end
-end
-
-TestApp.initialize!
-
-# We have to define this class because it's hard-coded into the definition of
-# ActiveSupport::TestCase, which will load regardless of whether we load
-# ActiveRecord.
-module ActiveRecord
-  class Model
-  end
-end
-
-## Examples
-
-class EmptyPresenter < Keynote::Presenter
-end
-
-class NormalPresenter < Keynote::Presenter
-  presents :model
-
-  def some_bad_js
-    "<script>alert('pwnt');</script>"
-  end
-
-  def some_bad_html
-    build_html do
-      div { text some_bad_js }
-      div { some_bad_js }
-      div some_bad_js
-    end
-  end
-end
-
-class Normal
-end
-
-module Keynote
-  class NestedPresenter < Keynote::Presenter
-    presents :model
-
-    def generate_div
-      build_html do
-        div.hi! do
-          link_to '#', 'Hello'
-        end
-      end
-    end
-  end
-
-  class Nested
-  end
-end
-
-class CombinedPresenter < Keynote::Presenter
-  presents :model_1, :model_2
-end

data/spec/inline_spec.rb

@@ -1,157 +0,0 @@
-# encoding: UTF-8
-
-require "helper"
-require "fileutils"
-require "slim"
-require "haml"
-require "haml/template"
-
-module Keynote
-  describe Inline do
-    let(:presenter) { InlineUser.new(:view) }
-
-    def clean_whitespace(str)
-      str.gsub(/\s/, "")
-    end
-
-    class InlineUser < Keynote::Presenter
-      extend Keynote::Inline
-      inline :slim, :haml
-
-      def simple_template
-        erb
-        # Here's some math: <%= 2 + 2 %>
-      end
-
-      def ivars
-        @greetee = "world"
-        erb
-        # Hello <%= @greetee %>!
-      end
-
-      def locals_from_hash
-        erb local: "H"
-        # Local <%= local %>
-      end
-
-      def locals_from_binding
-        local = "H"
-        erb binding
-        # Local <%= local %>
-      end
-
-      def method_calls
-        erb
-        # <%= locals_from_hash %>
-        # <%= locals_from_binding %>
-      end
-
-      def error_handling
-        erb
-        # <% raise "UH OH" %>
-      end
-
-      def fix_indentation
-        slim
-        # .indented_slightly
-        #   - (2..4).each do |i|
-        #     ' #{i} times
-      end
-
-      def erb_escaping
-        raw = erb
-        # <%= "<script>alert(1);</script>" %>
-        escaped = erb
-        # <%= "<script>alert(1);</script>".html_safe %>
-        raw + escaped
-      end
-
-      def slim_escaping
-        raw = slim
-        # = "<script>alert(1);</script>"
-        escaped = slim
-        # = "<script>alert(1);</script>".html_safe
-        raw + escaped
-      end
-
-      def haml_escaping
-        raw = haml
-        # = "<script>alert(1);</script>"
-        escaped = haml
-        # = "<script>alert(1);</script>".html_safe
-        raw + escaped
-      end
-    end
-
-    before do
-      Keynote::Inline::Cache.reset
-    end
-
-    it "should render a template" do
-      presenter.simple_template.strip.must_equal "Here's some math: 4"
-    end
-
-    it "should see instance variables from the presenter" do
-      presenter.ivars.strip.must_equal "Hello world!"
-    end
-
-    it "should see locals passed in as a hash" do
-      presenter.locals_from_hash.strip.must_equal "Local H"
-    end
-
-    it "should see locals passed in as a binding" do
-      presenter.locals_from_binding.strip.must_equal "Local H"
-    end
-
-    it "should be able to call other methods from the same object" do
-      presenter.method_calls.strip.squeeze(" ").must_equal "Local H\nLocal H"
-    end
-
-    it "should handle errors relatively gracefully" do
-      begin
-        presenter.error_handling
-      rescue => e
-      end
-
-      e.must_be_instance_of ActionView::Template::Error
-
-      if e.respond_to?(:original_exception)
-        e.original_exception.must_be_instance_of RuntimeError
-        e.original_exception.message.must_equal "UH OH"
-      else
-        e.cause.must_be_instance_of RuntimeError
-        e.cause.message.must_equal "UH OH"
-      end
-    end
-
-    it "should remove leading indentation" do
-      presenter.fix_indentation.must_equal \
-        "<div class=\"indented_slightly\">2 times 3 times 4 times </div>"
-    end
-
-    it "should escape HTML by default" do
-      unescaped = "<script>alert(1);</script>"
-      escaped   = unescaped.gsub(/</, "&lt;").gsub(/>/, "&gt;")
-      escaped2  = escaped.gsub(/\//, "&#47;") # for Slim w/ Rails > 3.0 (??)
-
-      clean_whitespace(presenter.erb_escaping).must_equal escaped + unescaped
-      clean_whitespace(presenter.haml_escaping).must_equal escaped + unescaped
-
-      [escaped + unescaped, escaped2 + unescaped].must_include \
-        clean_whitespace(presenter.slim_escaping)
-    end
-
-    it "should see updates after the file is reloaded" do
-      presenter.simple_template.strip.must_equal "Here's some math: 4"
-
-      Keynote::Inline::Cache.
-        any_instance.stubs(:read_template).returns("HELLO")
-
-      presenter.simple_template.strip.must_equal "Here's some math: 4"
-
-      FileUtils.touch __FILE__
-
-      presenter.simple_template.must_equal "HELLO"
-    end
-  end
-end

data/spec/keynote_spec.rb

@@ -1,130 +0,0 @@
-# encoding: UTF-8
-
-require 'helper'
-
-describe Keynote do
-  let(:view)  { Object.new }
-
-  describe "with a normal presenter" do
-    let(:model) { Normal.new }
-
-    it "should find and instantiate implicitly" do
-      p = Keynote.present(view, model)
-
-      p.wont_be_nil
-      p.must_be_instance_of NormalPresenter
-
-      p.view.must_equal  view
-      p.model.must_equal model
-    end
-
-    it "should find and instantiate explicitly" do
-      p = Keynote.present(view, :normal, 'hello')
-
-      p.wont_be_nil
-      p.must_be_instance_of NormalPresenter
-
-      p.view.must_equal  view
-      p.model.must_equal 'hello'
-    end
-
-    it "should take a block and pass the presenter into it" do
-      m = mock()
-      m.expects(:block_yielded)
-
-      Keynote.present(view, :normal, 'hello') do |p|
-        m.block_yielded
-
-        p.wont_be_nil
-        p.must_be_instance_of NormalPresenter
-
-        p.view.must_equal  view
-        p.model.must_equal 'hello'
-      end
-    end
-
-    it "should integrate with Rumble" do
-      p  = Keynote.present(view, model)
-      rx = /<div>&lt;script&gt;alert\(/
-
-      p.some_bad_html.scan(rx).count.must_equal 3
-    end
-  end
-
-  describe "with a nested presenter" do
-    let(:model) { Keynote::Nested.new }
-
-    it "should find and instantiate implicitly" do
-      p = Keynote.present(view, model)
-
-      p.wont_be_nil
-      p.must_be_instance_of Keynote::NestedPresenter
-
-      p.view.must_equal  view
-      p.model.must_equal model
-    end
-
-    it "should find and instantiate explicitly" do
-      p = Keynote.present(view, "keynote/nested", 'hello')
-
-      p.wont_be_nil
-      p.must_be_instance_of Keynote::NestedPresenter
-
-      p.view.must_equal  view
-      p.model.must_equal 'hello'
-    end
-  end
-
-  describe "caching" do
-    describe "when there is a view context" do
-      let(:view_2) { Object.new }
-
-      it "should cache based on the models" do
-        model_1 = Normal.new
-        model_2 = Normal.new
-
-        presented_1 = Keynote.present(view, model_1)
-        presented_2 = Keynote.present(view, model_1)
-
-        presented_1.must_be :equal?, presented_2
-
-        presented_3 = Keynote.present(view, :combined, model_1, model_2)
-        presented_4 = Keynote.present(view, :combined, model_1, model_2)
-        presented_5 = Keynote.present(view, :combined, model_2, model_1)
-
-        presented_3.wont_be :equal?, presented_1
-        presented_3.must_be :equal?, presented_4
-        presented_3.wont_be :equal?, presented_5
-      end
-
-      it "should cache even if there are no models" do
-        presenter_1 = Keynote.present(view, :empty)
-        presenter_2 = Keynote.present(view, :empty)
-
-        presenter_1.must_be :equal?, presenter_2
-      end
-
-      it "should be scoped to the specific view context" do
-        model = Normal.new
-
-        presenter_1 = Keynote.present(view, model)
-        presenter_1.view.must_equal view
-
-        presenter_2 = Keynote.present(view_2, model)
-        presenter_2.wont_be :equal?, presenter_1
-        presenter_2.view.must_equal view_2
-      end
-    end
-
-    describe "when there's no view context" do
-      it "shouldn't cache" do
-        model = Normal.new
-
-        presented_1 = Keynote.present(nil, model)
-        presented_2 = Keynote.present(nil, model)
-
-        presented_1.wont_be :equal?, presented_2
-      end
-    end
-  end
-end