frank 0.2.3 → 0.2.4

data/README.md

@@ -2,11 +2,13 @@ Frank
 =========
 
 Inspired by [Sinatra][0]'s simplicity and ease of use, Frank lets you build
-static sites using your favorite libs, painlessly. It uses [Tilt][1], so it
-comes with support for [Haml & Sass][2], [LESS][10], [Builder][3], [ERB][4],
-[Liquid][5], & [Mustache][6].
+static sites using your favorite libs. Frank has a built in development server
+for previewing work as you develop. Frank also has a "dump" command for compiling and saving
+your work out to static html, css, and js.
 
-Frank also supports [CoffeeScript][7] for writing JavaScript in style.
+Frank uses [Tilt][1], so it
+comes with support for [Haml & Sass][2], [LESS][10], [Builder][3], [ERB][4],
+[Liquid][5], [Mustache][6], and [CoffeeScript][7].
 
 Overview
 --------
@@ -15,18 +17,22 @@ Create a new project with:
 
     $ frank <project_name>
 
-Then start up the server with:
-    
+Then `cd <project_name>` and start up the server with:
+  
     $ frankup
 
     -----------------------
      Frank's holdin' it down...
      0.0.0.0:3601
 
-And you're ready to get to work. Feel free to use as much or a little of
-the available libs as you please. Frank works just as well with Mustache /
-CSS / JavasScript as Haml / Sass / CoffeeScript.
+And you're ready to get to work. By default, dynamic templates are served from the `dynamic` folder
+and static files are served from the `static` folder.
+
+When you are finished:
+
+    $ frankout <dump_dir>
 
+This will compile and copy everything to the folder given.
 
 Views & Layouts
 -------------------------
@@ -100,6 +106,7 @@ This will return 3 sentences of standard [Lorem Ipsum][11]. `lorem` also has all
      lorem.word
      lorem.paragraphs 10
      lorem.paragraph
+     lorem.date         # accepts a strftime format argument
      lorem.name
      lorem.first_name
      lorem.last_name

data/bin/frankup

@@ -1,14 +1,60 @@
 #!/usr/bin/env ruby
+require 'optparse'
 require 'frank'
 
-begin
+options = {:server => {}}
+
+opts = OptionParser.new do |opts|
+  
+  opts.on('--server [HANDLER]', 'Set the server handler') do |handler|
+    options[:server]['handler'] = handler unless handler.nil?
+  end
+  
+  opts.on('--hostname [HOSTNAME]', 'Set the server hostname') do |hostname|
+    options[:server]['hostname'] = hostname unless hostname.nil?
+  end
+  
+  opts.on('--port [PORT]', 'Set the server port') do |port|
+    options[:server]['port'] = port unless port.nil?
+  end
+  
+  opts.on('--dynamic_folder [FOLDER]', 'Set the dynamic folder') do |folder|
+    options[:dynamic_folder] = folder unless folder.nil?
+  end
+  
+  opts.on('--static_folder [FOLDER]', 'Set the static folder') do |folder|
+    options[:static_folder] = folder unless folder.nil?
+  end
+  
+end.parse!
+
+if File.exist? 'settings.yml'
   settings = YAML.load_file('settings.yml')
-  Frank.new do
-    settings.each do |name, value|
-      set name.to_s, value
-    end
-    set :proj_dir, Dir.pwd
-  end
-rescue Errno::ENOENT
-  puts "Frank could not find settings.yml."
-end
+else
+  settings = { 
+    :server => { 'handler' => 'mongrel', 'hostname' => '127.0.0.1', 'port' => 3601 },
+    :static_folder => '.', 
+    :dynamic_folder => '.',
+    :environment => :serving  
+  }
+end
+
+options.each do |opt, val|
+  if opt == :server
+    server = settings['server'] ? settings['server'] : settings[:server]
+    val.each { |sopt, sval| server[sopt] = sval }
+  else
+    settings[opt] = val
+  end 
+end
+
+if settings[:environment] == :serving
+  puts "Could not find \"settings.yml\", serving up files from the this directory at http://#{settings[:server]['hostname']}:#{settings[:server]['port']}"
+end
+
+Frank.new do
+  settings.each do |name, value|
+    set name.to_s, value
+  end
+  set :proj_dir, Dir.pwd
+end

data/frank.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frank}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["blahed", "nwah"]
-  s.date = %q{2010-03-11}
+  s.date = %q{2010-03-29}
   s.description = %q{Create/Dump static builds using whatever templating/helper languages you wish}
   s.email = %q{travis.dunn@thisismedium.com}
   s.executables = ["frank", "frankout", "frankup"]
@@ -86,7 +86,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/blahed/frank}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Stupidly Simple Static Slinger}
   s.test_files = [
     "test/helper.rb",

data/lib/frank/base.rb

@@ -5,7 +5,7 @@ require 'frank/statik'
 require 'frank/imager'
 
 module Frank
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
   
   module Render; end
   
@@ -85,13 +85,14 @@ module Frank
     
     # renders a template
     def render_template(tmpl, *args)
-      tilt_with_request(File.join(@proj_dir, @dynamic_folder, tmpl), *args) {"CONTENT"}
+      tilt(File.join(@proj_dir, @dynamic_folder, tmpl), *args) {"CONTENT"}
     end
     
-    # renders layout and template inside layout block
+    # if template has a layout defined, render template within layout
+    # otherwise render template
     def render_with_layout(tmpl, *args)
       if layout = get_layout_for(tmpl)
-        tilt_with_request(File.join(@proj_dir, @dynamic_folder, layout), *args) do
+        tilt(File.join(@proj_dir, @dynamic_folder, layout), *args) do
           render_template tmpl
         end
       else
@@ -132,8 +133,7 @@ module Frank
       tmpl_ext
     end
     
-    # determines layout using layouts setting
-    # in settings.yml
+    # determines layout using layouts settings
     # TODO: cleanup
     def get_layout_for(view)
       view, ext = name_ext(view)
@@ -142,18 +142,20 @@ module Frank
       onlies = layouts.select {|l| l['only'] }
       nots = layouts.select {|l| l['not'] }
       blanks = layouts - onlies - nots
-    
-      layout = onlies.select {|l| l['only'].index(view) }.first
+            
+      layout = onlies.select {|l| l['only'].index(view) }.first 
       layout = nots.reject {|l| l['not'].index(view) }.first unless layout
       layout = blanks.first unless layout
-        
-      layout = nil if (TMPL_EXTS[:css] + TMPL_EXTS[:js]).include?(ext)
       
+      # TODO: we are checking for exts in two places, consolidate soon
+      layout = nil if !blanks.empty? && blanks.first['name'] == view
+      layout = nil if (TMPL_EXTS[:css] + TMPL_EXTS[:js]).include?(ext)
+            
       layout.nil? ? nil : layout['name'] + '.' + ext
     end
     
     # TODO: cleanup
-    def tilt_with_request(file, *args, &block)      
+    def tilt(file, *args, &block)      
       locals = @request.nil? ? {} : { :request => @env, :params => @request.params }
       obj = Object.new.extend(TemplateHelpers).extend(Render)
       obj.instance_variable_set(:@proj_dir, @proj_dir)
@@ -184,8 +186,8 @@ module Frank
       puts "\n-----------------------\n" +
            " Frank's #{ m }...\n" +
            " #{base.server['hostname']}:#{base.server['port']} \n\n"
-    
       server = Rack::Handler.get(base.server['handler'])
+      
       server.run(builder, :Port => base.server['port'], :Host => base.server['hostname']) do
         trap(:INT) { puts "\n\n-----------------------\n Show's over, fellas.\n\n"; exit }
       end

data/lib/frank/output.rb

@@ -10,7 +10,8 @@ module Frank
       instance_eval &block
       @output_path = File.join(@proj_dir, @output_folder)
     end
-        
+    
+    # get all of the templates and compile them
     def compile_templates
       dir = File.join(@proj_dir, @dynamic_folder)
       
@@ -26,13 +27,15 @@ module Frank
         end
       end
     end
-  
+    
+    # copies over static content
     def copy_static
       puts "Copying over your static content" unless @environment == :test
       static_folder = File.join(@proj_dir, @static_folder)
       FileUtils.cp_r(File.join(static_folder, '/.'), @output_path) 
     end
-  
+    
+    # create the dump dir, compile templates, copy over static assets
     def dump
       FileUtils.mkdir(@output_path)
       puts "Create #{@output_folder}" unless @environment == :test

data/lib/frank/rescue.rb

@@ -1,10 +1,13 @@
 module Frank
-  module Rescue
+  module Rescue    
     
     def render_404
       template = File.expand_path(File.dirname(__FILE__)) + '/templates/404.haml'
-      locals = { :request => @env, :dynamic_folder => @dynamic_folder, :static_folder => @static_folder }
-
+      locals = { :request => @env, 
+                 :dynamic_folder => @dynamic_folder, 
+                 :static_folder => @static_folder,
+                 :environment => @environment }
+                 
       @response['Content-Type'] = 'text/html'
       @response.status = 404
       @response.body = Tilt.new(template, 1).render(Object.new, locals = locals)

data/lib/frank/templates/404.haml

@@ -13,21 +13,22 @@
     #wrapper
       %img{:src=>'/__frank__/frank-404.png'}
       %h1= "Not Found—"
-      %p
-        - if request['REQUEST_PATH']
-          - path = request['REQUEST_PATH'][1..-1]
-          = "Try creating"
+      - unless environment == :serving
+        %p
+          - if request['REQUEST_PATH']
+            - path = request['REQUEST_PATH'][1..-1]
+            = "Try creating"
           
-          - if path.match(/\.css$/)
-            = "<tt>#{path.match(/([\w\/]+)\./)[1]}.sass</tt>"
-          - elsif path.match(/\.js$/)
-            = "<tt>#{path.match(/([\w\/]+)\./)[1]}.coffee</tt>"
-          - else
-            = "<tt>#{path.gsub(/\/$/, '')}.haml</tt>"
-          = "in the <tt>#{dynamic_folder}</tt> folder, or"
+            - if path.match(/\.css$/)
+              = "<tt>#{path.match(/([\w\/]+)\./)[1]}.sass</tt>"
+            - elsif path.match(/\.js$/)
+              = "<tt>#{path.match(/([\w\/]+)\./)[1]}.coffee</tt>"
+            - else
+              = "<tt>#{path.gsub(/\/$/, '')}.haml</tt>"
+            = "in the <tt>#{dynamic_folder}</tt> folder, or"
           
-          - if path.match(/\.\w+/)
-            = "<tt>#{path}</tt>"
-          - else
-            = "<tt>#{path.gsub(/\/$/, '')}.html</tt>"
-          = "in the <tt>#{static_folder}</tt> folder."
+            - if path.match(/\.\w+/)
+              = "<tt>#{path}</tt>"
+            - else
+              = "<tt>#{path.gsub(/\/$/, '')}.html</tt>"
+            = "in the <tt>#{static_folder}</tt> folder."

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: frank
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - blahed
@@ -10,59 +15,74 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-11 00:00:00 -05:00
+date: 2010-03-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
         version: "1.0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: mongrel
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
         version: "1.0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: haml
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
         version: "2.0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
         version: "2.0"
-    version: 
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rack-test
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
         version: "0.5"
-    version: 
+  type: :development
+  version_requirements: *id005
 description: Create/Dump static builds using whatever templating/helper languages you wish
 email: travis.dunn@thisismedium.com
 executables: 
@@ -152,18 +172,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Stupidly Simple Static Slinger