soxer 0.9.7 → 0.9.8

data/CHANGES

@@ -1,10 +1,39 @@
+= 0.9.8 / 2010-11-28
+  
+  * Standardized and beautified code (no particular standard though.)
+  
+  * Rdoc documentation rewritten from scratch.
+  
+  * YAML file downloading disabled. This was a severe bug.
+  
+  * Url-to-file routing completely redone, now far more flexible and 
+    extendible, while less error prone.
+  
+  * Atom feed generator completely redone. Not backwards compatible. However, 
+    it was not logical and mostly broken anyway.
+  
+  * Added breadcrumb generator function
+  
+  * Added ttf/otf mime types to default Rack set
+  
+  * Fixed skeleton creation to include empty directories.
+  
+  * Developement mode output padded with newline. Annoyance only.
+  
+  * get_list now filters list of files: If both 'dir/something.yaml' and 
+    'dir/something/index.html' exist, only the first is included.
+      
+  * Fixed sitemap generator to use new settings.origin. This was a severe bug.
+
 = 0.9.7 / 2010-11-03
   
-  * Fixed "views/css/css.sass" for empty skeleton to comply with new sass notation.
+  * Fixed "views/css/css.sass" for empty skeleton to comply with new sass 
+    notation.
   
   * Created a README.markdown document
   
-  * Added sinatra-reloader as dependency, although it's only needed in developement mode.
+  * Added sinatra-reloader as dependency, although it's only needed in 
+    developement mode.
   
   * Added proper license
   

data/bin/soxer

@@ -85,8 +85,7 @@ def create template, dir
     when File.exist?(dir) then
       return err "The destination directory exists."
     else
-      FileUtils.mkdir(dir)
-      FileUtils.cp_r( Dir.glob( File.join(skel, template, '*') ), dir)
+      FileUtils.copy_entry( File.join(skel, template), dir)
       return notice "Successfuly created '#{dir}' application directory from '#{template}'."
   end
 end
@@ -96,7 +95,7 @@ def test port
   server = 'webrick'
   ENV['PATH'].split(':').each {|folder| server = 'thin' if File.exists?(folder+'/thin')}
   system("rackup -s #{server} -p #{port}")
-  return "Developement mode ends."
+  return "Developement mode ends.\n\n"
 end
 
 case $*[0]

data/lib/soxer/main.rb

@@ -3,7 +3,9 @@ require 'yaml'
 require 'haml'
 require 'uuid'
 
-
+#== Sinatra, web publishing DSL
+#
+# http://www.sinatrarb.com
 module Sinatra
   
   #== Soxer, the web publishing tool.
@@ -22,19 +24,26 @@ module Sinatra
     
     # === The Filereader class
     #
-    # In addition to reading the YAML file it also adds two fields to the file:
-    # uuid: Universally Unique Identifier for atom and other feeds. Please, note
-    #       that this id is not compared to other uuids. When creating a new
-    #       document it's best to let soxer generate it.
-    # date: A standard date field. When creating a new document it's best to 
-    #       let soxer generate it.
+    # Filereader is responsible for reading a YAML file, that contains the
+    # content and metadata for each web page.
+    #
+    # Filereader also assumes that each YAML file contains 2 top level fields:
+    # uuid:: A Universally Unique Identifier field 
+    # date:: A standard date and time field
+    # 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
       end
       
+      # The method, that retuns the YAML structure in a ::hash::.
       def get_content
         self.settings
         out = YAML.load_file( @filename )
@@ -47,6 +56,8 @@ module Sinatra
       
       private
       
+      # A private method, that generates and adds a Universally Unique 
+      # Identifier field to the data structure.
       def add_id
         mtime = File.mtime( @filename )
         File.open( @filename, 'r+' ) do |f|
@@ -57,6 +68,7 @@ module Sinatra
         File.utime( 0, mtime, @filename )
       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|
@@ -74,12 +86,19 @@ 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
       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
@@ -93,114 +112,173 @@ module Sinatra
       end
     end
     
+    # === Helper module
+    # 
+    # This module introduces several helper methods to Soxer application.
     module Helpers
-      # === The "get_page", the document reading function
-      #
-      # Read the document in yaml format (with .yaml) ending directly mapped from
-      # the given parameter. Sinatra's *settings.route* and Soxers 
-      # *settings.origin* are prefixed to the path in order to get an absolute
-      # filename. If the filename cannot be found, a directory by that name and
-      # an index file within are probed and read.
+      # === Document reader
+      # This method reads a yaml file from disk and returns a hash.
       # 
-      # If no parameter is given, the entire route is taken as the argument.
+      # ====Accepts
+      # [url => String] 
+      #   The string url. If empty, url recieved is used.
+      #
+      # ====Returns
+      # [=> Hash]
+      #   A hash representation of yaml file.
       def get_page url=params[:splat][0]
         out = Urlreader.new
         out.url = url
         out.get_content
       end
   
-      #=== The "get_list" the document listing function
+      # === Document list generator method
+      # This method returns a list of documents filtered by &block statement.
+      # 
+      # ====Accepts
+      # [&block] 
+      #   A callback method for filtering all available file.
       #
-      # The get_list function is the aggregator function. It reads all available
-      # yaml files (that map to urls directly) and outputs them according to the
-      # arguments you send it. Get_list only accepts a block.
-      #==== &block
-      # Block is a callback, which filters the entire array of yaml files.
-      # The result is an array of hashes, representing a subset of all yaml
-      # files from "origin" directory. It can be sorted by using Array.sort
-      # method.
+      # ====Returns
+      # [=> Array]
+      #   Array of hashes representing yaml files.
       def get_list &block 
-        pattern = File.join( settings.origin, "**", "*.yaml" )
-        output = Dir.glob(pattern).map! do |f|
+        fileset= Dir.glob File.join( settings.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
           if block_given?
             f = block.call file.get_content
+          else
+            f = file.get_content
           end
         end.compact
       end
   
-      #=== The "sitemap" the sitemap generator
+      #=== The "sitemap" the sitemap generator partial
       #
       # This funnction accepts no arguments. It simply renders a sitemap file
       # with all available urls from the site
+      
+      # === Sitemap generator method
+      # This generated an XML sitemap.
+      # 
+      # ====Accepts
+      # This method does not accept arguments.
+      #
+      # ====Returns
+      # [=> String]
+      #   An XML representing the contents of the web site.
       def sitemap
         template = File.read File.join( File.dirname(__FILE__), 'views', 'sitemap.haml' )
         out = '<?xml version="1.0" encoding="UTF-8"?>'+"\n"
         out << haml( template, :layout => false )
       end
-  
-  
-      #=== The "atom" the atom feed generator
+
+      # === The breadcrumb generator
+      # This method generates a stylable breadcrumb based on document's directory path.
+      # 
+      # ==== Accepts
+      # [options => Hash]
+      #   Additional options, passed to haml interpreter
       #
-      # This method accepts an author (which is the global feed's author)
-      # This is a required option, as the feed is only valid if it has at least
-      # the global author. If individual articles have a yaml field "author",
-      # the individual article's author is used for that article. In both cases,
-      # author is a hash consisting of values 'name', 'email', 'url', of which
-      # at least the 'name' should always be present.
+      # ==== Returns
+      # [ => String]
+      #   Html string containing breadcrumb path with links.
+      def breadcrumb options={}
+        template = File.read File.join( File.dirname(__FILE__), 'views', 'breadcrumb.haml' )
+        haml( template, options.merge!( :layout => false ) )
+      end
+        
+      # === The atom feed generator
+      # This method generates an atom entry from a document.
       # 
-      #==== autor
-      # Hash of values as required by the Atom standard:
-      # 'name', 'email' and 'url'. Only name is reuired.
+      # ====Accepts
+      # [doc => Hash] 
+      #   The document hash, read from a YAML source
+      # [options => hash]
+      #   Additional options, passed to haml interpreter
       #
-      #==== &block
-      # Block is a callback. Every file (in hash form) is passed to block and
-      # the block acts as the filter. That way only pages which are returned by
-      # block are included in the feed
-      def atom author=author, &block
-        template = File.read File.join( File.dirname(__FILE__), 'views', 'atom.haml' )
-        pattern = File.join( settings.origin, "**", "*.yaml" )
-        output = Dir.glob(pattern).map! do |f|
-          file = Filereader.new
-          file.filename = f
-          if block_given?
-            block.call file.get_content
-          end
-        end.compact!.sort!{|b,a| a.to_a[0] <=> b.to_a[0] }
-        out = '<?xml version="1.0" encoding="UTF-8"?>'+"\n"
-        out << haml( template, :layout => false, :locals => { :page=>get_page, :feed=>output, :author=>author } )
+      # ====Returns
+      # [=> String]
+      #   Atom feed entry.
+      def atom doc, options={}
+				template = File.read File.join( File.dirname(__FILE__), 'views', 'atom.haml' )
+				haml template, options.merge!( { :layout => false, 
+				                                 :format => :xhtml,
+				                                 :locals => { :doc => doc } } )
       end
       
+      # === Google ads generator method
+      # Returns the google ads code, according to arguments.
+      # 
+      # ====Accepts
+      # [options => Hash] 
+      #   Hash element :locals containing the following symbols
+      #     :client = google ads client ID
+      #     :slot   = google ads ad slot
+      #     :width  = google ads element width
+      #     :height = google ads element height
+      #
+      # ====Returns
+      # [=> String]
+      #   Html partial for the particular google ad.
       def google_ads options={}
         template = File.read File.join( File.dirname(__FILE__), 'views', 'google_ads.haml' )
         pattern = File.join( settings.origin, "**", "*.yaml" )
         haml( template, options.merge!( :layout => false ) )
       end
       
+      # === Disquss helper method
+      # Returns the code for disqus comments.  
+      # Calling this method without parameters generates javascript code needed
+      # at the end of each page containing disqus comments code.
+      # 
+      # ====Accepts
+      # [options => Hash] 
+      #   Hash element :locals containing the following symbols
+      #     :account = google ads client ID
+      #
+      # ====Returns
+      # [=> String]
+      #   Html code that includes Disquss comments.
       def disqus options={}
         template = File.read File.join( File.dirname(__FILE__), 'views', 'disqus.haml' )
         haml( template, options.merge!( :layout => false ) )
       end
       
+      # === Google analytics helper method
+      # Returns the basic google analytics asynchronous tracking code.
+      # 
+      # ====Accepts
+      # [options => Hash] 
+      #   Hash element :locals containing the following symbols
+      #     :tracker = google analytics tracker token
+      #
+      # ====Returns
+      # [=> String]
+      #   Google analytics asynchronous tracking code.
       def google_analytics options={}
         template = File.read File.join( File.dirname(__FILE__), 'views', 'google_analytics.haml' )
         haml( template, options.merge!( :layout => false ) )
       end
   
-      #=== "partial" rails like partial generator
-      #
-      # This funnction accepts a string and matches it to a haml layout (with a
-      # underscore prepended) Sinatra's layouts directory. 
+      # === Partial snippet generator method
+      # Returns a partial from ./views directory as specified in sinatra's
+      # manual.
       # 
-      #==== snippet
-      # A string that maps to a haml view in the views directory
-      # "partial :example, :layout => false" would map to a views/_example.haml
+      # ====Accepts
+      # [snippet => Symbol]
+      #   Symbol, representing a partial in the ./views directory (as specified by Sinatra)
+      #   Note, that the name of the file follows a RoR convention:
+      #   :some_file maps to ./views/_some_file.haml
+      # [options => hash]
+      #   Additional options, passed to haml interpreter
       #
-      #==== options={}
-      # Any options you pass to this partial ger merged and sent to haml as
-      # sinatra's haml options (this is usefull for passing sinatra's :layout,
-      # :locals and other variables)
+      # ====Returns
+      # [=> String]
+      #   Html partial.
       def partial(snippet, options={})
         haml ('_'+snippet.to_s).to_sym, options.merge!(:layout => false)
       end
@@ -216,7 +294,20 @@ module Sinatra
       #
       #==== url
       # This string is used for 'href' in a link
-      def link_to(text, url="/#{text.downcase.gsub(/\s/,'_')}")
+      
+      # === Link tag generator method
+      # Generates Html <a href="#"></a> tag accordng to RoR convention.
+      # 
+      # ==== Accepts
+      # [test => string]
+      #   Visible content of the link (the linked text).
+      # [url => string]
+      #   Url the linked text points to.
+      #
+      # ==== Returns
+      # [ => String]
+      #   Html link tag.
+      def link_to text, url="/#{text.downcase.gsub(/\s/,'_')}"
         url.gsub!(/^\//, '') if url =~ /.+:\/\//
         "<a href=\"#{url}\"> #{text}</a>"
       end
@@ -230,7 +321,18 @@ module Sinatra
       #==== str=nil
       # Obfuscates a string replacing characters with html entities.
       # Useful for hiding emails and such
-      def obfuscate(str=nil)
+
+      # === String obfuscator method
+      # Converts strings into a stream of html character codes.
+      # 
+      # ==== Accepts
+      # [str => string]
+      #   String of arbitrary length.
+      #
+      # ==== Returns
+      # [ => String]
+      #   Html character string.
+      def obfuscate str=nil
         out = []
         str.each_byte {|c| out << "&##{c};" }
         out.join
@@ -238,7 +340,7 @@ module Sinatra
       
     end
     
-    def self.registered(app)
+    def self.registered(app) #:nodoc: all
       app.helpers Soxer::Helpers
       
       def app.settings 
@@ -247,32 +349,52 @@ module Sinatra
       
       set :origin, File.join(app.settings.root, 'content')
       
-      app.get("/sitemap.xml") { sitemap }
+      mime_type :otf, 'application/x-font-TrueType'
+      mime_type :ttf, 'application/x-font-TrueType'
       
-      app.get "/*.css" do
-        content_type "text/css", :charset => "utf-8"
-        sass params[:splat][0].to_sym
-      end
-      
-      app.get '*.*' do
-        file = File.join( settings.origin, params[:splat].join('.') )
-        case params[:splat][1]
-          when /[jpg|png|pdf|doc|docx|xls|xlsx|pdf|]/i then send_file(file, :disposition => nil)
-        end
-      end
- 
+      app.get("/sitemap.xml") { sitemap }
+
+      app.get %r{(.*\.([^.]*))$} do
+				content_type "text/html", :charset => "utf-8"
+				url = params[:captures][0]
+				type = params[:captures][1]
+				file = File.join settings.origin, url
+				
+				case type
+					when 'yaml' then 
+						throw :halt, [404, "Document not found"]
+						
+					when /^jpg|png|pdf|doc|docx|xls|xlsx|pdf|ttf|otf$/i then
+						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 'atom' then 
+						content_type "application/atom+xml", :charset => "utf-8"
+						page = get_page url
+						layout = File.read File.join( File.dirname(__FILE__), 'views', 'atom_layout.haml' )
+						haml page['content'], :layout => layout,
+																  :format => :xhtml,
+						                      :locals => { :page => page }
+						
+
+					when 'rss' then 
+						'RSS is not supported yet'
+						
+					else throw :halt, [404, "Document not found"]
+				end
+			end
+
       app.get '*/?' do
         content_type "text/html", :charset => "utf-8"
-        
-        if params[:splat].last =~ /\.atom$/ then
-          set :haml, { :format => :xhtml }
-          content_type "application/atom+xml", :charset => "utf-8"
-        end
-      
         page = get_page
         page['layout'] ||= 'layout'
         haml page['content'], :layout => page['layout'].to_sym, :locals => { :page => page }
       end
+      
     end
   end
   

data/lib/soxer/skel/empty/content/index.yaml

@@ -1,7 +1,6 @@
-uuid: 151af640-c35a-012d-f6b7-001e378a2988
-date: 2010-10-26T20:03:43+02:00
 title: Hello world!
 content: |
   %h1= page['title']
   %h2 Congratulations!
-  %p You have just created your first #{link_to 'soxer', 'http://soxer.mutsu.org'} application.
+  %p You have just created your first #{link_to 'Soxer', 'http://soxer.mutsu.org'} application.
+

data/lib/soxer/skel/empty/views/css/css.sass

@@ -1,7 +1,6 @@
-$white: #ffffff
 body
-  color: $white
-  background: #800000
-  
-  a
-    color: $white
+  font:
+    face: "Trebuchet MS"
+    
+a
+  color: red

data/lib/soxer/views/atom.haml

@@ -1,32 +1,18 @@
-%feed(xmlns="http://www.w3.org/2005/Atom")
-  %title= page['title']
-  %link{:href=>request.url.split(request.fullpath)[0].gsub(/:\d+/, '')}
-  %link(rel="self"){:href=>request.url.gsub(/:\d+/, '')}
-  %id= "urn:uuid:"+page['uuid']
-  %updated= feed[0]['mtime'].xmlschema
-  %author
-    %name= author['name']
-    - if author['email'] and author['email'].length > 0
-      %email= author['email']
-    - if author['uri'] and author['uri'].length > 0
-      %uri= author['uri']
-  
-  -feed.each do |f|
-    %entry
-      %title= f['title']
-      %link{:href=>f['url']}
-      %id= "urn:uuid:"+f['uuid']
-      %updated= f['mtime'].xmlschema
-      %published= f['date'].xmlschema
-      - if f['summary'] and f['summary'].length > 0
-        - s = haml f['summary'], :layout=>false
-        %summary= s.gsub(%r{</?[^>]+?>}, '')
-      - if f['author']
-        %author
-          - if f['author']['name'] and f['author']['name'].length > 0
-            %name= f['author']['name']
-          - if f['author']['email'] and f['author']['email'].length > 0
-            %email= f['author']['email']
-          - if f['author']['uri'] and f['author']['uri'].length > 0
-            %uri= f['author']['uri']
-  
+%entry
+  %title= doc['title']
+  %link{:href=>doc['url']}
+  %id= "urn:uuid:"+doc['uuid']
+  %updated= doc['mtime'].xmlschema
+  %published= doc['date'].xmlschema
+  - if doc['summary'] and doc['summary'].length > 0
+    - s = haml doc['summary'], :layout=>false
+    %summary= s.gsub(%r{</?[^>]+?>}, '')
+  - if doc['author']
+    %author
+      - if doc['author']['name'] and doc['author']['name'].length > 0
+        %name= doc['author']['name']
+      - if doc['author']['email'] and doc['author']['email'].length > 0
+        %email= doc['author']['email']
+      - if doc['author']['uri'] and doc['author']['uri'].length > 0
+        %uri= doc['author']['uri']
+

data/lib/soxer/views/atom_layout.haml

@@ -0,0 +1,13 @@
+%feed(xmlns="http://www.w3.org/2005/Atom")
+  %title= page['title']
+  %link{:href=>request.url.split(request.fullpath)[0].gsub(/:\d+/, '')}
+  %link(rel="self"){:href=>request.url.gsub(/:\d+/, '')}
+  %id= "urn:uuid:"+page['uuid']
+  %updated= page['mtime'].xmlschema
+  %author
+    %name= page['author']['name']
+    - if page['author']['email'] and page['author']['email'].length > 0
+      %email= page['author']['email']
+    - if page['author']['uri'] and page['author']['uri'].length > 0
+      %uri= page['author']['uri']
+  =yield

data/lib/soxer/views/breadcrumb.haml

@@ -0,0 +1,16 @@
+:ruby
+  home ||= 'home'
+  crumbpaths ||= []
+  crumbs = params[:splat].first.split('/')
+  crumbs.each do |crumb|
+    path = File.join crumbs[0..crumbs.index(crumb)]
+    path = '/' and crumb=home if path==''
+    crumbpaths << [path, crumb]
+  end
+  crumbpaths = [['/', home]] if crumbs.length==0
+
+.breadcrumb
+  -crumbpaths.each do |crumbpath|
+    -unless crumbpaths.index(crumbpath)==0
+      %span ►
+    %a{ :href=>crumbpath[0] }= crumbpath[1]

data/lib/soxer/views/sitemap.haml

@@ -2,9 +2,9 @@
   site = env['HTTP_X_FORWARDED_HOST'] ? env['HTTP_X_FORWARDED_HOST'] : env['HTTP_HOST']
 
 %urlset(xmlns="http://www.sitemaps.org/schemas/sitemap/0.9")
-  - pattern = File.join( settings.root, settings.origin, "**", "*.yaml" )
+  - pattern = File.join( settings.origin, "**", "*.yaml" )
   - Dir.glob(pattern).each do |file|
     %url
-      %loc= "http://#{site}"+file.gsub(/#{settings.root}\/#{settings.origin}(.+)\.yaml$/, "\\1" ).gsub(/(.+)\/index$/, "\\1" )
+      %loc= "http://#{site}"+file.gsub(/#{settings.origin}(.+)\.yaml$/, "\\1" ).gsub(/(.+)\/index$/, "\\1" )
       %lastmod= File.mtime( file ).xmlschema
 

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.7'
-  s.date              = '2010-11-03'
+  s.version           = '0.9.8'
+  s.date              = '2010-11-28'
   s.rubyforge_project = 'soxer'
 
   s.summary     = "Dynamic web site generator engine"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: soxer
 version: !ruby/object:Gem::Version 
-  hash: 53
+  hash: 43
   prerelease: false
   segments: 
   - 0
   - 9
-  - 7
-  version: 0.9.7
+  - 8
+  version: 0.9.8
 platform: ruby
 authors: 
 - Toni Anzlovar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 +01:00
+date: 2010-11-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -94,8 +94,10 @@ files:
 - lib/soxer/views/atom.haml
 - lib/soxer/views/sitemap.haml
 - lib/soxer/views/disqus.haml
+- lib/soxer/views/atom_layout.haml
 - lib/soxer/views/google_analytics.haml
 - lib/soxer/views/google_ads.haml
+- lib/soxer/views/breadcrumb.haml
 - lib/soxer/skel/empty/content/index.yaml
 - lib/soxer/skel/empty/config.yml
 - lib/soxer/skel/empty/config.ru