frank 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+lib/frank/output_old.rb

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Travis Dunn
+ 
+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

@@ -0,0 +1,127 @@
+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], [Builder][3], [ERB][4],
+[Liquid][5], & [Mustache][6].
+
+Frank also supports [CoffeeScript][7] for writing JavaScript in style, and
+[LESS][8] is planned for the near future.
+
+Overview
+--------
+
+Create a new project with:
+
+    $ frank <project_name>
+
+Then 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.
+
+
+Views & Layouts
+-------------------------
+
+All of your templates, and less/sass/coffeescript go into `<project>/dynamic`,
+by default. You are more than welcome to organize them into subfolders if you've
+got lots.
+
+### Views
+
+Writing views is simple. Say you've got a `blog.haml`, in `<project>/dynamic` just browse to
+`http://0.0.0.0:3601/blog` and your view will be parsed and returned as html.
+
+### Layouts
+
+Layouts are also simple with Frank. By default, just create a `layout.haml`
+(or whichever language you like best), that contains a `yield`, and any
+views will be inserted into it at that point.
+
+Multiple layouts are also easy. In your `settings.yml`, do something like:
+
+    layouts:
+        - name: blog_layout
+          only: [blog]
+        - name: normal
+          not: [blog, ajax]
+This tells Frank to use `blog_layout.haml` for `/blog`, and `normal.haml`
+for everything but `/blog' and '/ajax`.
+
+
+Partials & Helpers
+------------------
+
+Frank comes with a helper method, `render_partial`, for including partials
+in your views.
+
+In addition, you can also easily add your own helper methods to use.
+
+### Partials
+
+To create a partial, make a new file like any of your other views, but
+prefix its name with an underscore.
+
+For example, if I have a partial named `_footer.haml`, I can include this
+in my Haml views like this:
+
+    = render_partial 'footer'
+
+### Helpers
+
+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`.
+
+
+GET/POST params
+---------------
+
+Sometimes it's nice to include user input in your mock-ups. It's especially
+handy when mocking-up Ajax-driven elements. For this reason, the `request`
+and `params` are available in your templates.
+
+For example, to use a person's name submitted through a form you might do:
+
+    %h1= "Hello, #{params.name}"
+
+Configuration
+-------------
+
+In `settings.yml`, you can change your folder names, and server port & host name.
+Check the comments there if you need help.
+
+Once you've gotten comfortable with Frank, you will probably no longer want
+the example files included whenever you start a new project. You may also have
+preferred folder names, and languages that you always want to start
+projects with.
+
+To do this, create a new base project. Then just copy your base project to `~/.frank`.
+This folder will then be copied for you whenever you run the `frank` command.
+  
+Installation
+------------
+
+### [Gemcutter](http://gemcutter.org/)
+
+    $ gem install frank
+
+
+[0]: http://www.sinatrarb.com/
+[1]: http://github.com/rtomayko/tilt
+[2]: http://haml-lang.com/
+[3]: http://builder.rubyforge.org/
+[4]: http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/
+[5]: http://www.liquidmarkup.org/
+[6]: http://github.com/defunkt/mustache
+[7]: http://jashkenas.github.com/coffee-script/
+[8]: http://lesscss.org/
+[9]: http://rack.rubyforge.org/

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "frank"
+    gemspec.summary = "Stupidly Simple Static Slinger"
+    gemspec.description = "Create/Dump static builds using whatever templating/helper languages you wish"
+    gemspec.email = "travis.dunn@thisismedium.com"
+    gemspec.homepage = "http://github.com/blahed/frank"
+    gemspec.authors = ["blahed", "nwah"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/frank

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+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"
+  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"
+

data/bin/frankout

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'frank'
+
+if ARGV.empty?
+  puts "Usage: frankout [DUMP_DIR]"
+  puts "Compiles and dumps a project and it\'s static files to given folder"
+  exit
+end
+
+output_folder = ARGV.first
+
+if File.exists? output_folder
+  print "Folder: #{output_folder} already exists... do you want to overwrite it? (y|n) "
+  resp = STDIN.gets.chomp.strip
+  exit if resp.downcase.strip != 'y'
+  FileUtils.rm_rf(output_folder)
+end
+
+begin
+  settings = YAML.load_file('settings.yml')
+  proj_dir = Dir.pwd
+  
+  Frank::Output.new do
+    settings.each do |name, value|
+      set name.to_s, value
+    end
+    set :output_folder, output_folder
+    set :proj_dir, proj_dir
+  end.dump
+  
+rescue Errno::ENOENT
+  puts "Frank could not find settings.yml."
+end

data/bin/frankup

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'frank'
+
+begin
+  settings = YAML.load_file('settings.yml')
+  Frank.new do
+    settings.each do |name, value|
+      set name.to_s, value
+    end
+  end
+rescue Errno::ENOENT
+  puts "Frank could not find settings.yml."
+end

data/frank.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{frank}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["blahed", "nwah"]
+  s.date = %q{2010-01-15}
+  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"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bin/frank",
+     "bin/frankout",
+     "bin/frankup",
+     "frank.gemspec",
+     "lib/frank.rb",
+     "lib/frank/base.rb",
+     "lib/frank/output.rb",
+     "lib/frank/rescue.rb",
+     "lib/frank/statik.rb",
+     "lib/frank/template_helpers.rb",
+     "lib/frank/templates/404.haml",
+     "lib/frank/templates/500.haml",
+     "lib/frank/templates/frank-404.png",
+     "lib/frank/templates/frank-500.png",
+     "lib/frank/tilt.rb",
+     "lib/template/dynamic/css/frank.sass",
+     "lib/template/dynamic/index.haml",
+     "lib/template/dynamic/js/frank.coffee",
+     "lib/template/dynamic/layout.haml",
+     "lib/template/helpers.rb",
+     "lib/template/settings.yml",
+     "lib/template/static/images/frank-med.png"
+  ]
+  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}
+
+  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
+    else
+    end
+  else
+  end
+end
+

data/lib/frank.rb

@@ -0,0 +1,7 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require File.join(Dir.pwd, 'helpers')
+require 'rubygems'
+require 'frank/base'
+require 'frank/output'

data/lib/frank/base.rb

@@ -0,0 +1,185 @@
+require 'rack'
+require 'frank/tilt'
+require 'frank/template_helpers'
+require 'frank/rescue'
+require 'frank/statik'
+
+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
+    
+    def initialize(&block)
+      instance_eval &block
+    end
+  
+    def call(env)
+      dup.call!(env)
+    end
+  
+    def call!(env)
+      @env = env
+      @request = Rack::Request.new(env)
+      @response = Rack::Response.new
+      process
+      @response.close
+      @response.finish
+    end
+    
+    private
+    
+    # setter for options
+    def set(option, value)      
+      if respond_to?("#{option}=")
+        send "#{option}=", value
+      end
+    end
+    
+    # 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
+    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 += "\n\n**QUACK** #{excp.message}\n\n#{excp.backtrace.join("\n")} " if excp
+      STDOUT.puts out
+    end
+    
+  end
+  
+  module Render
+    
+    def name_ext(path)
+      return path.split(/\.(?=[^.]+$)/)
+    end
+    
+    def render_path(path)
+      path.sub!(/^\//,'')
+      template, ext = find_template_ext(path)
+      raise Errno::ENOENT if template.nil?
+
+      if template.match(/^_/) or (ext||'').match(/^(js|css)$/)
+        render_template template
+      else
+        render_with_layout template
+      end
+    end
+
+    def render_template(tmpl, *args)
+      tilt_with_request(File.join(@dynamic_folder, tmpl), *args) {"CONTENT"}
+    end
+
+    def render_with_layout(tmpl, *args)
+      if layout = get_layout_for(tmpl)
+        tilt_with_request(File.join(@dynamic_folder, layout), *args) do
+          render_template tmpl
+        end
+      else
+        render_template tmpl
+      end
+    end
+    
+    TMPL_EXTS = { :html => %w[haml erb rhtml builder liquid mustache],
+                  :css => %w[sass less],
+                  :js => %w[coffee] }
+                  
+    def reverse_ext_lookup(ext)
+      TMPL_EXTS.each do |kind, exts|
+        return kind.to_s if exts.index(ext)
+      end
+      nil
+    end
+
+    def find_template_ext(filename)
+      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_EXTS[ kind.nil? ? :html : kind.intern ].each do |ext|
+        default = File.join((name||''), "#{@templates['default']}.#{ext}")
+        return [default, kind] if File.exists? File.join(@dynamic_folder, default)
+      end
+      nil
+    rescue
+      nil
+    end
+    
+    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
+    
+      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? ? 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)
+      locals = @request.nil? ? {} : { :request => @env, :params => @request.params }
+      obj = Object.new.extend(TemplateHelpers).extend(Render)
+      obj.instance_variable_set(:@dynamic_folder, @dynamic_folder)
+      obj.instance_variable_set(:@templates, @templates)
+      Tilt.new(file, 1).render(obj, locals, &block)
+    end
+  
+    def remove_ext(path)
+      path.gsub(File.extname(path), '')
+    end
+    
+  end
+  
+  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)
+      run base
+    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"
+    
+    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
+    
+    base
+  end
+  
+end