piano 0.7.5 → 0.7.6

data/README.rdoc

@@ -22,6 +22,26 @@ 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.
 
+== Extending functionality
+
+Piano will try to load a file named <tt>server/folder/.piano</tt>. There you can add functionality, like custom helpers. 
+
+==== Sample <tt>.piano</tt> file
+
+This file, for example, will bring back the email masking functionality that was deprecated in version 0.7.6
+
+  class Piano
+    helpers do
+      def unicode_entities(string)
+        encodings = ""
+        string.codepoints do |c|
+          encodings += "&##{c};"
+        end
+        encodings
+      end
+    end
+  end
+
 == YAML Data
 
 When receiving a request for <tt>"/users"</tt>, Piano will look up for a YAML file <tt>server/folder/data/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.
@@ -84,7 +104,6 @@ Note: you can also add a <tt>server/folder/data/404.yaml</tt> file to keep layer
 * 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.
-* <tt>nocoffee</tt>: Adding <tt>nocoffee</tt> to the shell command will cause Piano to Not load the CoffeeScript library. Useful when no JavaScript environment is available.
 
 == Library Usage
 
@@ -155,12 +174,6 @@ You can use them in your haml templates like this:
 Another helper you may find useful is <tt>extract("source_text/html", word_count = 80)</tt>. Returns an extract of the first <tt>word_count</tt> words (default is 80), html tags stripped, and closed by <tt>"..."</tt> . It does nothing is the text is less than <tt>word_count</tt> words in length.
 
   %p= extract content, 25
-  
-==== <tt>unicode_entities</tt>
-
-Useful for hashing email addresses (and hiding them from crawlers. Returns the htmlentities in unicode for each letter of the argument string. For example:
-
-  %p= unicode_entities "sample@address.com"
 
 Code is poetry.
 
@@ -176,6 +189,7 @@ Etags cause client side caching. This should not be a problem since the hash cha
 * haml (http://haml-lang.com)
 * sass (http://sass-lang.com)
 * coffee-script (http://github.com/josh/ruby-coffee-script)
+* therubyracer (http://rubygems.org/gems/therubyracer)
 
 == Desired (future) features
 
@@ -186,7 +200,6 @@ Etags cause client side caching. This should not be a problem since the hash cha
 * 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.
-* If CoffeeScript can't run, inform of the <tt>nocoffee</tt> command line option.
 
 * 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
@@ -195,6 +208,7 @@ Etags cause client side caching. This should not be a problem since the hash cha
 
 * Setup to production enviroment option (why not?!)
 * Etag on/off (currently etags are hardcoded on)
+* CoffeeScript appears to ve working everywhere once <tt>therubyracer</tt> was added as a dependency, so the nocoffee option was deleted. 
 
 == Tips
 
@@ -204,6 +218,10 @@ Piano is in intensive development, you might want to keep track of small updates
 
   gem "piano", :git => "git://github.com/xaviervia/piano.git"
 
+== Deprecated functions
+
+From version 0.7.6 on, <tt>unicode_entities</tt> has been deprecated for better Ruby version backwards compatibility.
+
 = License
 
 (The MIT License)

data/bin/piano

@@ -9,8 +9,6 @@ unless ARGV.empty?
       args[:port] = arg
     elsif arg =~ /^noetags$/
       args[:etags] = :off
-    elsif arg =~ /^nocoffee/
-      $notcoffeescript = 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."
@@ -53,4 +51,8 @@ def make_sample
   FileUtils.cp_r "#{source_dir}/sample", this_dir
 end
 
+if File.exists?(File.expand_path(Dir.pwd) + "/.piano")
+  load File.expand_path(Dir.pwd) + "/.piano"
+end
+
 Piano.run!

data/lib/piano.rb

@@ -3,8 +3,12 @@ require "haml"
 require "sass"
 require "yaml"
 
-unless $notcoffeescript
+begin
   require "coffee-script"
+rescue Exception => error
+  puts "No JavaScript environment was found. Please install therubyracer gem"
+  puts "  gem install therubyracer"
+  Process.exit!
 end
 
 class Piano < Sinatra::Base
@@ -120,14 +124,6 @@ class Piano < Sinatra::Base
       return text if words.length <= length
       words[0..(length-1)].join(" ") + "..."
     end
-    
-    def unicode_entities(string)
-      encodings = ""
-      string.codepoints do |c|
-        encodings += "&##{c};"
-      end
-      encodings
-    end
   end
   
   def self.play!

data/lib/piano/version.rb

@@ -1,3 +1,3 @@
 module Piano
-  VERSION = "0.7.5"
+  VERSION = "0.7.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piano
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-18 00:00:00.000000000 -03:00
+date: 2011-05-25 00:00:00.000000000 -03:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &21716892 !ruby/object:Gem::Requirement
+  requirement: &20217504 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *21716892
+  version_requirements: *20217504
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &21716592 !ruby/object:Gem::Requirement
+  requirement: &20217204 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *21716592
+  version_requirements: *20217204
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &21716316 !ruby/object:Gem::Requirement
+  requirement: &20216928 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *21716316
+  version_requirements: *20216928
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &21716040 !ruby/object:Gem::Requirement
+  requirement: &20216652 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *21716040
+  version_requirements: *20216652
 description: Out-of-the-box sinatra server for web site sketching using haml + sass
   + coffee-script
 email: