kazoo 0.0.2 → 0.0.5

data/Manifest

@@ -2,6 +2,15 @@ MIT-License
 Manifest
 Rakefile
 lib/kazoo.rb
+lib/kazoo/accessors.rb
 lib/kazoo/router.rb
+lib/kazoo/router/context.rb
+lib/kazoo/router/route.rb
 lib/kazoo/sinatra.rb
+lib/kazoo/support.rb
 readme.markdown
+spec/router/context_spec.rb
+spec/router/route_spec.rb
+spec/router_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/Rakefile

@@ -2,11 +2,19 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('kazoo', '0.0.2') do |p|
-  p.description    = "Make your Ruby Rack apps act like one"
+require 'rspec'
+require 'rspec/core/rake_task'
+
+Echoe.new('kazoo', '0.0.5') do |p|
+  p.description    = "A moduler framework to facilitate the development of content management systems"
   p.url            = "http://rubykazoo.com"
   p.author         = "Jeremy Nicoll"
   p.email          = "jnicoll @nspam@ accentuate.me"
   p.ignore_pattern = ['*.kpf', "tmp/*", "script/*"]
   p.development_dependencies = []
-end
+end
+
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/kazoo.gemspec

@@ -2,23 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kazoo}
-  s.version = "0.0.2"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremy Nicoll"]
   s.cert_chain = ["/Users/eltiare/keys/gem-public_cert.pem"]
-  s.date = %q{2011-01-28}
-  s.description = %q{Make your Ruby Rack apps act like one}
+  s.date = %q{2011-02-16}
+  s.description = %q{A moduler framework to facilitate the development of content management systems}
   s.email = %q{jnicoll @nspam@ accentuate.me}
-  s.extra_rdoc_files = ["lib/kazoo.rb", "lib/kazoo/router.rb", "lib/kazoo/sinatra.rb"]
-  s.files = ["MIT-License", "Manifest", "Rakefile", "lib/kazoo.rb", "lib/kazoo/router.rb", "lib/kazoo/sinatra.rb", "readme.markdown", "kazoo.gemspec"]
+  s.extra_rdoc_files = ["lib/kazoo.rb", "lib/kazoo/accessors.rb", "lib/kazoo/router.rb", "lib/kazoo/router/context.rb", "lib/kazoo/router/route.rb", "lib/kazoo/sinatra.rb", "lib/kazoo/support.rb"]
+  s.files = ["MIT-License", "Manifest", "Rakefile", "lib/kazoo.rb", "lib/kazoo/accessors.rb", "lib/kazoo/router.rb", "lib/kazoo/router/context.rb", "lib/kazoo/router/route.rb", "lib/kazoo/sinatra.rb", "lib/kazoo/support.rb", "readme.markdown", "spec/router/context_spec.rb", "spec/router/route_spec.rb", "spec/router_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "kazoo.gemspec"]
   s.homepage = %q{http://rubykazoo.com}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Kazoo", "--main", "readme.markdown"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{kazoo}
-  s.rubygems_version = %q{1.4.2}
+  s.rubygems_version = %q{1.5.0}
   s.signing_key = %q{/Users/eltiare/keys/gem-private_key.pem}
-  s.summary = %q{Make your Ruby Rack apps act like one}
+  s.summary = %q{A moduler framework to facilitate the development of content management systems}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/kazoo.rb

@@ -1,4 +1,12 @@
+$LOAD_PATH.push(File.dirname(__FILE__))
+
+require 'cgi'
+
 module Kazoo;   end
 
-base_path = File.dirname(__FILE__)
-#Dir["#{base_path}/kazoo/*.rb"].each { |library| require library }
+require "kazoo/support"
+require "kazoo/accessors"
+
+require 'kazoo/router/route'
+require 'kazoo/router/context'
+require "kazoo/router"

data/lib/kazoo/accessors.rb

@@ -0,0 +1,9 @@
+module Kazoo
+  
+  def self.admin_router(&blk)
+    @_admin_router ||= Kazoo::Router.new
+    @_admin_router.map(&blk) if block_given?
+    @_admin_router
+  end
+
+end

data/lib/kazoo/router.rb

@@ -1,37 +1,55 @@
 class Kazoo::Router
   
   def self.map(&blk)
-    instance = new
-    instance.instance_eval(&blk)
-    instance
+    new.map(&blk)
   end
   
-  def initialize
-    @routes = []
+  def map(&blk)
+    @context ||= Context.new(self)
+    @context.instance_eval(&blk)
+    self
   end
   
-  def match(path, options = {})
-    raise "You must match a route to an app using :to" unless options[:to] && options[:to].respond_to?(:call)
-    if path.is_a?(Regexp)
-      @routes << [ path, options[:to] ]
-    elsif path.is_a?(String)
-      @routes << [ Regexp.new("^#{path}"), options[:to] ]
-    end
+  def routes
+    @routes ||= []
+  end
+  
+  def named_routes
+    @named_routes ||= {}
   end
   
   def error_handler(app)
     @error_handler = app
   end
   
+  def general_handler(app)
+    @general_handler = app
+  end
+  
+  def kenv
+    @env['kazoo'] ||= {}
+  end
+  
   def call(env)
+    @env = env
     @routes.each do |route|
-      if matches = route[0].match(env['REQUEST_PATH'])
-        env['HTTP_PREFIX'] = matches[0]
-        env['PATH_INFO'] = env['PATH_INFO'].sub(route[0], '')
+      env['PATH_INFO'] = "#{env["PATH_INFO"]}/" unless %r'/$'.match(env['PATH_INFO'])
+      params = route.extract_params(env['PATH_INFO'])
+      
+      if params && route.app
+        kenv['params'] ||= {}
+        kenv['params'].merge!(params)
+        
+        match = route.to_regexp.match(env['PATH_INFO'])[0]
+        kenv['path_prefix'] = kenv['path_prefix'] ? File.join(kenv['path_prefix'], match) : match
+        
+        env['PATH_INFO'] = env['PATH_INFO'].sub(match, '')
         env['PATH_INFO'] = "/#{env['PATH_INFO']}" unless env['PATH_INFO'].match(%r'^/')
-        response = route[1].call(env)
-        return response if response[1]['X-Cascade'] != 'pass'
+        
+        response = route.app.call(env)
+        return response unless response[1]['X-Cascade'] == 'pass'
       end
+      
     end
     
     # If no routes found

data/lib/kazoo/router/context.rb

@@ -0,0 +1,46 @@
+class Kazoo::Router
+  
+  class Context
+    
+    def initialize(router, opts = {})
+      @router = router
+      @opts = opts
+    end
+    
+    def match(path, opts)
+      opts = @opts.merge(opts)
+      name = extract_name(opts)
+      route = Route.new(path, opts)
+      @router.named_routes[name] = route if name
+      @router.routes << route
+      route
+    end
+    
+    def context(opts = {})
+      opts = opts.dup
+      
+      if @opts[:path_prefix] && opts[:path_prefix]
+        opts[:path_prefix] = File.join(@opts[:path_prefix], opts[:path_prefix])
+      end
+      
+      if @opts[:name_prefix] && opts[:name_prefix]
+        opts[:name_prefix] = @opts[:name_prefix] + '_' + opts[:name_prefix]
+      end
+      
+      c = self.class.new(@router, opts)
+      yield c
+      c
+      
+    end
+    
+    def extract_name(opts)
+      
+    end
+    
+    def error_handler(app)
+      @router.error_handler(app)
+    end
+    
+  end
+  
+end

data/lib/kazoo/router/route.rb

@@ -0,0 +1,110 @@
+class Kazoo::Router
+  
+  class Route
+    
+    def initialize(path, opts = {})
+      
+      @named_params = []
+      @opts = opts
+      
+      # Extract & delete the special options
+      @app = opts.delete(:to)
+      
+      @path_prefix = opts.delete(:path_prefix)
+      @regex_prefix = opts.delete(:regex_prefix)
+      opts.delete(:name_prefix)
+      
+      # Parse the path
+      if path.is_a?(String)
+        
+        path = File.join(@path_prefix, path) if @path_prefix
+        
+        @passed_string = path
+        
+        @parts = path.split('/')
+        @parts.shift if @parts[0].nil?
+        
+        regexp_parts = @parts.map { |part|
+          # extracts the names of the path
+          if matches = part.match(/^:([a-z]+[a-z0-9_]*)$/i)
+            @named_params << matches[1].downcase
+            "([^\/]+)"
+          elsif part
+            part
+          else
+            raise ArgumentError, 'Paths may not have blank parts'
+          end
+        }
+        final_path = regexp_parts.join('/')
+      elsif path.is_a?(Regexp)
+        final_path = path.inspect
+        final_path.gsub!(/(^\^)|(\$$)/, '') # Remove anchors
+        final_path = File.join(@regex_prefix, file_path) if @regex_prefix
+      else
+        raise ArgumentError, "Invalid type passed to a route: #{path.class.name}. Must be either a string or regexp."
+      end
+      
+      final_path = "/#{final_path}" unless final_path.match(%r"^\/")
+      final_path = "#{final_path}/" unless final_path.match(%r"\/$")
+      @matcher = Regexp.new("^#{final_path}")
+    end
+    
+    def to_s
+      @passed_string || @matcher.inspect
+    end
+    
+    def to_regexp
+      @matcher
+    end
+    
+    def app
+      @app
+    end
+    
+    def named_params
+      @named_params
+    end
+    
+    def extract_params(path)
+      if matches = @matcher.match(path)
+        obj = @opts.dup
+        named_params.each_with_index { |np, i| obj[np] = matches[i + 1] }
+        obj
+      end
+    end
+    
+    def path(opts = {})
+      
+      opts = @opts.merge(opts)
+      
+      raise "Path cannot be generated from a Regexp" unless @passed_string
+      
+      unused_params = @named_params - opts.keys.map { |key| key.to_s }
+      raise ArgumentError, "You must supply the following params: #{unused_params.inspect}" if unused_params.size > 0
+      
+      str = @passed_string.dup
+      
+      extra_keys = []
+      
+      opts.keys.each { |key|
+        if test = str.sub!(%r"(\:|\*)#{key}", opts[key].to_s)
+          raise ArgumentError, "#{key} requires a value" if opts[key].nil?
+        else
+          extra_keys << key
+        end
+      }
+      
+      if extra_keys.size > 0
+        pstring = extra_keys.map { |key|
+          "#{CGI.escape(key.to_s)}=#{CGI.escape(opts[key].to_s)}" unless opts[key].nil?
+        }.compact.join('&')
+        "#{str}?#{pstring}"
+      else
+        str
+      end#if 
+      
+    end#def
+    
+  end#class
+  
+end

data/lib/kazoo/sinatra.rb

@@ -2,6 +2,34 @@ require 'sinatra/base'
 
 class Kazoo::Sinatra < Sinatra::Base
   
+  enable  :sessions
+  
+  before do
+    params.merge!(kenv['params']) if kenv['params']
+  end
+  
+  def ksession
+    session['kazoo'] ||= {}
+  end
+  
+  def kenv
+    @request.env['kazoo'] ||= {}
+  end
+  
+  def current_user=(user)
+    if user
+      ksession['user_id'] = user.id
+      ksession['user_class'] = user.class.name
+    else
+      ksession['user_class'] = ksession['user_id'] = nil
+    end
+    user
+  end
+  
+  def current_user
+    @_kcu ||= Kernal.const_get(k).find(ksession['user_id']) if ksession['user_id']
+  end
+  
   def render(engine, data, options = {}, *args)
     
     if !options[:views] && data.is_a?(Symbol) && !data.to_s.match('/')
@@ -45,27 +73,30 @@ class Kazoo::Sinatra < Sinatra::Base
     self.class.paths
   end
   
-  def url(name, opts = {})
-    n = name.to_sym
-    raise ArgumentError, "Invalid url name: #{name}" unless paths[n]
-    
-    url_path = paths[n].split('/').map { |part|
-      next unless part.is_a?(String)
-      if matches = part.match(/^:([a-z_]+)$/i)
-        matched = matches[1].downcase
-        opts[matched] || opts[matched.to_sym] || params[matched] || raise("You need to pass '#{matched}' to generate URL")
-      else
-        part
-      end
-    }.join('/')
+  def url(name = '', opts = {})
+    if name.is_a?(Symbol)
+      raise ArgumentError, "Invalid url name: #{name}" unless paths[name]
     
-    # Check for prefix
-    full_path = request.env['HTTP_PREFIX'] ? File.join(request.env['HTTP_PREFIX'], url_path) : url_path
-    
-    format = opts[:format] || opts['format']
-    full_path << ".#{format}" if format
-    
-    full_path
+      url_path = paths[name].split('/').map { |part|
+        next unless part.is_a?(String)
+        if matches = part.match(/^:([a-z_]+)$/i)
+          matched = matches[1].downcase
+          opts[matched] || opts[matched.to_sym] || params[matched] || raise("You need to pass '#{matched}' to generate URL")
+        else
+          part
+        end
+      }.join('/')
+      
+      # Check for prefix
+      full_path = kenv['HTTP_PREFIX'] ? File.join(kenv['HTTP_PREFIX'], url_path) : url_path
+      
+      format = opts[:format] || opts['format']
+      full_path << ".#{format}" if format
+      
+      full_path
+    else
+      kenv['HTTP_PREFIX'] ? File.join(kenv['HTTP_PREFIX'], name) : name
+    end
   end
 
 private

data/lib/kazoo/support.rb

@@ -0,0 +1,40 @@
+module Kazoo::Support
+  
+  
+  def load_files(files)
+    excepted_inits = []
+    files.sort.each do |init|
+      begin
+        require init
+      rescue => e
+        excepted_inits.push([init, {e => 0}])
+      end
+    end
+    
+    # Go through the ones that might have dependencies on other inits.
+    max_error_size = excepted_inits.size * 4
+    
+    while excepted_inits.size > 0
+      
+      begin
+        excepted_init = excepted_inits.pop
+        require excepted_init[0]
+      rescue => e
+        c = e.class
+        excepted_init[1][c] ||= 0
+        
+        if excepted_init[1][c]  > max_error_size
+          raise
+        else
+          excepted_init[1][c] += 1
+          excepted_inits.unshift(excepted_init)
+        end#if
+        
+      end#begin
+      
+    end#while
+  
+  end#def
+
+  
+end#module

data/readme.markdown

@@ -1,15 +1,14 @@
 Kazoo
 =====
 
-Kazoo is a Ruby library that aims to make your Rack applications behave like one. So far, it's very minimal with a simple router and some methods added to Sinatra to make it easier to have multiple Sinatra apps act more cohesively. Please note the current version on this: 0.0.1. This is nowhere near finished! It is on rubygems.org so that you can install it by running:
+Kazoo is a Ruby framework to faciliate modular content management applications. So far, it's a router and some methods added to Sinatra to make it easier to have multiple Sinatra apps act more cohesively. Please note the current version on this: 0.0.4, so please be aware that it is not production ready yet. Kazoo is on rubygems.org so that you can install it by running:
 
     gem install kazoo
 
-The Kazoo router takes string paths and matches them to apps with no bells or whistles (yet). This is how you use it in a config.ru file:
+The Kazoo router takes paths and matches them to apps. This is how you use it in a config.ru file:
 
     require 'rubygems'
     require 'kazoo'
-    require 'kazoo/router'
     
     # Omitted code that pulls in Sinatra apps...
     
@@ -57,4 +56,4 @@ In order to facilitate the fact that apps can be mounted at different paths, url
     <p>This is the generated URL for this page: <%= url(:show, :id => @feed.id) %></p>
     
     
-If you run into any problems or have suggestions, feel free to send a ticket to /dev/null. Or you can submit one at https://github.com/eltiare/kazoo/issues, your choice.
+If you run into any problems or have suggestions please submit a ticket at  https://github.com/eltiare/kazoo/issues

data/spec/router/context_spec.rb

@@ -0,0 +1,6 @@
+require File.join(File.dirname(__FILE__), '../spec_helper')
+
+describe Kazoo::Router::Context do
+  
+  
+end

data/spec/router/route_spec.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), '../spec_helper')
+
+describe Kazoo::Router::Route do
+  
+  before(:each) do
+    @route = Kazoo::Router::Route.new('/your/:relative/is/:adjective')
+    @route2 = Kazoo::Router::Route.new('/testing')
+  end
+  
+  it "extracts the variables from a path" do
+    @route.named_params.should eq(['relative', 'adjective'])
+  end
+  
+  it "generates a path with variables" do
+    @route.path(:relative => 'mom', :adjective => 'huge').should eq(
+      '/your/mom/is/huge'
+    )
+  end
+  
+  it "generates a path with extranous variables" do
+    @route.path(:relative => 'mom', :adjective => 'huge', :laughs => 1, :true => 'yes').should eq(
+      '/your/mom/is/huge?laughs=1&true=yes'
+    )
+  end
+  
+  it "throws an error if a required var is left out" do
+    lambda { @route.path(:relative => 'mom') }.should raise_error(ArgumentError, /adjective/)
+  end
+  
+  it "properly forms a matching regexp" do
+    @route2.to_regexp.inspect.should eq('/^\/testing\//')
+    @route.to_regexp.inspect.should eq('/^\/your\/([^\/]+)\/is\/([^\/]+)\//')
+  end
+  
+  it "doesn't match similar segments" do
+    @route2.extract_params('/testing_and_stuff').should eq(nil)
+  end
+  
+end

