frank 0.2.6 → 0.3.0.beta

data/lib/template/settings.yml

@@ -1,17 +1,3 @@
-# -----------------------------------------------
-#  Frank settings:
-#
-#  These settings will apply to this project only.
-#  If you would like to use this project as a
-#  template for new projects, just copy this
-#  project folder to `~/.frank` and it will be
-#  duplicated for you every time you run the
-# `frank` command.
-#
-#  Feel free to trash all these comments, too.
-#
-
-
 # ----------------------
 #  Server settings:
 #
@@ -41,17 +27,18 @@ static_folder: static
 dynamic_folder: dynamic
 
 # ----------------------
-#  Templates:
-#
-# 'layouts' is a list of layouts to use, where
-# 'name' is the filename (without extension).
-#  You can also use multiple layouts, and limit
-#  their scopes like so:
-#      - name: blog_layout
-#        only: [blog]
-#      - name: normal
-#        not: [blog, ajax]
-templates:
-    layouts:
-        - name: layout
-
+#  Layouts folder:
+#
+#  Frank will look for layouts in this folder
+#  the default layout is `default'
+#  it respects nested layouts that correspond to nested
+#  folders in the `dynamic_folder'
+#  for example: 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'
+#  
+#  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'
+#
+layouts_folder: layouts

data/spec/base_spec.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe Frank::Base do
+  include Rack::Test::Methods 
+  
+  def app
+    proj_dir = File.join(File.dirname(__FILE__), 'template')
+    settings = YAML.load_file(File.join(proj_dir, 'settings.yml'))
+    Frank.new do
+      settings.each do |name, value|
+        set name.to_s, value
+      end
+      set :environment, :test
+      set :proj_dir, proj_dir
+    end
+  end
+  
+  it 'has all of the required settings set' do
+    app.proj_dir.should_not be_nil
+    app.server.should_not be_nil
+    app.static_folder.should_not be_nil
+    app.dynamic_folder.should_not be_nil
+    app.layouts_folder.should_not be_nil
+  end
+  
+  it 'renders a dynamic template given a request' do
+    get '/'
+    
+    last_response.should be_ok
+    last_response.body.should == "<div id='p'>/</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/</h2>\n</div>\n"
+  end
+  
+  it 'renders a page and uses a helper' do
+    get '/helper_test'
+    
+    last_response.should be_ok
+    last_response.body.should == "<div id='p'>/helper_test</div>\n<div id='layout'>\n  <h1>hello from helper</h1>\n</div>\n"
+  end
+  
+  it 'renders a nested template given a request' do
+    get '/nested/child'
+    
+    last_response.should be_ok
+    last_response.body.should == "<div id='nested_layout'>\n  <h1>hello from child</h1>\n</div>\n"
+  end
+  
+  it 'renders dynamic css without a layout' do
+    get '/sass.css'
+    
+    last_response.should be_ok
+    last_response.body.should == "#hello-worlds {\n  background: red; }\n"
+  end
+  
+  it 'renders dynamic javascript without a layout' do
+    get '/coffee.js'
+    
+    last_response.should be_ok
+    last_response.body.should == "(function(){\n  var greeting;\n  greeting = \"Hello CoffeeScript\";\n})();"
+  end
+  
+  it 'renders a 404 page if template not found' do
+    get '/not_here.css'
+                            
+    last_response.should_not be_ok
+    last_response.content_type.should == 'text/html'
+    last_response.body.should =~ /Not Found/
+  end
+  
+  it 'renders a 500 page for error' do
+    capture_stdout { get '/500' }
+    
+    last_response.should_not be_ok
+    last_response.content_type.should == 'text/html'
+    last_response.body.should =~ /undefined local variable or method `non_method'/
+  end
+  
+  it 'stubs out a project' do
+    out = capture_stdout { Frank.stub('stubbed') }
+    Dir.entries('stubbed').should == Dir.entries(File.join(LIBDIR, 'template'))
+    response = "\nFrank is...\n - \e[32mCreating\e[0m your project 'stubbed'\n - \e[32mCopying\e[0m Frank template\n\n \e[32mCongratulations, 'stubbed' is ready to go!\e[0m\n"
+    out.string.should == response
+  end
+  
+  after(:all) do
+    FileUtils.rm_r File.join(Dir.pwd, 'stubbed')
+  end
+
+end

data/{test → spec}/helper.rb

@@ -6,12 +6,9 @@ $LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
 
 require 'stringio'
 require 'rubygems'
-require 'test/unit'
 require 'rack/test'
-require 'shoulda'
 require 'template/helpers'
 require 'frank'
-require 'ruby-debug'
 
 module Kernel
  def capture_stdout
@@ -23,7 +20,3 @@ module Kernel
    $stdout = STDOUT
  end
 end
-
-class Test::Unit::TestCase
-  include Rack::Test::Methods 
-end

data/spec/output_spec.rb

@@ -0,0 +1,220 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe Frank::Output do
+  include Rack::Test::Methods 
+  
+  context 'default output' do
+    before(:all) do
+      proj_dir = File.join(File.dirname(__FILE__), 'template')
+      settings = YAML.load_file(File.join(proj_dir, 'settings.yml'))
+      require File.join(proj_dir, 'helpers')
+      capture_stdout do
+        Frank::Output.new do
+          settings.each do |name, value|
+            set name.to_s, value
+          end
+          set :environment, :output
+          set :proj_dir, proj_dir
+          set :output_folder, File.join(File.dirname(__FILE__), 'template/output')
+        end.dump
+      end
+    end
+  
+    it 'creates the output folder' do
+      File.exist?(File.join(File.dirname(__FILE__), 'template/output')).should be_true
+    end
+      
+    it 'creates index.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/index.html')
+      File.read(output).should == "<div id='p'>/</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/</h2>\n</div>\n"
+    end
+      
+    it  'creates partial_test.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/partial_test.html')
+      File.read(output).should == "<div id='p'>/partial_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <p>hello from partial</p>\n</div>\n"
+    end
+    
+    it 'creates child.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/nested/child.html')
+      File.read(output).should == "<div id='nested_layout'>\n  <h1>hello from child</h1>\n</div>\n"
+    end
+    
+    it 'creates deep.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/nested/deeper/deep.html')
+      File.read(output).should == "<div id='nested_layout'>\n  <h1>really deep</h1>\n</div>\n"
+    end
+    
+    it 'creates no_layout.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/no_layout.html')
+      File.read(output).should == "<h1>i have no layout</h1>\n"
+    end
+      
+    it 'creates erb.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/erb.html')
+      File.read(output).should == "<h1>hello worlds</h1>\n\n"
+    end
+      
+    it 'creates redcloth.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/redcloth.html')
+      File.read(output).should == "<h1>hello worlds</h1>"
+    end
+      
+    it 'creates markdown.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/markdown.html')
+      File.read(output).should == "<h1>hello worlds</h1>\n"
+    end
+      
+    it 'creates mustache.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/mustache.html')
+      File.read(output).should == "<h1>hello worlds</h1>\n\n"
+    end
+      
+    it 'creates liquid.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/liquid.html')
+      File.read(output).should == "<h1>hello worlds</h1>\n"
+    end
+      
+    it 'creates builder.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/builder.html')
+      File.read(output).should == "<h1>hello worlds</h1>\n"
+    end
+      
+    it 'copies static.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/files/static.html')
+      File.read(output).should == "hello from static"
+    end
+      
+    it "doesn't create partials" do
+      File.exist?(File.join(File.dirname(__FILE__), 'template/output/_partial.html')).should be_false
+    end
+    
+    it 'handles lorem replacement fields' do
+      output = File.join(File.dirname(__FILE__), 'template/output/lorem_test.html')
+      File.read(output).should include("<p class='words'>replace-this</p>")
+      File.read(output).should include("<p class='sentences'>replace-this</p>")
+      File.read(output).should include("<p class='paragraphs'>replace-this</p>")
+      File.read(output).should include("<p class='date'>replace-this</p>")
+      File.read(output).should include("<p class='name'>replace-this</p>")
+      File.read(output).should include("<p class='email'>replace-this</p>")
+      File.read(output).should include("<img src='replace-this' />")
+    end
+    
+    it 'should not render the refresh js' do
+      output = File.join(File.dirname(__FILE__), 'template/output/refresh.html')
+      File.read(output).should == "<div id='p'>/refresh</div>\n<div id='layout'>\n  \n</div>\n"
+    end
+    
+    after(:all) do
+      FileUtils.rm_r File.join(File.dirname(__FILE__), 'template/output')
+    end
+  
+  end
+  
+  context 'productions output' do
+    before(:all) do
+      proj_dir = File.join(File.dirname(__FILE__), 'template')
+      settings = YAML.load_file(File.join(proj_dir, 'settings.yml'))
+      require File.join(proj_dir, 'helpers')
+      capture_stdout do
+        Frank::Output.new do
+          settings.each do |name, value|
+            set name.to_s, value
+          end
+          set :environment, :output
+          set :proj_dir, proj_dir
+          set :output_folder, File.join(File.dirname(__FILE__), 'template/output')
+        end.dump(production=true)
+      end
+    end
+  
+    it 'creates the output folder' do
+      File.exist?(File.join(File.dirname(__FILE__), 'template/output')).should be_true
+    end
+  
+    it 'creates index.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/index.html')
+      File.read(output).should == "<div id='p'>/</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/</h2>\n</div>\n"
+    end
+  
+    it  'creates partial_test.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/partial_test/index.html')
+      File.read(output).should == "<div id='p'>/partial_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <p>hello from partial</p>\n</div>\n"
+    end
+    
+    it 'creates child.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/nested/child/index.html')
+      File.read(output).should == "<div id='nested_layout'>\n  <h1>hello from child</h1>\n</div>\n"
+    end
+    
+    it 'creates deep.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/nested/deeper/deep/index.html')
+      File.read(output).should == "<div id='nested_layout'>\n  <h1>really deep</h1>\n</div>\n"
+    end
+    
+    it 'creates no_layout.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/no_layout/index.html')
+      File.read(output).should == "<h1>i have no layout</h1>\n"
+    end
+  
+    it 'creates erb.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/erb/index.html')
+      File.read(output).should == "<h1>hello worlds</h1>\n\n"
+    end
+  
+    it 'creates redcloth.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/redcloth/index.html')
+      File.read(output).should == "<h1>hello worlds</h1>"
+    end
+  
+    it 'creates markdown.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/markdown/index.html')
+      File.read(output).should == "<h1>hello worlds</h1>\n"
+    end
+  
+    it 'creates mustache.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/mustache/index.html')
+      File.read(output).should == "<h1>hello worlds</h1>\n\n"
+    end
+  
+    it 'creates liquid.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/liquid/index.html')
+      File.read(output).should == "<h1>hello worlds</h1>\n"
+    end
+  
+    it 'creates builder.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/builder/index.html')
+      File.read(output).should == "<h1>hello worlds</h1>\n"
+    end
+  
+    it 'copies static.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/files/static.html')
+      File.read(output).should == "hello from static"
+    end
+  
+    it "doesn't create partials" do
+      File.exist?(File.join(File.dirname(__FILE__), 'template/output/_partial/index.html')).should be_false
+    end
+    
+    it 'handles lorem replacement fields' do
+      output = File.join(File.dirname(__FILE__), 'template/output/lorem_test/index.html')
+      File.read(output).should include("<p class='words'>replace-this</p>")
+      File.read(output).should include("<p class='sentences'>replace-this</p>")
+      File.read(output).should include("<p class='paragraphs'>replace-this</p>")
+      File.read(output).should include("<p class='date'>replace-this</p>")
+      File.read(output).should include("<p class='name'>replace-this</p>")
+      File.read(output).should include("<p class='email'>replace-this</p>")
+      File.read(output).should include("<img src='replace-this' />")
+    end
+    
+    it 'should not render the refresh js' do
+      output = File.join(File.dirname(__FILE__), 'template/output/refresh/index.html')
+      File.read(output).should == "<div id='p'>/refresh</div>\n<div id='layout'>\n  \n</div>\n"
+    end
+  
+    after(:all) do
+      FileUtils.rm_r File.join(File.dirname(__FILE__), 'template/output')
+    end
+    
+  end
+  
+end

data/spec/render_spec.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe Frank::Render do
+  include Rack::Test::Methods 
+  
+  def app
+    proj_dir = File.join(File.dirname(__FILE__), 'template')
+    settings = YAML.load_file(File.join(proj_dir, 'settings.yml'))
+    Frank.new do
+      settings.each do |name, value|
+        set name.to_s, value
+      end
+      set :environment, :test
+      set :proj_dir, proj_dir
+    end
+  end
+  
+  before(:all) do
+    @app = app
+  end
+  
+  it 'renders a template using layout' do
+    template = @app.render('index.haml')
+    template.should == "<div id='p'>/</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/</h2>\n</div>\n"
+  end
+  
+  it 'renders a template using layout2' do
+    template = @app.render('layout2_test.haml')
+    template.should == "<div id='layout2'>\n  <h1>hi inside layout2</h1>\n</div>\n"
+  end
+  
+  it 'renders a markdown template inside haml layout' do
+    template = @app.render('markdown_in_haml.md')
+    template.should == "<div id='p'>/markdown_in_haml</div>\n<div id='layout'>\n  <h1>hi inside layout</h1>\n</div>\n"
+  end
+  
+  it 'renders a nested template with a nested layout' do
+    template = @app.render('/nested/child.haml')
+    template.should == "<div id='nested_layout'>\n  <h1>hello from child</h1>\n</div>\n"
+  end
+  
+  it 'renders a deeply nested template with a nested layout' do
+    template = @app.render('/nested/deeper/deep.haml')
+    template.should == "<div id='nested_layout'>\n  <h1>really deep</h1>\n</div>\n"
+  end
+   
+  it 'renders a haml template with no layout' do
+    template = @app.render('no_layout.haml')
+    template.should == "<h1>i have no layout</h1>\n"
+  end
+   
+  it 'renders haml template' do
+    template = @app.render('index.haml')
+    template.should == "<div id='p'>/</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/</h2>\n</div>\n"
+  end
+  
+  it 'renders haml template with a haml partial' do
+    template = @app.render('partial_test.haml')
+    template.should == "<div id='p'>/partial_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <p>hello from partial</p>\n</div>\n"
+  end
+  
+  it 'renders sass template' do
+    template = @app.render('sass.sass')
+    template.should == "#hello-worlds {\n  background: red; }\n"
+  end
+  
+  it 'renders coffee template' do
+    template = @app.render('coffee.coffee')
+    template.should == "(function(){\n  var greeting;\n  greeting = \"Hello CoffeeScript\";\n})();"
+  end
+   
+  it 'renders erb template' do
+    template = @app.render('erb.erb')
+    template.should == "<h1>hello worlds</h1>\n\n"
+  end
+  
+  it 'renders redcloth template' do
+    template = @app.render('redcloth.textile')
+    template.should == "<h1>hello worlds</h1>"
+  end
+  
+  it 'renders rdiscount template' do
+    template = @app.render('markdown.md')
+    template.should == "<h1>hello worlds</h1>\n"
+  end
+  
+  it 'renders mustache template' do
+    template = @app.render('mustache.mustache')
+    template.should == "<h1>hello worlds</h1>\n\n"
+  end
+  
+  it 'renders liquid template' do
+    template = @app.render('liquid.liquid')
+    template.should == "<h1>hello worlds</h1>\n"
+  end
+  
+  it 'renders builder template' do
+    template = @app.render('builder.builder')
+    template.should == "<h1>hello worlds</h1>\n"
+  end
+  
+  it 'raise template error' do
+    lambda { @app.render('not_a.template') }.should raise_error(Frank::TemplateError)
+  end
+   
+end