gin 1.1.2 → 1.2.0

data/lib/gin/config.rb

@@ -41,6 +41,8 @@ class Gin::Config
 
   attr_accessor :dir, :logger, :ttl, :environment
 
+  SYNTAX_ERROR = defined?(Psych) ? Psych::SyntaxError : ArgumentError
+
   ##
   # Create a new config instance for the given environment name.
   # The environment dictates which part of the config files gets exposed.
@@ -120,7 +122,7 @@ class Gin::Config
       @data[name] = c
     end
 
-  rescue Psych::SyntaxError
+  rescue SYNTAX_ERROR
     @logger.write "[ERROR] Could not parse config `#{filepath}' as YAML"
     return nil
   end

data/lib/gin/constants.rb

@@ -7,6 +7,8 @@ module Gin::Constants
   REMOTE_ADDR    = 'REMOTE_ADDR'.freeze
   REMOTE_USER    = 'REMOTE_USER'.freeze
   HTTP_VERSION   = 'HTTP_VERSION'.freeze
+  SERVER_NAME    = 'SERVER_NAME'.freeze
+  SERVER_PORT    = 'SERVER_PORT'.freeze
   REQ_METHOD     = 'REQUEST_METHOD'.freeze
   PATH_INFO      = 'PATH_INFO'.freeze
   QUERY_STRING   = 'QUERY_STRING'.freeze
@@ -14,6 +16,7 @@ module Gin::Constants
   IF_NONE_MATCH  = 'HTTP_IF_NONE_MATCH'.freeze
   IF_MOD_SINCE   = 'HTTP_IF_MODIFIED_SINCE'.freeze
   IF_UNMOD_SINCE = 'HTTP_IF_UNMODIFIED_SINCE'.freeze
+  RACK_INPUT     = 'rack.input'.freeze
 
   ASYNC_CALLBACK = 'async.callback'.freeze
 
@@ -27,13 +30,15 @@ module Gin::Constants
   CACHE_CTRL      = 'Cache-Control'.freeze
   EXPIRES         = 'Expires'.freeze
   PRAGMA          = 'Pragma'.freeze
+  HOST_NAME       = 'Host'.freeze
 
   # Gin env constants
+  GIN_APP         = 'gin.app'.freeze
   GIN_STACK       = 'gin.stack'.freeze
   GIN_ROUTE       = 'gin.http_route'.freeze
   GIN_PATH_PARAMS = 'gin.path_query_hash'.freeze
+  GIN_TARGET      = 'gin.target'.freeze
   GIN_CTRL        = 'gin.controller'.freeze
-  GIN_ACTION      = 'gin.action'.freeze
   GIN_STATIC      = 'gin.static'.freeze
   GIN_RELOADED    = 'gin.reloaded'.freeze
   GIN_ERRORS      = 'gin.errors'.freeze

data/lib/gin/controller.rb

@@ -49,6 +49,7 @@
 
 class Gin::Controller
   extend  GinClass
+  extend  Gin::Mountable
   include Gin::Constants
   include Gin::Filterable
   include Gin::Errorable
@@ -84,7 +85,7 @@ class Gin::Controller
   # Array of action names for this controller.
 
   def self.actions
-    instance_methods(false)
+    instance_methods(false).map{|a| a.to_sym }
   end
 
 
@@ -93,6 +94,9 @@ class Gin::Controller
   # Underscores the class name and removes mentions of 'controller'.
   #   MyApp::FooController.controller_name
   #   #=> "my_app/foo"
+  #
+  # Note that when route names get autogenerated, the namespacing is dropped.
+  # If two routes have the same name, the last one defined wins.
 
   def self.controller_name new_name=nil
     @ctrl_name = new_name if new_name
@@ -100,6 +104,32 @@ class Gin::Controller
   end
 
 
+  DEFAULT_ACTION_MAP = {
+    :index   => %w{GET /},
+    :show    => %w{GET /:id},
+    :new     => %w{GET /new},
+    :create  => %w{POST /},
+    :edit    => %w{GET /:id/edit},
+    :update  => %w{PUT /:id},
+    :destroy => %w{DELETE /:id}
+  } # :nodoc:
+
+
+  def self.default_route_for action #:nodoc:
+    DEFAULT_ACTION_MAP[action] || ['GET', "/#{action}"]
+  end
+
+
+  def self.route_name_for action #:nodoc:
+    "#{action}_#{controller_name.sub(%r{^.*/},'')}".to_sym
+  end
+
+
+  def self.display_name action=nil #:nodoc:
+    [self, action].compact.join("#")
+  end
+
+
   ##
   # Set or get the default content type for this Gin::Controller.
   # Default value is "text/html". This attribute is inherited.
@@ -123,6 +153,18 @@ class Gin::Controller
   end
 
 
+  ##
+  # Call the Controller with an Rack env hash. Requires the hash to have
+  # the keys 'gin.target' with the action name as the second item of the array,
+  # and 'gin.app'.
+
+  def self.call env
+    inst = new(env[GIN_APP], env)
+    env[GIN_CTRL] = inst
+    inst.call_action(env[GIN_TARGET][1])
+  end
+
+
   ##
   # Get or set a layout for a given controller.
   # Value can be a symbol or filepath.
@@ -164,7 +206,11 @@ class Gin::Controller
   end
 
 
-  def call_action action #:nodoc:
+  ##
+  # Calls the given or preset action and returns a Rack response Array.
+
+  def call_action action=nil
+    action ||= @action
     invoke{ dispatch action }
     invoke{ handle_status(@response.status) }
     content_type self.class.content_type unless @response[CNT_TYPE]
@@ -301,8 +347,6 @@ class Gin::Controller
   end
 
 
-
-
   ##
   # Set multiple response headers with Hash.
 
@@ -404,7 +448,8 @@ class Gin::Controller
 
   def path_to *args
     return "#{args[0]}#{"?" << Gin.build_query(args[1]) if args[1]}" if String === args[0]
-    args.unshift(self.class) if Symbol === args[0] && respond_to?(args[0])
+    args.unshift(self.class) if Symbol === args[0] &&
+                                self.class.actions.include?(args[0])
     @app.router.path_to(*args)
   end
 
@@ -471,6 +516,95 @@ class Gin::Controller
   end
 
 
+  ##
+  # Halt execution of the current controller action and create a new request to
+  # another action and/or controller, or path.
+  #
+  # Raises Gin::RouterError if the controller and action don't have a route.
+  # Returns a 404 response if an unrecognized path is given.
+  #
+  # The rewrite method acts just as if a request had been sent from the client,
+  # and will re-run any of the in-app middleware. If the app is itself running
+  # as middleware, you may use rewrite to pass a request down to the next item
+  # in the stack by specifying a path not supported by the app.
+  #
+  # Supports the same arguments at the Gin::Controller#url_to method.
+  #
+  #   rewrite MyController, :action
+  #   #=> Calls app with route for MyController#action
+  #
+  #   rewrite MyController, :show, :id => 123
+  #   #=> Calls app with route for MyController#action with the given params
+  #
+  #   rewrite :show_foo
+  #   #=> Calls app with route for the current controller's :show_foo action,
+  #   #=> or if missing the controller and action for the :show_foo named route.
+  #
+  #   # Rewrite and execute the request with the given headers.
+  #   rewrite :show_foo, 'HTTP_X_CUSTOM_HEADER' => 'foo'
+  #   rewrite :show_foo, params, 'HTTP_X_CUSTOM_HEADER' => 'foo'
+  #
+  #   # Rewrite to an arbitrary path.
+  #   rewrite '/path/to/something/else', {}, 'REQUEST_METHOD' => 'POST'
+  #
+  # Note that params are not forwarded with the rewrite call. The app
+  # considers this to be a completely different request, which means all params
+  # required must be passed explicitely.
+  #
+  # Streamed and IO request content is also ignored unless it is explicitely
+  # assigned to the 'rack.input' (as a part of the headers argument).
+
+  def rewrite *args
+    args.unshift(self.class) if Symbol === args[0] &&
+                                self.class.actions.include?(args[0])
+    halt(*@app.rewrite!(@env, *args))
+  end
+
+
+  ##
+  # Unlike Gin::Controller#rewrite, the reroute method forwards the current
+  # request and params to the provided controller and/or action, or named route.
+  # Halts further execution in the current action.
+  # Raises RouterError if a given named route isn't found in the app's routes.
+  #
+  #   reroute MyController, :action
+  #   #=> Executes MyController#action
+  #
+  #   reroute MyController, :show, :id => 123
+  #   #=> Executes MyController#action with the given params merged to
+  #   #=> the current params.
+  #
+  #   reroute :show_foo
+  #   #=> Executes the current controller's :show_foo action, or if missing
+  #   #=> the controller and action for the :show_foo named route.
+  #
+  #   # Reroute with the given headers.
+  #   reroute :show_foo, {}, 'HTTP_X_CUSTOM_HEADER' => 'foo'
+
+  def reroute *args
+    args.unshift(self.class) if Symbol === args[0] &&
+                                self.class.actions.include?(args[0])
+    nheaders = args.pop if Hash === args.last && Hash === args[-2] && args[-2] != args[-1]
+    nparams  = args.pop if Hash === args.last
+
+    if Class === args[0]
+      ctrl_klass, naction = args[0..1]
+    else
+      route = @app.router.route_to(*args)
+      ctrl_klass, naction = route.target
+    end
+
+    nenv = @env.merge(nheaders || {})
+    nenv[GIN_PATH_PARAMS] = {}
+    ctrl = ctrl_klass.new(@app, nenv)
+
+    ctrl.params.merge!(params)
+    ctrl.params.merge!(nparams) if nparams
+
+    halt(*ctrl.call_action(naction))
+  end
+
+
   ##
   # Assigns a file to the response body and halts the execution of the action.
   # Produces a 404 response if no file is found.
