frank 0.3.0.beta2 → 0.3.0

data/README.md

@@ -4,11 +4,11 @@ Frank
 Inspired by [Sinatra][0]'s simplicity and ease of use, Frank lets you build
 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.
+your work out to static html and css.
 
 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].
+[Liquid][5], and [Mustache][6].
 
 Overview
 --------
@@ -26,56 +26,84 @@ Then `cd <project_name>` and start up the server with:
      0.0.0.0:3601
 
 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 server from the `layouts` folder.
+static files are served from the `static` folder, and layouts are served from the `layouts` folder.
 
-When you are finished:
-    `$ frankout <dump_dir> # compile templates`
-    
-    or
+When you're done working:
+
+    $ frankout <dump_dir>
+
+to compile templates and copy them--along with static your assets--into `<dump_dir>`. Or,
     
-    `$ frankout --production <dump_dir> # compile and create folder structure suitable for serving from a production website`
+    $ frankout --production <dump_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)
 
 Views & Meta Data
 -------------------------
 
-All of your templates, and less/sass/coffeescript go into `<project>/dynamic`,
-by default. You can organize them into subfolders if you've
-got lots.
+All of your templates, less, sass &c. go into `<project>/dynamic` by default.
+You can 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.
+Writing views is simple. Say you've got a `blog.haml` in `<project>/dynamic`; just browse over to
+`http://0.0.0.0:3601/blog` and your view will be parsed and served up as html.
 
-### Meta Data
 
-Frank doesn't have controllers and there are times you need to pass variables around between templates and layouts.
-This can be done with template Meta data. Meta data is set using YAML. 
+### Meta Data
 
-You define your fields at the top a template
-a separate it from the rest of your template using the Meta delimiter: `META--------`. The delimiter can contain as
-many dashes, or hyphens as you wish.
+Frank was designed to make controllers unnecessary. But, sometimes it's nice to have
+variables in your templates / layouts. This is particularly handy if you want to set the page
+title (in the layout) according to the view. This is simple, now, with meta data.
+
+Meta fields go at the top of any view, and are written in [YAML][13]. To mark the end
+of the meta section, place the meta delimeter, `META---`, on a blank line. You can
+use as many hyphens as you'd like (as long as there are 3).
+
+Meta fields are then available as local variables to all templating languages that
+support them--in the view & layout:
+
+    view:
+      title: My Rad Page
+      author: My Rad Self
+      ---------------------------------------------META
+      
+      %h1= title
+      %h3= 'By ' + author
+      
+    layout:
+      %title= title + '--My Rad Site'
+    
 
-You can access your fields as local variables in the template (if the template language supports it).
-For example, you might have a template and define a field `title: My Rad Template`, then inside a haml layout,
- you could create a title tag with the field: `%title= title`
 
 Layouts (updated in 0.3)
 -----------------------------
 
-Layouts are also simple with Frank. By default, just create a `default.haml`
-(or another language), inside the `layouts` folder and include a `yield` statement. Any
-views will be inserted into it at that point.
+Layouts are also simple with Frank. Create a `default.haml` (or `.rhtml`, etc.),
+in the `layouts` folder, and include a `yield` somewhere therein; views using the
+layout will be inserted there.
 
-Layouts can be name spaced with folders:
+### Namespacing Layouts
+You can namespace your layouts using folders:
 
-a template: `dynamic_folder/blog/a-blog-post.haml`
-would look for a layout: `layouts/blog/default.haml`
-and if not found use the default: `layouts/default.haml`
+  * When rendering a view--`dynamic_folder/blog/a-blog-post.haml`,
+  * Frank would first look for the layout `layouts/blog/default.haml`,
+  * and if not found use fall back on `layouts/default.haml`
 
-Frank also supports defining layouts on an individual template basis using meta data
-you can do this by defining a meta field `layout: my_layout.haml` You can disable layouts on a 
-template by using `layout: nil`
+### Multiple/No Layouts
+
+Frank also supports choosing layouts on a view-by-view basis via meta data. Just add a
+`layout` meta field:
+
+    layout: my_layout.haml
+    ---------------------------------------------META
+    %h1 I'm using my_layout.haml instead of default.haml!
+
+or if you don't want a layout at all:
+
+    layout: nil
+    ---------------------------------------------META
+    %h1 No layout here!
 
 
 
@@ -85,7 +113,7 @@ 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.
+You can also add your own helper methods easily.
 
 ### Partials
 
@@ -107,13 +135,19 @@ to the `FrankHelpers` module; that's it. Use them just like `render_partial`.
 Built-in Helpers
 ----------------
 
-### Auto Refresh
+### Auto-Refresh
+
+Frank now has a handy automatic page refreshing helper. Just include `= refresh`
+(or equivalent) in your view, and Frank will automatically refresh the page for you whenever you
+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.
 
-Constantly refreshing your browser can become tedious while doing work. Frank has a handy refresh helper.
-It will include a bit of javascript that refreshes the browser when you save the current template or it's layout.
-You can include this in a haml template like this: `= refresh`. When you `frankout`,
-the template will render an empty string instead of the script tag
+### Current Page
 
+Frank now has a `current_page` 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
 
@@ -153,7 +187,8 @@ If you would like to use the placeholder images in a context where the helper me
 
 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 %>".
+However, when you `frankout` 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
@@ -179,9 +214,9 @@ Installation
 [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/
 [10]: http://lesscss.org/
 [11]: http://en.wikipedia.org/wiki/Lorem_ipsum
-[12]: http://www.imagemagick.org/script/binary-releases.php?ImageMagick=4pg9cdfr8e6gn7aru9mtelepr3
+[12]: http://www.imagemagick.org/script/binary-releases.php?ImageMagick=4pg9cdfr8e6gn7aru9mtelepr3
+[13]: http://www.yaml.org/start.html

data/frank.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frank}
-  s.version = "0.3.0.beta2"
+  s.version = "0.3.0"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["blahed", "nwah"]
-  s.date = %q{2010-06-18}
+  s.date = %q{2010-06-21}
   s.description = %q{Rapidly develop static sites using any supported templating language}
   s.email = %q{travis.dunn@thisismedium.com}
   s.executables = ["frank", "frankout", "frankup"]

data/lib/frank/base.rb

@@ -6,7 +6,7 @@ require 'frank/middleware/imager'
 require 'frank/middleware/refresh'
 
 module Frank
-  VERSION = '0.3.0.beta2'
+  VERSION = '0.3.0'
   
   module Render; end
   
@@ -98,7 +98,7 @@ module Frank
 
       # regex for kinds that don't support meta
       # and define the meta delimiter
-      nometa, delimiter  = /\/_|\.(sass|less)$/, /^META-{3,}\n$/
+      nometa, delimiter  = /\/_|\.(sass|less)$/, /^META-{3,}\s*$|^-{3,}META\s*$/
       
       # set the layout
       layout = path.match(nometa) ? nil : layout_for(path)

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: frank
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 0
   - 3
   - 0
-  - beta2
-  version: 0.3.0.beta2
+  version: 0.3.0
 platform: ruby
 authors: 
 - blahed
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-18 00:00:00 -04:00
+date: 2010-06-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -183,13 +182,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: