sinatra-partial 0.1.1 → 0.2.1

data/CHANGES

@@ -1,3 +1,5 @@
+v0.2.1 Sam Elliot provided a lot of helpful code to add in features that were lost from his gist. Further to these, the lib is now a Sinatra Extension so it can add in some useful defaults. Different template engines other than Haml may be specified, and leading underscores (a la Rails) can be specified for partials too. Examples have been added to the examples directory, and the code docs are much more extensive.
+
 v0.1.1 Improved the examples in the Readme file. A lot.
 
-v0.1.0 The locals hash doesn't get clobbered if passing a collection now, but you do get the chance to clobber the default of passing the collection local if you so wish. With great power comes great responsibility!
+v0.1.0 The locals hash doesn't get clobbered if passing a collection now, but you do get the chance to clobber the default of passing the collection local if you so wish. With great power comes great responsibility!

data/README.markdown

@@ -24,15 +24,42 @@ So here it is, partials, and that's it.
 
     gem install sinatra-partial
 
-### Some examples ###
+### Configuration options ###
+
+The default templating engine is haml. If you wish to use something else, you can set in the config options:
+
+    set :partial_template_engine, :erb
+
+If you wish, you can also pass this in with the options hash to partial (if you do, it will override the above setting for that call):
+
+    partial(:"meta/news", :template_engine => :erb)
+
+If you like the Rails convention of adding an underscore to the beginning of a partial, set it here:
+
+    enable :partial_underscores
+
+Otherwise, the default is for no underscore (if you like Rails you know where to get it;)
+
+### Getting started ###
 
 At the top of your app.rb:
 
     require 'sinatra/partial'
 
+For a classic app, that's all you need to do. For a modular app you should register it too:
+
     class Blah < Sinatra::Base
-      helpers Sinatra::Partial
-  
+      register Sinatra::Partial
+
+
+### Some examples ###
+
+The docs are good to look at (big thanks to Sam Elliot for improving them a lot), just follow the docs link from this page if you can't find them:
+
+https://rubygems.org/gems/sinatra-partial
+
+or use yard/rdoc to generate them.
+
 
 #### Inside a route ####
 
@@ -144,29 +171,21 @@ Here's how to use a collection, in this case to render a menu:
       
     
 You'll get a menu built for you.
-      
-
 
-### Another quick note ###
 
- Since the locals hash was getting clobbered when using a collection, I've changed the code so that you can pass in a collection _and_ locals that will be accessible too.
-
-    = partial( :record, collection: v[:records], :locals => {something_else: 243} )
-    
-Now you'll be able to access the local `something_else` within the `:record` partial.
+### Examples ###
 
-### HULK SMASH!!! ###
+Look in the examples directory for some very simple examples.
 
