serve 1.5.0.pre5 → 1.5.0

data/CHANGELOG.rdoc

@@ -1,7 +1,9 @@
 = Change Log
 
-== edge
-* Make Textile partials work. Closes #29. [rmetzler, jlong]
+== 1.5.0 (July 12, 2011)
+* Integrated bundler into config.ru and added a default Gemfile. [jlong]
+* Added new --template option which allows you to specify a project template when creating a new project. [jlong]
+* Made Textile partials work. Closes #29. [rmetzler, jlong]
 * Fixed problem with export that caused filenames with underscore to be excluded. [bmaland]
 * Updated generated config.ru to require Sass. Closes #20. [jlong]
 * Updated project README and other files to be more friendly to new users [jlong]

data/Gemfile

@@ -25,7 +25,7 @@ group :development do
 end
 
 group :website do
-  gem 'serve',          '~> 1.5.0.pre4'
+  gem 'serve',          :git => 'git://github.com/jlong/serve.git'
   gem 'css_parser',     '~> 1.1.9'
   gem 'maruku',         '~> 0.6.0'
 end

data/Gemfile.lock

@@ -1,3 +1,15 @@
+GIT
+  remote: git://github.com/jlong/serve.git
+  revision: 17f3e31c7ccb9ec75bc8d056d3147731e12655f6
+  specs:
+    serve (1.5.0.pre5)
+      activesupport (~> 3.0)
+      i18n
+      rack (~> 1.2)
+      rack-test (~> 0.5)
+      tilt (~> 1.3)
+      tzinfo
+
 GEM
   remote: http://rubygems.org/
   specs:
@@ -49,13 +61,6 @@ GEM
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
     sass (3.1.4)
-    serve (1.5.0.pre4)
-      activesupport (~> 3.0.7)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-test (~> 0.5.7)
-      tilt (~> 1.3.1)
-      tzinfo (~> 0.3.23)
     slim (0.9.4)
       temple (~> 0.3.0)
       tilt (~> 1.2)
@@ -89,7 +94,7 @@ DEPENDENCIES
   rdoc (~> 3.8.0)
   rspec (~> 2.6.0)
   sass (~> 3.1.1)
-  serve (~> 1.5.0.pre4)
+  serve!
   slim (~> 0.9.4)
   tilt (~> 1.3)
   tzinfo

data/VERSION

@@ -1 +1 @@
-1.5.0.pre5
+1.5.0

data/lib/serve/application.rb

@@ -84,7 +84,7 @@ module Serve
         "Examples:",
         "  #{program}                        # launch server in current directory",
         "  #{program} 2100                   # launch server on port 2100",
-        "  #{program} mockups                # launch server for mockups directory",
+        "  #{program} project                # launch server for project directory",
         "  #{program} create project         # new structured project in project dir",
         "  #{program} convert project        # convert a Compass project in directory",
         "  #{program} export project output  # export project to output directory",
@@ -129,7 +129,9 @@ module Serve
         "   ",
         "Options:",
         "  -j, --javascript  The name of the JavaScript Framework you'd like to use.",
-        "                    (Only valid for create and convert commands.)",
+        "                    (Only for create and convert.)",
+        "  -t, --template    The name of the template project to base the project on.",
+        "                    Builtins: blank, default. (Only for create.)",
         "  -h, --help        Show this message and quit.",
         "  -v, --version     Show the program version number and quit.",
         "  ",
@@ -172,36 +174,51 @@ module Serve
             return File.expand_path(dir)
           end
         end
-        Dir.pwd
+        '.'
       end
       
-      def extract_javascript_framework(args, *opts)
-        framework = nil
+      def extract_arg_and_value(args, opts)
         opts.each do |opt|
-          framework = args.pop if args.delete(opt)
+          index = args.index(opt)
+          next unless index
+          key = args.delete_at(index)
+          value = args[index]
+          if value !~ /^-/
+            args.delete_at(index)
+            return value 
+          end
         end