data/spec/router_spec.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+
+describe Kazoo::Router do
+
+  before :each do
+    @proper_response = [200, {'Content-Type' => 'text/plain'}, 'Yay!']
+    @proper_response2 = [200, {'Content-Type' => 'text/plain'}, 'Response2']
+    @not_found_response = [404, {"X-Cascade"=>"pass", "Content-Type"=>"text/plain"}, "The requested URI is not found"]
+    
+    handler = lambda { @proper_response }
+    handler2 = lambda { @proper_response2 }
+    
+    @router = Kazoo::Router.map do
+      match '/something/:id', :to => handler
+      match '/something', :to => handler
+      match '/something_else', :to => handler2
+    end
+    
+  end
+  
+  it "routes to the proper handler" do
+    @router.call({ 'PATH_INFO' => '/something' }).should eq(@proper_response)
+    @router.call({ 'PATH_INFO' => '/something/else'}).should eq(@proper_response)
+  end
+  
+  it "sets the kazoo params" do
+    env = { 'PATH_INFO' => '/something/123' }
+    @router.call(env)
+    env['kazoo']['params'].should eq({'id' => '123'})
+  end
+  
+  it "matches later routes properly" do
+    env = { 'PATH_INFO' => '/something_else/testing_blah' }
+    @router.call(env).should eq(@proper_response2)
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+profile
+--timeout
+20
+--diff

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+unless defined? SPEC_DIR
+  SPEC_DIR = File.dirname(__FILE__)
+  lib_path = File.expand_path("#{SPEC_DIR}/../lib")
+  $LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+  
+  require 'kazoo'
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kazoo
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Jeremy Nicoll
@@ -36,11 +36,11 @@ cert_chain:
   ZVeyFF4suKZEIEKi
   -----END CERTIFICATE-----
 
