frank 0.4.1 → 1.0.0

data/lib/frank/cli.rb

@@ -0,0 +1,152 @@
+require 'optparse'
+
+module Frank
+  class CLI
+    BANNER = <<-USAGE
+    Usage:
+      frank new PROJECT_PATH
+      frank server [options]
+      frank export PATH [options]
+      frank publish
+
+    Description:
+      The `frank new' command generates a frank template project with the default
+      directory structure and configuration at the given path.
+
+      Once you have a frank project you can use the `frank server' or the aliased 'frank up' commands
+      to start the development server and begin developing your project.
+
+      When you are finished working and ready to export you can use
+      the `frank export' or aliased `frank out' commands.
+
+    Example:
+      frank new ~/Dev/blah.com
+      cd ~/Dev/blah.com
+      frank server
+
+      # do some development
+
+      # export it
+      frank export ~/Dev/html/blah.com
+
+      # or publish it
+      frank publish
+    USAGE
+
+    class << self
+
+      def set_options
+        @options = {:server => {}}
+
+        @opts = OptionParser.new do |opts|
+          opts.banner = BANNER.gsub(/^\s{4}/, '')
+
+          opts.separator ''
+          opts.separator 'Options:'
+
+          opts.on('--server [HANDLER]', 'Set the server handler (frank server)') do |handler|
+            @options[:server]['handler'] = handler unless handler.nil?
+          end
+
+          opts.on('--hostname [HOSTNAME]', 'Set the server hostname (frank server)') do |hostname|
+            @options[:server]['hostname'] = hostname unless hostname.nil?
+          end
+
+          opts.on('--port [PORT]', 'Set the server port (frank server)') do |port|
+            @options[:server]['port'] = port unless port.nil?
+          end
+
+          opts.on('--dynamic_folder [FOLDER]', 'Set the dynamic folder (frank server)') do |folder|
+            @options[:dynamic_folder] = folder unless folder.nil?
+          end
+
+          opts.on('--static_folder [FOLDER]', 'Set the static folder (frank server)') do |folder|
+            @options[:static_folder] = folder unless folder.nil?
+          end
+
+          opts.on('--production', 'Production ready export (frank export) i.e. ([FOLDER]/index.html)') do |handler|
+            @options[:production] = true
+          end
+
+          opts.on('-v', '--version', 'Show the frank version and exit') do
+            puts "Frank v#{Frank::VERSION}"
+            exit
+          end
+
+          opts.on( '-h', '--help', 'Display this help' ) do
+            puts opts
+            exit
+          end
+        end
+
+        @opts.parse!
+      end
+
+      # parse and set options
+      # bootstrap if we need to
+      # and go go go
+      def run
+        set_options
+
+        if ARGV.empty?
+          print_usage_and_exit!
+        else
+          bootstrap
+          run!
+        end
+      end
+
+      # determine what the user wants us to do
+      # and then, just do it
+      def run!
+        case ARGV.first
+        when 'new', 'n'
+          print_usage_and_exit! unless ARGV[1]
+          # stub out the project
+          Frank.stub(ARGV[1])
+        when 'server', 's', 'up'
+          # 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
+        when 'export', 'e', 'out'
+          # compile the project
+          print_usage_and_exit! unless ARGV[1]
+          Frank.exporting!
+          Frank.production! if @options[:production]
+          Frank.export.path = ARGV[1]
+          Frank::Compile.export!
+        when 'publish', 'p'
+          # compile the project and scp it to server
+          Frank.publishing!
+          Frank::Publish::SCP.execute!
+        when 'upgrade'
+          # upgrade if we need to upgrade
+          Frank.upgrade!
+        end
+      end
+
+      # print the usage banner and exit
+      def print_usage_and_exit!
+        puts @opts
+        exit
+      end
+
+      # bootstrap this project up
+      # only if we really need to
+      def bootstrap
+        if %w[server up export out publish upgrade s e p].include? ARGV.first
+          Frank.bootstrap(Dir.pwd)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/frank/compile.rb

@@ -0,0 +1,65 @@
+module Frank
+  class Compile < Frank::Base
+
+    class << self
+      include Frank::Render
+
+      # 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
+        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 Frank.production? && "#{name}.#{new_ext}" != 'index.html' && new_ext == 'html'
+              new_file = File.join(Frank.export.path, path.sub(/(\/?[\w-]+)\.[\w-]+$/, "\\1/index.#{new_ext}"))
+            else
+              new_file = File.join(Frank.export.path, 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}'" unless Frank.silent_export?
+          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" unless Frank.silent_export?
+        static_folder = File.join(Frank.root, Frank.static_folder)
+        FileUtils.cp_r(File.join(static_folder, '/.'), Frank.export.path)
+      end
+
+      # TODO verbose everywhere is lame
+      # create the dump dir, compile templates, copy over static assets
+      def export!
+        FileUtils.mkdir(Frank.export.path)
+
+        unless Frank.silent_export?
+          puts "\nFrank is..."
+          puts " - \033[32mCreating\033[0m '#{Frank.export.path}'"
+        end
+
+        compile_templates
+        copy_static
+
+        puts "\n \033[32mCongratulations, project dumped to '#{Frank.export.path}' successfully!\033[0m" unless Frank.silent_export?
+      end
+    end
+
+  end
+end

data/lib/frank/lorem.rb

@@ -2,17 +2,12 @@ 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
+      if Frank.exporting? && replacement
         replacement
       else
         (1..total).map do
@@ -27,7 +22,7 @@ module Frank
 
     def sentences(total, replacement = nil)
       # TODO: Don't capitalize replacement field
-      if @environment == :output && replacement
+      if Frank.exporting? && replacement
         replacement
       else
         (1..total).map do
@@ -41,7 +36,7 @@ module Frank
     end
 
     def paragraphs(total, replacement = nil)
-      if @environment == :output && replacement
+      if Frank.exporting? && replacement
         replacement
       else
         (1..total).map do
@@ -51,7 +46,7 @@ module Frank
     end
 
     def date(fmt = '%a %b %d, %Y', replacement = nil)
-      if @environment == :output && replacement
+      if Frank.exporting? && replacement
         replacement
       else
         y = rand(20) + 1990
@@ -62,7 +57,7 @@ module Frank
     end
 
     def name(replacement = nil)
-      if @environment == :output && replacement
+      if Frank.exporting? && replacement
         replacement
       else
         "#{first_name} #{last_name}"
@@ -70,7 +65,7 @@ module Frank
     end
 
     def first_name(replacement = nil)
-      if @environment == :output && replacement
+      if Frank.exporting? && replacement
         replacement
       else
         names = %w(Judith Angelo Margarita Kerry Elaine Lorenzo Justice Doris Raul Liliana Kerry Elise Ciaran Johnny Moses Davion Penny Mohammed Harvey Sheryl Hudson Brendan Brooklynn Denis Sadie Trisha Jacquelyn Virgil Cindy Alexa Marianne Giselle Casey Alondra Angela Katherine Skyler Kyleigh Carly Abel Adrianna Luis Dominick Eoin Noel Ciara Roberto Skylar Brock Earl Dwayne Jackie Hamish Sienna Nolan Daren Jean Shirley Connor Geraldine Niall Kristi Monty Yvonne Tammie Zachariah Fatima Ruby Nadia Anahi Calum Peggy Alfredo Marybeth Bonnie Gordon Cara John Staci Samuel Carmen Rylee Yehudi Colm Beth Dulce Darius inley Javon Jason Perla Wayne Laila Kaleigh Maggie Don Quinn Collin Aniya Zoe Isabel Clint Leland Esmeralda Emma Madeline Byron Courtney Vanessa Terry Antoinette George Constance Preston Rolando Caleb Kenneth Lynette Carley Francesca Johnnie Jordyn Arturo Camila Skye Guy Ana Kaylin Nia Colton Bart Brendon Alvin Daryl Dirk Mya Pete Joann Uriel Alonzo Agnes Chris Alyson Paola Dora Elias Allen Jackie Eric Bonita Kelvin Emiliano Ashton Kyra Kailey Sonja Alberto Ty Summer Brayden Lori Kelly Tomas Joey Billie Katie Stephanie Danielle Alexis Jamal Kieran Lucinda Eliza Allyson Melinda Alma Piper Deana Harriet Bryce Eli Jadyn Rogelio Orlaith Janet Randal Toby Carla Lorie Caitlyn Annika Isabelle inn Ewan Maisie Michelle Grady Ida Reid Emely Tricia Beau Reese Vance Dalton Lexi Rafael Makenzie Mitzi Clinton Xena Angelina Kendrick Leslie Teddy Jerald Noelle Neil Marsha Gayle Omar Abigail Alexandra Phil Andre Billy Brenden Bianca Jared Gretchen Patrick Antonio Josephine Kyla Manuel Freya Kellie Tonia Jamie Sydney Andres Ruben Harrison Hector Clyde Wendell Kaden Ian Tracy Cathleen Shawn)
@@ -79,7 +74,7 @@ module Frank
     end
 
     def last_name(replacement = nil)
-      if @environment == :output && replacement
+      if Frank.exporting? && replacement
         replacement
         else
         names = %w(Chung Chen Melton Hill Puckett Song Hamilton Bender Wagner McLaughlin McNamara Raynor Moon Woodard Desai Wallace Lawrence Griffin Dougherty Powers May Steele Teague Vick Gallagher Solomon Walsh Monroe Connolly Hawkins Middleton Goldstein Watts Johnston Weeks Wilkerson Barton Walton Hall Ross Chung Bender Woods Mangum Joseph Rosenthal Bowden Barton Underwood Jones Baker Merritt Cross Cooper Holmes Sharpe Morgan Hoyle Allen Rich Rich Grant Proctor Diaz Graham Watkins Hinton Marsh Hewitt Branch Walton O'Brien Case Watts Christensen Parks Hardin Lucas Eason Davidson Whitehead Rose Sparks Moore Pearson Rodgers Graves Scarborough Sutton Sinclair Bowman Olsen Love McLean Christian Lamb James Chandler Stout Cowan Golden Bowling Beasley Clapp Abrams Tilley Morse Boykin Sumner Cassidy Davidson Heath Blanchard McAllister McKenzie Byrne Schroeder Griffin Gross Perkins Robertson Palmer Brady Rowe Zhang Hodge Li Bowling Justice Glass Willis Hester Floyd Graves Fischer Norman Chan Hunt Byrd Lane Kaplan Heller May Jennings Hanna Locklear Holloway Jones Glover Vick O'Donnell Goldman McKenna Starr Stone McClure Watson Monroe Abbott Singer Hall Farrell Lucas Norman Atkins Monroe Robertson Sykes Reid Chandler Finch Hobbs Adkins Kinney Whitaker Alexander Conner Waters Becker Rollins Love Adkins Black Fox Hatcher Wu Lloyd Joyce Welch Matthews Chappell MacDonald Kane Butler Pickett Bowman Barton Kennedy Branch Thornton McNeill Weinstein Middleton Moss Lucas Rich Carlton Brady Schultz Nichols Harvey Stevenson Houston Dunn West O'Brien Barr Snyder Cain Heath Boswell Olsen Pittman Weiner Petersen Davis Coleman Terrell Norman Burch Weiner Parrott Henry Gray Chang McLean Eason Weeks Siegel Puckett Heath Hoyle Garrett Neal Baker Goldman Shaffer Choi Carver)
@@ -88,7 +83,7 @@ module Frank
     end
 
     def email(replacement = nil)
-      if @environment == :output && replacement
+      if Frank.exporting? && replacement
         replacement
       else
         delimiters = [ '_', '-', '' ]
@@ -98,8 +93,9 @@ module Frank
       end
     end
 
+
     def image(size, options={})
-      if @environment == :output && options[:replacement]
+      if Frank.exporting? && options[:replacement]
         options[:replacement]
       else
         src              = "http://placehold.it/#{size}"

data/lib/frank/publish.rb

@@ -0,0 +1,46 @@
+module Frank
+  module Publish
+
+    class SCP
+      def self.execute!
+        puts "\nFrank is..."
+        puts " - \033[32mExporting templates\033[0m"
+
+        tmp_folder = "/tmp/frankexp-#{Frank.proj_name}"
+
+        # remove stale folder if it exists
+        FileUtils.rm_rf(tmp_folder) if File.exist?(tmp_folder)
+
+        # dump the project in production mode to tmp folder
+        Frank.export.path = tmp_folder
+        Frank.export.silent = true
+        Frank::Compile.export!
+
+        puts " - \033[32mPublishing to:\033[0m `#{Frank.publish.host}:#{Frank.publish.path}'"
+
+        ssh_options = {
+          :password => Frank.publish.password,
+          :port     => Frank.publish.port
+        }
+
+        current = nil
+
+        # upload the files and report progress
+        Net::SSH.start(Frank.publish.host, Frank.publish.user, ssh_options) do |ssh|
+          ssh.scp.upload!(tmp_folder, Frank.publish.path, :recursive => true, :chunk_size => 2048) do |ch, name, sent, total|
+
+            puts "   - #{name[tmp_folder.length..-1]}" unless name == current
+
+            current = name
+          end
+        end
+
+        # cleanup by removing tmp folder
+        FileUtils.rm_rf(tmp_folder)
+
+        puts "\n\033[32mPublish complete!\033[0m"
+      end
+    end
+
+  end
+end

data/lib/frank/settings.rb

@@ -12,6 +12,8 @@ module Frank
     attr_accessor :static_folder
     attr_accessor :dynamic_folder
     attr_accessor :layouts_folder
+    attr_accessor :export
+    attr_accessor :publish
     attr_accessor :sass_options
 
     def initialize
@@ -29,6 +31,18 @@ module Frank
       # reset options
       @options = OpenStruct.new
 
+      # export settings
+      @export = OpenStruct.new
+      @export.path = nil
+      @export.silent = false
+
+      # publish options
+      @publish = OpenStruct.new
+      @publish.host = nil
+      @publish.path = nil
+      @publish.username = nil
+      @publish.password = nil
+
       # setup folders
       @static_folder = "static"
       @dynamic_folder = "dynamic"
@@ -38,6 +52,26 @@ module Frank
       @sass_options = {}
     end
 
+    # return the proj folder name
+    def proj_name
+      @root.split('/').last
+    end
+
+    # Check to see if we're compiling
+    def exporting?
+      @exporting
+    end
+
+    # Mark this Frank run as compiling
+    def exporting!
+      @exporting = true
+    end
+
+    # Silent export if set or in test
+    def silent_export?
+      @environment == :test || @export.silent
+    end
+
     # Check to see if we're in production mode
     def production?
       @production
@@ -48,5 +82,11 @@ module Frank
       @production = true
     end
 
+    # Mark this Frank run as publishing
+    def publishing!
+      @exporting  = true
+      @production = true
+    end
+
   end
 end

data/lib/frank/template_helpers.rb

@@ -3,20 +3,20 @@ require 'frank/lorem'
 module Frank
   module TemplateHelpers
     include FrankHelpers if defined? FrankHelpers
-  
+
     def render_partial(path, *locals)
       pieces = path.split('/')
       partial = '_' + pieces.pop
       locals = locals.empty? ? nil : locals[0]
       render(File.join(pieces.join('/'), partial), partial = true, locals)
     end
-    
+
     def lorem
-      Frank::Lorem.new(@environment)
+      Frank::Lorem.new
     end
-    
+
     def refresh
-      if @environment == :output
+      if Frank.exporting?
         nil
       else
         <<-JS
@@ -30,9 +30,9 @@ module Frank
             }
 
             (function poll(){
-              var req = new XMLHttpRequest();  
-              req.open('GET', '/__refresh__', true);  
-              req.onreadystatechange = function (aEvt) {  
+              var req = new XMLHttpRequest();
+              req.open('GET', '/__refresh__', true);
+              req.onreadystatechange = function (aEvt) {
                 if ( req.readyState == 4 && req.status == 200 )
                   process(req.responseText);
               };
@@ -45,6 +45,6 @@ module Frank
         JS
       end
     end
-    
+
   end
 end