RubyGems - zorglub - Versions diffs - 0.0.2 → 0.0.3 - Mend

zorglub 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

data/Changelog CHANGED Viewed

@@ -1,2 +1,18 @@
-FIME-date Jérémy Zurcher <jeremy@asynk.ch>
+2011-05-26 Jérémy Zurcher <jeremy@asynk.ch>
 	* Project creation
+2011-09-13 Jérémy Zurcher <jeremy@asynk.ch>
+	* usable WIP
+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-05 Jérémy Zurcher <jeremy@asynk.ch>
+	* haml engine
+	* optional engine cache
+	* optional engine proc mime-type definition
+	* optional static page generation/cache
+	*

data/lib/zorglub/app.rb CHANGED Viewed

@@ -11,7 +11,9 @@ module Zorglub
             @map = map
             instance_eval &block if block_given?
             remap @map
+            @engines_cache = { }
         end
+        attr_reader :engines_cache
         #
         def map location, object
             return unless location and object

data/lib/zorglub/config.rb CHANGED Viewed

@@ -9,10 +9,17 @@ module Zorglub
             :layout => 'default',
             :view_dir => 'view',
             :layout_dir => 'layout',
+            :static_dir => 'static',
             :session_on => false,
             :session_key => 'zorglub.sid',
             :session_secret => 'session-secret-secret',
-            :session_sid_len => 64
+            :session_sid_len => 64,
+            :engines_cache_enabled => true,
+            :haml_options => {
+                :format => :html5,
+                :ugly => false,
+                :encoding => 'utf-8'
+            }
         #
         }
         @engines = { }
@@ -36,6 +43,11 @@ module Zorglub
                 ( p.nil? ? File.join(@options[:root], @options[:layout_dir]) : p )
             end
             #
+            def static_base_path
+                p = @options[:static_path]
+                ( p.nil? ? File.join(@options[:root], @options[:static_dir]) : p )
+            end
+            #
             def register_engine name, ext, proc
                 return unless name
                 @engines[name]=[ ext, proc ]

data/lib/zorglub/engines/haml.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# -*- coding: UTF-8 -*-
+#
+require 'haml/util'
+require 'haml/engine'
+#
+module Zorglub
+    module Engines
+        module Haml
+            def self.proc path,obj
+                if Zorglub::Config.engines_cache_enabled
+                    key = path.sub Zorglub::Config.root,''
+                    haml = obj.app.engines_cache[key] ||= ::Haml::Engine.new( File.open(path,'r'){|f| f.read }, Zorglub::Config.haml_options )
+                else
+                    haml = ::Haml::Engine.new( File.open(path,'r'){|f| f.read }, Zorglub::Config.haml_options )
+                end
+                html = haml.render(obj)
+                return html, 'text/html'
+            end
+        end
+    end
+end
+#
+Zorglub::Config.register_engine :haml, 'haml', Zorglub::Engines::Haml.method(:proc)
+#
+# EOF

data/lib/zorglub/node.rb CHANGED Viewed

@@ -32,6 +32,11 @@ module Zorglub
                 @layout ||= Config.layout
             end
             #
+            def static val=nil
+                @static = val if (val==true or val==false)
+                @static ||=false
+            end
+            #
             def inherited_var sym, *args
                 var = @inherited_vars[sym] ||=[]
                 unless args.empty?
@@ -41,7 +46,7 @@ module Zorglub
                 var
             end
             #
-            attr_writer :app
+            attr_accessor :app
             def map app, location
                 @app = app
                 @app.map location, self
@@ -55,13 +60,13 @@ module Zorglub
             def call env
                 meth, *args =  env['PATH_INFO'].sub(/^\//,'').split '/'
                 meth||= 'index'
-                node = self.new env, {:engine=>engine,:layout=>layout,:view=>r(meth),:method=>meth,:args=>args}
+                node = self.new env, {:engine=>engine,:layout=>layout,:view=>r(meth),:method=>meth,:args=>args,:static=>static}
                 return error_404 node if not node.respond_to? meth
                 node.realize!
             end
             #
             def partial meth, *args
-                node = self.new nil, {:engine=>engine,:layout=>nil,:view=>r(meth),:method=>meth.to_s,:args=>args}
+                node = self.new nil, {:engine=>engine,:layout=>nil,:view=>r(meth),:method=>meth.to_s,:args=>args,:static=>static}
                 return error_404 node if not node.respond_to? meth
                 node.feed!
                 node.content
@@ -95,11 +100,11 @@ module Zorglub
             #
         end
         #
-        attr_reader :action, :request, :response, :content
+        attr_reader :options, :request, :response, :content, :mime
         #
-        def initialize env, action
+        def initialize env, options
             @env = env
-            @action = action
+            @options = options
             @request = Rack::Request.new env
             @response = Rack::Response.new
         end
@@ -108,23 +113,50 @@ module Zorglub
             catch(:stop_realize) {
                 feed!
                 response.write @content
+                response.header['Content-Type'] = @mime||'text/html'
                 response.finish
                 response
             }
         end
         #
         def feed!
+            state :pre_cb
             Node.call_before_hooks self
             state :meth
-            @content = self.send @action[:method], *@action[:args]
-            v, l, e = view, layout, Config.engine_proc(@action[:engine])
-            # TODO compile and cache
-            state (@action[:layout].nil? ? :partial : :view)
-            @content = e.call v, self if e and File.exists? v
-            state :layout
-            @content = e.call l, self if e and File.exists? l
+            @content = self.send @options[:method], *@options[:args]
+            static_path = static
+            if static_path.nil?
+                compile!
+            else
+                static! static_path
+            end
+            state :post_cb
             Node.call_after_hooks self
-            @content
+            state :finished
+            return @content, @mime
+        end
+        #
+        def static! path
+            if not File.exists? path
+                compile!
+                Dir.mkdir Config.static_base_path
+                Dir.mkdir File.dirname path
+                File.open(path, 'w') {|f| f.write(@content); f.write("\n@mime:"+@mime) }
+            else
+                content = File.open(path, 'r') {|f| f.read }
+                @content = content.sub /\n@mime:(.*)$/,''
+                @mime = $1
+            end
+        end
+        #
+        def compile!
+            v, l, e = view, layout, Config.engine_proc(@options[:engine])
+            state (@options[:layout].nil? ? :partial : :view)
+            @content, mime = e.call v, self if e and File.exists? v
+            @mime = mime unless mime.nil?
+            state :layout
+            @content, mime = e.call l, self if e and File.exists? l
+            @mime = mime unless mime.nil?
         end
         #
         def redirect target, options={}, &block
@@ -139,29 +171,35 @@ module Zorglub
         end
         #
         def state state=nil
-            @action[:state] = state unless state.nil?
-            @action[:state]
+            @options[:state] = state unless state.nil?
+            @options[:state]
         end
         #
         def engine engine=nil
-            @action[:engine] = engine unless engine.nil? or engine.empty?
-            @action[:engine]
+            @options[:engine] = engine unless engine.nil? or engine.empty?
+            @options[:engine]
         end
         #
         def layout layout=nil
-            @action[:layout] = layout unless layout.nil? or layout.empty?
-            return '' if @action[:layout].nil?
-            File.join(Config.layout_base_path, @action[:layout])+ Config.engine_ext(@action[:engine])
+            @options[:layout] = layout unless layout.nil? or layout.empty?
+            return '' if @options[:layout].nil?
+            File.join(Config.layout_base_path, @options[:layout])+ Config.engine_ext(@options[:engine])
         end
         #
         def no_layout
-            @action[:layout] = nil
+            @options[:layout] = nil
+        end
+        #
+        def static val=nil
+            @options[:static] = val if (val==true or val==false)
+            return nil if not @options[:static] or @options[:view].nil?
+            File.join(Config.static_base_path, @options[:view])+Config.engine_ext(@options[:engine])
         end
         #
         def view view=nil
-            @action[:view] = view unless view.nil? or view.empty?
-            return '' if @action[:view].nil?
-            File.join(Config.view_base_path, @action[:view])+Config.engine_ext(@action[:engine])
+            @options[:view] = view unless view.nil? or view.empty?
+            return '' if @options[:view].nil?
+            File.join(Config.view_base_path, @options[:view])+Config.engine_ext(@options[:engine])
         end
         #
         def inherited_var sym, *args
@@ -173,8 +211,12 @@ module Zorglub
             d
         end
         #
+        def app
+            self.class.app
+        end
+        #
         def args
-            @action[:args]
+            @options[:args]
         end
         #
         def map
@@ -182,7 +224,7 @@ module Zorglub
         end
         #
         def r *args
-            File.join map, (args.empty? ? @action[:method] : args.map { |x| x.to_s } )
+            File.join map, (args.empty? ? @options[:method] : args.map { |x| x.to_s } )
         end
         #
         def html

data/lib/zorglub.rb CHANGED Viewed

@@ -7,7 +7,7 @@ require './lib/zorglub/app'
 #
 module Zorglub
     #
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
     #
 end
 #

data/spec/node_spec.rb CHANGED Viewed

@@ -2,9 +2,24 @@
 #
 require 'spec_helper'
 #
+def clean_static_path
+    static_base_path = Zorglub::Config.static_base_path
+    Dir.glob( File.join(static_base_path,'**','*') ).each do |f| File.unlink f if File.file? f end
+    Dir.glob( File.join(static_base_path,'*') ).each do |d| Dir.rmdir d end
+    Dir.rmdir static_base_path if File.directory? static_base_path
+end
+#
 describe Zorglub do
     #
     describe Zorglub::Node do
+        #
+        before(:all) do
+            clean_static_path
+        end
+        #
+        after(:all) do
+            clean_static_path
+        end
         #
         it "engine should return default Node's engine" do
             Node0.engine.should == Zorglub::Config.engine
@@ -118,6 +133,16 @@ describe Zorglub do
             r.body[0].should == "layout_start view_content layout_end"
         end
         #
+        it "default mime-type should be text/html" do
+            r = Node0.my_call '/index'
+            r.header['Content-type'].should == 'text/html'
+        end
+        #
+        it "should be able to override mime-type" do
+            r = Node0.my_call '/do_render'
+            r.header['Content-type'].should == 'text/view'
+        end
+        #
         it "partial should render correctly" do
             Node0.partial(:do_partial, 1, 2).should == 'partial_content'
         end
@@ -126,6 +151,21 @@ describe Zorglub do
             Node0.partial(:other_view).should == 'partial_content'
         end
         #
+        it "static pages should be generated" do
+            r = Node0.my_call '/do_static'
+            r.body[0].should == 'VAL 1'
+            r.header['Content-type'].should == 'text/static'
+            r = Node0.my_call '/do_static'
+            r.body[0].should == 'VAL 1'
+            r.header['Content-type'].should == 'text/static'
+            r = Node0.my_call '/do_static'
+            r.body[0].should == 'VAL 1'
+            r.header['Content-type'].should == 'text/static'
+            r = Node0.my_call '/no_static'
+            r.body[0].should == 'VAL 4'
+            r.header['Content-type'].should == 'text/static'
+        end
+        #
         it "redirect should work" do
             r = Node0.my_call '/do_redirect'
             r.status.should == 302

data/spec/spec_helper.rb CHANGED Viewed

@@ -13,14 +13,15 @@ require 'yaml'
 require 'zorglub'
 #
 HASH_PROC = Proc.new { |path,obj| {:path=>path,:layout=>obj.layout,:view=>obj.view,:args=>obj.args,:map=>obj.map}.to_yaml }
+STATIC_PROC = Proc.new { |path,obj| ["VAL #{obj.value}",'text/static'] }
 RENDER_PROC = Proc.new { |path,obj|
     case obj.state
     when :layout
         "layout_start #{obj.content} layout_end"
     when :view
-        "view_content"
+        ["view_content", 'text/view']
     when :partial
-        'partial_content'
+        ['partial_content','text/partial']
     else
         raise Exception.new
     end
@@ -29,6 +30,7 @@ Zorglub::Config.register_engine 'default', nil, HASH_PROC
 Zorglub::Config.register_engine 'engine-1', 'spec', HASH_PROC
 Zorglub::Config.register_engine 'engine-2', 'spec', HASH_PROC
 Zorglub::Config.register_engine 'real', nil, RENDER_PROC
+Zorglub::Config.register_engine 'static', nil, STATIC_PROC
 #
 Zorglub::Config[:engine] = 'default'
 Zorglub::Config.root = File.join Dir.pwd, 'spec', 'data'
@@ -43,6 +45,10 @@ class Temp < Zorglub::Node
 end
 #
 class Node0 < Zorglub::Node
+    @static_cpt=0
+    class << self
+        attr_accessor :static_cpt
+    end
     # default
     def index
         html
@@ -66,6 +72,21 @@ class Node0 < Zorglub::Node
     def do_redirect
         redirect r(:do_partial,1,2,3)
     end
+    attr_reader :value
+    def no_static
+        static false
+        engine 'static'
+        view r('do_render')
+        Node0.static_cpt+=1
+        @value = Node0.static_cpt
+    end
+    def do_static
+        static true
+        engine 'static'
+        view r('do_render')
+        Node0.static_cpt+=1
+        @value = Node0.static_cpt
+    end
 end
 #
 class Node1 < Zorglub::Node

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zorglub
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease:
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-01-04 00:00:00.000000000 Z
+date: 2012-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &15670960 !ruby/object:Gem::Requirement
+  requirement: &23307900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *15670960
+  version_requirements: *23307900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15670060 !ruby/object:Gem::Requirement
+  requirement: &23323560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *15670060
+  version_requirements: *23323560
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15669580 !ruby/object:Gem::Requirement
+  requirement: &23322980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *15669580
+  version_requirements: *23322980
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &15668980 !ruby/object:Gem::Requirement
+  requirement: &23322340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: 3.7.3
   type: :development
   prerelease: false
-  version_requirements: *15668980
+  version_requirements: *23322340
 description: a nano web application framework based on rack[http://rack.rubyforge.org/]
 email: jeremy@asynk.ch
 executables: []
@@ -67,31 +67,32 @@ files:
 - README.rdoc
 - Rakefile
 - lib/zorglub.rb
-- lib/zorglub/session.rb
 - lib/zorglub/app.rb
-- lib/zorglub/rack_session.rb
-- lib/zorglub/node.rb
 - lib/zorglub/config.rb
+- lib/zorglub/engines/haml.rb
+- lib/zorglub/node.rb
+- lib/zorglub/rack_session.rb
+- lib/zorglub/session.rb
+- spec/app_spec.rb
+- spec/data/layout/default
+- spec/data/layout/main.spec
 - spec/data/view/node0/do_partial
 - spec/data/view/node0/do_render
-- spec/data/layout/main.spec
-- spec/data/layout/default
-- spec/spec_helper.rb
 - spec/node_spec.rb
-- spec/app_spec.rb
-- tasks/spec.rake
-- tasks/helpers.rb
-- tasks/git.rake
-- tasks/test.rake
+- spec/spec_helper.rb
+- tasks/ann.rake
 - tasks/constants.rb
-- tasks/svn.rake
+- tasks/gem.rake
+- tasks/git.rake
+- tasks/helpers.rb
+- tasks/notes.rake
 - tasks/post_load.rake
+- tasks/rdoc.rake
 - tasks/rubyforge.rake
-- tasks/notes.rake
 - tasks/setup.rb
-- tasks/gem.rake
-- tasks/ann.rake
-- tasks/rdoc.rake
+- tasks/spec.rake
+- tasks/svn.rake
+- tasks/test.rake
 homepage: http://cgit.asynk.ch/cgi-bin/cgit/zorglub
 licenses: []
 post_install_message: