sinatra-pages 0.9.0 → 1.0.0

data/README.markdown

@@ -12,9 +12,10 @@ You should take into account that this library have the following dependencies:
 * [haml][3]
 
 ### Usage
-Before plug in this extension, you should create the following file structure inside your application.
+Before using this extension, you should create the following file structure inside your application.
 
     app/
+     |- app.rb
      |- config.ru
      |- views/
           |- home.haml
@@ -26,18 +27,47 @@ Before plug in this extension, you should create the following file structure in
           |- layout.haml
           |- not_found.haml
 
-The only restriction is extension imposes is that you have to create the *home.haml* and the *not_found.haml* files inside the directory you defined as *:views* for the pluggable application (Sinatra uses the *views/* directory as the default path for the *:views* option). Then you're free to add any layout (Sinatra defined the *layout.haml* file as the default specification for the *:layout* option) and page under any file structure hierarchy inside this directory.
+Please notice that this extension requires you to create the *home.haml* and the *not_found.haml* files inside the directory you defined as *:views* on your application (Sinatra uses the *views/* directory as the default path for the *:views* directory). Then you're free to add any layout (Sinatra defined the *layout.haml* file as the default specification for the *:layout* template) and page under any file structure hierarchy inside this directory.
 
-Then, you just need to plug it in inside your *config.ru* file.
+Now, as any other existing extension, there are two possible use cases depending the kind of Sinatra application you're developing. If you follow the __Classic__ approach, then you just need to require this extension in the *app.rb* file.
 
     require 'sinatra'
     require 'sinatra/pages'
-  
+    
+Then you should require your *app.rb* file inside the *config.ru* file in order to make your application runnable.
+
+    require 'app'
+    
+    disable :run
+    
+    run Sinatra::Application
+
+You can test your application by executing the following command on your command line.
+
+    $app/ruby app.rb
+    
+In case you would prefer to follow the __Modular__ approach on your application design, then you just need to declare your application as a class that inherit from the *Sinatra::Base* class and then register the extension inside it in the *app.rb* file.
+
+    require 'sinatra/base'
+    require 'sinatra/pages'
+    
+    module Sinatra
+      module App < Sinatra::Base
+        register Sinatra::Pages
+      end
+    end
+
+Then you should require your *app.rb* inside the *config.ru* file and associate your application class to a certain route.
+
+    require 'app'
+    
+    disable :run
+    
     map '/' do
-      run Sinatra::Pages
+      run Sinatra::App
     end
-  
-Finally, you should test your application by executing the following command on your command line.
+
+You can try your modular application by executing the following command in your command line.
 
     $app/rackup config.ru
   

data/lib/sinatra/pages.rb

@@ -2,26 +2,30 @@ require 'sinatra/base'
 require 'haml'
 
 module Sinatra
-  class Pages < Sinatra::Base
-    %w[/? /:page /*/:page].each do |route|
-      get route do
-        params[:page] = 'home' if params[:page].nil?
-        
-        page_to_render = params[:splat].nil? ? '' : "#{params[:splat].first}/"
-        page_to_render << params[:page]
-        
-        begin
-          haml page_to_render.to_sym, :layout => !request.xhr?
-        rescue Errno::ENOENT
-          halt 404
+  module Pages
+    def self.registered(app)
+      %w[/? /:page /*/:page].each do |route|
+        app.get route do
+          params[:page] = 'home' if params[:page].nil?
+
+          page_to_render = params[:splat].nil? ? '' : "#{params[:splat].first}/"
+          page_to_render << params[:page]
+
+          begin
+            haml page_to_render.to_sym, :layout => !request.xhr?
+          rescue Errno::ENOENT
+            halt 404
+          end
         end
       end
-    end
-    
-    not_found do
-      params[:page] = 'not_found'
-      
-      haml :not_found, :layout => !request.xhr?
+
+      app.not_found do
+        params[:page] = 'not_found'
+
+        haml :not_found, :layout => !request.xhr?
+      end
     end
   end
+  
+  register Pages
 end

data/spec/pages_spec.rb

@@ -4,7 +4,7 @@ describe Sinatra::Pages do
   include Rack::Test::Methods
   
   def app
-    Sinatra::Pages
+    Sinatra::Application
   end
 
   PAGES = ['Home','Generic',{'Generic Test'=>'Test'},{'Another Generic Test'=>{'Generic Test'=>'Test'}},'Not Found']
@@ -15,14 +15,13 @@ describe Sinatra::Pages do
     page_to_create = page.class == String ? page : page.keys.first
     content << '= "#{params[:page]}"' if content.empty?
     
-    Dir.mkdir directory unless File.exist? "#{directory}/"
+    Dir.mkdir "#{directory}/" unless File.exist? "#{directory}/"
     File.open("#{directory}/#{file_of.(page_to_create)}.haml", 'w'){|file| content.each{|line| file.puts line}}
     
     create_file_for.(page.values.first, "#{directory}/#{file_of.(page.keys.first)}") if page.class == Hash
   end
     
   before :all do
-    FileUtils.mkdir 'views'
     PAGES.each{|page| create_file_for.(page)}
   end
   

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
-require File.join(Dir.pwd, %w{lib sinatra pages})
+require 'sinatra'
 require 'rack/test'
-require 'fileutils'
+require 'fileutils'
+require File.join(Dir.pwd, %w{lib sinatra pages})
+
+set :environment, :test
+set :views, "#{Dir.pwd}/views"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-pages
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Julio Javier Cicchelli
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-23 00:00:00 +01:00
+date: 2010-02-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency