soxer 0.9.10 → 0.9.11

data/CHANGES

@@ -1,4 +1,28 @@
-= 0.9.10 / 2011-03-21
+= 0.9.11 / 2011-04-30
+  
+  * Fixed relative paths in config.ru for app requirement.
+  
+  * Fixed scoping inside classes. This was a severe bug.
+    It's a mistery how it worked until sinatra 1.2.3...
+  
+  * Deleted unneeded classes.
+  
+  * Added initialization to objects.
+  
+  * Properly modularized Soxer. There are now no global settings that
+    Soxer uses
+  
+  * Soxer sets up several application speciffic directories, which can be
+    changed inside SoxerApp.
+    
+  * Setting up the root of application is now mandatory.
+  
+  * Changed and cleaned skeletal application's app.rb and config.ru files
+    to reflect the new modularity.
+  
+  * Renamed config.yml to config.yml.example, added cosmetic fixes to it.
+  
+= 0.9.10 / 2011-03-22
   
   * The function get_list now returns an array of hashies. This was a severe
     inconsistency.
@@ -9,6 +33,8 @@
   * Completely rewritten inclusion of empty directories to facilitate a more
     flexible skeleton project creation.
   
+  * Added a blog skeleton to the list of project skeletons.
+  
 = 0.9.9 / 2011-03-03
 
   * Changed the names of Classes to match CamelCase convention in Ruby

data/lib/soxer/main.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
-
 require 'hashie'
 require 'sinatra/base'
 require 'yaml'
 require 'haml'
+require 'sass'
 require 'uuid'
 
 #== Sinatra, web publishing DSL
@@ -24,7 +24,7 @@ module Sinatra
   # Copyright: Copyright (c) 1010 Toni Anzlovar, www.formalibre.si
   # License:   Distributed under the GPL licence. http://www.gnu.org/licenses/gpl.html
   module Soxer
-    
+
     # === The FileReader class
     #
     # FileReader is responsible for reading a YAML file, that contains the
@@ -36,25 +36,22 @@ module Sinatra
     # if the fields are not present, they are automatically generated and
     # saved in the file.
     class FileReader
-      # The name of the YAML file
+
       attr_accessor :filename
       
-      # The standard Sinatra application settings, recieved from sinatra/base.
-      # These settings are configurable in __./config.ru__ file in the application
-      # directory.
-      def settings
-        @s = Sinatra::Application
+      def initialize filename, settings
+        @f, @s = filename, settings
       end
       
-      # The method, that retuns the YAML structure in a ::hash::.
+      # The method, that retuns the YAML structure in a ::hashie hash::.
+      # Hashie makes the hash keys accessible either strings, symbols or methods.
       def get_content
-        self.settings
-        out = YAML.load_file( @filename )
+        out = YAML.load_file( @f )
         add_date unless out['date']
         add_id unless out['uuid']
-        out['url'] = @filename.gsub(/#{@s.origin}(.+)\.yaml$/, "\\1" ).gsub(/(.+)\/index$/, "\\1" )
-        out['mtime'] =  File.mtime( @filename )
-        out
+        out['url'] = @f.gsub(/#{@s.origin}\/(.+)\.yaml$/, "\\1" ).gsub(/(.+)\/index$/, "\\1" )
+        out['mtime'] =  File.mtime( @f )
+        Hashie::Mash.new out
       end
       
       private
@@ -63,18 +60,18 @@ module Sinatra
       # Identifier field to the data structure.
       def add_id
         mtime = File.mtime( @filename )
-        File.open( @filename, 'r+' ) do |f|
+        File.open( @f, 'r+' ) do |f|
           out = "uuid: #{UUID.new.generate}\n"
           out << f.read; f.pos =  0
           f << out
         end
-        File.utime( 0, mtime, @filename )
+        File.utime( 0, mtime, @f )
       end
       
       # A private method, that adds a standard Time.now to the data structure.
       def add_date
-        mtime = File.mtime( @filename )
-        File.open( @filename, 'r+' ) do |f|
+        mtime = File.mtime( @f )
+        File.open( @f, 'r+' ) do |f|
           out = "date: #{mtime.xmlschema}\n"
           out << f.read; f.pos =  0
           f << out
@@ -89,53 +86,22 @@ module Sinatra
     # (the default is "content" directory within application root) or a 
     # directory path with index.yaml
     class UrlReader
-
-      # Url, recieved from the request
+    
       attr_accessor :url
-
-      # The standard Sinatra application settings, recieved from sinatra/base.
-      # These settings are configurable in __./config.ru__ file in the application
-      # directory.
-      def settings
-        @s = Sinatra::Application
+      
+      def initialize url, settings
+        @url, @s = url, settings
       end
       
       # Creates a FileReader instance, maps the url to either yaml file or 
       # index.yaml within a directory represented by url.
       def get_content
-        self.settings
         fn = case true
              when File.exist?( f = File.join( @s.origin, @url+'.yaml' ) ) then f
              when File.exist?( f = File.join( @s.origin, @url+'/index.yaml' ) ) then f
              else throw :halt, [404, "Document not found"]
              end
-        out = FileReader.new
-        out.filename = fn
-        out.get_content
-      end
-    end
-    
-    # === The DocumentStore class
-    #
-    # DocumentStore class extends the hash to enable document attribute access
-    # in one of three ways:
-    # hash key:    page['key'] => value
-    # method call: page.key => value
-    # symbol:      page[:key] => value
-    class Document < Hash
-      def initialize(attrs)
-        attrs.each do |k, v|
-          self[k] = v
-        end
-      end
-    
-      def []=(k, v)
-        unless respond_to?(k)
-          self.class.send :define_method, k do
-            self[k]
-          end
-        end
-        super
+        FileReader.new(fn, @s).get_content
       end
     end
     
@@ -143,6 +109,7 @@ module Sinatra
     # 
     # This module introduces several helper methods to Soxer application.
     module Helpers
+
       # === Document reader
       # This method reads a yaml file from disk and returns a hash.
       # 
@@ -154,9 +121,7 @@ module Sinatra
       # [=> Hash]
       #   A hash representation of yaml file.
       def get_page url=params[:splat][0]
-        out = UrlReader.new
-        out.url = url
-        Hashie::Mash.new out.get_content
+        UrlReader.new(url, options).get_content
       end
   
       # === Document list generator method
@@ -170,15 +135,14 @@ module Sinatra
       # [=> Array]
       #   Array of hashes representing yaml files.
       def get_list &block 
-        fileset= Dir.glob File.join( settings.origin, "**", "*.yaml" )
+        fileset= Dir.glob File.join( options.origin, "**", "*.yaml" )
         fileset.delete_if {|d| (d=~/\/index.yaml$/ and fileset.include? d[0..-12]+'.yaml') }
         output = fileset.map! do |f|
-          file = FileReader.new
-          file.filename = f
+          file = FileReader.new f, options
           if block_given?
-            f = block.call Hashie::Mash.new( file.get_content )
+            f = block.call file.get_content
           else
-            f = Hashie::Mash.new file.get_content
+            f = file.get_content
           end
         end.compact
       end
@@ -345,18 +309,20 @@ module Sinatra
       
     end
     
-    def self.registered(app) #:nodoc: all
-      app.helpers Soxer::Helpers
+    def self.registered(app)
       
-      def app.settings 
-        Sinatra::Application
+      if app.settings.root then
+        app.set :origin, File.join(app.settings.root, 'content') unless app.settings.respond_to? 'content'
+        app.set :public, File.join(app.settings.root, 'public') unless app.settings.respond_to? 'public'
+        app.set :views, File.join(app.settings.root, 'views') unless app.settings.respond_to? 'views'
+        app.set :log, File.join(app.settings.root, 'log') unless app.settings.respond_to? 'log'
       end
       
-      set :origin, File.join(app.settings.root, 'content')
+      app.helpers Soxer::Helpers
       
-      mime_type :otf, 'application/x-font-TrueType'
-      mime_type :ttf, 'application/x-font-TrueType'
-      mime_type :eot, 'application/vnd.ms-fontobject'
+      app.mime_type :otf, 'application/x-font-TrueType'
+      app.mime_type :ttf, 'application/x-font-TrueType'
+      app.mime_type :eot, 'application/vnd.ms-fontobject'
       
       app.get("/sitemap.xml") { sitemap }
 
@@ -364,7 +330,7 @@ module Sinatra
 				content_type "text/html", :charset => "utf-8"
 				url = params[:captures][0]
 				type = params[:captures][1]
-				file = File.join settings.origin, url
+				file = File.join app.settings.origin, url
 				
 				case type
 					when 'yaml' then 
@@ -374,9 +340,9 @@ module Sinatra
 						send_file(file, :disposition => nil) if File.exist? file
 						throw :halt, [404, "Document not found"]if  !File.exist? file
 						
-					when /^css$/i then 
-						content_type "text/css", :charset => "utf-8"
-					  sass url.sub('.'+type, '').to_sym
+					when /^css$/i then
+            content_type "text/css", :charset => "utf-8"
+            sass url.sub('.'+type, '').to_sym
 					  
 					when 'atom' then 
 						content_type "application/atom+xml", :charset => "utf-8"
@@ -385,7 +351,6 @@ module Sinatra
 						haml page['content'], :layout => layout,
 																  :format => :xhtml,
 						                      :locals => { :page => page }
-						
 
 					when 'rss' then 
 						'RSS is not supported yet'
@@ -397,9 +362,9 @@ module Sinatra
       app.get '*/?' do
         content_type "text/html", :charset => "utf-8"
         page = get_page
-        page['layout'] ||= 'layout'
-        page['layout'] == 'false' ? layout = false : layout = page['layout'].to_sym
-        haml page['content'], :layout => layout, :locals => { :page => page }
+        page.layout ||= 'layout'
+        page.layout == 'false' ? layout = false : layout = page.layout.to_sym
+        haml page.content, :layout => layout, :locals => { :page => page }
       end
       
     end
@@ -407,4 +372,3 @@ module Sinatra
   
   register Soxer
 end
-

data/lib/soxer/skel/blog/app.rb

@@ -1,9 +1,12 @@
 # encoding: utf-8
 require "rubygems"
-require "sinatra"
+require "sinatra/base"
 require "soxer"
 
 class SoxerApp < Sinatra::Base
+  set :root, File.dirname(__FILE__)
+  set :haml, {:format => :html5, 
+              :attr_wrapper => '"'}
   enable :sessions
   before do
     session[:theme] ||= %w[dna blossom][rand 1]

data/lib/soxer/skel/blog/config.ru

@@ -1,25 +1,5 @@
-require "rubygems"
-require "sinatra/base"
-require "app"
+# encoding: utf-8
+require "sinatra"
+require "./app"
 
-disable :run
-set :server, %w[thin mongrel webrick]
-set :haml, {:format => :html5, 
-            :attr_wrapper => '"'}
-set :haml, {:encoding => 'utf-8'} if RUBY_VERSION=~/1\.9/
-
-configure :development do
-  require 'sinatra/reloader'
-  set :port, 9394
-end
-
-configure :production do
-  set :haml, {:ugly => true}
-  set :port, 55500
-end
-
-set :environment, :production
-
-map '/' do
-  run SoxerApp
-end
+run SoxerApp

data/lib/soxer/skel/blog/{config.yml → config.yml.example}

@@ -2,8 +2,8 @@
   environment: production
   chdir: /path/to/your/application/home/dir
   address: 0.0.0.0
-  user: toni
-  group: toni
+  user: username
+  group: username
   port: 55500
   pid: /path/to/your/application/home/dir/log/thin.pid
   log: /path/to/your/application/home/dir/log/thin.log

data/lib/soxer/skel/blog/views/_block_history.haml

@@ -13,7 +13,7 @@
 .block
   %h2 History
   .content
-    h4 This block is currently not working properly.
+    %h4 This block is currently not working properly.
     %ul
       -history.each_pair do |y,m|
         -m.each_pair do |mm,dd|

data/lib/soxer/skel/empty/app.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 require "rubygems"
-require "sinatra"
+require "sinatra/base"
 require "soxer"
 
 class SoxerApp < Sinatra::Base
+  set :root, File.dirname(__FILE__)
   register Sinatra::Soxer
-
 end

data/lib/soxer/skel/empty/config.ru

@@ -1,25 +1,5 @@
-require "rubygems"
-require "sinatra/base"
-require "app"
+# encoding: utf-8
+require "sinatra"
+require "./app"
 
-disable :run
-set :server, %w[thin mongrel webrick]
-set :haml, {:format => :html5, 
-            :attr_wrapper => '"'}
-set :haml, {:encoding => 'utf-8'} if RUBY_VERSION=~/1\.9/
-
-configure :development do
-  require 'sinatra/reloader'
-  set :port, 9394
-end
-
-configure :production do
-  set :haml, {:ugly => true}
-  set :port, 55500
-end
-
-set :environment, :production
-
-map '/' do
-  run SoxerApp
-end
+run SoxerApp

data/lib/soxer/skel/empty/{config.yml → config.yml.example}

@@ -2,8 +2,8 @@
   environment: production
   chdir: /path/to/your/application/home/dir
   address: 0.0.0.0
-  user: toni
-  group: toni
+  user: username
+  group: username
   port: 55500
   pid: /path/to/your/application/home/dir/log/thin.pid
   log: /path/to/your/application/home/dir/log/thin.log

data/soxer.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.7'
 
   s.name              = 'soxer'
-  s.version           = '0.9.10'
-  s.date              = '2011-03-21'
+  s.version           = '0.9.11'
+  s.date              = '2011-04-30'
   s.rubyforge_project = 'soxer'
 
   s.summary     = "Dynamic web site generator engine"

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: soxer
 version: !ruby/object:Gem::Version 
-  hash: 47
   prerelease: false
   segments: 
   - 0
   - 9
-  - 10
-  version: 0.9.10
+  - 11
+  version: 0.9.11
 platform: ruby
 authors: 
 - Toni Anzlovar
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-21 00:00:00 +01:00
+date: 2011-04-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
         segments: 
         - 1
         version: "1"
@@ -40,7 +38,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 3
         version: "3"
@@ -54,7 +51,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 2
         version: "2"
@@ -68,7 +64,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
@@ -84,7 +79,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
         segments: 
         - 0
         - 5
@@ -107,47 +101,45 @@ files:
 - bin/soxer
 - lib/soxer.rb
 - lib/soxer/main.rb
-- lib/soxer/views/atom.haml
-- lib/soxer/views/sitemap.haml
-- lib/soxer/views/disqus.haml
 - lib/soxer/views/atom_layout.haml
+- lib/soxer/views/disqus.haml
 - lib/soxer/views/google_analytics.haml
-- lib/soxer/views/google_ads.haml
+- lib/soxer/views/atom.haml
 - lib/soxer/views/breadcrumb.haml
-- lib/soxer/skel/blog/content/index.yaml
-- lib/soxer/skel/blog/content/blog/2010-09-06-lorem_ipsum.yaml
-- lib/soxer/skel/blog/content/blog/2010-11-24-what_is_where.yaml
-- lib/soxer/skel/blog/content/blog/2010-10-12-how_to_spend_your_time_wisely.yaml
-- lib/soxer/skel/blog/content/blog/2010-04-16-ecce_quomdo_moritur_iustus.yaml
-- lib/soxer/skel/blog/content/blog/2009-06-02-meum_est_propositum.yaml
-- lib/soxer/skel/blog/content/blog.atom.yaml
-- lib/soxer/skel/blog/content/categories/index.yaml
-- lib/soxer/skel/blog/SETUP.rb
-- lib/soxer/skel/blog/public/css/dna/sequence.jpg
-- lib/soxer/skel/blog/public/css/blossom/blossom.jpg
-- lib/soxer/skel/blog/public/fonts/trashed.ttf
-- lib/soxer/skel/blog/public/fonts/GeosansLight.ttf
-- lib/soxer/skel/blog/config.yml
-- lib/soxer/skel/blog/config.ru
-- lib/soxer/skel/blog/views/_doc_short.haml
-- lib/soxer/skel/blog/views/layout.haml
+- lib/soxer/views/sitemap.haml
+- lib/soxer/views/google_ads.haml
+- lib/soxer/skel/blog/config.yml.example
 - lib/soxer/skel/blog/views/_block_history.haml
-- lib/soxer/skel/blog/views/css/common.sass
-- lib/soxer/skel/blog/views/css/trashed/css.sass
+- lib/soxer/skel/blog/views/_block_categories.haml
 - lib/soxer/skel/blog/views/css/dna/css.sass
 - lib/soxer/skel/blog/views/css/blossom/css.sass
-- lib/soxer/skel/blog/views/_block_categories.haml
-- lib/soxer/skel/blog/views/_block_about.haml
+- lib/soxer/skel/blog/views/css/common.sass
 - lib/soxer/skel/blog/views/_doc_docinfo.haml
 - lib/soxer/skel/blog/views/_block_recent.haml
+- lib/soxer/skel/blog/views/_doc_short.haml
+- lib/soxer/skel/blog/views/_block_about.haml
+- lib/soxer/skel/blog/views/layout.haml
+- lib/soxer/skel/blog/SETUP.rb
 - lib/soxer/skel/blog/app.rb
-- lib/soxer/skel/empty/content/index.yaml
-- lib/soxer/skel/empty/SETUP.rb
-- lib/soxer/skel/empty/config.yml
-- lib/soxer/skel/empty/config.ru
-- lib/soxer/skel/empty/views/layout.haml
+- lib/soxer/skel/blog/config.ru
+- lib/soxer/skel/blog/public/css/dna/sequence.jpg
+- lib/soxer/skel/blog/public/css/blossom/blossom.jpg
+- lib/soxer/skel/blog/public/fonts/GeosansLight.ttf
+- lib/soxer/skel/blog/content/blog.atom.yaml
+- lib/soxer/skel/blog/content/blog/2010-11-24-what_is_where.yaml
+- lib/soxer/skel/blog/content/blog/2010-09-06-lorem_ipsum.yaml
+- lib/soxer/skel/blog/content/blog/2010-04-16-ecce_quomdo_moritur_iustus.yaml
+- lib/soxer/skel/blog/content/blog/2010-10-12-how_to_spend_your_time_wisely.yaml
+- lib/soxer/skel/blog/content/blog/2009-06-02-meum_est_propositum.yaml
+- lib/soxer/skel/blog/content/index.yaml
+- lib/soxer/skel/blog/content/categories/index.yaml
+- lib/soxer/skel/empty/config.yml.example
 - lib/soxer/skel/empty/views/css/css.sass
+- lib/soxer/skel/empty/views/layout.haml
+- lib/soxer/skel/empty/SETUP.rb
 - lib/soxer/skel/empty/app.rb
+- lib/soxer/skel/empty/config.ru
+- lib/soxer/skel/empty/content/index.yaml
 has_rdoc: true
 homepage: http://soxer.mutsu.org
 licenses: []
@@ -162,7 +154,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -171,7 +162,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"

data/lib/soxer/skel/blog/views/css/trashed/css.sass

@@ -1,152 +0,0 @@
-/*
-  -----------------------------------------------------------------------------
-  Trashed Blog Theme for Soxer | http://soxer.mutsu.org
-  Copyright 2010 Toni Anzlovar, toni[at]formalibre.si
-  Attribution-ShareAlike 3.0 | http://creativecommons.org/licenses/by-sa/3.0/
-  -----------------------------------------------------------------------------
-@import "../common"
-
-
-// COLORS
-//-----------------------------------------------------------------------------
-$white: #ffffff
-$link: #375d9d
-$important: #375d9d
-$grey: #808080
-$lite: #dadada
-$normal: #4d4d4d
-
-// GENERAL
-//-----------------------------------------------------------------------------
-body
-  color: $normal
-  font:
-    size: 13px
-    family: "Trebuchet MS", Verdana, Arial, Helvetica, Swiss, Sans-Serif
-  margin: 0
-  padding: 0
-    
-a
-  color: $important
-  text-decoration: none
-  @include corners(3)
-  
-  &:hover
-    color: $white
-    background: $important
-    padding: 0px 3px
-    margin: -0px -3px
-
-h1, h2, h3, h4, h5, h6
-  +n
-
-h1, h2
-  color: $grey
-  font:
-    family: GeoSans
-    weight: normal
-h1
-  font-size: 38px
-  margin:
-    bottom: 30px
-
-h2
-  font-size: 28px
-  a
-    @include corners(7)
-    &:hover
-      @include corners(0)
-      +n
-      color: $important
-      background: none
-      border-bottom: 1px solid $important
-
-hr
-  display: none
-
-// COMMON
-//-----------------------------------------------------------------------------
-body
-  background: url(/css/dna/sequence.jpg) center top no-repeat
-  // @include sh(inset 0px 0px 200px rgba(0, 0, 0, .25))
-  
-#header, #content
-  width: 750px
-  +center
-
-#header
-  height: 260px
-  color: $white
-  text-shadow: black 1px 1px 5px
-  .slogan
-    font:
-      family: GeoSans
-      size: 42px
-    
-    padding-top: 10px
-      
-#content
-  padding-top: 20px
-  &:after
-    +clear
-
-#footer
-  width: 100%
-  background: $lite
-  border-top: 1px solid $grey
-  margin-top: 30px
-  @include sh(inset 0px 0px 100px rgba(0, 0, 0, .25))
-  
-  .content
-    width: 750px
-    height: 180px
-    +center
-
-// MAIN & SIDEBAR
-//-----------------------------------------------------------------------------
-#main, #sidebar
-  float: left
-  min-height: 300px
-  
-#main
-  width: 464px
-  margin:
-    top: 10px
-    left: 286px
-
-  .short
-    margin-top: 30px
-    small
-      color: $grey
-      font:
-        style: italic
-        size: 13px
-    p
-      +n
-  .shot:after
-    +clear
-
-#sidebar
-  width: 272px
-  margin:
-    top: 19px
-    left: -750px
-
-// BLOCKS
-//-----------------------------------------------------------------------------
-.block
-  margin-bottom: 20px
-  ul
-    +cu
-    margin-top: 10px
-    li
-      display: block
-      clear: both
-      +cl
-      margin-bottom: 5px
-  &:after
-    +clear
-
-  &.recent-entries
-    a
-      display: block