piano 0.6.0 → 0.7.0

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-views/*
+views/*
+test/*

data/README.rdoc

@@ -1,6 +1,6 @@
 = Piano
 
-Out-of-the-box sinatra server for fast website sketching using haml and sass and coffee-script.
+Out-of-the-box Sinatra server for fast website sketching using Haml and Sass and CoffeeScript (and YAML!).
 
 The magic triplet, one command away!
 
@@ -8,13 +8,13 @@ The magic triplet, one command away!
 
   gem install piano
 
-== Usage
+== Standalone Usage
 
   server/folder$ piano [<port-number>]
 
 Piano will start a Sinatra server based in the same folder where you run the command, in the port given. If no port is given, piano will start in the default Sinatra port, 4567. 
 
-Haml(http://haml-lang.com) <tt>.haml</tt> files and Sass (http://sass-lang.com) <tt>.sass</tt> and CoffeeScript (http://github.com/josh/ruby-coffee-script) <tt>.coffee</tt> files in the base folder will automatically be mapped to urls.
+Haml (http://haml-lang.com) <tt>.haml</tt> files and Sass (http://sass-lang.com) <tt>.sass</tt> and CoffeeScript (http://github.com/josh/ruby-coffee-script) <tt>.coffee</tt> files in the base folder will automatically be mapped to urls.
 
   yoursite.com/users      => server/folder/users.haml
   yoursite.com/style.css  => server/folder/style.sass
@@ -22,8 +22,81 @@ Haml(http://haml-lang.com) <tt>.haml</tt> files and Sass (http://sass-lang.com)
 
 Other files (images, plain text files, etc) will be loaded from the <tt>server/folder/public</tt> as is default behavior in Sinatra.
 
+== YAML Data
+
+When receiving a request for <tt>"/users"</tt>, Piano will look up for a YAML file <tt>server/folder/<strong>data/</strong>users.haml</tt>. If it is there, the YAML file will be loaded and available for the correspondent Haml template in the <tt>@data</tt> variable.
+
+== 5 minutes site!
+
+...all working with stylesheet, scripts and YAML data sources.
+
+<strong>folder/index.haml:</strong>
+
+  !!! 5
+  %head
+    %title= @data['title']
+    = style "style.css"
+    = script "app.js"
+  %body
+    %h1= @data['title']
+    %p= @data['description']
+    %ul
+      - @data['list'].each do |item|
+        %li= item
+
+<strong>folder/style.sass:</strong>
+
+  body
+    width: 960px
+    margin: 0 auto
+    font:
+      family: sans-serif
+      size: 15px
+
+<strong>folder/app.coffee:</strong>
+
+  alert "This is too simple to be true"
+  
+<strong>folder/data/index.yaml:</strong>
+
+  title: 5 minutes site!
+  description: Is amazing how simple it gets
+  list:
+    - and I can have
+    - a list
+    - also.
+  
+Note: You can find this sample in the repository within the sample folder.
+
+== Library Usage
+
+If you want, you can include Piano as a library in your own server. Kind of defeats the point of using Piano, but useful if you want to extend its functionality.
+
+  require "piano"
+  
+  Piano.play! # .play! added 4 the lulz; Piano.run! will do the trick aswell
+
+Piano inherits Sinatra::Base, so all of Sinatra::Base own methods are available.
+
+Of course, you can also do this:
+
+  require "piano"
+  
+  class ExtendingPiano < Piano    
+    get "/" do
+      "This will not work since this route has already been matched."
+    end
+    # ...but you can add "before do" and "after do" filters
+    
+    run! # or play!
+  end
+  
+Remember that the server folder will be the working directory when the script is executed, and not the script path as usual in Sinatra.
+
 == Candies for the kidz
 
+=== Convenience helpers
+
 Piano features two convenience helpers to include stylesheets and javascripts: <tt>style("style.css")</tt> and <tt>script("app.js")</tt>.
 
 You can use them in your haml templates like this:
@@ -37,6 +110,12 @@ You can use them in your haml templates like this:
       
 Code is poetry.
 
+=== Etags
+
+Since parsing YAML, Sass, Haml and CoffeeScript can be quite a burden for the processor, each response is marked with an Etag hash featuring the required file name and the timestamp of the last modification.
+
+Etags cause client side caching. This should not be a problem since the hash changes every time a source file is modified (including the YAML data files), forcing the User-Agent to update its cache, but still is worth noting as I might not be fully aware of cache-related issues that Etag-ging may trigger.
+
 == Gem dependencies
 
 * sinatra (http://sinatrarb.com)
@@ -46,6 +125,8 @@ Code is poetry.
 
 == Desired (future) features
 
+* Etag on/off (currently etags are hardcoded on)
+* <tt>"data"</tt> folder name configurable.
 * Online source files edition.
 
 == Tips

data/lib/piano.rb

@@ -2,74 +2,62 @@ require "sinatra/base"
 require "haml"
 require "sass"
 require "coffee-script"
+require "yaml"
 
 class Piano < Sinatra::Base
   set :root, File.expand_path(Dir.pwd)
   set :views, File.expand_path(Dir.pwd)
   
   get "/" do
-    try_haml :index
+    @data = data_for "index"
+    try_haml "index"
   end
   
   get %r{/(.+?).css} do |something|
     content_type :css
-    sass something.to_sym
+    sass something
   end
   
   get %r{/(.+?).js} do |something|
     content_type :js
-    coffee something.to_sym
+    coffee something
   end
   
   get %r{/(.+)$} do |something|
-    try_haml something.to_sym
+    @data = data_for something
+    try_haml something
   end
   
   helpers do
     def try_haml(template)
-      begin
-        return haml template
-      rescue Exception => error
-        if error.message =~ /No such file or directory/
-          path = File.expand_path(Dir.pwd)
-          response = "<h1>You have still to put something here.</h1><p>This is <em>#{path}/#{template.to_sym}.haml</em></p><blockquote>Good luck!</blockquote>"
-          return response
-        else
-          raise error
-        end
-      end
+      file_name = "#{pwd}/#{template}.haml"
+      bad_luck file_name unless File.exists? file_name
+     
+      hash = hash_for template, :haml
+      hash += hash_for "data/#{template}", :yaml if File.exists? "#{pwd}/data/#{template}.yaml"
+      etag hash
+      haml template.to_sym
     end
     
     def sass(template)
-      begin
-        dir = File.expand_path(Dir.pwd)
-        data = File.read "#{dir}/#{template.to_s}.sass"
-        return Sass.compile(data, :syntax => :sass)
-      rescue Exception => error
-        if error.message =~ /No such file or directory/
-          path = File.expand_path(Dir.pwd)
-          response = "<h1>You have still to put something here.</h1><p>This is <em>#{path}/#{template.to_s}.sass</em></p><blockquote>Good luck!</blockquote>"
-          return response
-        else
-          raise error
-        end
-      end
+      file_name = "#{pwd}/#{template}.sass"
+      bad_luck file_name unless File.exists? file_name
+
+      etag hash_for(template, :sass)
+      Sass.compile File.read(file_name), :syntax => :sass
     end
   
     def coffee(template)
-      begin
-        dir = File.expand_path(Dir.pwd)
-        data = File.read "#{dir}/#{template.to_s}.coffee"
-        return CoffeeScript.compile(data)
-      rescue Exception => error
-        if error.message =~ /No such file or directory/
-          path = File.expand_path(Dir.pwd)
-          response = "<h1>You have still to put something here.</h1><p>This is <em>#{path}/#{template.to_s}.coffee</em></p><blockquote>Good luck!</blockquote>"
-          return response
-        else
-          raise error
-        end
-      end
+      file_name = "#{pwd}/#{template}.coffee"
+      bad_luck file_name unless File.exists? file_name
+      
+      etag hash_for(template, :coffee)
+      CoffeeScript.compile(File.read(file_name))
+    end
+    
+    def data_for(template)
+      file_name = "#{pwd}/data/#{template}.yaml"
+      YAML.load_file(file_name) if File.exists?(file_name)
     end
     
     def style(path)
@@ -79,6 +67,21 @@ class Piano < Sinatra::Base
     def script(path)
       "<script type='text/javascript' src='#{path}'></script>"
     end
+    
+    def pwd
+      File.expand_path(Dir.pwd)
+    end
+    
+    def bad_luck(path)
+      halt 404, "<h1>You have still to put something here.</h1><p>This is <em>#{path}</em></p><blockquote>Good luck!</blockquote>"
+    end
+    
+    def hash_for(name, type)
+      "#{name}.#{type} - " + File.mtime("#{pwd}/#{name}.#{type}").to_s
+    end
   end
   
+  def self.play!
+    self.run!
+  end
 end

data/lib/piano/version.rb

@@ -1,3 +1,3 @@
 module Piano
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/sample/app.coffee

@@ -0,0 +1 @@
+alert "This is too simple to be true"

data/sample/data/index.yaml

@@ -0,0 +1,6 @@
+title: 5 minutes site!
+description: Is amazing how simple it gets
+list:
+  - and I can have
+  - a list
+  - also.

data/sample/index.haml

@@ -0,0 +1,11 @@
+!!! 5
+%head
+  %title= @data['title']
+  = style "style.css"
+  = script "app.js"
+%body
+  %h1= @data['title']
+  %p= @data['description']
+  %ul
+    - @data['list'].each do |item|
+      %li= item

data/sample/style.sass

@@ -0,0 +1,6 @@
+body
+  width: 960px
+  margin: 0 auto
+  font:
+    family: sans-serif
+    size: 15px

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piano
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &22065996 !ruby/object:Gem::Requirement
+  requirement: &20907024 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *22065996
+  version_requirements: *20907024
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &22065696 !ruby/object:Gem::Requirement
+  requirement: &20906724 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *22065696
+  version_requirements: *20906724
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &22065420 !ruby/object:Gem::Requirement
+  requirement: &20906448 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *22065420
+  version_requirements: *20906448
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &21335700 !ruby/object:Gem::Requirement
+  requirement: &20906172 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *21335700
+  version_requirements: *20906172
 description: Out-of-the-box sinatra server for web site sketching using haml + sass
   + coffee-script
 email:
@@ -73,6 +73,10 @@ files:
 - lib/piano.rb
 - lib/piano/version.rb
 - piano.gemspec
+- sample/app.coffee
+- sample/data/index.yaml
+- sample/index.haml
+- sample/style.sass
 has_rdoc: true
 homepage: http://github.com/xaviervia/piano
 licenses: []