serve 1.1.1 → 1.5.0.pre

data/CHANGELOG.rdoc

@@ -1,5 +1,8 @@
 = Change Log
 
+== edge
+* Added an export command which allows you to convert a Serve site to static HTML. Closes #10. [jlong]
+
 == 1.1.1 (June 7, 2011)
 * Fix: Allow create command to work without Git. Closes #24. [jlong]
 * Add javascript and stylesheet include helpers [zaeleus]

data/Gemfile

@@ -2,6 +2,7 @@ source "http://rubygems.org"
 
 gem 'rake',             '~> 0.9.0'
 gem 'rack',             '~> 1.3.0'
+gem 'rack-test',        '~> 0.6.0'
 gem 'tilt',             '~> 1.3.1'
 gem 'activesupport',    '~> 3.0.7'
 gem 'tzinfo',           '~> 0.3.27'

data/Gemfile.lock

@@ -26,6 +26,8 @@ GEM
     mutter (0.5.3)
     polyglot (0.3.1)
     rack (1.3.0)
+    rack-test (0.6.0)
+      rack (>= 1.0)
     radius (0.6.1)
     rake (0.9.0)
     rdiscount (1.6.8)
@@ -62,6 +64,7 @@ DEPENDENCIES
   jeweler (~> 1.4.0)
   less (~> 1.2.21)
   rack (~> 1.3.0)
+  rack-test (~> 0.6.0)
   radius (~> 0.6.1)
   rake (~> 0.9.0)
   rdiscount (~> 1.6.8)

data/README.rdoc

@@ -229,8 +229,8 @@ module and define your helper methods there:
 Helpers have full access to the request and response objects so you can easily
 read and manipulate headers or do other fancy tricks.
 
-Serve provides a number of stock helpers to make it easier for you to prototype
-Rails applications:
+Serve provides a number of stock helpers to make it easier for you to 
+prototype Rails applications:
 
   # Escape Helpers
   html_escape(string)              # escape HTML in string
@@ -285,6 +285,24 @@ email :: Evaluates the document as if it is an e-mail message; the format is ide
 redirect :: Redirects to the URL contained in the document
 
 
+== Exporting A Serve Project
+
+The edge version of Serve now has limited support for exporting your Serve 
+project to HTML. To get started with the prerelease version:
+
+  gem install --pre serve
+
+To export your project, use the new "export" command:
+
+  serve export <project_dir>:<output_dir>
+
+Where <project_dir> is the path to the project and <output_dir> is the path to 
+the directory where you would like your HTML and CSS generated.
+
+Please note! This feature is in beta. If you have issues with this approach,
+please post them to the GitHub issue tracker.
+
+
 == More Information
 
 You can find more information about Serve, including a detailed Screencast, on

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.5.0.pre

data/lib/serve/application.rb

@@ -20,10 +20,13 @@ module Serve
       case
       when options[:create]
         require 'serve/project'
-        Serve::Project.new(options[:create]).create
+        Serve::Project.create(options[:create])
       when options[:convert]
         require 'serve/project'
-        Serve::Project.new(options[:convert]).convert
+        Serve::Project.convert(options[:convert])
+      when options[:export]
+        require 'serve/export'
+        Serve.export(options[:export])
       when options[:version]
         puts version
       when options[:help]
@@ -49,8 +52,9 @@ module Serve
       args = normalize_args(args)
       options[:help]        = extract_boolean(args, '-h', '--help')
       options[:version]     = extract_boolean(args, '-v', '--version')
-      options[:create]      = extract_creation(args)
-      options[:convert]     = extract_conversion(args)
+      options[:create]      = extract_create(args)
+      options[:convert]     = extract_convert(args)
+      options[:export]      = extract_export(args)
       options[:environment] = extract_environment(args)
       options[:root]        = extract_root(args)
       options[:address]     = extract_address(args)
@@ -78,11 +82,12 @@ module Serve
         "  #{program} command [arguments] [options]",
         "  ",
         "Examples:",
-        "  #{program}                   # start Serve in current directory",
-        "  #{program} 2100              # start Serve on port 2100",
-        "  #{program} /path/to/project  # start Serve for a specific directory",
-        "  #{program} create mockups    # create a Serve project in mockups directory",
-        "  #{program} convert mockups   # convert a Compass project in mockups",
+        "  #{program}                       # launch server in current directory",
+        "  #{program} 2100                  # launch server on port 2100",
+        "  #{program} mockups               # launch server for mockups directory",
+        "  #{program} create mockups        # create a new project in mockups dir",
+        "  #{program} convert mockups       # convert a Compass project in mockups",
+        "  #{program} export mockups:output # export mockups to output dir",
         "  ",
         "Description:",
         "  Starts a web server on the specified address and port with its document root ",
@@ -174,7 +179,7 @@ module Serve
         framework
       end
       
-      def extract_creation(args)
+      def extract_create(args)
         if args.delete('create')
           framework = extract_javascript_framework(args, '-j', '--javascript')
           args.reverse!
@@ -186,7 +191,7 @@ module Serve
         end
       end
       
-      def extract_conversion(args)
+      def extract_convert(args)
         if args.delete('convert')
           framework = extract_javascript_framework(args, '-j', '--javascript')
           {
@@ -196,6 +201,19 @@ module Serve
         end
       end
       
+      def extract_export(args)
+        if args.delete('export')
+          input, output = (args.shift || '').split(':')
+          output = args.shift            if output.nil?
+          input, output = Dir.pwd, input if output.nil?
+          output = 'output'              if output.nil?
+          {
+            :input => input,
+            :output => output
+          }
+        end
+      end
+      
       def rails_script_server
         @rails_server_script ||= options[:root] + '/script/server'
       end

data/lib/serve/export.rb

@@ -0,0 +1,161 @@
+require 'active_support/all'
+require 'serve/out'
+require 'serve/path'
+require 'serve/rack'
+require 'fileutils'
+require 'rack/test'
+
+module Serve
+  class Exporter
+    
+    def initialize(options={})
+      @input  = normalize_path(options[:input])
+      @output = normalize_path(options[:output])
+    end
+    
+    def process
+      compile_compass_sass
+      collect_files
+      compile_views
+      compile_redirects
+      copy_remaining
+    end
+    
+    private
+      
+      include Serve::Out
+      include Serve::Path
+      
+      def collect_files
+        if rackified?
+          @root = "#{@input}/views"
+          @views = files_from_path("#{@input}/views")
+          @redirects, @views = @views.partition { |fn| fn =~ %r{\.redirect$} }
+          @views.reject! { |fn| fn =~ /view_helpers.rb$/} # remove view_helpers.rb
+          @public = files_from_path("#{@input}/public")
+        else
+          @root = @input
+          files = files_from_path(@input)
+          extensions = Serve::DynamicHandler.extensions
+          @views, files = files.partition { |fn| fn =~ %r{#{extensions.join('|')}$} }
+          files.reject! { |fn| fn =~ /view_helpers.rb$/} # remove view_helpers.rb
+          @redirects, @public = files.partition { |fn| fn =~ %r{\.redirect$} }
+        end
+        @views.reject! { |v| v =~ %r{_[^\/]+$} }        # remove partials
+      end
+      
+      def compile_compass_sass
+        if rackified?
+          `compass compile -c '#{@input}/compass.config' '#{@input}'`
+          log_action 'compiled', 'sass files'
+        end
+      end
+      
+      def compile_views
+        @views.each { |v| compile_view(v) }
+      end
+      
+      def compile_redirects
+        @redirects.each { |r| compile_redirect(r) }
+      end
+      
+      def copy_remaining
+        @public.each { |fn| copy_file(fn) }
+      end
+      
+      def files_from_path(path)
+        result = nil
+        FileUtils.cd(path) do
+          result = Dir["**/*"]
+          result.reject! { |fn| File.directory?(fn) }
+        end
+        result
+      end
+      
+      def compile_view(filename)
+        from_path = rackified? ? "#{@input}/views/#{filename}" : "#{@input}/#{filename}"
+        
+        # request the path
+        browser = Rack::Test::Session.new(Rack::MockSession.new(Serve::RackAdapter.new(@root)))
+        browser.get filename
+        response = browser.last_response
+        
+        # body and extension
+        contents = response.body
+        ext = extract_ext(response.content_type)
+        
+        # write contents
+        to_path   = "#{@output}/#{remove_ext(filename)}#{ext}"
+        ensure_path to_path
+        File.open(to_path, 'w+') { |f| f.puts contents }
+        
+        log_action "compiled", to_path
+      rescue => e
+        log_error "failed", "#{from_path}\n#{e.message}\n#{e.backtrace.join("\n")}"
+      end
+      
+      def compile_redirect(filename)
+        from_path = rackified? ? "#{@input}/views/#{filename}" : "#{@input}/#{filename}"
+        to_path   = "#{@output}/#{remove_ext(filename)}.html"
+        
+        ensure_path to_path
+        
+        url = IO.read(from_path).strip
+        contents = %{<html><head><meta http-equiv="refresh" content="0;#{url}" /></head></html>}
+        
+        File.open(to_path, 'w+') { |f| f.puts contents }
+        
+        log_action "compiled", to_path
+      rescue => e
+        log_error "failed", "#{from_path}\n#{e.message}\n#{e.backtrace.join("\n")}"
+      end
+      
+      def copy_file(filename)
+        from_path = rackified? ? "#{@input}/public/#{filename}" : "#{@input}/#{filename}"
+        to_path   = "#{@output}/#{filename}"
+        
+        ensure_path to_path
+        
+        FileUtils.cp from_path, to_path
+        
+        log_action "copied", to_path
+      end
+      
+      def ensure_path(path)
+        dirname = normalize_path(File.dirname(path))
+        unless File.directory?(dirname)
+          FileUtils.mkdir_p(dirname)
+          log_action "created", dirname
+        end
+      end
+      
+      def remove_ext(path)
+        if path =~ /^(.*?)\.[A-Za-z]+[A-Za-z.]*$/
+          $1
+        else
+          path
+        end
+      end
+      
+      def extract_ext(content_type)
+        case content_type
+        when %r{text/html}
+          ".html"
+        when %r{text/css}
+          ".css"
+        when %r{text/javascript}
+          ".js"
+        else
+          raise content_type.inspect
+        end
+      end
+      
+      def rackified?
+        @rackified ||= File.directory?("#{@input}/views") && File.directory?("#{@input}/public")
+      end
+  end
+  
+  def self.export(options={})
+    Exporter.new(options).process
+  end
+end

data/lib/serve/out.rb

@@ -1,8 +1,12 @@
+require 'pathname'
+
 module Serve #:nodoc:
   
   # Utility methods for handling output to the terminal
   module Out #:nodoc:
     
+    COLUMN_WIDTH = 12
+    
     COLORS = {
       :clear  => 0,
       :red    => 31,
@@ -31,12 +35,19 @@ module Serve #:nodoc:
     end
     
     def print(*args)
-      stderr.print(color_msg(:green, *args))
+      stderr.print(*args)
     end
     
     def log_action(name, message)
-      print " " * (12 - name.length)
-      print name
+      print " " * (COLUMN_WIDTH - name.length)
+      print color_msg(:green, name)
+      print "  "
+      puts message
+    end
+    
+    def log_error(name, message)
+      print " " * (COLUMN_WIDTH - name.length)
+      print color_msg(:red, name)
       print "  "
       puts message
     end
@@ -52,5 +63,7 @@ module Serve #:nodoc:
     def color(pigment)
       "\e[#{COLORS[pigment.to_sym]}m"
     end
+    
   end
+  
 end

data/lib/serve/path.rb

@@ -0,0 +1,13 @@
+require 'pathname'
+
+module Serve #:nodoc:
+  module Path #:nodoc:
+    
+    # Normalize a path relative to the current working directory
+    def normalize_path(*paths)
+      path = File.join(*paths)
+      Pathname.new(File.expand_path(path)).relative_path_from(Pathname.new(Dir.pwd)).to_s
+    end
+    
+  end
+end

data/lib/serve/project.rb

@@ -1,5 +1,6 @@
-require 'pathname'
+require 'fileutils'
 require 'serve/out'
+require 'serve/path'
 require 'serve/javascripts'
 
 module Serve #:nodoc:
@@ -34,6 +35,10 @@ module Serve #:nodoc:
       install_javascript_framework @framework
     end
     
+    def self.create(options={})
+      new(options).create
+    end
+    
     # Convert an existing Compass project to a Serve project
     def convert
       setup_base
@@ -49,10 +54,14 @@ module Serve #:nodoc:
       note_old_compass_config
     end
     
+    def self.convert(options={})
+      new(options).convert
+    end
+    
     private
       
       include Serve::Out
-      
+      include Serve::Path
       include Serve::JavaScripts
       
       # Files required for both a new server project and for an existing compass project.
@@ -109,6 +118,14 @@ module Serve #:nodoc:
         instance_eval "%{#{contents}}"
       end
       
+      # Grab data by key from the git config file if it exists
+      def git_config(key)
+        value = `git config #{key}`.chomp
+        value.empty? ? nil : value
+      rescue
+        nil
+      end
+      
       # Create a file with contents
       def create_file(file, contents)
         path = normalize_path(@location, file)
@@ -148,19 +165,6 @@ module Serve #:nodoc:
         end
       end
       
-      # Convert dashes and spaces to underscores
-      def underscore(string)
-        string.gsub(/-|\s+/, '_')
-      end
-            
-      # Grab data by key from the git config file if it exists
-      def git_config(key)
-        value = `git config #{key}`.chomp
-        value.empty? ? nil : value
-      rescue
-        nil
-      end
-      
       # Normalize the path of the target directory
       def normalize_location(path, name = nil)
         path = File.join(path, underscore(name)) if name
@@ -168,10 +172,9 @@ module Serve #:nodoc:
         path
       end
       
-      # Normalize a path relative to the current working directory
-      def normalize_path(*paths)
-        path = File.join(*paths)
-        Pathname.new(File.expand_path(path)).relative_path_from(Pathname.new(Dir.pwd)).to_s
+      # Convert dashes and spaces to underscores
+      def underscore(string)
+        string.gsub(/-|\s+/, '_')
       end
       
   end

data/spec/project_spec.rb

@@ -18,7 +18,7 @@ describe Serve::Project do
         :framework  => 'jquery'
       }
       
-      @mockup       = Serve::Project.new(@options)
+      @mockup        = Serve::Project.new(@options)
       @mockup.stdout = SilentOut.new
       @mockup.stderr = SilentOut.new
       

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: serve
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
+  hash: 961916028
+  prerelease: true
   segments: 
   - 1
-  - 1
-  - 1
-  version: 1.1.1
+  - 5
+  - 0
+  - pre
+  version: 1.5.0.pre
 platform: ruby
 authors: 
 - John W. Long
@@ -37,9 +38,25 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: tilt
+  name: rack-test
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -51,11 +68,11 @@ dependencies:
         - 1
         version: 1.3.1
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -67,11 +84,11 @@ dependencies:
         - 7
         version: 3.0.7
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: tzinfo
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -83,11 +100,11 @@ dependencies:
         - 27
         version: 0.3.27
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: i18n
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -99,11 +116,11 @@ dependencies:
         - 0
         version: 0.6.0
   type: :runtime
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -115,7 +132,7 @@ dependencies:
         - 0
         version: 2.6.0
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 description: Serve is a small Rack-based web server that makes it easy to serve ERB or HAML from any directory. Serve is an ideal tool for building HTML prototypes of Rails applications. Serve can also handle SASS, Textile, and Markdown if the appropriate gems are installed.
 email: me@johnwlong.com
 executables: 
@@ -137,6 +154,7 @@ files:
 - bin/serve
 - lib/serve.rb
 - lib/serve/application.rb
+- lib/serve/export.rb
 - lib/serve/handlers/dynamic_handler.rb
 - lib/serve/handlers/email_handler.rb
 - lib/serve/handlers/file_type_handler.rb
@@ -145,6 +163,7 @@ files:
 - lib/serve/handlers/sass_handler.rb
 - lib/serve/javascripts.rb
 - lib/serve/out.rb
+- lib/serve/path.rb
 - lib/serve/project.rb
 - lib/serve/rack.rb
 - lib/serve/router.rb
@@ -189,12 +208,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: