stache 0.0.1

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.2-p180@stache_gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in stache.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Matt Wilson / Agora Games, LLC
+
+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/README.md

@@ -0,0 +1,65 @@
+# stache
+
+A Rails 3.x (yes, even Rails *3.1*) compatible Mustache Template Handler, with support for partials and a couple extra niceties to make sharing the raw templates with client-side javascript a little easier.
+
+## Usage
+
+    gem "stache"
+
+Install the gem. If you want to override any of the configuration options (see `stache/config`), toss an initializer in `config/initializers` and:
+
+```ruby
+Stache.config do |c|
+  c.template_base_path = "..."  # this is probably the one you'll want to change
+                                # it defaults to app/templates
+end
+    
+# or if the block style ain't yer thang, just:
+Stache.template_base_path = File.join(Rails.root, "app", "şablon")
+```
+
+There is as of right now one provided helper, `template_include_tag`. Give it the name of a partial and it will write it raw to a script block. On the todo list is the ability to customize this helper a little more :).
+
+## A View Class of your Very Own
+
+To facilitate easy integration, 'Stache comes packaged with a fully-functioning subclass of Mustache, called `Stache::View`. It will try to find a more appropriate view class to provide to the template renderer based on the template name, but if one cannot be found it will automatically give ya a `Stache::View` so you can have *something*.
+
+Needless to say, it's probably better if your custom View objects are subclasses of `Stache::View`. That way we can all be sure that the handler will render correctly.
+
+An example by way of explanation:
+
+With a template `app/templates/profiles/index`, Stache will look for a view named `Profiles::Index`, and, if not found, will just use the base `Stache::View`.
+
+## Of Note
+
+This is early code, ripped out from an upcoming project. It probably has some rough edges.
+
+TODO:
+
+* more and better integration tests
+* automated tests across different rails versions
+* other helpers, etc, as desired
+
+## Thanks to
+
+This project builds on work done by the following people and projects:
+
+* olivernn's [Poirot](https://github.com/olivernn/poirot)
+* goodmike's [mustache_rails3](https://github.com/goodmike/mustache_rails3)
+* nex3's [HAML](https://github.com/nex3/haml)
+
+So: thanks a ton to those guys.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Matt Wilson / Agora Games. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError
+  $stderr.puts "You must install bundler - run `gem install bundler`"
+end
+
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'bueller'
+Bueller::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:examples) do |examples|
+  examples.rspec_opts = '-Ispec'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rspec_opts = '-Ispec'
+  spec.rcov = true
+end
+
+task :default => :examples
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/stache.rb

@@ -0,0 +1,13 @@
+require "stache/version"
+require "stache/config"
+require "stache/util"
+require "stache/handler"
+require "stache/asset_helper"
+
+module Stache
+  extend Config
+  
+end
+
+ActionView::Template.register_template_handler(:mustache, Stache::Handler)
+ActionView::Base.send :include, Stache::AssetHelper

data/lib/stache/asset_helper.rb

@@ -0,0 +1,16 @@
+module Stache
+  module AssetHelper
+    # template_include_tag("widgets/basic_text_api_data")
+    # template_include_tag("shared/test_thing")
+    def template_include_tag(*sources)
+      sources.collect do |source|
+        exploded = source.split("/")
+        file = exploded.pop
+        file = file.split(".").first
+        template_path = ::Rails.root.join('app/views', *exploded, "_#{file}.html.mustache")
+        template = ::File.open(template_path, "rb")
+        content_tag(:script, template.read.html_safe, :type => "text/html", :id => "#{file.dasherize.underscore}_template")
+      end.join("\n").html_safe
+    end
+  end
+end

data/lib/stache/config.rb

@@ -0,0 +1,31 @@
+module Stache
+  # Change these defaults in, say, an initializer.
+  #
+  # Stache.template_base_path = Rails.root.join('app', 'templates')
+  #
+  # Or with the block syntax:
+  #
+  # Stache.configure do |config|
+  #   config.template_base_path = Rails.root.join('app', 'views', 'shared')
+  # end
+  module Config
+    attr_accessor :template_base_path, :template_extension, :shared_path
+    
+    def configure
+      yield self
+    end
+    
+    
+    def template_base_path
+      @template_base_path ||= ::Rails.root.join('app', 'templates')
+    end
+
+    def template_extension
+      @template_extension ||= 'html.mustache'
+    end
+
+    def shared_path
+      @shared_path ||= ::Rails.root.join('app', 'templates', 'shared')
+    end
+  end
+end

data/lib/stache/handler.rb

@@ -0,0 +1,62 @@
+require 'stache/view'
+
+module Stache
+  # From HAML, thanks a bunch, guys!
+  # In Rails 3.1+, template handlers don't inherit from anything. In <= 3.0, they do.
+  # To avoid messy logic figuring this out, we just inherit from whatever the ERB handler does.
+  class Handler < Stache::Util.av_template_class(:Handlers)::ERB.superclass
+    if Stache::Util.needs_compilable?
+      include Stache::Util.av_template_class(:Handlers)::Compilable
+    end
+    
+    # Thanks to Mustache::Rails3 for getting us most of the way home here
+    def compile(template)
+      #
+      # get a custom Mustache, or the default Stache::View
+      mustache_class = mustache_class_from_template(template)
+    
+      # Return a string that will be eval'd in the context of the ActionView, ugly, but it works.
+      <<-MUSTACHE
+        mustache = ::#{mustache_class}.new
+        mustache.view = self
+        mustache.template = '#{template.source.gsub(/'/, "\\\\'")}'
+        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
+        # Stache::View subclass makes them available to your templates.
+        mustache.class.class_eval do
+          attr_reader *variables.map { |name| name.sub(/^@/, '').to_sym }
+        end
+
+        mustache.render.html_safe
+      MUSTACHE
+    end
+  
+    # In Rails 3.1+, #call takes the place of #compile
+    def self.call(template)
+      new.compile(template)
+    end
+
+    # suss out a constant name for the given template
+    def mustache_class_from_template(template)
+      const_name = ActiveSupport::Inflector.camelize(template.virtual_path.to_s)
+      begin
+        const_name.constantize
+      rescue NameError
+        Stache::View
+      end
+    end
+
+  end
+end

data/lib/stache/util.rb

@@ -0,0 +1,31 @@
+module Stache
+  # Basically a dumping ground for code that didn't fit anywhere else
+  module Util
+    # From HAML
+    # Returns an ::ActionView::Template* class.
+    # In pre-3.0 versions of Rails, most of these classes
+    # were of the form `::ActionView::TemplateFoo`,
+    # while afterwards they were of the form `::ActionView::Template::Foo`.
+    #
+    # @param name [#to_s] The name of the class to get.
+    #   For example, `:Error` will return `::ActionView::TemplateError`
+    #   or `::ActionView::Template::Error`.
+    def self.av_template_class(name)
+      if ::ActionView::Template.const_defined?(name)
+        ::ActionView::Template.const_get(name)
+      else
+        ::ActionView.const_get("Template#{name}")
+      end
+    end
+    
+    def self.needs_compilable?
+      (
+        (defined?(::ActionView::TemplateHandlers) && defined?(::ActionView::TemplateHandlers::Compilable)) ||
+        (defined?(::ActionView::Template) && defined?(::ActionView::Template::Handlers) && defined?(::ActionView::Template::Handlers::Compilable))
+      ) &&
+        # In Rails 3.1+, we don't need to include Compilable.
+      Stache::Util.av_template_class(:Handlers)::ERB.include?( Stache::Util.av_template_class(:Handlers)::Compilable )
+      
+    end
+  end
+end

data/lib/stache/version.rb

@@ -0,0 +1,3 @@
+module Stache
+  VERSION = "0.0.1"
+end

data/lib/stache/view.rb

@@ -0,0 +1,35 @@
+module Stache
+  #
+  # A Convienent Base Class for the views. Subclass this for autoloading magic with your templates.
+  #
+  # e.g. if the handler is loading a template from templates/
+  class View < Mustache
+    attr_accessor :view, :template
+
+    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 Stache::View 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}.#{Stache.template_extension}"
+      template_dir = Pathname.new(self.class.template_file).dirname
+      partial_path = File.expand_path(File.join(Stache.template_base_path, template_dir, partial_name))
+      unless File.file?(partial_path)
+        partial_path = "#{Stache.shared_path}/#{partial_name}"
+      end
+      
+      # ::Rails.logger.info "LOADING PARTIAL: #{partial_path}"
+      File.read(partial_path)
+    end
+    
+  end
+end

data/spec/controllers/stache_controller_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe StacheController do
+  render_views
+  
+  it "can get to index and render a Mustache" do
+    get :index
+    assert_response 200
+
+    response.should render_template 'index'               # view
+    response.body.should =~ /Hello, Matt!/
+  end
+  
+  it "correctly renders partials" do
+    get :with_partials
+    assert_response 200
+    
+    response.body.should =~ /Grue/
+    # puts response.body
+  end
+  
+  
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

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

@@ -0,0 +1,13 @@
+class StacheController < ApplicationController
+  
+  def index
+    @user = params[:user] || "Matt"
+    # index.html.mustache
+  end
+  
+  def with_partials
+    @user = params[:user] || "Matt"
+    @thing = "Grue"
+  end
+  
+end