-date: 2011-01-28 00:00:00 -07:00
+date: 2011-02-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: Make your Ruby Rack apps act like one
+description: A moduler framework to facilitate the development of content management systems
 email: jnicoll @nspam@ accentuate.me
 executables: []
 
@@ -48,16 +48,29 @@ extensions: []
 
 extra_rdoc_files: 
 - lib/kazoo.rb
+- lib/kazoo/accessors.rb
 - lib/kazoo/router.rb
+- lib/kazoo/router/context.rb
+- lib/kazoo/router/route.rb
 - lib/kazoo/sinatra.rb
+- lib/kazoo/support.rb
 files: 
 - MIT-License
 - Manifest
 - Rakefile
 - lib/kazoo.rb
+- lib/kazoo/accessors.rb
 - lib/kazoo/router.rb
+- lib/kazoo/router/context.rb
+- lib/kazoo/router/route.rb
 - lib/kazoo/sinatra.rb
+- lib/kazoo/support.rb
 - readme.markdown
+- spec/router/context_spec.rb
+- spec/router/route_spec.rb
+- spec/router_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 - kazoo.gemspec
 has_rdoc: true
 homepage: http://rubykazoo.com
@@ -95,9 +108,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: kazoo
-rubygems_version: 1.4.2
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: Make your Ruby Rack apps act like one
+summary: A moduler framework to facilitate the development of content management systems
 test_files: []