scytrin-maveric 2 → 3

data/lib/maveric.rb

@@ -3,85 +3,22 @@ require 'uri'
 require 'rack'
 
 module Maveric
-  class Response < Exception
-    DEFAULT, @r = [500, 'text/plain'], {}
-    def self.[] e; @r[e]; end
-    def self.[]= e, v; @r[e]=v; end
-    def initialize err
-      @status, @headers, @body = if resp = Response[err] then resp else
-        [ DEFAULT[0],
-          { 'Content-Type' => DEFAULT[1],
-            'Content-Length' => err.length.to_s },
-          err]
-      end
-      super @body
-    end
-    def each; @body.each{|line| yield line }; end
-    def to_a; [@status, @headers, self]; end # to_splat in 1.9
-    alias_method :finish, :to_a
-  end
-
-  module Views
-    attr_reader :maveric
-    TEMPLATES = {}
-  end
-
-  module Helpers
-    protected
-
-    # Powerhouse method to build a response. TODO: doc
-    def respond *args, &blk
-      headers = Hash === args.last ? args.pop : {}
-      seed = (Symbol === args.last && args.last) ? '' : args.pop
-      views, args = args.reverse.partition{|e| Symbol === e }
-
-      bad = views.map{|e|e.to_s} - self.class::Views.instance_methods
-      raise ArgumentError, 'Invalid views: '+bad.inspect unless bad.empty?
-      warn 'Invalid arguments: '+args.inspect unless args.empty?
-
-      response = Rack::Response.new
-      response.headers.update self.class.headers
-      response.headers.update headers.
-        reject{|(k,v)| !k.is_a? String or !v.is_a? String }
-      response.extend self.class::Views
-      response.instance_variable_set '@maveric', self
-
-      catch :response do
-        yield response if block_given?
-        body = views.inject(seed){|b,v| response.__send__(v,b) }.to_s
-        response.length = Rack::Utils.bytesize body
-        response.body = body.to_a
-        return response.finish
-      end
-    end
-
-    private
-
-    # Provides a simple way of generating a redirection response, relative to
-    # the current url.
-    def redirect uri
-      uri = URI(uri).normalize
-      uri = URI(@request.url).merge uri
-      [ 303, { 'Location'=>uri.to_s,
-          'Content-Type'=>'text/plain',
-          'Content-Length'=>'0'
-        }, [] ]
-    end
-  end
+  # Should contain methods to be shared amongst various maverics
+  module Helpers; end
 
+  # Should contain various views to be utilized by various maverics
+  module Views; attr_reader :maveric; TEMPLATES = {}; end
 
 
   # The current instance is stored in the passed environment under the key
   # 'maveric'. A Rack::Request of the current request is provided at @request.
-  #
-  # If no action is provided, @action is set as :index.
-  def initialize env, action=nil, route=nil
+  def initialize env
     env['maveric'] = self
     @request = Rack::Request.new env
-    @route, @action = route, action || :index
+    @route, @action = self.class.routes.empty? ?
+      [nil, :index] : self.class.routes.find{|(r,d)| r === env['PATH_INFO'] }
     extend self.class::Helpers
     self.init_hook if self.respond_to? :init_hook
-    p [ @request.script_name, @route, @action ]
   end
   attr_reader :request, :route, :action
 
@@ -110,12 +47,68 @@ module Maveric
   end
 
 
+  private
+
+
+  # Powerhouse method to build a response. TODO: doc
+  def respond *args, &blk
+    headers = Hash === args.last ? args.pop : {}
+    seed = (Symbol === args.last && args.last) ? '' : args.pop
+    views, args = args.reverse.partition{|e| Symbol === e }
+
+    bad = views.map{|e|e.to_s} - self.class::Views.instance_methods
+    raise ArgumentError, 'Invalid views: '+bad.inspect unless bad.empty?
+    warn 'Invalid arguments: '+args.inspect unless args.empty?
+
+    response = Rack::Response.new
+    response.headers.update self.class.headers
+    response.headers.update headers.
+      reject{|(k,v)| !k.is_a? String or !v.is_a? String }
+    response.extend self.class::Views
+    response.instance_variable_set '@maveric', self
+
+    catch :response do
+      yield response if block_given?
+      body = views.inject(seed){|b,v| response.__send__(v,b) }.to_s
+      response.length = Rack::Utils.bytesize body
+      response.body = body.to_a
+      return response.finish
+    end
+  end
+
+
+  # Provides a simple way of generating a redirection response, relative to
+  # the current url.
+  def redirect uri
+    uri = URI(uri).normalize
+    uri = URI(@request.url).merge uri
+    [ 303, { 'Location'=>uri.to_s,
+        'Content-Type'=>'text/plain',
+        'Content-Length'=>'0'
+      }, [] ]
+  end
+
+
+  def routes_to dest
+    self.class.routes.select{|(r,d)| d === dest }
+  end
+
+
+  def route_to dest
+    routes_to(dest).find{|(r,d)| String === d }
+  end
+
+
+
   # Methods provided to construct a maveric
   module Class
     # Default headers for Maveric instantiation.
     attr_reader :routes, :headers
     attr_writer :mount
 
+    # Scours through './templates', unless provided an alternate directory,
+    # and adds templates and a method to maveric::Views. Currently handles
+    # haml and erb files.
     def add_templates directory='templates/*'
       Dir.glob directory do |file| p file
         next unless File.readable? file               and tmpl = File.read(file)
@@ -143,9 +136,15 @@ module Maveric
       end
     end
 
+    # Instantiates a maveric with the provided environment, then calls
+    # maveric#response
     def call env
-      r, a = @routes.find{|(r,d)| r === env['PATH_INFO'] }
-      new(env, a, r).response
+      new(env).response
+    end
+
+    def routing mountpoint, routes
+      @mount = mountpoint
+      routes.each{|d,a| route d, *a }
     end
 
     def route d, *a
@@ -156,25 +155,32 @@ module Maveric
       @mount || self.name.downcase.gsub(/^|::/, '/')
     end
 
-    def inspect
-      "#<Maveric:#{self.name} '#{mount}'>"
-    end
-
     def self.extend_object obj
       obj.instance_variable_set '@routes',  []
       obj.instance_variable_set '@headers', Rack::Utils::HeaderHash.new
       super
     end
+
+    def inspect
+      "#{self.name}:'#{mount}':#{routes.inspect}"
+    end
   end
 
+
+
   @maverics = [] unless defined? @maverics
   @last_hash = nil
   @map = nil
   class << self
     attr_reader :maverics
 
+    def inspect
+      "Maveric#{maverics.inspect}"
+    end
+
     # Generates a Rack::URLMap compatible hash composed of all maverics and
-    # their mount points.
+    # their mount points. Will be regenerated if the list of maverics have
+    # changed.
     def map
       return @map if @map and @last_hash == @maverics.hash
       @last_hash = @maverics.hash
@@ -195,7 +201,9 @@ module Maveric
       self.urlmap.call env
     end
 
-    def new app
+    # Returns itself, or a Rack::Cascade when provided an app
+    def new app=nil
+      return self unless app
       Rack::Cascade.new [app, self]
     end
 
@@ -226,15 +234,42 @@ module Maveric
       return obj
     end
   end
+
+
+
+  # Response is an Exception class that can be raised from within a call to
+  # maveric#response, with 401, 403, and 404 errors provided.
+  #
+  # <tt>raise Maveric::Response, 404</tt> will look up 404 via Response#[] and
+  # if a value is found, it is utilized to set the status, headers, and body.
+  #
+  # <tt>raise Maveric::Response, 'Bad stuff'</tt> will generate a plain-text
+  # 500 response with the message as the body of the response.
+  #
+  # Additional or replacement responses should be set via Response#[]= and
+  # should be valid rack responses.
+  class Response < Exception
+    DEFAULT, @r = [500, 'text/plain'], {}
+    def self.[] e; @r[e]; end
+    def self.[]= e, v; @r[e]=v; end
+    def initialize err
+      resp = Response[err] || [ DEFAULT[0],
+        { 'Content-Type' => DEFAULT[1], 'Content-Length' => err.length.to_s },
+        err]
+      @status, @headers, @body = resp
+      super @body
+    end
+    def each; @body.each{|line| yield line }; end
+    def to_a; [@status, @headers, self]; end # to_splat in 1.9
+    alias_method :finish, :to_a
+  end
 end
 
+
+
 class Rack::Request
   # Allows the request to provide the current maveric.
   def maveric; @env['maveric']; end
-  # Allows the request to provide the current session.
-  def session; @env['rack.session']; end
-  # Same as the standard Rack::Request method.
-  def url; site_root + fullpath; end
   # Provides the compliment to #fullpath.
   def site_root
     url = scheme + "://" + host
@@ -243,8 +278,11 @@ class Rack::Request
       scheme == "http"  && port != 80
     url
   end
+  def url; site_root + fullpath; end
 end
 
+
+
 Maveric::Response[401] = [401,
   {'Content-Type'=>'text/plain','Content-Length'=>'13'},
   ['Unauthorized.']]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scytrin-maveric
 version: !ruby/object:Gem::Version 
-  version: "2"
+  version: "3"
 platform: ruby
 authors: 
 - scytrin