soxer 0.9.0

data/lib/soxer/main.rb

@@ -0,0 +1,241 @@
+require 'sinatra/base'
+require 'yaml'
+require 'haml'
+require 'uuid'
+
+
+module Sinatra
+
+  #== Soxer, the web publishing tool.
+  #
+  # Soxer is a Sinatra module that adds additional methods to sinatra routes.
+  # These methods allow for route-to-yaml-file mapping in order to serve a set
+  # files from disk with minimal effort. By clever use of views and/or
+  # templating Soxer makes for a simple and effective web site creation tool.
+  # You can get more information about Soxer, including the latest version at
+  # http://soxer.mutsu.org
+  #
+  # Author:    Toni Anzlovar  (toni[at]formalibre.si)
+  # Copyright: Copyright (c) 1010 Toni Anzlovar, www.formalibre.si
+  # License:   Distributed under the GPL licence. http://www.gnu.org/licenses/gpl.html
+  module Soxer
+    
+    class Filereader
+      attr_accessor :filename
+
+      def settings
+        @s = Sinatra::Application
+      end
+      
+      def get_content
+        self.settings
+        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['mtime'] =  File.mtime( @filename )
+        out
+      end
+      
+      private
+      
+      def add_id
+        mtime = File.mtime( @filename )
+        File.open( @filename, 'r+' ) do |f|
+          out = "uuid: #{UUID.new.generate}\n"
+          out << f.read; f.pos =  0
+          f << out
+        end
+        File.utime( 0, mtime, @filename )
+      end
+      
+      def add_date
+        mtime = File.mtime( @filename )
+        File.open( @filename, 'r+' ) do |f|
+          out = "date: #{mtime.xmlschema}\n"
+          out << f.read; f.pos =  0
+          f << out
+        end
+      end
+    end
+    
+    class Urlreader
+      attr_accessor :url
+
+      def settings
+        @s = Sinatra::Application
+      end
+      
+      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
+             else throw :halt, [404, "Document not found"]
+             end
+        out = Filereader.new
+        out.filename = fn
+        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
+    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
+        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
+        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
+
+    def recaptcha options={}
+      template = File.read File.join( File.dirname(__FILE__), 'views', 'recaptcha.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
+    end
+
+  end
+
+  helpers Soxer
+end

data/lib/soxer/views/atom.haml

@@ -0,0 +1,32 @@
+%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']
+  

data/lib/soxer/views/disqus.haml

@@ -0,0 +1,26 @@
+- if defined?(account)
+  #disqus_thread
+  :javascript
+    (function() {
+     var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+     dsq.src = 'http://#{account}.disqus.com/embed.js';
+     (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+    })();
+  %noscript Please enable JavaScript to view the #{link_to 'comments powered by Disqus', 'http://disqus.com/?ref_noscript=#{account}'}.
+  %a.dsq-brlink(href="http://disqus.com")
+    blog comments powered by
+    %span.logo-disqus Disqus
+
+- if !defined?(account)
+  :javascript
+    (function() {
+      var links = document.getElementsByTagName('a');
+      var query = '?';
+      for(var i = 0; i < links.length; i++) {
+      if(links[i].href.indexOf('#disqus_thread') >= 0) {
+        query += 'url' + i + '=' + encodeURIComponent(links[i].href) + '&';
+      }
+      }
+      document.write('<script charset="utf-8" type="text/javascript" src="http://disqus.com/forums/soxer/get_num_replies.js' + query + '"></' + 'script>');
+    })();
+  

data/lib/soxer/views/google_ads.haml

@@ -0,0 +1,6 @@
+:javascript
+  google_ad_client = "#{client}";
+  google_ad_slot = "#{slot}";
+  google_ad_width = #{width};
+  google_ad_height = #{height};
+%script(type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js")

data/lib/soxer/views/google_analytics.haml

@@ -0,0 +1,27 @@
+-#-----------------------------------------------------------------------------
+-# OLD
+-#-----------------------------------------------------------------------------
+-#:javascript
+-#  var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+-#  document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+-#
+-#:javascript
+-#  try {
+-#  var pageTracker = _gat._getTracker("#{tracker}");
+-#  pageTracker._trackPageview();
+-#  } catch(err) {}
+-#-----------------------------------------------------------------------------
+
+-#-----------------------------------------------------------------------------
+-# New, asynchronus
+-#-----------------------------------------------------------------------------
+:javascript
+  var _gaq = _gaq || [];
+  _gaq.push(['_setAccount', '#{tracker}']);
+  _gaq.push(['_trackPageview']);
+  (function() {
+  var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+  ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+  var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+  })();
+-#-----------------------------------------------------------------------------

data/lib/soxer/views/recaptcha.haml

@@ -0,0 +1,19 @@
+:ruby
+  width ||= 500;
+  height ||= 300;
+  theme ||= 'white'
+  lang ||= 'en'
+  
+%script(type="text/javascript" src="http://www.google.com/recaptcha/api/js/recaptcha_ajax.js")
+:javascript
+  Recaptcha.create("#{key}", "recaptcha", {
+      theme: "#{theme}",
+      callback: Recaptcha.focus_response_field }
+  );
+%noscript
+  %iframe(src="http://www.google.com/recaptcha/api/noscript?k=#{key}" height="#{height}" width="#{width}" frameborder="0")
+  %br
+  %textarea(name="recaptcha_challenge_field" rows="3" cols="40")
+  %input(type="hidden" name="recaptcha_response_field" value="manual_challenge")
+
+#recaptcha

data/lib/soxer/views/sitemap.haml

@@ -0,0 +1,10 @@
+:ruby
+  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" )
+  - Dir.glob(pattern).each do |file|
+    %url
+      %loc= "http://#{site}"+file.gsub(/#{settings.root}\/#{settings.origin}(.+)\.yaml$/, "\\1" ).gsub(/(.+)\/index$/, "\\1" )
+      %lastmod= File.mtime( file ).xmlschema
+

data/lib/soxer.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+require 'sinatra/base'
+require 'yaml'
+require 'haml'
+require 'uuid'
+
+require 'soxer/main.rb'

data/soxer.gemspec

@@ -0,0 +1,42 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.7'
+
+  s.name              = 'soxer'
+  s.version           = '0.9.0'
+  s.date              = '2010-10-25'
+  s.rubyforge_project = 'soxer'
+
+  s.summary     = "Dynamic web site engine"
+  s.description = "Soxer is a file based dynamic web creation tool for Sinatra."
+
+  s.authors  = ["Toni Anzlovar"]
+  s.email    = 'toni@formalibre.si'
+  s.homepage = 'http://soxer.mutsu.org'
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  # s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_dependency('sinatra', "~> 1")
+  s.add_dependency('haml', "~> 3")
+  s.add_dependency('uuid', "~> 2")
+
+  # = MANIFEST =
+  s.files = %w[
+    soxer.gemspec
+    lib/soxer.rb
+    lib/soxer/main.rb
+    lib/soxer/views/sitemap.haml
+    lib/soxer/views/recaptcha.haml
+    lib/soxer/views/google_analytics.haml
+    lib/soxer/views/google_ads.haml
+    lib/soxer/views/disqus.haml
+    lib/soxer/views/atom.haml
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: soxer
+version: !ruby/object:Gem::Version 
+  hash: 59
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- Toni Anzlovar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-25 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        version: "1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: uuid
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id003
+description: Soxer is a file based dynamic web creation tool for Sinatra.
+email: toni@formalibre.si
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- soxer.gemspec
+- lib/soxer.rb
+- lib/soxer/main.rb
+- lib/soxer/views/sitemap.haml
+- lib/soxer/views/recaptcha.haml
+- lib/soxer/views/google_analytics.haml
+- lib/soxer/views/google_ads.haml
+- lib/soxer/views/disqus.haml
+- lib/soxer/views/atom.haml
+has_rdoc: true
+homepage: http://soxer.mutsu.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: soxer
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: Dynamic web site engine
+test_files: []
+