piano 0.7.3 → 0.7.4

data/README.rdoc

@@ -10,7 +10,7 @@ The magic triplet, one command away!
 
 == Standalone Usage
 
-  server/folder$ piano [<port-number> <environment>]
+  server/folder$ piano [<port-number> <environment> [options]]
 
 Piano will start a Sinatra server based in the same folder where you run the command, in the port and environment given. If no port is given, Piano will start in the default Sinatra port <tt>4567</tt> and the default environment <tt>:development</tt>. 
 
@@ -79,6 +79,12 @@ For nicety sake, you can personalize 404 pages simply by creating a <tt>server/f
 
 Note: you can also add a <tt>server/folder/data/404.yaml</tt> file to keep layer separation even in your error pages.
 
+== Command line options summary
+
+* Port number: Any number passed as an argument to the <tt>piano</tt> command will be used as the port number.
+* Environment: Any string that does not matches any other argument will be setted as the environment. 
+* <tt>noetags</tt>: Adding <tt>noetags</tt> to the shell command will cause Piano to run without etags.
+
 == 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.
@@ -87,8 +93,15 @@ If you want, you can include Piano as a library in your own server. Kind of defe
   
   Piano.play! # .play! added 4 the lulz; Piano.run! will do the trick aswell
 
-<tt>Piano</tt> inherits <tt>Sinatra::Base</tt>, so all of <tt>Sinatra::Base</tt> own methods are available.
+<tt>Piano</tt> inherits <tt>Sinatra::Base</tt>, so all of <tt>Sinatra::Base</tt> own methods are available. Read the Sinatra documentation for further information. Tip: put
+  
+  Piano.environment = :production
+
+just before letting it play for play in production environment!
+
+By setting <tt>Piano.etags = :off</tt>, etags will be disabled.
 
+=== And extending it...
 Of course, you can also do this:
 
   require "piano"
@@ -101,9 +114,24 @@ Of course, you can also do this:
     
     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.
 
+You can even do this:
+  
+  class MySinatraServer < Sinatra::Base
+  
+    use Piano
+    
+    get "/" do
+      "My guess is this still won't work, yet I haven't properly tested it"
+    end
+    
+    # ...many other things
+  end
+
+...currently I can't predict its behavior since I haven't tested it.
+
 == Candies for the kidz
 
 === Convenience helpers
@@ -150,17 +178,21 @@ Etags cause client side caching. This should not be a problem since the hash cha
 
 == Desired (future) features
 
-* Etag on/off (currently etags are hardcoded on)
-* Folder paths and sinatra default arguments configurable.
+* Folder paths configurable.
 * Condition for disabling default Piano routes
 * Further documentation of Piano helpers
-* Custom error when there's no data
 * More helpers for semantic data handling.
 * Deploy of sample with command line <tt>--sample</tt> argument.
 * Online source files edition.
+* Test <tt>use Piano</tt> within a <tt>Sinatra::Base</tt> class.
 
-DONE &gt; Setup to production enviroment option (why not?!)
 * 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
+
+* Setup to production enviroment option (why not?!)
+* Etag on/off (currently etags are hardcoded on)
 
 == Tips
 

data/bin/piano

@@ -7,6 +7,27 @@ unless ARGV.empty?
   ARGV.each do |arg|
     if arg =~ /^\d+$/
       Piano.port = arg
+    elsif arg =~ /^noetags$/
+      Piano.etags = :off
+    elsif arg =~ /^nocoffee%/
+      $nocoffeescript = true
+    elsif arg =~ /^sample$/
+      puts "Warning: the sample site folder files will be created in the current directory."
+      puts "Any files with the same name will be overwritten."
+      print "Do you want to continue? (Yn): "
+      while answer = gets
+        puts answer
+#        if answer =~ /^Y/
+#          puts "Building sample..."
+#          make_sample
+#          break
+#        elsif answer =~ /^n/
+#          puts "Exiting now"
+#          Process.exit!
+#        else
+#          print "Couldn't understand the answer, please do it again (Yn): "
+#        end
+      end 
     elsif arg =~ /^[a-z]+$/
       Piano.environment = arg.to_sym
     end
@@ -14,4 +35,14 @@ unless ARGV.empty?
 
 end
 
+def make_sample
+  require "fileutils"
+  
+  source_dir = File.dirname(File.dirname(File.expand_path(__FILE__)))
+  
+  this_dir = File.expand_path(Dir.pwd)
+  
+  FileUtils.cp_r "#{source_dir}/sample", this_dir
+end
+
 Piano.run!

data/lib/piano.rb

@@ -1,12 +1,35 @@
 require "sinatra/base"
 require "haml"
 require "sass"
-require "coffee-script"
 require "yaml"
 
+unless $notcoffeescript
+  require "coffee-script"
+end
+
 class Piano < Sinatra::Base
+
+  class AllButPattern
+    Match = Struct.new(:captures)
+
+    def initialize(except)
+      @except   = except
+      @captures = Match.new([])
+    end
+
+    def match(str)
+      @captures unless @except === str
+    end
+  end
+
+  def self.all_but(pattern)
+    AllButPattern.new(pattern)
+  end
+  
   set :root, File.expand_path(Dir.pwd)
   set :views, File.expand_path(Dir.pwd)
+  set :etags, :on
+  set :etags?, Proc.new { settings.etags == :on }
   
   get "/" do
     @data = data_for "index"
@@ -23,7 +46,8 @@ class Piano < Sinatra::Base
     coffee something
   end
   
-  get %r{/(.+)$} do |something|
+  get all_but(%r{/finetuner(:.+)$}) do 
+    something = request.path[1..(request.path.length-1)]
     @data = data_for something
     try_haml something
   end
@@ -33,9 +57,11 @@ class Piano < Sinatra::Base
       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
+      if settings.etags?
+        hash = hash_for template, :haml
+        hash += hash_for "data/#{template}", :yaml if File.exists? "#{pwd}/data/#{template}.yaml"
+        etag hash
+      end
       haml template.to_sym
     end
     
@@ -43,7 +69,7 @@ class Piano < Sinatra::Base
       file_name = "#{pwd}/#{template}.sass"
       bad_luck file_name unless File.exists? file_name
 
-      etag hash_for(template, :sass)
+      etag hash_for(template, :sass) if settings.etags?
       Sass.compile File.read(file_name), :syntax => :sass
     end
   
@@ -51,7 +77,7 @@ class Piano < Sinatra::Base
       file_name = "#{pwd}/#{template}.coffee"
       bad_luck file_name unless File.exists? file_name
       
-      etag hash_for(template, :coffee)
+      etag hash_for(template, :coffee) if settings.etags?
       CoffeeScript.compile(File.read(file_name))
     end
     

data/lib/piano/version.rb

@@ -1,3 +1,3 @@
 module Piano
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piano
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-10 00:00:00.000000000 -03:00
+date: 2011-05-18 00:00:00.000000000 -03:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &21772596 !ruby/object:Gem::Requirement
+  requirement: &21455076 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *21772596
+  version_requirements: *21455076
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &21772296 !ruby/object:Gem::Requirement
+  requirement: &21454776 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *21772296
+  version_requirements: *21454776
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &21772020 !ruby/object:Gem::Requirement
+  requirement: &21454500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *21772020
+  version_requirements: *21454500
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &21771744 !ruby/object:Gem::Requirement
+  requirement: &21454224 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *21771744
+  version_requirements: *21454224
 description: Out-of-the-box sinatra server for web site sketching using haml + sass
   + coffee-script
 email: