padrino-core 0.10.2 → 0.10.3

data/lib/padrino-core/locale/pt_br.yml

@@ -13,7 +13,10 @@ pt_br:
     abbr_day_names: [Dom, Seg, Ter, Qua, Qui, Sex, Sab]
     month_names: [~, Janeiro, Fevereiro, Março, Abril, Maio, Junho, Julho, Agosto, Setembro, Outubro, Novembro, Dezembro]
     abbr_month_names: [~, Jan, Fev, Mar, Abr, Maio, Jun, Jul, Ago, Set, Out, Nov, Dez]
-    order: [ :day, :month, :year ]
+    order:
+      - day
+      - month
+      - year
 
   time:
     formats:

data/lib/padrino-core/locale/ru.yml

@@ -13,7 +13,10 @@ ru:
     abbr_day_names: [Вс, Пн, Вт, Ср, Чт, Пт, Сб]
     month_names: [~, Январь, Февраль, Март, Апрель, Май, Июнь, Июль, Август, Сентябрь, Октябрь, Ноябрь, Декабрь]
     abbr_month_names: [~, Янв, Феб, Мар, Апр, Май, Июн, Июл, Авг, Сен, Окт, Ноя, Дек]
-    order: [ :year, :month, :day ]
+    order:
+      - year
+      - month
+      - day
 
   time:
     formats:

data/lib/padrino-core/locale/tr.yml

@@ -13,7 +13,10 @@ tr:
     abbr_day_names: [Paz, Pts, Sal, Çar, Per, Cum, Cts]
     month_names: [~, Ocak, Şubat, Mart, Nisan, Mayıs, Haziran, Temmuz, Ağustos, Eylül, Ekim, Kasım, Aralık]
     abbr_month_names: [~, Oca, Şub, Mar, Nis, May, Haz, Tem, Ağu, Eyl, Eki, Kas, Ara]
-    order: [ :day, :month, :year ]
+    order:
+      - day
+      - month
+      - year
 
   time:
     formats:

data/lib/padrino-core/locale/uk.yml

@@ -13,7 +13,10 @@ uk:
     abbr_day_names: [Нд, Пн, Вт, Ср, Чт, Пт, Сб]
     month_names: [~, Січено, Лютий, Березень, Квітень, Травень, Червень, Липень, Серпень, Вересень, Жовтень, Листопад, Грудень]
     abbr_month_names: [~, Січ, Лют, Бер, Кві, Тра, Чер, Лип, Сер, Вер, Жов, Лис, Гру]
-    order: [ :year, :month, :day ]
+    order:
+      - year
+      - month
+      - day
 
   time:
     formats:

data/lib/padrino-core/locale/zh_cn.yml

@@ -13,7 +13,10 @@ zh_cn:
     abbr_day_names: [日, 一, 二, 三, 四, 五, 六]
     month_names: [~, 一月, 二月, 三月, 四月, 五月, 六月, 七月, 八月, 九月, 十月, 十一月, 十二月]
     abbr_month_names: [~, 1月, 2月, 3月, 4月, 5月, 6月, 7月, 8月, 9月, 10月, 11月, 12月]
-    order: [ :year, :month, :day ]
+    order:
+      - year
+      - month
+      - day
 
   time:
     formats:

data/lib/padrino-core/locale/zh_tw.yml

@@ -13,7 +13,10 @@ zh_tw:
     abbr_day_names: [日, 一, 二, 三, 四, 五, 六]
     month_names: [~, 一月, 二月, 三月, 四月, 五月, 六月, 七月, 八月, 九月, 十月, 十一月, 十二月]
     abbr_month_names: [~, 1月, 2月, 3月, 4月, 5月, 6月, 7月, 8月, 9月, 10月, 11月, 12月]
-    order: [ :year, :month, :day ]
+    order:
+      - year
+      - month
+      - day
 
   time:
     formats:

data/lib/padrino-core/logger.rb

@@ -5,10 +5,9 @@ PADRINO_LOGGER    = ENV['PADRINO_LOGGER'] unless defined?(PADRINO_LOGGER)
 module Padrino
 
   ##
-  # Returns the padrino logger
-  #
-  # ==== Examples
+  # @return [Padrino::Logger]
   #
+  # @example
   #   logger.debug "foo"
   #   logger.warn "bar"
   #
@@ -20,6 +19,20 @@ module Padrino
   ##
   # Set the padrino logger
   #
+  # @param [Object] value
+  #   an object that respond to <<, write, puts, debug, warn etc..
+  #
+  # @return [Object]
+  #   the given value
+  #
+  # @example using ruby default logger
+  #   require 'logger'
+  #   Padrino.logger = Logger.new(STDOUT)
+  #
+  # @example using ActiveSupport
+  #   require 'active_support/buffered_logger'
+  #   Padrino.logger = Buffered.new(STDOUT)
+  #
   def self.logger=(value)
     Thread.current[:padrino_logger] = value
   end
@@ -27,11 +40,6 @@ module Padrino
   ##
   # Extensions to the built in Ruby logger.
   #
-  # ==== Examples
-  #
-  #   logger.debug "foo"
-  #   logger.warn  "bar"
-  #
   class Logger
 
     attr_accessor :level
@@ -76,8 +84,7 @@ module Padrino
     # :format_message:: Format of message. Defaults to: ""%s - - [%s] \"%s\"""
     # :log_static:: Whether or not to show log messages for static files. Defaults to: false
     #
-    # ==== Examples
-    #
+    # @example
     #   Padrino::Logger::Config[:development] = { :log_level => :debug, :stream => :to_file }
     #   # or you can edit our defaults
     #   Padrino::Logger::Config[:development][:log_level] = :error
@@ -97,36 +104,27 @@ module Padrino
     #
     Config = {
       :production  => { :log_level => :warn,  :stream => :to_file },
-      :development => { :log_level => :debug, :stream => :stdout },
+      :development => { :log_level => :debug, :stream => :stdout, :format_datetime => ' ' },
       :test        => { :log_level => :debug, :stream => :null }
     }
     Config.merge!(PADRINO_LOGGER) if PADRINO_LOGGER
 
-    # Embed in a String to clear all previous ANSI sequences.
-    CLEAR      = "\e[0m"
-    BOLD       = "\e[1m"
-    BLACK      = "\e[30m"
-    RED        = "\e[31m"
-    GREEN      = "\e[32m"
-    YELLOW     = "\e[33m"
-    BLUE       = "\e[34m"
-    MAGENTA    = "\e[35m"
-    CYAN       = "\e[36m"
-    WHITE      = "\e[37m"
-
     # Colors for levels
     ColoredLevels = {
-      :fatal => [BOLD, RED],
-      :error => [RED],
-      :warn  => [YELLOW],
-      :info  => [GREEN],
-      :debug => [CYAN],
-      :devel => [MAGENTA]
+      :fatal => [:bold, :red],
+      :error => [:red],
+      :warn  => [:yellow],
+      :info  => [:green],
+      :debug => [:cyan],
+      :devel => [:magenta]
     } unless defined?(ColoredLevels)
 
     ##
     # Setup a new logger
     #
+    # @return [Padrino::Logger]
+    #   A {Padrino::Logger} instance
+    #
     def self.setup!
       config_level = (PADRINO_LOG_LEVEL || Padrino.env || :test).to_sym # need this for PADRINO_LOG_LEVEL
       config = Config[config_level]
@@ -151,46 +149,49 @@ module Padrino
     ##
     # To initialize the logger you create a new object, proxies to set_log.
     #
-    # ==== Options
+    # @param [Hash] options
     #
-    # :stream:: Either an IO object or a name of a logfile. Defaults to $stdout
-    # :log_level::
-    #   The log level from, e.g. :fatal or :info. Defaults to :debug in the
-    #   production environment and :debug otherwise.
-    # :auto_flush::
+    # @option options [Symbol] :stream ($stdout)
+    #   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.     
+    #
+    # @option options [Symbol] :auto_flush (true)
     #   Whether the log should automatically flush after new messages are
     #   added. Defaults to true.
-    # :format_datetime:: Format of datetime. Defaults to: "%d/%b/%Y %H:%M:%S"
-    # :format_message:: Format of message. Defaults to: ""%s - - [%s] \"%s\"""
-    # :log_static:: Whether or not to show log messages for static files. Defaults to: false
+    #
+    # @option options [Symbol] :format_datetime (" [%d/%b/%Y %H:%M:%S] ")
+    #   Format of datetime
+    #
+    # @option options [Symbol] :format_message ("%s -%s%s")
+    #    Format of message
+    #
+    # @option options [Symbol] :log_static (false)
+    #   Whether or not to show log messages for static files.
     #
     def initialize(options={})
-      @buffer            = []
-      @auto_flush        = options.has_key?(:auto_flush) ? options[:auto_flush] : true
-      @level             = options[:log_level] ? Levels[options[:log_level]] : Levels[:debug]
-      @log               = options[:stream]  || $stdout
-      @log.sync          = true
-      @mutex             = @@mutex[@log] ||= Mutex.new
-      @format_datetime   = options[:format_datetime] || "%d/%b/%Y %H:%M:%S"
-      @format_message    = options[:format_message]  || "%s - [%s] \"%s\""
-      @log_static        = options.has_key?(:log_static) ? options[:log_static] : false
+      @buffer          = []
+      @auto_flush      = options.has_key?(:auto_flush) ? options[:auto_flush] : true
+      @level           = options[:log_level] ? Levels[options[:log_level]] : Levels[:debug]
+      @log             = options[:stream]  || $stdout
+      @log.sync        = true
+      @mutex           = @@mutex[@log] ||= Mutex.new
+      @format_datetime = options[:format_datetime] || "%d/%b/%Y %H:%M:%S"
+      @format_message  = options[:format_message]  || "%s -%s%s"
+      @log_static      = options.has_key?(:log_static) ? options[:log_static] : false
     end
 
     ##
     # Colorize our level
     #
-    def colored_level(level)
-      style = ColoredLevels[level.to_s.downcase.to_sym].join("")
-      "#{style}#{level.to_s.upcase.rjust(7)}#{CLEAR}"
-    end
-
-    ##
-    # Set a color for our string. Color can be a symbol/string
+    # @param [String, Symbol] level
+    #
+    # @see Padrino::Logger::ColoredLevels
     #
-    def set_color(string, color, bold=false)
-      color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)
-      bold  = bold ? BOLD : ""
-      "#{bold}#{color}#{string}#{CLEAR}"
+    def colored_level(level)
+      style = ColoredLevels[level].map { |c| "\e[%dm" % String.colors[c] } * ''
+      [style, level.to_s.upcase.rjust(7), "\e[0m"] * ''
     end
 
     ##
@@ -206,6 +207,8 @@ module Padrino
     ##
     # Close and remove the current log object.
     #
+    # @return [NilClass]
+    #
     def close
       flush
       @log.close if @log.respond_to?(:close) && !@log.tty?
@@ -216,13 +219,47 @@ module Padrino
     # Appends a message to the log. The methods yield to an optional block and
     # the output of this block will be appended to the message.
     #
+    # @param [String] message
+    #   The message that you want write to your stream
+    #
+    # @param [String] level
+    #   The level one of :debug, :warn etc...
+    #
+    #
     def push(message = nil, level = nil)
-      self << @format_message % [colored_level(level), set_color(Time.now.strftime(@format_datetime), :yellow), message.to_s.strip]
+      write @format_message % [colored_level(level), Time.now.strftime(@format_datetime).yellow, message.to_s.strip]
+    end
+
+    ##
+    # Append a to development logger a given action with time
+    #
+    # @param [string] action
+    #   The action
+    #
+    # @param [float] time
+    #   Time duration for the given action
+    #
+    # @param [message] string
+    #   The message that you want to log
+    #
+    # @example
+    #   logger.bench 'GET', started_at, '/blog/categories'
+    #   # => DEBUG - GET (0.056ms) - /blog/categories
+    #
+    def bench(action, began_at, message, level=:debug, color=:yellow)
+      @_pad  ||= 8
+      @_pad    = action.to_s.size if action.to_s.size > @_pad
+      duration = Time.now - began_at
+      color    = :red if duration > 1
+      push "%s (" % action.to_s.upcase.rjust(@_pad).send(color) + "%0.4fms".bold.send(color) % duration + ") %s" % message.to_s, level
     end
 
     ##
     # Directly append message to the log.
     #
+    # @param [String] message
+    #   The message
+    #
     def <<(message = nil)
       message << "\n" unless message[-1] == ?\n
       @buffer << message
@@ -232,50 +269,21 @@ module Padrino
     alias :write :<<
 
     ##
-    # Generate the logging methods for Padrino.logger for each log level.
+    # Generate the logging methods for {Padrino.logger} for each log level.
     #
     Levels.each_pair do |name, number|
-      class_eval <<-LEVELMETHODS, __FILE__, __LINE__
-      # Appends a message to the log if the log level is at least as high as
-      # the log level of the logger.
-      #
-      # ==== Parameters
-      # message:: The message to be logged. Defaults to nil.
-      #
-      # ==== Returns
-      # self:: The logger object for chaining.
-      def #{name}(message = nil)
-        if #{number} >= level
-          message = block_given? ? yield : message
-          self.push(message, :#{name}) if #{number} >= level
-        end
-        self
-      end
-
-      # Appends a message to the log if the log level is at least as high as
-      # the log level of the logger. The bang! version of the method also auto
-      # flushes the log buffer to disk.
-      #
-      # ==== Parameters
-      # message:: The message to be logged. Defaults to nil.
-      #
-      # ==== Returns
-      # self:: The logger object for chaining.
-      def #{name}!(message = nil)
-        if #{number} >= level
-          message = block_given? ? yield : message
-          self.push(message, :#{name}) if #{number} >= level
-          flush if #{number} >= level
+      define_method(name) do |*args|
+        return if number < level
+        if args.size > 1
+          bench(*args)
+        else
+          push(args * '', name)
         end
-        self
       end
 
-      # ==== Returns
-      # Boolean:: True if this level will be logged by this logger.
-      def #{name}?
-        #{number} >= level
+      define_method(:"#{name}?") do
+        number >= level
       end
-      LEVELMETHODS
     end
 
     ##
@@ -284,19 +292,13 @@ module Padrino
     # rack.errors by default.
     #
     class Rack
-      ##
-      # Common Log Format: http://httpd.apache.org/docs/1.3/logs.html#common
-      # "lilith.local - - GET / HTTP/1.1 500 -"
-      #  %{%s - %s %s %s%s %s - %d %s %0.4f}
-      #
-      FORMAT = %{%s (%0.4fms) %s - %s %s%s%s %s - %d %s}
 
-      def initialize(app, uri_root)
+      def initialize(app, uri_root) # @private
         @app = app
         @uri_root = uri_root.sub(/\/$/,"")
       end
 
-      def call(env)
+      def call(env) # @private
         env['rack.logger'] = Padrino.logger
         env['rack.errors'] = Padrino.logger.log
         began_at = Time.now
@@ -307,31 +309,20 @@ module Padrino
 
       private
         def log(env, status, header, began_at)
-          now = Time.now
-          length = extract_content_length(header)
-
           return if env['sinatra.static_file'] and !logger.log_static
-
-          logger.debug FORMAT % [
+          logger.bench(
             env["REQUEST_METHOD"],
-            now - began_at,
-            env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-",
-            env["REMOTE_USER"] || "-",
-            @uri_root || "",
-            env["PATH_INFO"],
-            env["QUERY_STRING"].empty? ? "" : "?" + env["QUERY_STRING"],
-            env["HTTP_VERSION"],
-            status.to_s[0..3],
-            length]
-        end
-
-        def extract_content_length(headers)
-          headers.each do |key, value|
-            if key.downcase == 'content-length'
-              return value.to_s == '0' ? '-' : value
-            end
-          end
-          '-'
+            began_at,
+            [
+              @uri_root.to_s,
+              env["PATH_INFO"],
+              env["QUERY_STRING"].empty? ? "" : "?" + env["QUERY_STRING"],
+              ' - ',
+              status.to_s[0..3].bold
+            ] * '',
+            :debug,
+            :magenta
+          )
         end
     end # Rack
   end # Logger

data/lib/padrino-core/mounter.rb

@@ -3,8 +3,7 @@ module Padrino
   # Represents a particular mounted padrino application
   # Stores the name of the application (app folder name) and url mount path
   #
-  # ==== Examples
-  #
+  # @example
   #   Mounter.new("blog_app", :app_class => "Blog").to("/blog")
   #   Mounter.new("blog_app", :app_file => "/path/to/blog/app.rb").to("/blog")
   #
@@ -14,6 +13,16 @@ module Padrino
 
     attr_accessor :name, :uri_root, :app_file, :app_class, :app_root, :app_obj, :app_host
 
+    ##
+    # @param [String, Padrino::Application] name
+    #   The app name or the {Padrino::Application} class
+    #
+    # @param [Hash] options
+    # @option options [Symbol] :app_class (Detected from name)
+    # @option options [Symbol] :app_file (Automatically detected)
+    # @option options [Symbol] :app_obj (Detected)
+    # @option options [Symbol] :app_root (Directory of :app_file)
+    #
     def initialize(name, options={})
       @name      = name.to_s
       @app_class = options[:app_class] || @name.camelize
@@ -28,8 +37,10 @@ module Padrino
     ##
     # Registers the mounted application onto Padrino
     #
-    # ==== Examples
+    # @param [String] mount_url
+    #   Path where we mount the app
     #
+    # @example
     #   Mounter.new("blog_app").to("/blog")
     #
     def to(mount_url)
@@ -41,8 +52,10 @@ module Padrino
     ##
     # Registers the mounted application onto Padrino for the given host
     #
-    # ==== Examples
+    # @param [String] mount_host
+    #   Host name
     #
+    # @example
     #   Mounter.new("blog_app").to("/blog").host("blog.padrino.org")
     #   Mounter.new("blog_app").host("blog.padrino.org")
     #   Mounter.new("catch_all").host(/.*\.padrino.org/)
@@ -57,17 +70,22 @@ module Padrino
     # Maps Padrino application onto a Padrino::Router
     # For use in constructing a Rack application
     #
+    # @param [Padrino::Router]
+    #
+    # @return [Padrino::Router]
+    #
+    # @example
     #   @app.map_onto(router)
     #
     def map_onto(router)
       app_data, app_obj = self, @app_obj
-      app_obj.set :uri_root, app_data.uri_root
-      app_obj.set :app_name, app_data.name
-      app_obj.set :app_file, app_data.app_file unless ::File.exist?(app_obj.app_file)
-      app_obj.set :root,     app_data.app_root unless app_data.app_root.blank?
-      app_obj.set :public,   Padrino.root('public', app_data.uri_root) unless File.exists?(app_obj.public)
-      app_obj.set :static,   File.exist?(app_obj.public) if app_obj.nil?
-      app_obj.setup_application! # We need to initialize here the app.
+      app_obj.set :uri_root,       app_data.uri_root
+      app_obj.set :app_name,       app_data.name
+      app_obj.set :app_file,       app_data.app_file unless ::File.exist?(app_obj.app_file)
+      app_obj.set :root,           app_data.app_root unless app_data.app_root.blank?
+      app_obj.set :public_folder,  Padrino.root('public', app_data.uri_root) unless File.exists?(app_obj.public_folder)
+      app_obj.set :static,         File.exist?(app_obj.public_folder) if app_obj.nil?
+      app_obj.setup_application! # Initializes the app here with above settings.
       router.map(:to => app_obj, :path => app_data.uri_root, :host => app_data.app_host)
     end
 
@@ -81,6 +99,8 @@ module Padrino
     ###
     # Returns the basic route information for each named route
     #
+    # @return [Array]
+    #   Array of routes
     #
     def named_routes
       app_obj.routes.map { |route|
@@ -95,12 +115,15 @@ module Padrino
     ##
     # Makes two Mounters equal if they have the same name and uri_root
     #
+    # @param [Padrino::Mounter] other
+    #
     def ==(other)
       other.is_a?(Mounter) && self.app_class == other.app_class && self.uri_root == other.uri_root
     end
 
     ##
-    # Returns the class object for the app if defined, nil otherwise
+    # @return [Padrino::Application]
+    #  the class object for the app if defined, nil otherwise
     #
     def app_constant
       klass = Object
@@ -160,14 +183,18 @@ module Padrino
     attr_writer :mounted_root # Set root directory where padrino searches mounted apps
 
     ##
-    # Returns the root to the mounted apps base directory
+    # @param [Array] args
+    #
+    # @return [String]
+    #   the root to the mounted apps base directory
     #
     def mounted_root(*args)
       Padrino.root(@mounted_root ||= "", *args)
     end
 
     ##
-    # Returns the mounted padrino applications (MountedApp objects)
+    # @return [Array]
+    #   the mounted padrino applications (MountedApp objects)
     #
     def mounted_apps
       @mounted_apps ||= []
@@ -176,6 +203,8 @@ module Padrino
     ##
     # Inserts a Mounter object into the mounted applications (avoids duplicates)
     #
+    # @param [Padrino::Mounter] mounter
+    #
     def insert_mounted_app(mounter)
       Padrino.mounted_apps.push(mounter) unless Padrino.mounted_apps.include?(mounter)
     end
@@ -183,6 +212,9 @@ module Padrino
     ##
     # Mounts a new sub-application onto Padrino project
     #
+    # @see Padrino::Mounter#new
+    #
+    # @example
     #   Padrino.mount("blog_app").to("/blog")
     #
     def mount(name, options={})

data/lib/padrino-core/reloader.rb

@@ -39,6 +39,7 @@ module Padrino
       def include_constants
         @_include_constants ||= []
       end
+
       ##
       # Reload all files with changes detected.
       #
@@ -107,6 +108,7 @@ module Padrino
       # A safe Kernel::require which issues the necessary hooks depending on results
       #
       def safe_load(file, options={})
+        began_at    = Time.now
         force, file = options[:force], figure_path(file)
 
         # Check if file was changed or if force a reload
@@ -134,8 +136,8 @@ module Padrino
 
         # And finally load the specified file
         begin
-          logger.devel "Loading #{file}"   if !reload
-          logger.debug "Reloading #{file}" if  reload
+          logger.devel :loading, began_at, file if !reload
+          logger.debug :reload,  began_at, file if  reload
           $LOADED_FEATURES.delete(file)
           verbosity_was, $-v = $-v, nil
           loaded = false
@@ -143,7 +145,7 @@ module Padrino
           loaded = true
           MTIMES[file] = File.mtime(file)
         rescue SyntaxError => e
-          logger.error "Cannot require #{file} because of syntax error: #{e.message}"
+          logger.error "Cannot require #{file} due to a syntax error: #{e.message}"
         ensure
           $-v = verbosity_was
           new_constants = (ObjectSpace.classes - klasses).uniq