-You can also decide to do some clobbering of your own and HULK SMASH! the defaults for the collection, which in this case would be :record (as it's the template name) and :layout => false. Perhaps you might need this so I've left it up to you, but probably best to leave it alone and call your locals something else. It's your code.
 
 ### Thanks ###
 
-Thanks to Chris Schneider and Sam Elliott for sharing their code, I just made it into this gem and tinkered ever so slightly.
+Thanks to Chris Schneider and Sam Elliott for sharing their code, and for sharing further updates.
 
 
 ### Licence ###
 
-Copyright (c) 2011 Iain Barnett
+Copyright (c) 2012 Iain Barnett
 
 MIT Licence
 

data/examples/app_no_underscores/app.rb

@@ -0,0 +1,10 @@
+require 'sinatra'
+require_relative "../../lib/sinatra/partial.rb"
+require 'haml'
+
+News = ["This", "is", "all", "new"]
+
+get "/" do
+  haml :home
+end
+

data/examples/app_no_underscores/views/home.haml

@@ -0,0 +1,2 @@
+%p
+  Hello, World

data/examples/app_no_underscores/views/layout.haml

@@ -0,0 +1,11 @@
+%html
+  %head
+  %body
+    = partial :meta
+    
+    %ul
+      = partial :news, :collection => News
+      
+    = partial :locality, :locals => Hash[%w{a b c d}.zip(%w{A B C D})]
+    
+    = yield

data/examples/app_no_underscores/views/locality.haml

@@ -0,0 +1,4 @@
+%p= "A is #{a}"
+%p= "B is #{b}" 
+%p= "C is #{c}" 
+%p= "D is #{d}" 

data/examples/app_no_underscores/views/meta.haml

@@ -0,0 +1 @@
+Time is #{Time.now.localtime}

data/examples/app_no_underscores/views/news.haml

@@ -0,0 +1,2 @@
+%li
+  = news

data/examples/app_with_underscores/app.rb

@@ -0,0 +1,12 @@
+require 'sinatra'
+require_relative "../../lib/sinatra/partial.rb"
+require 'haml'
+
+News = ["This", "is", "all", "new"]
+
+set :partial_underscores, true
+
+get "/" do
+  haml :home
+end
+

data/examples/app_with_underscores/views/_locality.haml

@@ -0,0 +1,4 @@
+%p= "A is #{a}"
+%p= "B is #{b}" 
+%p= "C is #{c}" 
+%p= "D is #{d}" 

data/examples/app_with_underscores/views/_meta.haml

@@ -0,0 +1 @@
+Time is #{Time.now.localtime}

data/examples/app_with_underscores/views/_news.haml

@@ -0,0 +1,2 @@
+%li
+  = news

data/examples/app_with_underscores/views/home.haml

@@ -0,0 +1,2 @@
+%p
+  Hello, World

data/examples/app_with_underscores/views/layout.haml

@@ -0,0 +1,11 @@
+%html
+  %head
+  %body
+    = partial :meta
+    
+    %ul
+      = partial :news, :collection => News
+      
+    = partial :locality, :locals => Hash[%w{a b c d}.zip(%w{A B C D})]
+    
+    = yield

data/examples/app_with_underscores_and_erb/app.rb

@@ -0,0 +1,14 @@
+require 'sinatra'
+require_relative "../../lib/sinatra/partial.rb"
+require 'haml'
+
+News = ["This", "is", "all", "new"]
+
+set :partial_underscores, true
+set :partial_template_engine, :erb
+
+
+get "/" do
+  erb :home
+end
+

data/examples/app_with_underscores_and_erb/views/_locality.erb

@@ -0,0 +1,4 @@
+<p>A is <%= a %></p>
+<p>B is <%= b %></p> 
+<p>C is <%= c %></p>
+<p>D is <%= d %></p>

data/examples/app_with_underscores_and_erb/views/_meta.erb

@@ -0,0 +1 @@
+Time is <%= Time.now.localtime %>

data/examples/app_with_underscores_and_erb/views/_news.erb

@@ -0,0 +1,3 @@
+<li>
+  <%= news %>
+</li>

data/examples/app_with_underscores_and_erb/views/home.erb

@@ -0,0 +1,3 @@
+<p>
+  Hello, World
+</p>

data/examples/app_with_underscores_and_erb/views/layout.erb

@@ -0,0 +1,14 @@
+<html>
+  <head></head>
+  <body>
+    <%= partial :meta %>
+    
+    <ul>
+      <%= partial :news, :collection => News %>
+    </ul>
+      
+    <%= partial( :locality, :locals => Hash[%w{a b c d}.zip(%w{A B C D})]) %>
+    
+    <%= yield %>
+  </body>
+</html>

data/examples/app_with_underscores_and_erb_and_subdirs/app.rb

@@ -0,0 +1,14 @@
+require 'sinatra'
+require_relative "../../lib/sinatra/partial.rb"
+require 'haml'
+
+News = ["This", "is", "all", "new"]
+
+set :partial_underscores, true
+set :partial_template_engine, :erb
+
+
+get "/" do
+  erb :home
+end
+

data/examples/app_with_underscores_and_erb_and_subdirs/views/home.erb

@@ -0,0 +1,3 @@
+<p>
+  Hello, World
+</p>

data/examples/app_with_underscores_and_erb_and_subdirs/views/layout.erb

@@ -0,0 +1,14 @@
+<html>
+  <head></head>
+  <body>
+    <%= partial :"partials/meta" %>
+    
+    <ul>
+      <%= partial :"partials/news", :collection => News %>
+    </ul>
+      
+    <%= partial( :"partials/locality", :locals => Hash[%w{a b c d}.zip(%w{A B C D})]) %>
+    
+    <%= yield %>
+  </body>
+</html>

data/examples/app_with_underscores_and_erb_and_subdirs/views/partials/_locality.erb

@@ -0,0 +1,4 @@
+<p>A is <%= a %></p>
+<p>B is <%= b %></p> 
+<p>C is <%= c %></p>
+<p>D is <%= d %></p>

data/examples/app_with_underscores_and_erb_and_subdirs/views/partials/_meta.erb

@@ -0,0 +1 @@
+Time is <%= Time.now.localtime %>

data/examples/app_with_underscores_and_erb_and_subdirs/views/partials/_news.erb

@@ -0,0 +1,3 @@
+<li>
+  <%= news %>
+</li>

data/lib/sinatra/partial.rb

@@ -4,28 +4,74 @@ require 'sinatra/base'
 
 module Sinatra
   module Partial
-    
-    # support for partials
-    # @example
-    #   partial( :meta, :locals => {meta: meta} )
-    def partial(template, *args)
-      opts = args.last.is_a?(Hash) ? args.pop : {} # get hash options if they're there
-      opts.merge!(:layout => false) # don't layout, this is a partial
-
-      if collection = opts.delete(:collection)
-        locals = opts[:locals].nil? ? {} : opts.delete(:locals)
-        collection.inject([]) do |buffer, member|
-          buffer << haml( template, opts.merge(:layout => false, :locals => {template.to_sym => member}.merge(locals)
-            )
-          )
-        end.join("\n")
-      else
-        haml(template, opts)
+    module Helpers
+      # Renders a partial to a string.
+      # 
+      # @param [#to_s] partial The partial to render.
+      # @param [Hash] options The options to render the partial with.
+      # @option options [Hash] :locals Local variables to render with
+      # @option options [Array] :collection Renders the template once per object in this array.
+      # @option options [Symbol] :template_engine The template engine to use. Haml by default.
+      # @option options [true,false] :underscores Set to true if you wish to follow the Rails convention of partial files having a leading underscore.
+      #
+      # @return [String] The rendered template contents.
+      #
+      # @example simply render a partial
+      #   partial(:meta, :locals => {meta: meta})
+      #     # => renders views/_meta.haml
+      #
+      # @example render a partial in a subfolder
+      #   partial("meta/news", :locals => {news: [<News>]})
+      #     # => renders views/meta/_news.haml
+      #
+      # @example render a collection of objects with one partial
+      #   partial(:"meta/news", :collection => [<News>])
+      #     # => renders views/meta/_news.haml once per item in :collection,
+      #           with the local variable `news` being the current item in the iteration
+      def partial(partial, options={})
+        partial_location = partial.to_s
+        
+        locals = options.fetch(:locals, {})
+        engine = options.fetch(:template_engine, settings.partial_template_engine)
+        underscores = options.fetch(:underscores, settings.partial_underscores)
+        
+        template = partial_expand_path(partial_location, underscores)
+        
+        if collection = options.delete(:collection)
+          member_local = partial_local(partial_location)
+  
+          collection.inject([]) do |buffer, member|
+            new_locals = {member_local => member}.merge(locals)
+            buffer << self.method(engine).call(template, options.merge(:locals => new_locals))
+          end.join("\n")
+        else
+          self.method(engine).call(template, options)
+        end
       end
-    end # def
-  end
-
-  helpers Partial
+      
+      private
+      
+      def partial_expand_path(partial_path, underscores=false)
+        dirs, base = [File.dirname(partial_path),File.basename(partial_path)]
+        base.insert(0, "_") if underscores
+        File.join(dirs, base).to_sym
+      end
+      
+      def partial_local(partial_path)
+        File.basename(partial_path).to_sym
+      end
+    end
+    
+    def self.registered(app)
+      app.helpers(Partial::Helpers)
+      
+      # Configuration
+      app.set :partial_underscores, false
+      app.set :partial_template_engine, :haml
+    end
+    
+  end # Partial
+  register(Sinatra::Partial)
 end
 
 

data/lib/sinatra/partial/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Partial
-    VERSION = "0.1.1"
+    VERSION = "0.2.1"
   end
 end

data/sinatra-partial.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Chris Schneider", "Sam Elliott", "Iain Barnett"]
   s.email       = ["iainspeed@gmail.com"]
   s.homepage    = "https://github.com/yb66/Sinatra-Partial"
-  s.summary     = %q{Rack middleware for Geo IP city lookup}
+  s.summary     = %q{A sinatra extension for render partials.}
   s.description = %q{Just the partials helper in a gem. That is all.}
   s.license     = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-partial
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,12 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-09 00:00:00.000000000 +00:00
-default_executable: 
+date: 2012-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2152539520 !ruby/object:Gem::Requirement
+  requirement: &2152441740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,7 +23,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152539520
+  version_requirements: *2152441740
 description: Just the partials helper in a gem. That is all.
 email:
 - iainspeed@gmail.com
@@ -35,10 +34,33 @@ files:
 - .gitignore
 - CHANGES
 - README.markdown
+- examples/app_no_underscores/app.rb
+- examples/app_no_underscores/views/home.haml
+- examples/app_no_underscores/views/layout.haml
+- examples/app_no_underscores/views/locality.haml
+- examples/app_no_underscores/views/meta.haml
+- examples/app_no_underscores/views/news.haml
+- examples/app_with_underscores/app.rb
+- examples/app_with_underscores/views/_locality.haml
+- examples/app_with_underscores/views/_meta.haml
+- examples/app_with_underscores/views/_news.haml
+- examples/app_with_underscores/views/home.haml
+- examples/app_with_underscores/views/layout.haml
+- examples/app_with_underscores_and_erb/app.rb
+- examples/app_with_underscores_and_erb/views/_locality.erb
+- examples/app_with_underscores_and_erb/views/_meta.erb
+- examples/app_with_underscores_and_erb/views/_news.erb
+- examples/app_with_underscores_and_erb/views/home.erb
+- examples/app_with_underscores_and_erb/views/layout.erb
+- examples/app_with_underscores_and_erb_and_subdirs/app.rb
+- examples/app_with_underscores_and_erb_and_subdirs/views/home.erb
+- examples/app_with_underscores_and_erb_and_subdirs/views/layout.erb
+- examples/app_with_underscores_and_erb_and_subdirs/views/partials/_locality.erb
+- examples/app_with_underscores_and_erb_and_subdirs/views/partials/_meta.erb
+- examples/app_with_underscores_and_erb_and_subdirs/views/partials/_news.erb
 - lib/sinatra/partial.rb
 - lib/sinatra/partial/version.rb
 - sinatra-partial.gemspec
-has_rdoc: true
 homepage: https://github.com/yb66/Sinatra-Partial
 licenses:
 - MIT
@@ -60,8 +82,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Rack middleware for Geo IP city lookup
+summary: A sinatra extension for render partials.
 test_files: []
+has_rdoc: