sinatra-pages 1.4.0 → 1.5.0

data/README.markdown

@@ -1,5 +1,5 @@
 # Sinatra Pages
-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.
+This is a [Sinatra][1] extension that renders any static page (including sub-pages) located under your *:pages* directory  using [HAML][2] and [SASS][3] as the rendering engines for HTML and stylesheets. 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][4] in no time.
 
 ### Installation
 In order to install this gem, you just need to install the gem from your command line like this:
@@ -9,7 +9,9 @@ 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][1]
+* [tilt][13]
 * [haml][2]
+* [sass][3]
 
 ### Usage
 Before using this extension, you should create the following file structure inside your application.
@@ -24,10 +26,8 @@ Before using this extension, you should create the following file structure insi
               |- ...
           |- styles/
               |- ...
-     |- views/
+     |- pages/
           |- home.haml
-          |- layout.haml
-          |- not_found.haml
           |- a_file.haml
           |- another_file.haml
           |- ...
@@ -37,8 +37,11 @@ Before using this extension, you should create the following file structure insi
                   |- yet_another_file/
                             |- still_another_file.haml
                             |- ...
+     |- views/
+          |- layout.haml
+          |- not_found.haml
 
-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.
+Please notice that this extension requires you to create the *layout.haml* (if required) and other common pages inside your *:views* directory on your application. Then you're free to add the static pages you need under any file structure hierarchy inside the *:pages* 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.
 
@@ -81,15 +84,16 @@ You can try your modular application by executing the following command in your
 In order to verify if you application is working, open your web browser with the address that will appear after the execution described above.
 
 ### Built-in variables
-This extension have a default configuration that assumes the __:views__ and __:public__ configuration are located on the *./views* and *./public* directories respectively. As well, it preset the __:html__ version to use as *:v5*, the way to __:format__ the HTML code as *:tidy* and the HTML __:escaping__ is disabled by default.
-
-In any case, you are able to change these values as required.
+This extension defines the following setup as default. In any case, you are able to change these values as required.
 
-* __:views__ => <*Path to your views directory*>
-* __:public__ => <*Path to your public directory*>
-* __:html__ => [*:v4*, *:vX*, *:v5*]
-* __:format__ => [*:tidy*, *:ugly*]
-* __:escaping__ => [*true*, *false*]
+* __:public__ => <*Path to your public directory*> || **settings.root/public**
+* __:views__ => <*Path to your views directory*> || **settings.root/views**
+* __:pages__ => <*Path to your pages directory*> || **settings.root/views**
+* __:html__ => [*:v4*, *:vX*, *:v5*] || **:v5**
+* __:stylesheet__ => [*:css*, *:sass*, *:scss*] || **:scss**
+* __:format__ => [*:tidy*, *:ugly*] || **:tidy**
+* __:cache__ => [*:write*, *:read*] || **:write**
+* __:escaping__ => [*true*, *false*] || **:false**
 
 ### Customization
 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.
@@ -130,35 +134,37 @@ Everybody is welcome to contribute to this project by commenting the source code
 
 In case you would like to contribute on this library, here's the list of extra dependencies you would need:
 
-* [rspec][4]
-* [rcov][5]
-* [rack-test][6]
+* [rspec][5]
+* [rcov][6]
+* [rack-test][7]
 
 ### Contributors
-* [Julio Javier Cicchelli][7]
+* [Julio Javier Cicchelli][8]
 
 ### Sites
 The following sites are proudly using this extension:
 
-* [Rock & Code][10]
-* [Izcheznali][11]
+* [Rock & Code][11]
+* [Izcheznali][12]
 
 If your site is also using this extension, please let us know!
 
 ### Notes
-This extension have been tested on the versions 1.8.6, 1.8.7 and 1.9.1 of the [Ruby interpreter][8].
+This extension have been tested on the versions 1.8.6, 1.8.7 and 1.9.1 of the [Ruby interpreter][9].
 
 ### License
