sinatra-pages 1.2.0 → 1.3.0

data/README.markdown

@@ -1,5 +1,5 @@
 # Sinatra Pages
-This is a [Sinatra Extension][1] that renders any page or sub-pages located under the directory defined as *:views* and the layout file defined as *:layout* (if there is any) inside your [Sinatra][2] application.
+This is a [Sinatra][1] extension that renders any static page (including sub-pages) located under your *views/* directory  using [HAML][2] as the rendering engine. By combining the main driving principles behind these two libraries, this extension allows you to build static websites for [Sinatra][2] or directly on [Rack][3] in no time.
 
 ### Installation
 In order to install this gem, you just need to install the gem from your command line like this:
@@ -8,8 +8,8 @@ In order to install this gem, you just need to install the gem from your command
 
 You should take into account that this library have the following dependencies:
 
-* [sinatra][2]
-* [haml][3]
+* [sinatra][1]
+* [haml][2]
 
 ### Usage
 Before using this extension, you should create the following file structure inside your application.
@@ -17,17 +17,28 @@ Before using this extension, you should create the following file structure insi
     app/
      |- app.rb
      |- config.ru
+     |- public/
+          |- images/
+              |- ...
+          |- scripts/
+              |- ...
+          |- styles/
+              |- ...
      |- views/
           |- home.haml
-          |- a_file.haml
-          |- another_file.haml
-          |- another_file/yet_another_file.haml
-          |- another_file/yet_another_file/still_another_file.haml
-          |- ...more files and subdirectories...
           |- layout.haml
           |- not_found.haml
+          |- a_file.haml
+          |- another_file.haml
+          |- ...
+          |- another_file/
+                  |- yet_another_file.haml
+                  |- ...
+                  |- yet_another_file/
+                            |- still_another_file.haml
+                            |- ...
 
-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.
+Please notice that this extension requires you to create the *home.haml* and the *not_found.haml* files inside your *views/* directory on your application. Then you're free to add a *layout.haml* (if required) and all the static pages you need under any file structure hierarchy inside this directory. Please don't forget to give the extension *.haml* to all your views.
 
 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.
 
@@ -68,7 +79,43 @@ You can try your modular application by executing the following command in your
     $app/rackup config.ru
   
 In order to verify if you application is working, open your web browser with the address that will appear after the execution described above.
-  
+
+### Customization
+This extension assumes the __:views__ and __:public__ configuration are located on the *./views* and *./public* directories respectively. In any case, you are able to change these values as required.
+
+Depending on the kind of Sinatra application you're developing, you should proceed as follows. If you follow the __Classic__ approach, then you just need to set these configuration parameters in the *app.rb* file.
+
+    require 'sinatra'
+    require 'sinatra/pages'
+    
+    set :views, File.join(Dir.pwd, 'templates')
+    set :public, Proc.new {File.join(root, 'static')}
+    
+In case you would prefer to follow the __Modular__ approach on your application design, then you can set these variables  within your application as a class that inherit from the *Sinatra::Base* class in the *app.rb* file.
+
+    require 'sinatra/base'
+    require 'sinatra/pages'
+    
+    class App < Sinatra::Base
+      register Sinatra::Pages
+      
+      set :views, File.join(Dir.pwd, 'templates')
+      set :public, Proc.new {File.join(root, 'static')}
+    end
+
+Alternatively, you can also set these variables directly from the *config.ru* file in which your application class will be associated to a certain route.
+
+    require 'app'
+    
+    map '/' do
+      Sinatra::App.set :views, File.join(Dir.pwd, 'templates')
+      Sinatra::App.set :public, Proc.new {File.join(root, 'static')}
+      
+      run Sinatra::App
+    end
+
+In order to verify if the customized setup is working as expected, open your web browser with the address that will appear after the execution described above.
+
 ### Contributions
 Everybody is welcome to contribute to this project by commenting the source code, suggesting modifications or new ideas, reporting bugs, writing some documentation and, of course, you're also welcome to contribute with patches as well!
 
@@ -95,9 +142,9 @@ This extension have been tested on the versions 1.8.6, 1.8.7 and 1.9.1 of the [R
 ### License
 This extension is licensed under the [MIT License][9].
 
-[1]: http://www.sinatrarb.com/extensions.html
-[2]: http://www.sinatrarb.com/
-[3]: http://haml-lang.com/
+[1]: http://www.sinatrarb.com/
+[2]: http://haml-lang.com/
+[3]: http://rack.rubyforge.org/
 [4]: http://rspec.info/
 [5]: http://eigenclass.org/hiki/rcov
 [6]: http://gitrdoc.com/brynary/rack-test/tree/master

data/spec/pages_spec.rb

@@ -8,10 +8,6 @@ describe Sinatra::Pages do
     TestApp
   end
 
-  before :all do
-    PAGES.each{|page| create_file_for(page)}
-  end
-  
   context 'built-in settings' do
     context 'by default' do
       subject {app}
@@ -50,196 +46,260 @@ describe Sinatra::Pages do
     end
   end
   
-  context "on HTTP GET" do
-    context "in synchronous mode" do
-      context "with no Layout file" do
-        it "should render only the Home page if the given route is either empty or root." do
-          File.exist?("views/#{file_of('Layout')}.haml").should be_false
-          File.exist?("views/#{file_of('Home')}.haml").should be_true
-
-          ['/', ''].each do |route|
-            get route
-            
-            last_request.should_not be_xhr
-            last_response.should be_ok
-            last_response.body.chomp.should == file_of('Home')
+  context 'on HTTP GET' do
+    before :all do
+      PAGES.each{|page| create_file_for(page, app.views)}
+    end
+    
+    context 'in synchronous mode' do
+      context 'with no Layout' do
+        subject {File.join app.views, "#{file_of('Layout')}.haml"}
+        it {File.exist?(subject).should == false}
+        
+        context 'and with Home static page' do
+          subject {File.join app.views, "#{file_of('Home')}.haml"}
+          it {File.exist?(subject).should == true}
+          it 'should render it.' do
+            ['/', ''].each do |route|
+              get route
+
+              last_request.should_not be_xhr
+              last_response.should be_ok
+              last_response.body.chomp.should == file_of('Home')
+            end
           end
         end
         
-        it "should render only an existing page if the given route match the '/:page' or '/*/:page' patterns." do
-          Dir.glob 'views/**/*.haml' do |file|
-            File.exist?("views/#{file_of('Layout')}.haml").should be_false
-            File.exist?(file).should be_true
-
-            directory = File.dirname(file)[5].nil? ? '' : File.dirname(file)[5, File.dirname(file).size]
-
-            get "#{directory}/#{File.basename(file, '.haml')}"
-
-            last_request.should_not be_xhr
-            last_response.should be_ok
-            last_response.body.chomp.should == File.basename(file, '.haml')
+        Dir.glob "#{Dir.pwd}/views/**/*.haml" do |file|
+          filename = File.basename(file, '.haml').capitalize
+          
+          context "and with #{filename} static page" do
+            subject {file}
+            it {File.exist?(subject).should == true}
+            it "should render it." do
+              directory = File.dirname(subject)[5].nil? ? '' : File.dirname(subject)[5, File.dirname(subject).size]
+              path = "#{directory}/#{File.basename(subject, '.haml')}"
+              
+              [path, "#{path}/"].each do |route|
+                get route
+
+                last_request.should_not be_xhr
+                last_response.should be_ok
+                last_response.body.chomp.should == File.basename(subject, '.haml')
+              end
+            end
           end
         end
         
-        it "should render only the Not Found page if a given route can't find its static page on 'views/'." do
-          File.exist?("views/#{file_of('Layout')}.haml").should be_false
-          File.exist?("views/#{file_of('Do Not Exist')}.haml").should be_false
-
-          get "/#{file_of('Do Not Exist')}"
+        context 'and with a non-existing static page' do
+          subject {File.join app.views, "#{file_of('Do Not Exist')}.haml"}
+          it {File.exist?(subject).should == false}
+          it 'should render the Not Found page.' do
+            path = "/#{file_of('Do Not Exist')}"
+            
+            [path, "#{path}/"].each do |route|
+              get route
 
-          last_request.should_not be_xhr
-          last_response.should be_not_found
-          last_response.body.chomp.should == file_of('Not Found')
+              last_request.should_not be_xhr
+              last_response.should be_not_found
+              last_response.body.chomp.should == file_of('Not Found')
+            end
+          end
         end
       end
       
-      context "with Layout file" do
+      context "with Layout" do
         before :all do
-          create_file_for('Layout', 'views', ['Layout', '= yield'])
+          create_file_for('Layout', app.views, ['Layout', '= yield'])
         end
-
-        it "should render both the Layout and Home page if the given route is either empty or root." do
-          File.exist?("views/#{file_of('Layout')}.haml").should be_true
-          File.exist?("views/#{file_of('Home')}.haml").should be_true
-
-          ['/', ''].each do |route|
-            get route
-
-            last_request.should_not be_xhr
-            last_response.should be_ok
-            separate(last_response.body).first.should == 'Layout'
-            separate(last_response.body).last.should == file_of('Home')
+        
+        subject {File.join app.views, "#{file_of('Layout')}.haml"}
+        it {File.exist?(subject).should == true}
+        
+        context 'and with Home static page' do
+          subject {File.join app.views, "#{file_of('Home')}.haml"}
+          it {File.exist?(subject).should == true}
+          it 'should render both.' do
+            ['/', ''].each do |route|
+              get route
+
+              last_request.should_not be_xhr
+              last_response.should be_ok
+              separate(last_response.body).first.should == 'Layout'
+              separate(last_response.body).last.should == file_of('Home')
+            end
           end
         end
