serve 1.5.0.pre2 → 1.5.0.pre3

data/CHANGELOG.rdoc

@@ -1,6 +1,12 @@
 = Change Log
 
 == edge
+* Make 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]
+* Changed Sass directory name to "stylesheets" to be more consistent with Rails. [jlong]
+* Modified redirects so that only the last line is interpreted as the URL, everything else is ignored. This is useful for adding a comment at the beginning of the file. [jlong]
 * Modified params helper to work with POST params in addition to GET. Closes #19. [jlong]
 * Added an export command which allows you to convert a Serve site to static HTML. Closes #10. [jlong]
 

data/README.rdoc

@@ -1,40 +1,27 @@
 = Serve - A Rapid Prototyping Framework for Web Applications
 
-link:/downloads/jlong/serve/logo-hifi-1.png
+link:../../downloads/jlong/serve/logo-hifi-1.png
 
 Serve is a small Rack-based web server that makes it easy to serve HTML, ERB,
-Haml, or Slim templates from any directory.
+Haml, or a variety of template languages from any directory.
 
 But Serve is much more than a simple web server.
 
-Serve's primary purpose is to provide a rapid prototyping framework for Web
-applications (specifically Rails apps). It is designed to complement web
-application development and enforce a strict separation of concerns between
-designer and developer. Using Serve allows the designer to work in a separate
-prototype project, while the developer can work on the actual application and
-utilize resources from the prototype as needed. This allows the designer to
-focus on presentation and flow, while the developer can focus on
-implementation.
-
-This "Design First" approach can help a designer identify and fix a large
+Serve is meant to be a lightweight version of the Views part of the Rails MVC.
+This makes Serve an ideal framework for prototyping Rails applications or
+creating simple websites. Serve also has full support for Rails-style partials
+and layouts.
+
+If you use a "Design First" approach to Web application development, you may
+find Serve especially useful. Create a separate "prototype" project for your
+application (using Serve) and copy views over into actual application when
+they are ready to go. This workflow can allow the designer to focus on
+presentation and flow, while the developer can focus on implementation. One
+benefit to this approach is that the designer can identify and fix a large
 number of problems before a feature is ever touched by the developer. Once a
 feature has been completed in the prototype project it can also be estimated
 with a high degree of accuracy.
 
-A Serve prototype can work much like the finished application and be virtually
-indistinguishable. The only difference being that state is not saved as a user
-clicks around.
-
-Serve can be used alongside any Web development framework, but Rails
-developers will find it especially familiar. One way of thinking about Serve
-is that it is essentially a Rails application with only one part of the Rails
-MVC stack -- the views. Serve basically allows you to have a separate project
-just for designing the views for the application. When views are ready, they
-can be copied over from the prototype to the application almost as is. This
-process is eased since Serve has full support for partials and layouts with
-either ERB or Haml. Serve can also handle SASS, Slim, Textile, and Markdown
-if the appropriate libraries are installed.
-
 
 == Installation
 
@@ -47,7 +34,7 @@ Some systems, like the Mac, may require that you type:
 
   sudo gem install serve
 
-If you are a Mac user and are new to the command prompt see:
+If you are new to the command prompt and are a Mac user see:
 
 http://wiseheartdesign.com/articles/2010/11/12/the-designers-guide-to-the-osx-command-prompt/
 
@@ -122,9 +109,9 @@ This will create a new project with the following directory structure:
     |    |
     |    `-- javascripts/
     |
-    +-- sass/                  # Store Sass source files here
+    +-- stylesheets/           # Sass and SCSS source files
     |    |
-    |    `-- application.sass  # Example Sass file for application
+    |    `-- application.scss  # Example SCSS file for application
     |
     +-- tmp/                   # Needed for Passenger (mod_passenger)
     |    |
@@ -136,6 +123,8 @@ This will create a new project with the following directory structure:
          |
          +-- hello.html.erb    # Example view
          |
+         +-- index.redirect    # Example redirect
+         |
          `-- view_helpers.rb   # Example view helpers
 
 If you would like to generate the project with a specific JavaScript framework
