keynote 0.1.3 → 0.2.0pre1

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## v0.2.0pre1
+* Add an implementation of the `present`/`k` method that's available in test
+  cases. Update test generators accordingly.
+* Update minitest-rails integration to be compatible with the newest
+  version of minitest-rails (on Rails 3.0, 3.1, 3.2, and 4.0).
+* Add `use_html_5_tags` class method to `Keynote::Presenter`. This adds a more
+  complete set of Rumble tag methods to the class.
+
+## v0.1.3
+* Add block form of `present`. If you pass a block into a `present` call, it
+  yields the presenter.

data/keynote.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
     A presenter is an object that encapsulates view logic. Like Rails helpers,
     presenters help you keep complex logic out of your templates. Keynote
     provides a consistent interface for defining and instantiating presenters.
-  }
+  }.gsub(/\s+/, ' ')
   gem.homepage      = "https://github.com/rf-/keynote"
 
   gem.files         = `git ls-files`.split($\)

data/lib/generators/presenter_generator.rb

@@ -20,6 +20,9 @@ module Rails::Generators
       when :rspec
         template 'keynote_rspec.rb', rspec_path
       when :test_unit
+        # In Rails 4 this is kind of a weird place to generate tests into.
+        # Unfortunately it isn't really fixable without changing the Rails
+        # test tasks, so that's a TODO.
         template 'keynote_test_unit.rb', test_unit_path
       when :mini_test
         if Rails.application.config.generators.mini_test[:spec]
@@ -51,17 +54,17 @@ module Rails::Generators
       targets.map { |t| ":#{t}" }.join(', ')
     end
 
-    def view_and_target_list
-      if targets.any?
-        ['view', target_list].join(', ')
-      else
-        'view'
-      end
+    def presenter_name_and_target_list
+      [presenter_name, *target_list].join(', ')
+    end
+
+    def presenter_name
+      class_name.sub(/Presenter$/, '').underscore.to_sym.inspect
     end
 
     if ::Rails.version.to_f < 3.1
       protected
-      # This methods doesn't exist in Rails 3.0
+      # This method doesn't exist in Rails 3.0
       def module_namespacing
         yield if block_given?
       end

data/lib/generators/templates/keynote_mini_test_spec.rb

@@ -1,11 +1,13 @@
 require "minitest_helper"
 
-describe <%= class_name %>Presenter do
-  before do
-    @presenter = <%= class_name %>Presenter.new(<%= view_and_target_list %>)
-  end
+# Specs in this file have access to the present (or k) method, which they can
+# use to instantiate <%= class_name %>Presenter as normal. For example:
+#
+#   describe <%= class_name %>Presenter do
+#     it "has access to a view" do
+#       k(<%= presenter_name_and_target_list %>).should respond_to(:view)
+#     end
+#   end
 
-  # it "must be a real test" do
-  #   flunk "Need real tests"
-  # end
+describe <%= class_name %>Presenter do
 end

data/lib/generators/templates/keynote_mini_test_unit.rb

@@ -1,8 +1,8 @@
 require 'minitest_helper'
 
-class <%= class_name %>PresenterTest < Keynote::MiniTest::TestCase
+class <%= class_name %>PresenterTest < Keynote::TestCase
   setup do
-    @presenter = <%= class_name %>Presenter.new(<%= view_and_target_list %>)
+    @presenter = present(<%= presenter_name_and_target_list %>)
   end
 
   # test "the truth" do

data/lib/generators/templates/keynote_rspec.rb

@@ -1,5 +1,13 @@
 require 'spec_helper'
 
+# Specs in this file have access to the present (or k) method, which they can
+# use to instantiate <%= class_name %>Presenter as normal. For example:
+#
+#   describe <%= class_name %>Presenter do
+#     it "has access to a view" do
+#       k(<%= presenter_name_and_target_list %>).should respond_to(:view)
+#     end
+#   end
+
 describe <%= class_name %>Presenter do
-  subject { <%= class_name %>Presenter.new(<%= view_and_target_list %>) }
 end

data/lib/generators/templates/keynote_test_unit.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class <%= class_name %>PresenterTest < Keynote::TestCase
   setup do
-    @presenter = <%= class_name %>Presenter.new(<%= view_and_target_list %>)
+    @presenter = present(<%= presenter_name_and_target_list %>)
   end
 
   # test "the truth" do

data/lib/keynote.rb

@@ -26,7 +26,7 @@ module Keynote
     # @see Keynote::Controller#present
     # @see Keynote::Presenter#present
     #
-    # @overload present(*objects)
+    # @overload present(view, *objects)
     #   Return a presenter wrapping the given objects. The type of the
     #   presenter will be inferred from the type of the first object.
     #   @example

data/lib/keynote/presenter.rb

@@ -41,6 +41,12 @@ module Keynote
           end                            # end
         RUBY
       end
+
+      # Define a more complete set of HTML5 tag methods. The extra tags are
+      # listed in {Keynote::Rumble::COMPLETE}.
+      def use_html_5_tags
+        Rumble.use_html_5_tags(self)
+      end
     end
 
     # @private (used by Keynote::Cache to keep the view context up-to-date)

data/lib/keynote/railtie.rb

@@ -6,7 +6,11 @@ module Keynote
   # @private
   class Railtie < Rails::Railtie
     config.after_initialize do |app|
-      app.config.paths.add 'app/presenters', :eager_load => true
+      if ::Rails.version.to_f >= 4
+        app.config.paths.add 'app/presenters'
+      else
+        app.config.paths.add 'app/presenters', :eager_load => true
+      end
 
       if defined?(RSpec::Rails) && RSpec.respond_to?(:configure)
         require 'keynote/testing/rspec'
@@ -16,7 +20,9 @@ module Keynote
         require 'keynote/testing/minitest_rails'
       end
 
-      require "keynote/testing/test_unit"
+      if !defined?(MiniTest::Rails)
+        require "keynote/testing/test_unit"
+      end
     end
 
     ActiveSupport.on_load(:action_view) do

data/lib/keynote/rumble.rb

@@ -167,16 +167,14 @@ module Keynote
       table tbody td textarea tfoot th thead time tr ul]
 
     # A more complete set of HTML5 tags. You can use these by calling
-    # `Keynote::Rumble.use_html5_tags(self)` in a presenter's class body.
-    COMPLETE = %w[a abbr acronym address applet area article aside audio b base
-      basefont bdo big blockquote body br button canvas caption center cite
-      code col colgroup command datalist dd del details dfn dir div dl dt em
-      embed fieldset figcaption figure font footer form frame frameset h1
-      h6 head header hgroup hr i iframe img input ins keygen kbd label legend
-      li link map mark menu meta meter nav noframes noscript object ol optgroup
-      option output p param pre progress q rp rt ruby s samp script section
-      select small source span strike strong style sub summary sup table tbody
-      td textarea tfoot th thead time title tr tt u ul var video wbr xmp]
+    # `use_html_5_tags` in a presenter's class body.
+    COMPLETE = %w[abbr acronym address applet area article aside audio base
+      basefont bdo big blockquote body canvas caption center cite code col
+      colgroup command datalist dd details dfn dir dl dt embed fieldset
+      figcaption figure font footer frame frameset head header hgroup iframe
+      ins keygen kbd legend map mark menu meta meter nav noframes noscript
+      object output param progress q rp rt ruby s samp section small source
+      strike style summary title tt u var video wbr xmp]
 
     # @private
     SELFCLOSING = %w[base meta link hr br param img area input col frame]
@@ -199,9 +197,7 @@ module Keynote
       end
     end
 
-    # Define a more complete set of HTML5 tag methods on the given presenter
-    # class.
-    # @param [Keynote::Presenter] base
+    # @private
     def self.use_html_5_tags(base)
       define_tags(base, COMPLETE)
     end

data/lib/keynote/testing/minitest_rails.rake

@@ -1,2 +1,18 @@
-# Add the presenters folder to the default test run
-MINITEST_TASKS << 'presenters'
+# encoding: UTF-8
+
+require "rake/testtask"
+require "minitest/rails/testing"
+require "minitest/rails/tasks/sub_test_task"
+
+MiniTest::Rails::Testing.default_tasks << "presenters"
+
+namespace "minitest" do
+  unless Rake::Task.task_defined? "minitest:presenters"
+    desc "Runs tests under test/presenters"
+    MiniTest::Rails::Tasks::SubTestTask.new("presenters" => "test:prepare") do |t|
+      t.libs.push "test"
+      t.pattern = "test/presenters/**/*_test.rb"
+      t.options = MiniTest::Rails::Testing.task_opts["presenters"] if MiniTest::Rails::Testing.task_opts["presenters"]
+    end
+  end
+end

data/lib/keynote/testing/minitest_rails.rb

@@ -1,22 +1,27 @@
 # encoding: UTF-8
 
-require 'minitest/rails/action_view'
+# Mutually exclusive with the Keynote::TestCase defined in
+# keynote/testing/test_unit. This is kind of icky but consistent with how
+# MT::R itself replaces the Rails test case classes.
+
+require "minitest/rails"
+require "keynote/testing/test_present_method"
 
 module Keynote
-  module MiniTest
-    class TestCase < ::MiniTest::Rails::ActionView::TestCase
-      # describe SomePresenter do
-      register_spec_type(self) do |desc|
-        desc < Keynote::Presenter if desc.is_a?(Class)
-      end
+  class TestCase < ::ActionView::TestCase
+    include TestPresentMethod
+
+    # describe SomePresenter do
+    register_spec_type(self) do |desc|
+      desc < Keynote::Presenter if desc.is_a?(Class)
+    end
 
-      # describe "SomePresenter" do
-      register_spec_type(/presenter( ?test)?\z/i, self)
+    # describe "SomePresenter" do
+    register_spec_type(/presenter( ?test)?\z/i, self)
 
-      # Don't try to include any particular helper, since we're not testing one
-      def self.include_helper_modules!
-        include _helpers
-      end
+    # Don't try to include any particular helper, since we're not testing one
+    def self.include_helper_modules!
+      include _helpers
     end
   end
 end

data/lib/keynote/testing/rspec.rb

@@ -1,9 +1,12 @@
 # encoding: UTF-8
 
+require "keynote/testing/test_present_method"
+
 module Keynote
   module ExampleGroup
     def self.included(base)
       base.send :include, RSpec::Rails::ViewExampleGroup
+      base.send :include, TestPresentMethod
       base.metadata[:type] = :presenter
     end
   end

data/lib/keynote/testing/test_present_method.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+module Keynote
+  module TestPresentMethod
+    def present(*objects, &blk)
+      Keynote.present(view, *objects, &blk)
+    end
+    alias k present
+  end
+end

data/lib/keynote/testing/test_unit.rb

@@ -1,6 +1,9 @@
 # encoding: UTF-8
 
+require "keynote/testing/test_present_method"
+
 module Keynote
   class TestCase < ::ActionView::TestCase
+    include TestPresentMethod
   end
 end

data/lib/keynote/version.rb

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

data/spec/generator_spec.rb

@@ -100,7 +100,7 @@ describe "generators" do
         must_match /class PostPresenter < Keynote::Presenter/
 
       file_contents('test/presenters/post_presenter_test.rb').
-        must_match /class PostPresenterTest < Keynote::MiniTest::TestCase/
+        must_match /class PostPresenterTest < Keynote::TestCase/
     end
   end
 end

data/spec/helper.rb

@@ -82,3 +82,13 @@ end
 class CombinedPresenter < Keynote::Presenter
   presents :model_1, :model_2
 end
+
+class Html5Presenter < Keynote::Presenter
+  def generate_h3(content)
+    build_html { h3 content }
+  end
+
+  def generate_small(content)
+    build_html { small content }
+  end
+end

data/spec/presenter_spec.rb

@@ -62,6 +62,20 @@ describe Keynote::Presenter do
     end
   end
 
+  describe ".use_html5_tags" do
+    it "should add Rumble tags like `small` while preserving existing tags" do
+      presenter = Html5Presenter.new(nil)
+
+      presenter.generate_h3("hi").must_equal "<h3>hi</h3>"
+      proc { presenter.generate_small("uh-oh") }.must_raise NoMethodError
+
+      Html5Presenter.use_html_5_tags
+
+      presenter.generate_h3("hi").must_equal "<h3>hi</h3>"
+      presenter.generate_small("hi").must_equal "<small>hi</small>"
+    end
+  end
+
   describe "#present" do
     it "should pass its view context through to the new presenter" do
       mock = mock()

metadata

@@ -1,26 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: keynote
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.1.3
+  prerelease: 5
+  version: 0.2.0pre1
 platform: ruby
 authors:
 - Ryan Fitzgerald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-14 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
     none: false
-  name: rails
   type: :runtime
-  prerelease: false
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -28,15 +28,15 @@ dependencies:
         version: 3.0.0
     none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: appraisal
   type: :development
-  prerelease: false
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -44,15 +44,15 @@ dependencies:
         version: '0'
     none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: minitest
   type: :development
-  prerelease: false
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -60,15 +60,15 @@ dependencies:
         version: '0'
     none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: mocha
   type: :development
-  prerelease: false
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -76,15 +76,15 @@ dependencies:
         version: '0'
     none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: pry
   type: :development
-  prerelease: false
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -92,15 +92,15 @@ dependencies:
         version: '0'
     none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: redcarpet
   type: :development
-  prerelease: false
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -108,25 +108,24 @@ dependencies:
         version: '0'
     none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: yard
   type: :development
-  prerelease: false
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-description: ! "\n    A presenter is an object that encapsulates view logic. Like
-  Rails helpers,\n    presenters help you keep complex logic out of your templates.
-  Keynote\n    provides a consistent interface for defining and instantiating presenters.\n
-  \ "
+description: ! ' A presenter is an object that encapsulates view logic. Like Rails
+  helpers, presenters help you keep complex logic out of your templates. Keynote provides
+  a consistent interface for defining and instantiating presenters. '
 email:
 - rwfitzge@gmail.com
 executables: []
@@ -136,6 +135,7 @@ files:
 - .gitignore
 - .yardopts
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -157,6 +157,7 @@ files:
 - lib/keynote/testing/minitest_rails.rake
 - lib/keynote/testing/minitest_rails.rb
 - lib/keynote/testing/rspec.rb
+- lib/keynote/testing/test_present_method.rb
 - lib/keynote/testing/test_unit.rb
 - lib/keynote/version.rb
 - spec/generator_spec.rb
@@ -180,13 +181,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
   none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Flexible presenters for Rails.