blossom 0.0.12 → 0.1.0

data/bin/blossom

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
 
-require 'fileutils'
-require "#{File.dirname(__FILE__)}/../lib/blossom"
+BLOSSOM_HOME = File.join(File.dirname(__FILE__), "..")
+
+require "fileutils"
+require "#{BLOSSOM_HOME}/lib/blossom"
 
 include FileUtils
 
@@ -9,83 +11,178 @@ def make_file(name, content)
   File.open(name, "w") { |file| file.write(content) }
 end
 
-def print_usage
-  warn "Usage: #$0 PROJECT-NAME"
+def copy_file(name, destination)
+  FileUtils.cp "#{BLOSSOM_HOME}/#{name}", "#{destination}/#{name}"
+end
+
+def usage
+  "Usage: #$0 PROJECT-NAME"
+end
+
+def die(message)
+  error message
+  exit 1
+end
+
+def error(message)
+  warn "Blossom: Error: #{message}"
+end
+
+def run(command)
+  puts "$ #{command}"
+  system command or die "Command failed: #{command}"
 end
 
 if ARGV.empty?
-  print_usage
+  puts usage
 elsif ARGV[0].start_with? "-"
   case ARGV[0]
   when "--version", "-v"
     puts Blossom::VERSION
   when "--help", "-h", "-?"
-    print_usage
+    puts usage
   else
-    warn "#$0: unrecognized option: #{ARGV[0]}"
+    error "Unrecognized option: #{ARGV[0]}"
+    warn usage
+    exit 1
   end
 else
   name = ARGV.first
   name_symbol = name =~ /\W|^\d/ ? ":'#{name}'" : ":#{name}"
-  unless File.exist? name
-    mkdir name
-    cd name
+  name_pretty = name.capitalize.gsub(/[-_]/, " ")
+
+  if File.exist? name
+    die "File already exists: #{name}"
+  else
+    puts "Blossom creating project: #{name}"
+
+    puts "$ mkdir #{name}; cd #{name}"
+    mkdir name; cd name
+
+    puts "Installing Blossom boilerplate."
+
+    make_file "#{name}.blossom", <<"^D"
+## This is the Blossom configuration file.
+##
+## All settings are listed here with their default values.
+## To change a setting, you have to uncomment the line first.
+
+## The directory in which to put arbitrary public files:
+# Public-Directory: public
+
+## Files with these extensions are always public:
+# Public-Extensions: js css html png jpg
+
+## The maximum amount of time browsers may cache the site:
+# Max-Cache-Time: 1 day
+
+## Whether or not to remove the "www." part of the domain:
+# Remove-WWW-From-Domain: yes
+^D
 
     make_file ".gitignore", "tmp\n"
 
-    make_file "config.ru", <<-"end_file"
+    make_file "config.ru", <<"^D"
 require "rubygems"
 require "bundler/setup"
 require "blossom"
 
-run Blossom(__FILE__, #{name_symbol}, :cache => [1, :day])
-    end_file
+run Blossom __FILE__
+^D
 
-    make_file "Gemfile", <<-"end_file"
+    make_file "Gemfile", <<"^D"
 source :rubygems
 
-gem 'blossom', '~> #{Blossom::VERSION}'
-    end_file
+gem "blossom", "~> #{Blossom::VERSION}"
+
+# Uncomment the following if you want to use CoffeeScript.
+# (See further instructions in #{name}.js.)
+#
+# gem "rack-coffee"
+^D
 
-    make_file "#{name}.haml", <<-"end_file"
+    mkdir "public"
+
+    make_file "#{name}.haml", <<"^D"
 !!!
 %html
   %head
     %meta(charset="utf-8")
-    %title #{name.capitalize}
-    %meta(name="description" content="Description of #{name.capitalize}.")
+    %title [insert title here]
+    %meta(name="description" content="[insert description here]")
     %link(rel="stylesheet" href="#{name}.css")
+    %script(src="#{name}.js")
+    /[if lt IE 9]
+      %script(src="//html5shiv.googlecode.com/svn/trunk/html5.js")
   %body
-    %h1 This is <tt>#{name}.haml</tt>.
-    end_file
+    %h1 #{name}.haml
+^D
 
-    make_file "#{name}.sass", <<-"end_file"
+    make_file "#{name}.sass", <<"^D"
 @import compass/reset
-
-body
-  width: 600px
-  margin: auto
+@import compass/utilities
+@import compass/css3
 
 h1
-  font: 200 40px "Helvetica Neue", Helvetica
-  margin-top: 80px
-    end_file
+  font: 48px monospace
+  margin-top: 1em
+  text-align: center
+^D
+
+    make_file "#{name}.sinatra.rb", <<"^D"
+# Put any custom Sinatra routes or configuration here.
+# See <http://www.sinatrarb.com/documentation> for help.
+
+# This is also where you insert middleware (just remember to add
+# any new dependencies to your Gemfile and to run \`bundle\'):
+#
+# require "some/middleware"
+# use Some::Middleware
+
+# get "/hello" do
+#   "Hello World"
+# end
+^D
+
+    make_file "#{name}.js", <<"^D"
+// If you do not want to use CoffeeScript, you can delete this comment.
+// If you do, first install the CoffeeScript compiler and Rack::Coffee:
+//
+//    $ npm install -g coffee-script
+//    $ sudo gem install rack-coffee
+//    $ echo 'gem "rack-coffee"' >> Gemfile
+//    $ bundle
+//
+// Then simply delete this file and create #{name}.coffee instead.
+^D
+
+    run "bundle --local"
+    run "git init"
+    run "git add -A"
+    run "git commit -m 'Create project.'"
+    
+    puts <<"^D"
 
-    mkdir "static"
+Application created!  Now type \`cd #{name}\' and then \`rackup\'.
+This will run your application at <http://localhost:9292/>.
 
-    %x{git init && git add -A && git commit -m 'Create project.'}
-    
-    print "\
-Application created!  Now type \`cd #{name}\' and then \`rackup\'.\n\
-This will run your application at <http://localhost:9292/>.\n\
-You can start hacking in \`#{name}.haml\' and \`#{name}.sass\'.\n\
-If you create \`x.haml\', it will show up at <http://localhost:9292/x>.\n\
-Images and other static files go in the \`static/\' directory.\n\
-In production, your pages are cached; configure this in \`config.ru\'.
-Good luck, have fun!\n\
-"
-  else
-    warn "#$0: error: file already exists: #{name}"
-    exit -1
+Start hacking in \`#{name}.haml\' and \`#{name}.sass\'.  If you
+create \`x.haml\', it will show up at <http://localhost:9292/x>.
+
+Public files go in the \`public/\' directory, but you can put images
+and Javascript files directly in the root directory if you want.
+This (and other things) can be configured in \`#{name}.blossom\'.
+
+Put any custom middleware or Sinatra code in \`#{name}.sinatra.rb\',
+but remember to restart your application after changing this file.
+
+If you restart your application a lot, there is a drop-in replacement
+for rackup called Shotgun <https://github.com/rtomayko/shotgun>:
+
+   $ sudo gem install shotgun
+   $ shotgun # Like rackup, except with automatic reloading.
+
+Good luck and have fun! :-)
+^D
   end
 end

data/lib/blossom.rb

@@ -1,115 +1,289 @@
-require "rubygems"
+require "blossom/version"
 
-require "compass" # Load before sinatra.
+require "sass"
+require "compass"
+
+require "haml"
+require "rack"
+require "rack/normalize-domain"
 require "sinatra/base"
-require "haml" # Load after sinatra.
-require "rack/strip-www"
-require "hassle"
+require "yaml"
 
-module Blossom
-  VERSION = "0.0.12"
+begin
+  require "rack/coffee"
+rescue LoadError
 end
 
-def Blossom.get_seconds(value, unit)
-  days = 60 * 60 * 24
-  case unit
-  when :seconds, :second
-    value
-  when :minutes, :minute
-    value * 60
-  when :hours, :hour
-    value * 60 * 60
-  when :days, :day
-    value * days
-  when :weeks, :week
-    value * days * 7
-  when :months, :month
-    value * days * 30
-  when :years, :year
-    value * days * 365
-  else
-    raise ArgumentError, "Unrecognized unit: #{unit}"
+module Blossom
+  def self.fail(message)
+    info "Error: #{message}"
+    exit 1
   end
-end
 
-def Blossom(root_file, index = :index, options = {})
-  Rack::Builder.app do
-    cache = options[:cache]
-    use Hassle
-    use Rack::StripWWW unless options[:strip_www?] == false
-    defined? Rack::Coffee and use Rack::Coffee,
-      :static => false,
-      :urls => "/",
-      :cache => !!cache,
-      :ttl => cache && Blossom.get_seconds(*cache)
-    run Blossom::Base(root_file, index, options)
+  def self.info(message)
+    Kernel.warn "[Blossom] #{message}"
   end
 end
 
-def Blossom.Base(root_file, index = :index, blossom_options = {})
-  root = File.dirname(root_file)
-  Class.new(Sinatra::Base).tap do |app|
-    app.class_eval do
-      extend Blossom::Helpers
-
-      configure do
-        set :root, root
-        set :public, "#{root}/static"
-        set :views, root
-        set :index, index
-        set :haml, { :format => :html5, :attr_wrapper => '"' }
-    
-        Compass.configuration.project_path = root
-        Compass.configuration.sass_dir = ""
-        Compass.configuration.images_dir = "static"
-        Compass.configuration.http_images_path = "/"
-        Compass.configuration.output_style = :compact
-        Compass.configuration.line_comments = false
-        
-        sass_options = Compass.sass_engine_options.merge \
-          :cache_location => "#{root}/tmp/sass-cache"
-        
-        set :sass, sass_options
-      end
-    
-      get "/" do
-        headers blossom_headers
-        haml settings.index
+def Blossom(root_filename)
+  Blossom::Application.new(File.dirname(root_filename))
+end
+
+class Blossom::Application < Rack::Builder
+  def initialize(root)
+    super()
+
+    @root = root
+
+    determine_name!
+    load_configuration!
+    configure!
+    build_rack!
+  end
+
+  # --------------------------------------------------------
+
+  def compass_options
+    return \
+      :cache_dir         => "tmp/sass-cache",
+      :http_images_path  => "/",
+      :images_dir        => @config.public_directory,
+      :line_comments     => false,
+      :output_style      => :compact,
+      :project_path      => @root,
+      :sass_dir          => ""
+  end
+
+  def coffee_options
+    return \
+      :cache   => @config.cache_content?,
+      :static  => false,
+      :ttl     => @config.content_max_age,
+      :urls    => "/"
+  end
+
+  def haml_options
+    return \
+      :format        => :html5,
+      :attr_wrapper  => '"'
+  end
+
+  def sass_options
+    Compass.sass_engine_options
+  end
+
+  # --------------------------------------------------------
+
+  def determine_name!
+    names = glob("*.blossom")
+    case names.size
+    when 0
+      Blossom.fail "Missing configuration file: NAME.blossom"
+    when 1
+      @name = names[0].sub(/\.blossom$/, '')
+    else
+      Blossom.fail "Multiple configuration files: #{names * ', '}"
+    end
+  end
+
+  def load_configuration!
+    @config = Configuration.new(configuration_hash)
+  end
+
+  def configuration_hash
+    case result = YAML.load_file(configuration_filename)
+    when false then {} # Empty file.
+    when Hash then result
+    else Blossom.fail "Bad configuration file: #{configuration_filename}"
+    end
+  rescue Errno::ENOENT
+    {}
+  end
+
+  # --------------------------------------------------------
+
+  def configuration_filename
+    filename("#@name.blossom") end
+  def sinatra_code_filename
+    filename("#@name.sinatra.rb") end
+  def public_dirname
+    filename(@config.public_directory) end
+
+  def glob(glob)
+    Dir[filename(glob)].map { |name| File.basename(name) } end
+  def filename(*components)
+    File.join(@root, *components) end
+
+  # --------------------------------------------------------
+
+  def configure!
+    compass_options.each do |key, value|
+      Compass.configuration.send("#{key}=", value)
+    end
+
+    Compass.configure_sass_plugin!
+  end
+
+  def build_rack!
+    use_rack_normalize_domain!
+    use_rack_coffee!
+    run sinatra_app
+  end
+
+  def use_rack_normalize_domain!
+    if @config.strip_www?
+      use Rack::NormalizeDomain
+      Blossom.info "Normalizing domains by removing initial www."
+    else
+      Blossom.info "Not normalizing domains."
+    end
+  end
+
+  def use_rack_coffee!
+    if defined? Rack::Coffee
+      use Rack::Coffee, coffee_options
+      Blossom.info "Using CoffeeScript."
+    else
+      Blossom.info "Not using CoffeeScript."
+    end
+  end
+
+  def sinatra_app
+    app = Sinatra.new
+    app.set :blossom, self
+
+    app.set :root, @root
+    app.set :index, @name.to_sym
+
+    app.set :views, @root
+    app.set :public, public_dirname
+
+    app.set :haml, haml_options
+    app.set :sass, sass_options
+
+    if custom_sinatra_code
+      app.class_eval(custom_sinatra_code)
+    end
+
+    # Need variable here for lexical scoping.
+    max_age = @config.max_age
+    app.before { cache_control :max_age => max_age }
+
+    app.register do
+      def path_exists? suffix
+        condition do
+          basename = File.basename(request.path_info)
+          File.exist? File.join(settings.root, "#{basename}.#{suffix}")
+        end
       end
   
-      get "/:name.css", :file_exists? => :sass do
-        headers blossom_headers
-        content_type "text/css", :charset => "utf-8"
-        sass params[:name].to_sym
+      def file_exists? suffix
+        condition do
+          basename = File.basename(request.path_info)
+          barename = basename.sub(/\.[^.]*$/, '')
+          File.exist? File.join(settings.root, "#{barename}.#{suffix}")
+        end
+      end
+    end
+
+    @config.public_extensions.each do |extension|
+      app.get "/:name.#{extension}", :file_exists? => extension do
+        send_file "#{params[:name]}.#{extension}"
       end
+    end
+
+    app.get "/:name.css", :file_exists? => :sass do
+      content_type :css
+      sass params[:name].to_sym
+    end
   
-      get "/:name", :file_exists? => :haml do
-        headers blossom_headers
-        haml params[:name].to_sym
+    app.get "/:name", :path_exists? => :haml do
+      haml params[:name].to_sym
+    end
+
+    app.get "/" do
+      haml settings.index
+    end
+
+    app
+  end
+
+  def custom_sinatra_code
+    File.read(sinatra_code_filename) rescue nil
+  end
+
+  # --------------------------------------------------------
+
+  class Configuration < Struct.new(:user_data)
+    DEFAULTS = YAML.load <<"^D"
+Public-Directory: public
+Public-Extensions: js css html png jpg
+Max-Cache-Time: 1 day
+Remove-WWW-From-Domain: yes
+^D
+
+    def public_directory
+      get("Public-Directory").string end
+    def strip_www?
+      get("Remove-WWW-From-Domain").boolean end
+    def max_age
+      get("Max-Cache-Time").duration end
+    def public_extensions
+      get("Public-Extensions").words end
+
+  private
+
+    def get(name)
+      if user_data.include? name
+        Value.new(user_data[name])
+      else
+        Value.new(DEFAULTS[name])
+      end
+    end
+
+    class Value < Struct.new(:value)
+      def string
+        value.to_s
+      end
+
+      def words
+        value.gsub(/^\s+|\s$/, "").split(/\s+/)
+      end
+
+      def boolean
+        if value == true or value == false
+          value
+        else
+          fail "Must be \`yes' or \`no\': #{name}"
+        end
       end
-      
-      define_method :blossom_headers do
-        if blossom_options.include? :cache
-          seconds = Blossom.get_seconds(*blossom_options[:cache])
-          { 'Cache-Control' => "max-age=#{seconds}" }
+
+      def duration
+        if value =~ /^((?:\d+\.)?\d+) ([a-z]+?)s?$/
+          $1.to_f * time_unit($2.to_sym)
         else
-          {}
+          error "Bad duration: #{value}"
         end
       end
-    end
 
-    code = File.read("#{root}/#{index}.rb") rescue nil
-    app.class_eval(code) if code
-  end
-end
+    private
+
+      def fail(message)
+        Blossom.fail "Configuration: #{value}: #{message}"
+      end
 
-module Blossom::Helpers
-  def file_exists? suffix
-    condition do
-      basename = File.basename(request.path)
-      barename = basename.sub(/\.[^.]*$/, '')
-      name = "#{barename}.#{suffix}"
-      File.exist? File.join(settings.root, name)
+      def time_unit(name)
+        case name
+        when :second then 1
+        when :minute then 60
+        when :hour then 60 * 60
+        when :day then 24 * time_unit(:hour)
+        when :week then 7 * time_unit(:day)
+        when :month then 30 * time_unit(:day)
+        when :year then 365 * time_unit(:day)
+        else fail "Unknown time unit: #{name}"
+        end
+      end
     end
   end
 end

data/lib/blossom/version.rb

@@ -0,0 +1,3 @@
+module Blossom
+  VERSION = "0.1.0"
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: blossom
 version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 12
-  version: 0.0.12
+  version: 0.1.0
 platform: ruby
 authors: 
 - Daniel Brockman
@@ -15,81 +14,70 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-08 00:00:00 Z
+date: 2012-01-10 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sinatra
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
-        - 0
-        version: 1.0.0
+        version: "1.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: haml
+  name: sass
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 3
-        - 0
-        - 0
-        version: 3.0.0
+        - 1
+        - 1
+        version: 3.1.1
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: compass
+  name: haml
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 55
         segments: 
-        - 0
-        - 10
-        - 0
-        version: 0.10.0
+        - 3
+        - 1
+        - 1
+        version: 3.1.1
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rack-strip-www
+  name: compass
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 0
-        - 2
-        - 0
-        version: 0.2.0
+        - 10
+        version: "0.10"
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: hassle
+  name: rack-normalize-domain
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 29
         segments: 
         - 0
         - 0
@@ -98,8 +86,7 @@ dependencies:
   type: :runtime
   version_requirements: *id005
 description: 
-email: 
-- daniel@brockman.se
+email: daniel@gointeractive.se
 executables: 
 - blossom
 extensions: []
@@ -107,8 +94,10 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/blossom.rb
 - bin/blossom
+- lib/blossom.rb
+- lib/blossom/version.rb
+has_rdoc: true
 homepage: http://github.com/dbrock/blossom
 licenses: []
 
@@ -118,27 +107,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.1
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Quick-start web development with Haml, Sass and Compass.