RubyGems - adzap-mustache-rails - Versions diffs - 0.2.3 - Mend

adzap-mustache-rails 0.2.3

Files changed (8) hide show

data/README.md +82 -0
data/lib/action_view/helpers/mustache_helper.rb +105 -0
data/lib/action_view/mustache.rb +77 -0
data/lib/action_view/mustache/context.rb +75 -0
data/lib/action_view/mustache/generator.rb +123 -0
data/lib/action_view/template/handlers/mustache.rb +43 -0
data/lib/mustache/railtie.rb +89 -0
metadata +99 -0

data/README.md ADDED

@@ -0,0 +1,82 @@
+# Mustache Rails
+Implements Mustache views and templates for Rails 3.x
+## Installation
+``` ruby
+gem 'mustache-rails', :require => 'mustache/railtie'
+```
+Or alternatively `require 'mustache/railtie'` in your `config/application.rb`.
+## Usage
+In typical mustache fashion, `.mustache` templates go under `app/templates` and view `.rb` files go under `app/views`. Any view classes will be looked for under the `::Views` modules.
+Simple template scaffolding:
+``` ruby
+# app/views/layouts/application.rb
+module Views
+  module Layouts
+    class Application < ActionView::Mustache
+      def title
+        "Hello"
+      end
+    end
+  end
+end
+```
+``` mustache
+{{ ! app/templates/layouts/application.mustache }}
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <title>{{title}}</title>
+</head>
+<body>
+  {{yield}}
+</body>
+</html>
+```
+``` ruby
+# app/views/users/show.rb
+module Views
+  module Users
+    class Show < Layouts::Application
+      attr_reader :user
+    end
+  end
+end
+```
+``` mustache
+{{ ! app/templates/users/show.mustache }}
+{{#user}}
+  <h1>{{name}}</h1>
+{{/user}}
+```
+### Optional Configuration
+``` ruby
+# config/application.rb
+module Foo
+  class Application < Rails::Application
+    # Config defaults
+    config.mustache.template_path = "app/templates"
+    config.mustache.view_path = "app/views"
+    config.mustache.view_namespace = "::Views"
+  end
+end
+```
+## License
+Copyright &copy; 2012 Joshua Peek.
+Released under the MIT license. See `LICENSE` for details.

data/lib/action_view/helpers/mustache_helper.rb ADDED

@@ -0,0 +1,105 @@
+require 'active_support/concern'
+require 'action_view'
+require 'action_view/base'
+require 'action_view/helpers'
+require 'action_view/mustache'
+module ActionView
+  module Helpers
+    # Public: Standard helper mixed into ActionView context for
+    # constructing the Mustache View.
+    module MustacheHelper
+      extend ActiveSupport::Concern
+      included do
+        # PID: Storing our view namespace settings on a class variable
+        # is kinda nasty. It'd better to avoid the global and always
+        # use our application's config object.
+        cattr_accessor :mustache_view_namespace
+        # Default class to use if no view class is found.
+        # A nil value will raise an exception.
+        cattr_accessor :mustache_default_view_class
+      end
+      # Public: Get Mustache View Class for template.
+      #
+      # Choose template class by camalizing the template path name and
+      # prefixing our view namespace.
+      #
+      # The class must be a subclass of ActionView::Mustache
+      # otherwise a TypeError will be raised.
+      #
+      # If the template is "anonymous" and has no path, which is the
+      # case for render(:inline), the default ActionView::Mustache
+      # base class will be returned.
+      #
+      # Examples
+      #
+      #     "blog/show" => Blog::Show
+      #
+      # Returns Class or raises a TypeError.
+      def mustache_view_class
+        if @virtual_path
+          begin
+            klass = "#{mustache_view_namespace}/#{@virtual_path}"
+            load_mustache_view_class_name(klass)
+          rescue NameError => e
+            if klass = mustache_default_view_class
+              load_mustache_view_class_name(klass)
+            else
+              raise e
+            end
+          end
+        else
+          if klass = mustache_default_view_class
+            load_mustache_view_class_name(klass)
+          else
+            ActionView::Mustache
+          end
+        end
+      end
+      # Internal: Load Mustache View class.
+      #
+      # klass_name - Actual Class or String of class name.
+      #
+      # Returns view class that is a subclass of ActionView::Mustache
+      # or raises an exception.
+      def load_mustache_view_class_name(klass_name)
+        case klass_name
+        when String
+          klass_name = klass_name.camelize
+          begin
+            klass = klass_name.constantize
+          rescue NameError => e
+            load_path = ActiveSupport::Dependencies.autoload_paths.map { |p| "  #{p}\n" }.join
+            raise NameError, "Couldn't find #{klass_name}\n#{load_path}"
+          end
+        when Class
+          klass = klass_name
+        else
+          raise ArgumentError, "#{klass_name} isn't a Class"
+        end
+        unless klass < ActionView::Mustache
+          raise TypeError, "#{klass} isn't a subclass of ActionView::Mustache"
+        end
+        klass
+      end
+      # Public: Get or initialize Mustache View.
+      #
+      # The view object is cached so partial renders will reuse the
+      # same instance.
+      #
+      # Returns a Mustache View which is a subclass of
+      # ActionView::Mustache.
+      def mustache_view
+        @_mustache_view ||= mustache_view_class.new(self)
+      end
+    end
+  end
+  Base.send :include, Helpers::MustacheHelper
+end

data/lib/action_view/mustache.rb ADDED

@@ -0,0 +1,77 @@
+require 'action_view'
+require 'mustache'
+require 'action_view/mustache/context'
+module ActionView
+  # Public: Mustache View base class.
+  #
+  # All Mustache views MUST inherit from this class.
+  #
+  # Examples
+  #
+  #     module Layouts
+  #       class Application < ActionView::Mustache; end
+  #     end
+  #
+  class Mustache < ::Mustache
+    # Internal: Initializes Mustache View.
+    #
+    # Initialization is handled by MustacheHelper#mustache_view.
+    #
+    # view - ActionView::Base instance
+    #
+    # Returns ActionView::Mustache instance.
+    def initialize(view)
+      # Reference to original ActionView context.
+      @_view = view
+      # Grab template path from view
+      self.template_name = view.instance_variable_get(:@virtual_path)
+      # If view has an associated controller
+      if controller = view.controller
+        # Copy controller ivars into our view
+        controller.view_assigns.each do |name, value|
+          instance_variable_set '@'+name, value
+        end
+      end
+      # Define `yield` keyword for content_for :layout
+      context[:yield] = lambda { content_for :layout }
+    end
+    # Remove Mustache's render method so ActionView's render can be
+    # delegated to.
+    undef_method :render
+    # Public: Get view context.
+    #
+    # Returns ActionView::Mustache::Context instance.
+    def context
+      @context ||= Context.new(self)
+    end
+    # Public: Get cache key for current template contents.
+    #
+    # Useful for busting caches when the template changes.
+    #
+    # Returns 10 hex char String.
+    def template_cache_key
+      context[:template_cache_key]
+    end
+    # Public: Forwards methods to original Rails view context
+    #
+    # Returns an Object.
+    def method_missing(*args, &block)
+      @_view.send(*args, &block)
+    end
+    # Public: Checks if method exists in Rails view context.
+    #
+    # Returns Boolean.
+    def respond_to?(method, include_private = false)
+      super || @_view.respond_to?(method, include_private)
+    end
+  end
+end

data/lib/action_view/mustache/context.rb ADDED

@@ -0,0 +1,75 @@
+require 'action_view'
+require 'mustache'
+module ActionView
+  class Mustache < ::Mustache
+    # Internal: Override Mustache's default Context class
+    class Context < ::Mustache::Context
+      # Partials are no longer routed through Mustache but through
+      # ActionView's own render method.
+      undef_method :partial
+      # Escape helper isn't used, its all handled by Rails' SafeBuffer
+      # auto escaping.
+      undef_method :escapeHTML
+      # Internal: Evaluate section block.
+      #
+      # view   - ActionView::Context instance
+      # buffer - ActiveSupport::SafeBuffer object
+      # value  - Object value of section tag
+      #
+      # Returns nothing.
+      def _eval_section(view, buffer, value, &block)
+        if value
+          if value == true
+            yield
+          elsif value.is_a?(Proc)
+            buffer.concat(value.call { view.capture(&block) }.to_s)
+          else
+            value = [value] unless value.is_a?(Array) || defined?(Enumerator) && value.is_a?(Enumerator)
+            for h in value
+              push(h)
+              yield
+              pop
+            end
+          end
+        end
+      end
+      # Internal: Evaluate inverted section block.
+      #
+      # buffer - ActiveSupport::SafeBuffer object
+      # value  - Object value of inverted section tag
+      #
+      # Returns nothing.
+      def _eval_inverted_section(buffer, value)
+        if (value.nil? || value == false || value.respond_to?(:empty?) && value.empty?)
+          yield
+        end
+      end
+      # Internal: Evaluate unescaped tag.
+      #
+      # buffer - ActiveSupport::SafeBuffer object
+      # value  - Object value of tag
+      #
+      # Returns nothing.
+      def _eval_utag(buffer, value)
+        value = value.call.to_s if value.is_a?(Proc)
+        buffer.safe_concat(value.to_s)
+      end
+      # Internal: Evaluate escaped tag.
+      #
+      # buffer - ActiveSupport::SafeBuffer object
+      # value  - Object value of tag
+      #
+      # Returns nothing.
+      def _eval_etag(buffer, value)
+        value = value.call.to_s if value.is_a?(Proc)
+        buffer.concat(value.to_s)
+      end
+    end
+  end
+end

