haml-server 0.2 → 0.3

data/bin/haml-server

@@ -62,11 +62,107 @@
 #         :css
 #           @import url(/stylesheets/screen.css);
 
+##### Helpers
+
+# You can create a file called `helpers.rb` to define any helpers you might
+# want to make available.
+#
+#     # helpers.rb
+#     require "pygmentize"
+#
+#     def highlight(code, format)
+#       Pygmentize.process(code, format)
+#     end
+#
+#     alias hi highlight
+#
+# And then in your views, you can access the helpers:
+#
+#     # index.haml
+#
+#     %h3 Example code
+#     ~ hi "puts '1 + 2 # => 3'", :ruby
+#
+# The helpers are reloaded before each request, so you can add and remove them
+# without restarting the server.
+
+#### Running on Heroku (cedar stack)
+
+# With Heroku's cedar stack, it's now super easy to deploy your `haml-server`
+# site for anyone to see. Here's a step-by-step walkthrough for deploying to
+# Heroku, with some recommendations for how to structe the site.
+
+##### Structure
+
+# Since we'll be adding some additional files to get things wired up, I
+# recommend you move your views and static files into a separate folder like
+# `site` (the walkthrough will assume that you've done so). So your site might
+# look like this:
+#
+#     > tree
+#     .
+#     ├── helpers.rb
+#     └── site
+#         ├── index.haml
+#         ├── layout.haml
+#         └── screen.css
+#
+# When working locally, then, you'll want to run the site with: `haml-server
+# site`.
+#
+# Now to get things set up for Heroku, we'll need to add a few files:
+#
+#     # Gemfile
+#     source :rubygems
+#     gem "haml-server"
+#
+#     # Procfile
+#     web: bundle exec haml-server -p $PORT site
+#
+# Now the project should look like this:
+#
+#     > tree
+#     .
+#     ├── Gemfile
+#     ├── Procfile
+#     ├── helpers.rb
+#     └── site
+#         ├── index.haml
+#         ├── layout.haml
+#         └── screen.css
+
+##### Deploy
+
+# First we'll need to get our environment in order by running:
+#     > gem install bundler
+#     > bundle
+#
+# This will install any dependencies, and store those in a file called
+# `Gemfile.lock`.
+#
+# Now we should set up the site as a `git` repository, and commit our files.
+#
+#     > git init
+#     > git add .
+#     > git commit -m "Initial commit"
+#
+# We're almost done! Now we'll create a new application and deploy it:
+#
+#     > gem install heroku
+#     > heroku apps:create --stack cedar
+#     > git push heroku master
+#     > heroku open
+#
+# `heroku open` will open up your site in the browser. Done!
+
 #### The code
 
 # `HAML`, check!
 require "haml"
 
+# `SASS`, check!
+require "sass"
+
 # Okay. In any other context, this would be pretty evil. Let me explain.
 # Sinatra is a well-behaving citizen, and calls `ARGV.dup` before parsing its
 # options.  Unfortunately for us, that means if we want to easily add
@@ -96,18 +192,43 @@ require "pathname"
 
 template_dir = Pathname(Dir.pwd) + (ARGV.shift || ".")
 
-set :public, template_dir
-set :views , template_dir
+set :public_folder, template_dir
+set :views, template_dir
 
 # If a favicon wasn't already matched by the public handler, just return a 404.
 get "/favicon.ico" do
   404
 end
 
+# This will be a container module for user-defined helpers. `Helpers.reload!`
+# will clean up any existing methods in the module, and then load helpers
+# defined in a `helpers.rb` file if it exists.
+module Helpers
+  class << self
+    def reload!
+      # First we remove all instance methods in the helper module.
+      instance_methods.each do |method|
+        remove_method(method)
+      end
+
+      # And now we load any helper methods into the module from the file
+      # `helpers.rb` if it exists.
+      module_eval(File.read("helpers.rb")) if File.file?("helpers.rb")
+    end
+  end
+end
+
+# Include our module into the Sinatra application.
+helpers Helpers
+
 # This is our basic handler for all requests that come through to Sinatra.
 # We'll extract the necessary path information, and then render either a haml
 # or sass file.
 handler = lambda do
+
+  # Reload our helpers for each request.
+  Helpers.reload!
+
   path = request.path_info
 
   extension = File.extname(path)

metadata

@@ -1,78 +1,80 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: haml-server
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: '0.3'
   prerelease: 
-  version: "0.2"
 platform: ruby
-authors: 
+authors:
 - Bernerd Schaefer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-24 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sinatra
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70098912206340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *70098912206340
+- !ruby/object:Gem::Dependency
   name: haml
+  requirement: &70098912204600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70098912204600
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: &70098912203780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *70098912203780
 description: Server for HAML files
 email: bj.schaefer@gmail.com
-executables: 
+executables:
 - haml-server
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README
 - bin/haml-server
-has_rdoc: true
 homepage: http://github.com/bernerdschaefer/haml-server
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Server for HAML files
 test_files: []
-