rack-golem 0.0.1

data/README.md

@@ -0,0 +1,84 @@
+>Made of consonants and vowels,  
+>there is a terrible Name,  
+>that in its essence encodes God’s all,  
+>power, guarded in letters, in hidden syllables.  -- Jorge Luis Borges
+
+GOLEM
+=====
+
+I would describe Golem as a Ramaze for kids.  
+Golem is not a framework though, just a controller, but you know... the kind of controller that leaves you in the train 
+even if you did not buy a ticket.  
+It leaves you on the rails if you will (incredibly good pun intended).
+
+Install with:
+
+    sudo gem install rack-golem
+
+Config.ru is one of his names, so say it in a Rackup file.
+
+    require 'db' # Loads ORM models and all
+    require 'go' # Our controller (I don not like that word really)
+    use Rack::ContentLength
+    use Rack::Session::Cookies
+    run Go
+
+And the winner is:
+
+    require 'rack/golem'
+
+  	class Go
+	    include Rack::Golem # To hell with sub-classes !!!
+
+	    before do
+	      # Here you can do many things
+	      # In order to help you here are some variables you can read and override:
+	      # @r => the Rack::Request object
+	      # @res => the Rack::Response object
+	      # @action => Name of the public method that will handle the request
+	      # @action_arguments => Arguments for the action (really?)
+	    end
+
+	    def index(*args)
+	      # When no public method is found
+	      # Of course you don't have to declare one and it is gonna use Controller#not_found instead
+	      # But if it is declared, keep in mind it's a catch-all so make it deal with args
+	      @articles = Post.all
+	      erb :index
+	    end
+
+	    def post(id=nil)
+	      @post = Post[id]
+	      if @post.nil?
+	        not_found
+	      else
+	        erb :post
+	      end
+	    end
+
+	    def say(listener='me', *words)
+	      "Hey #{listener} I don't need ERB to tell you that #{words.join(' ')}"
+	    end
+
+	    def not_found(*args)
+	      # This one is defined by Golem but here we decided to override it
+	      # Like :index this method receives the arguments in order to make something with it
+	      Email.alert('Too many people are looking for porn here') if args.includes?("porn")
+	      super(args)
+	    end
+
+	    after do
+	      Spy.analyse.send_info_to([:government, :facebook, :google, :james_bond])
+	    end
+
+	  end
+
+Hopefully no headache.
+
+WHAT GOLEM DOES NOT
+===================
+
+- Support templates other than ERB (I plan to use Tilt more cleverly though in order to achieve that without selling my soul)
+- Session/Cookies administration (Like for many things, use a middleware instead ex: Rack::Session::Cookies)
+- Prepare the coffee (Emacs does but Ed is the standard text editor)
+- So many things, why bother...

data/lib/rack/golem.rb

@@ -0,0 +1,65 @@
+module Rack::Golem
+  
+  def self.included(klass)
+    klass.class_eval do
+      extend ClassMethods
+      include InstanceMethods
+    end
+  end
+  
+  module ClassMethods
+    attr_reader :before_block, :after_block
+    def before(&block); @before_block = block; end
+    def after(&block); @after_block = block; end
+    def dispatcher(&block); @dispatcher_block = block; end
+    def dispatcher_block
+      @dispatcher_block || proc{
+        @path_atoms = @r.path_info.split('/').find_all{|s| s!=''}
+        @action, *@action_arguments = @path_atoms
+        unless public_methods.include?(@action)
+          if public_methods.include?('index')
+            @action, @action_arguments = 'index', @path_atoms
+          else
+            @action, @action_arguments = 'not_found', @path_atoms
+          end
+        end
+        
+        instance_eval(&self.class.before_block) unless self.class.before_block.nil?
+        
+        @res.write(self.__send__(@action,*@action_arguments))
+        
+        instance_eval(&self.class.after_block) unless self.class.after_block.nil?
+      }
+    end
+  end
+  
+  module InstanceMethods
+    def initialize(app=nil); @app = app; end
+    def call(env); dup.call!(env); end
+    def call!(env)
+      @r = ::Rack::Request.new(env)
+      @res = ::Rack::Response.new
+      instance_eval(&self.class.dispatcher_block)
+      @res.status==404&&!@app.nil? ? @app.call(env) : @res.finish
+    end
+    def not_found(*args)
+      @res.status = 404
+      @res.headers['X-Cascade']='pass'
+      "Not Found: #{@r.path_info}"
+    end
+    def erb(template)
+      @@tilt_cache ||= {}
+      if @@tilt_cache.has_key?(template)
+        template_obj = @@tilt_cache[template]
+      else
+        erb_extention = @r.env['erb.extention'] || ".erb"
+        views_location = @r.env['erb.location'] || ::Dir.pwd+'/views/'
+        views_location << '/' unless views_location[-1]==?/
+        template_obj = Tilt.new("#{views_location}#{template}#{erb_extention}")
+        @@tilt_cache.store(template,template_obj) if ENV['RACK_ENV']=='production'
+      end
+      template_obj.render(self)
+    end
+  end
+  
+end

data/lib/rack_golem.rb

@@ -0,0 +1 @@
+require 'rack/golem'

data/rack-golem.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s| 
+  s.name = 'rack-golem'
+  s.version = "0.0.1"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "A Controller middleware that is euh... basic"
+  s.description = "A Controller middleware that is euh... basic. I would say it is a sort of Ramaze for kids"
+  s.files = `git ls-files`.split("\n").sort
+  s.require_path = './lib'
+  s.author = "Mickael Riga"
+  s.email = "mig@campbellhay.com"
+  s.homepage = "http://www.campbellhay.com"
+end

data/test/spec_golem.rb

@@ -0,0 +1,95 @@
+require 'rubygems'
+require 'bacon'
+require 'rack'
+require 'rack/lobster'
+require 'fileutils' # fix Rack missing
+
+Bacon.summary_on_exit
+
+# Helpers
+F = ::File
+D = ::Dir
+ROOT = F.dirname(__FILE__)+'/..'
+$:.unshift ROOT+'/lib'
+require 'rack/golem'
+
+# =========
+# = Basic =
+# =========
+
+class Basic
+  include Rack::Golem
+  def no_arg; 'nothing'; end  
+  def with_args(a,b); '%s+%s' % [a,b]; end 
+  def splat_arg(*a); a.join('+'); end
+  private
+  def no_way; 'This is private'; end
+end
+BasicR = ::Rack::MockRequest.new(::Rack::Lint.new(Basic.new))
+BasicLobsterR = ::Rack::MockRequest.new(::Rack::Lint.new(Basic.new(::Rack::Lobster.new)))
+
+# ==========
+# = Filter =
+# ==========
+
+class Filter
+  include Rack::Golem
+  before{@res.write @action=='not_found' ? @action_arguments.join('+') : 'before+'}
+  after{@res.write '+after'}
+  def wrapped; 'wrapped'; end
+end
+FilterR = ::Rack::MockRequest.new(::Rack::Lint.new(Filter.new))
+
+# ===========
+# = Indexed =
+# ===========
+
+class Indexed
+  include Rack::Golem
+  before{ @res.write("action=#{@action} args=#{@action_arguments.join(',')} ") if @r['switch']=='true' }
+  def index(*a); a.join('+'); end
+  def exist(*a); a.join('+'); end
+end
+IndexedR = ::Rack::MockRequest.new(::Rack::Lint.new(Indexed.new))
+
+# =========
+# = Specs =
+# =========
+
+describe "Golem" do
+  it "Should dispatch on a method with no arguments" do
+    BasicR.get('/no_arg').body.should=='nothing'
+  end
+  it "Should dispatch on a method with arguments" do
+    BasicR.get('/with_args/a/b').body.should=='a+b'
+  end
+  it "Should dispatch on a method with splat argument" do
+    BasicR.get('/splat_arg/a/b/c/d').body.should=='a+b+c+d'
+  end
+  it "Should not dispatch if the method is private or does not exist" do
+    r = BasicR.get('/no_way')
+    r.status.should==404
+    r.body.should=='Not Found: /no_way'
+    r = BasicR.get('/no')
+    r.status.should==404
+    r.body.should=='Not Found: /no'
+  end
+  it "Should follow the rack stack if response is 404 and there are middlewares below" do
+    r = BasicLobsterR.get("/no_way")
+    r.status.should==200
+  end
+  it "Should provide filters" do
+    FilterR.get('/wrapped').body.should=="before+wrapped+after"
+  end
+  it "Should provide arguments in filter when page is not_found" do
+    FilterR.get('/a/b/c/d').body.should=="a+b+c+dNot Found: /a/b/c/d+after"
+  end
+  it "Should send everything to :index if it exists and there is no matching method for first arg" do
+    IndexedR.get('/exist/a/b/c/d').body.should=='a+b+c+d'
+    Indexed.new.public_methods.include?(:index)
+    IndexedR.get('/a/b/c/d').body.should=='a+b+c+d'
+  end
+  it "Should set dispatch-specific variables correctly when defaulting to :index" do
+    IndexedR.get('/a/b/c/d?switch=true').body.should=="action=index args=a,b,c,d a+b+c+d"
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: rack-golem
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mickael Riga
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-22 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A Controller middleware that is euh... basic. I would say it is a sort of Ramaze for kids
+email: mig@campbellhay.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/rack/golem.rb
+- lib/rack_golem.rb
+- rack-golem.gemspec
+- test/spec_golem.rb
+has_rdoc: true
+homepage: http://www.campbellhay.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A Controller middleware that is euh... basic
+test_files: []
+