data/lib/action_view/mustache/generator.rb ADDED

@@ -0,0 +1,123 @@
+require 'action_view'
+require 'action_view/mustache'
+require 'mustache'
+module ActionView
+  class Mustache < ::Mustache
+    # Public: Compiles tokens from Mustache::Parser into evaluatable
+    # Ruby code.
+    #
+    # The code generate targets Rails output buffer and must be
+    # evaluated inside an ActionView::Base instance.
+    #
+    # See Mustache::Generator for more info.
+    class Generator
+      # Public: Convert tokens to plain old Ruby.
+      #
+      # exp - Array of tokens produced by Mustache::Parser
+      #
+      # Returns String of compiled Ruby code.
+      def compile(exp)
+        src = ""
+        src << "@output_buffer = output_buffer || ActionView::OutputBuffer.new; "
+        src << compile!(exp)
+        src << "@output_buffer.to_s;"
+        src
+      end
+      # Internal: Recursively compile token expression.
+      #
+      # exp - Token Array structure
+      #
+      # Returns String.
+      def compile!(exp)
+        case exp.first
+        when :multi
+          exp[1..-1].map { |e| compile!(e) }.join
+        when :static
+          text(exp[1])
+        when :mustache
+          send("on_#{exp[1]}", *exp[2..-1])
+        else
+          raise "Unhandled exp: #{exp.first}"
+        end
+      end
+      # Internal: Compile section.
+      #
+      # name    - String of section name
+      # content - Array of section content tokens
+      #
+      # Returns String.
+      def on_section(name, content, raw, delims)
+        "v = #{compile!(name)}; ctx._eval_section(self, @output_buffer, v) {\n#{compile!(content)}\n}; "
+      end
+      # Internal: Compile inverted section.
+      #
+      # name    - String of section name
+      # content - Array of section content tokens
+      #
+      # Returns String.
+      def on_inverted_section(name, content, raw, delims)
+        "v = #{compile!(name)}; ctx._eval_inverted_section(@output_buffer, v) {\n#{compile!(content)}\n}; "
+      end
+      # Internal: Compile partial render call.
+      #
+      # name        - String of partial name
+      # indentation - String of indentation level
+      #
+      # Returns String.
+      def on_partial(name, indentation)
+        "@output_buffer.concat(render(:partial => #{name.inspect}));\n"
+      end
+      # Internal: Compile unescaped tag.
+      #
+      # name - String name of tag
+      #
+      # Returns String.
+      def on_utag(name)
+        "v = #{compile!(name)}; ctx._eval_utag(@output_buffer, v); "
+      end
+      # Internal: Compile escaped tag.
+      #
+      # name - String name of tag
+      #
+      # Returns String.
+      def on_etag(name)
+        "v = #{compile!(name)}; ctx._eval_etag(@output_buffer, v); "
+      end
+      # Internal: Compile fetch lookup.
+      #
+      # names - Array of names to fetch.
+      #
+      # Returns String.
+      def on_fetch(names)
+        names = names.map { |n| n.to_sym }
+        if names.length == 0
+          "ctx[:to_s]"
+        elsif names.length == 1
+          "ctx[#{names.first.to_sym.inspect}]"
+        else
+          initial, *rest = names
+          "#{rest.inspect}.inject(ctx[#{initial.inspect}]) { |v, k| v && ctx.find(v, k) }; "
+        end
+      end
+      # Internal: Compile static string.
+      #
+      # text - String of text.
+      #
+      # Returns String.
+      def text(text)
+        text = text.gsub(/['\\]/, '\\\\\&')
+        "@output_buffer.safe_concat('#{text}'); "
+      end
+    end
+  end
+end

data/lib/action_view/template/handlers/mustache.rb ADDED

@@ -0,0 +1,43 @@
+require 'action_view'
+require 'action_view/template'
+require 'action_view/template/handlers'
+require 'action_view/helpers/mustache_helper'
+require 'action_view/mustache'
+require 'action_view/mustache/generator'
+require 'mustache'
+require 'digest/md5'
+module ActionView
+  class Template
+    module Handlers
+      # Public: Mustache template compiler.
+      #
+      # Requiring this file should automatically register the template
+      # handler, so there should be no need to reference the class
+      # directly.
+      class Mustache
+        # Public: Compile template into Ruby.
+        #
+        # template - ActionView::Template object
+        #
+        # Returns String of Ruby code to be evaled.
+        def self.call(template)
+          # Use standard mustache parser to generate tokens
+          tokens = ::Mustache::Parser.new.compile(template.source)
+          # Use custom generator to generate the compiled ruby
+          src = ActionView::Mustache::Generator.new.compile(tokens)
+          digest = Digest::MD5.hexdigest(template.source)[0, 10]
+          set_cache_key = "merge({:template_cache_key => \"#{digest}\"})"
+          <<-RUBY
+            ctx = mustache_view.context; begin; ctx.push(local_assigns.#{set_cache_key}); #{src}; ensure; ctx.pop; end
+          RUBY
+        end
+      end
+    end
+    register_template_handler :mustache, Handlers::Mustache
+  end
+end

data/lib/mustache/railtie.rb ADDED

@@ -0,0 +1,89 @@
+require 'mustache'
+require 'rails/railtie'
+class Mustache
+  # Railtie initializer for Rails 3.x and higher.
+  #
+  # Either add a require to the top of your `config/application.rb`
+  #
+  #     require "mustache/rails"
+  #
+  # Or setup an auto-require in your Gemfile
+  #
+  #     gem "mustache-rails", :require => "mustache/railtie"
+  #
+  class Railtie < Rails::Railtie
+    # Public: Application configuration object.
+    #
+    # Defaults can be modified in your `config/application.rb`.
+    config.mustache = ActiveSupport::OrderedOptions.new
+    # Public: Relative path to .mustache template files.
+    #
+    # Defaults to "app/templates". Its highly recommended to keep the
+    # default value.
+    #
+    # Returns String.
+    config.mustache.template_path = "app/templates"
+    # Public: Relative path to mustache view classes.
+    #
+    # Defaults to "app". Since "::Views::Blog::Show" will
+    # automatically look up "app/" + "views/blog/show".
+    #
+    # If you want to drop the namespace, this should be set to
+    # "app/views".
+    #
+    # Returns String.
+    config.mustache.view_path = "app"
+    # Public: Namespace to look for mustache view classes under.
+    #
+    # Defaults to "::Views". You may want to drop this namespace by
+    # setting the value to "".
+    #
+    # The value may also be set to a Class, but a String is
+    # recommended for lazily loading.
+    #
+    # Returns String or Class.
+    config.mustache.view_namespace = "::Views"
+    # Public: Set default Mustache View class to use if none is found.
+    #
+    # Defaults to "nil" which means an exception will be raised with
+    # the class it expected to find. This can be useful during
+    # development or when your just getting started.
+    #
+    # Setting a String or Class will cause the class to be used as a
+    # fallback anytime the expected view class lookup fails.
+    #
+    # Returns nil, String or Class.
+    config.mustache.default_view_class = nil
+    # Internal: Ensures view path is included in autoload path.
+    initializer 'mustache.add_autoload_paths', :before => :set_autoload_paths do |app|
+      app.config.autoload_paths << app.root.join(app.config.mustache.view_path).to_s
+    end
+    # Internal: Adds .mustache template path to ActionController's view paths.
+    initializer 'mustache.add_view_paths', :after => :add_view_paths do |app|
+      ActiveSupport.on_load(:action_controller) do
+        append_view_path app.root.join(app.config.mustache.template_path).to_s
+      end
+    end
+    # Internal: Assigns configured view namespace to ActionView context.
+    initializer 'mustache.set_view_namespace' do |app|
+      ActiveSupport.on_load(:action_view) do
+        require 'action_view/template/handlers/mustache'
+        require 'action_view/helpers/mustache_helper'
+        # PID: Setting a global on ActionView::Base is kinda nasty.
+        # It'd be better if ApplicationController could reference its
+        # local app configuration.
+        ActionView::Base.mustache_view_namespace = app.config.mustache.view_namespace
+        ActionView::Base.mustache_default_view_class = app.config.mustache.default_view_class
+      end
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: adzap-mustache-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+  prerelease:
+platform: ruby
+authors:
+- Joshua Peek
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.99.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.99.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implements Mustache views and templates for Rails 3.x
+email: josh@joshpeek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/action_view/helpers/mustache_helper.rb
+- lib/action_view/mustache/context.rb
+- lib/action_view/mustache/generator.rb
+- lib/action_view/mustache.rb
+- lib/action_view/template/handlers/mustache.rb
+- lib/mustache/railtie.rb
+homepage: https://github.com/josh/mustache-rails
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.23
+signing_key:
+specification_version: 3
+summary: Mustache Rails adapter
+test_files: []