petroglyph 0.0.5 → 0.0.6

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+
+script: rspec spec

data/README.md

@@ -2,6 +2,9 @@
 
 A simple, terse, and unsurprising ruby dsl to create json views.
 
+[![Build Status](https://secure.travis-ci.org/kytrinyx/petroglyph.png?branch=master)](http://travis-ci.org/kytrinyx/petroglyph)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kytrinyx/petroglyph)
+
 ## Usage
 
 Add a node with a simple value:
@@ -85,13 +88,18 @@ In your controller:
 
 Support for partials is non-standard at this time: create a subdirectory in the directory that your template lives in and call it `partials`.
 
+## Sinatra
+
+This works with version 1.3 of Sinatra. It may work with earlier versions.
+
+There is a known incompatibility in Sinatra versions prior to 1.3 where a local variable named `post` will crash with Sinatra's HTTP `post` action.
+The same goes for `get`, `head`, `put`, etc, but these are less likely to be resources in your application.
+
 
 ## Caveat
 
 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
 
 Other json templating libraries exist, some of which also generate XML.

data/lib/petroglyph/version.rb

@@ -1,3 +1,3 @@
 module Petroglyph
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/petroglyph.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency "tilt"
   s.add_development_dependency "rspec"
-  s.add_development_dependency "sinatra"
+  s.add_development_dependency "sinatra", ">= 1.3"
   s.add_development_dependency "rack-test"
 end

data/spec/engine_spec.rb

@@ -1,24 +1,24 @@
 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'})
+  specify "#to_hash takes local variables and passes them to the template" do
+    engine = Petroglyph::Engine.new('node :beverage => drink')
+    engine.to_hash({:drink => 'espresso'}).should eq({:beverage => 'espresso'})
   end
 
   it "takes a template" do
-    engine = Petroglyph::Engine.new('node :whatever => "nevermind"')
-    engine.render.should eq({:whatever => "nevermind"}.to_json)
+    engine = Petroglyph::Engine.new('node :beverage => "no, thanks"')
+    engine.render.should eq({:beverage => "no, thanks"}.to_json)
   end
 
   it "takes a block" do
     Petroglyph::Engine.new.render do
-      node :whatever => "nevermind"
-    end.should eq({:whatever => "nevermind"}.to_json)
+      node :beverage => "hot chocolate"
+    end.should eq({:beverage => "hot chocolate"}.to_json)
   end
 
   it "passes the locals" do
-    engine = Petroglyph::Engine.new('node :whatever => thing')
-    engine.render(nil, {:thing => 'stuff'}).should eq({:whatever => 'stuff'}.to_json)
+    engine = Petroglyph::Engine.new('node :beverage => drink')
+    engine.render(nil, {:drink => 'bai mu cha'}).should eq({:beverage => 'bai mu cha'}.to_json)
   end
 end

data/spec/fixtures/views/partials/nested_partial.pg

@@ -1 +1 @@
- partial :the_partial, :thing => 'stuff'
+ partial :the_partial, :drink => 'stuff'

data/spec/fixtures/views/the_partial.pg

@@ -1 +1 @@
-node :thing => thing
+node :beverage => drink

data/spec/fixtures/views/with_partial.pg

@@ -1,3 +1,3 @@
 node :root do
-  partial :the_partial, :thing => 'stuff'
+  partial :the_partial, :drink => 'stuff'
 end

data/spec/scope_spec.rb

@@ -2,223 +2,227 @@ require 'spec_helper'
 
 describe Petroglyph::Scope do
 
-  it "takes a simple string value" do
+  it 'takes a simple string value' do
     scope = Petroglyph::Scope.new
-    scope.node :whatever => "nevermind"
-    scope.value.should eq(:whatever => "nevermind")
+    scope.node :beverage => 'soda pop'
+    scope.value.should eq(:beverage => 'soda pop')
   end
 
-  it "merges in a hash" do
-    tea = {:tea => {:temperature => 'hot', :type => 'wulong'}}
+  it 'merges in a hash' do
+    tea = {:tea => {:type => 'wulong', :temperature => 'hot'}}
 
     scope = Petroglyph::Scope.new
     scope.merge tea
-    scope.value.should eq({:tea => {:temperature => "hot", :type => 'wulong'}})
+    scope.value.should eq({:tea => {:type => 'wulong', :temperature => 'hot'}})
   end
 
-  it "merges within a block" do
+  it 'merges within a block' do
     scope = Petroglyph::Scope.new
-    scope.node :whatever do
-      merge(:stuff => {:no => :way})
+    scope.node :beverage do
+      merge('espresso' => {:shots => 2})
     end
 
-    scope.value.should eq({:whatever => {:stuff => {:no => :way}}})
+    scope.value.should eq({:beverage => {'espresso' => {:shots => 2}}})
   end
 
-  it "lets you process what you merge in a block" do
+  it 'lets you process what you merge in a block' do
     scope = Petroglyph::Scope.new
-    scope.node :whatever do
-      merge(10) do
-        attributes :to_s
+    drink = 'Zombie Driver'
+    def drink.tagline
+      'Take your mind off the apocalypse!'
+    end
+    scope.node :beverage do
+      merge(drink) do
+        attributes :tagline
       end
     end
 
-    scope.value.should eq({:whatever => {:to_s => '10'}})
+    scope.value.should eq({:beverage => {:tagline => 'Take your mind off the apocalypse!'}})
   end
 
-  it "handles sibling nodes" do
+  it 'handles sibling nodes' do
     scope = Petroglyph::Scope.new
-    scope.node :whatever => "nevermind"
-    scope.node :stuff => "awesome"
+    scope.node :beverage => 'bubble milk tea'
+    scope.node :price => 2.5
 
-    scope.value.should eq({:whatever => "nevermind", :stuff => "awesome"})
+    scope.value.should eq({:beverage => 'bubble milk tea', :price => 2.5})
   end
 
-  it "handles sibling nodes as blocks" do
+  it 'handles sibling nodes as blocks' do
     scope = Petroglyph::Scope.new
-    scope.node :whatever => "nevermind"
-    scope.node :stuff do
-      merge(:too => :cool)
+    scope.node :beverage => 'root beer float'
+    scope.node :ingredients do
+      merge(:ice_cream => 'vanilla', :root_beer => 'to taste')
     end
 
-    scope.value.should eq({:whatever => "nevermind", :stuff => {:too => :cool}})
+    scope.value.should eq({:beverage => 'root beer float', :ingredients => {:ice_cream => 'vanilla', :root_beer => 'to taste'}})
   end
 
-  it "nests nodes" do
+  it 'nests nodes' do
     scope = Petroglyph::Scope.new
-    scope.node :whatever do
-      node :stuff => "awesome"
+    scope.node :beverage do
+      node :tea => 'black'
     end
 
-    scope.value.should eq({:whatever => {:stuff => 'awesome'}})
+    scope.value.should eq({:beverage => {:tea => 'black'}})
   end
 
-  it "nests stuff arbitrarily deeply with complex values" do
+  it 'nests stuff arbitrarily deeply with complex values' do
     scope = Petroglyph::Scope.new
     scope.node :drink do
       node :tea do
         node :temperature do
-          merge(:really => :hot)
+          merge(:really => 'hot')
         end
       end
     end
 
-    scope.value.should eq({:drink => {:tea => {:temperature => {:really => :hot}}}})
+    scope.value.should eq({:drink => {:tea => {:temperature => {:really => 'hot'}}}})
   end
 
-  it "uses regular ruby" do
+  it 'uses regular ruby' do
     scope = Petroglyph::Scope.new
-    scope.node :drink do
+    scope.node :beverage do
       if false
-        "cold"
+        'hot'
       else
         node(:tea) do
-          merge(:temperature => "hot".upcase)
+          merge(:temperature => 'iced'.upcase)
         end
       end
     end
 
-    scope.value.should eq({:drink => {:tea => {:temperature => "HOT"}}})
+    scope.value.should eq({:beverage => {:tea => {:temperature => 'ICED'}}})
   end
 
-  context "with locals" do
-    let(:scope) { Petroglyph::Scope.new(nil, {:thing => 'stuff'}) }
+  context 'with locals' do
+    let(:scope) { Petroglyph::Scope.new(nil, {:drink => 'strawberry daikiri'}) }
 
     before(:each) do
       scope.instance_eval do
-        node :thing => thing
+        node :beverage => drink
       end
     end
 
-    it "resolves values" do
-      scope.value.should eq({:thing => 'stuff'})
+    it 'resolves values' do
+      scope.value.should eq({:beverage => 'strawberry daikiri'})
     end
 
-    it "responds to existing locals" do
-      scope.respond_to?(:thing).should == true
+    it 'responds to existing locals' do
+      scope.respond_to?(:drink).should == true
     end
 
     it "doesn't respond to missing locals" do
       scope.respond_to?(:not_a_thing).should == false
     end
 
-    it "doesn't clobber :respond_to?" do
+    it "doesn't clobber :respond_to? for existing methods" do
       scope.respond_to?(:value).should == true
     end
   end
 
-  describe "within a context" do
-    it "has access to methods" do
+  describe 'within a context' do
+    it 'has access to methods' do
       context = Object.new
-      def context.thing
-        'stuff'
+      def context.drink
+        'tisane'
       end
 
       scope = Petroglyph::Scope.new(context)
       scope.instance_eval do
-        node :thing => thing
+        node :beverage => drink
       end
-      scope.value.should eq({:thing => 'stuff'})
+      scope.value.should eq({:beverage => 'tisane'})
     end
 
-    it "lets local variables take precedence over methods" do
+    it 'lets local variables take precedence over methods' do
       context = Object.new
-      def context.thing
-        'junk'
+      def context.drink
+        'coffee'
       end
 
-      scope = Petroglyph::Scope.new(context, {:thing => 'stuff'})
+      scope = Petroglyph::Scope.new(context, {:drink => 'rooiboos tea'})
       scope.instance_eval do
-        node :thing => thing
+        node :beverage => drink
       end
-      scope.value.should eq({:thing => 'stuff'})
+      scope.value.should eq({:beverage => 'rooiboos tea'})
     end
   end
 
-  describe "attributes" do
-    it "evaluates on an object" do
-      hal = OpenStruct.new(:name => 'HAL 9000', :temperament => 'psychotic', :garbage => 'junk')
+  describe 'attributes' do
+    it 'evaluates on an object' do
+      drink = OpenStruct.new(:name => "Grandma's Herb Garden", :temperature => 'luke warm', :origin => 'the garden')
 
       scope = Petroglyph::Scope.new
-      scope.node :hal => hal do
-        attributes :name, :temperament
+      scope.node :beverage => drink do
+        attributes :name, :temperature
       end
 
-      scope.value.should eq({:hal => {:name => 'HAL 9000', :temperament => 'psychotic'}})
+      scope.value.should eq({:beverage => {:name => "Grandma's Herb Garden", :temperature => 'luke warm'}})
     end
 
-    it "evaluates on a hash" do
-      hal = {:name => 'HAL 9000', :temperament => 'psychotic', :garbage => 'junk'}
+    it 'evaluates on a hash' do
+      drink = {:name => 'darjeeling', :temperature => 'piping hot', :origin => 'the store'}
 
       scope = Petroglyph::Scope.new
-      scope.node :hal => hal do
-        attributes :name, :temperament
+      scope.node :beverage => drink do
+        attributes :name, :temperature
       end
 
-      scope.value.should eq({:hal => {:name => 'HAL 9000', :temperament => 'psychotic'}})
+      scope.value.should eq({:beverage => {:name => 'darjeeling', :temperature => 'piping hot'}})
     end
   end
 
-  context "with a collection" do
+  context 'with a collection' do
     let(:tea) { OpenStruct.new(:type => 'tea', :temperature => 'hot') }
-    let(:coffee) { OpenStruct.new(:type => 'coffee', :temperature => 'lukewarm') }
+    let(:coffee) { OpenStruct.new(:type => 'coffee', :temperature => 'warm') }
     let(:drinks) { [tea, coffee] }
 
-    it "evaluates attributes" do
+    it 'evaluates attributes' do
       scope = Petroglyph::Scope.new
-      scope.collection :drinks => drinks do
+      scope.collection :beverages => drinks do
         attributes :type, :temperature
       end
 
-      scope.value.should eq({:drinks => [{:type => 'tea', :temperature => 'hot'}, {:type => 'coffee', :temperature => 'lukewarm'}]})
+      scope.value.should eq({:beverages => [{:type => 'tea', :temperature => 'hot'}, {:type => 'coffee', :temperature => 'warm'}]})
     end
 
-    it "evaluates attributes on explicitly named items" do
+    it 'evaluates attributes on explicitly named items' do
       scope = Petroglyph::Scope.new
-      scope.collection :drinks => drinks do |drink|
+      scope.collection :beverages => drinks do |drink|
         node :drink do
           node :type => drink.type
         end
         node :prep => "Make water #{drink.temperature}."
       end
 
-      scope.value.should eq({:drinks => [{:drink => {:type => 'tea'}, :prep => "Make water hot."}, {:drink => {:type => 'coffee'}, :prep => "Make water lukewarm."}]})
+      scope.value.should eq({:beverages => [{:drink => {:type => 'tea'}, :prep => 'Make water hot.'}, {:drink => {:type => 'coffee'}, :prep => 'Make water warm.'}]})
     end
 
-    it "evaluates object attributes within a sub node" do
+    it 'evaluates object attributes within a sub node' do
       scope = Petroglyph::Scope.new
-      scope.collection :drinks => drinks do |drink|
+      scope.collection :beverages => drinks do |drink|
         node :drink => drink do
           attributes :type
         end
-        node :prep => "Make water #{drink.temperature}."
+        node :prep => "Water should be #{drink.temperature}."
       end
 
-      scope.value.should eq({:drinks => [{:drink => {:type => 'tea'}, :prep => "Make water hot."}, {:drink => {:type => 'coffee'}, :prep => "Make water lukewarm."}]})
+      scope.value.should eq({:beverages => [{:drink => {:type => 'tea'}, :prep => 'Water should be hot.'}, {:drink => {:type => 'coffee'}, :prep => 'Water should be warm.'}]})
     end
 
-    it "evaluates an empty collection to an empty array" do
+    it 'evaluates an empty collection to an empty array' do
       scope = Petroglyph::Scope.new
-      scope.collection :drinks => [] do |drink|
+      scope.collection :beverages => [] do |drink|
         node :drink => drink
       end
 
-      scope.value.should eq({:drinks => []})
+      scope.value.should eq({:beverages => []})
     end
   end
 
-  context "with partials" do
-    it "renders a partial" do
+  context 'with partials' do
+    it 'renders a partial' do
       Petroglyph.stub(:partial) { 'node :drink => "tea"' }
 
       scope = Petroglyph::Scope.new
@@ -229,7 +233,7 @@ describe Petroglyph::Scope do
       scope.value.should eq({:partial => {:drink => 'tea'}})
     end
 
-    it "renders a partial with local variables" do
+    it 'renders a partial with local variables' do
       Petroglyph.stub(:partial) { 'node :drink => drink' }
 
       scope = Petroglyph::Scope.new
@@ -240,30 +244,32 @@ describe Petroglyph::Scope do
       scope.value.should eq({:partial => {:drink => 'tea'}})
     end
 
-    it "defaults locals to match the name of the partial" do
-      Petroglyph.stub(:partial) { 'node :drink => drink' }
+    it 'defaults locals to match the name of the partial' do
+      Petroglyph.stub(:partial) { 'node :beverage => drink' }
 
       scope = Petroglyph::Scope.new(nil, {:drink => 'coffee'})
-      scope.node :drinks do
+      scope.node :beverages do
         partial :drink
       end
 
-      scope.value.should eq({:drinks => {:drink => 'coffee'}})
+      scope.value.should eq({:beverages => {:beverage => 'coffee'}})
     end
 
-    it "finds the partial" do
+    it 'finds the partial' do
       scope = Petroglyph::Scope.new
-      scope.file = "spec/fixtures/views/some_template.pg"
+      # Pretend that this node is defined in some_template
+      # so that we have a decent relative path for the partial.
+      scope.file = 'spec/fixtures/views/some_template.pg'
       scope.node :partial do
-        partial :the_partial, :thing => 'stuff'
+        partial :the_partial, :drink => 'mocha'
       end
 
-      scope.value.should eq({:partial => {:thing => 'stuff'}})
+      scope.value.should eq({:partial => {:beverage => 'mocha'}})
     end
 
-    it "finds the partial in a subdirectory" do
+    it 'finds the partial in a subdirectory' do
       scope = Petroglyph::Scope.new
-      scope.file = "spec/fixtures/views/some_template.pg"
+      scope.file = 'spec/fixtures/views/some_template.pg'
       scope.node :partial do
         partial :sub_partial, :thing => 'stuff'
       end
@@ -271,15 +277,15 @@ describe Petroglyph::Scope do
       scope.value.should eq({:partial => {:thing => 'stuff'}})
     end
 
-    it "finds nested partials" do
+    it 'finds nested partials' do
       scope = Petroglyph::Scope.new
-      scope.file = "spec/fixtures/views/some_template.pg"
+      scope.file = 'spec/fixtures/views/some_template.pg'
 
       scope.node :partial do
         partial :nested_partial
       end
 
-      scope.value.should eq({:partial => {:thing => 'stuff'}})
+      scope.value.should eq({:partial => {:beverage => 'stuff'}})
     end
   end
 end

data/spec/sinatra_integration_spec.rb

@@ -30,10 +30,7 @@ describe "Sinatra integration" do
     last_response.body.should eq '{"drinks":[{"type":"tea","temperature":"hot"},{"type":"coffee","temperature":"lukewarm"}]}'
   end
 
-  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"
+  it "doesn't get overshadowed by controller methods (issue #5)" do
     post '/'
     last_response.body.should eq "{\"post\":\"a post\"}"
   end

data/spec/tilt_spec.rb

@@ -32,7 +32,7 @@ describe "Tilt integration" do
   context "with partials" do
     it "loads the partial" do
       template = Tilt::PetroglyphTemplate.new('spec/fixtures/views/with_partial.pg')
-      template.render.should eq('{"root":{"thing":"stuff"}}')
+      template.render.should eq('{"root":{"beverage":"stuff"}}')
     end
 
     it "loads the partial from a subdirectory" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: petroglyph
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-18 00:00:00.000000000 Z
+date: 2013-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70270581389760 !ruby/object:Gem::Requirement
+  requirement: &70296704591240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70270581389760
+  version_requirements: *70296704591240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70270581388680 !ruby/object:Gem::Requirement
+  requirement: &70296704590820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,21 +32,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270581388680
+  version_requirements: *70296704590820
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70270581387860 !ruby/object:Gem::Requirement
+  requirement: &70296704590320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70270581387860
+  version_requirements: *70296704590320
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70270581387260 !ruby/object:Gem::Requirement
+  requirement: &70296704589900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270581387260
+  version_requirements: *70296704589900
 description: A simple, terse, and unsurprising ruby dsl to create json views.
 email:
 - katrina.owen@gmail.com
@@ -65,6 +65,7 @@ files:
 - .gitignore
 - .rspec
 - .simplecov
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -118,3 +119,4 @@ signing_key:
 specification_version: 3
 summary: A simple, terse, and unsurprising ruby dsl to create json views.
 test_files: []
+has_rdoc: