zorglub 0.0.1

data/Changelog

@@ -0,0 +1,2 @@
+FIME-date Jérémy Zurcher <jeremy@asynk.ch>
+	* Project creation

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2011-2012 Jérémy Zurcher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,55 @@
+zorglub
+    by Jérémy Zurcher
+    http://cgit.asynk.ch/cgi-bin/cgit/zorglub
+
+== DESCRIPTION:
+
+a nano web application framework based on rack[http://rack.rubyforge.org/]
+
+== FEATURES:
+
+* class#method mapping scheme (/class_mapping/method_name/*args)
+* class level layout and engine specification
+* method level layout, engine and view specification
+* before_all and after_all methods callbacks
+* redirection
+* partial
+* class level inherited variables
+* session
+
+== SYNOPSIS:
+
+For a simple test application run:
+* rackup ./example/sample.ru
+
+Don't forget to look at
+* the spec/ folder
+
+== REQUIREMENTS:
+
+* rack
+
+== DOWNLOAD/INSTALL:
+
+From rubygems:
+
+  [sudo] gem install zorglub
+
+or from the git repository on github:
+
+  git clone git://github.com/jeremyz/zorglub.git
+  cd zorglub
+  rake gem:install
+
+== RESOURCES:
+
+You can find this project in a few places:
+
+Online repositories:
+
+* https://github.com/jeremyz/zorglub
+* http://cgit.asynk.ch/cgi-bin/cgit/zorglub/
+
+== LICENSE:
+
+See MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,58 @@
+# -*- coding: UTF-8 -*-
+#
+require './lib/zorglub.rb'
+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

data/lib/zorglub/app.rb

@@ -0,0 +1,45 @@
+# -*- coding: UTF-8 -*-
+#
+require 'rack'
+#
+module Zorglub
+    #
+    class App < Rack::URLMap
+        #
+        def initialize map={}, &block
+            super
+            @map = map
+            instance_eval &block if block_given?
+            remap @map
+        end
+        #
+        def map location, object
+            return unless location and object
+            raise Exception.new "#{@map[location]} already mapped to #{location}" if @map.has_key? location
+            object.app = self
+            @map.merge! location.to_s=>object
+            remap @map
+        end
+        #
+        def delete location
+            @map.delete location
+            remap @map
+        end
+        #
+        def at location
+            @map[location]
+        end
+        #
+        def to object
+            @map.invert[object]
+        end
+        #
+        def to_hash
+            @map.dup
+        end
+        #
+    end
+    #
+end
+#
+# EOF

data/lib/zorglub/config.rb

@@ -0,0 +1,66 @@
+# -*- coding: UTF-8 -*-
+#
+module Zorglub
+    #
+    class Config
+        @options = {
+            :root => '.',
+            :engine => nil,
+            :layout => 'default',
+            :view_dir => 'view',
+            :layout_dir => 'layout',
+            :session_on => false
+        }
+        @engines = { }
+        class << self
+            #
+            def [] k
+                @options[k]
+            end
+            #
+            def []= k, v
+                @options[k]=v
+            end
+            #
+            def view_base_path
+                p = @options[:view_path]
+                ( p.nil? ? File.join(@options[:root], @options[:view_dir]) : p )
+            end
+            #
+            def layout_base_path
+                p = @options[:layout_path]
+                ( p.nil? ? File.join(@options[:root], @options[:layout_dir]) : p )
+            end
+            #
+            def register_engine name, ext, proc
+                return unless name
+                @engines[name]=[ ext, proc ]
+            end
+            #
+            def engine_ext engine
+                e = @engines[engine]
+                return '' if e.nil?
+                x=e[0]
+                ( x.nil? ? '' : '.'+x )
+            end
+            #
+            def engine_proc engine
+                e = @engines[engine]
+                ( e.nil? ? nil : e[1] )
+            end
+            #
+        end
+        #
+        def self.method_missing m, *args, &block
+            if m=~/(.*)=$/
+                @options[$1.to_sym]=args[0]
+            else
+                @options[m.to_sym]
+            end
+        end
+        #
+    end
+    #
+end
+#
+# EOF

data/lib/zorglub/node.rb

@@ -0,0 +1,196 @@
+# -*- coding: UTF-8 -*-
+#
+module Zorglub
+    #
+    class Node
+        #
+        @hooks = {
+            :before_all => [],
+            :after_all => [],
+        }
+        #
+        @inherited_vars = { }
+        #
+        class << self
+            #
+            attr_reader :hooks, :inherited_vars
+            #
+            def inherited sub
+                sub.layout layout
+                sub.engine engine
+                sub.instance_variable_set :@inherited_vars, {}
+                @inherited_vars.each do |s,v| sub.inherited_var s, *v end
+            end
+            #
+            def engine engine=nil
+                @engine = engine unless engine.nil? or engine.empty?
+                @engine ||= Config.engine
+            end
+            #
+            def layout layout=nil
+                @layout = layout unless layout.nil? or layout.empty?
+                @layout ||= Config.layout
+            end
+            #
+            def inherited_var sym, *args
+                var = @inherited_vars[sym] ||=[]
+                unless args.empty?
+                    var.concat args
+                    var.uniq!
+                end
+                var
+            end
+            #
+            attr_writer :app
+            def map app, location
+                @app = app
+                @app.map location, self
+            end
+            #
+            def r *args
+                @r ||= @app.to self
+                (args.empty? ? @r : File.join( @r, args.map { |x| x.to_s } ) )
+            end
+            #
+            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}
+                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}
+                return error_404 node if not node.respond_to? meth
+                node.feed!
+                node.content
+            end
+            #
+            def call_before_hooks obj
+                Node.hooks[:before_all].each do |blk| blk.call obj end
+            end
+            #
+            def before_all &blk
+                Node.hooks[:before_all]<< blk
+                Node.hooks[:before_all].uniq!
+            end
+            #
+            def call_after_hooks obj
+                Node.hooks[:after_all].each do |blk| blk.call obj end
+            end
+            #
+            def after_all &blk
+                Node.hooks[:after_all]<< blk
+                Node.hooks[:after_all].uniq!
+            end
+            #
+            def error_404 node
+                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
+            end
+            #
+        end
+        #
+        attr_reader :action, :request, :response, :content
+        #
+        def initialize env, action
+            @env = env
+            @action = action
+            @request = Rack::Request.new env
+            @response = Rack::Response.new
+        end
+        #
+        def realize!
+            catch(:stop_realize) {
+                feed!
+                response.write @content
+                response.finish
+                response
+            }
+        end
+        #
+        def feed!
+            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
+            Node.call_after_hooks self
+            @content
+        end
+        #
+        def redirect target, options={}, &block
+            status = options[:status] || 302
+            body   = options[:body] || redirect_body(target)
+            header = response.header.merge('Location' => target.to_s)
+            throw :stop_realize, Rack::Response.new(body, status, header, &block)
+        end
+        #
+        def redirect_body target
+            "You are being redirected, please follow this link to: <a href='#{target}'>#{target}</a>!"
+        end
+        #
+        def state state=nil
+            @action[:state] = state unless state.nil?
+            @action[:state]
+        end
+        #
+        def engine engine=nil
+            @action[:engine] = engine unless engine.nil? or engine.empty?
+            @action[: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])
+        end
+        #
+        def no_layout
+            @action[:layout] = nil
+        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])
+        end
+        #
+        def inherited_var sym, *args
+            d = self.class.inherited_vars[sym].clone || []
+            unless args.empty?
+                d.concat args
+                d.uniq!
+            end
+            d
+        end
+        #
+        def args
+            @action[:args]
+        end
+        #
+        def map
+            self.class.r
+        end
+        #
+        def r *args
+            File.join map, (args.empty? ? @action[:method] : args.map { |x| x.to_s } )
+        end
+        #
+        def html
+            [ :map, :r, :args, :engine, :layout, :view ].inject('') { |s,sym| s+="<p>#{sym} => #{self.send sym}</p>"; s }
+        end
+        #
+    end
+    #
+end
+#
+# EOF

data/lib/zorglub/session.rb

@@ -0,0 +1,81 @@
+# -*- coding: UTF-8 -*-
+#
+require 'securerandom'
+#
+module Zorglub
+    #
+    class Node
+        #
+        def session
+            @session ||= Session.new @request
+        end
+    end
+    #
+    class SessionHash
+        #
+        @data = {}
+        class << self
+            attr_reader :data
+        end
+        #
+        def initialize sid
+            @sid = sid
+            # TODO if sid is nil, one should be created
+            @session_data = SessionHash.data[sid]||={}
+        end
+        #
+        def exists?
+            not @sid.nil?
+        end
+        #
+        def [] idx
+            @session_data[idx]
+        end
+        #
+        def []= idx, v
+            @session_data[idx] = v
+        end
+    end
+    #
+    class Session
+        #
+        @session_key =  'zorglub.sid'
+        @session_kls = Zorglub::SessionHash
+        class << self
+            attr_accessor :session_key, :session_kls
+        end
+        #
+        def initialize req
+            @request = req
+            @instance = nil
+        end
+        #
+        def setup!
+            if Config.session_on
+                @instance = Session.session_kls.new @request.cookies[Session.session_key]
+            else
+                @instance = {}
+            end
+        end
+        private :setup!
+        #
+        def exists?
+            setup! if @instance.nil?
+            @instance.exists?
+        end
+        #
+        def [] idx
+            setup! if @instance.nil?
+            @instance[idx]
+        end
+        #
+        def []= idx, v
+            setup! if @instance.nil?
+            @instance[idx] = v
+        end
+        #
+    end
+    #
+end
+#
+# EOF

data/lib/zorglub.rb

@@ -0,0 +1,14 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+require './lib/zorglub/config'
+require './lib/zorglub/node'
+require './lib/zorglub/app'
+#
+module Zorglub
+    #
+    VERSION = '0.0.1'
+    #
+end
+#
+# EOF

data/spec/app_spec.rb

@@ -0,0 +1,43 @@
+# -*- coding: UTF-8 -*-
+#
+require 'spec_helper'
+#
+describe Zorglub do
+    #
+    describe Zorglub::App do
+        #
+        it "map should add a mapped node" do
+            APP.at("/temp").should be_nil
+            APP.map "/temp", Temp
+            APP.at("/temp").should be Temp
+        end
+        #
+        it "delete should delete a mapped node" do
+            APP.at("/temp").should be Temp
+            APP.delete "/temp"
+            APP.at("/temp").should be_nil
+        end
+        #
+        it "at should return mapped node" do
+            APP.at("/node1").should be Node1
+        end
+        #
+        it "at should return nil if no Node mapped" do
+            APP.at("/none").should be_nil
+        end
+        #
+        it "to should return path to node" do
+            APP.to(Node1).should == "/node1"
+        end
+        #
+        it "to should return nil if not an existing Node" do
+            APP.to(nil).should be_nil
+        end
+        #
+        it "to_hash should return a correct hash" do
+            APP.to_hash["/node1"].should be Node1
+        end
+        #
+    end
+    #
+end