stache 1.0.0.rc → 1.0.0

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.0.0
+
+* Overhauled Mustache template engine. If you wish to have Mustache drive your entire template stack, you can invert control to it.
+* Fixed a bunch of problems with Handlebars access to the view namespace for helpers, etc.
+* New configuration option: you can now specify a wrapper namespace that Stache will look for your view classes in.
+
+Backwards compatibility should be fine; any regressions are bugs and should be reported.
+
+Huge thanks to all contributors!
+
 # 0.9.1
 
 * soften our hardcore stance on missing properties.

data/README.md

@@ -4,7 +4,7 @@ A Rails 3.x compatible Mustache/Handlebars Template Handler, with support for pa
 
 [![Build Status](https://secure.travis-ci.org/agoragames/stache.png)](http://travis-ci.org/agoragames/stache)
 
-## 1.0.0.rc
+## 1.0.0
 
 Major overhaul to the mustache side of things. Backwards compatibility *should* be intact. If not, file a bug and it will get taken care of.
 
@@ -26,6 +26,10 @@ Stache.configure do |c|
   c.template_base_path = "..."  # this is probably the one you'll want to change
                                 # it defaults to app/templates
 
+  c.wrapper_module_name = "..." # this lets you indicate the name of a module that
+                                # namespaces all your view classes, useful, if you
+                                # have a naming conflict, such as with a mailer
+
   # N.B. YOU MUST TELL STACHE WHICH TO USE:
   c.use :mustache
   # and / or
@@ -74,6 +78,10 @@ end
 <p>Here's a helper_method call: {{ my_view_helper_method }}</p>
 ```
 
+With the wrapper_module_name configuration set to "Wrapper":
+
+With a template `app/templates/profiles/index`, Stache will look for a view named `Wrapper::Profiles::Index`, and, if not found, will just use the base `Stache::Mustache::View`.
+
 ### Handlebars?
 
 Handlebars will have full access to your rails view helpers.
@@ -113,6 +121,10 @@ So: thanks a ton to those guys.
 * [ajacksified](https://github.com/ajacksified) cleaned up template extension handling.
 * [ayamomiji](https://github.com/ayamomiji) extended the `#template_include_tag` to pass through the full range of `#content_tag` options.
 * [awestendorf](https://github.com/awestendorf) requested that `View#partial` not be so particular about leading underscores. Though I didn't use his code, his prompt lead me to investigate how to properly use Rails' internal template lookup code.
+* [zombor](https://github.com/zombor) contributed an overhaul to the Mustache renderer that puts Mustache classes themselves in control of the render chain, not Rails.
+* [kategengler](https://github.com/kategengler) contributed a patch to allow folks to specify a namespace for their view objects.
+
+Thanks a ton to all of the contributors as well. This would never have grown beyond a mediocre tool that rendered partials without their help!
 
 ## Note on Patches/Pull Requests
 

data/Rakefile

@@ -10,8 +10,8 @@ end
 
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.main = 'README.rdoc'

data/lib/stache/config.rb

@@ -11,13 +11,12 @@ module Stache
   #   use :mustache # or :handlebars
   # end
   module Config
-    attr_accessor :template_base_path, :shared_path
+    attr_accessor :template_base_path, :shared_path, :wrapper_module_name
 
     def configure
       yield self
     end
 
-
     def template_base_path
       @template_base_path ||= ::Rails.root.join('app', 'templates')
     end
@@ -30,6 +29,10 @@ module Stache
       @shared_path ||= ::Rails.root.join('app', 'templates', 'shared')
     end
 
+    def wrapper_module_name
+      @wrapper_module_name ||= nil
+    end
+
     def use template_engine
       require "stache/#{template_engine}"
     end

data/lib/stache/handlebars/handler.rb

@@ -70,6 +70,8 @@ module Stache
       # suss out a constant name for the given template
       def handlebars_class_from_template(template)
         const_name = ActiveSupport::Inflector.camelize(template.virtual_path.to_s)
+        const_name = "#{Stache.wrapper_module_name}::#{const_name}" if Stache.wrapper_module_name
+
         begin
           const_name.constantize
         rescue NameError, LoadError => e

data/lib/stache/mustache/handler.rb

@@ -25,7 +25,7 @@ module Stache
           if #{mustache_class} == Stache::Mustache::View
             template_source = '#{template.source.gsub(/'/, "\\\\'")}'
           else
-            template_name = mustache.template_name+".#{template.formats.first.to_s}."+mustache.template_extension
+            template_name = "#{template.virtual_path.to_s}.#{template.formats.first.to_s}."+mustache.template_extension
             template_source = File.read(File.join(::Stache.template_base_path, template_name))
           end
 
@@ -68,6 +68,7 @@ module Stache
         end
 
         const_name = ActiveSupport::Inflector.camelize(template.virtual_path.to_s)
+        const_name = "#{Stache.wrapper_module_name}::#{const_name}" if Stache.wrapper_module_name
         begin
           const_name.constantize
         rescue NameError, LoadError => e

data/lib/stache/version.rb

@@ -1,3 +1,3 @@
 module Stache
-  VERSION = "1.0.0.rc"
+  VERSION = "1.0.0"
 end

data/spec/controllers/handlebars_controller_spec.rb

@@ -15,6 +15,20 @@ describe HandlebarsController do
     response.body.should =~ /Hello, Matt!/
   end
 
+  it "can render using a module wrapper" do
+    begin
+      Stache.wrapper_module_name = "Wrapper"
+
+      get :with_wrapper
+      assert_response 200
+
+      response.should render_template 'with_wrapper'
+      response.body.should =~ /Yes/
+    ensure
+      Stache.wrapper_module_name = nil
+    end
+  end
+
   it "correctly renders partials" do
     get :with_partials
     assert_response 200

data/spec/controllers/stache_controller_spec.rb

@@ -15,6 +15,20 @@ describe StacheController do
     response.body.should =~ /Hello, Matt!/
   end
 
+  it "can render using a module wrapper" do
+    begin
+      Stache.wrapper_module_name = "Wrapper"
+
+      get :with_wrapper
+      assert_response 200
+
+      response.should render_template 'with_wrapper'
+      response.body.should =~ /Yes/
+    ensure
+      Stache.wrapper_module_name = nil
+    end
+  end
+
   it "correctly renders partials" do
     get :with_partials
     assert_response 200

data/spec/dummy/app/controllers/handlebars_controller.rb

@@ -19,4 +19,8 @@ class HandlebarsController < ApplicationController
     #with_missing_data.html.hbs
   end
 
+  def with_wrapper
+
+  end
+
 end

data/spec/dummy/app/controllers/stache_controller.rb

@@ -18,6 +18,10 @@ class StacheController < ApplicationController
 
   end
 
+  def with_wrapper
+
+  end
+
   def helper
     Stache::ViewContext.current = self.view_context
   end

data/spec/dummy/app/views/handlebars/with_wrapper.html.hbs

@@ -0,0 +1,3 @@
+Am I using a wrapper module?
+
+{{answer}}

data/spec/dummy/app/views/stache/with_wrapper.html.mustache

@@ -0,0 +1,3 @@
+Am I using a wrapper module?
+
+{{answer}}

data/spec/dummy/config/application.rb

@@ -43,5 +43,7 @@ module Dummy
     config.filter_parameters += [:password]
 
     config.assets.enabled = true
+
+    config.autoload_paths += %W(#{config.root}/lib)
   end
 end

data/spec/dummy/config/routes.rb

@@ -9,6 +9,8 @@ Dummy::Application.routes.draw do
 
   get 'stache/with_asset_helpers', :to => 'stache#with_asset_helpers'
 
+  get 'stache/with_wrapper', :to => 'stache#with_wrapper'
+
   get 'handlebars', :to => 'handlebars#index', :as => 'handlebars'
 
   get 'handlebars/with_partials', :to => 'handlebars#with_partials'
@@ -16,4 +18,6 @@ Dummy::Application.routes.draw do
   get 'handlebars/with_helpers', :to => 'handlebars#with_helpers'
 
   get 'handlebars/with_missing_data', :to => 'handlebars#with_missing_data'
+
+  get 'handlebars/with_wrapper', :to => 'handlebars#with_wrapper'
 end

data/spec/dummy/lib/wrapper/handlebars/with_wrapper.rb

@@ -0,0 +1,9 @@
+module Wrapper
+  module Handlebars
+    class WithWrapper < ::Stache::Handlebars::View
+      def answer
+        "Yes"
+      end
+    end
+  end
+end

data/spec/dummy/lib/wrapper/stache/with_wrapper.rb

@@ -0,0 +1,9 @@
+module Wrapper
+  module Stache
+    class WithWrapper < ::Stache::Mustache::View
+      def answer
+        "Yes"
+      end
+    end
+  end
+end

data/spec/stache/config_spec.rb

@@ -7,8 +7,7 @@ describe "Stache::Config" do
     end
     [:template_base_path, :shared_path].each do |attr|
       it "sets up an attribute named #{attr.to_s}" do
-        Stache.should respond_to(attr)
-        Stache.should respond_to("#{attr}=")
+        should_set_up_attr_accessor_for(attr)
       end
 
       it "sets up a default value for #{attr}" do
@@ -20,6 +19,15 @@ describe "Stache::Config" do
         end
       end
     end
+
+    it "sets up an attribute named wrapper_module_name" do
+      attr = :wrapper_module_name
+      should_set_up_attr_accessor_for(attr)
+    end
+
+    it "sets a default value for wrapper_module_name" do
+      Stache.send(:wrapper_module_name).should be_nil
+    end
   end
 
   describe ".configure" do
@@ -34,4 +42,9 @@ describe "Stache::Config" do
     end
   end
 
+  def should_set_up_attr_accessor_for(attr)
+    Stache.should respond_to(attr)
+    Stache.should respond_to("#{attr}=")
+  end
+
 end

data/spec/stache/handlebars/handlebars_spec.rb

@@ -34,4 +34,26 @@ describe Stache::Handlebars::Handler do
       Object.send(:remove_const, :Profiles)
     end
   end
+
+  describe "#handlebars_class_from_template with config module wrapper set" do
+    before do
+      Stache.wrapper_module_name = "Wrapper"
+    end
+
+    it "returns the appropriate handlebars class" do
+      module Wrapper; class HelloWorld < ::Stache::Handlebars::View; end; end
+      @handler.handlebars_class_from_template(@template).should == Wrapper::HelloWorld
+      Object.send(:remove_const, :Wrapper)
+    end
+    it "is clever about folders and such" do
+      @template.stub!(:virtual_path).and_return("profiles/index")
+      module Wrapper; module Profiles; class Index < ::Stache::Handlebars::View; end; end; end
+      @handler.handlebars_class_from_template(@template).should == Wrapper::Profiles::Index
+      Object.send(:remove_const, :Wrapper)
+    end
+
+    after do
+      Stache.wrapper_module_name = nil
+    end
+  end
 end

data/spec/stache/mustache/handler_spec.rb

@@ -38,4 +38,26 @@ describe Stache::Mustache::Handler do
       Object.send(:remove_const, :Profiles)
     end
   end
+
+  describe "#mustache_class_from_template with config module wrapper set" do
+    before do
+      Stache.wrapper_module_name = "Wrapper"
+    end
+
+    it "returns the appropriate mustache class" do
+      module Wrapper; class HelloWorld < ::Stache::Mustache::View; end; end
+      @handler.mustache_class_from_template(@template).should == Wrapper::HelloWorld
+      Object.send(:remove_const, :Wrapper)
+    end
+    it "is clever about folders and such" do
+      @template.stub!(:virtual_path).and_return("profiles/index")
+      module Wrapper; module Profiles; class Index < ::Stache::Mustache::View; end; end; end
+      @handler.mustache_class_from_template(@template).should == Wrapper::Profiles::Index
+      Object.send(:remove_const, :Wrapper)
+    end
+
+    after do
+      Stache.wrapper_module_name = nil
+    end
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: stache
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
@@ -169,6 +169,7 @@ files:
 - spec/dummy/app/views/handlebars/with_helpers.html.hbs
 - spec/dummy/app/views/handlebars/with_missing_data.html.hbs
 - spec/dummy/app/views/handlebars/with_partials.html.hbs
+- spec/dummy/app/views/handlebars/with_wrapper.html.hbs
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/app/views/stache/_eaten_by_a.html.mustache
 - spec/dummy/app/views/stache/helper.html.mustache
@@ -181,6 +182,7 @@ files:
 - spec/dummy/app/views/stache/with_layout.rb
 - spec/dummy/app/views/stache/with_partials.html.mustache
 - spec/dummy/app/views/stache/with_partials.rb
+- spec/dummy/app/views/stache/with_wrapper.html.mustache
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -198,6 +200,8 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/lib/with_asset_helpers.rb
+- spec/dummy/lib/wrapper/handlebars/with_wrapper.rb
+- spec/dummy/lib/wrapper/stache/with_wrapper.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
@@ -234,9 +238,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2542393094037451014
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -263,6 +264,7 @@ test_files:
 - spec/dummy/app/views/handlebars/with_helpers.html.hbs
 - spec/dummy/app/views/handlebars/with_missing_data.html.hbs
 - spec/dummy/app/views/handlebars/with_partials.html.hbs
+- spec/dummy/app/views/handlebars/with_wrapper.html.hbs
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/app/views/stache/_eaten_by_a.html.mustache
 - spec/dummy/app/views/stache/helper.html.mustache
@@ -275,6 +277,7 @@ test_files:
 - spec/dummy/app/views/stache/with_layout.rb
 - spec/dummy/app/views/stache/with_partials.html.mustache
 - spec/dummy/app/views/stache/with_partials.rb
+- spec/dummy/app/views/stache/with_wrapper.html.mustache
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -292,6 +295,8 @@ test_files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/lib/with_asset_helpers.rb
+- spec/dummy/lib/wrapper/handlebars/with_wrapper.rb
+- spec/dummy/lib/wrapper/stache/with_wrapper.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html