padrino-core 0.10.2 → 0.10.3

data/lib/padrino-core/router.rb

@@ -11,13 +11,7 @@ module Padrino
   # * Ignore server names (this solve issues with vhost and domain aliases)
   # * Use hosts instead of server name for mappings (this help us with our vhost and doman aliases)
   #
-  # ==== Options
-  #
-  # :to:: The class of application that you want mount
-  # :path:: Map the app to the given path
-  # :host:: Map the app to the given host
-  #
-  # ==== Examples
+  # @example
   #
   #   routes = Padrino::Router.new do
   #     map(:path => "/", :to => PadrinoWeb, :host => "padrino.local")
@@ -30,17 +24,33 @@ module Padrino
   #   end
   #   run routes
   #
+  # @semipublic
   class Router
+
+    # Constructs a new route mapper instance
     def initialize(*mapping, &block)
       @mapping = []
       mapping.each { |m| map(m) }
       instance_eval(&block) if block
     end
 
-    def sort!
-      @mapping = @mapping.sort_by { |h, p, m, a| -p.size }
-    end
-
+    ##
+    # Map a route path and host to a specified application.
+    #
+    # @param [Hash] options
+    #  The options to map.
+    # @option options [Sinatra::Application] :to
+    #  The class of the application to mount.
+    # @option options [String] :path ("/")
+    #  The path to map the specified application.
+    # @option options [String] :host
+    #  The host to map the specified application.
+    #
+    # @example
+    #  map(:path => "/", :to => PadrinoWeb, :host => "padrino.local")
+    #
+    # @return [Array] The sorted route mappings.
+    # @api semipublic
     def map(options={})
       path = options[:path] || "/"
       host = options[:host]
@@ -57,6 +67,8 @@ module Padrino
       sort!
     end
 
+    # The call handler setup to route a request given the mappings specified.
+    # @api private
     def call(env)
       rPath = env["PATH_INFO"].to_s
       script_name = env['SCRIPT_NAME']
@@ -75,5 +87,12 @@ module Padrino
       end
       [404, {"Content-Type" => "text/plain", "X-Cascade" => "pass"}, ["Not Found: #{rPath}"]]
     end
+
+    private
+
+    # Sorts the mapped routes in consistent order
+    def sort!
+      @mapping = @mapping.sort_by { |h, p, m, a| -p.size }
+    end
   end # Router
 end # Padrino

data/lib/padrino-core/server.rb

@@ -1,10 +1,9 @@
 module Padrino
   ##
-  # Run the Padrino apps as a self-hosted server using:
-  # thin, mongrel, webrick in that order.
-  #
-  # ==== Examples
+  # Runs the Padrino apps as a self-hosted server using:
+  # thin, mongrel, or webrick in that order.
   #
+  # @example
   #   Padrino.run! # with these defaults => host: "localhost", port: "3000", adapter: the first found
   #   Padrino.run!("localhost", "4000", "mongrel") # use => host: "0.0.0.0", port: "3000", adapter: "mongrel"
   #
@@ -14,12 +13,13 @@ module Padrino
   end
 
   ##
-  # This module build a Padrino server
+  # This module builds a Padrino server to run the project based on available handlers.
   #
   class Server < Rack::Server
     # Server Handlers
     Handlers = [:thin, :mongrel, :webrick]
 
+    # Starts the application on the available server with specified options.
     def self.start(app, opts={})
       options = {}.merge(opts) # We use a standard hash instead of Thor::CoreExt::HashWithIndifferentAccess
       options.symbolize_keys!
@@ -38,6 +38,7 @@ module Padrino
       @options, @app = options, app
     end
 
+    # Starts the application on the available server with specified options.
     def start
       puts "=> Padrino/#{Padrino.version} has taken the stage #{Padrino.env} at http://#{options[:Host]}:#{options[:Port]}"
       [:INT, :TERM].each { |sig| trap(sig) { exit } }
@@ -46,16 +47,24 @@ module Padrino
       puts "<= Padrino has ended his set (crowd applauds)" unless options[:daemonize]
     end
 
+    # The application the server will run.
     def app
       @app
     end
     alias :wrapped_app :app
 
+    # The options specified to the server.
     def options
       @options
     end
 
     private
+
+      # Detects the supported handler to use.
+      #
+      # @example
+      #   detect_rack_handler => <ThinHandler>
+      #
       def self.detect_rack_handler
         Handlers.each do |handler|
           begin

data/lib/padrino-core/support_lite.rb

@@ -10,10 +10,12 @@ require 'active_support/core_ext/array/extract_options'     # extract_options
 require 'active_support/inflector/methods'                  # constantize
 require 'active_support/inflector/inflections'              # pluralize
 require 'active_support/inflections'                        # load default inflections
+require 'yaml' unless defined?(YAML)                        # load yaml for i18n
+require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /win32/    # ruby color suppor for win
 
 ##
-# This is a small version of active_support/core_ext/string/inflections.rb
-# to prevent to load a lot of dependencies including I18n gem
+# This is an adapted version of active_support/core_ext/string/inflections.rb
+# to prevent loading several dependencies including I18n gem.
 #
 # Issue: https://github.com/rails/rails/issues/1526
 #
@@ -51,7 +53,6 @@ class String
   # in the string. It raises a NameError when the name is not in CamelCase
   # or is not initialized.
   #
-  # Examples
   #   "Module".constantize # => Module
   #   "Class".constantize  # => Class
   #
@@ -59,6 +60,18 @@ class String
     ActiveSupport::Inflector.constantize(self)
   end
 
+  ##
+  # The reverse of +camelize+. Makes an underscored, lowercase form from the expression in the string.
+  #
+  # +underscore+ will also change '::' to '/' to convert namespaces to paths.
+  #
+  #   "ActiveRecord".underscore         # => "active_record"
+  #   "ActiveRecord::Errors".underscore # => active_record/errors
+  #
+  def underscore
+    ActiveSupport::Inflector.underscore(self)
+  end
+
   ##
   # By default, +camelize+ converts strings to UpperCamelCase. If the argument to camelize
   # is set to <tt>:lower</tt> then camelize produces lowerCamelCase.
@@ -78,18 +91,6 @@ class String
   end
   alias_method :camelcase, :camelize
 
-  ##
-  # The reverse of +camelize+. Makes an underscored, lowercase form from the expression in the string.
-  #
-  # +underscore+ will also change '::' to '/' to convert namespaces to paths.
-  #
-  #   "ActiveRecord".underscore         # => "active_record"
-  #   "ActiveRecord::Errors".underscore # => active_record/errors
-  #
-  def underscore
-    ActiveSupport::Inflector.underscore(self)
-  end
-
   ##
   # Create a class name from a plural table name like Rails does for table names to models.
   # Note that this returns a string and not a class. (To convert to an actual class
@@ -148,11 +149,44 @@ module FileSet
 end
 
 ##
-# YAML Engine Parsing Fix
-# https://github.com/padrino/padrino-framework/issues/424
+# Removes indentation
+# Add colors
+#
+# @example
+#   help <<-EOS.undent
+#     Here my help usage
+#      sample_code
+#
+#     Fix
+#   EOS
+#   puts help.red.bold
 #
