grippy-doozer 0.1.3 → 0.1.4

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/doozer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{doozer}
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["grippy"]
-  s.date = %q{2009-08-11}
+  s.date = %q{2009-08-14}
   s.default_executable = %q{doozer}
   s.description = %q{This GEM provides a small, barebones framework for creating MVC Rack applications.}
   s.email = %q{gmelton@whorde.com}
@@ -28,7 +28,6 @@ Gem::Specification.new do |s|
      "bin/doozer",
      "doozer.gemspec",
      "lib/doozer.rb",
-     "lib/doozer/README.rb",
      "lib/doozer/active_support/array.rb",
      "lib/doozer/active_support/class.rb",
      "lib/doozer/active_support/date_time.rb",
@@ -37,6 +36,7 @@ Gem::Specification.new do |s|
      "lib/doozer/app.rb",
      "lib/doozer/configs.rb",
      "lib/doozer/controller.rb",
+     "lib/doozer/exceptions.rb",
      "lib/doozer/extend.rb",
      "lib/doozer/initializer.rb",
      "lib/doozer/lib.rb",
@@ -91,6 +91,34 @@ Gem::Specification.new do |s|
      "templates/skeleton/test/fixtures/setup.rb",
      "templates/skeleton/test/setup.rb",
      "test/doozer_test.rb",
+     "test/project/Rakefile",
+     "test/project/app/controllers/application_controller.rb",
+     "test/project/app/controllers/index_controller.rb",
+     "test/project/app/helpers/application_helper.rb",
+     "test/project/app/views/global/_header.html.erb",
+     "test/project/app/views/global/_navigation.html.erb",
+     "test/project/app/views/index/index.html.erb",
+     "test/project/app/views/layouts/default.html.erb",
+     "test/project/config/app.yml",
+     "test/project/config/database.yml",
+     "test/project/config/environment.rb",
+     "test/project/config/rack.rb",
+     "test/project/config/routes.rb",
+     "test/project/script/cluster",
+     "test/project/script/console",
+     "test/project/script/migrate",
+     "test/project/script/task",
+     "test/project/script/test",
+     "test/project/static/404.html",
+     "test/project/static/500.html",
+     "test/project/static/css/style.css",
+     "test/project/static/favicon.ico",
+     "test/project/static/js/application.js",
+     "test/project/static/js/jquery-1.3.min.js",
+     "test/project/static/robots.txt",
+     "test/project/test/fixtures/setup.rb",
+     "test/project/test/setup.rb",
+     "test/routing_test.rb",
      "test/test_helper.rb"
   ]
   s.has_rdoc = true
@@ -101,6 +129,15 @@ Gem::Specification.new do |s|
   s.summary = %q{A little MVC framework for Rack applications.}
   s.test_files = [
     "test/doozer_test.rb",
+     "test/project/app/controllers/application_controller.rb",
+     "test/project/app/controllers/index_controller.rb",
+     "test/project/app/helpers/application_helper.rb",
+     "test/project/config/environment.rb",
+     "test/project/config/rack.rb",
+     "test/project/config/routes.rb",
+     "test/project/test/fixtures/setup.rb",
+     "test/project/test/setup.rb",
+     "test/routing_test.rb",
      "test/test_helper.rb"
   ]
 

data/lib/doozer.rb

@@ -20,8 +20,13 @@ module Doozer
   end
   
   module Util
-    autoload :Logger,         "doozer/logger"
+    autoload :Logger,       "doozer/logger"
   end
+
+  module Exceptions
+    autoload :Route,        "doozer/exceptions"
+  end
+  
   autoload :ViewHelpers,    "doozer/view_helpers"
   autoload :Version,        "doozer/version"
   

data/lib/doozer/app.rb

@@ -1,6 +1,5 @@
 module Doozer
   class App
-    APP_PATH = Dir.pwd
     include Doozer::Util::Logger
     attr_accessor :options
 
@@ -108,6 +107,7 @@ module Doozer
       end
     end
     
+    # Load all application files for app/helpers/*, app/views/layouts/*, app/views/* and app/controllers/*
     def load_files
       # load models
       load_models
@@ -118,7 +118,7 @@ module Doozer
       @@errors={}
       
       # require helper files and include into Doozer::Partial