-        framework
+        nil
+      end
+      
+      def extract_javascript_framework(args)
+        extract_arg_and_value args, %w(-j --javascript)
+      end
+      
+      def extract_template(args)
+        extract_arg_and_value args, %w(-t --template)
       end
       
       def extract_create(args)
         if args.delete('create')
-          framework = extract_javascript_framework(args, '-j', '--javascript')
-          name = args.shift
-          raise InvalidArgumentsError unless name
+          framework = extract_javascript_framework(args)
+          template  = extract_template(args)
+          directory = args.pop || '.'
           {
-           :framework => framework,
-           :name      => name,
-           :directory => (args.last ? File.expand_path(args.shift) : Dir.pwd)
+            :directory => directory,
+            :framework => framework,
+            :template  => template
           }
         end
       end
       
       def extract_convert(args)
         if args.delete('convert')
-          framework = extract_javascript_framework(args, '-j', '--javascript')
+          framework = extract_javascript_framework(args)
+          directory = args.pop || '.'
           {
-           :directory => (args.first ? File.expand_path(args.pop) : Dir.pwd),
-           :framework => framework 
+            :directory => directory,
+            :framework => framework 
           }
         end
       end
@@ -209,7 +226,7 @@ module Serve
       def extract_export(args)
         if args.delete('export')
           input, output = args.shift, args.shift
-          input, output = Dir.pwd, input if output.nil?
+          input, output = '.', input if output.nil?
           output ||= 'html'
           {
             :input => input,

data/lib/serve/{templates → bootstrap}/Gemfile

@@ -3,14 +3,14 @@ source :rubygems
 gem 'serve', '#{Serve.version}'
 
 # Use edge instead:
-# gem 'serve', :get => 'git://github.com/jlong/serve.git'
+# gem 'serve', :git => 'git://github.com/jlong/serve.git'
 
 # Use Compass and Sass
 gem 'compass'
 
 # Markdown and Textile
-# gem 'rdiscount'
-# gem 'RedCloth'
+# gem 'rdiscount' # Markdown
+# gem 'RedCloth'  # Textile
 
 # Other templating languages
 # gem 'erubis'

data/lib/serve/{templates → bootstrap}/config.ru

@@ -1,4 +1,4 @@
-#\\ -p 4000
+#\ -p 4000
 
 require 'rubygems'
 require 'bundler'

data/lib/serve/export.rb

@@ -29,13 +29,13 @@ module Serve
       def collect_files
         if rackified?
           @root = "#{@input}/views"
-          @views = files_from_path("#{@input}/views")
+          @views = glob_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")
+          @public = glob_path("#{@input}/public")
         else
           @root = @input
-          files = files_from_path(@input)
+          files = glob_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
@@ -63,15 +63,6 @@ module Serve
         @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}"
         

data/lib/serve/path.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'fileutils'
 
 module Serve #:nodoc:
   module Path #:nodoc:
@@ -9,5 +10,28 @@ module Serve #:nodoc:
       Pathname.new(File.expand_path(path)).relative_path_from(Pathname.new(Dir.pwd)).to_s
     end
     
+    # Retrieve all files from a path
+    def glob_path(path, directories = false)
+      result = nil
+      
+      FileUtils.cd(path) do
+        # glob files
+        result = Dir.glob("**/*", File::FNM_DOTMATCH)
+        
+        # reject the directories
+        result.reject! { |fn| File.directory?(fn) } unless directories
+        
+        # reject dot files or .empty
+        result.reject! { |fn| %r{(^|/)(\.{1,2}|\.empty)$}.match(fn) }
+        
+        # reject git files (allow .gitignore)
+        result.reject! { |fn| %r{\.git(/|$)}.match(fn) }
+      end
+      
+      result.sort!
+      
+      result
+    end
+    
   end
 end

data/lib/serve/project.rb

@@ -9,13 +9,12 @@ module Serve #:nodoc:
   # Serve::Project.new(options).convert
   #
   class Project #:nodoc:
-    attr_reader :name, :location, :framework
+    attr_reader :location, :framework, :template
     
     def initialize(options)
-      @name       = options[:name]
-      @location   = normalize_location(options[:directory], @name)
-      @full_name  = git_config('user.name') || 'Your Full Name'
+      @location   = normalize_path(options[:directory])
       @framework  = options[:framework]
+      @template   = options[:template] || 'default'
     end
     
     # Create a new Serve project
@@ -27,12 +26,10 @@ module Serve #:nodoc:
         public/stylesheets
         stylesheets
       ).each { |path| make_path path } 
-      create_file 'stylesheets/application.scss',  read_template('application.scss')
-      create_file 'views/_layout.html.erb',        read_template('_layout.html.erb')
-      create_file 'views/hello.html.erb',          read_template('hello.html.erb')
-      create_file 'views/view_helpers.rb',         read_template('view_helpers.rb')
-      create_file 'views/index.redirect',          read_template('index.redirect')
+      copy_project_template @template
       install_javascript_framework @framework
+      copy_readme
+      post_create_message
     end
     
     def self.create(options={})
@@ -44,14 +41,19 @@ module Serve #:nodoc:
       setup_base
       move_file 'images', 'public/'
       move_file 'stylesheets', 'public/'
-      if File.directory? 'javascripts'
+      if File.directory? "#{@location}/javascripts"
         move_file 'javascripts', 'public/'
       else
         make_path 'public/javascripts'
       end
-      move_file 'src', 'stylesheets'
+      if File.directory? "#{@location}/src"
+        move_file 'src', 'stylesheets'
+      elsif File.directory? "#{@location}/sass"
+        move_file 'sass', 'styleheets'
+      end
       install_javascript_framework @framework
-      note_old_compass_config
+      copy_readme
+      post_convert_message
     end
     
     def self.convert(options={})
@@ -66,25 +68,47 @@ module Serve #:nodoc:
       
       # Files required for both a new server project and for an existing compass project.
       def setup_base
+        make_path
         %w(
-          .
           public
           tmp
           views
         ).each { |path| make_path path }
-        create_file 'Gemfile',         read_template('Gemfile')
-        create_file 'config.ru',       read_template('config.ru')
-        create_file '.gitignore',      read_template('gitignore')
-        create_file 'compass.config',  read_template('compass.config')
-        create_file 'README.markdown', read_template('README.markdown')
+        create_file 'Gemfile',         read_bootstrap_file('Gemfile', true)
+        create_file 'config.ru',       read_bootstrap_file('config.ru')
+        create_file '.gitignore',      read_bootstrap_file('gitignore')
+        create_file 'compass.config',  read_bootstrap_file('compass.config')
         create_empty_file 'tmp/restart.txt'
       end
       
+      # Copy files from project template
+      def copy_project_template(name)
+        source = lookup_template_directory(name)
+        raise 'invalid template' unless source
+        
+        files = glob_path(source, true)
+        
+        files.each do |filename|
+          from_path = "#{source}/#{filename}"
+          to_path = "#{@location}/#{filename}"
+          if File.directory? from_path
+            make_path filename
+          else
+            if File.file? to_path
+              log_action "exists", to_path
+            else
+              log_action "create", to_path
+              FileUtils.cp from_path, to_path
+            end
+          end
+        end
+      end
+      
       # Install a JavaScript framework if one was specified
       def install_javascript_framework(framework)
         if framework
           if valid_javascript_framework?(framework)
-            path = normalize_path(@location, "public/javascripts")
+            path = "#{@location}/public/javascripts"
             filename = javascript_filename(framework, path)
             if File.exists? filename
               log_action 'exists', filename
@@ -99,53 +123,70 @@ module Serve #:nodoc:
         end
       end
       
-      # Display note about old compass config if it exists
-      def note_old_compass_config
-        old_config = normalize_path(@location, 'config.rb')
-        if File.exists? old_config
-          puts ""
+      # Copy readme file if not included in template
+      def copy_readme
+        create_file 'README.md', read_bootstrap_file('README.md'), :silent
+      end
+      
+      # Display post create message
+      def post_create_message(action_message = "You created a new Serve project.")
+        puts ""
+        puts "Woohoo! #{action_message}"
+        puts ""
+        puts "A couple of basic files are in place ready for you to edit."
+        puts "Remember to edit the project Gemfile and run:"
+        puts ""
+        puts "    bundle install"
+        puts ""
+        puts "To start serving your project, run:"
+        puts ""
+        puts "    cd \"#{@location}\""
+        puts "    serve"
+        puts ""
+        puts "Then go to http://localhost:4000 in your web browser."
+        puts ""
+        puts "Have fun!"
+        puts ""
+      end
+      
+      # Display post convert message
+      def post_convert_message
+        post_create_message "You converted your Compass project to a Serve project."
+        if File.exists? "#{@location}/config.rb"
           puts "============================================================================"
-          puts " Please Note: You still need to copy your unique settings from config.rb to "
-          puts " compass.config. Remove config.rb when you are finished."
+          puts "Please Note: You still need to copy your unique settings from config.rb to "
+          puts "compass.config. Remove config.rb when you are finished."
           puts "============================================================================"
           puts ""
         end
       end
       
-      # Read and eval a template by name
-      def read_template(name)
-        contents = IO.read(normalize_path(File.dirname(__FILE__), "templates", name))
-        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
+      # Read and optionally eval a bootstrap template by name
+      def read_bootstrap_file(name, eval = false)
+        contents = IO.read(normalize_path(File.dirname(__FILE__), "bootstrap", name))
+        eval ? instance_eval("%{#{contents}}") : contents
       end
       
       # Create a file with contents
-      def create_file(file, contents)
-        path = normalize_path(@location, file)
+      def create_file(file, contents, exists=:noisy)
+        path = "#{@location}/#{file}"
         unless File.exists? path
           log_action "create", path
           File.open(path, 'w+') { |f| f.puts contents }
         else
-          log_action "exists", path
+          log_action "exists", path if exists == :noisy
         end
       end
       
       # Create an empty file
       def create_empty_file(file)
-        path = normalize_path(@location, file)
+        path = "#{@location}/#{file}"
         FileUtils.touch(path)
       end
       
       # Make every directory in a given path
-      def make_path(path)
-        path = normalize_path(@location, path)
+      def make_path(path=nil)
+        path = File.join(*[@location, path].compact)
         unless File.exists? path
           log_action "create", path
           FileUtils.mkdir_p(path)
@@ -156,8 +197,8 @@ module Serve #:nodoc:
       
       # Move a file from => to (relative to the project location)
       def move_file(from, to)
-        from_path = normalize_path(@location, from)
-        to_path = normalize_path(@location, to)
+        from_path = "#{@location}/#{from}"
+        to_path = "#{@location}/#{to}"
         if File.exists? from_path
           to = to + from if to[-1..-1] == "/"
           log_action "move", "#{@location}/{#{from} => #{to}}"
@@ -165,17 +206,19 @@ module Serve #:nodoc:
         end
       end
       
-      # Normalize the path of the target directory
-      def normalize_location(path, name = nil)
-        path = File.join(path, underscore(name)) if name
-        path = normalize_path(path)
-        path
-      end
-      
       # Convert dashes and spaces to underscores
       def underscore(string)
         string.gsub(/-|\s+/, '_')
       end
       
+      def default_templates_directory
+        "#{File.dirname(__FILE__)}/templates"
+      end
+      
+      def lookup_template_directory(name)
+        path = "#{default_templates_directory}/#{name}"
+        path = normalize_path(name) unless File.directory?(path)
+        path if File.directory?(path)
+      end
   end
 end