grippy-doozer 0.1.3 → 0.1.4

data/lib/doozer/scripts/cluster.rb

@@ -11,7 +11,6 @@
 require 'optparse'
 
 APP_PATH = Dir.pwd if APP_PATH.nil?
-
 config =  Doozer::Configs.symbolize_keys( YAML.load(File.read(File.join(APP_PATH,'config/app.yml'))) )
 clusters = Doozer::Configs.symbolize_keys(config[:clusters])
 
@@ -32,7 +31,7 @@ end
 # Automatically starts a test instance of your appserver on http://localhost:5000. (No -E flag is required for this command).
 def test
   cmd = "rackup #{@test_config}" 
-  p "Command: #{cmd} -p 5000 -E test -o 127.0.0.1"
+  printf "Command: #{cmd} -p 5000 -E test -o 127.0.0.1\n"
   system(cmd)
 end
 
@@ -40,23 +39,23 @@ end
 #
 # <b>deployment</b>: Automatically starts a new instance of your appserver for each defined cluster address:port
 def start
-  p "Starting clusters..."
+  printf "Starting clusters...\n"
   for app in @apps
     if @env == :deployment
       #need to check if application has a pid file so we don't start
       pid_file = "#{APP_PATH}/log/doozer.#{app[:port]}.pid"
       raise "pid file already exists for #{pid_file}" if File.exist?(pid_file)
       cmd = "rackup #{@config} -p #{app[:port]} -E #{@env.to_s} -s #{@server} -o #{app[:ip]} #{@daemonize} -P #{pid_file}" 
-      p "Command: #{cmd}"
+      printf "Command: #{cmd}\n"
       system(cmd)
     else
       cmd = "rackup #{@config} -p #{app[:port]} -E #{@env.to_s} -s #{@server} -o #{app[:ip]}" 
-      p "Command: #{cmd}"
+      printf "Command: #{cmd}\n"
       system(cmd)
       break
     end
   end
-  p "Did they start?"
+  printf "Did they start?\n"
   system("ps -aux | grep rackup")
 end
 
@@ -71,21 +70,21 @@ end
 # <b>deployment</b>: Automatically stops all instances of your appserver for each defined cluster address:port
 def stop
   system("ps -aux | grep rackup")
-  p "Stoping clusters..."
+  printf "Stoping clusters...\n"
   for app in @apps
     if @env == :deployment
       pid_file = "#{APP_PATH}/log/doozer.#{app[:port]}.pid"
-      p "Reading pid from #{pid_file}" 
+      printf "Reading pid from #{pid_file}\n" 
       if File.exist?(pid_file)
         File.open(pid_file, 'r'){ | f | 
           pid = f.gets.to_i
-          p "Shutting down process #{pid}"
+          printf "Shutting down process #{pid}\n"
           system("kill -9 #{pid}")
 
         }
         File.delete(pid_file) 
       else
-        p "pid file doesn't exist"
+        printf "pid file doesn't exist\n"
       end
     end
   end

data/lib/doozer/version.rb

@@ -2,7 +2,7 @@ module Doozer
   module Version
     MAJOR=0
     MINOR=1
-    PATCH=3
+    PATCH=4
     STRING=[MAJOR, MINOR, PATCH].join('.')
   end
 end

data/lib/doozer/view_helpers.rb

@@ -1,8 +1,22 @@
 require 'digest/sha1'
 
 module Doozer
+  
+  # ViewHelpers which are included in Controllers and Partials
   module ViewHelpers
-
+    
+    # Returns a url from a hash of options. Expects option keys as symbols.
+    #
+    # :name - the route.name to parse additional options with
+    #
+    # :base_url - the base url of the request
+    #
+    # => route tokens are replace the key/values pairs in the options. if a route token is found in the options it is replaced with a 'MISSING-key' string.
+    #
+    # => all remaining options are added as key=value query string parameters
+    #
+    # You can also pass a opt as a string which just passed it through.
+    #
     def url(opt)
       url = ''
       if opt.kind_of? Hash
@@ -14,8 +28,10 @@ module Doozer
           return "MISSING-ROUTE-for-name-#{name}" if route .nil?
           url = "#{route.path}"
 
-          # we need to swap out the tokens here...
-          route.tokens.each {|token|
+          # we need to swap out the tokens here and account for formats on the end of the path
+          tokens = route.tokens
+          tokens.last.gsub!(Regexp.compile("\.#{route.format.to_s}$"), '') if route.format != :html if not route.tokens.empty?
+          tokens.each { |token|
             val = opt[token.to_sym]
             if val
               opt.delete(token.to_sym)
@@ -26,7 +42,7 @@ module Doozer
           }
         end
 
-        # set base _url
+        # set base_url
         host = ""
         if opt[:base_url]
           host = opt.delete(:base_url)
@@ -42,15 +58,34 @@ module Doozer
       return url
     end
     
+    # Creates an html anchor tag.
+    #
+    # text - the text of the anchor tag
+    # 
+    # opt - a hash of options which are passed to url(opt)
+    #
+    # prop - a hash of anchor tag attributes to add to the link
     def link(text='', opt={}, prop={})
       "<a href=\"#{url(opt)}\"#{hash_to_props(prop)}>#{text}</a>"
     end
-  
+    
+    # Creates an img tag.
+    #
+    # path - the src of the image tag
+    #
+    # prop - a hash of image tag attributes
     def img(path, prop={})
       path = timestamp_path(path)
       "<img src=\"#{path}\"#{hash_to_props(prop)} />"
     end
     
+    # Creates a stylesheet link tag.
+    #
+    # path - the href of the link tag
+    #
+    # prop - a hash of link tag attributes.
+    #
+    # => Defaults to :rel=>'stylesheet', :type=>'text/css', :media=>'all'
     def stylesheet(path, prop={})
       #<link rel="stylesheet" type="text/css" media="all" href="/css/style.css" />
       path = timestamp_path(path)
@@ -60,12 +95,33 @@ module Doozer
       "<link #{hash_to_props(prop)} href=\"#{path}\" />"
     end
 
+    # Creates a link tag for feeds.
+    #
+    # opt - a hash of options which are passed to url(opt)
+    #
+    # prop - a hash of link tag attributes.
+    #
+    # => Example: :rel=>'alternate', :type=>'application/rss+', :media=>'all'
+    def feed(opt={}, prop={})
+      "<link #{hash_to_props(prop)} href=\"#{url(opt)}\" />"
+    end
+
+    # Creates a script tag.
+    #
+    # path - the src of the javascript tag
+    #
+    # prop - a hash of script tag attributes.
+    #
+    # => Defaults to: :type=>'text/javascript'
     def javascript(path, prop={})
       path = timestamp_path(path)
       prop[:type] = 'text/javascript' if prop[:type].nil?
       "<script #{hash_to_props(prop)} src=\"#{path}\"></script>"
     end
 
+    # Creates metatags
+    #
+    # retuns a differnt metatag for each key/value added to @view[:meta] hash. See Doozer::Controller#meta for adding examples.
     def metatags
       #loop all metatags here...
       out=[]
@@ -75,7 +131,20 @@ module Doozer
       }
       out.join("")
     end
-    
+
+    # Creates an authtoken form element
+    #
+    # By default, all post requests expect this value to be present unless overrided with Doozer::Controller#after_initialize
+    #
+    # You can customize the elemement id by passing arg[:id] to the method.
+    #
+    # The value contains an checksum of the app_name and cookie sid
+    def authtoken(args={})
+      id = args[:id] if args[:id]
+      "<input type=\"hidden\" id=\"#{id}_authtoken\" name=\"_authtoken\" value=\"#{generate_authtoken(@request.cookies['sid'])}\" />"
+    end
+
+    # Turns a hash of key/value pairs in to a key1="value1" key2="value2" key3="value3"
     def hash_to_props(opt={})
       props=[]
       opt.each { | key, value | 
@@ -85,6 +154,9 @@ module Doozer
       return ""
     end
 
+    # Turns a hash of key/value pairs in querystring like key1=value%201&key2=value2&key3=value3
+    #
+    # All values are CGI.escaped for output
     def hash_to_qs(opt={})
       props=[]
       opt.each { | key, value | 
@@ -93,24 +165,41 @@ module Doozer
       props.join("&")
     end    
     
+    # Safe encodes a string by entity encodes all less then and greater then signs
+    #
     def h(s)
       s.gsub!(/</,'&lt;')
       s.gsub!(/>/,'&gt;')
       return s
     end
     
+    # Returns the base url configured in app.yml
+    #
     def base_url
       Doozer::Configs.base_url
     end
 
+    # Returns the env setting the application was loaded under (:development, :deployment, or :test)
+    #
     def rack_env
       Doozer::Configs.rack_env
     end
 
+    # Returns the app name configured in app.yml
+    #
     def app_name
       Doozer::Configs.app_name
     end
 
+    # Returns the app path the application was loaded in. This defaults to the path all scripts were executed from. In general, this is the root of your project directory unless specified otherwise.
+    #
+    def app_path
+      Doozer::Configs.app_path
+    end
+    
+    # Returns the ip address of the server
+    # 
+    # Automatically accounts for proxied requests and returns HTTP_X_FORWARDED_FOR if present.
     def ip
       if addr = @env['HTTP_X_FORWARDED_FOR']
         addr.split(',').last.strip
@@ -119,20 +208,19 @@ module Doozer
       end
     end
 
+    # Returns the domain name of the request
+    #
     def server_name
       @env['SERVER_NAME']
     end
 
+    # Returns the request path
+    #
     def path
         @env['REQUEST_PATH']
     end
 
-    def authtoken(args={})
-      id = args[:id] if args[:id]
-      "<input type=\"hidden\" id=\"#{id}_authtoken\" name=\"_authtoken\" value=\"#{generate_authtoken(@request.cookies['sid'])}\" />"
-    end
-
-    # test if this person has a session with keys in it...
+    # Test if this person has a session with keys in it...
     def session?
       @session.empty?
     end

data/lib/generator/generator.rb

@@ -167,7 +167,6 @@ end
       }
     end
     
-    
     def self.migrate(orm, name)
       return if help?(name, :migrate)
     
@@ -305,7 +304,6 @@ end
       end
       return false
     end
-    
     def self.help(action=nil)
       h = ""
       case action

data/templates/skeleton/config/environment.rb

@@ -1,6 +1,6 @@
 # This file is loaded right after orm is initialized and right before app, controllers and models
 # place code here which is used throughout the application
-printf "Loading Environment..."
+printf "Loading Environment... \n"
 
 Doozer::Initializer.after_orm do | config |
   # require 'doozer/plugins/paginate/init'

data/templates/skeleton/config/routes.rb

@@ -19,7 +19,7 @@ Formats
 Adding formats symbolzes automatically creates new routes for the formats symbols provided. 
 The appropriate content-type is returned with the response.
 You can access the format with @format in your controllers.
-Supported formats are: :json, :js, :xml, :rss
+Supported formats are: :json, :js, :xml, :rss, :atom
 All routes default to :html format
 
 Example:
@@ -32,7 +32,7 @@ Example:
   map.add :format_example, '/format_example', {:controller=>'index', :action=>'format_example', :status=>200} 
   :json format
   map.add :format_example_json, '/format_example.json', {:controller=>'index', :action=>'format_example', :status=>200}
-  :xml formate
+  :xml format
   map.add :format_example_xml, '/format_example.xml', {:controller=>'index', :action=>'format_example', :status=>200}
   
 

data/test/doozer_test.rb

@@ -2,6 +2,6 @@ require 'test_helper'
 
 class DoozerTest < Test::Unit::TestCase
   should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+    # flunk "hey buddy, you should probably rename this file and start testing for real"
   end
 end

data/test/project/Rakefile

@@ -0,0 +1,3 @@
+require 'rake'
+Dir['tasks/**/*.rake'].each { |t| load t }
+task :default => :spec

data/test/project/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < Doozer::Controller
+end

data/test/project/app/controllers/index_controller.rb

@@ -0,0 +1,7 @@
+class IndexController < ApplicationController
+
+  def index
+    meta({:description=>"meta description goes here"})
+  end
+
+end

data/test/project/app/helpers/application_helper.rb

@@ -0,0 +1,17 @@
+# This is the default ApplicationHelper. 
+# Place methods here which are global to your application.
+# By default all controllers include this file.
+#
+# To load a helper file into a controller:
+#
+# Example:
+#
+#   -files: app_root/app/helpers/helper1_helper.rb, app_root/app/helpers/helper2_helper.rb
+#
+#   -declare inside controller: self.require_view_helpers=[:helper1, :helper2]
+#
+# By default all helpers are automatically included into the base partial class.
+#   Be care to avoid methods with the same names between helper modules.
+#   The helpers are included alphabetically by file name
+module ApplicationHelper
+end

data/test/project/app/views/global/_header.html.erb

@@ -0,0 +1,7 @@
+<div id="hdr">
+	<%=partial('global/navigation')%>
+	<span class="big"><%=link('Home', {:name=>:index})%></span>
+</div>
+<%#=img("/images/doozers.jpg", {:class=>'img'})%>
+
+

data/test/project/app/views/global/_navigation.html.erb

@@ -0,0 +1,6 @@
+<div class="nav">
+	<p>
+		<span><%#=link('about us', {:name=>:about_us})%></span> | 
+		<span><%#=link('contact', {:name=>:contact})%></span> | 
+	</p>
+</div>

data/test/project/app/views/index/index.html.erb

@@ -0,0 +1,108 @@
+<h2><span>Project Details</span></h2>
+<p><span>Doozer is a <%=link('Rackup', 'http://rack.rubyforge.org/') %> application.</span></p>
+
+<ul>
+	<li><span>Bare bones, lightweight, MVC framework.</span></li>
+	<li><span>Map routes to controller actions or completely separate applications.</span></li>
+	<li><span>ORM agnostic. use activerecord, data mapper, or sequel</span></li>
+	<li><span>Easy to define static directories</span></li>
+	<li><span>View Helpers for controllers</span></li>
+	<li><span>Layouts and Partials</span></li>
+</ul>
+
+<h3>Intro</h3>
+	<h4>Inspiration</h4>
+
+<h3>Requirements</h3>
+	<h4>Rackup</h4>
+	<p>Rackup  and its dependencies:</p>
+	
+<h3>File Structure</h3>
+<p>This should look similar to rails</p>
+	<h4>Layout</h4>
+
+<h3>Configs</h3>
+	<h4>Static</h4>
+	<h4>ORM</h4>
+	<h4>Clusters</h4>
+		<p>This needs to change names to something better. Maybe Server?</p>
+<h3>Environment</h3>
+	<h4>Load Hooks</h4>
+	<h4>Settings</h4>
+		
+<h3>Load Order</h3>
+	
+<h3>Routes</h3>
+	<h4>Parameters</h4>
+	<h4>Magic</h4>
+		<p>A magic route is similar to "/:controller/:action" in rails.</p>
+		<p>Right now, these are tuned off in favor of explicitly having to declare them. Formats aren't extended to them yet. :()</p>
+	<h4>Bypassing Controllers</h4>
+		<p>You can declare a Rackup compatible app to call instead of a Doozer::Controller.</p>
+		<p>See config/routes.rb for more info.</p>
+	<h4>Layouts</h4>
+		<p>By default all html routes use the default.html.erb layout generated with the initial scaffolding.</p>
+		<p>Declare a route layout of :layout=>:view_name to override the default behavior.</p>
+		
+
+<h3>App</h3>
+	<h4>Security</h4>
+		<h5>Post Requests</h5>
+			<h6>Authenticity Token</h6>
+		
+	<h4>Model</h4>
+	<h4>View</h4>
+		<h5>Route Tokens</h5>
+	<h4>Controller</h4>
+		<h5>Callbacks</h5>
+			As a controller is initialized, rendered, and finalized, you have the ability to influence the call stack.
+			
+			<h6>after_initialize</h6>
+			<p>This is called after the controller is matched to the route and intialized.
+			<p>Use this hook to customize which actions shouldn't call before_filter and after_filter.</p>
+				<code>
+					@before_filter={:exclude=>[:action1, :action2]}
+					@after_filter={:exclude=>[:action1, :action2]}
+				</code>
+			<h6>before_filter</h6>
+			<p>By default all actions call this method. You can override it in your controller class by declaring:</p>
+				<code>
+					def before_filter
+						#code goes here....
+					end
+				</code>
+			<h6>after_filter</h6>
+			<p>By default all actions call this method. You can override it in your controller class by declaring:</p>
+				<code>
+					def after_filter
+						#code goes here....
+					end
+				</code>
+		<h5>Params</h5>
+		<h5>Route Tokens</h5>
+			<p>All route tokens are available as instance variables.</p>
+			<p>A route token of :id is available in an action and it's view as @id. You must pass this variable into a partial as a local variable.</p>
+		
+<h3>View Helpers</h3>
+	<h4>Redirects</h4>
+	<h4>Flash</h4>
+	<h4>Partial</h4>
+	<h4>Layout</h4>
+	<h4>Session</h4>
+
+<h3>Generators</h3>
+	<h4>MVC Files</h4>
+
+<h3>Scaffold</h3>
+	<h4>Building Project</h4>
+
+<h3>Static</h3>
+
+<h3>Testing</h3>
+
+<h3>Tasks</h3>
+
+<h3>App Start</h3>
+	<h4>Config</h4>
+	<h4>Start Command</h4>
+		<h5>Environments</h5>