-
-        it "should render both the Layout and an existing page if the given route match the '/:page' or '/*/:page' patterns." do
-          Dir.glob('views/**/*.haml').reject{|file| file =~ /layout/}.each do |file|
-            File.exist?("views/#{file_of('Layout')}.haml").should be_true
-            File.exist?(file).should be_true
-
-            directory = File.dirname(file)[5].nil? ? '' : File.dirname(file)[5, File.dirname(file).size]
-
-            get "#{directory}/#{File.basename(file, '.haml')}"
-
-            last_request.should_not be_xhr
-            last_response.should be_ok
-            separate(last_response.body).first.should == 'Layout'
-            separate(last_response.body).last.should == File.basename(file, '.haml')
+        
+        Dir.glob "#{Dir.pwd}/views/**/*.haml" do |file|
+          filename = File.basename(file, '.haml').capitalize
+          
+          context "and with #{filename} static page" do
+            subject {file}
+            it {File.exist?(subject).should == true}
+            it "should render both." do
+              directory = File.dirname(subject)[5].nil? ? '' : File.dirname(subject)[5, File.dirname(subject).size]
+              path = "#{directory}/#{File.basename(subject, '.haml')}"
+              
+              [path, "#{path}/"].each do |route|
+                get route
+
+                last_request.should_not be_xhr
+                last_response.should be_ok
+                separate(last_response.body).first.should == 'Layout'
+                separate(last_response.body).last.should == File.basename(file, '.haml')
+              end
+            end
           end
         end
 
-        it "should render both the Layout and the Not Found page if a given route can't find its static page on 'views/'." do
-          File.exist?("views/#{file_of('Layout')}.haml").should be_true
-          File.exist?("views/#{file_of('Do Not Exist')}.haml").should be_false
-
-          get "/#{file_of('Do Not Exist')}"
-
-          last_request.should_not be_xhr
-          last_response.should be_not_found
-          separate(last_response.body).first.should == 'Layout'
-          separate(last_response.body).last.should == file_of('Not Found')
+        context 'and with a non-existing static page' do
+          subject {File.join app.views, "#{file_of('Do Not Exist')}.haml"}
+          it {File.exist?(subject).should == false}
+          it 'should render the Layout and the Not Found page.' do
+            path = "/#{file_of('Do Not Exist')}"
+            
+            [path, "#{path}/"].each do |route|
+              get route
+
+              last_request.should_not be_xhr
+              last_response.should be_not_found
+              separate(last_response.body).first.should == 'Layout'
+              separate(last_response.body).last.should == file_of('Not Found')
+            end
+          end
         end
 
         after :all do
-          FileUtils.rm 'views/layout.haml'
+          FileUtils.rm "#{app.views}/layout.haml"
         end
       end
     end
     
     context "in asynchronous mode" do
-      context "with no Layout file" do
-        it "should render just the Home page if the given route is either empty or root." do
-          File.exist?("views/#{file_of('Layout')}.haml").should be_false
-          File.exist?("views/#{file_of('Home')}.haml").should be_true
-
-          ['/', ''].each do |route|
-            request route, :method => 'GET', :xhr => true
-
-            last_request.should be_xhr
-            last_response.should be_ok
-            last_response.body.chomp.should == file_of('Home')
+      context 'with no Layout' do
+        subject {File.join app.views, "#{file_of('Layout')}.haml"}
+        it {File.exist?(subject).should == false}
+        
+        context 'and with Home static page' do
+          subject {File.join app.views, "#{file_of('Home')}.haml"}
+          it {File.exist?(subject).should == true}
+          it 'should render it.' do
+            ['/', ''].each do |route|
+              request route, :method => 'GET', :xhr => true
+
+              last_request.should be_xhr
+              last_response.should be_ok
+              last_response.body.chomp.should == file_of('Home')
+            end
           end
         end
         
-        it "should render just an existing page if the given route match the '/:page' or '/*/:page' patterns." do
-          Dir.glob 'views/**/*.haml' do |file|
-            File.exist?("views/#{file_of('Layout')}.haml").should be_false
-            File.exist?(file).should be_true
-
-            directory = File.dirname(file)[5].nil? ? '' : File.dirname(file)[5, File.dirname(file).size]
-
-            request "#{directory}/#{File.basename(file, '.haml')}", :method => 'GET', :xhr => true
-
-            last_request.should be_xhr
-            last_response.should be_ok
-            last_response.body.chomp.should == File.basename(file, '.haml')
+        Dir.glob "#{Dir.pwd}/views/**/*.haml" do |file|
+          filename = File.basename(file, '.haml').capitalize
+          
+          context "and with #{filename} static page" do
+            subject {file}
+            it {File.exist?(subject).should == true}
+            it "should render it." do
+              directory = File.dirname(subject)[5].nil? ? '' : File.dirname(subject)[5, File.dirname(subject).size]
+              path = "#{directory}/#{File.basename(subject, '.haml')}"
+              
+              [path, "#{path}/"].each do |route|
+                request route, :method => 'GET', :xhr => true
+
+                last_request.should be_xhr
+                last_response.should be_ok
+                last_response.body.chomp.should == File.basename(subject, '.haml')
+              end
+            end
           end
         end
         
-        it "should render just the Not Found page if a given route can't find its static page on 'views/." do
-          File.exist?("views/#{file_of('Layout')}.haml").should be_false
-          File.exist?("views/#{file_of('Do Not Exist')}.haml").should be_false
-
-          request "/#{file_of('Do Not Exist')}", :method => 'GET', :xhr => true
+        context 'and with a non-existing static page' do
+          subject {File.join app.views, "#{file_of('Do Not Exist')}.haml"}
+          it {File.exist?(subject).should == false}
+          it 'should render the Not Found page.' do
+            path = "/#{file_of('Do Not Exist')}"
+            
+            [path, "#{path}/"].each do |route|
+              request route, :method => 'GET', :xhr => true
 
-          last_request.should be_xhr
-          last_response.should be_not_found
-          last_response.body.chomp.should == file_of('Not Found')
+              last_request.should be_xhr
+              last_response.should be_not_found
+              last_response.body.chomp.should == file_of('Not Found')
+            end
+          end
         end
       end
       
-      context "with a Layout file" do
+      context 'with a Layout' do
         before :all do
-          create_file_for('Layout', 'views', ['Layout', '= yield'])
+          create_file_for('Layout', app.views, ['Layout', '= yield'])
         end
