frank 0.2.4 → 0.2.5

data/README.md

@@ -30,9 +30,11 @@ and static files are served from the `static` folder.
 
 When you are finished:
 
-    $ frankout <dump_dir>
-
-This will compile and copy everything to the folder given.
+    $ frankout <dump_dir> # compile templates
+    
+    or
+    
+    $ frankout --production <dump_dir> # compile and create folder structure suitable for serving from a production website
 
 Views & Layouts
 -------------------------

data/bin/frankout

@@ -1,16 +1,37 @@
 #!/usr/bin/env ruby
+require 'optparse'
 require 'frank'
 
+options = { :production => false }
+
+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|
+    options[:production] = true
+  end
+  
+  opts.on( '-h', '--help', 'Display this help' ) do
+    puts opts
+    exit
+  end
+end
+
+opts.parse!
+
 if ARGV.empty?
-  puts "Usage: frankout [DUMP_DIR]"
-  puts "Compiles and dumps a project and it\'s static files to given folder"
+  puts opts
   exit
 end
 
 output_folder = ARGV.first
 
 if File.exists? output_folder
-  print "Folder: #{output_folder} already exists... do you want to overwrite it? (y|n) "
+  print "'#{output_folder}' \033[31malready exists...\033[0m do you want to overwrite it? (y|n) "
   resp = STDIN.gets.chomp.strip
   exit if resp.downcase.strip != 'y'
   FileUtils.rm_rf(output_folder)
@@ -26,7 +47,7 @@ begin
     end
     set :output_folder, output_folder
     set :proj_dir, proj_dir
-  end.dump
+  end.dump(options)
   
 rescue Errno::ENOENT
   puts "Frank could not find settings.yml."

data/bin/frankup

@@ -4,7 +4,12 @@ require 'frank'
 
 options = {:server => {}}
 
-opts = OptionParser.new do |opts|
+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"
+  
+  opts.separator 'Options:'
   
   opts.on('--server [HANDLER]', 'Set the server handler') do |handler|
     options[:server]['handler'] = handler unless handler.nil?
@@ -26,6 +31,10 @@ opts = OptionParser.new do |opts|
     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'

data/frank.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frank}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["blahed", "nwah"]
-  s.date = %q{2010-03-29}
+  s.date = %q{2010-04-02}
   s.description = %q{Create/Dump static builds using whatever templating/helper languages you wish}
   s.email = %q{travis.dunn@thisismedium.com}
   s.executables = ["frank", "frankout", "frankup"]

data/lib/frank/base.rb

@@ -5,7 +5,7 @@ require 'frank/statik'
 require 'frank/imager'
 
 module Frank
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
   
   module Render; end
   
@@ -201,13 +201,14 @@ module Frank
   
   # copies over the generic project template
   def self.stub(project)
-    puts "\n-----------------------\n Frank:\n - Creating '#{project}'"
+    puts "\nFrank is..."
+    puts " - \033[32mCreating\033[0m your project '#{project}'"
     Dir.mkdir project
-    puts " - Copying Frank template"
+    puts " - \033[32mCopying\033[0m Frank template"
     FileUtils.cp_r( Dir.glob(File.join(LIBDIR, 'template/*')), project )
-    puts "\n Congratulations, '#{project}' is ready to go.\n\n"
+    puts "\n \033[32mCongratulations, '#{project}' is ready to go!\033[0m"
   rescue Errno::EEXIST
-    puts " uh oh, #{project} already exists..."
+    puts "\n \033[31muh oh, directory '#{project}' already exists...\033[0m"
     exit
   end
   

data/lib/frank/output.rb

@@ -12,36 +12,64 @@ module Frank
     end
     
     # get all of the templates and compile them
-    def compile_templates
+    def compile_templates(options)
       dir = File.join(@proj_dir, @dynamic_folder)
+      layouts = templates['layouts'].map { |l| l['name'] }
       
       Find.find(dir) do |path|
-        if FileTest.file?(path) and !File.basename(path).match(/^(\.|_)/)
+        if FileTest.file?(path) && !File.basename(path).match(/^(\.|_)/)
+          # get the path name
           path = path[ dir.size + 1 ..-1 ]
+          # get name and ext
           name, ext = name_ext(path)
+          # get output extension
           new_ext = reverse_ext_lookup(ext)
-          new_file = File.join(@proj_dir, @output_folder,  "#{name}.#{new_ext}")          
-          FileUtils.makedirs(new_file.split('/').reverse[1..-1].reverse.join('/'))
-          File.open(new_file, 'w') {|f| f.write render_path(path) }
-          puts "Create #{name}.#{new_ext}" unless @environment == :test
+
+          # if production is true and this template isn't a layout
+          if options[:production] == true && !layouts.include?(name)
+            # if template isn't index or template doesn't compile to html
+            # then compile it as is, otherwise name a folder based on the template
+            # and compile to index.html
+            if "#{name}.#{new_ext}" == 'index.html' || new_ext != 'html'
+              new_file = File.join(@proj_dir, @output_folder, "#{name}.#{new_ext}")
+            else
+              new_file = File.join(@proj_dir, @output_folder, name, "index.#{new_ext}")
+              name = "#{name}/index"
+            end
+            create_dir(new_file)
+            File.open(new_file, 'w') {|f| f.write render_path(path) }
+          elsif options[:production] == false
+            new_file = File.join(@proj_dir, @output_folder, "#{name}.#{new_ext}")  
+            create_dir(new_file)
+            File.open(new_file, 'w') {|f| f.write render_path(path) }
+          end
+          puts " - \033[32mCreating\033[0m '#{@output_folder}/#{name}.#{new_ext}'"
         end
       end
     end
     
