piano 0.9.0 → 0.10.1

data/bin/piano

@@ -43,11 +43,11 @@ end
 require "piano"
 
 if args
-  Piano.port = args[:port]  if args[:port]
-  Piano.environment = args[:environment] if args[:environment]
-  Piano.etags = args[:etags] if args[:etags]
-  Piano.views = File.expand_path(Dir.pwd) + "/" +args[:views] if args[:views]
-  Piano.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 = File.expand_path(Dir.pwd) + "/" +args[:views] if args[:views]
+  Piano::Base.public = File.expand_path(Dir.pwd) + "/" + args[:public] if args[:public]
 end
 
 def make_sample
@@ -61,7 +61,7 @@ def make_sample
 end
 
 self.extend Metafun::Delegator
-self.delegate Piano,  :get, :patch, :put, :post, :delete, 
+self.delegate Piano::Base,  :get, :patch, :put, :post, :delete, 
                       :head, :options, :template, :layout,
                       :before, :after, :error, :not_found, 
                       :configure, :set, :mime_type, :enable, 
@@ -73,14 +73,15 @@ self.helpers Sinatra::Piano
 $LOAD_PATH << Dir.pwd
 
 if File.exists?(File.expand_path(Dir.pwd) + "/Pianofile")
-  piano_file = File.expand_path(Dir.pwd) + "/Pianofile"
   puts "Pianofile found, loading..."
-  load piano_file
+  load File.expand_path(Dir.pwd) + "/Pianofile"
 end
-if File.exists?(File.expand_path(Dir.pwd) + "/.piano") # Deprecate soon
-  load File.expand_path(Dir.pwd) + "/.piano"
+
+if Dir.exist? "controllers"
+  puts "'controllers' directory found, loading '.controller' files"
+  Piano::ControllerLoader.folder "controllers" 
 end
 
 require "piano/routes"
 
-Piano.play!
+Piano::Base.play!

data/lib/piano.rb

@@ -13,7 +13,13 @@ rescue Exception => error
 end
 
 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
@@ -26,6 +32,9 @@ module Sinatra
       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
@@ -34,6 +43,10 @@ module Sinatra
       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
@@ -42,23 +55,31 @@ module Sinatra
       CoffeeScript.compile(File.read(file_name))
     end
     
+    # Loads and parses the YAML data from the data directory
     def data_for(template)
       file_name = "#{pwd}/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
@@ -73,16 +94,43 @@ module Sinatra
       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(/<.+?>/, "")
@@ -93,6 +141,7 @@ module Sinatra
       words[0..(length-1)].join("-")
     end
     
+    # Shorthand to settings.etags == :on
     def etags?
       if settings.respond_to? :etags
         settings.etags == :on
@@ -101,6 +150,7 @@ module Sinatra
       end
     end
     
+    # Non implemented yet
     def t(key)
       I18n.translate key
     end
@@ -110,29 +160,30 @@ module Sinatra
 end
 
 
-
-class Piano < Sinatra::Base      
-  register Sinatra::Piano
-  
-  set :root, File.expand_path(Dir.pwd)
-  set :views, File.expand_path(Dir.pwd)
-  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}"
+module Piano
+  class Base < Sinatra::Base      
+    register Sinatra::Piano
+    
+    set :root, File.expand_path(Dir.pwd)
+    set :views, File.expand_path(Dir.pwd)
+    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
-    I18n.load_path = i18n_files
-  end
-  
-  def self.play!
-    self.run! 
   end
 end
 

data/lib/piano/controllerloader.rb

@@ -1,11 +1,42 @@
 require "polyglot"
+require "rspec"
 
-class Piano
-  class ControllerLoader
+include RSpec::Matchers
+
+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::ControllerLoader
+Polyglot.register "controller", Piano::PolyglotControllerLoader

data/lib/piano/routes.rb

@@ -1,22 +1,24 @@
-class Piano
-  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
+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.9.0"
+  VERSION = "0.10.1"
 end

data/piano.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |s|
   s.add_dependency "polyglot", ">= 0.3.1"
   s.add_dependency "metafun"
 
+  s.add_development_dependency "rspec"
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/spec/controller_spec.rb

@@ -0,0 +1,90 @@
+require "piano/controllerloader"
+
+describe Piano::ControllerLoader do
+  context "there are some files in the folder" do
+    before :all do      
+      if Dir.exist? "controllers"
+        puts "#{File.expand_path('controllers')} should not exist for this to run"
+        Process.exit!
+      end
+      
+      FileUtils.mkdir "controllers"
+      File.open "controllers/demo.controller", "w" do |file|
+        file.write <<-HOLA
+        def Piano.demo_was_loaded; true; end
+        HOLA
+      end
+      
+      File.open "controllers/another.rb", "w" do |file|
+        file.write <<-HOLA2
+        def Piano.wrong!; true; end
+        HOLA2
+      end
+      
+      FileUtils.mkdir "controllers/recursive"
+      FileUtils.mkdir "controllers/recursive/very"
+      File.open "controllers/recursive/very/demo2.controller", "w" do
+        |file|
+        file.write <<-HOLA3
+        def Piano.another_was_loaded; true; end
+        HOLA3
+      end
+    end
+    
+    describe ".folder" do
+      context "files" do
+        before :all do
+          Piano::ControllerLoader.folder "controllers"
+        end
+        
+        it "should include the demo file" do 
+          Piano.demo_was_loaded.should be
+        end
+        
+        it "should not include the .rb file" do
+          expect { Piano.wrong!
+          }.to raise_error(NoMethodError)
+        end
+        
+        it "should include the in-folder file" do
+          Piano.another_was_loaded.should be
+        end
+      end
+      
+      it "should not change $LOAD_PATH" do
+        expect { Piano::ControllerLoader.folder "controllers"
+        }.to change{ $LOAD_PATH.length }.by(1)
+      end
+    end
+    
+    describe ".recursive" do
+      it "should contain the path to the demo file" do
+        flag = false
+        Piano::ControllerLoader.recursive "controllers" do |item|
+          flag = true if item == "controllers/demo"
+        end
+        flag.should be_true
+      end
+      
+      it "should not contain the path to the .rb file" do
+        flag = false
+        Piano::ControllerLoader.recursive "controllers" do |item|
+          flag = true if item == "controllers/another"
+        end
+        flag.should_not be_true
+      end
+      
+      it "should contain the path to the indented demo file" do
+        flag = false
+        Piano::ControllerLoader.recursive "controllers" do |item|
+          flag = true if item == "controllers/recursive/very/demo2"
+        end
+        flag.should be_true
+      end
+    end
+    
+    after :all do
+      FileUtils.rm_r "controllers"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piano
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-12 00:00:00.000000000 -03:00
+date: 2011-10-14 00:00:00.000000000 -03:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &22896720 !ruby/object:Gem::Requirement
+  requirement: &22807344 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *22896720
+  version_requirements: *22807344
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &22896420 !ruby/object:Gem::Requirement
+  requirement: &22807044 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *22896420
+  version_requirements: *22807044
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &22896108 !ruby/object:Gem::Requirement
+  requirement: &22806768 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *22896108
+  version_requirements: *22806768
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &22895832 !ruby/object:Gem::Requirement
+  requirement: &22806492 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *22895832
+  version_requirements: *22806492
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &22895556 !ruby/object:Gem::Requirement
+  requirement: &22806216 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *22895556
+  version_requirements: *22806216
 - !ruby/object:Gem::Dependency
   name: polyglot
-  requirement: &22895268 !ruby/object:Gem::Requirement
+  requirement: &22805940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: 0.3.1
   type: :runtime
   prerelease: false
-  version_requirements: *22895268
+  version_requirements: *22805940
 - !ruby/object:Gem::Dependency
   name: metafun
-  requirement: &22895016 !ruby/object:Gem::Requirement
+  requirement: &22805712 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22895016
+  version_requirements: *22805712
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &22805436 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22805436
 description: Out-of-the-box sinatra server for web site sketching using haml + sass
   + coffee-script
 email:
@@ -103,9 +114,6 @@ files:
 - README.rdoc
 - Rakefile
 - bin/piano
-- features/piano_i18n.feature
-- features/step_definitions/i18n_steps.rb
-- features/support/env.rb
 - lib/piano.rb
 - lib/piano/controllerloader.rb
 - lib/piano/routes.rb
@@ -115,6 +123,7 @@ files:
 - sample/data/index.yaml
 - sample/index.haml
 - sample/style.sass
+- spec/controller_spec.rb
 has_rdoc: true
 homepage: http://github.com/xaviervia/piano
 licenses: []

data/features/piano_i18n.feature

@@ -1,28 +0,0 @@
-Feature: i18n
-  In order to have internationalization in Piano
-  As a Piano user
-  I want to get it loaded and ready
-  
-  Scenario: Load the i18n
-    Given I have installed the i18n gem
-    When I require the i18n
-    Then I have the I18n module in scope
-    
-  Scenario: Get an english translation
-    Given I have the file "config/locale/en.yml"
-    And I have the file "config/locale/es.yml"
-    And the file "config/locale/en.yml" includes:
-      """
-      en: 
-        hello:
-          world: 'Hello World!'
-      """
-    When I load the i18ns within "config/locale"
-    And I set the locale as :en
-    And I run the translation with "hello.world"
-    Then I should get the translated "Hello World!"
-    
-  Scenario: Provide a helper
-    Given everything is ok
-    When execute instance.t "some.text"
-    Then translation should match "translation missing"

data/features/step_definitions/i18n_steps.rb

@@ -1,52 +0,0 @@
-Given /I have installed the (.*?) gem$/ do |gem|
-  Gem.available? gem
-end
-
-When /I require the (.*?)$/ do |file|
-  Piano.should be_a(Class)
-end
-
-Then /I have the (.*?) module in scope/ do |class_name|
-  klass = Module.const_get class_name
-  klass.should be_a(Module)
-end
-
-Given /I have the file "([^"]*)"$/ do |file_path|
-  @base_path = File.expand_path("../../../", __FILE__)
-  file_name = "#{@base_path}/#{file_path}"
-  File.should exist(file_name)
-end
-
-Given /the file "([^"]*)" includes:$/ do |file_path, content|
-  file_content = File.read "#{@base_path}/#{file_path}"
-  file_content.should == content
-end
-
-When /I load the i18ns within "([^"]*)"/ do |folder|
-  Piano.i18n_path = folder
-  Piano.i18n!
-end
-
-When /I set the locale as :(.*)/ do |locale_string|
-  I18n.locale = locale_string.to_sym
-end
-
-When /I run the translation with "([^"]*)"/ do |key|
-  @translation = I18n.translate key
-end
-
-Then /I should get the translated "([^"]*)"/ do |translated|
-  @translation.should == translated
-end
-
-Given /everything is ok/ do; end
-
-When /execute instance.t "([^"]*)"/ do |text|
-  obj = Object.new
-  obj.extend Sinatra::Piano::Helpers
-  @translation = obj.t text
-end
-
-Then /translation should match "([^"]*)"/ do |text|
-  @translation.should match(Regexp.new(text))
-end

data/features/support/env.rb

@@ -1,3 +0,0 @@
-$LOAD_PATH << File.expand_path("../../../lib", __FILE__)
-
-require "piano"