-This extension is licensed under the [MIT License][9].
+This extension is licensed under the [MIT License][10].
 
 [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
-[7]: http://github.com/mr-rock
-[8]: http://www.ruby-lang.org/en/
-[9]: http://creativecommons.org/licenses/MIT/
-[10]: http://rock-n-code.com
-[11]: http://izcheznali.net
+[3]: http://sass-lang.com/
+[4]: http://rack.rubyforge.org/
+[5]: http://rspec.info/
+[6]: http://eigenclass.org/hiki/rcov
+[7]: http://gitrdoc.com/brynary/rack-test/tree/master
+[8]: http://github.com/mr-rock
+[9]: http://www.ruby-lang.org/en/
+[10]: http://creativecommons.org/licenses/MIT/
+[11]: http://rock-n-code.com
+[12]: http://izcheznali.net
+[13]: http://github.com/rtomayko/tilt

data/lib/sinatra/pages.rb

@@ -1,24 +1,51 @@
 require 'sinatra/base'
 require 'haml'
+require 'sass'
 
 module Sinatra
   module Pages
     def self.registered(app)
+      app.configure do
+        app.set :root, Dir.pwd
+        app.enable :static
+      end
+
+      app.set :pages, Proc.new {File.join app.root, %w[pages]}
+      app.set :styles, Proc.new {find_styles_directory app.public}
       app.set :html, :v5
+      app.set :stylesheet, :scss
+      app.set :cache, :write
       app.set :format, :tidy
       app.disable :escaping
       
       app.configure do
-        app.set :root, Dir.pwd
-        app.set :haml, Proc.new {setup(app)}
-        app.enable :static
+        app.set :haml, Proc.new {generate_setup :haml, app}
+        app.set :sass, Proc.new {generate_setup :sass, app}
       end
+      
+      unless app.stylesheet == :css
+        app.get '/*.css' do
+          content_type :css, :charset => 'utf-8'
 
+          sass File.basename(params[:splat].first).to_sym, :views => settings.styles
+        end
+      end
+      
+      app.before do
+        unless settings.views == settings.pages
+          unless File.exist?(File.join settings.views, settings.pages.split('/').last)
+            FileUtils.ln_s settings.pages, settings.views \
+              if (File.exist?(settings.views) && File.exist?(settings.pages))
+          end
+        end
+      end
+      
       %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 = settings.views != settings.pages ? "#{settings.pages.split('/').last}/" : ''
+          page_to_render << "#{params[:splat].first}/" unless params[:splat].nil?
           page_to_render << params[:page]
 
           begin
@@ -38,19 +65,43 @@ module Sinatra
 
     private
     
-    def setup(app)
-      options = {:format => nil, :ugly => nil, :escape_html => nil}
-
-      options[:ugly] = app.format == :ugly ? true : false
-      options[:escape_html] = app.escaping
-      options[:format] = case app.html
-        when :v5 then :html5
-        when :v4 then :html4
-        when :vX then :xhtml
+    def generate_setup(type, settings)
+      options = {}
+      
+      case type
+        when :haml
+          options[:ugly] = settings.format == :ugly ? true : false
+          options[:escape_html] = settings.escaping
+          options[:format] = case settings.html
+            when :v5 then :html5
+            when :v4 then :html4
+            when :vX then :xhtml
+          end
+        when :sass
+          options[:style] = settings.format == :tidy ? :expanded : :compressed
+          options[:syntax] = settings.stylesheet
+          options[:cache] = true if settings.cache == :write
+          options[:read_cache] = true if settings.cache == :read
       end
       
       options
     end
+    
+    def find_styles_directory(public_directory)
+      %w[*.css *.scss *.sass].each do |extension|
+        files = Dir.glob File.join(public_directory, '**', extension)
+
+        return File.dirname(files.first) unless files.empty? 
+      end
+
+      %w[css styles stylesheets].each do |directory| 
+        directory = File.join public_directory, directory
+
+        return directory if File.exist?(directory)
+      end
+
+      nil
+    end
   end
   
   register Pages

data/spec/pages_spec.rb

@@ -8,12 +8,13 @@ describe Sinatra::Pages do
     TestApp
   end
 
-  context 'built-in settings' do
+  context 'Directories settings' do
     context 'by default' do
       subject {app}
       its(:root) {should == Dir.pwd}
       its(:public) {should == File.join(Dir.pwd, 'public')}
       its(:views) {should == File.join(Dir.pwd, 'views')}
+      its(:pages) {should == File.join(Dir.pwd, 'pages')}
       its(:static) {should == true} 
     end
 
@@ -25,6 +26,7 @@ describe Sinatra::Pages do
         its(:root) {should == File.dirname(__FILE__)}
         its(:public) {should == File.join(File.dirname(__FILE__), 'public')}
         its(:views) {should == File.join(File.dirname(__FILE__), 'views')}
+        its(:pages) {should == File.join(File.dirname(__FILE__), 'pages')}
         its(:static) {should == true}
       end
 
@@ -33,6 +35,7 @@ describe Sinatra::Pages do
         its(:root) {should == Dir.pwd}
         its(:public) {should == File.join(File.dirname(__FILE__), 'public')}
         its(:views) {should == File.join(Dir.pwd, 'views')}
+        its(:pages) {should == File.join(Dir.pwd, 'pages')}
         its(:static) {should == true}
       end
 
@@ -41,6 +44,17 @@ describe Sinatra::Pages do
         its(:root) {should == Dir.pwd}
         its(:public) {should == File.join(Dir.pwd, 'public')}
         its(:views) {should == File.join(File.dirname(__FILE__), 'views')}
+        its(:pages) {should == File.join(Dir.pwd, 'pages')}
+        its(:static) {should == true}
+      end
+      
+      context '#pages' do
+        before {app.set :root, Dir.pwd}
+        subject {app.set :pages, File.join(File.dirname(__FILE__), 'pages')}
+        its(:root) {should == Dir.pwd}
+        its(:public) {should == File.join(Dir.pwd, 'public')}
+        its(:views) {should == File.join(Dir.pwd, 'views')}
+        its(:pages) {should == File.join(File.dirname(__FILE__), 'pages')}
         its(:static) {should == true}
       end
     end
@@ -62,25 +76,78 @@ describe Sinatra::Pages do
         app.disable :escaping
       end
       
-      [:v4, :vX].each do |value|
+      [:v4, :vX].each do |html|
         context '#html' do
-          subject {app.set :html, value}
-          its(:html) {should == value}
-          it {subject.haml[:format].should == (value == :v4 ? :html4 : :xhtml)}
+          subject {app.set :html, html}
+          its(:html) {should == html}
+          it {subject.haml[:format].should == (html == :v4 ? :html4 : :xhtml)}
+        end
+      end
+      
+      [:tidy, :ugly].each do |format|
+        context '#format' do
+          subject {app.set :format, format}
+          its(:format) {should == format}
+          it {subject.haml[:ugly].should == (format == :ugly ? true : false)}
+        end
+      end
+      
+      [true, false].each do |escaping|
+        context '#escaping' do
+          #subject {app.enable :escaping}
+          subject {app.set :escaping, escaping}
+          its(:escaping) {should == escaping}
+          it {subject.haml[:escape_html].should == escaping}
+        end
+      end
+    end
+  end
+  
+  context 'SASS settings' do
+    context 'by default' do
+      subject {app}
+      its(:stylesheet) {should == :scss}
+      its(:format) {should == :tidy}
+      its(:cache) {should == :write}
+      its(:sass) {should == {:style => :expanded, :syntax => :scss, :cache => true}}
+    end
+    
+    context 'on defining' do
+      before do
+        app.set :stylesheet, :css
+        app.set :format, :tidy
+        app.set :cache, :write
+      end
+      
+      [:css, :sass, :scss].each do |stylesheet|
+        context '#stylesheet' do
+          subject {app.set :stylesheet, stylesheet}
+          its(:stylesheet) {should == stylesheet}
+          it {subject.sass[:syntax].should == stylesheet}
         end
       end
       
-      context '#format' do
-        subject {app.set :format, :ugly}
-        its(:format) {should == :ugly}
-        it {subject.haml[:ugly].should == true}
+      [:tidy, :ugly].each do |format|
+        context '#format' do
+          subject {app.set :format, format}
+          its(:format) {should == format}
+          format == :tidy ? it {subject.sass[:style].should == :expanded} :
+                            it {subject.sass[:style].should == :compressed}
+        end
       end
       
-      context '#escaping' do
-        #subject {app.enable :escaping}
-        subject {app.set :escaping, true}
-        its(:escaping) {should == true}
-        it {subject.haml[:escape_html].should == true}
+      [:write, :read].each do |cache|
+        context '#cache' do
+          subject {app.set :cache, cache}
+          its(:cache) {should == cache}
+          if cache == :write
+            it {subject.sass[:cache].should == true}
+            it {subject.sass[:read_cache].should == nil}
+          else
+            it {subject.sass[:cache].should == nil}
+            it {subject.sass[:read_cache].should == true}
+          end
+        end
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-pages
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: false
   segments: 
   - 1
-  - 4
+  - 5
   - 0
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Julio Javier Cicchelli
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-05 00:00:00 +02:00
+date: 2010-08-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,9 +35,25 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: haml
+  name: tilt
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -49,11 +65,11 @@ dependencies:
         - 15
         version: 3.0.15
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -65,11 +81,11 @@ dependencies:
         - 0
         version: 1.3.0
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rcov
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -81,11 +97,11 @@ dependencies:
         - 8
         version: 0.9.8
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rack-test
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -97,7 +113,7 @@ dependencies:
         - 4
         version: 0.5.4
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: "    A Sinatra extension for static pages rendering using the HAML rendering engine.\n"
 email: javier@rock-n-code.com
 executables: []