serve 0.11.7 → 1.0.0

data/lib/serve/javascripts.rb

@@ -0,0 +1,62 @@
+require 'fileutils'
+require 'open-uri'
+
+module Serve
+  module JavaScripts
+    
+    # JavaScript Versions
+    GOOGLE_AJAX_APIS      = 'http://ajax.googleapis.com/ajax/libs'
+    JQUERY_VERSION        = '1' # the latest stable version of 1.x.x
+    JQUERY_UI_VERSION     = '1'
+    PROTOTYPE_VERSION     = '1'
+    SCRIPTACULOUS_VERSION = '1'
+    MOOTOOLS_VERSION      = '1'
+    
+    JAVASCRIPT_FRAMEWORKS = %w(jquery jquery-ui mootools prototype scriptaculous)
+    
+    def fetch_javascript(framework, download_path)
+      filename = javascript_filename(framework, download_path)
+      framework_url = javascript_framework_url(framework)
+      lines = open(framework_url) { |io| io.read }
+      open(filename, "w+") { |io| io.write(lines) }
+    end
+    
+    def supported_javascript_frameworks
+      JAVASCRIPT_FRAMEWORKS
+    end
+    
+    def valid_javascript_framework?(framework)
+      framework = framework.downcase
+      JAVASCRIPT_FRAMEWORKS.include?(framework)
+    end
+    
+    def javascript_filename(framework, path)
+      File.join(path, "#{framework}.js")
+    end
+    
+    def javascript_framework_url(framework)
+      self.send(framework.tr('-', '_') + "_url")
+    end
+    
+    def jquery_url
+      "#{GOOGLE_AJAX_APIS}/jquery/#{JQUERY_VERSION}/jquery.min.js"
+    end
+    
+    def jquery_ui_url
+      "#{GOOGLE_AJAX_APIS}/jqueryui/#{JQUERY_UI_VERSION}/jquery-ui.min.js"
+    end
+    
+    def mootools_url
+      "#{GOOGLE_AJAX_APIS}/mootools/#{MOOTOOLS_VERSION}/mootools-yui-compressed.js"
+    end
+    
+    def prototype_url
+      "#{GOOGLE_AJAX_APIS}/prototype/#{PROTOTYPE_VERSION}/prototype.js"
+    end
+    
+    def scriptaculous_url
+      "#{GOOGLE_AJAX_APIS}/scriptaculous/#{SCRIPTACULOUS_VERSION}/scriptaculous.js"
+    end
+     
+  end
+end

data/lib/serve/out.rb

@@ -0,0 +1,38 @@
+module Serve #:nodoc:
+  
+  # Utility methods for handling output to the terminal
+  module Out #:nodoc:
+    
+    def stdout
+      @stdout ||= $stdout
+    end
+    
+    def stdout=(value)
+      @stdout = value
+    end
+    
+    def stderr
+      @stderr ||= $stderr
+    end
+    
+    def stderr=(value)
+      @stderr = value
+    end
+    
+    def puts(*args)
+      stdout.puts(*args)
+    end
+    
+    def print(*args)
+      stderr.print(*args)
+    end
+    
+    def log_action(name, message)
+      print " " * (12 - name.length)
+      print name
+      print "  "
+      puts message
+    end
+    
+  end
+end

data/lib/serve/project.rb

@@ -0,0 +1,176 @@
+require 'pathname'
+require 'serve/out'
+require 'serve/javascripts'
+
+module Serve #:nodoc:
+  #
+  # Serve::Project.new(options).create
+  # Serve::Project.new(options).convert
+  #
+  class Project #:nodoc:
+    attr_reader :name, :location, :framework
+    
+    def initialize(options)
+      @name       = options[:name]
+      @location   = normalize_location(options[:directory], @name)
+      @full_name  = git_config('user.name') || 'Your Full Name'
+      @framework  = options[:framework]
+    end
+    
+    # Create a new Serve project
+    def create
+      setup_base
+      %w(
+        public/images
+        public/javascripts
+        public/stylesheets
+        sass
+      ).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')
+      install_javascript_framework @framework
+    end
+    
+    # Convert an existing Compass project to a Serve project
+    def convert
+      setup_base
+      move_file 'images', 'public/'
+      move_file 'stylesheets', 'public/'
+      if File.directory? 'javascripts'
+        move_file 'javascripts', 'public/'
+      else
+        make_path 'public/javascripts'
+      end
+      move_file 'src', 'sass'
+      install_javascript_framework @framework
+      note_old_compass_config
+    end
+    
+    private
+      
+      include Serve::Out
+      
+      include Serve::JavaScripts
+      
+      # Files required for both a new server project and for an existing compass project.
+      def setup_base
+        %w(
+          .
+          public
+          tmp
+          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')
+        create_empty_file 'tmp/restart.txt'
+      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")
+            filename = javascript_filename(framework, path)
+            if File.exists? filename
+              log_action 'exists', filename
+            else
+              log_action 'install', filename
+              fetch_javascript framework, path
+            end
+          else
+            puts "*** #{framework} javascript framework not supported. ***"
+            puts "Supported frameworks: #{ supported_javascript_frameworks.join(', ') }"
+          end
+        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 ""
+          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 "============================================================================"
+          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
+      
+      # Create a file with contents
+      def create_file(file, contents)
+        path = normalize_path(@location, file)
+        unless File.exists? path
+          log_action "create", path
+          File.open(path, 'w+') { |f| f.puts contents }
+        else
+          log_action "exists", path
+        end
+      end
+      
+      # Create an empty file
+      def create_empty_file(file)
+        path = normalize_path(@location, file)
+        FileUtils.touch(path)
+      end
+      
+      # Make every directory in a given path
+      def make_path(path)
+        path = normalize_path(@location, path)
+        unless File.exists? path
+          log_action "create", path
+          FileUtils.mkdir_p(path)
+        else
+          log_action "exists", path
+        end
+      end
+      
+      # 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)
+        if File.exists? from_path
+          to = to + from if to[-1..-1] == "/"
+          log_action "move", "#{@location}/{#{from} => #{to}}"
+          FileUtils.mv from_path, to_path
+        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
+      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
+      
+      # 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/templates/LICENSE

@@ -0,0 +1,20 @@
+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/README.markdown

@@ -0,0 +1,46 @@
+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.
+
+
+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:
+
+    gem install serve
+
+(OSX and Unix users may need to prefix the command with `sudo`.)
+
+After Serve is installed, you can start it up in a given directory like this:
+
+    serve
+
+This will start Serve on port 4000. You can now view the prototype in your
+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.
+
+
+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:
+
+<http://bit.ly/serve-and-passenger>

data/lib/serve/templates/_layout.html.erb

@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title><%= @title %></title>
+    <link rel="stylesheet" href="/stylesheets/application.css" />
+  </head>
+  <body>
+  <%= yield %>
+  </body>
+</html>

data/lib/serve/templates/application.sass

@@ -0,0 +1,12 @@
+@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

data/lib/serve/templates/compass.config

@@ -0,0 +1,28 @@
+#
+# Compass Configuration
+#
+
+# HTTP paths
+http_path             = '/'
+http_stylesheets_path = '/stylesheets'
+http_images_path      = '/images'
+http_javascripts_path = '/javascripts'
+
+# File system locations
+sass_dir              = 'sass'
+css_dir               = 'public/stylesheets'
+images_dir            = 'public/images'
+javascripts_dir       = 'public/javascripts'
+
+# Set to true for easier debugging
+line_comments         = false
+
+# CSS output style - :nested, :expanded, :compact, or :compressed
+output_style          = :expanded
+
+# Determine whether Compass asset helper functions generate relative
+# or absolute paths
+relative_assets       = true
+
+# Learn more:
+#   http://compass-style.org/docs/tutorials/configuration-reference/

data/lib/serve/templates/config.ru

@@ -0,0 +1,35 @@
+#\\ -p 4000
+
+gem 'activesupport'
+gem 'serve'
+
+require 'serve'
+require 'serve/rack'
+
+require 'sass/plugin/rack'
+require 'compass'
+
+# The project root directory
+root = ::File.dirname(__FILE__)
+
+# Compass
+Compass.add_project_configuration(root + '/compass.config')
+Compass.configure_sass_plugin!
+
+# Rack Middleware
+use Rack::ShowStatus      # Nice looking 404s and other messages
+use Rack::ShowExceptions  # Nice looking errors
+use Sass::Plugin::Rack    # Compile Sass on the fly
+
+# Rack Application
+if ENV['SERVER_SOFTWARE'] =~ /passenger/i
+  # Passendger only needs the adapter
+  run Serve::RackAdapter.new(root + '/views')
+else
+  # We use Rack::Cascade and Rack::Directory on other platforms to handle static 
+  # assets
+  run Rack::Cascade.new([
+    Serve::RackAdapter.new(root + '/views'),
+    Rack::Directory.new(root + '/public')
+  ])
+end

data/lib/serve/templates/gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.gem
+.rvmrc
+.bundle