piano 0.10.4 → 0.10.6

data/lib/piano/controllerloader.rb

@@ -1,39 +1,39 @@
-require "polyglot"
-
-module Piano
-  # Controller loader especifically for polyglot
-  class PolyglotControllerLoader
-    # Loads the file, no more settings for the moment
-    def self.load filename, options = nil, &block
-      Kernel.eval File.read filename
-    end
-  end
-
-  # Handler of .controller files loading
-  class ControllerLoader
-    def self.folder path
-      $LOAD_PATH << Dir.pwd
-      recursive path do |item|
-        require item
-      end
-    end
-    
-    # Iterates recursively over the path and calls the block
-    # with each newfound file
-    def self.recursive path, &block
-      files = []
-      Dir.new(File.expand_path(path)).each do |file|
-        if File.directory? "#{path}/#{file}"
-          recursive "#{path}/#{file}" do |item|
-            files << "#{item}"
-          end unless file == ".." or file == "."
-        elsif file.end_with? ".controller"
-          files << "#{path}/#{file[0..-12]}"
-        end
-      end
-      files.each { |item| block.call(item) }
-    end
-  end
-end
-
-Polyglot.register "controller", Piano::PolyglotControllerLoader
+require "polyglot"
+
+module Piano
+  # Controller loader especifically for polyglot
+  class PolyglotControllerLoader
+    # Loads the file, no more settings for the moment
+    def self.load filename, options = nil, &block
+      Kernel.eval File.read filename
+    end
+  end
+
+  # Handler of .controller files loading
+  class ControllerLoader
+    def self.folder path
+      $LOAD_PATH << Dir.pwd
+      recursive path do |item|
+        require item
+      end
+    end
+    
+    # Iterates recursively over the path and calls the block
+    # with each newfound file
+    def self.recursive path, &block
+      files = []
+      Dir.new(File.expand_path(path)).each do |file|
+        if File.directory? "#{path}/#{file}"
+          recursive "#{path}/#{file}" do |item|
+            files << "#{item}"
+          end unless file == ".." or file == "."
+        elsif file.end_with? ".controller"
+          files << "#{path}/#{file[0..-12]}"
+        end
+      end
+      files.each { |item| block.call(item) }
+    end
+  end
+end
+
+Polyglot.register "controller", Piano::PolyglotControllerLoader

data/lib/piano/routes.rb

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

data/lib/piano/version.rb

@@ -1,3 +1,3 @@
-module Piano
-  VERSION = "0.10.4"
-end
+module Piano
+  VERSION = "0.10.6"
+end

data/lib/sinatra/piano.rb

@@ -0,0 +1,141 @@
+module Sinatra
+  
+  # Piano was originally though as a Sinatra extension
+  # That's why the code was defined here
+  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
+      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
+
+      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
+      
+      etag hash_for(template, :coffee) if etags?
+      CoffeeScript.compile(File.read(file_name))
+    end
+    
+    # Loads and parses the YAML data from the data directory
+    def data_for(template)
+      file_name = "#{settings.data}/#{template}.yaml"
+      YAML.load_file(file_name) if File.exists?(file_name)
+    end
+    
+    # Sugar: formats a css stylesheet <link /> tag with the input
+    def style(path)
+      "<link rel='stylesheet' type='text/css' href='#{path}' />"
+    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
+    end
+    
+    # Fails. Shouts a 404 response and prints hints
+    #
+    # If Piano is running in production mode, prints a plain 404 html
+    # or, if a 404.haml exists in the :views directory, returns it
+    def bad_luck(path)
+      content_type :html
+      if settings.environment == :production
+        if File.exists? "#{pwd}/404.haml"
+          @data = data_for "404"
+          halt 404, haml(:"404")
+        else
+          halt 404, "<h1>404 - Not Found</h1><p>Piano has found nothing in this address</p>"
+        end
+      else
+        halt 404, "<h1>You have still to put something here.</h1><p>This is <em>#{path}</em></p><blockquote>Good luck!</blockquote>"
+      end
+    end
+    
+    # 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
+    end
+    
+    # Makes an extract out of the given text with the default length
+    # of 80 words
+    # 
+    # If an integer is passed as the second argument, the length 
+    # of the result is adjusted properly:
+    #   
+    #   extract "Hello World! Too much text is inconvenient", 2
+    #
+    # returns
+    # 
+    #   => "Hello World!..."
+    #
+    def extract(text, length = 80)
+      words = text.gsub(/<.+?>/, "").split
+      return text if words.length <= length
+      words[0..(length-1)].join(" ") + "..."
+    end
+    
+    # Returns a url-friendly version of the given link, with a
+    # default maximum of 5 words. 
+    # `link` strips any non-letter or special character, downcases the
+    # string and replaces whitespace with "-"
+    # For example:
+    #
+    #   link "This is a special text! This won't be shown"
+    #
+    # returns
+    #
+    #   => "this-is-a-special-text"
+    #
+    # You can specify a word length in the second argument.
+    def link(text, length = 5)
+      words = text.gsub(/<.+?>/, "").gsub(" ", "-").downcase.gsub(/[^a-z0-9\-]/, "").split("-")
+      words[0..(length-1)].join("-")
+    end
+    
+    # Shorthand to settings.etags == :on
+    def etags?
+      if settings.respond_to? :etags
+        settings.etags == :on
+      else 
+        true
+      end
+    end
+    
+    # Non implemented yet
+    def t(key)
+      I18n.translate key
+    end
+  end
+  
+  register Piano
+end

