zorglub 0.0.5 → 0.0.6

data/.gitignore

@@ -0,0 +1,3 @@
+*~
+pkg
+coverage

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+script: "rake spec"

data/Changelog

@@ -1,26 +1,37 @@
-2011-05-26 Jérémy Zurcher <jeremy@asynk.ch>
-	* Project creation
-
-2011-09-13 Jérémy Zurcher <jeremy@asynk.ch>
-	* usable WIP
+2013-01-08 Jérémy Zurcher <jeremy@asynk.ch>
+	* release 0.6
+	* add sass engine
+	* use Bundler
+	* enable travis
+	* fix and rename inherited_vars in cli_vals
 
-2012-01-04 Jérémy Zurcher <jeremy@asynk.ch>
-	* lots of code cleanup
-	* replace Helpers Module with Node#inherited_var Node@inherited_vars
-	* rewrite session so it is compatible with Rack SessionHash
-	* update test application and write specs
+2012-01-17 Jérémy Zurcher <jeremy@asynk.ch>
+	* release 0.5
+	* Node code cleanup
+	* class and method level directives are now view!, layout!, no_layout!, ...
+	* add view_base_path! and layout_base_path!
+	* before_all and after_all are based on inherited_vars
+	* add Zorglub::Config.debug
+	* Zorglub::App swallows Zorglub::Config
 
 2012-01-05 Jérémy Zurcher <jeremy@asynk.ch>
+	* release 0.3 and 0.4
 	* haml, file engines
 	* view/layout extention overriding at methode level
 	* optional engine cache
 	* optional engine proc mime-type definition
 	* optional static page generation/cache
 
-2012-01-17 Jérémy Zurcher <jeremy@asynk.ch>
-	* Node code cleanup
-	* class and method level directives are now view!, layout!, no_layout!, ...
-	* add view_base_path! and layout_base_path!
-	* before_all and after_all are based on inherited_vars
-	* add Zorglub::Config.debug
-	* Zorglub::App swallows Zorglub::Config
+2012-01-04 Jérémy Zurcher <jeremy@asynk.ch>
+	* release 0.2
+	* lots of code cleanup
+	* replace Helpers Module with Node#inherited_var Node@inherited_vars
+	* rewrite session so it is compatible with Rack SessionHash
+	* update test application and write specs
+
+2011-09-13 Jérémy Zurcher <jeremy@asynk.ch>
+	* usable WIP
+
+2011-05-26 Jérémy Zurcher <jeremy@asynk.ch>
+	* Project creation
+

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# gem's dependencies are in zorglub.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    zorglub (0.0.5)
+      rack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    haml (3.1.7)
+    rack (1.4.2)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    sass (3.2.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  haml
+  rake
+  rspec
+  sass
+  zorglub!

data/{README.rdoc → README.md}

@@ -1,12 +1,12 @@
-zorglub
+# zorglub
     by Jérémy Zurcher
-    http://cgit.asynk.ch/cgi-bin/cgit/zorglub
+    http://asynk.ch
 
-== DESCRIPTION:
+## DESCRIPTION:
 
-a nano web application framework based on rack[http://rack.rubyforge.org/]
+a nano web application framework based on [rack](http://rack.rubyforge.org/)
 
-== FEATURES:
+## FEATURES:
 
 * class#method mapping scheme (/class_mapping/method_name/*args)
 * class level layout and engine specification
@@ -17,7 +17,11 @@ a nano web application framework based on rack[http://rack.rubyforge.org/]
 * class level inherited variables
 * session
 
-== SYNOPSIS:
+## STATUS:
+
+[![Build Status](https://secure.travis-ci.org/jeremyz/zorglub.png)](http://travis-ci.org/jeremyz/zorglub)
+
+## SYNOPSIS:
 
 For a simple test application run:
 * rackup ./example/sample.ru
@@ -25,11 +29,11 @@ For a simple test application run:
 Don't forget to look at
 * the spec/ folder
 
-== REQUIREMENTS:
+## REQUIREMENTS:
 
 * rack
 
-== DOWNLOAD/INSTALL:
+## DOWNLOAD/INSTALL:
 
 From rubygems:
 
@@ -37,11 +41,9 @@ From rubygems:
 
 or from the git repository on github:
 
-  git clone git://github.com/jeremyz/zorglub.git
-  cd zorglub
-  rake gem:install
+git clone git://github.com/jeremyz/zorglub.git && cd zorglub && rake install
 
-== RESOURCES:
+## RESOURCES:
 
 You can find this project in a few places:
 
@@ -50,6 +52,7 @@ Online repositories:
 * https://github.com/jeremyz/zorglub
 * http://cgit.asynk.ch/cgi-bin/cgit/zorglub/
 
-== LICENSE:
+## LICENSE:
+
+[MIT](http://www.opensource.org/licenses/MIT) see [MIT_LICENSE](https://github.com/jeremyz/zorglub/blob/master/MIT-LICENSE)
 
-See MIT-LICENSE file.

data/Rakefile

@@ -1,60 +1,6 @@
-# -*- coding: UTF-8 -*-
-#
-$LOAD_PATH << 'lib'
-#
-require 'zorglub'
-load './tasks/setup.rb'
-#
-# Project general information
-PROJ.name = 'zorglub'
-PROJ.authors = 'Jérémy Zurcher'
-PROJ.email = 'jeremy@asynk.ch'
-PROJ.url = 'http://cgit.asynk.ch/cgi-bin/cgit/zorglub'
-PROJ.version = Zorglub::VERSION
-PROJ.rubyforge.name = 'FIXME'
-PROJ.readme_file = 'README.rdoc'
-#
-# Annoucement
-PROJ.ann.paragraphs << 'FEATURES' << 'SYNOPSIS' << 'REQUIREMENTS' << 'DOWNLOAD/INSTALL' << 'CREDITS' << 'LICENSE'
-PROJ.ann.email[:from] = 'jeremy@asynk.ch'
-PROJ.ann.email[:to] = ['FIXME']
-PROJ.ann.email[:server] = 'FIXME'
-PROJ.ann.email[:tls] = false
-# Gem specifications
-PROJ.gem.need_tar = false
-PROJ.gem.files = %w(Changelog MIT-LICENSE README.rdoc Rakefile) + Dir.glob("{ext,lib,spec,tasks}/**/*[^~]").reject { |fn| test ?d, fn }
-PROJ.gem.platform = Gem::Platform::RUBY
-PROJ.gem.required_ruby_version = ">= 1.9.2"
-#
-# Override Mr. Bones autogenerated extensions and force ours in
-#PROJ.gem.extras['extensions'] = %w(ext/extconf.rb)
-#PROJ.gem.extras['required_ruby_version'] = ">= 1.9.2"
-#
-# RDoc
-PROJ.rdoc.exclude << '^ext\/'
-PROJ.rdoc.opts << '-x' << 'ext'
-#
-# Ruby
-PROJ.ruby_opts = []
-PROJ.ruby_opts << '-I' << 'lib'
-#
-# RSpec
-PROJ.spec.files.exclude /rbx/
-PROJ.spec.opts << '--color'
-#
-# Rcov
-PROJ.rcov.opts << '-I lib'
-#
-# Dependencies
-depend_on 'rack'
-depend_on 'rake', '>=0.8.0'
-#
-task :default  => [:spec]
-#
-desc "Build all packages"
-task :package => 'gem:package'
-#
-desc "Install the gem locally"
-task :install => 'gem:install'
-#
-# EOF
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/TODO

@@ -0,0 +1,7 @@
+TODO
+- development and production modes
+- minimized html/js/css
+- encoding
+
+MAYBE
+- config belongs to application

data/example/layout/css.haml

@@ -0,0 +1,5 @@
+%h1=@title
+%p="xx <b>css</b> layout xx"
+%p="Css #{cli_val(:css).inspect}"
+%p=@content
+%p="xx -- xx"

data/example/layout/default.haml

@@ -0,0 +1,5 @@
+%h1=@title
+%p="xx <b>default</b> layout xx"
+%p="count #{Zorglub::Node.count}"
+%p=@content
+%p="xx -- xx"

data/example/layout/other.haml

@@ -0,0 +1,4 @@
+%h1=@title
+%p="xx <b>other</b> layout - xx"
+%p=@content
+%p="xx -- xx"

data/example/sample.ru

@@ -0,0 +1,157 @@
+#! /usr/bin/env ruby
+#
+$LOAD_PATH << File.join(File.dirname( File.absolute_path(__FILE__)), '..', 'lib')
+#
+USE_RACK_SESSION=false
+#
+require 'zorglub'
+require 'zorglub/engines/haml'
+if USE_RACK_SESSION
+    require 'zorglub/rack_session'
+else
+    require 'zorglub/session'
+end
+#
+class Zorglub::Node
+    @count=0
+    class << self
+        attr_accessor :count
+    end
+    before_all do |node|
+        Zorglub::Node.count +=1
+    end
+end
+#
+class Node1 < Zorglub::Node
+    #
+    def index a1, *a2
+        @title='Index'
+        @links = LINKS
+        # there's a view so the below will be lost !
+        "<b>should never be seeen</b>"
+    end
+    #
+    def meth0 *args
+        @title='meth0'
+        @links = LINKS
+        # method level engine
+        engine! 'tmp-engine'
+        # there's a view so the below will be lost !
+        "<b>should never be seeen</b>"
+    end
+    #
+    def meth1 *args
+        @title='meth1'
+        @links = LINKS
+        # method level engine (layout/other.haml)
+        layout! 'other'
+        # specific method view (view/url1/meth0.haml)
+        view! File.join( 'url1','meth0')
+        # there's a view so the below will be lost !
+        "<b>should never be seeen</b>"
+    end
+    #
+    def jump *args
+        redirect r(:index,1,2,3)
+    end
+    #
+end
+#
+HAML_PROC = Proc.new { |path,obj| Haml::Engine.new( File.open(path,'r').read ).render(obj) }
+#
+APP = Zorglub::App.new do
+    register_engine! :haml, 'haml', Zorglub::Engines::Haml.method(:proc)
+    register_engine! 'tmp-engine', 'haml', HAML_PROC
+    opt! :debug, true
+    opt! :engine, :haml
+    opt!:root, File.dirname( File.absolute_path(__FILE__) )
+    opt(:session_options)[:enabled] = true
+    map '/url1', Node1
+end
+#
+class Node2 < Zorglub::Node
+    #
+    map APP, '/url2'
+    layout! 'css'
+    # class level engine
+    engine! 'tmp-engine'
+    # class level css
+    cli_val :css, 'class_level.css'
+    #
+    def index *args
+        "<title>Node2:index</title><b>START</b>#{html}<a href=#{Node2.r(:meth0)}>next</a><br/><b>END</b>"
+    end
+    #
+    def meth0 *args
+        # instance level css
+        cli_val :css, 'instance_level.css'
+        "<title>Node2:meth0</title><b>START</b>#{html}<a href=#{Node2.r(:meth1,1,2)}>next</a><br/><b>END</b>"
+    end
+    #
+    def meth1 *args
+        more = Node2.partial :meth0, *args
+        "<title>Node2:meth1</title><b>partial</b><br/>#{more}<br/><b>done</b><br/><a href=#{Node0.r}>back</a>"
+    end
+end
+#
+class Node3 < Zorglub::Node
+    #
+    map APP, '/url3'
+    no_layout!
+    #
+    def index *args
+        @title = "Session tests"
+        t = Time.now
+        if session[:now].nil?
+            session[:now] = t
+            @data = "#{t.strftime('%H:%M:%S')} FIRST"
+        elsif t-session[:now]>10
+            session[:now] = t
+            @data = "#{t.strftime('%H:%M:%S')} UPDATE"
+        else
+            @data = "#{session[:now].strftime('%H:%M:%S')} CURRENT"
+        end
+    end
+    def reset
+        session.clear
+        redirect :index
+    end
+    #
+end
+#
+class Node0 < Zorglub::Node
+    #
+    map APP, '/'
+    #
+    def index
+        html = "<html><body><ul>"
+        html << "<li><a href=\"#{Node1.r('index','a',2,'c')}\">Node1</a> engine, layout, view, redirect tests</li>"
+        html << "<li><a href=\"#{Node2.r}\">Node2</a> css helper tests</li>"
+        html << "<li><a href=\"#{Node3.r}\">Node3</a> session test</li>"
+        html << "</ul></body></html>"
+        html
+    end
+    #
+end
+#
+Node1::LINKS= [
+            [Node1.r('index','arg1','arg2','arg3'),'index'],
+            [Node1.r('meth0'),'meth0'],
+            [Node1.r('meth1','one','two'),'meth1 with args'],
+            [Node1.r('jump','one','two'),'test redirect'],
+            [Node0.r,'back'],
+]
+#
+puts APP.to_hash.inspect
+puts "  **** "+( USE_RACK_SESSION ? 'USE Rack Session' : 'USE builtin Session' )
+#
+map '/' do
+    use Rack::Lint
+    use Rack::ShowExceptions
+    if USE_RACK_SESSION
+        use Rack::Session::Cookie,  :key=>APP.opt(:session_options)[:key], :secret=>APP.opt(:session_options)[:secret],
+            :path=>'/', :http_only=>true, :expire_after=>30
+    end
+    run APP
+end
+#

data/example/view/url1/index.haml

@@ -0,0 +1,7 @@
+%h3='url1 index view'
+-options.each do |k,v|
+  %p="#{k} => #{v}"
+%p
+  - @links.each do |href,name|
+    %a{:href=>href}=name
+    %br

data/example/view/url1/meth0.haml

@@ -0,0 +1,7 @@
+%h3='url1 meth0 view'
+-options.each do |k,v|
+  %p="#{k} => #{v}"
+%p
+  - @links.each do |href,name|
+    %a{:href=>href}=name
+    %br

data/example/view/url3/index.haml

@@ -0,0 +1,8 @@
+%h2=@title
+%p=Time.now.strftime '%H:%M:%S'
+%p="Session data : #{@data}"
+%a{:href=>Node3.r}="reload"
+%br
+%a{:href=>Node3.r('reset')}="reset session"
+%br
+%a{:href=>Node0.r}="back"

data/lib/version.rb

@@ -0,0 +1,10 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+module Zorglub
+    #
+    VERSION = '0.0.6'
+    #
+end
+#
+# EOF

data/lib/zorglub/app.rb

@@ -25,11 +25,16 @@ module Zorglub
                     :ugly => false,
                     :encoding => 'utf-8'
                 },
+                :sass_options => {
+                    :syntax => :scss,
+                    :cache => :false,
+                    :style => :compressed
+                },
                 :session_options => {
-                    :session_on => false,
-                    :session_key => 'zorglub.sid',
-                    :session_secret => 'session-secret-secret',
-                    :session_sid_len => 64,
+                    :enabled => false,
+                    :key => 'zorglub.sid',
+                    :secret => 'session-secret-secret',
+                    :sid_len => 64
                 }
             }
             instance_eval &block if block_given?

data/lib/zorglub/engines/sass.rb

@@ -0,0 +1,22 @@
+# -*- coding: UTF-8 -*-
+#
+require 'sass'
+#
+module Zorglub
+    module Engines
+        module Sass
+            def self.proc path,obj
+                if obj.app.opt(:engines_cache_enabled)
+                    key = path.sub obj.app.opt(:root),''
+                    sass = obj.app.engines_cache[key] ||= ::Sass::Engine.new( ::File.open(path,'r'){|f| f.read }, obj.app.opt(:sass_options) )
+                else
+                    sass = ::Sass::Engine.new( ::File.open(path,'r'){|f| f.read }, obj.app.opt(:sass_options) )
+                end
+                css = sass.render
+                return css, 'text/css'
+            end
+        end
+    end
+end
+#
+# EOF

data/lib/zorglub/node.rb

@@ -154,58 +154,60 @@ module Zorglub
             "You are being redirected, please follow this link to: <a href='#{target}'>#{target}</a>!"
         end
         #
-        # inherited vars, they can be modified at class level only
+        # class level inherited values are key=>array, copied at inheritance
+        # so they can be extanded at class level
+        # values are copied from class into instance at object creation
+        # so that can be extanded without modifying class level values
+        # typical usage are css or js inclusions
         #
-        @inherited_vars = { }
+        @cli_vals = { }
         #
         class << self
             #
-            attr_reader :inherited_vars
+            attr_reader :cli_vals
             #
-            def inherited_var sym, *args
-                var = @inherited_vars[sym] ||=[]
+            def cli_val sym, *args
+                vals = @cli_vals[sym] ||=[]
                 unless args.empty?
-                    var.concat args
-                    var.uniq!
+                    vals.concat args
+                    vals.uniq!
                 end
-                var
+                vals
             end
             #
         end
         #
-        def inherited_var sym, *args
-            d = self.class.inherited_vars[sym].clone || []
+        def cli_val sym, *args
+            vals = @cli_vals[sym] ||=[]
             unless args.empty?
-                d.concat args
-                d.uniq!
+                vals.concat args
+                vals.uniq!
             end
-            d
+            vals
         end
         #
         # before_all and after_all hooks
         #
-        @inherited_vars[:before_all] = []
-        @inherited_vars[:after_all] = []
+        @cli_vals[:before_all] = []
+        @cli_vals[:after_all] = []
         class << self
-            #
-            attr_reader :hooks
             #
             def call_before_hooks obj
-                @inherited_vars[:before_all].each do |blk| blk.call obj end
+                @cli_vals[:before_all].each do |blk| blk.call obj end
             end
             #
             def before_all &blk
-                @inherited_vars[:before_all]<< blk
-                @inherited_vars[:before_all].uniq!
+                @cli_vals[:before_all]<< blk
+                @cli_vals[:before_all].uniq!
             end
             #
             def call_after_hooks obj
-                @inherited_vars[:after_all].each do |blk| blk.call obj end
+                @cli_vals[:after_all].each do |blk| blk.call obj end
             end
             #
             def after_all &blk
-                @inherited_vars[:after_all]<< blk
-                @inherited_vars[:after_all].uniq!
+                @cli_vals[:after_all]<< blk
+                @cli_vals[:after_all].uniq!
             end
             #
         end
@@ -217,12 +219,12 @@ module Zorglub
             def inherited sub
                 sub.engine! engine||(self==Zorglub::Node ? UNDEFINED : nil )
                 sub.layout! layout||(self==Zorglub::Node ? UNDEFINED : nil )
-                sub.instance_variable_set :@inherited_vars, {}
-                @inherited_vars.each do |s,v| sub.inherited_var s, *v end
+                sub.instance_variable_set :@cli_vals, {}
+                @cli_vals.each do |s,v| sub.cli_val s, *v end
             end
             #
             def call env
-                meth, *args =  env['PATH_INFO'].sub(/^\//,'').split '/'
+                meth, *args =  env['PATH_INFO'].sub(/^\//,'').split(/\//)
                 meth||= 'index'
                 puts "=> #{meth}(#{args.join ','})" if app.opt :debug
                 node = self.new env, {:engine=>engine,:layout=>layout,:view=>r(meth),:method=>meth,:args=>args,:static=>static}
@@ -242,7 +244,7 @@ module Zorglub
                 resp = node.response
                 resp.status = 404
                 resp['Content-Type'] = 'text/plain'
-                resp.write "%s mapped at %p can't respond to : %p" % [ node.class.name, node.r, node.request.env['PATH_INFO'] ]
+                resp.write "%s mapped at %p can't respond to : %p" % [ node.class.name, node.map, node.request.env['PATH_INFO'] ]
                 resp
             end
             #
@@ -255,6 +257,8 @@ module Zorglub
             @options = options
             @request = Rack::Request.new env
             @response = Rack::Response.new
+            @cli_vals ={}
+            self.class.cli_vals.each do |s,v| cli_val s, *v end
         end
         #
         def state state=nil

data/lib/zorglub/session.rb

@@ -47,7 +47,7 @@ module Zorglub
         #
         def clear
             load_data!
-#            @response.delete_cookie @options[:session_key]
+#            @response.delete_cookie @options[:key]
 #            @sessions.delete @sid
 #            @sid = nil
             super
@@ -95,11 +95,11 @@ module Zorglub
         #
         def load_data!
             return if loaded?
-            if @options[:session_on]
-                sid = @request.cookies[@options[:session_key]]
+            if @options[:enabled]
+                sid = @request.cookies[@options[:key]]
                 if sid.nil?
                     sid = generate_sid!
-                    @response.set_cookie @options[:session_key], sid
+                    @response.set_cookie @options[:key], sid
                 end
                 replace @sessions[sid] ||={}
                 @sessions[sid] = self
@@ -126,7 +126,7 @@ module Zorglub
             # SecureRandom is available since Ruby 1.8.7.
             # For Ruby versions earlier than that, you can require the uuidtools gem,
             # which has a drop-in replacement for SecureRandom.
-            def sid_algorithm; SecureRandom.hex(@options[:session_sid_len]); end
+            def sid_algorithm; SecureRandom.hex(@options[:sid_len]); end
         rescue LoadError
             require 'openssl'
             # Using OpenSSL::Random for generation, this is comparable in performance
@@ -134,7 +134,7 @@ module Zorglub
             # have the same behaviour as the SecureRandom::hex method of the
             # uuidtools gem.
             def sid_algorithm
-                OpenSSL::Random.random_bytes(@options[:session_sid_len] / 2).unpack('H*')[0]
+                OpenSSL::Random.random_bytes(@options[:sid_len] / 2).unpack('H*')[0]
             end
         rescue LoadError
             # Digest::SHA2::hexdigest produces a string of length 64, although