@@ -282,7 +271,7 @@ slim :: Evaluates the document using the Slim template language (requires the Sl
 sass :: Evaluates the document as Sass (requires the Haml gem)
 scss :: Evaluates the document as SCSS (requires the Haml gem)
 email :: Evaluates the document as if it is an e-mail message; the format is identical to a plain/text e-mail message's source
-redirect :: Redirects to the URL contained in the document
+redirect :: Redirects to the URL contained on the last line of the file
 
 
 == Exporting a Serve Project
@@ -294,26 +283,29 @@ project to HTML. To get started with the prerelease version:
 
 To export your project, use the new "export" command:
 
-  serve export <project_dir>:<output_dir>
+  serve export project:output
 
-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.
+Where "project" is the path to the project and "output" 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.
 
 
+== Mailing List
+
+Have questions? Please don't be ashamed to ask. Post them on the mailing list:
+
+http://groups.google.com/group/serve-users
+
+
 == More Information
 
-You can find more information about Serve, including a detailed Screencast, on
+You can find more information about Serve, including a detailed screencast, on
 the GitHub wiki:
 
 http://wiki.github.com/jlong/serve
 
-Have questions? Feel free to ask them on the mailing list:
-
-http://groups.google.com/group/serve-users
-
 
 == License
 

data/VERSION

@@ -1 +1 @@
-1.5.0.pre2
+1.5.0.pre3

data/lib/serve/export.rb

@@ -41,7 +41,7 @@ module Serve
           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
+        @views.reject! { |v| v =~ /(^_|\/_)/ }           # remove partials
       end
       
       def compile_compass_sass
@@ -100,7 +100,8 @@ module Serve
         
         ensure_path to_path
         
-        url = IO.read(from_path).strip
+        lines = IO.read(from_path).strip.split("\n")
+        url = lines.pop.strip
         contents = %{<html><head><meta http-equiv="refresh" content="0;#{url}" /></head></html>}
         
         File.open(to_path, 'w+') { |f| f.puts contents }

data/lib/serve/handlers/redirect_handler.rb

@@ -3,7 +3,8 @@ module Serve #:nodoc:
     extension 'redirect'
     
     def process(request, response)
-      url = super.strip
+      lines = super.strip.split("\n")
+      url = lines.last.strip
       unless url =~ %r{^\w[\w\d+.-]*:.*}
         url = request.protocol + request.host_with_port + url
       end

data/lib/serve/project.rb

@@ -25,13 +25,13 @@ module Serve #:nodoc:
         public/images
         public/javascripts
         public/stylesheets
-        sass
+        stylesheets
       ).each { |path| make_path path } 
-      create_file 'sass/application.sass',  read_template('application.sass')
-      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')
+      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')
       install_javascript_framework @framework
     end
     
@@ -49,7 +49,7 @@ module Serve #:nodoc:
       else
         make_path 'public/javascripts'
       end
-      move_file 'src', 'sass'
+      move_file 'src', 'stylesheets'
       install_javascript_framework @framework
       note_old_compass_config
     end
@@ -73,7 +73,6 @@ module Serve #:nodoc:
           views
         ).each { |path| make_path path }
         create_file 'config.ru',       read_template('config.ru')
-        create_file 'LICENSE',         read_template('license')
         create_file '.gitignore',      read_template('gitignore')
         create_file 'compass.config',  read_template('compass.config')
         create_file 'README.markdown', read_template('README.markdown')

data/lib/serve/templates/README.markdown

@@ -4,20 +4,21 @@ What is this?
 This is a simple HTML prototype written in HAML or ERB that is designed to be
 viewed with Serve.
 
-What is Serve? Serve is a rapid prototyping framework for Rails applications.
-It is designed to compliment Rails development and enforce a strict separation
-of concerns between designer and developer. Using Serve with Rails allows the
-designer to happily work in his own space creating an HTML prototype of the
-application, while the developer works on the Rails application and copies
-over HTML from the prototype as needed. This allows the designer to focus on
-presentation and flow while the developer can focus on the implementation.
+What is Serve? Serve is an open-source rapid prototyping framework for Web
+applications. It makes it easy to prototype functionality without writing a
+single line of backend code.
 
 
 How do I install and run Serve?
 -------------------------------
 
-Serve is distributed as a gem to make it easy to get up and running. To
-install, type the following at the command prompt:
+Serve is distributed as a Ruby gem to make it easy to get up and running. You
+must have Ruby installed in order to download and use Serve. The Ruby download
+page provides instructions for getting Ruby setup on different platforms:
+
+<http://www.ruby-lang.org/en/downloads/>
+
+After you have Ruby installed, open up the command prompt and type:
 
     gem install serve
 
@@ -32,15 +33,55 @@ Web browser at this URL:
 
 <http://localhost:4000>
 
-Click around. You will find that Serve enables you to prototype most
-functionality without writing a single line of backend code.
+
+Compass and Sass
+----------------
+
+This prototype uses Compass and Sass to generate CSS. Both are distributed as
+Ruby gems and can be easily installed from the command prompt. Since the
+Compass gem depends on Sass, you can install them both with one command:
+
+    gem install compass
+
+Learn more about Sass:
+
+<http://sass-lang.org>
+
+Learn more about Compass:
+
+<http://compass-style.org>
 
 
 Rack and Passenger
 ------------------
 
 Astute users may notice that this project is also a simple Rack application.
-This means that it is easy to deploy it on Passenger or rack it up with the
-`rackup` command. For more information about using Serve and Passenger see:
+This means that it is easy to deploy it on Passenger or in any other
+Rack-friendly environment. Rack it up with the `rackup` command. For more
+information about using Serve and Passenger see:
+
+<http://bit.ly/serve-and-passenger>
+
+
+Exporting
+---------
+
+To export this project to pure HTML and CSS you will need the prerelease
+version of Serve. To get started with the prerelease version:
+
+    gem install --pre serve
+
+To export your project, use the new "export" command:
+
+    serve export <project>:<output>
+
+Where "project" is the path to the project and "output" is the path to the
+directory where you would like your HTML and CSS generated.
+
+
+Learning More
+-------------
+
+You can learn more about Serve on the GitHub project page:
 
-<http://bit.ly/serve-and-passenger>
+<http://github.com/jlong/serve>

data/lib/serve/templates/application.scss

@@ -0,0 +1,18 @@
+//
+// Application Stylesheet
+//
+
+@import "compass";
+
+@include global-reset;
+
+body {
+  font-size: 90%;
+  padding: 20px;
+}
+
+h1 {
+  font-family: "Trebuchet MS", Helvetica, Arial, sans-serif;
+  font-size: 260%;
+  font-weight: bold;
+}

data/lib/serve/templates/compass.config

@@ -9,7 +9,7 @@ http_images_path      = '/images'
 http_javascripts_path = '/javascripts'
 
 # File system locations
-sass_dir              = 'sass'
+sass_dir              = 'stylesheets'
 css_dir               = 'public/stylesheets'
 images_dir            = 'public/images'
 javascripts_dir       = 'public/javascripts'

data/lib/serve/templates/config.ru

@@ -1,6 +1,5 @@
 #\\ -p 4000
 
-gem 'activesupport'
 gem 'serve'
 
 require 'serve'
@@ -13,6 +12,7 @@ root = ::File.dirname(__FILE__)
 # don't allow you to write to the file system on the fly (like Heroku).
 # Remove this conditional if you want to compile Sass in production.
 if ENV['RACK_ENV'] != 'production'
+  require 'sass'
   require 'sass/plugin/rack'
   require 'compass'
   

data/lib/serve/templates/index.redirect

@@ -1 +1,15 @@
+Serve has a special file type for mapping HTTP redirects. Redirects make nice
+end points for form posts or short URLs.
+
+Redirect URLs can be fully formed, like this:
+
+http://wiseheartdesign.com/
+
+Or, relative to the site root, like this:
+
+/action
+
+Extra lines at the beginning of a redirect file are ignored. By convention,
+the last line of a redirect file is the URL to redirect to:
+
 /hello

data/lib/serve/templates/view_helpers.rb

@@ -1,5 +1,34 @@
+#
+# Place methods here that you want available to you in your views.
+# View helpers allow you keep templates clean.
+#
 module ViewHelpers
+  
+  # Example helper method
   def hello(name)
     "Hello \#{name}!"
   end
+  
+  # Handy for hiding a block of unfinished code
+  def hidden(&block)
+    #no-op
+  end
+  
+  # Shorthand for referencing images in the images folder
+  def image(name, options = {})
+    path = "/images/\#{name}"
+    path += ".png" unless path.match(/\.[A-za-z]{3,4}$/)
+    image_tag(name, {:alt => ""}.update(options))
+  end
+  
+  # Calculate the years for a copyright
+  def copyright_years(start_year)
+    end_year = Date.today.year
+    if start_year == end_year
+      "\#{start_year}"
+    else
+      "\#{start_year}–\#{end_year}"
+    end
+  end
+  
 end

data/lib/serve/view_helpers.rb

@@ -140,7 +140,7 @@ module Serve #:nodoc:
         template = template[1..-1]
         path = @root_path
       end
-      filename = template_filename(File.join(path, template), :partial => options.delete(:partial))
+      filename = template_filename(File.join(path, template), :partial => options[:partial])
       if File.file?(filename)
         parser.parse_file(filename, options[:locals])
       else
@@ -153,15 +153,16 @@ module Serve #:nodoc:
       def template_filename(name, options)
         path = File.dirname(name)
         template = File.basename(name)
-        template = "_" + template if options.delete(:partial)
-        template += extname(parser.script_filename) unless name =~ /\.[a-z]{3,4}$/
+        template = "_" + template if options[:partial]
+        template += extname(parser.script_filename) unless name =~ /\.[a-z]+$/
         File.join(path, template)
       end
       
       def extname(filename)
-        /(\.[a-z]{3,4}\.[a-z]{3,4})$/.match(filename)
+        /(\.[a-z]+\.[a-z]+)$/.match(filename)
         $1 || File.extname(filename) || ''
       end
+      
   end
   
   module TagHelpers

data/spec/application_spec.rb

@@ -9,11 +9,14 @@ describe Serve::Application do
       :help         => false,
       :version      => false,
       :environment  => 'development',
+      
       :port         => 4000,
       :address      => '0.0.0.0',
       :root         => Dir.pwd,
+      
       :convert      => nil,
-      :create       => nil
+      :create       => nil,
+      :export       => nil
     }
   end
   

data/spec/project_spec.rb

@@ -13,6 +13,9 @@ describe Serve::Project do
     
     before(:all) do
       @options = {
+        :port         => 4000,
+        :address      => '0.0.0.0',
+        
         :name       => 'test_mockup',
         :directory  => File.dirname(__FILE__),
         :framework  => 'jquery'
@@ -67,7 +70,7 @@ describe Serve::Project do
       end
       
       it "should have a sass directory" do
-        File.exists?(File.join(@mockup_file, 'sass')).should be_true
+        File.exists?(File.join(@mockup_file, 'stylesheets')).should be_true
       end
       
       it "should have a tmp directory" do
@@ -86,10 +89,6 @@ describe Serve::Project do
         File.exists?(File.join(@mockup_file, 'compass.config')).should be_true
       end
       
-      it "should have a LICENSE file" do
-        File.exists?(File.join(@mockup_file, 'LICENSE')).should be_true
-      end
-      
       it "should have a dot gitignore file" do
         File.exists?(File.join(@mockup_file, '.gitignore')).should be_true
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: serve
 version: !ruby/object:Gem::Version 
-  hash: -1876988199
+  hash: -1876988218
   prerelease: true
   segments: 
   - 1
   - 5
   - 0
-  - pre2
-  version: 1.5.0.pre2
+  - pre3
+  version: 1.5.0.pre3
 platform: ruby
 authors: 
 - John W. Long
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-08 00:00:00 -04:00
+date: 2011-06-22 00:00:00 -04:00
 default_executable: serve
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -167,10 +167,9 @@ files:
 - lib/serve/project.rb
 - lib/serve/rack.rb
 - lib/serve/router.rb
-- lib/serve/templates/LICENSE
 - lib/serve/templates/README.markdown
 - lib/serve/templates/_layout.html.erb
-- lib/serve/templates/application.sass
+- lib/serve/templates/application.scss
 - lib/serve/templates/compass.config
 - lib/serve/templates/config.ru
 - lib/serve/templates/gitignore

data/lib/serve/templates/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) #{Time.now.year} #{@full_name}
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/serve/templates/application.sass

@@ -1,12 +0,0 @@
-@import "compass"
-
-+global-reset
-
-body
-  font-size: 90%
-  padding: 20px
-
-h1
-  font-family: "Trebuchet MS", Helvetica, Arial, sans-serif
-  font-size: 260%
-  font-weight: bold