maveric 0.3.0 → 0.3.1

data/lib/maveric.rb

@@ -150,16 +150,19 @@ require 'maveric/extensions'
 # trickery.
 class Maveric
   ## Implementation details.
-  VERSION='0.3.0'
+  VERSION='0.3.1'
 
   ## Standard end of line for HTTP
   EOL="\r\n"
   ## Group 1 wil contain a boundary for multipart/form-data bodies.
   MP_BOUND_REGEX = /\Amultipart\/form-data.*boundary=\"?([^\";, ]+)\"?/n
+  ## Contains a list of environment preprocessors.
+  @adj_env = []
 
   # I hate putting utility methods here, rather than in some module, but
   # I don't see how to do it without getting messy.
   class << self
+
     ## Builds a logging object if there's not one yet, then returns it.
     def log
       unless defined? @@maveric_logger
@@ -275,7 +278,7 @@ class Maveric
     # their respective modules.
     def inherited klass
       ::Maveric.log.info "#{klass} inherits from #{self}."
-      super klass
+      super
       parent = self
       klass.class_eval do
         const_set(:Models, Module.new).
@@ -308,7 +311,6 @@ class Maveric
       @adj_env << act
     end
   end
-    @adj_env = []
 
   ##
   # When instantiated, the Maveric decends through its constants for
@@ -367,9 +369,16 @@ class Maveric
   def prepare_environment env
     ::Maveric.type_check :env, env, Hash
     env.update :maveric => self
-    self.class.adjust_env.
-      select {|act| act[:test].nil? or act[:test][env] }.
-      each {|act| act[:do] ? act[:do][env] : __send__(act[:name], env) }
+    self.class.adjust_env.select do |act|
+      act[:test].nil? or act[:test][env]
+    end.each do |act|
+      ::Maveric.log.debug "#{self.class} prep_env #{act[:name]}"
+      if act[:do]
+        act[:do].call env
+      else
+        __send__ act[:name], env
+      end
+    end
   end
 
   ### Does this count as magic? No, just defaults.
@@ -396,9 +405,6 @@ class Maveric
 
   ##
   # Holds views related methods and helpers
-  #
-  # As long as Controller#prepare_0_imports is not overridden, Views extends
-  # the Controller instance just before the action is called.
   module Views
     def path_to c, a={}
       ::Maveric.log.info "#{self.class}#path_to #{c} #{a.inspect}"
@@ -408,9 +414,6 @@ class Maveric
 
   ##
   # Repository for models. Still not really utilized.
-  #
-  # As long as Controller#prepare_0_imports is not overridden, Models extends
-  # the Controller instance just before the action is called.
   module Models
   end
 end
@@ -438,8 +441,14 @@ end
 # Integer corresponding to a real HTTP status code, and @body should contain
 # a String.
 #
+# The instance variable @action contains a Symbol corresponding to the
+# Controller method to be called. The result of this call is assigned to
+# @body.
+#
 # Those are the only instance variables you should be warned against playing
-# with frivously.
+# with frivously. All instance variables are initially assigned before the
+# before actions have been run, with the exception of @body which is set
+# after @action is called.
 class Maveric::Controller
   REQUEST_METHODS = [:post, :get, :put, :delete, :head] # CRUDY
   @before = []
@@ -564,25 +573,36 @@ class Maveric::Controller
     action ||= @env[:route][:action] rescue nil
     action ||= @env['REQUEST_METHOD'].downcase rescue nil
     action ||= 'get'
-    action = action.to_sym
+    @action = action.to_sym
 
-    raise NoMethodError, [503, "#{action} not implemented.", nil, @env] if \
-      REQUEST_METHODS.include? action and not respond_to? action
+    ::Maveric.log.debug "#{self.class} action #{@action.inspect}"
 
     self.class.before.select do |act|
-      (act[:only].nil? or act[:only].include? action) and \
-      (act[:exclude].nil? or not act[:exclude].include? action)
+      (act[:only].nil? or act[:only].include? @action) and \
+      (act[:exclude].nil? or not act[:exclude].include? @action)
     end.each do |act|
-      act[:do] ? act[:do][self] : __send__(act[:name], self)
+      ::Maveric.log.debug "#{self.class} before #{act[:name]}"
+      if act[:do]
+        act[:do].call self
+      else
+        __send__ act[:name], self
+      end
     end
 
-    @body = __send__ action
+    raise NoMethodError, [503, "#{@action} not implemented.", nil, @env] if \
+      REQUEST_METHODS.include? @action and not respond_to? @action
+    @body = __send__ @action
 
     self.class.after.select do |act|
-      (act[:only].nil? or act[:only].include? action) and \
-      (act[:exclude].nil? or not act[:exclude].include? action)
+      (act[:only].nil? or act[:only].include? @action) and \
+      (act[:exclude].nil? or not act[:exclude].include? @action)
     end.each do |act|
-      act[:do] ? act[:do][self] : __send__(act[:name], self)
+      ::Maveric.log.debug "#{self.class} after #{act[:name]}"
+      if act[:do]
+        act[:do].call self
+      else
+        __send__ act[:name], self
+      end
     end
 
     ::Maveric.log.debug self # omg, masochistic.
@@ -606,7 +626,7 @@ class Maveric::Controller
   # just above the return. Controller#render calls itself. That is all.
   def render view, s=''
     ::Maveric.log.debug "#{self.class}#render"+
-      " #{view.inspect}, #{s.inspect}" # s is painful to logs.
+      " #{view.inspect}, #{s[0..100].inspect}"
     ::Maveric.type_check :view, view, Symbol, String
     ::Maveric.type_check :s, s, String
     s = yield s if block_given?
@@ -706,7 +726,9 @@ class Maveric::Route < Regexp
     ::Maveric.log.debug "#{self.class}#build #{arg.inspect} : #{@params}"
     ::Maveric.type_check :arg, arg, Hash
     if @params.sort == arg.keys.sort
-      path = arg.inject(@path){|r,(k,v)| r.sub /:#{k}:?/, v }
+      @options.
+        merge(arg).
+        inject(@path){|r,(k,v)| r.sub /:#{k}:?/, v }
     end
   end
 
@@ -718,7 +740,9 @@ class Maveric::Route < Regexp
     ::Maveric.log.debug "#{self.class}#route #{path.inspect} : #{self}"
     ::Maveric.type_check :path, path, String
     if self =~ path
-      Hash[ *@params.zip($~.captures).flatten ].update(nil => self)
+      @options.
+        merge( Hash[ *@params.zip($~.captures).flatten ] ).
+        update(nil => self) # should be safe enough.
     end
   end
 
@@ -736,7 +760,7 @@ class Maveric::Route < Regexp
   end
 
   ##
-  # As Route is a subclass of a corelib class, the inspect isn't as
+  # As Route is a subclass of a core lib class, the inspect isn't as
   # informative as we'd like. So we override it.
   def inspect
     "#<%s:0x%x %s %s %s>" % [
@@ -745,7 +769,7 @@ class Maveric::Route < Regexp
       super,
       @params.inspect,
       @path.inspect
-    ]
+    ] # we don't include @options, I know.
   end
 
   private

data/lib/maveric/extensions.rb

@@ -6,16 +6,22 @@ class Module
       gsub(/(::)+/, '/').
       downcase
   end
+
   # ::nodoc::
+  # Still deving this.
   def self.nesting_path_to_constant path
-    dig=proc{|c,n| c.const_get(n)}
+    dig = proc{|c,n| c.const_get(n) }
     path.gsub(/_([a-z])/){$1.upcase}.split('/')
   end
 end
 
 class Symbol
   # #to_s makes sense, but #to_i is just as effective.
-  def <=> o; o.instance_of?(Symbol) ? self.to_i <=> o.to_i : super; end
+  def <=> obj
+    obj.instance_of?(Symbol) ?
+      self.to_i <=> obj.to_i :
+      super
+  end
 end
 
 module Enumerable
@@ -30,9 +36,11 @@ module Enumerable
   # tpope> it's a little confusing, but it's a confusing concept
 
   ##
-  # Used to return the first value for which the black evalutes as true.
+  # Used to return the first value for which the given block evalutes as true.
   # Think .map(&b).compact.first
-  def eject &b; find{|e| r=b[e] and break r }; end
+  def eject &block
+    find{|e| result = block[e] and break result }
+  end
 end
 
 ##
@@ -41,24 +49,34 @@ class StandardError
   DEFAULT_STATUS = 500
   DEFAULT_HEADERS = {'Content-Type'=>'text/plain'}
   attr_writer :status, :headers, :body
-  def status; @status or DEFAULT_STATUS; end
-  def headers; @headers or DEFAULT_HEADERS; end
+  def status
+    @status or DEFAULT_STATUS
+  end
+
+  def headers
+    @headers or DEFAULT_HEADERS
+  end
+  
   ## Unless @body is defined, a self inspect and backtrace is output.
-  def body; @body or [inspect, *backtrace]*"\n"; end
+  def body
+    @body or [inspect, *backtrace]*"\n"
+  end
+  
   ## See ::Maveric::Controller#to_http
   def to_http
     response = "Status: #{status}"+::Maveric::EOL
     response << headers.map{|(k,v)| "#{k}: #{v}" }*::Maveric::EOL
     response << ::Maveric::EOL*2 + body
   end
+  
   alias_method :old_init, :initialize
   ##
-  # After a bit of experimenting with Exception and raise I determinee a fun
+  # After a bit of experimenting with Exception and raise I determined a fun
   # and simple way to generate fast HTTP response error thingies. As long as
-  # you're within a call to dispatch (with no further rescue clauses) the
-  # StandardError will propogate up and be returned. As a StandardError has
-  # similar accessors as a Controller, they should be compatible with any
-  # outputting implimentation.
+  # you're within a call to Maveric#dispatch (with no further rescue clauses)
+  # the StandardError will propogate up and be returned. As a StandardError
+  # has similar accessors as a Controller, they should be compatible with any
+  # outputting implimentation for Maveric.
   #
   #   raise StandardErrpr; # 500 error
   #   raise StandardError, 'Crap!'; # 500 error with message set to 'Crap!'
@@ -67,15 +85,15 @@ class StandardError
   # In the final example line an Array is passed to raise as a second argument
   # rather than a String. This is taken as the HTTP status code. The next
   # element is tested to be a Hash, if so then it's values are merged into
-  # the HTTP headers. Then next item is tested to be a String, if so it is
+  # the HTTP headers. The next item is tested to be a String, if so it is
   # appended to the response body. All remaining elements are appended to
   # the response body in inspect format.
   #
   # A simple way of only including data that might be interpreted to being the
   # status, headers, or body is to place a nil previous to the data you want
-  # apended to the response body.
+  # appended to the response body.
   def initialize data=nil
-    #consider autosettign @status, like 503 for NoMethodError
+    # consider autosetting @status, like 503 for NoMethodError
     if data.is_a? Array and data[0].is_a? Integer
       @body = ''
       @status = data.shift if Integer === data.first

data/lib/maveric/sessions.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 class Maveric
   ##
   # Contains session data and provides conveniance in generating an appropriate
@@ -5,14 +7,22 @@ class Maveric
   class Sessions < Set
     COOKIE_NAME = 'SESSIONID'
 
+    ##
+    # Looks up a sessions by id given. The id argument should be a string of
+    # a hex number. (num.to_s(16) If id is not found a new Session is created
+    # and its Session#id is returned.
     def session id #wants stringed hex num
+      ::Maveric.type_check :id, id, String
+
       #ensure crusty old sessions don't linger
       @__i += 1 rescue @__i = 1
-      reject!{|s| s.expire < Time.now-3 } if (@__i%=10) == 0
+      reject!{|s| s.expire < Time.now-3 } if (@__i%=10) == 0 # 3 second grace
+      
       # now get the session
       session = find{|s| s.id == id } and return session
-      #there isn't one? then make a new one!
-      push Session.new and return last
+      
+      # there isn't one? then make a new one!
+      add (session=Session.new) and return session
     end
 
     ##
@@ -28,15 +38,28 @@ class Maveric
         touch
         ::Maveric.log.debug self
       end
+
       attr_reader :expires, :data, :duration
+      
       ## Returns an upcased hexed object_id, not #object_id.to_s(16) however.
-      def id; @id||=[object_id<<1].pack('i').unpack('I')[0].to_s(16).upcase; end
+      def id
+        @id||=[object_id<<1].pack('i').unpack('I')[0].to_s(16).upcase
+      end
+
       ##
       # One session is less than another if it expires sooner. Useful if we
       # are managing in a manner akin to a priority stack.
-      def <=> obj; Session === obj ? self.expires <=> obj.expires : super; end
+      def <=> obj
+        Session === obj ?
+          self.expires <=> obj.expires :
+          super
+      end
+      
       ## Set this session's expiry to @duration+Time.now
-      def touch; @expires = Time.now.gmtime + Integer(@duration); end
+      def touch
+        @expires = Time.now.gmtime + Integer(@duration)
+      end
+      
       ## Perhaps better named as #to_cookie for clarity?
       def to_s env=nil
         touch
@@ -51,23 +74,36 @@ class Maveric
       end
     end
   end
+  
   @sessions = Sessions.new
+  
   ## Return the standard session set.
-  def self.sessions; @sessions; end
+  def self.sessions
+    @sessions
+  end
+  
   ## Return a session via Session#session
-  def self.session id; @sessions.session id; end
+  def self.session id
+    @sessions.session id
+  end
+
   ##
   # Uses env[:cookie] to find the session_id, and retrives the data to set the
-  # valuse or env[:session].
-  def env_1_session env
+  # values or env[:session].
+  def set_session env
     session_id = env[:cookies][::Maveric::Sessions::COOKIE_NAME].first
     env[:session] = ::Maveric.session session_id 
   end
+
+  adjust_env :set_session
+
   class Controller
     ## Touches the session and includes it into the http headers.
-    def cleanup_1_sessions
+    def session_cleanup controller
       @env[:session].touch
       @headers['Set-Cookie'] = [@env[:session].to_s(@env)]
     end
+
+    after :session_cleanup
   end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: maveric
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2007-01-26 00:00:00 -07:00
+  version: 0.3.1
+date: 2007-01-28 00:00:00 -07:00
 summary: A simple, non-magical, framework.
 require_paths: 
 - lib/