mustache_rails3 0.1.2

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License
+
+Copyright (c) 2010 Michael Harrison  mh@michaelharrison.ws
+                   Paul Barry        
+                   Martin Gamsjaeger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/config/initializers/mustache.rb

@@ -0,0 +1,6 @@
+# Be sure to install mustache gem and include mustache gem in project Gemfile.
+
+# Template Handler
+require 'mustache_rails'
+# Generator
+Rails.application.config.generators.template_engine :mustache

data/lib/generators/mustache.rb

@@ -0,0 +1,9 @@
+class Mustache
+  module Generators
+    module TemplatePath
+      def source_root
+        @_mustache_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'mustache', generator_name, 'templates'))
+      end
+    end
+  end
+end

data/lib/generators/mustache/controller/controller_generator.rb

@@ -0,0 +1,39 @@
+require 'generators/mustache'
+require 'rails/generators/named_base'
+
+class Mustache
+  module Generators
+    class ControllerGenerator < ::Rails::Generators::NamedBase
+      extend TemplatePath
+      
+      argument :actions, :type => :array, :default => [], :banner => "action action"
+
+      def create_view_files
+        model_path                  = File.join(class_path, file_name)
+        
+        base_mustache_view_path     = File.join("app/views", model_path)
+        empty_directory base_mustache_view_path
+        
+        base_mustache_template_path = File.join("app/templates", model_path)
+        empty_directory base_mustache_template_path
+        
+        actions.each do |action|
+          @action  = action
+          mustache_view_path       = File.join(base_mustache_view_path,
+                                                "#{action}.rb")
+          mustache_template_path   = File.join(base_mustache_template_path,
+                                                "#{action}.html.mustache")
+          
+          template "view.rb.erb", mustache_view_path
+          template "view.html.mustache.erb", mustache_template_path                                   
+        end
+      end
+      
+      protected
+
+      def handler
+        :haml
+      end
+    end
+  end
+end

data/lib/generators/mustache/controller/templates/view.rb.erb

@@ -0,0 +1,3 @@
+class <%= singular_name.camelize %>::<%= @action.camelize %> < Mustache::Rails
+  
+end

data/lib/generators/mustache/install/install_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/mustache'
+
+class Mustache
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      extend TemplatePath
+
+      def copy_initializer_files
+        copy_file "config/initializers/mustache.rb", "config/initializers/mustache.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/mustache/install/templates/config/initializers/mustache.rb

@@ -0,0 +1,6 @@
+# Be sure to install mustache gem and include mustache gem in project Gemfile.
+
+# Template Handler
+require 'mustache_rails'
+# Generator
+Rails.application.config.generators.template_engine :mustache

data/lib/generators/mustache/scaffold/scaffold_generator.rb

@@ -0,0 +1,38 @@
+require 'generators/mustache'
+require 'rails/generators/erb/scaffold/scaffold_generator'
+
+class Mustache
+  module Generators
+    class ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
+      extend TemplatePath
+
+      # TODO Layout files? snusnu claims his template engine supports layouts:
+      # http://github.com/defunkt/mustache/issues/#issue/3/comment/263445
+
+      def copy_view_files
+        views = available_views
+        views.delete("index") if options[:singleton]
+
+        views.each do |view|                  
+          template "#{view}.rb.erb", 
+                   File.join("app/views", controller_file_path, "#{view}.rb")
+          template "#{view}.html.mustache.erb", 
+                   File.join("app/templates", 
+                             controller_file_path, 
+                             "#{view}.html.mustache")
+        end
+        template "_form.html.mustache.erb", 
+                   File.join("app/templates", 
+                             controller_file_path, 
+                             "_form.html.mustache")
+      end
+      
+      private
+      
+      def available_views
+        %w(index edit show new)
+      end
+
+    end
+  end
+end

data/lib/generators/mustache/scaffold/templates/_form.html.mustache.erb

@@ -0,0 +1,4 @@
+<p><% for attribute in attributes -%>
+{{{<%= attribute.name %>_label}}}: {{{<%= attribute.name %>_text_field}}}<br />
+<% end -%></p>
+  {{{form_submit}}}

data/lib/generators/mustache/scaffold/templates/edit.html.mustache.erb

@@ -0,0 +1,10 @@
+<p>Editing <%= singular_name.capitalize %></p>
+
+{{{errors_display_div}}}
+
+<hr />
+{{{<%= singular_name %>_form_tag}}}
+{{> form }}
+</form>
+<hr />
+<a href="{{show_path}}">Back to record</a>

data/lib/generators/mustache/scaffold/templates/edit.rb.erb

@@ -0,0 +1,53 @@
+class <%= plural_name.camelize %>::Edit < Mustache::Rails
+
+  <%# TODO: extract errors_display settings to to module methods -%>
+def errors_display_div
+    return "" unless <%= singular_name %>.errors.any?
+    content_tag("div", :id=>"errorExplanation", :class=>"errorExplanation") do
+      content_tag("h2", error_header) + content_tag("ul") do 
+        <%= singular_name %>.errors.full_messages.inject("") do |memo,msg|
+          memo += content_tag("li", msg)
+        end
+      end
+    end
+  end
+  
+def <%= singular_name %>_form_tag
+    form_tag(update_path, :class => "<%= singular_name %>_form", :method => :put, :id => "edit_<%= singular_name %>_#{<%= singular_name %>.id}_form")
+  end
+  
+<% for attribute in attributes -%>
+def <%= attribute.name %>_label
+    label :<%= singular_name %>, :<%= attribute.name %>
+  end
+  <%# TODO: Different fields for different attribute types -%>
+  
+def <%= attribute.name %>_text_field
+    text_field(:<%= singular_name %>, :<%= attribute.name %>, :id => "<%= attribute.name %>_text_field")
+  end
+
+<% end -%>
+
+  def form_submit
+    submit_tag "Update"
+  end
+  
+  def show_path
+    <%= singular_name %>_path(<%= singular_name %>)
+  end  
+  
+  def index_path
+    <%= plural_name %>_path
+  end
+  
+  private
+  
+  def update_path
+    <%= singular_name %>_path(<%= singular_name %>)
+  end
+  
+  def error_header
+    "u r dong it rong"
+  end
+  
+end

data/lib/generators/mustache/scaffold/templates/index.html.mustache.erb

@@ -0,0 +1,13 @@
+<p>Listing <%= plural_name.capitalize %></p>
+
+{{#listing}}
+
+<p>
+  <% attributes.collect do |attribute| -%>
+  <b><%= attribute.human_name %></b>: {{<%= attribute.name %>}}
+<% end.join(" | ") -%>
+| <a href="{{show_path}}">Details</a></p>
+
+{{/listing}}
+
+<p><a href="{{new_path}}">New</a></p>

data/lib/generators/mustache/scaffold/templates/index.rb.erb

@@ -0,0 +1,18 @@
+class <%= plural_name.camelize %>::Index < Mustache::Rails
+
+  def new_path
+    new_<%= singular_name %>_path()
+  end
+  
+  def listing
+    <%= plural_name %>.collect do |record|
+      {
+  <% for attribute in attributes -%>
+        :<%= attribute.name %> => record.<%= attribute.name %>,
+  <% end -%>
+        :show_path => <%= singular_name %>_path(record)
+      }
+    end
+  end
+  
+end

data/lib/generators/mustache/scaffold/templates/new.html.mustache.erb

@@ -0,0 +1,11 @@
+<p>New <%= singular_name.capitalize %></p>
+
+{{{errors_display_div}}}
+
+<hr />
+{{{<%= singular_name %>_form_tag}}}
+{{> form }}
+</form>
+<hr />
+
+<a href="{{index_path}}">Back to listing</a>

data/lib/generators/mustache/scaffold/templates/new.rb.erb

@@ -0,0 +1,50 @@
+class <%= plural_name.camelize %>::New < Mustache::Rails
+
+  <%# TODO: extract errors_display settings to to module methods -%>
+def errors_display_div
+    return "" unless <%= singular_name %>.errors.any?
+    content_tag("div", :id=>"errorExplanation", :class=>"errorExplanation") do
+      content_tag("h2", error_header) + content_tag("ul") do 
+        <%= singular_name %>.errors.full_messages.inject("") do |memo,msg|
+          memo += content_tag("li", msg)
+        end
+      end
+    end
+  end
+  
+def <%= singular_name %>_form_tag
+    form_tag(create_path, :class => "<%= singular_name %>_form", :id => "edit_<%= singular_name %>_#{<%= singular_name %>.id}_form")
+  end
+  
+<% for attribute in attributes -%>
+def <%= attribute.name %>_label
+    label :<%= singular_name %>, :<%= attribute.name %>
+  end
+  <%# TODO: Different fields for different attribute types -%>
+  
+def <%= attribute.name %>_text_field
+    text_field(:<%= singular_name %>, :<%= attribute.name %>, :id => "<%= attribute.name %>_text_field")
+  end
+
+<% end -%>
+
+  def form_submit
+    submit_tag "Create"
+  end
+
+  
+  def index_path
+    <%= plural_name %>_path
+  end
+  
+  private
+  
+  def create_path
+    <%= plural_name %>_path
+  end
+  
+  def error_header
+    "u r dong it rong"
+  end
+  
+end

data/lib/generators/mustache/scaffold/templates/show.html.mustache.erb

@@ -0,0 +1,7 @@
+<p>Displaying <%= singular_name.capitalize %></p>
+
+<% for attribute in attributes -%>
+<p><b><%= attribute.human_name %></b>: {{<%= attribute.name %>}}</p>
+<% end -%>
+
+<a href="{{edit_path}}">Edit</a> | <a href="{{index_path}}">Back</a>

data/lib/generators/mustache/scaffold/templates/show.rb.erb

@@ -0,0 +1,18 @@
+class <%= plural_name.camelize %>::Show < Mustache::Rails
+  
+  <% for attribute in attributes -%>
+  def <%= attribute.name %>
+    <%= singular_name %>.<%= attribute.name %>
+  end
+  
+  <% end -%>
+
+  def edit_path
+    edit_<%= singular_name %>_path(@<%= singular_name %>)
+  end
+  
+  def index_path
+    <%= plural_name %>_path
+  end
+  
+end

data/lib/mustache_rails.rb

@@ -0,0 +1,123 @@
+require 'action_view'
+require 'active_support'
+require 'mustache'
+
+class Mustache
+
+  # Remember to use {{{yield}}} (3 mustaches) to skip escaping HTML
+  # Using {{{tag}}} will skip escaping HTML so if your mustache methods return
+  # HTML, be sure to interpolate them using 3 mustaches.
+
+  class Rails < Mustache
+    attr_accessor :view
+
+    def method_missing(method, *args, &block)
+      view.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      super(method, include_private) || view.respond_to?(method, include_private)
+    end
+
+    # Redefine where Mustache::Rails templates locate their partials:
+    #
+    # (1) in the same directory as the current template file.
+    # (2) in the shared templates path (can be configured via Config.shared_path=(value))
+    #
+    def partial(name)
+      partial_name = "_#{name}.#{Config.template_extension}"
+      template_dir = Pathname.new(self.class.template_file).dirname
+      partial_path = File.expand_path("#{template_dir}/#{partial_name}")
+      unless File.file?(partial_path)
+        partial_path = "#{Config.shared_path}/#{partial_name}"
+      end
+      File.read(partial_path)
+    end
+
+    # You can change these defaults in, say, a Rails initializer or
+    # environment.rb, e.g.:
+    #
+    # Mustache::Rails::Config.template_base_path = Rails.root.join('app', 'templates')
+    module Config
+      def self.template_base_path
+        @template_base_path ||= ::Rails.root.join('app', 'templates')
+      end
+
+      def self.template_base_path=(value)
+        @template_base_path = value
+      end
+
+      def self.template_extension
+        @template_extension ||= 'html.mustache'
+      end
+
+      def self.template_extension=(value)
+        @template_extension = value
+      end
+
+      def self.shared_path
+        @shared_path ||= ::Rails.root.join('app', 'templates', 'shared')
+      end
+
+      def self.shared_path=(value)
+        @shared_path = value
+      end
+    end
+
+    class TemplateHandler < ActionView::Template::Handler
+
+      include ActionView::Template::Handlers::Compilable
+
+      self.default_format = :mustache
+
+      # @return [String] its evaled in the context of the action view
+      # hence the hack below
+      #
+      # @param [ActionView::Template]
+      def compile(template)
+        mustache_class = mustache_class_from_template(template)
+        mustache_class.template_file = mustache_template_file(template)
+        
+        <<-MUSTACHE
+          mustache = ::#{mustache_class}.new
+          mustache.view = self
+          mustache[:yield] = content_for(:layout)
+          mustache.context.update(local_assigns)
+          variables = controller.instance_variable_names
+          variables -= %w[@template]
+      
+          if controller.respond_to?(:protected_instance_variables)
+            variables -= controller.protected_instance_variables
+          end
+      
+          variables.each do |name|
+            mustache.instance_variable_set(name, controller.instance_variable_get(name))
+          end
+      
+          # Declaring an +attr_reader+ for each instance variable in the
+          # Mustache::Rails subclass makes them available to your templates.
+          mustache.class.class_eval do
+            attr_reader *variables.map { |name| name.sub(/^@/, '').to_sym }
+          end
+
+          mustache.render
+        MUSTACHE
+      end
+
+    private
+
+      def mustache_class_from_template(template)
+        const_name = ActiveSupport::Inflector.camelize(template.virtual_path.to_s)
+        defined?(const_name) ? const_name.constantize : Mustache
+      end
+
+      def mustache_template_file(template)
+        "#{Config.template_base_path}/#{template.virtual_path}.#{Config.template_extension}"
+      end
+
+    end
+  end
+end
+
+::ActiveSupport::Dependencies.load_paths << Rails.root.join("app", "views")
+::ActionView::Template.register_template_handler(:rb, Mustache::Rails::TemplateHandler)

data/readme.md

@@ -0,0 +1,35 @@
+## Mustache support for Rails 3
+
+This generator and template handler for Mustache in Rails 3 is based on the 
+work of Paul Barry, Louis T., and Martin Gamsjaeger. I am indebted to them for allowing me to stand on their shoulders.
+
+Subclass Mustache::Rails for your view files. Place view files in
+app/views/:controller/:action.rb. 
+
+Mustache::Rails registers a TemplateHandler for ".rb" files. Templates go in
+app/templates/:controller/:action.format.mustache
+
+This is also available as a [rubygem](http://rubygems.org/gems/mustache_rails3).
+
+I'm just getting started. This really is a low-numbered prerelease. :-) I have asked for comments on [the mustache project's Rails Support issue ticket](http://github.com/defunkt/mustache/issues/#issue/3/comment/294928). Please leave feedback there, and thanks.
+
+### Instructions
+
+A Rails 3 reminder: be sure to add 
+    gem 'mustache' 
+to your project's Gemfile before running any generators or starting the server.
+If you're using the mustache_rails3 gem, be sure to also add
+    gem 'mustache_rails3'
+
+You can enable the mustache template handler by running
+    rails g mustache:install
+in your project directory.
+
+### TODO:
+
+* Enable mustache layout usage (uses default application.erb for now)
+* Add controller-retrofit generator to build default mustache views for existing controllers
+* Generate different fields for different attribute types
+* Think about allowing to overwrite layout methods in subclassing views:
+  http://github.com/defunkt/mustache/blob/master/lib/mustache/sinatra.rb#L79-82
+  http://github.com/defunkt/mustache/blob/master/lib/mustache/sinatra.rb#L96-102

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: mustache_rails3
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Michael Harrison
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-28 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Mustache_rails3 is intended to add Rails 3 support to the existing mustache templating system for Ruby. It provides a template handler for Rails 3 and generators. The source code is maintained at http://github.com/goodmike/mustache_rails3, and I welcome comments and forks.
+email: mh@michaelharrison.ws
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- readme.md
+- LICENSE
+- config/initializers/mustache.rb
+- lib/generators/mustache.rb
+- lib/generators/mustache/controller/controller_generator.rb
+- lib/generators/mustache/controller/templates/view.html.mustache.erb
+- lib/generators/mustache/controller/templates/view.rb.erb
+- lib/generators/mustache/install/install_generator.rb
+- lib/generators/mustache/install/templates/config/initializers/mustache.rb
+- lib/generators/mustache/scaffold/scaffold_generator.rb
+- lib/generators/mustache/scaffold/templates/_form.html.mustache.erb
+- lib/generators/mustache/scaffold/templates/edit.html.mustache.erb
+- lib/generators/mustache/scaffold/templates/edit.rb.erb
+- lib/generators/mustache/scaffold/templates/index.html.mustache.erb
+- lib/generators/mustache/scaffold/templates/index.rb.erb
+- lib/generators/mustache/scaffold/templates/new.html.mustache.erb
+- lib/generators/mustache/scaffold/templates/new.rb.erb
+- lib/generators/mustache/scaffold/templates/show.html.mustache.erb
+- lib/generators/mustache/scaffold/templates/show.rb.erb
+- lib/mustache_rails.rb
+has_rdoc: true
+homepage: http://github.com/goodmike/mustache_rails3
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Mustache_rails3 provides a template handler and generators for Rails 3.
+test_files: []
+