soxer 0.9.4 → 0.9.5

data/CHANGES

@@ -0,0 +1,34 @@
+= 0.9.5 / 2010-10-00
+
+  * Inline documentation has been adjusted and slightly improved.
+  
+  * The value of settings.origin is now a global system path, rather than a
+    local path from settings.root. Default is set to 'content', but you can
+    change it by Sinatra's standards.
+  
+  * Atom file as progressed from -atom to .atom (dot atom) and soxer will now
+    server /any/path/to/file.atom with the application/atom+xml content type.
+  
+  * Soxer has been modularized to Sinatra's standards, with the exception of
+    the name. It's still named soxer and not sinatra-soxer. This might change
+    in the future as we hit stable.
+      
+  * Changed get_list method. It only accepts a block for filtering yaml files
+    Any sorting is now done by Array.sort {} afterwards.
+  
+  * Fixed partial generator so it properly handles strings and symbols
+  
+  * Cleaned up "soxer test" and only choose "thin" webserver if available.
+    Defaults to webrick (very slow).
+
+= 0.9.4 / 2010-10-27
+  
+  * Added executable 'soxer' to help generating application directories and
+    running developement versions
+    
+  * Added skeletal directories, and 'empty' skeleton application
+
+= 0.9.0 / 2010-10-24
+
+  * Initial release
+

data/bin/soxer

@@ -85,7 +85,6 @@ def create
       FileUtils.mkdir(dir)
       FileUtils.cp_r(src+"/.", dir)
       return notice "Successfuly created '"+dir+"' Directory."
-      #return Dir.glob(src+"/**/*").to_s
     else
       return err 'The destination directory exists.'
     end
@@ -96,27 +95,21 @@ end
 
 def test
   port = $*[1]!=nil ? $*[1] : '9394'
-  server = false
-  servers = %w[webrick mongrel thin]
-  servers.each do |s|
-    ENV['PATH'].split(':').each {|folder| server = s if File.exists?(folder+'/'+s)}
-  end
-  if server!=false
-    system("rackup -s #{server} -p #{port}")
-    return notice "End of developement mode."
-  else
-    return err "Please install a sinatra compatible web server (thin, mongrel or webrick.)"
-  end
+  server = 'webrick'
+  ENV['PATH'].split(':').each {|folder| server = 'thin' if File.exists?(folder+'/thin')}
+  x = system("rackup -s #{server} -p #{port}")
+  return "Developement mode ends."
 end
 
 case $*[0]
   when 'create' then printf create
   when 'test' then printf test
+  when 'prank' then printf prank
   when 'help' then printf @help
   else printf err 'You did not specify an action!'
 end
 
-
+# TO COME LATER
 x = <<END
       #{b 'corporate'} - Creates a corporate web page mockup
       #{b 'blog'}      - Creates a blog mockup

data/lib/soxer/main.rb

@@ -5,7 +5,7 @@ require 'uuid'
 
 
 module Sinatra
-
+  
   #== Soxer, the web publishing tool.
   #
   # Soxer is a Sinatra module that adds additional methods to sinatra routes.
@@ -20,6 +20,14 @@ module Sinatra
   # License:   Distributed under the GPL licence. http://www.gnu.org/licenses/gpl.html
   module Soxer
     
+    # === 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.
     class Filereader
       attr_accessor :filename
 
@@ -32,7 +40,7 @@ module Sinatra
         out = YAML.load_file( @filename )
         add_date unless out['date']
         add_id unless out['uuid']
-        out['url'] = @filename.gsub(/#{@s.root}\/#{@s.origin}(.+)\.yaml$/, "\\1" ).gsub(/(.+)\/index$/, "\\1" )
+        out['url'] = @filename.gsub(/#{@s.origin}(.+)\.yaml$/, "\\1" ).gsub(/(.+)\/index$/, "\\1" )
         out['mtime'] =  File.mtime( @filename )
         out
       end
@@ -59,6 +67,12 @@ module Sinatra
       end
     end
     
+    # === The Urlreader class
+    #
+    # Urlreader simply checks if the URL recieved can be matched to a file.
+    # Currelntly it either matches a file path (ending with .yaml) from origin 
+    # (the default is "content" directory within application root) or a 
+    # directory path with index.yaml
     class Urlreader
       attr_accessor :url
 
@@ -69,8 +83,8 @@ module Sinatra
       def get_content
         self.settings
         fn = case true
-             when File.exist?( f = File.join( @s.root, @s.origin, @url+'.yaml' ) ) then f
-             when File.exist?( f = File.join( @s.root, @s.origin, @url+'/index.yaml' ) ) then f
+             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
@@ -78,158 +92,190 @@ module Sinatra
         out.get_content
       end
     end
-
-    # === 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.
-    # 
-    # If no parameter is given, the entire route is taken as the argument.
-    def get_page url=params[:splat][0]
-      out = Urlreader.new
-      out.url = url
-      out.get_content
+    
+    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.
+      # 
+      # If no parameter is given, the entire route is taken as the argument.
+      def get_page url=params[:splat][0]
+        out = Urlreader.new
+        out.url = url
+        out.get_content
+      end
+  
+      #=== The "get_list" the document listing function
+      #
+      # 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.
+      def get_list &block 
+        pattern = File.join( settings.origin, "**", "*.yaml" )
+        output = Dir.glob(pattern).map! do |f|
+          file = Filereader.new
+          file.filename = f
+          if block_given?
+            f = block.call file.get_content
+          end
+        end.compact
+      end
+  
+      #=== The "sitemap" the sitemap generator
+      #
+      # This funnction accepts no arguments. It simply renders a sitemap file
+      # with all available urls from the 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
+      #
+      # 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.
+      # 
+      #==== autor
+      # Hash of values as required by the Atom standard:
+      # 'name', 'email' and 'url'. Only name is reuired.
+      #
+      #==== &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 } )
+      end
+      
+      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
+      
+      def disqus options={}
+        template = File.read File.join( File.dirname(__FILE__), 'views', 'disqus.haml' )
+        haml( template, options.merge!( :layout => false ) )
+      end
+      
+      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. 
+      # 
+      #==== snippet
+      # A string that maps to a haml view in the views directory
+      # "partial :example, :layout => false" would map to a views/_example.haml
+      #
+      #==== 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)
+      def partial(snippet, options={})
+        haml ('_'+snippet.to_s).to_sym, options.merge!(:layout => false)
+      end
+      
+      #=== "link_to" rails like link_to generator
+      #
+      # This funnction accepts a 1 or 2 strings. 
+      # 
+      #==== text
+      # A string that becomes the link text. If there is no second parameter,
+      # link_to converts the string into a local url by replacing all spaces with
+      # an underscore and downcasing the string.
+      #
+      #==== url
+      # This string is used for 'href' in a link
+      def link_to(text, url="/#{text.downcase.gsub(/\s/,'_')}")
+        url.gsub!(/^\//, '') if url =~ /.+:\/\//
+        "<a href=\"#{url}\"> #{text}</a>"
+      end
+      
+      # A simple string obuscator.
+      # Useful for hiding emails and such
+      #=== "obfuscate" simple string obuscator.
+      #
+      # This funnction accepts a 1 or 2 strings. 
+      # 
+      #==== str=nil
+      # Obfuscates a string replacing characters with html entities.
+      # Useful for hiding emails and such
+      def obfuscate(str=nil)
+        out = []
+        str.each_byte {|c| out << "&##{c};" }
+        out.join
+      end
+      
     end
-
-    #=== The "get_list" the document listing function
-    #
-    # 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 1 argument and a block.
-    # 
-    #==== sort='desc'
-    # Direction of output. 'desc' (descending) or 'asc' (ascending)The default 
-    # is 'desc'. If :sort conatins anything else, the output is unsorted.
-    #
-    #==== &block
-    # Block is a callback. Every file (in hash form) is passed to block and
-    # the block acts as the filter. :sort only takes the result and sorts it
-    # according to the first key/value pair, so hash order IS signifficant.
-    def get_list sort='desc', &block 
-      pattern = File.join( settings.root, settings.origin, "**", "*.yaml" )
-      output = Dir.glob(pattern).map! do |f|
-        file = Filereader.new
-        file.filename = f
-        if block_given?
-          f = block.call file.get_content
+    
+    def self.registered(app)
+      app.helpers Soxer::Helpers
+      
+      def app.settings 
+        Sinatra::Application
+      end
+      
+      set :origin, File.join(app.settings.root, 'content')
+      
+      app.get("/sitemap.xml") { sitemap }
+      
+      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.compact
-      case sort
-        when 'desc' then output.sort!{|b,a| a.to_a[0] <=> b.to_a[0] }
-        when 'asc'  then output.sort!{|a,b| a.to_a[0] <=> b.to_a[0] }
       end
-    end
-
-    #=== The "sitemap" the sitemap generator
-    #
-    # This funnction accepts no arguments. It simply renders a sitemap file
-    # with all available urls from the 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
-    #
-    # 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.
-    # 
-    #==== autor
-    # Hash of values as required by the Atom standard:
-    # 'name', 'email' and 'url'. Only name is reuired.
-    #
-    #==== &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.root, settings.origin, "**", "*.yaml" )
-      output = Dir.glob(pattern).map! do |f|
-        file = Filereader.new
-        file.filename = f
-        if block_given?
-          block.call file.get_content
+ 
+      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
-      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 } )
-    end
-    
-    def google_ads options={}
-      template = File.read File.join( File.dirname(__FILE__), 'views', 'google_ads.haml' )
-      pattern = File.join( settings.root, settings.origin, "**", "*.yaml" )
-      haml( template, options.merge!( :layout => false ) )
-    end
-    
-    def disqus options={}
-      template = File.read File.join( File.dirname(__FILE__), 'views', 'disqus.haml' )
-      haml( template, options.merge!( :layout => false ) )
-    end
-    
-    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. 
-    # 
-    #==== snippet
-    # A string that maps to a haml view in the views directory
-    # "partial :example, :layout => false" would map to a views/_example.haml
-    #
-    #==== 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)
-    def partial(snippet, options={})
-      haml ('_'+snippet).to_sym, options.merge!(:layout => false)
-    end
-    
-    #=== "link_to" rails like link_to generator
-    #
-    # This funnction accepts a 1 or 2 strings. 
-    # 
-    #==== text
-    # A string that becomes the link text. If there is no second parameter,
-    # link_to converts the string into a local url by replacing all spaces with
-    # an underscore and downcasing the string.
-    #
-    #==== url
-    # This string is used for 'href' in a link
-    def link_to(text, url="/#{text.downcase.gsub(/\s/,'_')}")
-      url.gsub!(/^\//, '') if url =~ /.+:\/\//
-      "<a href=\"#{url}\"> #{text}</a>"
-    end
-    
-    # A simple string obuscator.
-    # Useful for hiding emails and such
-    #=== "obfuscate" simple string obuscator.
-    #
-    # This funnction accepts a 1 or 2 strings. 
-    # 
-    #==== str=nil
-    # Obfuscates a string replacing characters with html entities.
-    # Useful for hiding emails and such
-    def obfuscate(str=nil)
-      out = []
-      str.each_byte {|c| out << "&##{c};" }
-      out.join
+      
+        page = get_page
+        page['layout'] ||= 'layout'
+        haml page['content'], :layout => page['layout'].to_sym, :locals => { :page => page }
+      end
     end
-
   end
-
-  helpers Soxer
+  
+  register Soxer
 end
+

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

@@ -5,9 +5,9 @@ require "app"
 disable :run
 set :server, %w[thin mongrel webrick]
 set :origin, "content"
-set :haml, {:encoding => 'utf-8',
-            :format => :html5, 
-            :attr_wrapper => '"' }
+set :haml, {:format => :html5, 
+            :attr_wrapper => '"'}
+set :haml, {:encoding => 'utf-8'} if RUBY_VERSION=~/1\.9/
 
 configure :development do
   require 'sinatra/reloader'
@@ -15,6 +15,7 @@ configure :development do
 end
 
 configure :production do
+  set :haml, {:ugly => true}
   set :port, 55500
 end
 

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.4'
-  s.date              = '2010-10-27'
+  s.version           = '0.9.5'
+  s.date              = '2010-11-01'
   s.rubyforge_project = 'soxer'
 
   s.summary     = "Dynamic web site generator engine"
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   # = MANIFEST =
   s.files = %w[
     soxer.gemspec
+    CHANGES
     bin/soxer
     lib/soxer.rb
     lib/soxer/main.rb

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: soxer
 version: !ruby/object:Gem::Version 
-  hash: 51
+  hash: 49
   prerelease: false
   segments: 
   - 0
   - 9
-  - 4
-  version: 0.9.4
+  - 5
+  version: 0.9.5
 platform: ruby
 authors: 
 - Toni Anzlovar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 +02:00
+date: 2010-11-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,6 +70,7 @@ extra_rdoc_files: []
 
 files: 
 - soxer.gemspec
+- CHANGES
 - bin/soxer
 - lib/soxer.rb
 - lib/soxer/main.rb