@@ -510,9 +644,15 @@ class Gin::Controller
   def last_modified time
     return unless time
 
-    time = Time.at(time)    if Integer === time
-    time = Time.parse(time) if String === time
-    time = time.to_time     if time.respond_to?(:to_time)
+    time = if Integer === time
+             Time.at(time)
+           elsif time.respond_to?(:to_time)
+             time.to_time
+           elsif !time.is_a?(Time)
+             Time.parse time.to_s
+           else
+             time
+           end
 
     @response[LAST_MOD] = time.httpdate
     return if @env[IF_NONE_MATCH]
@@ -596,7 +736,7 @@ class Gin::Controller
 
   def expire_cache_control
     @response[PRAGMA] = 'no-cache'
-    expires EPOCH, :no_cache, :no_store, :must_revalidate, max_age: 0
+    expires EPOCH, :no_cache, :no_store, :must_revalidate, :max_age => 0
   end
 
 
@@ -604,9 +744,28 @@ class Gin::Controller
   # Returns the url to an asset, including predefined asset cdn hosts if set.
 
   def asset_url name
-    url = File.join(@app.asset_host_for(name).to_s, name)
-    url = [url, *@app.asset_version(url)].join("?") if url !~ %r{^https?://}
-    url
+    host = @app.asset_host_for(name)
+    return asset_path(name) if !host
+    File.join(host, name)
+  end
+
+
+  ##
+  # Returns the HTTP path to the local asset.
+
+  def asset_path name
+    fdpath = @app.asset(name)
+
+    if fdpath && fdpath.start_with?(@app.assets_dir)
+      if fdpath.start_with?(@app.public_dir)
+        fdpath[@app.public_dir.length..-1]
+      else
+        fdpath[@app.assets_dir.length..-1]
+      end
+    else
+      path = File.join('', name)
+      [path, *@app.asset_version(name)].compact.join("?")
+    end
   end
 
 
@@ -643,7 +802,7 @@ class Gin::Controller
   #   #=> "<root_dir>/other/foo"
 
   def template_path template, is_layout=false
-    dir = if template[0] == ?/
+    dir = if template.to_s[0] == ?/
             @app.root_dir
           elsif is_layout
             @app.layouts_dir
@@ -765,10 +924,11 @@ class Gin::Controller
 
   def html_error_page err, code=nil
     if @app.development?
-      fulltrace = err.backtrace.join("\n")
+      backtrace = err.backtrace || ['No backtrace :(']
+      fulltrace = backtrace.join("\n")
       fulltrace = "<pre>#{h(fulltrace)}</pre>"
 
-      apptrace  = Gin.app_trace(err.backtrace).join("\n")
+      apptrace  = Gin.app_trace(backtrace).join("\n")
       apptrace  = "<pre>#{h(apptrace)}</pre>" unless apptrace.empty?
 
       DEV_ERROR_HTML %
@@ -807,9 +967,12 @@ class Gin::Controller
   # Get action arguments from the params.
   # Raises Gin::BadRequest if a required argument has no matching param.
 
-  def action_arguments action=@action
+  def action_arguments action
+    raise Gin::NotFound,
+      "No action exists for: #{env[REQ_METHOD]} #{env[PATH_INFO]}" unless action
+
     raise Gin::NotFound, "No action #{self.class}##{action}" unless
-      self.class.actions.include? action.to_sym
+      self.class.actions.include?(action.to_sym)
 
     args = []
     temp = []

data/lib/gin/core_ext/float.rb

@@ -0,0 +1,10 @@
+if Float.instance_method(:round).arity == 0
+class Float
+  undef round
+  def round ndigits=0
+    num, dec = self.to_s.split(".")
+    num = "#{num}.#{dec[0,ndigits]}".sub(/\.$/, "")
+    Float num
+  end
+end
+end

data/lib/gin/core_ext/time.rb

@@ -0,0 +1,41 @@
+unless Time.now.respond_to?(:httpdate)
+
+class Time
+  def httpdate(date)
+    if /\A\s*
+        (?:Mon|Tue|Wed|Thu|Fri|Sat|Sun),\x20
+        (\d{2})\x20
+        (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\x20
+        (\d{4})\x20
+        (\d{2}):(\d{2}):(\d{2})\x20
+        GMT
+        \s*\z/x =~ date
+      self.rfc2822(date)
+    elsif /\A\s*
+           (?:Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday),\x20
+           (\d\d)-(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)-(\d\d)\x20
+           (\d\d):(\d\d):(\d\d)\x20
+           GMT
+           \s*\z/x =~ date
+      year = $3.to_i
+      if year < 50
+        year += 2000
+      else
+        year += 1900
+      end
+      self.utc(year, $2, $1.to_i, $4.to_i, $5.to_i, $6.to_i)
+    elsif /\A\s*
+           (?:Mon|Tue|Wed|Thu|Fri|Sat|Sun)\x20
+           (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\x20
+           (\d\d|\x20\d)\x20
+           (\d\d):(\d\d):(\d\d)\x20
+           (\d{4})
+           \s*\z/x =~ date
+      self.utc($6.to_i, MonthValue[$1.upcase], $2.to_i,
+               $3.to_i, $4.to_i, $5.to_i)
+    else
+      raise ArgumentError.new("not RFC 2616 compliant date: #{date.inspect}")
+    end
+  end
+end
+end

data/lib/gin/filterable.rb

@@ -74,14 +74,14 @@ module Gin::Filterable
 
       elsif opts[:except]
         except = Array(opts[:except])
-        filter_hsh.keys.each do |action|
-          next if action.nil?
-          filter_hsh[action] ||= filter_hsh[nil].dup and next if
-            except.include?(action)
+        except.each do |action|
+          filter_hsh[action] ||= filter_hsh[nil].dup
+        end
 
+        filter_hsh.keys.each do |action|
+          next if except.include?(action)
           yield filter_hsh, action, names
         end
-        yield filter_hsh, nil, names
 
       else
         filter_hsh.keys.each do |action|

data/lib/gin/mountable.rb

@@ -0,0 +1,100 @@
+##
+# The Gin::Mountable module provides an interface to mount any type of object
+# to a Gin::App route.
+#
+# The Gin::Mountable module is only necessary if features such automatic route
+# naming and defaults are needed. Gin will otherwise happily mount any object
+# that responds to the `call' method onto it's routing tree.
+
+module Gin::Mountable
+
+  def verify_mount! #:nodoc:
+    controller_name.to_str
+
+    test_action = actions[0]
+
+    test_route = default_route_for(test_action)
+    test_route[0].to_str
+    test_route[1].to_str
+
+    route_name_for(test_action).to_proc
+
+    display_name.to_str
+    display_name(test_action).to_str
+
+    true
+  end
+
+
+  ##
+  # The actions available on this Mountable object.
+  # Actions can be of any object type.
+  #
+  # Must return an Array of actions. Must be overloaded.
+  #   UserController.actions
+  #   #=> [:show, :delete, :list, :update]
+
+  def actions
+    raise NoMethodError,
+      "The `#{__method__}' method must be defined on #{self} and return an\
+Array of available actions for the Router to map to."
+  end
+
+
+  ##
+  # The String representing the controller.
+  #
+  # Must return a String. Must be overloaded.
+  #   UserController.controller_name
+  #   #=> 'user'
+
+  def controller_name
+    raise NoMethodError,
+      "The `#{__method__}' method must be defined on #{self} and return a\
+String representing the controller name."
+  end
+
+
+  ##
+  # Should return a 2 item Array with the HTTP verb and request path (local to
+  # the controller) to use for a given action.
+  #
+  # Must return a 2 item Array of Strings. Must be overloaded.
+  #   UserController.default_route_for :show
+  #   #=> ['GET', '/:id']
+
+  def default_route_for action
+    raise NoMethodError,
+      "The `#{__method__}' method must be defined on #{self} and return a\
+2 item Array with the HTTP verb and local path: ['GET', '/users/:id']"
+  end
+
+
+  ##
+  # Creates a route name used to identify a given route. Used by helper methods.
+  #
+  # Must return a Symbol, or nil. Must be overloaded.
+  #   UserController.route_name_for :show
+  #   #=> :show_user
+
+  def route_name_for action
+    raise NoMethodError,
+      "The `#{__method__}' method must be defined on #{self} and return a\
+Symbol representing the route name: :show_user"
+  end
+
+
+  ##
+  # Creates a display name for the Controller (and optional action).
+  # Used for logging and error messages.
+  #
+  # Must return a String. Must be overloaded.
+  #   UserController.display_name :show
+  #   #=> "UserController#show"
+
+  def display_name action=nil
+    raise NoMethodError,
+      "The `#{__method__}' method must be defined on #{self} and return a\
+String for display purposes"
+  end
+end