-require 'yaml' unless defined?(YAML)
-YAML::ENGINE.yamler = "syck" if defined?(YAML::ENGINE)
+class String
+  def self.colors
+    @_colors ||= {
+      :clear   => 0,
+      :bold    => 1,
+      :black   => 30,
+      :red     => 31,
+      :green   => 32,
+      :yellow  => 33,
+      :blue    => 34,
+      :magenta => 35,
+      :cyan    => 36,
+      :white   => 37
+    }
+  end
+
+  colors.each do |color, value|
+    define_method(color) do
+      ["\e[", value.to_s, "m", self, "\e[", self.class.colors[:clear], "m"] * ''
+    end
+  end
+
+  def undent
+    gsub(/^.{#{slice(/^ +/).size}}/, '')
+  end
+end
 
 ##
 # Loads our locale configuration files
@@ -160,6 +194,6 @@ YAML::ENGINE.yamler = "syck" if defined?(YAML::ENGINE)
 I18n.load_path += Dir["#{File.dirname(__FILE__)}/locale/*.yml"] if defined?(I18n)
 
 ##
-# Used to know if this file has already been required
+# Used to determine if this file has already been required
 #
 module SupportLite; end

data/lib/padrino-core/tasks.rb

@@ -1,12 +1,10 @@
 module Padrino
-
   ##
   # This module it's used for bootstrap with padrino rake
   # thirdy party tasks, in your gem/plugin/extension you
   # need only do this:
   #
-  # ==== Examples
-  #
+  # @example
   #   Padrino::Tasks.files << yourtask.rb
   #   Padrino::Tasks.files.concat(Dir["/path/to/all/my/tasks/*.rb"])
   #   Padrino::Tasks.files.unshift("yourtask.rb")

data/lib/padrino-core/version.rb

@@ -1,13 +1,17 @@
-##
+#
 # Manages current Padrino version for use in gem generation.
 #
 # We put this in a separate file so you can get padrino version
 # without include full padrino core.
 #
 module Padrino
-  VERSION = '0.10.2' unless defined?(Padrino::VERSION)
-  ##
-  # Return the current Padrino version
+  VERSION = '0.10.3' unless defined?(Padrino::VERSION)
+
+  #
+  # The current Padrino version.
+  #
+  # @return [String]
+  #   The version number.
   #
   def self.version
     VERSION

data/lib/padrino-core.rb

@@ -16,8 +16,13 @@ module Padrino
     ##
     # Helper method for file references.
     #
-    # ==== Examples
+    # @param [Array<String>] args
+    #   The directories to join to {PADRINO_ROOT}.
     #
+    # @return [String]
+    #   The absolute path.
+    #
+    # @example
     #   # Referencing a file in config called settings.yml
     #   Padrino.root("config", "settings.yml")
     #   # returns PADRINO_ROOT + "/config/setting.yml"
@@ -27,21 +32,30 @@ module Padrino
     end
 
     ##
-    # Helper method that return PADRINO_ENV
+    # Helper method that return {PADRINO_ENV}.
+    #
+    # @return [Symbol]
+    #   The Padrino Environment.
     #
     def env
       @_env ||= PADRINO_ENV.to_s.downcase.to_sym
     end
 
     ##
-    # Returns the resulting rack builder mapping each 'mounted' application
+    # The resulting rack builder mapping each 'mounted' application.
+    #
+    # @return [Padrino::Router]
+    #   The router for the application.
+    #
+    # @raise [ApplicationLoadError]
+    #   No applications were mounted.
     #
     def application
       raise ApplicationLoadError, "At least one app must be mounted!" unless Padrino.mounted_apps && Padrino.mounted_apps.any?
       router = Padrino::Router.new
       Padrino.mounted_apps.each { |app| app.map_onto(router) }
 
-      unless middleware.empty?
+      if middleware.present?
         builder = Rack::Builder.new
         middleware.each { |c,a,b| builder.use(c, *a, &b) }
         builder.run(router)
@@ -55,6 +69,10 @@ module Padrino
     # Configure Global Project Settings for mounted apps. These can be overloaded
     # in each individual app's own personal configuration. This can be used like:
     #
+    # @yield []
+    #   The given block will be called to configure each application.
+    #
+    # @example
     #   Padrino.configure_apps do
     #     enable  :sessions
     #     disable :raise_errors
@@ -64,16 +82,24 @@ module Padrino
       @_global_configuration = block if block_given?
     end
 
-    ###
-    # Returns project-wide configuration settings
-    # defined in 'configure_apps' block
+    ##
+    # Returns project-wide configuration settings defined in
+    # {configure_apps} block.
     #
     def apps_configuration
       @_global_configuration
     end
 
     ##
-    # Default encoding to UTF8.
+    # Set +Encoding.default_internal+ and +Encoding.default_external+
+    # to +Encoding::UFT_8+.
+    #
+    # Please note that in +1.9.2+ with some template engines like +haml+
+    # you should turn off Encoding.default_internal to prevent problems.
+    #
+    # @see https://github.com/rtomayko/tilt/issues/75
+    #
+    # @return [NilClass]
     #
     def set_encoding
       if RUBY_VERSION < '1.9'
@@ -86,9 +112,15 @@ module Padrino
     end
 
     ##
-    # Return bundle status :+:locked+ if .bundle/environment.rb exist :+:unlocked if Gemfile exist
+    # Determines whether the dependencies are locked by Bundler.
     # otherwise return nil
     #
+    # @return [:locked, :unlocked, nil]
+    #   Returns +:locked+ if the +Gemfile.lock+ file exists, or +:unlocked+
+    #   if only the +Gemfile+ exists.
+    #
+    # @deprecated Will be removed in 1.0.0
+    #
     def bundle
       return :locked   if File.exist?(root('Gemfile.lock'))
       return :unlocked if File.exist?(root("Gemfile"))
@@ -96,14 +128,20 @@ module Padrino
 
     ##
     # A Rack::Builder object that allows to add middlewares in front of all
-    # Padrino applications
+    # Padrino applications.
+    #
+    # @return [Array<Array<Class, Array, Proc>>]
+    #   The middleware classes.
     #
     def middleware
       @middleware ||= []
     end
 
     ##
-    # Clears all previously configured middlewares
+    # Clears all previously configured middlewares.
+    #
+    # @return [Array]
+    #   An empty array
     #
     def clear_middleware!
       @middleware = []
@@ -112,6 +150,15 @@ module Padrino
     ##
     # Convenience method for adding a Middleware to the whole padrino app.
     #
+    # @param [Class] m
+    #   The middleware class.
+    #
+    # @param [Array] args
+    #   The arguments for the middleware.
+    #
+    # @yield []
+    #   The given block will be passed to the initialized middleware.
+    #
     def use(m, *args, &block)
       middleware << [m, args, block]
     end

data/padrino-core.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.post_install_message << "\n\e[32m" + ("*" * 20) + "\n\e[0m"
 
   s.add_dependency("tilt", "~> 1.3.0")
-  s.add_dependency("sinatra", "~> 1.2.6")
+  s.add_dependency("sinatra", "~> 1.3.0")
   s.add_dependency("http_router", "~> 0.10.2")
   s.add_dependency("thor", "~> 0.14.3")
   s.add_dependency("activesupport", "~> 3.1.0")

data/test/fixtures/apps/simple.rb

@@ -14,7 +14,7 @@ end
 
 SimpleDemo.controllers do
   get "/" do
-    'The magick number is: 724274705032786548110472817755585178605481536388041566742570203174924198689!' # Change only the number!!!
+    'The magick number is: 2767356926488785838763860464013972991031534522105386787489885890443740254365!' # Change only the number!!!
   end
 
   get "/rand" do

data/test/helper.rb

@@ -2,42 +2,22 @@ ENV['PADRINO_ENV'] = 'test'
 PADRINO_ROOT = File.dirname(__FILE__) unless defined?(PADRINO_ROOT)
 
 require File.expand_path('../../../load_paths', __FILE__)
+require File.expand_path('../mini_shoulda', __FILE__)
 require 'padrino-core'
 require 'json'
-require 'test/unit'
 require 'rack/test'
 require 'rack'
-require 'shoulda'
 
 # Rubies < 1.9 don't handle hashes in the properly order so to prevent
 # this issue for now we remove extra values from mimetypes.
 Rack::Mime::MIME_TYPES.delete(".xsl") # In this way application/xml respond only to .xml
 
-module Kernel
-  # Silences the output by redirecting to stringIO
-  # silence_logger { ...commands... } => "...output..."
-  def silence_logger(&block)
-    $stdout = log_buffer = StringIO.new
-    block.call
-    $stdout = STDOUT
-    log_buffer.string
-  end
-  alias :silence_stdout :silence_logger
-
-  def silence_warnings
-    old_verbose, $VERBOSE = $VERBOSE, nil
-    yield
-  ensure
-    $VERBOSE = old_verbose
-  end
-end
-
-class Class
+class Sinatra::Base
   # Allow assertions in request context
-  include Test::Unit::Assertions
+  include MiniTest::Assertions
 end
 
-class Test::Unit::TestCase
+class MiniTest::Spec
   include Rack::Test::Methods
 
   # Sets up a Sinatra::Base subclass defined with the block

data/test/mini_shoulda.rb

@@ -0,0 +1,45 @@
+gem 'minitest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha' # Load mocha after minitest
+
+begin
+  require 'ruby-debug'
+rescue LoadError; end
+
+class MiniTest::Spec
+  class << self
+    alias :setup :before unless defined?(Rails)
+    alias :teardown :after unless defined?(Rails)
+    alias :should :it
+    alias :context :describe
+    def should_eventually(desc)
+      it("should eventually #{desc}") { skip("Should eventually #{desc}") }
+    end
+  end
+  alias :assert_no_match  :refute_match
+  alias :assert_not_nil   :refute_nil
+  alias :assert_not_equal :refute_equal
+end
+
+class ColoredIO
+  def initialize(io)
+    @io = io
+  end
+
+  def print(o)
+    case o
+    when "." then @io.send(:print, o.green)
+    when "E" then @io.send(:print, o.red)
+    when "F" then @io.send(:print, o.yellow)
+    when "S" then @io.send(:print, o.magenta)
+    else @io.send(:print, o)
+    end
+  end
+
+  def puts(*o)
+    super
+  end
+end
+
+MiniTest::Unit.output = ColoredIO.new(MiniTest::Unit.output)

data/test/test_application.rb

@@ -1,9 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/helper')
 
+class PadrinoPristine < Padrino::Application; end
 class PadrinoTestApp < Padrino::Application; end
 class PadrinoTestApp2 < Padrino::Application; end
 
-class TestApplication < Test::Unit::TestCase
+describe "Application" do
   def setup
     Padrino.clear!
   end
@@ -15,27 +16,27 @@ class TestApplication < Test::Unit::TestCase
   context 'for application functionality' do
 
     should 'check default options' do
-      assert File.identical?(__FILE__, PadrinoTestApp.app_file)
-      assert_equal :padrino_test_app, PadrinoTestApp.app_name
-      assert_equal :test, PadrinoTestApp.environment
-      assert_equal Padrino.root("views"), PadrinoTestApp.views
-      assert PadrinoTestApp.raise_errors
-      assert !PadrinoTestApp.logging
-      assert !PadrinoTestApp.sessions
-      assert !PadrinoTestApp.dump_errors
-      assert !PadrinoTestApp.show_exceptions
-      assert PadrinoTestApp.raise_errors
+      assert File.identical?(__FILE__, PadrinoPristine.app_file)
+      assert_equal :padrino_pristine, PadrinoPristine.app_name
+      assert_equal :test, PadrinoPristine.environment
+      assert_equal Padrino.root("views"), PadrinoPristine.views
+      assert PadrinoPristine.raise_errors
+      assert !PadrinoPristine.logging
+      assert !PadrinoPristine.sessions
+      assert !PadrinoPristine.dump_errors
+      assert !PadrinoPristine.show_exceptions
+      assert PadrinoPristine.raise_errors
       assert !Padrino.configure_apps
     end
 
     should 'check padrino specific options' do
-      assert !PadrinoTestApp.instance_variable_get(:@_configured)
-      PadrinoTestApp.send(:setup_application!)
-      assert_equal :padrino_test_app, PadrinoTestApp.app_name
-      assert_equal 'StandardFormBuilder', PadrinoTestApp.default_builder
-      assert PadrinoTestApp.instance_variable_get(:@_configured)
-      assert !PadrinoTestApp.reload?
-      assert !PadrinoTestApp.flash
+      assert !PadrinoPristine.instance_variable_get(:@_configured)
+      PadrinoPristine.send(:setup_application!)
+      assert_equal :padrino_pristine, PadrinoPristine.app_name
+      assert_equal 'StandardFormBuilder', PadrinoPristine.default_builder
+      assert PadrinoPristine.instance_variable_get(:@_configured)
+      assert !PadrinoPristine.reload?
+      assert !PadrinoPristine.flash
     end
 
     should 'set global project settings' do

data/test/test_core.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/helper')
 
-class TestCore < Test::Unit::TestCase
+describe "Core" do
   def setup
     Padrino.clear!
   end
@@ -42,7 +42,7 @@ class TestCore < Test::Unit::TestCase
     end
 
     should 'raise application error if I instantiate a new padrino application without mounted apps' do
-      assert_raise(Padrino::ApplicationLoadError) { Padrino.application.new }
+      assert_raises(Padrino::ApplicationLoadError) { Padrino.application.new }
     end
 
     should "check before/after padrino load hooks" do

data/test/test_dependencies.rb

@@ -1,11 +1,11 @@
 require File.expand_path(File.dirname(__FILE__) + '/helper')
 
-class TestDependencies < Test::Unit::TestCase
+describe "Dependencies" do
   context 'when we require a dependency that have another dependency' do
 
     should 'raise an error without reloading it twice' do
-      silence_warnings do
-        assert_raise(RuntimeError) do
+      capture_io do
+        assert_raises(RuntimeError) do
           Padrino.require_dependencies(
             Padrino.root("fixtures/dependencies/a.rb"),
             Padrino.root("fixtures/dependencies/b.rb"),
@@ -18,7 +18,7 @@ class TestDependencies < Test::Unit::TestCase
     end
 
     should 'resolve dependency problems' do
-      silence_warnings do
+      capture_io do
         Padrino.require_dependencies(
           Padrino.root("fixtures/dependencies/a.rb"),
           Padrino.root("fixtures/dependencies/b.rb"),
@@ -30,7 +30,7 @@ class TestDependencies < Test::Unit::TestCase
     end
 
     should 'remove partially loaded constants' do
-      silence_warnings do
+      capture_io do
         Padrino.require_dependencies(
           Padrino.root("fixtures/dependencies/circular/e.rb"),
           Padrino.root("fixtures/dependencies/circular/f.rb"),

data/test/test_filters.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/helper')
 
-class TestFilters < Test::Unit::TestCase
+describe "Filters" do
   should "filters by accept header" do
     mock_app do
       get '/foo', :provides => [:xml, :js] do
@@ -269,6 +269,7 @@ class TestFilters < Test::Unit::TestCase
     mock_app do
       before(:index, '/foo') { test = 'before' }
       get :index do
+        ''
       end
     end
     get '/foo'

data/test/test_locale.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/helper')
 
-class TestLocales < Test::Unit::TestCase 
+describe "Locales" do
   Dir[File.expand_path("../../lib/padrino-core/locale/*.yml", __FILE__)].each do |file|
     base_original = YAML.load_file(file)
     name = File.basename(file, '.yml')