frank 0.4.1 → 1.0.0

data/lib/template/setup.rb

@@ -42,6 +42,23 @@ Frank.dynamic_folder = "dynamic"
 #
 Frank.layouts_folder = "layouts"
 
+# ----------------------
+#  Publish settings:
+#
+#  Frank can publish your exported project to
+#  a server. All you have to do is tell Frank what host, path, and username.
+#  If you have ssh keys setup there is no need for a password.
+#  Just uncomment the Publish settings below and
+#  make the appropriate changes.
+#
+#  Frank.publish.host = "example.com"
+#  Frank.publish.path = "/www"
+#  Frank.publish.username = 'me'
+#  Frank.publish.password = 'secret'
+#  Frank.publish.port = 22
+#
+
+
 
 # ----------------------
 # Initializers:

data/spec/base_spec.rb

@@ -6,8 +6,6 @@ describe Frank::Base do
   def app
     Frank.bootstrap(File.join(File.dirname(__FILE__), 'template'))
     Frank.new do
-      set :environment, :test
-
       # this is just used for a test
       @blowup_sometimes = true
     end

data/spec/{output_spec.rb → compile_spec.rb}

@@ -1,11 +1,11 @@
 require File.dirname(__FILE__) + '/helper'
 
-describe Frank::Output do
+describe Frank::Compile do
   include Rack::Test::Methods
 
   context 'default output' do
     before :all do
-      bin_dir    = File.join(File.dirname(File.dirname(__FILE__)), 'bin', 'frankout')
+      bin_dir    = File.join(File.dirname(File.dirname(__FILE__)), 'bin', 'frank export')
       proj_dir   = File.join(File.dirname(__FILE__), 'template')
       output_dir = File.join(proj_dir, 'output')
       Dir.chdir proj_dir do
@@ -62,11 +62,6 @@ describe Frank::Output do
       File.read(output).should == "<div id='p'>/markdown</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n</div>\n"
     end
 
-    it 'creates mustache.html' do
-      output = File.join(File.dirname(__FILE__), 'template/output/mustache.html')
-      File.read(output).should == "<div id='p'>/mustache</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n</div>\n"
-    end
-
     it 'creates liquid.html' do
       output = File.join(File.dirname(__FILE__), 'template/output/liquid.html')
       File.read(output).should == "<div id='p'>/liquid</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n</div>\n"
@@ -110,7 +105,7 @@ describe Frank::Output do
 
   context 'productions output' do
     before :all do
-      bin_dir    = File.join(File.dirname(File.dirname(__FILE__)), 'bin', 'frankout')
+      bin_dir    = File.join(File.dirname(File.dirname(__FILE__)), 'bin', 'frank export')
       proj_dir   = File.join(File.dirname(__FILE__), 'template')
       output_dir = File.join(proj_dir, 'output')
       Dir.chdir proj_dir do
@@ -167,11 +162,6 @@ describe Frank::Output do
       File.read(output).should == "<div id='p'>/markdown</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n</div>\n"
     end
 
-    it 'creates mustache.html' do
-      output = File.join(File.dirname(__FILE__), 'template/output/mustache/index.html')
-      File.read(output).should == "<div id='p'>/mustache</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n</div>\n"
-    end
-
     it 'creates liquid.html' do
       output = File.join(File.dirname(__FILE__), 'template/output/liquid/index.html')
       File.read(output).should == "<div id='p'>/liquid</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n</div>\n"

data/spec/publish_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe Frank::Publish do
+  include Rack::Test::Methods
+
+    before :all do
+      @proj_dir   = File.join(File.dirname(__FILE__), 'template')
+
+      bin_dir    = File.join(File.dirname(File.dirname(__FILE__)), 'bin')
+      Dir.chdir @proj_dir do
+        system "#{bin_dir}/frank publish"
+      end
+    end
+
+    it 'creates the published folder' do
+      File.exist?("/tmp/frankexp-#{@proj_dir.split('/').last}").should be_true
+    end
+
+    after(:all) do
+      #FileUtils.rm_r File.join(File.dirname(__FILE__), 'template/output')
+    end
+
+end

data/spec/render_spec.rb

@@ -5,9 +5,7 @@ describe Frank::Render do
 
   def app
     Frank.bootstrap(File.join(File.dirname(__FILE__), 'template'))
-    Frank.new do
-      set :environment, :test
-    end
+    Frank.new
   end
 
   before(:all) do
@@ -91,11 +89,6 @@ describe Frank::Render do
      template.should == "<div id='p'>/markdown</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n</div>\n"
    end
 
-   it 'renders mustache template' do
-     template = @app.render('mustache.mustache')
-     template.should == "<div id='p'>/mustache</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n</div>\n"
-   end
-
    it 'renders liquid template' do
      template = @app.render('liquid.liquid')
      template.should == "<div id='p'>/liquid</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n</div>\n"

data/spec/template/setup.rb

@@ -1 +1,4 @@
-Frank.environment = :test
+Frank.environment = :test
+Frank.publish.path = '/tmp'
+Frank.publish.host = 'linda'
+Frank.publish.user = 'badmin'

data/spec/template_helpers_spec.rb

@@ -6,9 +6,7 @@ describe Frank::TemplateHelpers do
   def app
     Frank.bootstrap(File.join(File.dirname(__FILE__), 'template'))
     require File.join(Frank.root, 'helpers')
-    Frank.new do
-      set :environment, :test
-    end
+    Frank.new
   end
 
   before(:all) do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: frank
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 23
   prerelease: false
   segments: 
-  - 0
-  - 4
   - 1
-  version: 0.4.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - blahed
@@ -16,8 +16,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-15 00:00:00 -04:00
-default_executable: 
+date: 2010-11-08 00:00:00 -05:00
+default_executable: frank
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
@@ -101,8 +101,6 @@ description: Rapidly develop static sites using any supported templating languag
 email: travis.dunn@thisismedium.com
 executables: 
 - frank
-- frankout
-- frankup
 extensions: []
 
 extra_rdoc_files: 
@@ -110,23 +108,23 @@ extra_rdoc_files:
 - README.md
 files: 
 - .gitignore
-- Featurelist
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- autotest/discover.rb
 - bin/frank
-- bin/frankout
-- bin/frankup
 - frank.gemspec
 - lib/frank.rb
 - lib/frank/base.rb
+- lib/frank/cli.rb
+- lib/frank/compile.rb
 - lib/frank/lorem.rb
 - lib/frank/middleware/imager.rb
 - lib/frank/middleware/refresh.rb
 - lib/frank/middleware/statik.rb
-- lib/frank/output.rb
+- lib/frank/publish.rb
 - lib/frank/rescue.rb
 - lib/frank/settings.rb
 - lib/frank/template_helpers.rb
@@ -155,8 +153,9 @@ files:
 - lib/template/static/images/frank-med.png
 - lib/template/static/js/frank.js
 - spec/base_spec.rb
+- spec/compile_spec.rb
 - spec/helper.rb
-- spec/output_spec.rb
+- spec/publish_spec.rb
 - spec/render_spec.rb
 - spec/template/dynamic/500.haml
 - spec/template/dynamic/_partial.haml
@@ -170,7 +169,6 @@ files:
 - spec/template/dynamic/lorem_test.haml
 - spec/template/dynamic/markdown.md
 - spec/template/dynamic/markdown_in_haml.md
-- spec/template/dynamic/mustache.mustache
 - spec/template/dynamic/nested/child.haml
 - spec/template/dynamic/nested/deeper/deep.haml
 - spec/template/dynamic/no_layout.haml
@@ -225,8 +223,9 @@ specification_version: 3
 summary: Static Site Non-Framework
 test_files: 
 - spec/base_spec.rb
+- spec/compile_spec.rb
 - spec/helper.rb
-- spec/output_spec.rb
+- spec/publish_spec.rb
 - spec/render_spec.rb
 - spec/template/helpers.rb
 - spec/template/setup.rb

data/Featurelist

@@ -1,6 +0,0 @@
-- DONE - support layouts of a different type than the rendered template
-dynamically reload template changes using javascript and a slick url
-dynamically reload helpers and settings
-- DONE - support yaml variable definition at the top of templates
-- DONE - add helper for "selected" css class, this should work with frankup and frankout
-- DONE - add frankout replacement fields to lorem helpers 

data/bin/frankout

@@ -1,67 +0,0 @@
-#!/usr/bin/env ruby
-require 'optparse'
-
-puts "\nthe `frankout' command is deprecated and will be removed in 0.5, use `frank export' or the alias `frank out'"
-
-begin
-  # try to use bundler if its available
-  require 'bundler'
-  begin
-    Bundler.require
-  rescue Bundler::GemfileNotFound
-    # revert to using local frank install
-    $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-  end
-rescue LoadError
-  # revert to using local frank install
-  $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-end
-
-require 'frank'
-
-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|
-    production = true
-  end
-
-  opts.on( '-h', '--help', 'Display this help' ) do
-    puts opts
-    exit
-  end
-end
-
-opts.parse!
-
-if ARGV.empty?
-  puts opts
-  exit
-end
-
-output_folder = ARGV.first
-
-if File.exists? output_folder
-  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)
-end
-
-begin
-  Frank.production! if production
-  Frank.bootstrap(Dir.pwd)
-  Frank::Output.new do
-    set :environment, :output
-    set :output_folder, output_folder
-  end.dump(production)
-
-rescue Errno::ENOENT
-  puts "Frank could not find setup.rb"
-end

data/bin/frankup

@@ -1,69 +0,0 @@
-#!/usr/bin/env ruby
-require 'optparse'
-
-puts "\nthe `frankup' command is deprecated and will be removed in 0.5, use `frank server' or the alias `frank up'"
-
-begin
-  # try to use bundler if its available
-  require 'bundler'
-  begin
-    Bundler.require
-  rescue Bundler::GemfileNotFound
-    # revert to using local frank install
-    $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-  end
-rescue LoadError
-  # revert to using local frank install
-  $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-end
-
-require 'frank'
-
-options = {:server => {}}
-
-OptionParser.new do |opts|
-  opts.banner = "Usage: frankup [OPTIONS]\n",
-                "Starts the frank development server using setup.rb\n",
-                "If setup.rb 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?
-  end
-
-  opts.on('--hostname [HOSTNAME]', 'Set the server hostname') do |hostname|
-    options[:server]['hostname'] = hostname unless hostname.nil?
-  end
-
-  opts.on('--port [PORT]', 'Set the server port') do |port|
-    options[:server]['port'] = port unless port.nil?
-  end
-
-  opts.on('--dynamic_folder [FOLDER]', 'Set the dynamic folder') do |folder|
-    options[:dynamic_folder] = folder unless folder.nil?
-  end
-
-  opts.on('--static_folder [FOLDER]', 'Set the static folder') do |folder|
-    options[:static_folder] = folder unless folder.nil?
-  end
-
-  opts.on( '-h', '--help', 'Display this help' ) do
-    puts opts
-    exit
-  end
-end.parse!
-
-Frank.bootstrap(Dir.pwd)
-
-# setup server from options
-server_options        = options[:server]
-Frank.server.handler  = server_options['handler'] if server_options['handler']
-Frank.server.hostname = server_options['hostname'] if server_options['hostname']
-Frank.server.port     = server_options['port'] if server_options['port']
-
-# setup folder options
-Frank.dynamic_folder = options[:dynamic_folder] if options[:dynamic_folder]
-Frank.static_folder  = options[:static_folder] if options[:static_folder]
-
-Frank.new

data/lib/frank/output.rb

@@ -1,63 +0,0 @@
-module Frank
-  class Output < Frank::Base
-    include Frank::Render
-
-    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
-    # name a folder based on the template and compile to index.html
-    # otherwise compile as is
-    def compile_templates(production)
-      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)
-          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}"))
-          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(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