+    # use path to determine folder name and
+    # create the required folder if it doesn't exist
+    def create_dir(path)
+      FileUtils.makedirs path.split('/').reverse[1..-1].reverse.join('/')
+    end
+    
     # copies over static content
     def copy_static
-      puts "Copying over your static content" unless @environment == :test
+      puts " - \033[32mCopying\033[0m static content"
       static_folder = File.join(@proj_dir, @static_folder)
       FileUtils.cp_r(File.join(static_folder, '/.'), @output_path) 
     end
     
     # create the dump dir, compile templates, copy over static assets
-    def dump
+    def dump(options={:production => false})
       FileUtils.mkdir(@output_path)
-      puts "Create #{@output_folder}" unless @environment == :test
+      puts "\nFrank is..."
+      puts " - \033[32mCreating\033[0m '#{@output_folder}'"
       
-      compile_templates
+      compile_templates(options)
       copy_static
+      puts "\n \033[32mCongratulations, project dumped to '#{@output_folder}' successfully!\033[0m"
     end
   end
   

data/test/test_base.rb

@@ -68,7 +68,7 @@ class TestBase < Test::Unit::TestCase
       should 'stub out a project' do
         out = capture_stdout { Frank.stub('stubbed') }
         assert_equal Dir.entries('stubbed'), Dir.entries(File.join(LIBDIR, 'template'))
-        putss = "\n-----------------------\n Frank:\n - Creating 'stubbed'\n - Copying Frank template\n\n Congratulations, 'stubbed' is ready to go.\n\n"
+        putss = "\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"
         assert_equal putss, out.string
       end
     

data/test/test_output.rb

@@ -8,14 +8,16 @@ class TestBase < Test::Unit::TestCase
       proj_dir = File.join(File.dirname(__FILE__), 'template')
       settings = YAML.load_file(File.join(proj_dir, 'settings.yml'))
       require File.join(proj_dir, 'helpers')
-      @frank = Frank::Output.new do
-        settings.each do |name, value|
-          set name.to_s, value
-        end
-        set :environment, :test
-        set :proj_dir, proj_dir
-        set :output_folder, 'output'
-      end.dump
+      capture_stdout do
+        @frank = Frank::Output.new do
+          settings.each do |name, value|
+            set name.to_s, value
+          end
+          set :environment, :test
+          set :proj_dir, proj_dir
+          set :output_folder, 'output'
+        end.dump
+      end
     end
     
     should 'create the output folder' do
@@ -74,7 +76,84 @@ class TestBase < Test::Unit::TestCase
     teardown do
       FileUtils.rm_r File.join(File.dirname(__FILE__), 'template/output')
     end
-
+  end
+  
+  context 'Frank::Output Production' do
+    
+    setup 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 = Frank::Output.new do
+          settings.each do |name, value|
+            set name.to_s, value
+          end
+          set :environment, :test
+          set :proj_dir, proj_dir
+          set :output_folder, 'output'
+        end.dump({:production => true})
+      end
+    end
+    
+    should 'create the output folder' do
+      assert File.exist? File.join(File.dirname(__FILE__), 'template/output')
+    end
+    
+    should 'create index.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/index.html')
+      assert_equal "<div id='layout'>\n  <h1>hello worlds</h1>\n</div>\n", IO.read(output)
+    end
+    
+    should  'create partial_test.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/partial_test/index.html')
+      assert_equal "<div id='layout'>\n  <h1>hello worlds</h1>\n  <p>hello from partial</p>\n</div>\n", IO.read(output)   
+    end
+    
+    should 'create erb.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/erb/index.html')
+      assert_equal "<h1>hello worlds</h1>\n", IO.read(output)
+    end
+    
+    should 'create redcloth.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/redcloth/index.html')
+      assert_equal "<h1>hello worlds</h1>", IO.read(output)
+    end
+    
+    should 'create markdown.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/markdown/index.html')
+      assert_equal "<h1>hello worlds</h1>\n", IO.read(output)
+    end
+    
+    should 'create mustache.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/mustache/index.html')
+      assert_equal "<h1>hello worlds</h1>\n", IO.read(output)
+    end
+    
+    should 'create liquid.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/liquid/index.html')
+      assert_equal "<h1>hello worlds</h1>", IO.read(output)
+    end
+    
+    should 'create builder.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/builder/index.html')
+      assert_equal "<h1>hello worlds</h1>\n", IO.read(output)
+    end
+    
+    should 'copy static.html' do
+      output = File.join(File.dirname(__FILE__), 'template/output/static.html')
+      assert_equal "hello from static", IO.read(output)
+    end
+    
+    should 'not create partials' do
+      assert !File.exist?(File.join(File.dirname(__FILE__), 'template/output/_partial/index.html'))
+    end
+    
+    teardown do
+      FileUtils.rm_r File.join(File.dirname(__FILE__), 'template/output')
+    end
+  
     
   end
   

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - blahed
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-29 00:00:00 -04:00
+date: 2010-04-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency