petroglyph 0.0.1 → 0.0.2

data/README.md

@@ -77,9 +77,20 @@ This can be overridden by re-implementing the `Petroglyph.partial(name)` method.
       partial :tea, :tea => tea
     end
 
+## Rails 3
+
+In your controller:
+
+    render 'index', :locals => {:teas => teas}, :layout => false
+
+Support for partials is non-standard at this time: create a subdirectory in the directory that your template lives in and call it `partials`.
+
+
 ## Caveat
 
-We've removed support for using instance variables (from the controller) in the template, as this was hacky and not optimal.
+There is currently no support for instance variables in Sinatra and Rails 3.
+
+Avoid using `post` as a local variable name in sinatra. Since the template context in sinatra is the controller, calling `post` from your template will call the http `post` action. Same goes for `get`, `head`, `put`, etc, but these are less likely to be resources in your application.
 
 ## Related Projects
 

data/lib/petroglyph.rb

@@ -2,9 +2,13 @@ require 'json'
 
 require 'petroglyph/scope'
 require 'petroglyph/engine'
+require 'petroglyph/railtie' if defined?(Rails) && Rails.version =~ /^3/
 
 module Petroglyph
   class << self
+    def register!
+      require 'petroglyph/template'
+    end    
     def partial(filename, template_filename)
       basedir = File.dirname(template_filename)
       [basedir, "#{basedir}/partials"].each do |dir|
@@ -15,3 +19,10 @@ module Petroglyph
     end
   end
 end
+
+if defined?(Padrino)
+  require 'padrino-core'
+  Padrino.after_load { Petroglyph.register! }
+elsif defined?(Rails) && Rails.version =~ /^2/
+  Petroglyph.register!
+end

data/lib/petroglyph/engine.rb

@@ -6,13 +6,16 @@ module Petroglyph
     end
 
     def render(context = Object.new, locals = {}, file = nil, &block)
+      to_hash(locals, file, context, &block).to_json
+    end
+
+    def to_hash(locals = {}, file = nil, context = Object.new, &block)
       scope = Scope.new(context, locals, file)
-      if @data
-        scope.instance_eval(@data)
-      else
-        scope.instance_eval(&block)
-      end
-      scope.value.to_json
+
+      scope.instance_eval(@data) if @data
+      scope.instance_eval(&block) if block_given?
+
+      scope.value
     end
   end
 end

data/lib/petroglyph/railtie.rb

@@ -0,0 +1,10 @@
+module Petroglyph
+  class Railtie < Rails::Railtie
+
+    initializer "petroglyph.initialize" do |app|
+      ActiveSupport.on_load(:action_view) do
+        Petroglyph.register!
+      end
+    end
+  end
+end

data/lib/petroglyph/scope.rb

@@ -5,6 +5,7 @@ module Petroglyph
     def initialize(context = nil, locals = {}, template_filename = nil, parent_scope = nil)
       @file = template_filename
       @context = context
+      self.copy_instance_variables_from(@context, [:@assigns, :@helpers]) if self.respond_to?(:copy_instance_variables_from)
       @locals = locals
       @parent_scope = parent_scope
       @value = nil
@@ -81,7 +82,7 @@ module Petroglyph
     end
 
     def method_missing(method, *args, &block)
-      if @locals.has_key?(method)
+      if @locals and @locals.has_key?(method)
         @locals[method]
       elsif @context.respond_to?(method)
         @context.send(method)

data/lib/petroglyph/template.rb

@@ -0,0 +1,64 @@
+# TILT Template
+if defined?(Tilt)
+  class PetroglyphTemplate < Tilt::Template
+    def initialize_engine
+      return if defined?(::Petroglyph)
+      require_template_library 'petroglyph'
+    end
+
+    def prepare
+      options = @options.merge(:source_location => file)
+      @engine = ::Petroglyph::Engine.new(data, options)
+    end
+
+    def evaluate(scope, locals, &block)
+      @engine.render(scope, locals, &block)
+    end
+  end
+
+  Tilt.register 'pg', PetroglyphTemplate
+end
+
+# Rails 2.X Template
+if defined?(Rails) && Rails.version =~ /^2/
+  require 'action_view/base'
+  require 'action_view/template'
+
+  module ActionView
+    module TemplateHandlers
+      class PetroglyphHandler < TemplateHandler
+        include Compilable
+
+        def compile(template) %{
+          ::Petroglyph::Engine.new(#{template.source.inspect}).
+            render(self, assigns.merge(local_assigns), '#{template.filename}')
+        } end
+      end
+    end
+  end
+
+  ActionView::Template.register_template_handler :pg, ActionView::TemplateHandlers::PetroglyphHandler
+end
+
+# Rails 3.X Template
+if defined?(Rails) && Rails.version =~ /^3/
+  module ActionView
+    module Template::Handlers
+      class Petroglyph
+
+        def call(template)
+          source = if template.source.empty?
+            File.read(template.identifier)
+          else
+            template.source
+          end
+
+          %{ ::Petroglyph::Engine.new(#{source.inspect}).
+              render(self, assigns.merge(local_assigns), '#{template.identifier}') }
+        end
+      end
+    end
+  end
+
+  ActionView::Template.register_template_handler :pg, ActionView::Template::Handlers::Petroglyph.new
+end

data/lib/petroglyph/version.rb

@@ -1,3 +1,3 @@
 module Petroglyph
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/engine_spec.rb

@@ -1,6 +1,11 @@
 require 'spec_helper'
 
 describe Petroglyph::Engine do
+  specify "#to_hash" do
+    engine = Petroglyph::Engine.new('node :whatever => thing')
+    engine.to_hash({:thing => 'stuff'}).should eq({:whatever => 'stuff'})
+  end
+
   it "takes a template" do
     engine = Petroglyph::Engine.new('node :whatever => "nevermind"')
     engine.render.should eq({:whatever => "nevermind"}.to_json)

data/spec/sinatra_integration_spec.rb

@@ -30,8 +30,12 @@ describe "Sinatra integration" do
     last_response.body.should eq '{"drinks":[{"type":"tea","temperature":"hot"},{"type":"coffee","temperature":"lukewarm"}]}'
   end
 
-  xit "doesn't freak out on the HTTP method" do
-    post '/'
-    last_response.body.should eq '{}'
+  it "overshadows the controller methods" do
+    # look at /views/fixtures/post.pg
+    # and line 18 of this file
+    pending "right now if you refer to a local var 'post' in the template, you will accidentally call sinatra's post method" do
+      post '/'
+      last_response.body.should eq "{\"post\":\"a post\"}"
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: petroglyph
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-20 00:00:00.000000000Z
+date: 2012-03-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &2161013440 !ruby/object:Gem::Requirement
+  requirement: &70204971169420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161013440
+  version_requirements: *70204971169420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2161013020 !ruby/object:Gem::Requirement
+  requirement: &70204971169000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161013020
+  version_requirements: *70204971169000
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2161012600 !ruby/object:Gem::Requirement
+  requirement: &70204971168580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161012600
+  version_requirements: *70204971168580
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2161012180 !ruby/object:Gem::Requirement
+  requirement: &70204971168160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161012180
+  version_requirements: *70204971168160
 description: A simple, terse, and unsurprising ruby dsl to create json views.
 email:
 - katrina.owen@gmail.com
@@ -70,7 +70,9 @@ files:
 - Rakefile
 - lib/petroglyph.rb
 - lib/petroglyph/engine.rb
+- lib/petroglyph/railtie.rb
 - lib/petroglyph/scope.rb
+- lib/petroglyph/template.rb
 - lib/petroglyph/version.rb
 - lib/sinatra/petroglyph.rb
 - lib/tilt/petroglyph.rb