padrino-core 0.10.3 → 0.10.4

data/README.rdoc

@@ -31,7 +31,7 @@ Mailer:: Fast and simple delivery support for sending emails (akin to ActionMail
 Admin:: Builtin Admin interface (like Django)
 Logging:: Provide a unified logger that can interact with your ORM or any library.
 Reloading:: Automatically reloads server code during development.
-Localization:: Full support of I18n language localization and can auto-set user’s locale.
+Localization:: Full support of I18n language localization and can auto-set user's locale.
 
 Keep in mind, the user will be able to pull in these components
 {seperately into existing Sinatra applications}[http://www.padrinorb.com/guides/standalone-usage-in-sinatra]

data/lib/padrino-core.rb

@@ -4,8 +4,9 @@ require 'padrino-core/support_lite' unless defined?(SupportLite)
 FileSet.glob_require('padrino-core/application/*.rb', __FILE__)
 FileSet.glob_require('padrino-core/*.rb', __FILE__)
 
-# Defines our Constants
+# The Padrino environment (falls back to the rack env or finally develop)
 PADRINO_ENV  = ENV["PADRINO_ENV"]  ||= ENV["RACK_ENV"] ||= "development"  unless defined?(PADRINO_ENV)
+# The Padrino project root path (falls back to the first caller)
 PADRINO_ROOT = ENV["PADRINO_ROOT"] ||= File.dirname(Padrino.first_caller) unless defined?(PADRINO_ROOT)
 
 module Padrino

data/lib/padrino-core/application/rendering.rb

@@ -2,11 +2,14 @@ require 'padrino-core/support_lite' unless defined?(SupportLite)
 
 module Padrino
   ##
-  # Padrino enhances the Sinatra ‘render’ method to have support for
+  # Padrino enhances the Sinatra 'render' method to have support for
   # automatic template engine detection, enhanced layout functionality,
   # locale enabled rendering, among other features.
   #
   module Rendering
+    ##
+    # Exception responsible for when an expected template did not exist.
+    #
     class TemplateNotFound < RuntimeError
     end
 
@@ -26,10 +29,10 @@ module Padrino
     #
     DEFAULT_RENDERING_OPTIONS = { :strict_format => false, :raise_exceptions => true } unless defined?(DEFAULT_RENDERING_OPTIONS)
 
-    ##
-    # Main class that register this extension.
-    #
     class << self
+      ##
+      # Main class that register this extension.
+      #
       def registered(app)
         app.send(:include, InstanceMethods)
         app.extend(ClassMethods)
@@ -37,6 +40,9 @@ module Padrino
       alias :included :registered
     end
 
+    ##
+    # Class methods responsible for rendering templates as part of a request.
+    #
     module ClassMethods
       ##
       # Use layout like rails does or if a block given then like sinatra.
@@ -100,6 +106,7 @@ module Padrino
       end
     end
 
+    # Instance methods that allow enhanced rendering to function properly in Padrino.
     module InstanceMethods
       attr_reader :current_engine
 
@@ -270,7 +277,7 @@ module Padrino
 
           raise TemplateNotFound, "Template '#{template_path}' not found in '#{view_path}'!"  if !located_template && options[:raise_exceptions]
           settings.cache_template_file!(located_template, rendering_options) unless settings.reload_templates?
-          logger.debug :template, began_at, located_template[0] if settings.logging? && defined?(logger)
+          logger.debug :template, began_at, located_template[0] if located_template && settings.logging? && defined?(logger)
           located_template
         end
 

data/lib/padrino-core/application/routing.rb

@@ -60,6 +60,7 @@ class HttpRouter
     end
   end
 
+  # @private
   class Route
     attr_accessor :use_layout, :controller, :cache, :cache_key, :cache_expires_in
 
@@ -128,9 +129,12 @@ module Padrino
   # which can be used to refer to the url throughout the application.
   #
   module Routing
+    # Defines common content-type alias mappings
     CONTENT_TYPE_ALIASES = { :htm => :html } unless defined?(CONTENT_TYPE_ALIASES)
+    # Defines the available route priorities supporting route deferrals.
     ROUTE_PRIORITY = {:high => 0, :normal => 1, :low => 2} unless defined?(ROUTE_PRIORITY)
 
+    # Raised when a route was invalid or cannot be processed.
     class UnrecognizedException < RuntimeError; end
 
     class Parent < String # @private
@@ -159,6 +163,7 @@ module Padrino
       alias :included :registered
     end
 
+    # Class methods responsible for enhanced routing for controllers.
     module ClassMethods
       ##
       # Method for organize in a better way our routes.
@@ -294,6 +299,9 @@ module Padrino
         add_filter :after, &(args.empty? ? block : construct_filter(*args, &block))
       end
 
+      ##
+      # Adds a filter hook to a request.
+      #
       def  add_filter(type, &block)
         filters[type] << block
       end
@@ -393,6 +401,7 @@ module Padrino
       end
       alias :urls :router
 
+      # Compiles the routes including deferred routes.
       def compiled_router
         if deferred_routes.empty?
           router
@@ -403,10 +412,14 @@ module Padrino
         end
       end
 
+      # Returns all routes that were deferred based on their priority.
       def deferred_routes
         @deferred_routes ||= Hash[ROUTE_PRIORITY.values.sort.map{|p| [p, []]}]
       end
 
+      ##
+      # Resets the http router and all deferred routes.
+      #
       def reset_router!
         @deferred_routes = nil
         router.reset!
@@ -480,13 +493,6 @@ module Padrino
         route('HEAD', path, *args, &block)
       end
 
-      ##
-      # Returns the lat controller, useful inside a layout/view.
-      #
-      def current_controller
-        @_controller and @_controller[-1]
-      end
-
       private
         # Parse params from the url method
         def value_to_param(value)
@@ -780,6 +786,9 @@ module Padrino
         end
     end
 
+    ##
+    # Instance methods related to recognizing and processing routes and serving static files.
+    #
     module InstanceMethods
       ##
       # Instance method for url generation.
@@ -802,10 +811,16 @@ module Padrino
       end
       alias :url_for :url
 
+      ##
+      # Returns the recognized path for a route.
+      #
       def recognize_path(path)
         settings.recognize_path(path)
       end
 
+      ##
+      # Returns the current path within a route from specified +path_params+.
+      #
       def current_path(*path_params)
         if path_params.last.is_a?(Hash)
           path_params[-1] = params.merge(path_params[-1])
@@ -815,6 +830,17 @@ module Padrino
         @route.url(*path_params)
       end
 
+      ##
+      # Returns the current route
+      #
+      # @example
+      #   -if route.controller == :press
+      #     %li=show_article
+      #
+      def route
+        @route
+      end
+
       ##
       # This is mostly just a helper so request.path_info isn't changed when
       # serving files from the public directory.
@@ -834,6 +860,7 @@ module Padrino
       def static!
         if path = static_file?(request.path_info)
           env['sinatra.static_file'] = path
+          cache_control *settings.static_cache_control if settings.static_cache_control?
           send_file(path, :disposition => nil)
         end
       end

data/lib/padrino-core/caller.rb

@@ -1,4 +1,6 @@
 module Padrino
+
+  # List of callers in a Padrino application that should be ignored as part of a stack trace.
   PADRINO_IGNORE_CALLERS = [
     %r{lib/padrino-.*$},                             # all padrino code
     %r{/padrino-.*/(lib|bin)},                       # all padrino code

data/lib/padrino-core/logger.rb

@@ -1,5 +1,6 @@
-# Defines our PADRINO_LOGGER constants
+# Defines the log level for a Padrino project.
 PADRINO_LOG_LEVEL = ENV['PADRINO_LOG_LEVEL'] unless defined?(PADRINO_LOG_LEVEL)
+# Defines the logger used for a Padrino project.
 PADRINO_LOGGER    = ENV['PADRINO_LOGGER'] unless defined?(PADRINO_LOGGER)
 
 module Padrino
@@ -155,7 +156,7 @@ module Padrino
     #   Either an IO object or a name of a logfile. Defaults to $stdout
     #
     # @option options [Symbol] :log_level (:production in the production environment and :debug otherwise)
-    #   The log level from, e.g. :fatal or :info.     
+    #   The log level from, e.g. :fatal or :info.
     #
     # @option options [Symbol] :auto_flush (true)
     #   Whether the log should automatically flush after new messages are
@@ -318,12 +319,18 @@ module Padrino
               env["PATH_INFO"],
               env["QUERY_STRING"].empty? ? "" : "?" + env["QUERY_STRING"],
               ' - ',
-              status.to_s[0..3].bold
+              status.to_s[0..3].bold,
+              ' ',
+              code_to_name(status)
             ] * '',
             :debug,
             :magenta
           )
         end
+
+        def code_to_name(status)
+          ::Rack::Utils::HTTP_STATUS_CODES[status.to_i] || ''
+        end
     end # Rack
   end # Logger
 end # Padrino

data/lib/padrino-core/reloader.rb

@@ -12,8 +12,12 @@ module Padrino
     # Please note that this will not reload files in the background, and does so
     # only when explicitly invoked.
     #
+
+    # The modification times for every file in a project.
     MTIMES          = {}
+    # The list of files loaded as part of a project.
     LOADED_FILES    = {}
+    # The list of object constants and classes loaded as part of the project.
     LOADED_CLASSES  = {}
 
     class << self
@@ -237,6 +241,7 @@ module Padrino
         @last = (Time.now - cooldown)
       end
 
+      # Invoked in order to perform the reload as part of the request stack.
       def call(env)
         if @cooldown && Time.now > @last + @cooldown
           Thread.list.size > 1 ? Thread.exclusive { Padrino.reload! } : Padrino.reload!

data/lib/padrino-core/router.rb

@@ -24,7 +24,7 @@ module Padrino
   #   end
   #   run routes
   #
-  # @semipublic
+  # @api semipublic
   class Router
 
     # Constructs a new route mapper instance

data/lib/padrino-core/version.rb

@@ -5,7 +5,8 @@
 # without include full padrino core.
 #
 module Padrino
-  VERSION = '0.10.3' unless defined?(Padrino::VERSION)
+  # The version constant for the current version of Padrino.
+  VERSION = '0.10.4' unless defined?(Padrino::VERSION)
 
   #
   # The current Padrino version.

data/padrino-core.gemspec

@@ -23,15 +23,15 @@ Gem::Specification.new do |s|
   s.rdoc_options  = ["--charset=UTF-8"]
 
   # TODO remove after a couple versions
-  s.post_install_message = "\e[32m" + ("*" * 20)
-  s.post_install_message << "\n UPGRADE NOTES\n\n\e[31m When upgrading, please 'enable :sessions' for each application"
-  s.post_install_message << " as shown here:\e[0m http://bit.ly/kODKMx\n"
-  s.post_install_message << "\e[31m When upgrading, please 'register Padrino::Rendering' for each application"
-  s.post_install_message << " as shown here:\e[0m https://gist.github.com/1d36a35794dbbd664ea4"
-  s.post_install_message << "\n\e[32m" + ("*" * 20) + "\n\e[0m"
+  # s.post_install_message = "\e[32m" + ("*" * 20)
+  # s.post_install_message << "\n UPGRADE NOTES\n\n\e[31m When upgrading, please 'enable :sessions' for each application"
+  # s.post_install_message << " as shown here:\e[0m http://bit.ly/kODKMx\n"
+  # s.post_install_message << "\e[31m When upgrading, please 'register Padrino::Rendering' for each application"
+  # s.post_install_message << " as shown here:\e[0m https://gist.github.com/1d36a35794dbbd664ea4"
+  # s.post_install_message << "\n\e[32m" + ("*" * 20) + "\n\e[0m"
 
   s.add_dependency("tilt", "~> 1.3.0")
-  s.add_dependency("sinatra", "~> 1.3.0")
+  s.add_dependency("sinatra", "~> 1.3.1")
   s.add_dependency("http_router", "~> 0.10.2")
   s.add_dependency("thor", "~> 0.14.3")
   s.add_dependency("activesupport", "~> 3.1.0")

data/test/test_logger.rb

@@ -64,6 +64,15 @@ describe "PadrinoLogger" do
       assert_match /GET/, Padrino.logger.log.string
     end
 
+    should 'log an application\'s status code' do
+      mock_app do
+        enable :logging
+        get("/"){ "Foo" }
+      end
+      get "/"
+      assert_match /\e\[1m200\e\[0m OK/, Padrino.logger.log.string
+    end
+
     context "static asset logging" do
       should 'not log static assets by default' do
         mock_app do

data/test/test_rendering.rb

@@ -203,6 +203,27 @@ describe "Rendering" do
 
   context 'for application render functionality' do
 
+    should "work properly with logging and missing layout" do
+      create_view :index, "<%= foo %>"
+      mock_app do
+        enable :logging
+        get("/") { render "index", { :layout => true }, { :foo => "bar" } }
+      end
+      get "/"
+      assert_equal "bar", body
+    end
+
+    should "work properly with logging and layout" do
+      create_layout :application, "layout <%= yield %>"
+      create_view :index, "<%= foo %>"
+      mock_app do
+        enable :logging
+        get("/") { render "index", { :layout => true }, { :foo => "bar" } }
+      end
+      get "/"
+      assert_equal "layout bar", body
+    end
+
     should 'be compatible with sinatra render' do
       mock_app do
         get("/"){ render :erb, "<%= 1+2 %>" }

data/test/test_routing.rb

@@ -4,6 +4,31 @@ class FooError < RuntimeError; end
 
 
 describe "Routing" do
+  setup do
+    Padrino::Application.send(:register, Padrino::Rendering)
+    Padrino::Rendering::DEFAULT_RENDERING_OPTIONS[:strict_format] = false
+  end
+
+  should "serve static files with simple cache control" do
+    mock_app do
+      set :static_cache_control, :public
+      set :public_folder, File.dirname(__FILE__)
+    end
+    get "/#{File.basename(__FILE__)}"
+    assert headers.has_key?('Cache-Control')
+    assert_equal headers['Cache-Control'], 'public'
+  end # static simple
+
+  should "serve static files with cache control and max_age" do
+    mock_app do
+      set :static_cache_control, [:public, :must_revalidate, {:max_age => 300}]
+      set :public_folder, File.dirname(__FILE__)
+    end
+    get "/#{File.basename(__FILE__)}"
+    assert headers.has_key?('Cache-Control')
+    assert_equal headers['Cache-Control'], 'public, must-revalidate, max-age=300'
+  end # static max_age
+
   should 'ignore trailing delimiters for basic route' do
     mock_app do
       get("/foo"){ "okey" }

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: padrino-core
 version: !ruby/object:Gem::Version 
-  hash: 49
   prerelease: 
-  segments: 
-  - 0
-  - 10
-  - 3
-  version: 0.10.3
+  version: 0.10.4
 platform: ruby
 authors: 
 - Padrino Team
@@ -18,8 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-03 00:00:00 -07:00
-default_executable: 
+date: 2011-10-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: tilt
@@ -29,11 +23,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
         version: 1.3.0
   type: :runtime
   version_requirements: *id001
@@ -45,12 +34,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
+        version: 1.3.1
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -61,11 +45,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 0
-        - 10
-        - 2
         version: 0.10.2
   type: :runtime
   version_requirements: *id003
@@ -77,11 +56,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 33
-        segments: 
-        - 0
-        - 14
-        - 3
         version: 0.14.3
   type: :runtime
   version_requirements: *id004
@@ -93,11 +67,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 3
-        - 1
-        - 0
         version: 3.1.0
   type: :runtime
   version_requirements: *id005
@@ -186,15 +155,10 @@ files:
 - test/test_restful_routing.rb
 - test/test_router.rb
 - test/test_routing.rb
-has_rdoc: true
 homepage: http://www.padrinorb.com
 licenses: []
 
-post_install_message: "\e[32m********************\n UPGRADE NOTES\n\n\
-  \e[31m When upgrading, please 'enable :sessions' for each application as shown here:\e[0m http://bit.ly/kODKMx\n\
-  \e[31m When upgrading, please 'register Padrino::Rendering' for each application as shown here:\e[0m https://gist.github.com/1d36a35794dbbd664ea4\n\
-  \e[32m********************\n\
-  \e[0m"
+post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
@@ -204,25 +168,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: padrino-core
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: The required Padrino core gem