frank 0.1.3 → 0.2.0

data/README.md

@@ -81,6 +81,43 @@ Helper methods are also easy. Just open up `helpers.rb` and add your methods
 to the `FrankHelpers` module; that's it. Use them just like `render_partial`.
 
 
+
+Built-in Helpers
+----------------
+
+Frank also comes with some handy helper methods for generating placeholder content.
+
+### Placeholder Text
+
+You can easily generate dummy text like so:
+
+     %p= lorem.sentences 3
+
+This will return 3 sentences of standard [Lorem Ipsum][11]. `lorem` also has all of the following methods for generating dummy text:
+
+     lorem.sentence     # returns a single sentence
+     lorem.words 5      # returns 5 individual words
+     lorem.word
+     lorem.paragraphs 10
+     lorem.paragraph
+
+
+### Placeholder Images
+
+Likewise, Frank can generate placeholder images for you, from a selection of 10 pre-made images. For example, to generate `<img />` tag with a random dummy image:
+     
+     %img{:src=> lorem.image( 500, 400 ) }
+
+The `lorem.image` helper returns a special Frank image URL. In this case, the returned image will be 500 pixels wide and 400 pixels tall. By default, Frank caches the images returned for each specific size. So every subsequent request for a `500x400` image will return the same thing. If you'd rather have a random image every time, just pass in `true` for the 3rd image:
+     
+     lorem.image( 100, 100, true )    # returns a random 100x100 image every time it's called
+
+( NOTE: Unfortunately, in order to use the placeholder images, you must have a working [ImageMagick][12], and have the `mini_magick` gem installed as well. )
+
+If you would like to use the placeholder images in a context where the helper methods are unavailable (e.g. in static CSS or JavaScript), you can access the URL directly with `/_img/500x400.jpg`, or for random images `/_img/500x400.jpg?random`.
+
+
+
 GET/POST params
 ---------------
 
@@ -92,6 +129,8 @@ For example, to use a person's name submitted through a form you might do:
 
     %h1= "Hello, #{params.name}"
 
+
+
 Configuration
 -------------
 
@@ -124,4 +163,6 @@ Installation
 [7]: http://jashkenas.github.com/coffee-script/
 [8]: http://lesscss.org/
 [9]: http://rack.rubyforge.org/
-[10]: http://lesscss.org/
+[10]: http://lesscss.org/
+[11]: http://en.wikipedia.org/wiki/Lorem_ipsum
+[12]: http://www.imagemagick.org/script/binary-releases.php?ImageMagick=4pg9cdfr8e6gn7aru9mtelepr3

data/Rakefile

@@ -7,9 +7,12 @@ begin
     gemspec.email = "travis.dunn@thisismedium.com"
     gemspec.homepage = "http://github.com/blahed/frank"
     gemspec.authors = ["blahed", "nwah"]
-    gemspec.add_dependency 'rack'
-    gemspec.add_dependency 'mongrel'
-    gemspec.add_dependency 'haml'
+    gemspec.add_dependency 'rack', '>=1.0'
+    gemspec.add_dependency 'mongrel', '>=1.0'
+    gemspec.add_dependency 'haml', '>=2.0'
+    gemspec.add_development_dependency 'shoulda', '>=2.0'
+    gemspec.add_development_dependency 'rack-test', '>=0.5'
+    
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/bin/frank

@@ -1,33 +1,10 @@
 #!/usr/bin/env ruby
+require 'frank'
 
 if ARGV.empty?
   puts "Usage: frank [PROJECT_NAME]"
-  puts "Stubs out a template project; if a .frank folder was found, copies it over as your project base"
+  puts "Stubs out a template project"
   exit
 end
 
-puts "\n-----------------------\n Frank:\n"
-
-project   = ARGV.first
-libdir    = File.join(File.dirname(File.expand_path(__FILE__)), '../lib')
-dot_frank = File.join(ENV['HOME'], '.frank')
-
-puts " - Creating '#{project}'"
-begin
-  Dir.mkdir project
-rescue Errno::EEXIST
-  puts " uh oh, #{project} already exists..."
-  exit
-end
-
-# If they have a .frank, copy contents to new project folder
-if File.directory? dot_frank
-  puts " - Copying .frank template"
-  FileUtils.cp_r( File.join(dot_frank, '.'), project )
-else # Otherwise just copy over the template project
-  puts " - Copying Frank template"
-  FileUtils.cp_r( Dir.glob(File.join(libdir, 'template/*')), project )
-end
-
-puts "\n Congratulations, '#{project}' is ready to go.\n\n"
-
+Frank.stub(ARGV.first)

data/bin/frankup

@@ -7,6 +7,7 @@ begin
     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."

data/frank.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frank}
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["blahed", "nwah"]
-  s.date = %q{2010-02-18}
+  s.date = %q{2010-02-26}
   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"]
@@ -29,6 +29,8 @@ Gem::Specification.new do |s|
      "frank.gemspec",
      "lib/frank.rb",
      "lib/frank/base.rb",
+     "lib/frank/imager.rb",
+     "lib/frank/lorem.rb",
      "lib/frank/output.rb",
      "lib/frank/rescue.rb",
      "lib/frank/statik.rb",
@@ -37,6 +39,16 @@ Gem::Specification.new do |s|
      "lib/frank/templates/500.haml",
      "lib/frank/templates/frank-404.png",
      "lib/frank/templates/frank-500.png",
+     "lib/frank/templates/imager/frank0.jpg",
+     "lib/frank/templates/imager/frank1.jpg",
+     "lib/frank/templates/imager/frank2.jpg",
+     "lib/frank/templates/imager/frank3.jpg",
+     "lib/frank/templates/imager/frank4.jpg",
+     "lib/frank/templates/imager/frank5.jpg",
+     "lib/frank/templates/imager/frank6.jpg",
+     "lib/frank/templates/imager/frank7.jpg",
+     "lib/frank/templates/imager/frank8.jpg",
+     "lib/frank/templates/imager/frank9.png",
      "lib/frank/tilt.rb",
      "lib/template/dynamic/css/frank.sass",
      "lib/template/dynamic/index.haml",
@@ -44,31 +56,72 @@ Gem::Specification.new do |s|
      "lib/template/helpers.rb",
      "lib/template/settings.yml",
      "lib/template/static/images/frank-med.png",
-     "lib/template/static/js/frank.js"
+     "lib/template/static/js/frank.js",
+     "test/helper.rb",
+     "test/suite.rb",
+     "test/template/dynamic/_partial.haml",
+     "test/template/dynamic/builder.builder",
+     "test/template/dynamic/coffee.coffee",
+     "test/template/dynamic/erb.erb",
+     "test/template/dynamic/helper_test.haml",
+     "test/template/dynamic/index.haml",
+     "test/template/dynamic/layout.haml",
+     "test/template/dynamic/layout2.haml",
+     "test/template/dynamic/layout2_test.haml",
+     "test/template/dynamic/layout_test.haml",
+     "test/template/dynamic/liquid.liquid",
+     "test/template/dynamic/lorem_test.haml",
+     "test/template/dynamic/markdown.md",
+     "test/template/dynamic/mustache.mustache",
+     "test/template/dynamic/partial_test.haml",
+     "test/template/dynamic/redcloth.textile",
+     "test/template/dynamic/sass.sass",
+     "test/template/helpers.rb",
+     "test/template/settings.yml",
+     "test/template/static/static.html",
+     "test/test_base.rb",
+     "test/test_helpers.rb",
+     "test/test_output.rb",
+     "test/test_render.rb"
   ]
   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.summary = %q{Stupidly Simple Static Slinger}
+  s.test_files = [
+    "test/helper.rb",
+     "test/suite.rb",
+     "test/template/helpers.rb",
+     "test/test_base.rb",
+     "test/test_helpers.rb",
+     "test/test_output.rb",
+     "test/test_render.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rack>, [">= 0"])
-      s.add_runtime_dependency(%q<mongrel>, [">= 0"])
-      s.add_runtime_dependency(%q<haml>, [">= 0"])
+      s.add_runtime_dependency(%q<rack>, [">= 1.0"])
+      s.add_runtime_dependency(%q<mongrel>, [">= 1.0"])
+      s.add_runtime_dependency(%q<haml>, [">= 2.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 2.0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0.5"])
     else
-      s.add_dependency(%q<rack>, [">= 0"])
-      s.add_dependency(%q<mongrel>, [">= 0"])
-      s.add_dependency(%q<haml>, [">= 0"])
+      s.add_dependency(%q<rack>, [">= 1.0"])
+      s.add_dependency(%q<mongrel>, [">= 1.0"])
+      s.add_dependency(%q<haml>, [">= 2.0"])
+      s.add_dependency(%q<shoulda>, [">= 2.0"])
+      s.add_dependency(%q<rack-test>, [">= 0.5"])
     end
   else
-    s.add_dependency(%q<rack>, [">= 0"])
-    s.add_dependency(%q<mongrel>, [">= 0"])
-    s.add_dependency(%q<haml>, [">= 0"])
+    s.add_dependency(%q<rack>, [">= 1.0"])
+    s.add_dependency(%q<mongrel>, [">= 1.0"])
+    s.add_dependency(%q<haml>, [">= 2.0"])
+    s.add_dependency(%q<shoulda>, [">= 2.0"])
+    s.add_dependency(%q<rack-test>, [">= 0.5"])
   end
 end
 

data/lib/frank.rb

@@ -1,7 +1,14 @@
-libdir = File.dirname(__FILE__)
-$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+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
+
+module Frank
+  class TemplateError < StandardError; end
+  class ConfigError < StandardError; end
+end
 
-require File.join(Dir.pwd, 'helpers')
 require 'rubygems'
 require 'frank/base'
 require 'frank/output'

data/lib/frank/base.rb

@@ -3,23 +3,24 @@ require 'frank/tilt'
 require 'frank/template_helpers'
 require 'frank/rescue'
 require 'frank/statik'
+require 'frank/imager'
 
 module Frank
   
   module Render; end
-    
+  
   class Base
     include Rack::Utils
     include Frank::Rescue
     include Frank::TemplateHelpers
     include Frank::Render
     
-    attr_accessor :server, :static_folder, :dynamic_folder, :templates
+    attr_accessor  :environment, :proj_dir, :server, :static_folder, :dynamic_folder, :templates
     
     def initialize(&block)
       instance_eval &block
     end
-  
+
     def call(env)
       dup.call!(env)
     end
@@ -36,7 +37,7 @@ module Frank
     private
     
     # setter for options
-    def set(option, value)      
+    def set(option, value)  
       if respond_to?("#{option}=")
         send "#{option}=", value
       end
@@ -45,22 +46,20 @@ module Frank
     # attempt to render with the request path,
     # if it cannot be found, render error page
     def process
-      begin
-        ext = File.extname(@request.path.split('/').last || '')
-        @response['Content-Type'] = Rack::Mime.mime_type(ext, 'text/html')
-        @response.write render_path(@request.path)
-      rescue Errno::ENOENT
-        render_404
-      rescue Exception => e
-        render_500 e
-      end
+      ext = File.extname(@request.path.split('/').last || '')
+      @response['Content-Type'] = Rack::Mime.mime_type(ext, 'text/html')
+      @response.write render_path(@request.path)
+    rescue Frank::TemplateError
+      render_404
+    rescue Exception => e
+      render_500 e
     end
     
     # prints requests and errors to STDOUT
     def log_request(status, excp=nil)
-      out = "[#{Time.now.strftime('%Y-%m-%d %H:%M')}] (#{@server['handler'].capitalize}) http://#{@request.host}:#{@request.port}#{@request.fullpath} [#{@request.request_method}] - #{status}"
+      out = "[#{Time.now.strftime('%Y-%m-%d %H:%M')}] (#{@request.request_method}) http://#{@request.host}:#{@request.port}#{@request.fullpath} - #{status}"
       out += "\n\n**QUACK** #{excp.message}\n\n#{excp.backtrace.join("\n")} " if excp
-      STDOUT.puts out
+      STDOUT.puts out unless @environment == :test
     end
     
   end
@@ -71,25 +70,28 @@ module Frank
       return path.split(/\.(?=[^.]+$)/)
     end
     
+    # breaks down path and renders partials, js, css without layouts
     def render_path(path)
       path.sub!(/^\//,'')
       template, ext = find_template_ext(path)
-      raise Errno::ENOENT if template.nil?
-
+      
+      raise Frank::TemplateError, "Template not found #{path}" if template.nil?
       if template.match(/^_/) or (ext||'').match(/^(js|css)$/)
         render_template template
       else
         render_with_layout template
       end
     end
-
+    
+    # renders a template
     def render_template(tmpl, *args)
-      tilt_with_request(File.join(@dynamic_folder, tmpl), *args) {"CONTENT"}
+      tilt_with_request(File.join(@proj_dir, @dynamic_folder, tmpl), *args) {"CONTENT"}
     end
-
+    
+    # renders layout and template inside layout block
     def render_with_layout(tmpl, *args)
       if layout = get_layout_for(tmpl)
-        tilt_with_request(File.join(@dynamic_folder, layout), *args) do
+        tilt_with_request(File.join(@proj_dir, @dynamic_folder, layout), *args) do
           render_template tmpl
         end
       else
@@ -97,7 +99,7 @@ module Frank
       end
     end
     
-    TMPL_EXTS = { :html => %w[haml erb rhtml builder liquid mustache],
+    TMPL_EXTS = { :html => %w[haml erb rhtml builder liquid mustache textile md mkd markdown],
                   :css => %w[sass less],
                   :js => %w[coffee] }
                   
@@ -107,29 +109,36 @@ module Frank
       end
       nil
     end
-
+    
+    # finds template extension based on filename
+    # TODO: cleanup
     def find_template_ext(filename)
-      name, kind = name_ext(filename)
-      kind = reverse_ext_lookup(kind) if kind && TMPL_EXTS[kind.intern].nil?
+      name, kind = name_ext(filename)      
+      kind = reverse_ext_lookup(kind) if kind && TMPL_EXTS[kind.intern].nil?      
       
-      TMPL_EXTS[ kind.nil? ? :html : kind.intern ].each do |ext|
-        tmpl = "#{(name||'')}.#{ext}"
-        return [tmpl, kind] if File.exists? File.join(@dynamic_folder, tmpl)
-      end
+      tmpl_ext = nil
       
       TMPL_EXTS[ kind.nil? ? :html : kind.intern ].each do |ext|
+        tmpl = "#{(name||'')}.#{ext}"
         default = File.join((name||''), "#{@templates['default']}.#{ext}")
-        return [default, kind] if File.exists? File.join(@dynamic_folder, default)
+        
+        if File.exists? File.join(@proj_dir, @dynamic_folder, tmpl)
+          tmpl_ext = [tmpl, ext] 
+        elsif File.exists? File.join(@proj_dir, @dynamic_folder, default)
+          tmpl_ext = [default, ext]
+        end
       end
-      nil
-    rescue
-      nil
+      
+      tmpl_ext
     end
     
+    # determines layout using layouts setting
+    # in settings.yml
+    # TODO: cleanup
     def get_layout_for(view)
       view, ext = name_ext(view)
+      
       layouts = @templates['layouts'] || []
-    
       onlies = layouts.select {|l| l['only'] }
       nots = layouts.select {|l| l['not'] }
       blanks = layouts - onlies - nots
@@ -137,17 +146,17 @@ module Frank
       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)
+      
       layout.nil? ? nil : layout['name'] + '.' + ext
     end
     
-    def tilt_lang(file, lang, *tilt_args, &block)
-      Tilt[lang].new(file, 1).render(*tilt_args, &block)
-    end
-    
-    def tilt_with_request(file, *args, &block)
+    # TODO: cleanup
+    def tilt_with_request(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)
       obj.instance_variable_set(:@dynamic_folder, @dynamic_folder)
       obj.instance_variable_set(:@templates, @templates)
       Tilt.new(file, 1).render(obj, locals, &block)
@@ -159,29 +168,45 @@ module Frank
     
   end
   
+  # starts the server
   def self.new(&block)
     base = Base.new(&block) if block_given?
-    server_settings = base.instance_variable_get(:@server)
     
     builder = Rack::Builder.new do
-      use Rack::Statik, :root => base.instance_variable_get(:@static_folder)
+      use Frank::Statik, :root => base.static_folder
+      use Frank::Imager
       run base
     end
+
+    unless base.environment == :test
+      m = "got it under control \n got your back \n holdin' it down
+             takin' care of business \n workin' some magic".split("\n").sort_by{rand}.first.strip
+      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
+    end
     
-    m = "got it under control \n got your back \n holdin' it down
-         takin' care of business \n workin' some magic".split("\n").sort_by{rand}.first.strip
-    puts "\n-----------------------\n" +
-         " Frank's #{ m }...\n" +
-         " #{server_settings['hostname']}:#{server_settings['port']} \n\n"
+    base
     
-    server = Rack::Handler.get(server_settings['handler'])
-    server.run(builder, :Port => server_settings['port'], :Host => server_settings['hostname']) do
-      trap(:INT) { puts "\n\n-----------------------\n Show's over, fellas.\n\n"; exit }
-    end
-        
-  rescue Errno::EADDRINUSE
-    puts " Hold on a second... Frank works alone.\n \033[31mSomething's already using port #{server_settings['port']}\033[0m\n\n"
-      
+    rescue Errno::EADDRINUSE
+      puts " Hold on a second... Frank works alone.\n \033[31mSomething's already using port #{base.server['port']}\033[0m\n\n"
+  end
+  
+  # copies over the generic project template
+  def self.stub(project)
+    puts "\n-----------------------\n Frank:\n - Creating '#{project}'"
+    Dir.mkdir project
+    puts " - Copying Frank template"
+    FileUtils.cp_r( Dir.glob(File.join(LIBDIR, 'template/*')), project )
+    puts "\n Congratulations, '#{project}' is ready to go.\n\n"
+  rescue Errno::EEXIST
+    puts " uh oh, #{project} already exists..."
+    exit
   end
   
 end