piano 0.7.0 → 0.7.1

data/README.rdoc

@@ -24,13 +24,13 @@ Other files (images, plain text files, etc) will be loaded from the <tt>server/f
 
 == 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.
+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.
 
 == 5 minutes site!
 
 ...all working with stylesheet, scripts and YAML data sources.
 
-<strong>folder/index.haml:</strong>
+==== folder/index.haml
 
   !!! 5
   %head
@@ -44,7 +44,7 @@ When receiving a request for <tt>"/users"</tt>, Piano will look up for a YAML fi
       - @data['list'].each do |item|
         %li= item
 
-<strong>folder/style.sass:</strong>
+==== folder/style.sass
 
   body
     width: 960px
@@ -53,11 +53,11 @@ When receiving a request for <tt>"/users"</tt>, Piano will look up for a YAML fi
       family: sans-serif
       size: 15px
 
-<strong>folder/app.coffee:</strong>
+==== folder/app.coffee
 
   alert "This is too simple to be true"
   
-<strong>folder/data/index.yaml:</strong>
+==== folder/data/index.yaml
 
   title: 5 minutes site!
   description: Is amazing how simple it gets
@@ -66,7 +66,7 @@ When receiving a request for <tt>"/users"</tt>, Piano will look up for a YAML fi
     - a list
     - also.
   
-Note: You can find this sample in the repository within the sample folder.
+Note: You can find this sample in the repository within the <tt>/sample</tt> folder.
 
 == Library Usage
 
@@ -76,7 +76,7 @@ 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
 
-Piano inherits Sinatra::Base, so all of Sinatra::Base own methods are available.
+<tt>Piano</tt> inherits <tt>Sinatra::Base</tt>, so all of <tt>Sinatra::Base</tt> own methods are available.
 
 Of course, you can also do this:
 
@@ -108,6 +108,10 @@ You can use them in your haml templates like this:
       = style "style.css"
       = script "app.js"
       
+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
+
 Code is poetry.
 
 === Etags
@@ -126,12 +130,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)
-* <tt>"data"</tt> folder name configurable.
+* Folder paths and sinatra default arguments configurable.
+* Condition for disabling default Piano routes
+* Further documentation of Piano helpers
+* More helpers for semantic data handling.
+* Deploy of sample with command line <tt>--sample</tt> argument.
+* Setup to production enviroment option (why not?!)
 * Online source files edition.
 
 == Tips
 
-Not really suitable for production use, since any empty URL will return a full path disclosure of the file the Piano intended to load.
+As for v0.7, not really suitable for production use, since any empty URL will return a full path disclosure of the file that Piano intended to load.
+
+Piano is in intensive development, you might want to keep track of small updates with Bundler pointing to the github repository. Here is the line to put in your Gemfile
+
+  gem "piano", :git => "git://github.com/xaviervia/piano.git"
 
 = License
 

data/lib/piano.rb

@@ -79,6 +79,12 @@ class Piano < Sinatra::Base
     def hash_for(name, type)
       "#{name}.#{type} - " + File.mtime("#{pwd}/#{name}.#{type}").to_s
     end
+    
+    def extract(text, length = 80)
+      words = text.gsub(/<.+?>/, "").split
+      return text if words.length <= length
+      words[0..(length-1)].join(" ") + "..."
+    end
   end
   
   def self.play!

data/lib/piano/version.rb

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

data/sample/data/index.yaml

@@ -3,4 +3,6 @@ description: Is amazing how simple it gets
 list:
   - and I can have
   - a list
-  - also.
+  - also.
+content: |
+  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed a tortor vel sapien facilisis faucibus at eget dolor. Sed rhoncus est sit amet ipsum cursus eu porttitor dui eleifend. Maecenas accumsan egestas dolor eu imperdiet. Maecenas molestie urna quis sapien volutpat eu pretium risus rutrum. Pellentesque commodo urna eu tortor euismod venenatis. Pellentesque luctus dui ullamcorper eros feugiat sit amet suscipit lectus iaculis. Aliquam dolor massa, pulvinar id feugiat sed, commodo non dolor. Mauris fringilla purus ut nunc dapibus ac posuere velit adipiscing. Etiam id vestibulum eros. Aenean id dolor lorem. Donec sed lacus vel sem congue congue eu nec tellus. 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piano
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-08 00:00:00.000000000 -03:00
+date: 2011-05-10 00:00:00.000000000 -03:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &20907024 !ruby/object:Gem::Requirement
+  requirement: &21661932 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *20907024
+  version_requirements: *21661932
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &20906724 !ruby/object:Gem::Requirement
+  requirement: &21661632 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *20906724
+  version_requirements: *21661632
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &20906448 !ruby/object:Gem::Requirement
+  requirement: &21661356 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *20906448
+  version_requirements: *21661356
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &20906172 !ruby/object:Gem::Requirement
+  requirement: &21661080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *20906172
+  version_requirements: *21661080
 description: Out-of-the-box sinatra server for web site sketching using haml + sass
   + coffee-script
 email: