frank 0.3.2 → 0.4.0

data/lib/frank/middleware/refresh.rb

@@ -1,12 +1,12 @@
 module Frank
   module Middleware
     class Refresh
- 
+
       def initialize(app, options={})
         @app     = app
         @folders = options[:watch]
       end
-    
+
       # catch __refrank__ path and
       # return the most recent timestamp
       def call(env)
@@ -16,18 +16,17 @@ module Frank
         else
           @app.call(env)
         end
-      
       end
-    
+
       private
-    
+
       # build list of mtimes for watched files
       # return the most recent
       def get_mtime
         pwd        = Dir.pwd
         timestamps = []
         helpers    = File.join(pwd, 'helpers.rb')
-        
+
         timestamps << File.mtime(helpers).to_i if File.exist? helpers
         @folders.each do |folder|
           Dir[File.join(pwd, folder, '**/*.*')].each do |found|
@@ -36,7 +35,7 @@ module Frank
         end
         timestamps.sort.last
       end
-      
+
     end
   end
 end

data/lib/frank/output.rb

@@ -1,63 +1,63 @@
 module Frank
   class Output < Frank::Base
     include Frank::Render
-    
-    attr_accessor :environment, :proj_dir, :static_folder, :dynamic_folder, :templates, :output_folder
-    
+
+    attr_accessor :environment, :output_folder
+
     def initialize(&block)
       instance_eval &block
     end
-    
+
     # compile the templates
-    # if production and template isn't index and is html    
+    # if production and template isn't index and is html
     # name a folder based on the template and compile to index.html
     # otherwise compile as is
     def compile_templates(production)
-      dir = File.join(@proj_dir, @dynamic_folder)
-      
-      Dir[File.join(dir, '**/*')].each do |path|
+      dir = File.join(Frank.root, Frank.dynamic_folder)
+
+      Dir[File.join(dir, '**{,/*/**}/*')].each do |path|
         if File.file?(path) && !File.basename(path).match(/^(\.|_)/)
           path    = path[ (dir.size + 1)..-1 ]
           ext     = File.extname(path)
-          new_ext = ext_from_handler(ext)  
+          new_ext = ext_from_handler(ext)
           name    = File.basename(path, ext)
-          
+
           if production == true && "#{name}.#{new_ext}" != 'index.html' && new_ext == 'html'
             new_file = File.join(@output_folder, path.sub(/(\/?[\w-]+)\.[\w-]+$/, "\\1/index.#{new_ext}"))
           else
-            new_file = File.join(@output_folder, path.sub(/\.[\w-]+$/, ".#{new_ext}"))  
+            new_file = File.join(@output_folder, path.sub(/\.[\w-]+$/, ".#{new_ext}"))
           end
-          
+
           create_dirs(new_file)
           File.open(new_file, 'w') {|f| f.write render(path) }
           puts " - \033[32mCreating\033[0m '#{new_file}'"
         end
       end
     end
-    
+
     # use path to determine folder name and
     # create the required folders if they don't exist
     def create_dirs(path)
       FileUtils.makedirs path.split('/').reverse[1..-1].reverse.join('/')
     end
-    
+
     # copies over static content
     def copy_static
       puts " - \033[32mCopying\033[0m static content"
-      static_folder = File.join(@proj_dir, @static_folder)
-      FileUtils.cp_r(File.join(static_folder, '/.'), @output_folder) 
+      static_folder = File.join(Frank.root, Frank.static_folder)
+      FileUtils.cp_r(File.join(static_folder, '/.'), @output_folder)
     end
-    
+
     # create the dump dir, compile templates, copy over static assets
     def dump(production = false)
       FileUtils.mkdir(@output_folder)
       puts "\nFrank is..."
       puts " - \033[32mCreating\033[0m '#{@output_folder}'"
-      
+
       compile_templates(production)
       copy_static
       puts "\n \033[32mCongratulations, project dumped to '#{@output_folder}' successfully!\033[0m"
     end
   end
-  
+
 end

data/lib/frank/rescue.rb

@@ -1,34 +1,34 @@
 module Frank
-  module Rescue    
-    
+  module Rescue
+
     def render_404
       template = File.expand_path(File.dirname(__FILE__)) + '/templates/404.haml'
-      locals = { :request => @env, 
-                 :dynamic_folder => @dynamic_folder, 
-                 :static_folder => @static_folder,
-                 :environment => @environment }
-                 
+      locals = { :request => @env,
+                 :dynamic_folder => Frank.dynamic_folder,
+                 :static_folder => Frank.static_folder,
+                 :environment => Frank.environment }
+
       @response['Content-Type'] = 'text/html'
       @response.status          = 404
       obj                       = Object.new.extend(TemplateHelpers)
       @response.body            = Tilt::HamlTemplate.new(template).render(obj, locals = locals)
-      
+
       log_request('404')
     end
-  
+
     def render_500(excp)
       template = File.expand_path(File.dirname(__FILE__)) + '/templates/500.haml'
-      locals   = { :request => @env, 
-                   :params => @request.params, 
+      locals   = { :request => @env,
+                   :params => @request.params,
                    :exception => excp }
 
       @response['Content-Type'] = 'text/html'
       @response.status          = 500
       obj                       = Object.new.extend(TemplateHelpers)
-      @response.body            = Tilt::HamlTemplate.new(template).render(obj, locals = locals)  
-      
+      @response.body            = Tilt::HamlTemplate.new(template).render(obj, locals = locals)
+
       log_request('500', excp)
     end
-    
+
   end
 end

data/lib/frank/settings.rb

@@ -0,0 +1,52 @@
+require 'singleton'
+require 'ostruct'
+module Frank
+  class Settings
+    include Singleton
+
+    attr_accessor :environment
+    attr_accessor :root
+
+    attr_accessor :server
+    attr_accessor :options
+    attr_accessor :static_folder
+    attr_accessor :dynamic_folder
+    attr_accessor :layouts_folder
+    attr_accessor :sass_options
+
+    def initialize
+      reset
+    end
+
+    # Reset settings to the defaults
+    def reset
+      # reset server settings
+      @server = OpenStruct.new
+      @server.handler = "mongrel"
+      @server.hostname = "0.0.0.0"
+      @server.port = "3601"
+
+      # reset options
+      @options = OpenStruct.new
+
+      # setup folders
+      @static_folder = "static"
+      @dynamic_folder = "dynamic"
+      @layouts_folder = "layouts"
+
+      # setup 3rd party configurations
+      @sass_options = {}
+    end
+
+    # Check to see if we're in production mode
+    def production?
+      @production
+    end
+
+    # Mark this Frank run as production
+    def production!
+      @production = true
+    end
+
+  end
+end

data/lib/frank/tilt_setup.rb

@@ -0,0 +1,58 @@
+require 'tilt'
+
+module Frank
+
+  # Scss template implementation. See:
+  # http://haml.hamptoncatlin.com/
+  #
+  # Sass templates do not support object scopes, locals, or yield.
+  class SassTemplate < Tilt::SassTemplate
+    def prepare
+      @engine = ::Sass::Engine.new(data, sass_options.merge(Frank.sass_options || {}).merge(:syntax => :sass))
+    end
+  end
+  Tilt.register 'sass', SassTemplate
+
+  # Scss template implementation. See:
+  # http://haml.hamptoncatlin.com/
+  #
+  # Sass templates do not support object scopes, locals, or yield.
+  class ScssTemplate < Tilt::SassTemplate
+    def prepare
+      @engine = ::Sass::Engine.new(data, sass_options.merge(Frank.sass_options || {}).merge(:syntax => :scss))
+    end
+  end
+  Tilt.register 'scss', ScssTemplate
+
+  # Radius Template
+  # http://github.com/jlong/radius/
+  class RadiusTemplate < Tilt::Template
+    def initialize_engine
+      return if defined? ::Radius
+      require_template_library 'radius'
+    end
+
+    def prepare
+      @context = Class.new(Radius::Context).new
+    end
+
+    def evaluate(scope, locals, &block)
+      @context.define_tag("yield") do
+        block.call
+      end
+      (class << @context; self; end).class_eval do
+        define_method :tag_missing do |tag, attr, &block|
+          if locals.key?(tag.to_sym)
+            locals[tag.to_sym]
+          else
+            scope.__send__(tag)  # any way to support attr as args?
+          end
+        end
+      end
+      # TODO: how to config tag prefix?
+      parser = Radius::Parser.new(@context, :tag_prefix => 'r')
+      parser.parse(data)
+    end
+  end
+  Tilt.register 'radius', RadiusTemplate
+end

data/lib/frank/upgrades.rb

@@ -0,0 +1,90 @@
+module Frank
+  module Upgrades
+
+    def upgrade!
+      version = detect_version
+
+      if version == '0.3'
+        upgrade_from_0_3!
+      else
+        puts "\033[32mLooks like you're already good to go!\033[0m"
+      end
+    end
+
+    private
+
+    def upgrade_from_0_3!
+      settings   = YAML.load_file(File.join(Frank.root, 'settings.yml'))
+      setup      = <<-SETUP
+      # ----------------------
+      #  Server settings:
+      #
+      #  Change the server host/port to bind rack to.
+      # 'server' can be any Rack-supported server, e.g.
+      #  Mongrel, Thin, WEBrick
+      #
+      Frank.server.handler = "#{settings['server']['handler']}"
+      Frank.server.hostname = "#{settings['server']['hostname']}"
+      Frank.server.port = "#{settings['server']['port']}"
+
+      # ----------------------
+      #  Static folder:
+      #
+      #  All files in this folder will be served up
+      #  directly, without interpretation
+      #
+      Frank.static_folder = "#{settings['static_folder']}"
+
+      # ----------------------
+      #  Dynamic folder:
+      #
+      #  Frank will try to interpret any of the files
+      #  in this folder based on their extension
+      #
+      Frank.dynamic_folder = "#{settings['dynamic_folder']}"
+
+      # ----------------------
+      #  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'
+      #
+      Frank.layouts_folder = "#{settings['layouts_folder']}"
+
+
+      # ----------------------
+      # Initializers:
+      #
+      # Add any other project setup code, or requires here
+      # ....
+      SETUP
+
+      puts " - \033[32mConverting\033[0m settings.yml => setup.rb"
+
+      File.open(File.join(Frank.root, 'setup.rb'), 'w') { |file| file.write(setup.gsub(/^\s+(?=[^\s])/, '')) }
+      File.delete(File.join(Frank.root, 'settings.yml'))
+
+      puts "\n \033[32mUpdate is complete, enjoy!\033[0m"
+    end
+
+    def detect_version
+      if File.exist? File.join(Frank.root, 'settings.yml')
+        version = '0.3'
+      else
+        version = '<0.3'
+      end
+
+      version
+    end
+
+  end
+end

data/lib/frank.rb

@@ -12,5 +12,49 @@ require 'rubygems'
 require 'yaml'
 require 'fileutils'
 require 'rack'
+require 'frank/settings'
 require 'frank/base'
 require 'frank/output'
+
+# relay
+module Frank
+
+  # Quickly configure Frank settings. Best used by passing a block.
+  #
+  # Example:
+  #
+  #   Frank.configure do |settings|
+  #     settings.server.handler = "mongrel"
+  #     settings.server.hostname = "0.0.0.0"
+  #     settings.server.port = "3601"
+  #
+  #     settings.static_folder = "static"
+  #     settings.dynamic_folder = "dynamic"
+  #     settings.layouts_folder = "layouts"
+  #   end
+  #
+  # Returns:
+  #
+  # The Frank +Settings+ singleton instance.
+  class << self
+    def configure
+      settings = Frank::Settings.instance
+      block_given? ? yield(settings) : settings
+    end
+  end
+
+  # Take all the public instance methods from the Settings singleton and allow
+  # them to be accessed through the Frank module directly.
+  #
+  # Examples:
+  #
+  # <tt>Frank.server.hander #=> "mongrel"</tt>
+  # <tt>Frank.static_folder #=> "static"</tt>
+  Frank::Settings.public_instance_methods(false).each do |name|
+    (class << self; self; end).class_eval <<-EOT
+      def #{name}(*args)
+        configure.send("#{name}", *args)
+      end
+    EOT
+  end
+end

data/lib/template/dynamic/index.haml

@@ -5,10 +5,10 @@
   %img{:src=>'/images/frank-med.png'}
   %h1 Frank
   %h2 Relax, fella. Frank's got it under control.
-  
+
 %ol#help
   %li
-    %p= "Edit <em>settings.yml</em> to set your server options, folder names for static/dynamic content, and layouts for your views."
+    %p= "Edit <em>setup.rb</em> to set your server options, folder names for static/dynamic content, and layouts for your views."
   %li
     %p= "Stash your static files (images, flash movies, etc) in the folder that you set as <em>[static_folder]</em>."
   %li

data/lib/template/{settings.yml → setup.rb}

@@ -5,10 +5,9 @@
 # 'server' can be any Rack-supported server, e.g.
 #  Mongrel, Thin, WEBrick
 #
-server:
-  handler: mongrel
-  hostname: 0.0.0.0
-  port: 3601
+Frank.server.handler = "mongrel"
+Frank.server.hostname = "0.0.0.0"
+Frank.server.port = "3601"
 
 # ----------------------
 #  Static folder:
@@ -16,7 +15,7 @@ server:
 #  All files in this folder will be served up
 #  directly, without interpretation
 #
-static_folder: static
+Frank.static_folder = "static"
 
 # ----------------------
 #  Dynamic folder:
@@ -24,7 +23,7 @@ static_folder: static
 #  Frank will try to interpret any of the files
 #  in this folder based on their extension
 #
-dynamic_folder: dynamic
+Frank.dynamic_folder = "dynamic"
 
 # ----------------------
 #  Layouts folder:
@@ -36,9 +35,16 @@ dynamic_folder: dynamic
 #  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
+Frank.layouts_folder = "layouts"
+
+
+# ----------------------
+# Initializers:
+#
+# Add any other project setup code, or requires here
+# ....

data/spec/base_spec.rb

@@ -1,79 +1,79 @@
 require File.dirname(__FILE__) + '/helper'
 
 describe Frank::Base do
-  include Rack::Test::Methods 
-  
+  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.bootstrap(File.join(File.dirname(__FILE__), 'template'))
     Frank.new do
-      settings.each do |name, value|
-        set name.to_s, value
-      end
       set :environment, :test
-      set :proj_dir, proj_dir
+
+      # this is just used for a test
+      @blowup_sometimes = true
     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
+    app
+    Frank.root.should_not be_nil
+    Frank.server.handler.should_not be_nil
+    Frank.server.hostname.should_not be_nil
+    Frank.server.port.should_not be_nil
+    Frank.static_folder.should_not be_nil
+    Frank.dynamic_folder.should_not be_nil
+    Frank.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'
-    
+    get '/stylesheets/sass.css'
+
     last_response.should be_ok
-    last_response.body.should == "#hello-worlds {\n  background: red; }\n"
+    last_response.body.should include("#hello-worlds {\n  background: red;\n}\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

data/spec/helper.rb

@@ -1,8 +1,10 @@
 testdir = File.dirname(__FILE__)
 $:.unshift testdir unless $LOAD_PATH.include?(testdir)
 
+require 'bundler'
+Bundler.setup
+
 require 'stringio'
-require 'rubygems'
 require 'rack/test'
 require 'template/helpers'
 require 'frank'