petroglyph 0.0.6 → 0.0.7

data/.rspec

@@ -1 +1 @@
---color --format documentation
+--color

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - rbx-19mode
 
 script: rspec spec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Katrina Owen
+
+MIT License
+
+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

@@ -50,6 +50,14 @@ Conveniently define which attributes to include. Create a new node with a differ
     end
     => '{"person":{"name":"Alice","gender":"female","job":"surgeon"}}'
 
+If you don't want to namespace the object, you can use `merge` in place of `node`:
+
+    merge alice do
+      attributes :name, :gender
+      node :job => alice.profession
+    end
+    => '{"name":"Alice","gender":"female","job":"surgeon"}'
+
 Iterate through collections:
 
     wulong = Tea.new(:type => 'wulong')
@@ -73,7 +81,11 @@ You can also explicitly reference each item in the collection if you need to:
 
 Partials have been implemented. This defaults to looking for a file in the same file as the template, or in a subdirectory called `partials`.
 
-This can be overridden by re-implementing the `Petroglyph.partial(name)` method.
+There is a shortcut if you're looping over a collection to render a partial for each item in the collection:
+
+    collection :teas => teas, :partial => :tea
+
+The name of the partials subdirectory can be overridden by re-implementing the `Petroglyph.partial(name)` method.
 
     collection :teas => teas do |tea|
       # partial(template_name, local_variables)
@@ -92,6 +104,24 @@ Support for partials is non-standard at this time: create a subdirectory in the
 
 This works with version 1.3 of Sinatra. It may work with earlier versions.
 
+### Config
+
+You need to require the Sinatra petroglyph extension:
+
+```ruby
+require 'sinatra/petroglyph'
+```
+
+Then you can use the `pg` helper method in your endpoints:
+
+```ruby
+get '/api/v1/widgets' do
+  pg :widgets, :locals => {:widgets => Widget.all}
+end
+```
+
+### Gotcha
+
 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.
 
@@ -112,3 +142,10 @@ Other json templating libraries exist, some of which also generate XML.
 * [Jsonify](https://github.com/bsiggelkow/jsonify)
 * [Representative](https://github.com/mdub/representative)
 * [Tokamak](https://github.com/abril/tokamak)
+
+## License
+
+MIT License
+
+Copyright (c) 2012 Katrina Owen
+

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/petroglyph.rb

@@ -6,13 +6,20 @@ require 'petroglyph/engine'
 module Petroglyph
   class << self
     def partial(filename, template_filename)
-      basedir = File.dirname(template_filename)
-      [basedir, "#{basedir}/partials"].each do |dir|
-        path = File.join(dir, "#{filename}.pg")
-        return File.read(path) if File.exist?(path)
+      paths(filename, template_filename).each do |path|
+        if File.exist?(path)
+          return eval "Proc.new{#{File.read(path)}}"
+        end
       end
       raise Exception.new("Could not find partial #{filename}")
     end
+
+    def paths(filename, template_filename)
+      basedir = File.dirname(template_filename)
+      [basedir, "#{basedir}/partials"].map do |dir|
+        File.join(dir, "#{filename}.pg")
+      end
+    end
   end
 end
 

data/lib/petroglyph/scope.rb

@@ -39,10 +39,15 @@ module Petroglyph
       end
     end
 
-    def collection(input, &block)
+    def collection(args, &block)
       @value ||= {}
-      name = input.keys.first
-      items = input.values.first
+      name, items = args.first
+
+      if args.length == 2
+        singular = args[:partial]
+        block = eval "Proc.new{|item| partial #{singular.inspect}, #{singular.inspect} => item}"
+      end
+
       results = []
       items.each do |item|
         scope = sub_scope(item)
@@ -77,9 +82,9 @@ module Petroglyph
     def partial(name, locals = nil)
       locals ||= {name => send(name)} if respond_to?(name)
       locals ||= {}
-      data = Petroglyph.partial(name, file)
+      partial  = Petroglyph.partial(name, file)
       scope = Scope.new(@context, locals, file)
-      scope.instance_eval(data.to_s)
+      scope.instance_eval(&partial)
       merge scope.value
     end
 

data/lib/petroglyph/version.rb

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

data/lib/tilt/petroglyph.rb

@@ -1,7 +1,4 @@
 # Makes Petroglyph available through Tilt.
-# Also contains a utility function that will
-# be added to Sinatra if Sinatra is defined.
-
 require 'tilt'
 require 'petroglyph'
 
@@ -13,14 +10,16 @@ module Tilt
       require_template_library 'petroglyph'
     end
 
-    def prepare; end
+    def prepare
+      @engine = Petroglyph::Engine.new(data)
+    end
 
     def precompiled_template(locals)
       data.to_str
     end
 
     def evaluate(scope = Object.new, locals = {}, &block)
-      Petroglyph::Engine.new(data).render(scope, locals, file, &block)
+      @engine.render(scope, locals, file, &block)
     end
   end
   register PetroglyphTemplate, 'pg'

data/spec/scope_spec.rb

@@ -1,5 +1,9 @@
 require 'spec_helper'
 
+def fake_partial(s)
+  eval "Proc.new{#{s}}"
+end
+
 describe Petroglyph::Scope do
 
   it 'takes a simple string value' do
@@ -219,11 +223,20 @@ describe Petroglyph::Scope do
 
       scope.value.should eq({:beverages => []})
     end
+
+    it 'has a convenience handler' do
+      Petroglyph.stub(:partial) { fake_partial('node :drink => drink.type') }
+
+      scope = Petroglyph::Scope.new
+      scope.collection :drinks => drinks, :partial => :drink
+
+      scope.value.should eq({:drinks => [{:drink => 'tea'}, {:drink => 'coffee'}]})
+    end
   end
 
   context 'with partials' do
     it 'renders a partial' do
-      Petroglyph.stub(:partial) { 'node :drink => "tea"' }
+      Petroglyph.stub(:partial) { fake_partial('node :drink => "tea"') }
 
       scope = Petroglyph::Scope.new
       scope.node :partial do
@@ -234,7 +247,7 @@ describe Petroglyph::Scope do
     end
 
     it 'renders a partial with local variables' do
-      Petroglyph.stub(:partial) { 'node :drink => drink' }
+      Petroglyph.stub(:partial) { fake_partial('node :drink => drink') }
 
       scope = Petroglyph::Scope.new
       scope.node :partial do
@@ -245,7 +258,7 @@ describe Petroglyph::Scope do
     end
 
     it 'defaults locals to match the name of the partial' do
-      Petroglyph.stub(:partial) { 'node :beverage => drink' }
+      Petroglyph.stub(:partial) { fake_partial('node :beverage => drink') }
 
       scope = Petroglyph::Scope.new(nil, {:drink => 'coffee'})
       scope.node :beverages do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: petroglyph
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-08 00:00:00.000000000 Z
+date: 2013-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70296704591240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70296704591240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70296704590820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70296704590820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70296704590320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70296704590320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70296704589900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70296704589900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple, terse, and unsurprising ruby dsl to create json views.
 email:
 - katrina.owen@gmail.com
@@ -67,6 +87,7 @@ files:
 - .simplecov
 - .travis.yml
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/padrino/petroglyph.rb
@@ -114,9 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: petroglyph
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A simple, terse, and unsurprising ruby dsl to create json views.
 test_files: []
-has_rdoc: