frank 0.3.2 → 0.4.0

data/.gitignore

@@ -1,3 +1,6 @@
 .DS_Store
 pkg
-lib/frank/output_old.rb
+lib/frank/output_old.rb
+.rvmrc
+.sass-cache
+.bundle

data/Gemfile

@@ -0,0 +1,27 @@
+source :gemcutter
+gem "rack", ">=1.0"
+gem "mongrel", ">=1.0"
+gem "haml", ">=3.0"
+gem "tilt", "=0.9"
+
+# dev dependencies
+gem "jeweler"
+gem "rspec", ">=2.0.0.beta.19"
+gem "rack-test", ">=0.5"
+gem "rake"
+
+# tilt dev dependencies
+gem 'contest'
+gem 'builder'
+gem 'erubis'
+gem 'compass', '>= 0.10.2'
+gem 'mustache'
+gem 'rdiscount'
+gem 'liquid'
+gem 'less'
+gem 'coffee-script'
+gem "RedCloth"
+
+gem "mini_magick"
+
+gem 'ruby-debug'

data/Gemfile.lock

@@ -0,0 +1,90 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.3)
+    abstract (1.0.0)
+    builder (2.1.2)
+    cgi_multipart_eof_fix (2.5.0)
+    coffee-script (0.3.2)
+    columnize (0.3.1)
+    compass (0.10.2)
+      haml (>= 3.0.4)
+    contest (0.1.2)
+    daemons (1.1.0)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    fastthread (1.0.7)
+    gem_plugin (0.2.3)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    haml (3.0.13)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.3)
+    less (1.2.21)
+      mutter (>= 0.4.2)
+      treetop (>= 1.4.2)
+    linecache (0.43)
+    liquid (2.1.2)
+    mini_magick (1.3.1)
+      subexec (~> 0.0.4)
+    mongrel (1.1.5)
+      cgi_multipart_eof_fix (>= 2.4)
+      daemons (>= 1.0.3)
+      fastthread (>= 1.0.1)
+      gem_plugin (>= 0.2.3)
+    mustache (0.11.2)
+    mutter (0.5.3)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rdiscount (1.6.5)
+    rspec (2.0.0.beta.19)
+      rspec-core (= 2.0.0.beta.19)
+      rspec-expectations (= 2.0.0.beta.19)
+      rspec-mocks (= 2.0.0.beta.19)
+    rspec-core (2.0.0.beta.19)
+    rspec-expectations (2.0.0.beta.19)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.19)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    subexec (0.0.4)
+    tilt (0.9)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  builder
+  coffee-script
+  compass (>= 0.10.2)
+  contest
+  erubis
+  haml (>= 3.0)
+  jeweler
+  less
+  liquid
+  mini_magick
+  mongrel (>= 1.0)
+  mustache
+  rack (>= 1.0)
+  rack-test (>= 0.5)
+  rake
+  rdiscount
+  rspec (>= 2.0.0.beta.19)
+  ruby-debug
+  tilt (= 0.9)

data/README.md

@@ -15,29 +15,34 @@ Overview
 
 Create a new project with:
 
-    $ frank <project_name>
+    $ frank new <project_path>
 
-Then `cd <project_name>` and start up the server with:
-  
-    $ frankup
+Then `cd <project_path>` and start up the server with:
+
+    $ frank server
 
     -----------------------
      Frank's holdin' it down...
      0.0.0.0:3601
 
-And you're ready to get to work. By default, dynamic templates are served from the `dynamic` folder, 
+And you're ready to get to work. By default, dynamic templates are served from the `dynamic` folder,
 static files are served from the `static` folder, and layouts are served from the `layouts` folder.
 
 When you're done working:
 
-    $ frankout <dump_dir>
+    $ frank export <export_dir>
+
+to compile templates and copy them--along with static your assets--into `<export_dir>`. Or,
 
-to compile templates and copy them--along with static your assets--into `<dump_dir>`. Or,
-    
-    $ frankout --production <dump_dir>
+    $ frank export --production <export_dir>
 
 to compile & copy over, but organized to work as a static website in production. (e.g. folders named after your views, with an `index.html` inside)
 
+Upgrading to 0.4
+-------------------------
+
+As of version 0.4, Frank no longer uses settings.yml. However you can use `frank upgrade` in order convert your old settings.yml to the new setup.rb format.
+
 Views & Meta Data
 -------------------------
 
@@ -67,13 +72,13 @@ support them--in the view & layout:
       title: My Rad Page
       author: My Rad Self
       ---------------------------------------------META
-      
+
       %h1= title
       %h3= 'By ' + author
-      
+
     layout:
       %title= title + '--My Rad Site'
-    
+
 
 
 Layouts (updated in 0.3)
@@ -146,12 +151,12 @@ Frank now has a handy automatic page refreshing helper. Just include `= refresh`
 save a project file. This eliminates the tedium of hundreds of manual refreshes over the course
 of building a project.
 
-When it's time to `frankout`, Frank will leave out the JavasScript bits of the refresher.
+When it's time export with `frank export`, Frank will leave out the JavasScript bits of the refresher.
 
 ### Current Path
 
 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.
+It will return the path info from the template being processed. You also, have access to the variable from layouts and from the `frank export` command.
 
 ### Placeholder Text
 
@@ -171,38 +176,31 @@ This will return 3 sentences of standard [Lorem Ipsum][11]. `lorem` also has all
      lorem.first_name
      lorem.last_name
      lorem.email
-     
 
-### 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
+### Placeholder Images
 
-( 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. )
+Frank now uses [placehold.it][14] for placeholder images, the `lorem.image` helper supports background_color, color, random_color, and text options:
 
-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`.
+     lorem.image('300x400')                                               #=> http://placehold.it/300x400
+     lorem.image('300x400', :background_color => '333', :color => 'fff')  #=> http://placehold.it/300x400/333/fff
+     lorem.image('300x400', :random_color => true)                        #=> http://placehold.it/300x400/f47av7/9fbc34d
+     lorem.image('300x400', :text => 'blah')                              #=> http://placehold.it/300x400&text=blah
 
 ### Replacement Text
 
-All of the lorem helpers accept an optional "replacement" argument. This will be the text rendered when you `frankout`.
-For example `lorem.sentence("<%= page.content %>")` will generate a lorem sentence when you view the page using the `frankup` server.
-However, when you `frankout` the template will render "<%= page.content %>". This is useful if you plan on moving a frank project
+All of the lorem helpers accept an optional "replacement" argument. This will be the text rendered when you `frank export`.
+For example `lorem.sentence("<%= page.content %>")` will generate a lorem sentence when you view the page using the `frank server` for development.
+However, when you `frank export` the template will render "<%= page.content %>". This is useful if you plan on moving a frank project
 into a framework. (e.g. rails, sinatra, django, etc)
 
 
 Configuration
 -------------
 
-In `settings.yml`, you can change your folder names, and server port & host name.
+In `setup.rb`, you can change your folder names, and server port & host name.
 Check the comments there if you need help.
 
-(NOTE: In order to reduce confusion, Frank no longer checks for a `~/.frank` folder to copy when you run the `frank` command. Instead, the preferred method is just to create a base Frank project wherever you please, and just `cp -r` to the location of your new project, since this is all the `frank` command did anyway)
-  
 Installation
 ------------
 
@@ -224,3 +222,4 @@ Installation
 [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
+[14]: http://placehold.it

data/Rakefile

@@ -1,3 +1,4 @@
+$LOAD_PATH << "./lib"
 require File.dirname(__FILE__) + "/lib/frank.rb"
 
 begin
@@ -11,11 +12,11 @@ begin
     gemspec.homepage = "http://github.com/blahed/frank"
     gemspec.authors = ["blahed", "nwah"]
     gemspec.add_dependency 'rack', '>=1.0'
-    gemspec.add_dependency 'mongrel', '>=1.0'
-    gemspec.add_dependency 'haml', '>=2.0'
-    gemspec.add_development_dependency 'rspec'
+    gemspec.add_dependency 'haml', '>=3.0'
+    gemspec.add_dependency 'tilt', '=0.9'
+    gemspec.add_development_dependency 'rspec', ">=2.0.0.beta.19"
     gemspec.add_development_dependency 'rack-test', '>=0.5'
-    
+
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/bin/frank

@@ -2,14 +2,132 @@
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'frank'
+require 'optparse'
+
+begin
+  # try to use bundler if its available
+  require 'bundler'
+  begin
+    Bundler.require
+  rescue Bundler::GemfileNotFound
+    # revert to using local frank install
+    $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+  end
+rescue LoadError
+  # revert to using local frank install
+  $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+end
+
+options = {:server => {}}
+
+banner = <<-USAGE
+Usage:
+  frank new PROJECT_PATH
+  frank server [options]
+  frank export PATH [options]
+
+Description:
+  The `frank new' command generates a frank template project with the default
+  directory structure and configuration at the given path.
+
+  Once you have a frank project you can use the `frank server' or the aliased 'frank up' commands
+  to start the development server and begin developing your project.
+
+  When you are finished working and ready to export you can use
+  the `frank export' or aliased `frank out' commands.
+
+Example:
+  frank new ~/Dev/blah.com
+  cd ~/Dev/blah.com
+  frank server
+
+  # do some development
+
+  frank export ~/Dev/html/blah.com
+USAGE
+
+
+opts = OptionParser.new do |opts|
+  opts.banner = banner
+
+  opts.separator ''
+  opts.separator 'Options:'
+
+  opts.on('--server [HANDLER]', 'Set the server handler (frank server)') do |handler|
+    options[:server]['handler'] = handler unless handler.nil?
+  end
+
+  opts.on('--hostname [HOSTNAME]', 'Set the server hostname (frank server)') do |hostname|
+    options[:server]['hostname'] = hostname unless hostname.nil?
+  end
+
+  opts.on('--port [PORT]', 'Set the server port (frank server)') do |port|
+    options[:server]['port'] = port unless port.nil?
+  end
+
+  opts.on('--dynamic_folder [FOLDER]', 'Set the dynamic folder (frank server)') do |folder|
+    options[:dynamic_folder] = folder unless folder.nil?
+  end
+
+  opts.on('--static_folder [FOLDER]', 'Set the static folder (frank server)') do |folder|
+    options[:static_folder] = folder unless folder.nil?
+  end
+
+  opts.on('--production', 'Production ready export (frank export) i.e. ([FOLDER]/index.html)') do |handler|
+    options[:production] = true
+  end
+
+  opts.on('-v', '--version', 'Show the frank version and exit') do
+    puts "Frank v#{Frank::VERSION}"
+    exit
+  end
+
+  opts.on( '-h', '--help', 'Display this help' ) do
+    puts opts
+    exit
+  end
+end
+
+opts.parse!
 
 if ARGV.empty?
-  puts "Usage: frank [PROJECT_NAME]"
-  puts "Stubs out a template project"
+  puts opts
   exit
-elsif ['-v', '--version'].include?(ARGV.first)
-  puts "Frank v#{Frank::VERSION}"
-  exit
-end
+else
+  if %w[server up export out upgrade].include? ARGV.first
+    begin
+      Frank.bootstrap(Dir.pwd)
+    rescue Errno::ENOENT
+      if File.exist? File.join(Dir.pwd, 'helpers.rb')
+        puts "Frank could not find setup.rb, perhaps you need to upgrade with the `frank upgrade' command"
+      else
+        puts "Frank could not find setup.rb"
+      end
+    end
+  end
+
+  case ARGV.first
+  when 'new', 'n'
+    # stub out the project
+    Frank.stub(ARGV[1])
+  when 'server', 's', 'up'
+    # setup server from options
+    server_options        = options[:server]
+    Frank.server.handler  = server_options['handler'] if server_options['handler']
+    Frank.server.hostname = server_options['hostname'] if server_options['hostname']
+    Frank.server.port     = server_options['port'] if server_options['port']
 
-Frank.stub(ARGV.first)
+    # setup folder options
+    Frank.dynamic_folder = options[:dynamic_folder] if options[:dynamic_folder]
+    Frank.static_folder  = options[:static_folder] if options[:static_folder]
+    Frank.new
+  when 'export', 'e', 'out'
+    Frank.production! if options[:production]
+    Frank::Output.new do
+      set :environment, :output
+      set :output_folder, ARGV[1]
+    end.dump(options[:production])
+  when 'upgrade'
+    Frank.upgrade!
+  end
+end

data/bin/frankout

@@ -1,7 +1,22 @@
 #!/usr/bin/env ruby
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
 require 'optparse'
+
+puts "\nthe `frankout' command is deprecated and will be removed in 0.5, use `frank export' or the alias `frank out'"
+
+begin
+  # try to use bundler if its available
+  require 'bundler'
+  begin
+    Bundler.require
+  rescue Bundler::GemfileNotFound
+    # revert to using local frank install
+    $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+  end
+rescue LoadError
+  # revert to using local frank install
+  $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+end
+
 require 'frank'
 
 production = false
@@ -10,13 +25,13 @@ opts = OptionParser.new do |opts|
   opts.banner = "Usage: frankout [OPTIONS] directory\n",
                 "Compiles and dumps a project and it\'s static files to given directory\n",
                 "Example: frankout --production html_dump\n\n"
-  
+
   opts.separator 'Options:'
-  
+
   opts.on('--production', 'Production ready dump i.e. ([FOLDER]/index.html)') do |handler|
     production = true
   end
-  
+
   opts.on( '-h', '--help', 'Display this help' ) do
     puts opts
     exit
@@ -40,18 +55,13 @@ if File.exists? output_folder
 end
 
 begin
-  settings = YAML.load_file('settings.yml')
-  proj_dir = Dir.pwd
-  
+  Frank.production! if production
+  Frank.bootstrap(Dir.pwd)
   Frank::Output.new do
-    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(production)
-  
+
 rescue Errno::ENOENT
-  puts "Frank could not find settings.yml."
+  puts "Frank could not find setup.rb"
 end

data/bin/frankup

@@ -1,71 +1,69 @@
 #!/usr/bin/env ruby
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
 require 'optparse'
+
+puts "\nthe `frankup' command is deprecated and will be removed in 0.5, use `frank server' or the alias `frank up'"
+
+begin
+  # try to use bundler if its available
+  require 'bundler'
+  begin
+    Bundler.require
+  rescue Bundler::GemfileNotFound
+    # revert to using local frank install
+    $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+  end
+rescue LoadError
+  # revert to using local frank install
+  $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+end
+
 require 'frank'
 
 options = {:server => {}}
 
 OptionParser.new do |opts|
   opts.banner = "Usage: frankup [OPTIONS]\n",
-                "Starts the frank development server using settings.yml\n",
-                "If settings.yml isn\'t found, a webserver will be started and serve up files from the current directory\n\n"
-  
+                "Starts the frank development server using setup.rb\n",
+                "If setup.rb isn\'t found, a webserver will be started and serve up files from the current directory\n\n"
+
   opts.separator 'Options:'
-  
+
   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
-  
+
   opts.on( '-h', '--help', 'Display this help' ) do
     puts opts
     exit
   end
 end.parse!
 
-if File.exist? 'settings.yml'
-  settings = YAML.load_file('settings.yml')
-else
-  settings = { 
-    :server => { 'handler' => 'mongrel', 'hostname' => '0.0.0.0', 'port' => 3601 },
-    :static_folder => '.', 
-    :dynamic_folder => '.',
-    :environment => :serving  
-  }
-end
+Frank.bootstrap(Dir.pwd)
 
-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
+# setup server from options
+server_options        = options[:server]
+Frank.server.handler  = server_options['handler'] if server_options['handler']
+Frank.server.hostname = server_options['hostname'] if server_options['hostname']
+Frank.server.port     = server_options['port'] if server_options['port']
 
-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
+# setup folder options
+Frank.dynamic_folder = options[:dynamic_folder] if options[:dynamic_folder]
+Frank.static_folder  = options[:static_folder] if options[:static_folder]
 
-Frank.new do
-  settings.each do |name, value|
-    set name.to_s, value
-  end
-  set :proj_dir, Dir.pwd
-end
+Frank.new