piano 0.10.8 → 0.11.0

data/.gitignore

@@ -4,4 +4,5 @@ Gemfile.lock
 pkg/*
 views/*
 test/*
-config/*
+config/*
+.sass-cache/*

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+if RUBY_PLATFORM =~ /linux/
+  gem "therubyracer"
+end

data/README.rdoc

@@ -190,35 +190,25 @@ Another helper you may find useful is <tt>extract("source_text/html", word_count
 
   %p= extract content, 25
 
-=== <tt>flash</tt> & <tt>flash?</tt>
+=== <tt>link</tt>
 
-Most times on a POST request the server performs an action and you want to give the user some feedback about that action. The data for that feedback has become known as "flash text" steming from the Rails argot.
+No, it does not print an anchor: it strips all strange characters from a string and replaces all whitespace with "-". If the text is too long, it cuts it. 
 
-Piano provides <tt>flash</tt> for you, easy to use. A sample
+Really useful when generating uri's for articles, or html id attributes.
 
-==== Pianofile
+  %a(href="/articles/#{article.id}-#{link(article.title)}")= article.title
   
-  post "/article/new" do
-    Article.create params             # ActiveRecord-like article creation
-    
-    flash "The article was created"   # You set the flash text by calling `flash` 
-                                      # with an argument
-                                      
-    redirect "/articles"
-  end
+or
+  
+  %h2(id="#{link(subtitle,4)}")= subtitle
+  
+In this example, the second argument (4) ensures that the link is done with no more than four of the subtitle's words.
 
-==== articles.haml
+=== <tt>flash</tt>
 
-  %html
-    %head
-      %title Articles index
-    %body
-      - if flash? # Checks if any flash text is setted
-        %output= flash
-
-<tt>flash</tt> called without an argument destructively returns the flash text. Destructively so further request to <tt>/articles</tt> (which in this case will bring up <tt>articles.haml</tt>) will not display the flash text. 
+Piano now comes bundled with https://github.com/SFEley/sinatra-flash so you can use the <tt>flash</tt> helper as in Rails. (0.10.9+) 
 
-Internally, <tt>flash</tt> and <tt>flash?</tt> set and check the <tt>session[:flash]</tt> object.
+Please go to the https://github.com/SFEley/sinatra-flash documentation for further reading. Is a nice gem and you might find it really useful.
 
 Code is poetry.
 
@@ -228,18 +218,11 @@ Since parsing YAML, Sass, Haml and CoffeeScript can be quite a burden for the pr
 
 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)
-* haml (http://haml-lang.com)
-* sass (http://sass-lang.com)
-* coffee-script (http://github.com/josh/ruby-coffee-script)
-
 == Desired (future) features
 
-* Folder paths configurable.
+* Features and specs covering all Piano's functionality.
+* Agnosticism. Currently Piano is kind of HAML&SASS monotheistic.
 * <tt>style</tt> and <tt>script</tt> helpers working with symbols.
-* Further documentation of Piano helpers
 * More helpers for semantic data handling.
 * Deploy of sample with command line <tt>--sample</tt> argument.
 * Online source files edition.
@@ -247,13 +230,9 @@ Etags cause client side caching. This should not be a problem since the hash cha
 * Now it would be nice to give Piano personalized templates not only to 404 but for all error pages, specially 500
 * Custom error when there's no data
 
-==== Done
+== Known issues
 
-* Setup to production enviroment option (why not?!)
-* Etag on/off (currently etags are hardcoded on)
-* CoffeeScript appears to be working everywhere once <tt>therubyracer</tt> was setup to be suggested for install in no default javascript environment, so the nocoffee option was deleted. 
-* Default Piano routes are now overridable.
-* No longer relevant since Piano is now fully extendable -> Test <tt>use Piano</tt> within a <tt>Sinatra::Base</tt> class.
+* Sinatra::Piano rules break when a route consisting of only a number is passed
 
 == Tips
 

data/bin/piano

@@ -28,35 +28,36 @@ unless ARGV.empty?
 end
 
 if args
-  Piano::Base.port = args[:port]  if args[:port]
-  Piano::Base.environment = args[:environment] if args[:environment]
-  Piano::Base.etags = args[:etags] if args[:etags]
-  Piano::Base.views = File.expand_path(Dir.pwd) + "/" +args[:views] if args[:views]
-  Piano::Base.public = File.expand_path(Dir.pwd) + "/" + args[:public] if args[:public]
+  Piano::Base.port          = args[:port]  if args[:port]
+  Piano::Base.environment   = args[:environment] if args[:environment]
+  Piano::Base.etags         = args[:etags] if args[:etags]
+  Piano::Base.views         = args[:views] if args[:views]
+  Piano::Base.public        = args[:public] if args[:public]
 end
 
 self.extend Metafun::Delegator
 self.delegate Piano::Base,  :get, :patch, :put, :post, :delete, 
-                      :head, :options, :template, :layout,
+                      :head, :options, :template, :fetch, :layout,
                       :before, :after, :error, :not_found, 
                       :configure, :set, :mime_type, :enable, 
                       :disable, :use, :development?, :test?, 
-                      :production?, :helpers, :settings
+                      :production?, :helpers, :settings, :play!
 
 self.helpers Sinatra::Piano
 
-$LOAD_PATH << Dir.pwd
+$LOAD_PATH << Dir.pwd + "/lib"
 
-if File.exists?(File.expand_path(Dir.pwd) + "/Pianofile")
+if File.exists?("Pianofile")
   puts "Pianofile found, loading..."
-  load File.expand_path(Dir.pwd) + "/Pianofile"
+  load "Pianofile"
 end
 
-if File.exist?("controllers") && File.directory?("controllers")
+if File.directory?("controllers")
   puts "'controllers' directory found, loading '.controller' files"
   Piano::ControllerLoader.folder "controllers" 
 end
 
 require "piano/routes"
 
+puts "Starting Sinatra from Piano #{Piano::VERSION}"
 Piano::Base.play!

data/lib/piano.rb

@@ -1,6 +1,9 @@
 require "sinatra/base"
+require "sinatra/flash"
+
 require "haml"
 require "sass"
+require "compass"
 require "yaml"
 require "i18n"
 
@@ -14,33 +17,6 @@ end
 
 require "sinatra/piano"
 
-module Piano
-  class Base < Sinatra::Base      
-    register Sinatra::Piano
-    
-    set :root, File.expand_path(Dir.pwd)
-    set :views, File.expand_path(Dir.pwd)
-    set :data, File.expand_path(Dir.pwd + "/data")
-    set :etags, :on
-    set :i18n_path, File.expand_path(Dir.pwd) + "/config/locale"
-    
-    def self.i18n!
-      return unless Dir.exists? self.i18n_path
-      dir = Dir.new self.i18n_path
-      i18n_files = []
-      dir.each do |file|
-        if file.end_with?(".yml") or file.end_with?(".yaml")
-          i18n_files << "#{dir.path}/#{file}"
-        end
-      end
-      I18n.load_path = i18n_files
-    end
-        
-    def self.play!
-      self.run! 
-    end
-  end
-end
-
+require "piano/base"
 require "piano/controllerloader"
 require "piano/version"

data/lib/piano/base.rb

@@ -0,0 +1,23 @@
+module Piano
+  class Base < Sinatra::Base      
+    register Sinatra::Piano
+    register Sinatra::Flash
+    
+    Compass.configuration do |config|
+      config.project_path = File.expand_path(Dir.pwd)
+      config.sass_dir = File.expand_path(Dir.pwd)
+    end
+
+    # Defaults
+    set :root, File.expand_path(Dir.pwd)
+    set :views, File.expand_path(Dir.pwd)
+    set :sass, Compass.sass_engine_options
+    set :data, File.expand_path(Dir.pwd + "/data")
+    set :etags, :on
+    set :multidomain, :off
+    
+    def self.play!
+      self.run!
+    end    
+  end
+end

data/lib/piano/controllerloader.rb

@@ -2,7 +2,6 @@ module Piano
   # Handler of .controller files loading
   class ControllerLoader
     def self.folder path
-      $LOAD_PATH << Dir.pwd
       recursive path do |item|
         load item
       end

data/lib/piano/routes.rb

@@ -2,23 +2,23 @@ module Piano
   class Base
     get "/" do
       @data = data_for "index"
-      try_haml "index"
+      fetch :index
     end
     
     get %r{/(.+?).css$} do |something|
       content_type :css
-      sass something
+      fetch something, :sass
     end
     
     get %r{/(.+?).js$} do |something|
       content_type :js
-      coffee something
+      fetch something, :coffee
     end
     
     get "/*" do 
       something = request.path[1..(request.path.length-1)]
       @data = data_for something
-      try_haml something
+      fetch something
     end
   end
-end
+end

data/lib/piano/version.rb

@@ -1,3 +1,3 @@
 module Piano
-  VERSION = "0.10.8"
+  VERSION = "0.11.0"
 end

data/lib/sinatra/piano.rb

@@ -2,43 +2,35 @@ module Sinatra
   
   # Piano was originally though as a Sinatra extension
   # That's why the code was defined here
-  module Piano
+  module Piano    
     
-    # Like Sinatra's/Tilt's `haml`, but adds etags and
-    # returns a 404 with some hints if the haml is not found
-    def try_haml(template)
-      file_name = "#{pwd}/#{template}.haml"
-      bad_luck file_name unless File.exists? file_name
-     
-      if etags?
-        hash = hash_for template, :haml
-        hash += hash_for "data/#{template}", :yaml if File.exists? "#{pwd}/data/#{template}.yaml"
-        etag hash
+    # Replacemente for :try_haml, :sass & :coffee. Agnostic
+    # Work in progress
+    def fetch *args
+      resource = args.shift
+      unless args.empty?
+        type = args.shift
+      else 
+        type = :haml
       end
-      haml template.to_sym
-    end
-    
-    # Loads and parses a `sass` template from the :views directory.
-    # Adds an etag if `etags?` is enabled and returns 404 and hints
-    # if it can't find the .sass file.
-    def sass(template)
-      file_name = "#{pwd}/#{template}.sass"
-      bad_luck file_name unless File.exists? file_name
+      
+      file_name = "#{settings.views}/#{resource}.#{type}"
+      return bad_luck file_name unless File.exists? file_name
 
-      etag hash_for(template, :sass) if etags?
-      Sass.compile File.read(file_name), :syntax => :sass
-    end
-  
-    # Loads and parses a `coffee-script` template from the :views
-    # directory.
-    # Adds an etag if `etags?` is enabled and returns 404 and hints
-    # if it can't find the .coffee file.
-    def coffee(template)
-      file_name = "#{pwd}/#{template}.coffee"
-      bad_luck file_name unless File.exists? file_name
+      if etags?
+        if type == :haml
+          hash = hash_for resource, :haml
+          if File.exists? "#{settings.views}/#{settings.data}/#{resource}.yaml"
+            hash += hash_for "#{settings.data}/#{resource}", :yaml
+          end
+          
+          etag hash
+        else
+          etag hash_for(resource, type)
+        end      
+      end
       
-      etag hash_for(template, :coffee) if etags?
-      CoffeeScript.compile(File.read(file_name))
+      send type, resource.to_sym, *args # Send the template to Sinatra to take care of it
     end
     
     # Loads and parses the YAML data from the data directory
@@ -48,18 +40,13 @@ module Sinatra
     end
     
     # Sugar: formats a css stylesheet <link /> tag with the input
-    def style(path)
-      "<link rel='stylesheet' type='text/css' href='#{path}' />"
+    def style path, more = ""
+      "<link rel='stylesheet' type='text/css' href='#{path}' #{more} />"
     end
     
     # Sugar: formats a javascript <script> tag with the input
-    def script(path)
-      "<script type='text/javascript' src='#{path}'></script>"
-    end
-    
-    # Returns the path to the :views directory
-    def pwd
-      settings.views
+    def script path, more = ""
+      "<script type='text/javascript' src='#{path}' #{more} ></script>"
     end
     
     # Fails. Shouts a 404 response and prints hints
@@ -69,7 +56,7 @@ module Sinatra
     def bad_luck(path)
       content_type :html
       if settings.environment == :production
-        if File.exists? "#{pwd}/404.haml"
+        if File.exists? "#{settings.views}/404.haml"
           @data = data_for "404"
           halt 404, haml(:"404")
         else
@@ -83,7 +70,7 @@ module Sinatra
     # Builds a hash for a file within the :views directory
     # Note: I feel like this functionality should be private
     def hash_for(name, type)
-      "#{name}.#{type} - " + File.mtime("#{pwd}/#{name}.#{type}").to_s
+      "#{name}.#{type} - " + File.mtime("#{settings.views}/#{name}.#{type}").to_s
     end
     
     # Makes an extract out of the given text with the default length
@@ -130,30 +117,7 @@ module Sinatra
         true
       end
     end
-    
-    # Returns the session[:flash] if is defined, nil otherwise
-    def flash?  
-      session[:flash]
-    end
-
-    # If an argument is passed, it sets the `session[:flash]` to the passed argument
-    #
-    # Otherwise, returns `session[:flash]` and removes `:flash` from the `session`
-    # hash to make it available for subsequent requests.
-    def flash data = nil
-      if data
-        session[:flash] = data
-      else
-        flash_text = session[:flash]
-        session.delete :flash
-        return flash_text
-      end
-    end
-    
-    # Non implemented yet
-    def t(key)
-      I18n.translate key
-    end   
+  
   end
   
   register Piano

data/piano.gemspec

@@ -14,8 +14,10 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "piano"
   s.add_dependency "sinatra", ">= 1.2.6"
+  s.add_dependency "sinatra-flash", ">= 0.3.0"
   s.add_dependency "haml", ">= 3.1.1"
   s.add_dependency "sass", ">= 3.1.1"
+  s.add_dependency "compass", ">= 0.12.2"
   s.add_dependency "coffee-script", ">= 2.2.0"
   s.add_dependency "i18n", ">= 0.6.0"
   s.add_dependency "metafun"

metadata

@@ -1,98 +1,167 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: piano
-version: !ruby/object:Gem::Version
-  version: 0.10.8
+version: !ruby/object:Gem::Version 
+  hash: 51
   prerelease: 
+  segments: 
+  - 0
+  - 11
+  - 0
+  version: 0.11.0
 platform: ruby
-authors:
+authors: 
 - Xavier Via
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-08 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-07-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: sinatra
-  requirement: &5684900 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 2
+        - 6
         version: 1.2.6
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sinatra-flash
   prerelease: false
-  version_requirements: *5684900
-- !ruby/object:Gem::Dependency
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: haml
-  requirement: &5684180 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 1
+        - 1
         version: 3.1.1
   type: :runtime
-  prerelease: false
-  version_requirements: *5684180
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: sass
-  requirement: &5683620 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 1
+        - 1
         version: 3.1.1
   type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: compass
   prerelease: false
-  version_requirements: *5683620
-- !ruby/object:Gem::Dependency
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 12
+        - 2
+        version: 0.12.2
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: coffee-script
-  requirement: &5682760 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
         version: 2.2.0
   type: :runtime
-  prerelease: false
-  version_requirements: *5682760
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: i18n
-  requirement: &5681280 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
         version: 0.6.0
   type: :runtime
-  prerelease: false
-  version_requirements: *5681280
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: metafun
-  requirement: &5680880 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *5680880
-description: Out-of-the-box sinatra server for web site sketching using haml + sass
-  + coffee-script
-email:
+  version_requirements: *id008
+description: Out-of-the-box sinatra server for web site sketching using haml + sass + coffee-script
+email: 
 - xavierviacanel@gmail.com
-executables:
+executables: 
 - piano
 - piano~
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- Gemfile
 - README.rdoc
 - Rakefile
 - bin/piano
 - bin/piano~
 - lib/piano.rb
+- lib/piano/base.rb
 - lib/piano/controllerloader.rb
 - lib/piano/routes.rb
 - lib/piano/version.rb
@@ -104,28 +173,36 @@ files:
 - sample/style.sass
 homepage: http://github.com/xaviervia/piano
 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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: piano
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Out-of-the-box sinatra server for web site sketching using haml + sass +
-  coffee-script
+summary: Out-of-the-box sinatra server for web site sketching using haml + sass + coffee-script
 test_files: []
-has_rdoc: 
+