-
-        it "should render both the Layout and Home page if the given route is either empty or root." do
-          File.exist?("views/#{file_of('Layout')}.haml").should be_true
-          File.exist?("views/#{file_of('Home')}.haml").should be_true
-
-          ['/', ''].each do |route|
-            request route, :method => 'GET', :xhr => true
-
-            last_request.should be_xhr
-            last_response.should be_ok
-            last_response.body.chomp.should == file_of('Home')
+        
+        subject {File.join app.views, "#{file_of('Layout')}.haml"}
+        it {File.exist?(subject).should == true}
+        
+        context 'and with Home static page' do
+          subject {File.join app.views, "#{file_of('Home')}.haml"}
+          it {File.exist?(subject).should == true}
+          it 'should render it.' do
+            ['/', ''].each do |route|
+              request route, :method => 'GET', :xhr => true
+
+              last_request.should be_xhr
+              last_response.should be_ok
+              last_response.body.chomp.should == file_of('Home')
+            end
           end
         end
-
-        it "should render both the Layout and an existing page if the given route match the '/:page' or '/*/:page' patterns." do
-          Dir.glob('views/**/*.haml').reject{|file| file =~ /layout/}.each do |file|
-            File.exist?("views/#{file_of('Layout')}.haml").should be_true
-            File.exist?(file).should be_true
-
-            directory = File.dirname(file)[5].nil? ? '' : File.dirname(file)[5, File.dirname(file).size]
-
-            request "#{directory}/#{File.basename(file, '.haml')}", :method => 'GET', :xhr => true
-
-            last_request.should be_xhr
-            last_response.should be_ok
-            last_response.body.chomp.should == File.basename(file, '.haml')
+        
+        Dir.glob "#{Dir.pwd}/views/**/*.haml" do |file|
+          filename = File.basename(file, '.haml').capitalize
+          
+          context "and with #{filename} static page" do
+            subject {file}
+            it {File.exist?(subject).should == true}
+            it "should render both." do
+              directory = File.dirname(subject)[5].nil? ? '' : File.dirname(subject)[5, File.dirname(subject).size]
+              path = "#{directory}/#{File.basename(subject, '.haml')}"
+              
+              [path, "#{path}/"].each do |route|
+                request route, :method => 'GET', :xhr => true
+
+                last_request.should be_xhr
+                last_response.should be_ok
+                last_response.body.chomp.should == File.basename(file, '.haml')
+              end
+            end
           end
         end
 
-        it "should render both the Layout and the Not Found page if a given route can't find its static page on 'views/'." do
-          File.exist?("views/#{file_of('Layout')}.haml").should be_true
-          File.exist?("views/#{file_of('Do Not Exist')}.haml").should be_false
-
-          request "/#{file_of('Do Not Exist')}", :method => 'GET', :xhr => true
+        context 'and with a non-existing static page' do
+          subject {File.join app.views, "#{file_of('Do Not Exist')}.haml"}
+          it {File.exist?(subject).should == false}
+          it 'should render the Layout and the Not Found page.' do
+            path = "/#{file_of('Do Not Exist')}"
+            
+            [path, "#{path}/"].each do |route|
+              request route, :method => 'GET', :xhr => true
 
-          last_request.should be_xhr
-          last_response.should be_not_found
-          last_response.body.chomp.should == file_of('Not Found')
+              last_request.should be_xhr
+              last_response.should be_not_found
+              last_response.body.chomp.should == file_of('Not Found')
+            end
+          end
         end
 
         after :all do
-          FileUtils.rm 'views/layout.haml'
+          FileUtils.rm "#{app.views}/layout.haml"
         end
       end
     end
-  end
-
-  after :all do
-    FileUtils.rm_r 'views', :force => true
+    
+    after :all do
+      FileUtils.rm_r app.views, :force => true
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-pages
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: false
   segments: 
   - 1
-  - 2
+  - 3
   - 0
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Julio Javier Cicchelli
@@ -98,7 +98,7 @@ dependencies:
         version: 0.5.4
   type: :development
   version_requirements: *id005
-description: "    A Sinatra extension for static pages rendering.\n"
+description: "    A Sinatra extension for static pages rendering using the HAML rendering engine.\n"
 email: javier@rock-n-code.com
 executables: []