-      helper_files = Dir.glob(File.join(APP_PATH,'app/helpers/*_helper.rb'))      
+      helper_files = Dir.glob(File.join(app_path,'app/helpers/*_helper.rb'))      
       helper_files.each {|f|
         require f
         key = f.split("helpers/")[1].gsub(/.rb/,'')
@@ -126,7 +126,7 @@ module Doozer
       }
       
       # cache contoller classes
-      controller_files = Dir.glob(File.join(APP_PATH,'app/controllers/*_controller.rb'))
+      controller_files = Dir.glob(File.join(app_path,'app/controllers/*_controller.rb'))
       # we need to load the application_controller first since this might not be the first in the list...
       if controller_files.length > 0
         i=0
@@ -160,9 +160,9 @@ module Doozer
       }
       
       # cache layout erb's
-      layout_files = Dir.glob(File.join(APP_PATH,'app/views/layouts/*.erb'))
+      layout_files = Dir.glob(File.join(app_path,'app/views/layouts/*.erb'))
       layout_files.each {|f|
-        key = f.split("layouts/")[1].split(".html.erb")[0].gsub(/.xml.erb/, '_xml').gsub(/.json.erb/, '_json')
+        key = f.split("layouts/")[1].split(".html.erb")[0].gsub(/.xml.erb/, '_xml').gsub(/.json.erb/, '_json').gsub(/.js.erb/, '_js').gsub(/.rss.erb/, '_rss').gsub(/.atom.erb/, '_atom')
         results = []
         File.new(f, "r").each { |line| results << line }
         @@layouts[key.to_sym] = ERB.new(results.join(""))
@@ -171,7 +171,7 @@ module Doozer
       #lood 404 and 500 pages if they exist
       pnf = Doozer::Configs.page_not_found_url
       if pnf
-        file = File.join(APP_PATH,"#{pnf}")
+        file = File.join(app_path,"#{pnf}")
         results = []
         File.new(file, "r").each { |line| results << line }
         @@errors[404] = results.join("")
@@ -180,7 +180,7 @@ module Doozer
       end
       ise = Doozer::Configs.internal_server_error_url
       if ise
-        file = File.join(APP_PATH,"#{ise}")
+        file = File.join(app_path,"#{ise}")
         results = []
         File.new(file, "r").each { |line| results << line }
         @@errors[500] = results.join("")
@@ -190,7 +190,7 @@ module Doozer
       
       @@controllers.each_key { | key |
         # p key.inspect
-        files = Dir.glob(File.join(APP_PATH,"app/views/#{key.to_s}/*.erb"))
+        files = Dir.glob(File.join(app_path,"app/views/#{key.to_s}/*.erb"))
         files.each { | f |
           #!!!don't cache partials here!!!
           view = f.split("#{key.to_s}/")[1].split(".erb")[0].gsub(/\./,'_')
@@ -205,18 +205,23 @@ module Doozer
         }
       }
     end
-  
+    
+    # Load application routes
     def load_routes
-      require File.join(APP_PATH, 'config/routes')
+      require File.join(app_path, 'config/routes')
     end
-
+    
+    # Load all application models in app/models
     def load_models
       printf "Loading models...\n"
-      Dir.glob(File.join(APP_PATH,'app/models/*.rb')).each { | model | 
+      Dir.glob(File.join(app_path,'app/models/*.rb')).each { | model | 
         require model 
       }
     end
-  
+    
+    # Loads the file watcher for all application files while in development mode-only.
+    #
+    # This allows you to edit files without restarting the app server to pickup new changes.
     def load_watcher
       require 'doozer/watcher'
       
@@ -224,12 +229,12 @@ module Doozer
       watcher = FileSystemWatcher.new()
       
       # watcher.addDirectory(File.join(File.dirname(__FILE__),'../doozer/'), "*.rb")
-      watcher.addDirectory( APP_PATH + '/app/', "**/*")
-      watcher.addDirectory( APP_PATH + '/app', "**/**/*")
-      watcher.addDirectory( APP_PATH + '/config/', "*.*")
-      watcher.addDirectory( APP_PATH + '/lib/', "*.*")
-      watcher.addDirectory( APP_PATH + '/static/', "*.*")
-      watcher.addDirectory( APP_PATH + '/static/', "**/**/*")
+      watcher.addDirectory( app_path + '/app/', "**/*")
+      watcher.addDirectory( app_path + '/app', "**/**/*")
+      watcher.addDirectory( app_path + '/config/', "*.*")
+      watcher.addDirectory( app_path + '/lib/', "*.*")
+      watcher.addDirectory( app_path + '/static/', "*.*")
+      watcher.addDirectory( app_path + '/static/', "**/**/*")
 
 
       watcher.sleepTime = 1
@@ -258,6 +263,10 @@ module Doozer
       return Object.const_get(@@controllers[key])
     end
             
+    def app_path
+      Doozer::Configs.app_path
+    end
+    
     def self.controllers
       @@controllers
     end

data/lib/doozer/configs.rb

@@ -6,18 +6,16 @@ module Doozer
   
   # This is the main Configs class which loads root/config/app.yml and root/config/database.yml
   #
-  # It also provides a few helper methods like logger, env_path, base_url and app_name
+  # It also provides a few helper methods like logger, app_path, base_url and app_name
   class Configs
-   APP_PATH = Dir.pwd
    @@possible_orm = [:active_record, :data_mapper, :sequel]
+   @@app_path = nil
    
-   # Rack refers to production as deployment.
+   # Load all the config files for the application. Also instantiates a default application Logger.
    def self.load(rack_env)
-      printf "APP_ROOT: #{APP_PATH}\n" 
+      printf "Application path: #{app_path}\n" 
       printf "Loading configs for #{rack_env}\n"
       
-      # TODO: remove this and replace with APP_PATH
-      @@env_path = Dir.pwd 
       @@config = Config::CONFIG
       rack_env = (rack_env.kind_of? String) ? rack_env.to_sym : rack_env
       case rack_env
@@ -33,20 +31,20 @@ module Doozer
       if [:development, :test].include?(rack_env)
         @@logger = Logger.new(STDOUT)
       else
-        @@logger = Logger.new("#{APP_PATH}/log/#{rack_env}.log")
+        @@logger = Logger.new("#{app_path}/log/#{rack_env}.log")
       end
 
       @@config[:rack_env] = rack_env
       # p ":rack_env set to #{@@config[:rack_env]}"
 
       begin
-       @@config[:database] = Configs.symbolize_keys( YAML.load(File.read(File.join(APP_PATH,'config/database.yml'))) )
+       @@config[:database] = Configs.symbolize_keys( YAML.load(File.read(File.join(app_path,'config/database.yml'))) )
       rescue
        printf "--Failed to load config/database.yml \n"
       end
 
       begin
-       @@config[:app] = Configs.symbolize_keys( YAML.load(File.read(File.join(APP_PATH,'config/app.yml'))) )
+       @@config[:app] = Configs.symbolize_keys( YAML.load(File.read(File.join(app_path,'config/app.yml'))) )
       rescue
        printf "--Failed to load config/app.yml\n"
       end
@@ -57,10 +55,18 @@ module Doozer
      @@logger
    end
    
+   # Hook for setting the application path.
+   #
+   # This allows the an application to be initialized from a different location then the project directory.
+   def self.set_app_path(path=nil)
+     @@app_path = path || Dir.pwd
+   end
+
    # This is the file path the app was loaded under. Dir.pwd moves to root in daemon mode so we cache this.
-   def self.env_path
-     @@env_path
-   end   
+   def self.app_path
+     set_app_path if @@app_path.nil?
+     return @@app_path
+   end
    
    # Take a hash and turn all the keys into symbols
    def self.symbolize_keys(hash=nil)

data/lib/doozer/controller.rb

@@ -237,7 +237,7 @@ module Doozer
     
     # Method for setting metatags via Controllers. 
     #
-    # Pass an options hash to meta and all the keys are turned into metatags with the corresponding values.
+    # Pass an options hash to @view[:meta] and all the key/values are turned into metatags with the corresponding values. See Doozer::ViewHelpers#metatags for creating the metatags for view.
     #
     # Example: meta({:description=>'The awesome metatag description is awesome', :keywords=>'awesome, blog, of awesomeness'})
     def meta(opt={})
@@ -328,7 +328,7 @@ module Doozer
       elsif args.kind_of? ERB
         view = args
       end
-      view = ERB.new("Missing view for controller#action") if view.nil?
+      view = ERB.new("Missing view for #{@route.view_path}") if view.nil?
       @render_args[:view] = view
     end
   end

data/lib/doozer/exceptions.rb

@@ -0,0 +1,12 @@
+module Doozer
+  module Exceptions
+    
+    # Runtime Error for handling Route intialization errors.
+    class Route < RuntimeError
+      def initialize(message)
+        @message=message
+      end
+    end
+
+  end
+end

data/lib/doozer/initializer.rb

@@ -14,9 +14,11 @@ module Doozer
     @@before_rackup = []
 
     # env - :development, :deployment, or :test
-    def self.boot(env)
+    # app_path - optional path which overrides where the application is loaded from. Defaults to the Dir.pwd of script loading this file
+    def self.boot(env, app_path=nil)
       #--load configs
       require 'doozer/configs'
+      Doozer::Configs.set_app_path(app_path)
       Doozer::Configs.load(env)
       
       #--load orm
@@ -64,16 +66,16 @@ module Doozer
     # end
     def self.environment
       begin
-        require "#{Dir.pwd}/config/environment"
+        require "#{Doozer::Configs.app_path}/config/environment"
       rescue => e
         Doozer::Configs.logger.error(e)
       end
     end
 
-    
-    def self.console(env)
-      self.boot(env)
-      app = Doozer::App.new(env)
+    # TODO: test this again
+    def self.console(env, app_path=nil)
+      self.boot(env, app_path=app_path)
+      app = Doozer::App.new(args={})
     end
     
     # Primary hook for extending/overriding ORM. Code block is pushed onto an array which allows for multiple hooks throughtout different files.

data/lib/doozer/logger.rb

@@ -1,7 +1,8 @@
 module Doozer
   module Util
     module Logger
-    
+      
+      # Helper function for returning logger.
       def logger
         Doozer::Configs.logger
       end

data/lib/doozer/partial.rb

@@ -24,7 +24,7 @@ module Doozer
     include Doozer::Util::Logger
     include Doozer::ViewHelpers
     
-    APP_PATH = Dir.pwd
+    # APP_PATH = Dir.pwd
     @@partials={}
     
     def initialize(erb, locals, route)
@@ -74,14 +74,14 @@ module Doozer
 
     # Load and cache partial ERB template with the given file_name.
     def self.load_partial(name)
-      file = File.join(APP_PATH,"/app/views/#{name}.html.erb")
+      file = File.join(Doozer::Configs.app_path,"app/views/#{name}.html.erb")
       results = []
       begin
         File.new(file, "r").each { |line| results << line }
         # TODO: throw error if doesn't exist
         @@partials[name] = ERB.new(results.join(""))
       rescue
-        p "sorry couldn't load partial #{name} (#{file})"
+        printf "sorry couldn't load partial #{name} (#{file}) \n"
       end
     end    
     

data/lib/doozer/rackup/test.rb

@@ -3,7 +3,8 @@
   since rackup doesn't call Rackup::Builder in test (in rackup this is 'none') mode
   
 """
-config = 'doozer/rackup/server.ru'
+
+config = File.expand_path(File.join(File.dirname(__FILE__), 'server.ru'))
 env = :test
 cfgfile = File.read(config)
 if cfgfile[/^#\\(.*)/]

data/lib/doozer/redirect.rb

@@ -1,5 +1,5 @@
 module Doozer
-  class Redirect < Exception
+  class Redirect < RuntimeError
     attr_accessor :url
     attr_reader :status
     

data/lib/doozer/route.rb

@@ -2,6 +2,9 @@ require 'doozer/app'
 
 module Doozer
   module Routing
+    
+    
+    # Route manager for drawing and adding routes.
     class Routes
       @@parts=[] # stored as [route.name, route.path]
       @@dict={}  # route hash
@@ -22,6 +25,9 @@ module Doozer
         printf "Routes drawn and sorted...\n"
         # @@parts.each { | i | p i[1] }
       end
+      
+      
+      # An empty path defaults to a path of '/'
       def self.add(name=nil, path=nil, args=nil)
         # p name
         # p path
@@ -33,6 +39,11 @@ module Doozer
           for format in formats
             args.delete(:formats)
             if name != :magic
+              path = '/' if path == ''
+              
+              raise Doozer::Exceptions::Route.new("Route name must be a symbol. #{name} given.") if not name.kind_of? Symbol
+              raise Doozer::Exceptions::Route.new("Route already exists with the name of #{name}.") if @@dict[name]
+              @@parts.each { |p| raise Doozer::Exceptions::Route.new("Route already defined with a path of '#{path}'") if p[1] == path }
               parts = [name, path, args]
               # p parts.inspect
               args[:format] = format
@@ -48,6 +59,7 @@ module Doozer
         end
       end
       
+      # sets up default formats to initialize a mapped route
       def self.init_formats(args)
         formats = args[:formats]
         formats = [] if formats.nil?
@@ -56,11 +68,13 @@ module Doozer
         return args
       end
       
+      # return a route by name
       def self.get_by_name(name)
         # p @@dict.inspect
         return @@dict[name]
       end
-
+      
+      # return the route which matches the request path
       def self.match(path)
           # p path
           # p @@cache.inspect
@@ -76,6 +90,7 @@ module Doozer
           return nil
       end
       
+      # caches the request path and with the route.name
       def self.cache_request_path(route,path)
         # p "route cache request path"
         @@cache[path] = route.name
@@ -177,6 +192,10 @@ module Doozer
       attr_accessor :name, :path, :controller, :action, 
                     :layout, :status, :content_type, :tokens, 
                     :grouping, :app, :format, :view, :view_path
+                    
+                    
+      # Initializes a route with the following parameters
+      # route - [:name, 'path', {args}]
       def initialize(route)
         #p "Doozer::Route#new: #{route}"
         args = route[2]
@@ -207,13 +226,14 @@ module Doozer
         path = '/' if path == ''
         @path = (@format == :html) ? path : "#{path}.#{format}"
         @name = (@format == :html) ? route[0] : "#{route[0]}_#{format.to_s}".to_sym
-        @layout = :none if @format != :html and @layout == 'default'
+        @layout = "default_#{@format.to_s}".to_sym if @format != :html and @layout == 'default'
         
         @view = "#{@action}_#{@format.to_s}"
         @view_path = "#{@controller}/#{@action}.#{@format.to_s}.erb"
         regify()
       end
-    
+      
+      # Creates the Regex grouping for matching and parsing route tokens
       def regify
         if (@path.index('/'))
           grouping = []
@@ -224,12 +244,13 @@ module Doozer
                 # part = '(?P<'+token+'>.)'
                 # part = '(\.*)'
                 # part = '(\w*)'
-                part = '([a-zA-Z0-9,-.%]*)' # this picks up all allowable route tokens (a-zA-Z0-9,-.%)
+                part = '([a-zA-Z0-9,-.%_~;]*)' # this picks up all allowable route tokens (a-zA-Z0-9,-.%)
                 @tokens.push(token)
               end
               grouping.push(part)
           end
           out = "^#{grouping.join('/')}"
+          out += ".#{@format.to_s}" if @format != :html # we need to include the 
           @grouping = Regexp.compile(out)
         else
           #handle default index route
@@ -237,21 +258,28 @@ module Doozer
         end
       end
     
+      # Matches a request path against a route.path if a direct match or route.grouping
       def match(path)
         # p "#{path} vs #{@path}" 
         # p path =~ @grouping
-        #short-circut for root
+        # short-circut for root
         return false if path == '/' and @path != '/' #handles root condition
+        # short-circut for exact match with no tokens
+        return true if path == @path
+        # test for tokens
         pass=(path =~ @grouping) == 0 ? true : false
         # p @tokens.inspect if pass
         if @tokens.empty?; pass=false if @path != path; end #handles root condition '/'
         pass=false if path.split('/').length != @path.split('/').length #handles the root condition /:token
         return pass
       end
-    
+      
+      # Parses route tokens and creates a hash of extra params
       def extra_params(path)
         hashish = {}
         params = @grouping.match(path)
+        # make sure to remove the format from the last token
+        @tokens.last.gsub!(Regexp.compile("\.#{@format.to_s}$"), '') if @format != :html if not @tokens.empty?
         i = 1
         for token in @tokens
           hashish[token.to_sym] = params[i]