frank 0.3.1 → 0.3.2

data/README.md

@@ -125,6 +125,10 @@ in my Haml views like this:
 
     = render_partial 'footer'
 
+You can also send local variables to partials like this:
+
+    = render_partial 'footer', :local_variable_name => 'some_value'
+
 ### Helpers
 
 Helper methods are also easy. Just open up `helpers.rb` and add your methods
@@ -144,9 +148,9 @@ of building a project.
 
 When it's time to `frankout`, Frank will leave out the JavasScript bits of the refresher.
 
-### Current Page
+### Current Path
 
-Frank now has a `current_page` variable that you can use to set selected states on nav items.
+Frank now has a `current_path` variable that you can use to set selected states on nav items.
 It will return the path info from the template being processed. You also, have access to the variable from layouts and from the `frankout` command.
 
 ### Placeholder Text
@@ -219,4 +223,4 @@ Installation
 [10]: http://lesscss.org/
 [11]: http://en.wikipedia.org/wiki/Lorem_ipsum
 [12]: http://www.imagemagick.org/script/binary-releases.php?ImageMagick=4pg9cdfr8e6gn7aru9mtelepr3
-[13]: http://www.yaml.org/start.html
+[13]: http://www.yaml.org/start.html

data/bin/frank

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
 require 'frank'
 
 if ARGV.empty?

data/bin/frankout

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
 require 'optparse'
 require 'frank'
 
-options = { :production => false }
+production = false
 
 opts = OptionParser.new do |opts|
   opts.banner = "Usage: frankout [OPTIONS] directory\n",
@@ -12,7 +14,7 @@ opts = OptionParser.new do |opts|
   opts.separator 'Options:'
   
   opts.on('--production', 'Production ready dump i.e. ([FOLDER]/index.html)') do |handler|
-    options[:production] = true
+    production = true
   end
   
   opts.on( '-h', '--help', 'Display this help' ) do
@@ -45,9 +47,10 @@ begin
     settings.each do |name, value|
       set name.to_s, value
     end
+    set :environment, :output
     set :output_folder, output_folder
     set :proj_dir, proj_dir
-  end.dump(options)
+  end.dump(production)
   
 rescue Errno::ENOENT
   puts "Frank could not find settings.yml."

data/bin/frankup

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
 require 'optparse'
 require 'frank'
 

data/frank.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frank}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["blahed", "nwah"]
-  s.date = %q{2010-06-28}
+  s.date = %q{2010-07-06}
   s.description = %q{Rapidly develop static sites using any supported templating language}
   s.email = %q{travis.dunn@thisismedium.com}
   s.executables = ["frank", "frankout", "frankup"]
@@ -64,6 +64,7 @@ Gem::Specification.new do |s|
      "spec/render_spec.rb",
      "spec/template/dynamic/500.haml",
      "spec/template/dynamic/_partial.haml",
+     "spec/template/dynamic/_partial_with_locals.haml",
      "spec/template/dynamic/builder.builder",
      "spec/template/dynamic/erb.erb",
      "spec/template/dynamic/helper_test.haml",
@@ -77,6 +78,7 @@ Gem::Specification.new do |s|
      "spec/template/dynamic/nested/child.haml",
      "spec/template/dynamic/nested/deeper/deep.haml",
      "spec/template/dynamic/no_layout.haml",
+     "spec/template/dynamic/partial_locals_test.haml",
      "spec/template/dynamic/partial_test.haml",
      "spec/template/dynamic/redcloth.textile",
      "spec/template/dynamic/refresh.haml",

data/lib/frank.rb

@@ -1,5 +1,4 @@
 LIBDIR = File.dirname(__FILE__)
-$LOAD_PATH.unshift(LIBDIR) unless $LOAD_PATH.include?(LIBDIR)
 
 local_helpers = File.join(Dir.pwd, 'helpers.rb')
 require local_helpers[0..-4] if File.exists? local_helpers

data/lib/frank/base.rb

@@ -6,7 +6,7 @@ require 'frank/middleware/imager'
 require 'frank/middleware/refresh'
 
 module Frank
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
   
   module Render; end
   
@@ -63,7 +63,7 @@ module Frank
     end
     
     # prints requests and errors to STDOUT
-    def log_request(status, excp=nil)
+    def log_request(status, excp = nil)
       out = "\033[1m[#{Time.now.strftime('%Y-%m-%d %H:%M')}]\033[22m (#{@request.request_method}) http://#{@request.host}:#{@request.port}#{@request.fullpath} - #{status}"
       out << "\n\n#{excp.message}\n\n#{excp.backtrace.join("\n")} " if excp
       puts out
@@ -89,13 +89,15 @@ module Frank
     LAYOUT_EXTS = %w[.haml .erb .rhtml .liquid .mustache]
     
     # render request path or template path
-    def render(path)
+    def render(path, partial = false, local_vars = nil)
+      @current_path = path unless partial
+      
       # normalize the path
       path.sub!(/^\/?(.*)$/, '/\1')
       path.sub!(/\/$/, '/index.html')
       path.sub!(/(\/[\w-]+)$/, '\1.html')
       path = to_file_path(path) if defined? @request or path.match(/\/_[^\/]+$/)
-
+      
       # regex for kinds that don't support meta
       # and define the meta delimiter
       nometa, delimiter  = /\/_|\.(sass|less)$/, /^META-{3,}\s*$|^-{3,}META\s*$/
@@ -111,8 +113,8 @@ module Frank
       template        = File.read(template_path) << "\n"
       ext             = File.extname(path)
       template, meta  = template.split(delimiter).reverse
-      locals          = parse_meta_and_set_locals(meta, path)
-      
+      locals          = parse_meta_and_set_locals(meta, local_vars)
+
       # use given layout if defined as a meta field
       layout = locals[:layout] == 'nil' ? nil : locals[:layout] if locals.has_key?(:layout)
       
@@ -211,11 +213,8 @@ module Frank
     private
     
     # parse the given meta string with yaml
-    # add current path
-    # and add instance variables
-    def parse_meta_and_set_locals(meta, path)
-      locals = {}
-      
+    # set the current_path local
+    def parse_meta_and_set_locals(meta, locals = nil)      
       # parse yaml and symbolize keys
       if meta.nil?
         meta = {}
@@ -224,14 +223,11 @@ module Frank
           options[(key.to_sym rescue key) || key] = value
           options
         end
-      end
-      
-      # normalize current_path
-      # and add it to locals
-      current_path = path.sub(/\.[\w-]+$/, '').sub(/\/index/, '/')
-      locals[:current_path] = current_path
+      end      
+      meta.merge!(locals) unless locals.nil?
+      meta[:current_path] = @current_path.sub(/\.[\w-]+$/, '').sub(/\/index/, '/')
       
-      meta.merge(locals)
+      meta
     end
     
   end

data/lib/frank/template_helpers.rb

@@ -4,10 +4,11 @@ module Frank
   module TemplateHelpers
     include FrankHelpers if defined? FrankHelpers
   
-    def render_partial(path)
+    def render_partial(path, *locals)
       pieces = path.split('/')
       partial = '_' + pieces.pop
-      render(File.join(pieces.join('/'), partial))
+      locals = locals.empty? ? nil : locals[0]
+      render(File.join(pieces.join('/'), partial), partial = true, locals)
     end
     
     def lorem
@@ -15,7 +16,7 @@ module Frank
     end
     
     def refresh
-      if @environment == :output || @environment == :production
+      if @environment == :output
         nil
       else
         <<-JS

data/spec/helper.rb

@@ -1,8 +1,5 @@
 testdir = File.dirname(__FILE__)
-$LOAD_PATH.unshift testdir unless $LOAD_PATH.include?(testdir)
- 
-libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
-$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
+$:.unshift testdir unless $LOAD_PATH.include?(testdir)
 
 require 'stringio'
 require 'rubygems'

data/spec/output_spec.rb

@@ -4,19 +4,12 @@ describe Frank::Output do
   include Rack::Test::Methods 
   
   context 'default output' do
-    before(:all) do
-      proj_dir = File.join(File.dirname(__FILE__), 'template')
-      settings = YAML.load_file(File.join(proj_dir, 'settings.yml'))
-      require File.join(proj_dir, 'helpers')
-      capture_stdout do
-        Frank::Output.new do
-          settings.each do |name, value|
-            set name.to_s, value
-          end
-          set :environment, :output
-          set :proj_dir, proj_dir
-          set :output_folder, File.join(File.dirname(__FILE__), 'template/output')
-        end.dump
+    before :all do
+      bin_dir    = File.join(File.dirname(File.dirname(__FILE__)), 'bin', 'frankout')
+      proj_dir   = File.join(File.dirname(__FILE__), 'template')
+      output_dir = File.join(proj_dir, 'output')
+      Dir.chdir proj_dir do
+        system "#{bin_dir} #{output_dir} > /dev/null"
       end
     end
   
@@ -29,9 +22,14 @@ describe Frank::Output do
       File.read(output).should == "<div id='p'>/</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/</h2>\n</div>\n"
     end
       
-    it  'creates partial_test.html' do
+    it 'creates partial_test.html' do
       output = File.join(File.dirname(__FILE__), 'template/output/partial_test.html')
-      File.read(output).should == "<div id='p'>/partial_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <p>hello from partial</p>\n</div>\n"
+      File.read(output).should == "<div id='p'>/partial_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/partial_test</h2>\n  <p>hello from partial</p>\n</div>\n"
+    end
+    
+    it 'creates partial_locals_test.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/partial_locals_test.html')
+      File.read(output).should == "<div id='p'>/partial_locals_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/partial_locals_test</h2>\n  <p>hello from local</p>\n</div>\n"
     end
     
     it 'creates child.html' do
@@ -111,19 +109,12 @@ describe Frank::Output do
   end
   
   context 'productions output' do
-    before(:all) do
-      proj_dir = File.join(File.dirname(__FILE__), 'template')
-      settings = YAML.load_file(File.join(proj_dir, 'settings.yml'))
-      require File.join(proj_dir, 'helpers')
-      capture_stdout do
-        Frank::Output.new do
-          settings.each do |name, value|
-            set name.to_s, value
-          end
-          set :environment, :output
-          set :proj_dir, proj_dir
-          set :output_folder, File.join(File.dirname(__FILE__), 'template/output')
-        end.dump(production=true)
+    before :all do
+      bin_dir    = File.join(File.dirname(File.dirname(__FILE__)), 'bin', 'frankout')
+      proj_dir   = File.join(File.dirname(__FILE__), 'template')
+      output_dir = File.join(proj_dir, 'output')
+      Dir.chdir proj_dir do
+        system "#{bin_dir} #{output_dir} --production > /dev/null"
       end
     end
   
@@ -136,9 +127,14 @@ describe Frank::Output do
       File.read(output).should == "<div id='p'>/</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/</h2>\n</div>\n"
     end
   
-    it  'creates partial_test.html' do
+    it 'creates partial_test.html' do
       output = File.join(File.dirname(__FILE__), 'template/output/partial_test/index.html')
-      File.read(output).should == "<div id='p'>/partial_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <p>hello from partial</p>\n</div>\n"
+      File.read(output).should == "<div id='p'>/partial_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/partial_test</h2>\n  <p>hello from partial</p>\n</div>\n"
+    end
+    
+    it 'creates partial_locals_test.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/partial_locals_test/index.html')
+      File.read(output).should == "<div id='p'>/partial_locals_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/partial_locals_test</h2>\n  <p>hello from local</p>\n</div>\n"
     end
     
     it 'creates child.html' do
@@ -217,4 +213,4 @@ describe Frank::Output do
     
   end
   
-end
+end

data/spec/render_spec.rb

@@ -56,7 +56,12 @@ describe Frank::Render do
    
    it 'renders haml template with a haml partial' do
      template = @app.render('partial_test.haml')
-     template.should == "<div id='p'>/partial_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <p>hello from partial</p>\n</div>\n"
+     template.should == "<div id='p'>/partial_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/partial_test</h2>\n  <p>hello from partial</p>\n</div>\n"
+   end
+
+   it 'renders a partial with locals' do
+     template = @app.render('partial_locals_test.haml')
+     template.should == "<div id='p'>/partial_locals_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/partial_locals_test</h2>\n  <p>hello from local</p>\n</div>\n"
    end
    
    it 'renders sass template' do
@@ -98,4 +103,4 @@ describe Frank::Render do
      lambda { @app.render('not_a.template') }.should raise_error(Frank::TemplateError)
    end
    
-end
+end

data/spec/template/dynamic/_partial_with_locals.haml

@@ -0,0 +1 @@
+%p="hello from #{local}"

data/spec/template/dynamic/partial_locals_test.haml

@@ -0,0 +1,3 @@
+%h1 hello worlds
+%h2= current_path
+= render_partial('partial_with_locals', :local => 'local')

data/spec/template/dynamic/partial_test.haml

@@ -1,2 +1,3 @@
 %h1 hello worlds
+%h2= current_path
 = render_partial('partial')

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - blahed
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-28 00:00:00 -04:00
+date: 2010-07-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -140,6 +140,7 @@ files:
 - spec/render_spec.rb
 - spec/template/dynamic/500.haml
 - spec/template/dynamic/_partial.haml
+- spec/template/dynamic/_partial_with_locals.haml
 - spec/template/dynamic/builder.builder
 - spec/template/dynamic/erb.erb
 - spec/template/dynamic/helper_test.haml
@@ -153,6 +154,7 @@ files:
 - spec/template/dynamic/nested/child.haml
 - spec/template/dynamic/nested/deeper/deep.haml
 - spec/template/dynamic/no_layout.haml
+- spec/template/dynamic/partial_locals_test.haml
 - spec/template/dynamic/partial_test.haml
 - spec/template/dynamic/redcloth.textile
 - spec/template/dynamic/refresh.haml