frank 0.3.2 → 0.4.0

data/frank.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# 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.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["blahed", "nwah"]
-  s.date = %q{2010-07-06}
+  s.date = %q{2010-09-02}
   s.description = %q{Rapidly develop static sites using any supported templating language}
   s.email = %q{travis.dunn@thisismedium.com}
   s.executables = ["frank", "frankout", "frankup"]
@@ -20,6 +20,8 @@ Gem::Specification.new do |s|
   s.files = [
     ".gitignore",
      "Featurelist",
+     "Gemfile",
+     "Gemfile.lock",
      "LICENSE",
      "README.md",
      "Rakefile",
@@ -35,6 +37,7 @@ Gem::Specification.new do |s|
      "lib/frank/middleware/statik.rb",
      "lib/frank/output.rb",
      "lib/frank/rescue.rb",
+     "lib/frank/settings.rb",
      "lib/frank/template_helpers.rb",
      "lib/frank/templates/404.haml",
      "lib/frank/templates/500.haml",
@@ -50,12 +53,14 @@ Gem::Specification.new do |s|
      "lib/frank/templates/imager/frank7.jpg",
      "lib/frank/templates/imager/frank8.jpg",
      "lib/frank/templates/imager/frank9.jpg",
-     "lib/frank/tilt.rb",
+     "lib/frank/tilt_setup.rb",
+     "lib/frank/upgrades.rb",
      "lib/template/dynamic/css/frank.sass",
      "lib/template/dynamic/index.haml",
      "lib/template/helpers.rb",
      "lib/template/layouts/default.haml",
-     "lib/template/settings.yml",
+     "lib/template/setup.rb",
+     "lib/template/static/favicon.ico",
      "lib/template/static/images/frank-med.png",
      "lib/template/static/js/frank.js",
      "spec/base_spec.rb",
@@ -82,19 +87,22 @@ Gem::Specification.new do |s|
      "spec/template/dynamic/partial_test.haml",
      "spec/template/dynamic/redcloth.textile",
      "spec/template/dynamic/refresh.haml",
-     "spec/template/dynamic/sass.sass",
+     "spec/template/dynamic/setting_in_layout.haml",
+     "spec/template/dynamic/stylesheets/sass.sass",
+     "spec/template/dynamic/stylesheets/sass_with_compass.sass",
+     "spec/template/dynamic/stylesheets/scss_with_compass.scss",
      "spec/template/helpers.rb",
      "spec/template/layouts/default.haml",
      "spec/template/layouts/explicit/layout2.haml",
      "spec/template/layouts/nested/default.haml",
-     "spec/template/settings.yml",
+     "spec/template/setup.rb",
      "spec/template/static/files/static.html",
      "spec/template_helpers_spec.rb"
   ]
   s.homepage = %q{http://github.com/blahed/frank}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Static Site Non-Framework}
   s.test_files = [
     "spec/base_spec.rb",
@@ -102,6 +110,7 @@ Gem::Specification.new do |s|
      "spec/output_spec.rb",
      "spec/render_spec.rb",
      "spec/template/helpers.rb",
+     "spec/template/setup.rb",
      "spec/template_helpers_spec.rb"
   ]
 
@@ -109,24 +118,24 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rack>, [">= 1.0"])
-      s.add_runtime_dependency(%q<mongrel>, [">= 1.0"])
-      s.add_runtime_dependency(%q<haml>, [">= 2.0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<haml>, [">= 3.0"])
+      s.add_runtime_dependency(%q<tilt>, ["= 0.9"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
       s.add_development_dependency(%q<rack-test>, [">= 0.5"])
     else
       s.add_dependency(%q<rack>, [">= 1.0"])
-      s.add_dependency(%q<mongrel>, [">= 1.0"])
-      s.add_dependency(%q<haml>, [">= 2.0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<haml>, [">= 3.0"])
+      s.add_dependency(%q<tilt>, ["= 0.9"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
       s.add_dependency(%q<rack-test>, [">= 0.5"])
     end
   else
     s.add_dependency(%q<rack>, [">= 1.0"])
-    s.add_dependency(%q<mongrel>, [">= 1.0"])
-    s.add_dependency(%q<haml>, [">= 2.0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<haml>, [">= 3.0"])
+    s.add_dependency(%q<tilt>, ["= 0.9"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
     s.add_dependency(%q<rack-test>, [">= 0.5"])
   end
 end

data/lib/frank/base.rb

@@ -1,37 +1,30 @@
-require 'frank/tilt'
+require 'frank/tilt_setup'
 require 'frank/template_helpers'
 require 'frank/rescue'
+require 'frank/upgrades'
 require 'frank/middleware/statik'
-require 'frank/middleware/imager'
 require 'frank/middleware/refresh'
 
 module Frank
-  VERSION = '0.3.2'
-  
+  VERSION = '0.4.0'
+  extend Frank::Upgrades
+
   module Render; end
-  
+
   class Base
     include Rack::Utils
     include Frank::Rescue
     include Frank::TemplateHelpers
     include Frank::Render
-    
-    attr_accessor :environment
-    attr_accessor :proj_dir
-    attr_accessor :server
-    attr_accessor :static_folder
-    attr_accessor :dynamic_folder
-    attr_accessor :layouts_folder
-    attr_accessor :templates
-    
+
     def initialize(&block)
-      instance_eval &block
+      instance_eval(&block) if block_given?
     end
 
     def call(env)
       dup.call!(env)
     end
-  
+
     def call!(env)
       @env = env
       @request = Rack::Request.new(env)
@@ -40,20 +33,20 @@ module Frank
       @response.close
       @response.finish
     end
-    
+
     private
-    
+
     # setter for options
-    def set(option, value)  
+    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
-      load_helpers      
+      load_helpers
       @response['Content-Type'] = Rack::Mime.mime_type(File.extname(@request.path), 'text/html')
       @response.write render(@request.path)
     rescue Frank::TemplateError
@@ -61,53 +54,52 @@ module Frank
     rescue Exception => e
       render_500 e
     end
-    
+
     # prints requests and errors to STDOUT
     def log_request(status, excp = nil)
       out = "\033[1m[#{Time.now.strftime('%Y-%m-%d %H:%M')}]\033[22m (#{@request.request_method}) http://#{@request.host}:#{@request.port}#{@request.fullpath} - #{status}"
       out << "\n\n#{excp.message}\n\n#{excp.backtrace.join("\n")} " if excp
       puts out
     end
-    
+
     def load_helpers
-      helpers = File.join(@proj_dir, 'helpers.rb')
+      helpers = File.join(Frank.root, 'helpers.rb')
       if File.exist? helpers
-        load helpers 
+        load helpers
         Frank::TemplateHelpers.class_eval("include FrankHelpers")
       end
     end
-    
   end
-  
+
   module Render
-    
-    TMPL_EXTS = { 
+
+    TMPL_EXTS = {
       :html => %w[haml erb rhtml builder liquid mustache textile md mkd markdown],
       :css  => %w[sass less scss]
     }
-    
+
     LAYOUT_EXTS = %w[.haml .erb .rhtml .liquid .mustache]
-    
+
     # render request path or template path
     def render(path, partial = false, local_vars = nil)
       @current_path = path unless partial
-      
+
       # normalize the path
       path.sub!(/^\/?(.*)$/, '/\1')
       path.sub!(/\/$/, '/index.html')
       path.sub!(/(\/[\w-]+)$/, '\1.html')
       path = to_file_path(path) if defined? @request or path.match(/\/_[^\/]+$/)
-      
+
       # regex for kinds that don't support meta
       # and define the meta delimiter
-      nometa, delimiter  = /\/_|\.(sass|less)$/, /^META-{3,}\s*$|^-{3,}META\s*$/
-      
+      nometa, delimiter  = /\/_|\.(scss|sass|less)$/, /^META-{3,}\s*$|^-{3,}META\s*$/
+
       # set the layout
       layout = path.match(nometa) ? nil : layout_for(path)
-      
-      template_path = File.join(@proj_dir, @dynamic_folder, path)
+
+      template_path = File.join(Frank.root, Frank.dynamic_folder, path)
       raise Frank::TemplateError, "Template not found #{template_path}" unless File.exist? template_path
-      
+
       # read in the template
       # check for meta and parse it if it exists
       template        = File.read(template_path) << "\n"
@@ -117,42 +109,50 @@ module Frank
 
       # use given layout if defined as a meta field
       layout = locals[:layout] == 'nil' ? nil : locals[:layout] if locals.has_key?(:layout)
-      
+
+      page = setup_page
+
       # let tilt determine the template handler
       # and return some template markup
       if layout.nil?
-        tilt(ext, template, locals)
+        tilt(page, ext, template, locals)
       else
-        layout_path = File.join(@proj_dir, @layouts_folder, layout)
+        layout_path = File.join(Frank.root, Frank.layouts_folder, layout)
         # add layout_path to locals
         raise Frank::TemplateError, "Layout not found #{layout_path}" unless File.exist? layout_path
-        
-        tilt(File.extname(layout), layout_path, locals) do
-          tilt(ext, template, locals)
-        end          
+
+        # original
+        # tilt(File.extname(layout), layout_path, locals) do
+        #   tilt(ext, template, locals)
+        # end
+
+        page_content = tilt(page, ext, template, locals)
+        tilt(page, File.extname(layout), layout_path, locals) do
+          page_content
+        end
       end
     end
-    
+
     # converts a request path to a template path
     def to_file_path(path)
       file_name = File.basename(path, File.extname(path))
       file_ext  = File.extname(path).sub(/^\./, '')
-      folder    = File.join(@proj_dir, @dynamic_folder)
+      folder    = File.join(Frank.root, Frank.dynamic_folder)
       engine    = nil
-      
+
       TMPL_EXTS.each do |ext, engines|
         if ext.to_s == file_ext
           engine = engines.reject do |eng|
             !File.exist? File.join(folder, path.sub(/\.[\w-]+$/, ".#{eng}"))
-          end.first          
+          end.first
         end
       end
-      
+
       raise Frank::TemplateError, "Template not found #{path}" if engine.nil?
-      
+
       path.sub(/\.[\w-]+$/, ".#{engine}")
     end
-    
+
     # lookup the original ext for given template path
     # TODO: make non-ugly
     def ext_from_handler(extension)
@@ -162,8 +162,8 @@ module Frank
       end
       orig_ext
     end
-  
-    
+
+
     # reverse walks the layouts folder until we find a layout
     # returns nil if layout is not found
     def layout_for(path)
@@ -172,10 +172,10 @@ module Frank
       default     = 'default' << layout_ext_or_first(layout_exts, ext)
       file_path   = path.sub(/\/[\w-]+\.[\w-]+$/, '')
       folders     = file_path.split('/')
-            
-      until File.exist? File.join(@proj_dir, @layouts_folder, folders, default)
+
+      until File.exist? File.join(Frank.root, Frank.layouts_folder, folders, default)
         break if layout_exts.empty? && folders.empty?
-        
+
         if layout_exts.empty?
           layout_exts = LAYOUT_EXTS.dup
           default = 'default' << layout_ext_or_first(layout_exts, ext)
@@ -184,37 +184,48 @@ module Frank
           default = 'default' << layout_exts.shift
         end
       end
-      
-      if File.exists? File.join(@proj_dir, @layouts_folder, folders, default)
+
+      if File.exists? File.join(Frank.root, Frank.layouts_folder, folders, default)
         File.join(folders, default)
       else
         nil
       end
     end
-    
+
     # if the given ext is a layout ext, pop it off and return it
     # otherwise return the first layout ext
     def layout_ext_or_first(layout_exts, ext)
       layout_exts.include?(ext) ? layout_exts.delete(ext) : layout_exts.first
     end
-          
-    # setup an object and extend it with TemplateHelpers and Render
-    # then send everything to tilt and get some template markup back
-    def tilt(ext, source, locals={}, &block)
-      obj = Object.new.extend(TemplateHelpers).extend(Render)
+
+    # render a page using tilt and get the result template markup back
+    def tilt(page, ext, source, locals={}, &block)
+      Tilt[ext].new do
+        source = source.to_str if source.respond_to?(:to_str)
+        if source.match(/^[^\n]+$/) && File.exist?(source)
+          File.read(source)
+        else
+          source
+        end
+      end.render(page, locals=locals, &block)
+    end
+
+    # setup a new page object to be rendered
+    def setup_page
+      page = Object.new.extend(TemplateHelpers).extend(Render)
       instance_variables.each do |var|
         unless ['@response', '@env'].include? var
-          obj.instance_variable_set(var.intern, instance_variable_get(var))
+          page.instance_variable_set(var.intern, instance_variable_get(var))
         end
       end
-      Tilt[ext].new(source).render(obj, locals=locals, &block)
+      page
     end
-    
+
     private
-    
+
     # parse the given meta string with yaml
     # set the current_path local
-    def parse_meta_and_set_locals(meta, locals = nil)      
+    def parse_meta_and_set_locals(meta, locals = nil)
       # parse yaml and symbolize keys
       if meta.nil?
         meta = {}
@@ -223,57 +234,94 @@ module Frank
           options[(key.to_sym rescue key) || key] = value
           options
         end
-      end      
+      end
       meta.merge!(locals) unless locals.nil?
       meta[:current_path] = @current_path.sub(/\.[\w-]+$/, '').sub(/\/index/, '/')
-      
+
       meta
     end
-    
   end
-  
+
+  # Bootstrap will set up Frank up at a root path, and read in the setup.rb
+  def self.bootstrap(new_root = nil)
+    Frank.reset
+    Frank.root = new_root if new_root
+
+    # setup compass
+    begin
+      require 'compass'
+
+      Compass.configuration do |config|
+        # project_path should be the directory to which the sass directory is relative.
+        # I think maybe this should be one more directory up from the configuration file.
+        # Please update this if it is or remove this message if it can stay the way it is.
+        config.project_path = Frank.root
+        config.sass_dir = File.join('dynamic', 'stylesheets')
+      end
+
+      # sass_engine_options returns a hash, you can merge it with other options.
+      Frank.sass_options = Compass.sass_engine_options
+    rescue LoadError
+      # ignore if compass is not there
+    end
+
+    # try to pull in setup
+    setup = File.join(Frank.root, 'setup.rb')
+    if File.exists?(setup)
+      load setup
+    end
+
+  end
+
   # starts the server
   def self.new(&block)
-    base = Base.new(&block) if block_given?
-    
+    base = Base.new(&block)
+
     builder = Rack::Builder.new do
-      use Frank::Middleware::Statik, :root => base.static_folder
-      use Frank::Middleware::Imager
-      use Frank::Middleware::Refresh, :watch => [ base.dynamic_folder, base.static_folder, base.layouts_folder ]
+      use Frank::Middleware::Statik, :root => Frank.static_folder
+      use Frank::Middleware::Refresh, :watch => [ Frank.dynamic_folder, Frank.static_folder, Frank.layouts_folder ]
       run base
     end
 
-    unless base.environment == :test
+    unless Frank.environment == :test
       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" +
-           " #{base.server['hostname']}:#{base.server['port']} \n\n"
-      server = Rack::Handler.get(base.server['handler'])
-      
-      server.run(builder, :Port => base.server['port'], :Host => base.server['hostname']) do
+           " #{Frank.server.hostname}:#{Frank.server.port} \n\n"
+
+      begin
+        server = Rack::Handler.get(Frank.server.handler)
+      rescue LoadError
+        puts "\n\nUnable to find handler for: #{Frank.server.handler}"
+        puts "\nUse `gem install \"#{Frank.server.handler}\"` to install it"
+        puts "\nDefaulting to using webrick"
+        server = Rack::Handler.get("webrick")
+      end
+
+      server.run(builder, :Port => Frank.server.port, :Host => Frank.server.hostname) do
         trap(:INT) { puts "\n\n-----------------------\n Show's over, fellas.\n\n"; exit }
       end
     end
-    
+
     base
-    
+
     rescue Errno::EADDRINUSE
-      puts " Hold on a second... Frank works alone.\n \033[31mSomething's already using port #{base.server['port']}\033[0m\n\n"
+      puts " Hold on a second... Frank works alone.\n \033[31mSomething's already using port #{Frank.server.port}\033[0m\n\n"
   end
-  
+
   # copies over the generic project template
   def self.stub(project)
     puts "\nFrank is...\n - \033[32mCreating\033[0m your project '#{project}'"
     Dir.mkdir project
-    
+
     puts " - \033[32mCopying\033[0m Frank template"
     FileUtils.cp_r( Dir.glob(File.join(LIBDIR, 'template/*')), project )
-    
+
     puts "\n \033[32mCongratulations, '#{project}' is ready to go!\033[0m"
   rescue Errno::EEXIST
     puts "\n \033[31muh oh, directory '#{project}' already exists...\033[0m"
     exit
   end
-  
+
 end

data/lib/frank/lorem.rb

@@ -1,16 +1,16 @@
 module Frank
   class Lorem
     WORDS = %w(alias consequatur aut perferendis sit voluptatem accusantium doloremque aperiam eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo aspernatur aut odit aut fugit sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt neque dolorem ipsum quia dolor sit amet consectetur adipisci velit sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem ut enim ad minima veniam quis nostrum exercitationem ullam corporis nemo enim ipsam voluptatem quia voluptas sit suscipit laboriosam nisi ut aliquid ex ea commodi consequatur quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae et iusto odio dignissimos ducimus qui blanditiis praesentium laudantium totam rem voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident sed ut perspiciatis unde omnis iste natus error similique sunt in culpa qui officia deserunt mollitia animi id est laborum et dolorum fuga et harum quidem rerum facilis est et expedita distinctio nam libero tempore cum soluta nobis est eligendi optio cumque nihil impedit quo porro quisquam est qui minus id quod maxime placeat facere possimus omnis voluptas assumenda est omnis dolor repellendus temporibus autem quibusdam et aut consequatur vel illum qui dolorem eum fugiat quo voluptas nulla pariatur at vero eos et accusamus officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae itaque earum rerum hic tenetur a sapiente delectus ut aut reiciendis voluptatibus maiores doloribus asperiores repellat)
-  
+
     def initialize(environment)
       @environment = environment
-      
+
     end
-        
+
     def word(replacement = nil)
       words 1, replacement
     end
-        
+
     def words(total, replacement = nil)
       if @environment == :output && replacement
         replacement
@@ -35,7 +35,7 @@ module Frank
         end.join('. ')
       end
     end
-  
+
     def paragraph(replacement = nil)
       paragraphs 1, replacement
     end
@@ -49,7 +49,7 @@ module Frank
         end.join("\n\n")
       end
     end
-    
+
     def date(fmt = '%a %b %d, %Y', replacement = nil)
       if @environment == :output && replacement
         replacement
@@ -60,7 +60,7 @@ module Frank
         Time.local(y,m,d).strftime(fmt)
       end
     end
-    
+
     def name(replacement = nil)
       if @environment == :output && replacement
         replacement
@@ -68,7 +68,7 @@ module Frank
         "#{first_name} #{last_name}"
       end
     end
-    
+
     def first_name(replacement = nil)
       if @environment == :output && replacement
         replacement
@@ -77,7 +77,7 @@ module Frank
         names[rand(names.size)]
       end
     end
-    
+
     def last_name(replacement = nil)
       if @environment == :output && replacement
         replacement
@@ -91,31 +91,42 @@ module Frank
       if @environment == :output && replacement
         replacement
       else
-        delimiters = ['_','-','']
-        domains = %w(gmail.com yahoo.com hotmail.com email.com live.com me.com mac.com aol.com fastmail.com mail.com)        
+        delimiters = [ '_', '-', '' ]
+        domains = %w(gmail.com yahoo.com hotmail.com email.com live.com me.com mac.com aol.com fastmail.com mail.com)
         username = name.gsub(/[^\w]/, delimiters[rand(delimiters.size)])
         "#{username}@#{domains[rand(domains.size)]}".downcase
       end
     end
-  
-    def image(width, height, random=false, replacement=nil)
-      if @environment == :output && replacement
-        replacement
+
+    def image(size, options)
+      if @environment == :output && options[:replacement]
+        options[:replacement]
       else
-        if defined? MiniMagick
-          "/_img/#{width.to_s}x#{height.to_s}.jpg#{'?random' + (10000 + rand(10000)).to_s if random}"
-        else
-          raise Frank::ConfigError, 'mini_magick is required for lorem.image, please install it with `gem install mini_magick`'
+        src              = "http://placehold.it/#{size}"
+        hex              = %w[a b c d e f 0 1 2 3 4 5 6 7 8 9]
+        background_color = options[:background_color]
+        color            = options[:color]
+
+        if options[:random_color]
+          background_color = hex.shuffle[0...6].join
+          color = hex.shuffle[0...6].join
         end
+
+        src << "/#{background_color.sub(/^#/, '')}" if background_color
+        src << "/ccc" if background_color.nil? && color
+        src << "/#{color.sub(/^#/, '')}" if color
+        src << "&text=#{Rack::Utils::escape(options[:text])}" if options[:text]
+
+        src
       end
     end
-  
+
     private
-  
+
     def randm(range)
       a = range.to_a
       a[rand(a.length)]
     end
-    
+
   end
-end
+end