data/sample/data/index.yaml

@@ -1,8 +1,8 @@
-title: 5 minutes site!
-description: Is amazing how simple it gets
-list:
-  - and I can have
-  - a list
-  - also.
-content: |
+title: 5 minutes site!
+description: Is amazing how simple it gets
+list:
+  - and I can have
+  - a list
+  - 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. 

data/sample/index.haml

@@ -1,11 +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|
+!!! 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

@@ -1,6 +1,6 @@
-body
-  width: 960px
-  margin: 0 auto
-  font:
-    family: sans-serif
+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.10.4
+  version: 0.10.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-01 00:00:00.000000000Z
+date: 2011-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &18672096 !ruby/object:Gem::Requirement
+  requirement: &16774000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *18672096
+  version_requirements: *16774000
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &18671700 !ruby/object:Gem::Requirement
+  requirement: &16772720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *18671700
+  version_requirements: *16772720
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &18671004 !ruby/object:Gem::Requirement
+  requirement: &16770960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *18671004
+  version_requirements: *16770960
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &18670704 !ruby/object:Gem::Requirement
+  requirement: &16770080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *18670704
+  version_requirements: *16770080
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &18670428 !ruby/object:Gem::Requirement
+  requirement: &16769340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *18670428
+  version_requirements: *16769340
 - !ruby/object:Gem::Dependency
   name: polyglot
-  requirement: &18670044 !ruby/object:Gem::Requirement
+  requirement: &16768600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.3.1
   type: :runtime
   prerelease: false
-  version_requirements: *18670044
+  version_requirements: *16768600
 - !ruby/object:Gem::Dependency
   name: metafun
-  requirement: &18669720 !ruby/object:Gem::Requirement
+  requirement: &16756100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18669720
+  version_requirements: *16756100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18669312 !ruby/object:Gem::Requirement
+  requirement: &16755220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,31 +98,32 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18669312
+  version_requirements: *16755220
 description: Out-of-the-box sinatra server for web site sketching using haml + sass
   + coffee-script
 email:
 - xavierviacanel@gmail.com
 executables:
 - piano
+- piano~
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- Gemfile
 - README.rdoc
 - Rakefile
 - bin/piano
+- bin/piano~
 - lib/piano.rb
 - lib/piano/controllerloader.rb
 - lib/piano/routes.rb
 - lib/piano/version.rb
+- lib/sinatra/piano.rb
 - piano.gemspec
 - sample/app.coffee
 - sample/data/index.yaml
 - sample/index.haml
 - sample/style.sass
-- spec/controller_spec.rb
 homepage: http://github.com/xaviervia/piano
 licenses: []
 post_install_message: 
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: piano
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Out-of-the-box sinatra server for web site sketching using haml + sass +