RubyGems - tilt-handlebars - Versions diffs - 1.0 → 1.1.0 - Mend

tilt-handlebars 1.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

data/README.md +50 -3
data/RELEASE_NOTES.md +13 -0
data/lib/sinatra/handlebars.rb +9 -0
data/lib/tilt/handlebars.rb +24 -6
data/lib/tilt/handlebars/version.rb +5 -0
data/test/{hello.hbs → fixtures/views/hello.hbs} +0 -0
data/test/fixtures/views/missing_partial.hbs +1 -0
data/test/fixtures/views/partial.hbs +1 -0
data/test/fixtures/views/partial2.handlebars +1 -0
data/test/fixtures/views/partial_test.hbs +1 -0
data/test/fixtures/views/partial_test2.handlebars +1 -0
data/test/fixtures/views/two_partials.hbs +1 -0
data/test/sinatra_test.rb +38 -0
data/test/test_helper.rb +5 -0
data/test/tilt_handlebarstemplate_test.rb +64 -10
data/tilt-handlebars.gemspec +8 -3
metadata +68 -23

data/README.md CHANGED

@@ -42,10 +42,57 @@ Output:
 	Hello, Joe. I'm happy to meet you.
+### Partials
+Partials are a file that can be loaded into another. For example, you may define a web page with
+a master layout (`layout.hbs`), which includes a header (`header.hbs`) and footer (`footer.hbs`).
+In this case, `header.hbs` and `footer.hbs` would be partials; `layout.hbs` includes these partials.
+`layout.hbs`:
+```html
+<html>
+	<head>...</head>
+	<body>
+		{{> header }}
+		{{ content }}
+		{{> footer }}
+	</body>
+</html>
+```
+Notice that you do not include the `.hbs` file extension in the partial name. Tilt Handlebars
+will look for the partial relative to the enclosing file (`layout.hbs` in this example) with
+either a `.hbs` or `.handlebars` extension.
+#### Sinatra
+Handlebars can be used with Sintra:
+```ruby
+require 'sinatra/handlebars'
+class MyApp < Sinatra::Base
+  helpers Sinatra::Handlebars
+  get "/hello" do
+    handlebars :hello, locals: {name: 'Joe'}
+  end
+end
+```
+This will use the template file named `views/hello.hbs`.
+Partials can also be used with Sinatra. As described previously, partials will be loaded
+relative to the enclosing template (e.g., in the `views` directory).
 ## Contributing
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Add tests, preferrably using Minitest::Spec for consistency.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/RELEASE_NOTES.md ADDED

@@ -0,0 +1,13 @@
+Version 1.1.0
+-------------
+2013 August 15
+* Sinatra support
+* Automatic loading of partials
+Version 1.0.0
+-------------
+2013 July 5
+* Initial release

data/lib/sinatra/handlebars.rb ADDED

@@ -0,0 +1,9 @@
+module Sinatra
+	module Handlebars
+		def handlebars(*args)
+			render(:handlebars, *args)
+		end
+	end
+	helpers Handlebars
+end

data/lib/tilt/handlebars.rb CHANGED

@@ -13,18 +13,17 @@ module Tilt
   #
   class HandlebarsTemplate < Template
     def initialize_engine
-      @context = ::Handlebars::Context.new
+      return if defined? ::Handlebars
+      require_template_library 'handlebars'
     end
-    def self.engine_initialized?
-      true
-    end
     def prepare
       @context = ::Handlebars::Context.new
-          @template = @context.compile(data)
+      @context.partial_missing { |partial_name| load_partial partial_name }
+      @template = @context.compile(data)
     end
     def evaluate(scope, locals = {}, &block)
       # Based on LiquidTemplate
       locals = locals.inject({}){ |h,(k,v)| h[k.to_s] = v ; h }
@@ -59,6 +58,25 @@ module Tilt
     def allows_script?
       false
     end
+    def load_partial(partial_name)
+      if Pathname.new(partial_name).absolute?
+        dir = ""
+      elsif file
+        dir = File.dirname file
+      end
+      partial_file = File.expand_path("#{partial_name}.hbs", dir)
+      partial_file = File.expand_path("#{partial_name}.handlebars", dir) unless File.file? partial_file
+      if File.file? partial_file
+        return IO.read(partial_file)
+      end
+      raise "The partial '#{partial_name}' could not be found. No such file #{partial_file}"
+    end
+    private :load_partial
   end
   register HandlebarsTemplate, 'handlebars', 'hbs'

data/lib/tilt/handlebars/version.rb ADDED

@@ -0,0 +1,5 @@
+module Tilt
+  module Handlebars
+    VERSION = "1.1.0"
+  end
+end

data/test/{hello.hbs → fixtures/views/hello.hbs} RENAMED

File without changes

data/test/fixtures/views/missing_partial.hbs ADDED

	@@ -0,0 +1 @@
1	+ Has anyone seen my partial? {{> no_partial }}

data/test/fixtures/views/partial.hbs ADDED

	@@ -0,0 +1 @@
1	+ It Came From the Partial Side by {{ author }}

data/test/fixtures/views/partial2.handlebars ADDED

	@@ -0,0 +1 @@
1	+ It Came From the Partial Side by {{ author }}

data/test/fixtures/views/partial_test.hbs ADDED

	@@ -0,0 +1 @@
1	+ My all time favorite book is {{> partial}}.

data/test/fixtures/views/partial_test2.handlebars ADDED

	@@ -0,0 +1 @@
1	+ My all time favorite book is {{> partial2}}.

data/test/fixtures/views/two_partials.hbs ADDED

	@@ -0,0 +1 @@
1	+ {{> partial}} may be a good book, but I'm waiting for the movie directed by {{> director}}.

data/test/sinatra_test.rb ADDED

@@ -0,0 +1,38 @@
+require 'test_helper'
+require 'rack/test'
+require 'sinatra/base'
+require 'sinatra/handlebars'
+class HandlebarsApp < Sinatra::Base
+  set :root, File.dirname(__FILE__) + '/fixtures'
+  helpers Sinatra::Handlebars
+  get "/hello" do
+    handlebars :hello, locals: {name: 'Joe', emotion: 'happy'}
+  end
+  get "/partials" do
+    handlebars :partial_test, locals: {author: "Stephanie Queen"}
+  end
+end
+describe "Using handlebars in Sinatra" do
+  include Rack::Test::Methods
+  def app
+    HandlebarsApp
+  end
+  it "renders simple template" do
+    response = get "/hello"
+    response.body.strip.must_equal "Hello, Joe. I'm happy to meet you."
+  end
+  it "renders template with partials" do
+    response = get "/partials"
+    response.body.strip.must_equal "My all time favorite book is It Came From the Partial Side by Stephanie Queen."
+  end
+end

data/test/test_helper.rb ADDED

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler.setup
+require 'minitest/autorun'
+require 'minitest/spec'

data/test/tilt_handlebarstemplate_test.rb CHANGED

@@ -1,8 +1,4 @@
-require 'bundler'
-Bundler.setup
-require 'minitest/autorun'
-require 'minitest/spec'
+require 'test_helper'
 require 'tilt'
 require 'tilt/handlebars'
@@ -13,7 +9,7 @@ end
 describe Tilt::HandlebarsTemplate do
   it 'renders from file' do
-    template = Tilt.new('test/hello.hbs')
+    template = Tilt.new('test/fixtures/views/hello.hbs')
     template.render(nil, name: 'Joe', emotion: 'happy').must_equal "Hello, Joe. I'm happy to meet you.\n"
   end
@@ -116,7 +112,26 @@ describe Tilt::HandlebarsTemplate do
   end
   describe "helpers" do
-    it "applies helper to static text" do
+    it "applies simple helper to value" do
+      template = make_template '{{upper greeting}}, world'
+      template.register_helper(:upper) do |this, *args|
+        "#{args[0].upcase}"
+      end
+      template.render(nil, :greeting => 'hello').must_equal "HELLO, world"
+    end
+    it "applies simple helper to quoted value" do
+      template = make_template '{{upper "greetings and salutations"}}, world'
+      template.register_helper(:upper) do |this, *args|
+        "#{args[0].upcase}"
+      end
+      template.render.must_equal "GREETINGS AND SALUTATIONS, world"
+    end
+    it "applies block helper to static text" do
       template = make_template '{{#upper}}Hello, World.{{/upper}}'
       template.register_helper(:upper) do |this, block|
         block.fn(this).upcase
@@ -125,7 +140,7 @@ describe Tilt::HandlebarsTemplate do
       template.render.must_equal "HELLO, WORLD."
     end
-    it "applies helper to nested values" do
+    it "applies block helper to nested values" do
       template = make_template '{{#upper}}Hey {{name}}{{/upper}}!'
       template.register_helper(:upper) do |this, block|
         block.fn(this).upcase
@@ -203,13 +218,52 @@ describe Tilt::HandlebarsTemplate do
   end
   describe "partials" do
-    it "displays content of partial" do
+    it "looks for partial relative to the template file" do
+      template = Tilt.new('test/fixtures/views/partial_test.hbs')
+      template.render(nil, :author => "Stephanie Queen").must_equal "My all time favorite book is It Came From the Partial Side by Stephanie Queen."
+    end
+    it "can load partial from absolute path" do
+      dir = Dir.pwd
+      template = make_template "Have you read {{> #{dir}/test/fixtures/views/partial}}?"
+      template.render(nil, :author => "Stephanie Queen").must_equal "Have you read It Came From the Partial Side by Stephanie Queen?"
+    end
+    it "also recognizes .handlebars extension" do
+      template = Tilt.new('test/fixtures/views/partial_test2.handlebars')
+      template.render(nil, :author => "Stephanie Queen").must_equal "My all time favorite book is It Came From the Partial Side by Stephanie Queen."
+    end
+    it "can load relative partial along with registered partial" do
+      template = Tilt.new('test/fixtures/views/two_partials.hbs')
+      template.register_partial :director, "Gary Rockhammer"
+      template.render(nil, :author => "Stephanie Queen").must_equal "It Came From the Partial Side by Stephanie Queen may be a good book, but I'm waiting for the movie directed by Gary Rockhammer."
+    end
+    it "gives precedence to registered partial over relative file" do
+      template = Tilt.new('test/fixtures/views/partial_test.hbs')
+      template.register_partial :partial, "Revenge of the Partial"
+      template.render.must_equal "My all time favorite book is Revenge of the Partial."
+    end
+    it "raises error if partial cannot be found" do
+      template = Tilt.new('test/fixtures/views/missing_partial.hbs')
+      # template.render
+      proc { template.render }.must_raise V8::Error
+    end
+    it "cannot automatically load partial when template is created from string instead of file" do
+      template = make_template "I wish I could load a partial like this: {{> my_partial}}."
+      proc { template.render }.must_raise V8::Error
+    end
+    it "allows partial to be registered" do
       template = make_template "{{> greeting}}. Nice to meet you."
       template.register_partial :greeting, "Hey, {{name}}"
       template.render(nil, :name => "Joe").must_equal "Hey, Joe. Nice to meet you."
     end
-    it "calls registeded method if partial is missing" do
+    it "calls registered method if partial is missing" do
       template = make_template "{{> where}} I've been looking for you."
       template.partial_missing do |partial_name|
         "Where have you been, {{name}}?" if partial_name == 'where'

data/tilt-handlebars.gemspec CHANGED

@@ -2,9 +2,11 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tilt/handlebars/version'
 Gem::Specification.new do |spec|
   spec.name          = "tilt-handlebars"
-  spec.version       = "1.0"
+  spec.version       = Tilt::Handlebars::VERSION
   spec.authors       = ["Jim Cushing"]
   spec.email         = ["jimothy@mac.com"]
   spec.description   = "Use Handlebars.rb with Tilt"
@@ -17,9 +19,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.add_dependency "tilt", "~> 1.4"
+  spec.add_dependency "handlebars", "~> 0.4"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_dependency "tilt", "~> 1.4"
-  spec.add_dependency "handlebars", "~> 0.4"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "rack-test"
 end

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tilt-handlebars
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.1.0
   prerelease:
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2013-08-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: handlebars
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -60,37 +92,37 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: tilt
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: handlebars
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
 description: Use Handlebars.rb with Tilt
 email:
 - jimothy@mac.com
@@ -102,9 +134,20 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASE_NOTES.md
 - Rakefile
+- lib/sinatra/handlebars.rb
 - lib/tilt/handlebars.rb
-- test/hello.hbs
+- lib/tilt/handlebars/version.rb
+- test/fixtures/views/hello.hbs
+- test/fixtures/views/missing_partial.hbs
+- test/fixtures/views/partial.hbs
+- test/fixtures/views/partial2.handlebars
+- test/fixtures/views/partial_test.hbs
+- test/fixtures/views/partial_test2.handlebars
+- test/fixtures/views/two_partials.hbs
+- test/sinatra_test.rb
+- test/test_helper.rb
 - test/tilt_handlebarstemplate_test.rb
 - tilt-handlebars.gemspec
 homepage: https://github.com/jimothyGator/tilt-handlebars
@@ -120,24 +163,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -129076644092719377
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -129076644092719377
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key:
 specification_version: 3
 summary: Use Handlebars.rb with Tilt
 test_files:
-- test/hello.hbs
+- test/fixtures/views/hello.hbs
+- test/fixtures/views/missing_partial.hbs
+- test/fixtures/views/partial.hbs
+- test/fixtures/views/partial2.handlebars
+- test/fixtures/views/partial_test.hbs
+- test/fixtures/views/partial_test2.handlebars
+- test/fixtures/views/two_partials.hbs
+- test/sinatra_test.rb
+- test/test_helper.rb
 - test/tilt_handlebarstemplate_test.rb