padrino-core 0.10.2 → 0.10.3

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

@@ -1,7 +1,8 @@
 module Padrino
   ##
-  # This module extend Sinatra::ShowExceptions adding Padrino as "Framework"
+  # This module extend Sinatra::ShowExceptions adding Padrino as "Framework".
   #
+  # @private
   class ShowExceptions < Sinatra::ShowExceptions
     private
       def frame_class(frame)

data/lib/padrino-core/application.rb

@@ -7,7 +7,17 @@ module Padrino
   # These subclassed applications can be easily mounted into other Padrino applications as well.
   #
   class Application < Sinatra::Base
-    register Padrino::Routing   # Support for advanced routing, controllers, url_for
+    # Support for advanced routing, controllers, url_for
+    register Padrino::Routing
+
+    ##
+    # Returns the logger for this application.
+    #
+    # @return [Padrino::Logger] Logger associated with this app.
+    #
+    def logger
+      Padrino.logger
+    end
 
     class << self
 
@@ -25,29 +35,15 @@ module Padrino
         super(base) # Loading the subclass inherited method
       end
 
-      ##
-      # Hooks into when a new instance of the application is created
-      # This is used because putting the configuration into inherited doesn't
-      # take into account overwritten app settings inside subclassed definitions
-      # Only performs the setup first time application is initialized.
-      #
-      def new(*args, &bk)
-        setup_application!
-        logging, logging_was = false, logging
-        show_exceptions, show_exceptions_was = false, show_exceptions
-        super(*args, &bk)
-      ensure
-        logging, show_exceptions = logging_was, show_exceptions_was
-      end
-
       ##
       # Reloads the application files from all defined load paths
       #
       # This method is used from our Padrino Reloader during development mode
       # in order to reload the source files.
       #
-      # ==== Examples
+      # @return [TrueClass]
       #
+      # @example
       #   MyApp.reload!
       #
       def reload!
@@ -56,31 +52,32 @@ module Padrino
         reset! # Reset sinatra app
         reset_router! # Reset all routes
         Padrino.require_dependencies(self.app_file, :force => true) # Reload the app file
-        register_initializers # Reload our middlewares
         require_dependencies # Reload dependencies
-        default_filters! # Reload filters
-        default_routes!  # Reload default routes
-        default_errors!  # Reload our errors
+        default_filters!     # Reload filters
+        default_routes!      # Reload default routes
+        default_errors!      # Reload our errors
         I18n.reload! if defined?(I18n) # Reload also our translations
+        true
       end
 
       ##
       # Resets application routes to only routes not defined by the user
       #
-      # ==== Examples
+      # @return [TrueClass]
       #
+      # @example
       #   MyApp.reset_routes!
       #
       def reset_routes!
         reset_router!
         default_routes!
+        true
       end
 
       ##
       # Returns the routes of our app.
       #
-      # ==== Examples
-      #
+      # @example
       #   MyApp.routes
       #
       def routes
@@ -91,11 +88,11 @@ module Padrino
       # Setup the application by registering initializers, load paths and logger
       # Invoked automatically when an application is first instantiated
       #
+      # @return [TrueClass]
+      #
       def setup_application!
         return if @_configured
-        self.register_initializers
         self.require_dependencies
-        self.disable :logging # We need do that as default because Sinatra use commonlogger.
         self.default_filters!
         self.default_routes!
         self.default_errors!
@@ -104,12 +101,15 @@ module Padrino
           I18n.reload!
         end
         @_configured = true
+        @_configured
       end
 
       ##
       # Run the Padrino app as a self-hosted server using
       # Thin, Mongrel or WEBrick (in that order)
       #
+      # @see Padrino::Server#start
+      #
       def run!(options={})
         return unless Padrino.load!
         Padrino.mount(self.to_s).to("/")
@@ -117,7 +117,8 @@ module Padrino
       end
 
       ##
-      # Returns the used $LOAD_PATHS from this application
+      # @return [Array]
+      #   directory that need to be added to +$LOAD_PATHS+ from this application
       #
       def load_paths
         @_load_paths ||= %w(models lib mailers controllers helpers).map { |path| File.join(self.root, path) }
@@ -127,7 +128,10 @@ module Padrino
       # Returns default list of path globs to load as dependencies
       # Appends custom dependency patterns to the be loaded for your Application
       #
-      # ==== Examples
+      # @return [Array]
+      #   list of path globs to load as dependencies
+      #
+      # @example
       #   MyApp.dependencies << "#{Padrino.root}/uploaders/**/*.rb"
       #   MyApp.dependencies << Padrino.root('other_app', 'controllers.rb')
       #
@@ -143,12 +147,13 @@ module Padrino
       #
       # By default we look for files:
       #
+      #   # List of default files that we are looking for:
       #   yourapp/models.rb
       #   yourapp/models/**/*.rb
       #   yourapp/lib.rb
       #   yourapp/lib/**/*.rb
       #
-      # ==== Examples
+      # @example Adding a custom perequisite
       #   MyApp.prerequisites << Padrino.root('my_app', 'custom_model.rb')
       #
       def prerequisites
@@ -167,14 +172,15 @@ module Padrino
           set :logging, Proc.new { development? }
           set :method_override, true
           set :sessions, false
-          set :public, Proc.new { Padrino.root('public', uri_root) }
+          set :public_folder, Proc.new { Padrino.root('public', uri_root) }
           set :views, Proc.new { File.join(root,   "views") }
           set :images_path, Proc.new { File.join(public, "images") }
+          set :protection, false
           # Padrino specific
           set :uri_root, "/"
           set :app_name, self.to_s.underscore.to_sym
           set :default_builder, 'StandardFormBuilder'
-          set :flash, defined?(Rack::Flash)
+          set :flash, defined?(Sinatra::Flash) || defined?(Rack::Flash)
           set :authentication, false
           # Padrino locale
           set :locale_path, Proc.new { Dir[File.join(self.root, "/locale/**/*.{rb,yml}")] }
@@ -222,16 +228,6 @@ module Padrino
           end
         end
 
-        ##
-        # Requires the Padrino middleware
-        #
-        def register_initializers
-          use Padrino::ShowExceptions         if show_exceptions?
-          use Padrino::Logger::Rack, uri_root if Padrino.logger && logging?
-          use Padrino::Reloader::Rack         if reload?
-          use Rack::Flash, :sweep => true     if flash?
-        end
-
         ##
         # Requires all files within the application load paths
         #
@@ -239,22 +235,36 @@ module Padrino
           Padrino.set_load_paths(*load_paths)
           Padrino.require_dependencies(dependencies, :force => true)
         end
-    end # self
 
-    # TODO Remove deprecated render inclusion in a few versions
-    # Detects if a user is incorrectly using 'render' and warns them about the fix
-    # In 0.10.0, Padrino::Rendering now has to be explicitly included in the application
-    def render(*args)
-      if !defined?(DEFAULT_RENDERING_OPTIONS) && !@_render_included &&
-          (args.size == 1 || (args.size == 2 && args[0].is_a?(String) && args[1].is_a?(Hash)))
-        logger.warn "[Deprecation] Please 'register Padrino::Rendering' for each application as shown here:
-          https://gist.github.com/1d36a35794dbbd664ea4 for 'render' to function as expected"
-        self.class.instance_eval { register Padrino::Rendering }
-        @_render_included = true
-        render(*args)
-      else # pass through, rendering is valid
-        super(*args)
-      end
-    end # render method
+      private
+
+        # Overrides the default middleware for Sinatra based on Padrino conventions
+        # Also initializes the application after setting up the middleware
+        def setup_default_middleware(builder)
+          setup_sessions builder
+          setup_flash builder
+          builder.use Padrino::ShowExceptions         if show_exceptions?
+          builder.use Padrino::Logger::Rack, uri_root if Padrino.logger && logging?
+          builder.use Padrino::Reloader::Rack         if reload?
+          builder.use Rack::MethodOverride            if method_override?
+          builder.use Rack::Head
+          setup_protection builder
+          setup_application!
+        end
+
+         # TODO Remove this in a few versions (rack-flash deprecation)
+         # Move register Sinatra::Flash into setup_default_middleware
+         # Initializes flash using sinatra-flash or rack-flash
+        def setup_flash(builder)
+          register Sinatra::Flash if flash? && defined?(Sinatra::Flash)
+          if defined?(Rack::Flash) && !defined?(Sinatra::Flash)
+            logger.warn %Q{
+              [Deprecation] In Gemfile, 'rack-flash' should be replaced with 'sinatra-flash'!
+              Rack-Flash is not compatible with later versions of Rack and should be replaced.
+            }
+            builder.use Rack::Flash, :sweep => true     if flash?
+          end
+        end
+    end # self
   end # Application
 end # Padrino

data/lib/padrino-core/caller.rb

@@ -20,22 +20,28 @@ module Padrino
   ] unless defined?(PADRINO_IGNORE_CALLERS)
 
   ##
-  # Add rubinius (and hopefully other VM impls) ignore patterns ...
+  # Add rubinius (and hopefully other VM implementations) ignore patterns ...
   #
   PADRINO_IGNORE_CALLERS.concat(RUBY_IGNORE_CALLERS) if defined?(RUBY_IGNORE_CALLERS)
 
   private
     ##
-    # Returns the filename for the file that is the direct caller (first caller)
+    # The filename for the file that is the direct caller (first caller).
+    #
+    # @return [String]
+    #   The file the caller method exists in.
     #
     def self.first_caller
       caller_files.first
     end
 
-    ##
-    # Like Kernel#caller but excluding certain magic entries and without
+    #
+    # Like +Kernel#caller+ but excluding certain magic entries and without
     # line / method information; the resulting array contains filenames only.
     #
+    # @return [Array<String>]
+    #   The files of the calling methods.
+    #
     def self.caller_files
       caller(1).
         map    { |line| line.split(/:(?=\d|in )/)[0,2] }.

data/lib/padrino-core/command.rb

@@ -5,6 +5,14 @@ module Padrino
   # This method return the correct location of padrino bin or
   # exec it using Kernel#system with the given args
   #
+  # @param [Array] args
+  #   command or commands to execute
+  #
+  # @return [Boolean]
+  #
+  # @example
+  #   Padrino.bin('start', '-e production')
+  #
   def self.bin(*args)
     @_padrino_bin ||= [self.ruby_command, File.expand_path("../../../bin/padrino", __FILE__)]
     args.empty? ? @_padrino_bin : system(args.unshift(@_padrino_bin).join(" "))
@@ -14,6 +22,9 @@ module Padrino
   # Return the path to the ruby interpreter taking into account multiple
   # installations and windows extensions.
   #
+  # @return [String]
+  #   path to ruby bin executable
+  #
   def self.ruby_command
     @ruby_command ||= begin
       ruby = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])

data/lib/padrino-core/loader.rb

@@ -1,16 +1,19 @@
 module Padrino
   class << self
-
     ##
-    # Hooks to be called before a load/reload
+    # Hooks to be called before a load/reload.
+    #
+    # @yield []
+    #   The given block will be called before Padrino was loaded/reloaded.
     #
-    # ==== Examples
+    # @return [Array<Proc>]
+    #   The load/reload before hooks.
     #
+    # @example
     #   before_load do
     #     pre_initialize_something
     #   end
     #
-    #
     def before_load(&block)
       @_before_load ||= []
       @_before_load << block if block_given?
@@ -18,15 +21,19 @@ module Padrino
     end
 
     ##
-    # Hooks to be called after a load/reload
+    # Hooks to be called after a load/reload.
     #
-    # ==== Examples
+    # @yield []
+    #   The given block will be called after Padrino was loaded/reloaded.
     #
+    # @return [Array<Proc>]
+    #   The load/reload hooks.
+    #
+    # @example
     #   after_load do
     #     DataMapper.finalize
     #   end
     #
-    #
     def after_load(&block)
       @_after_load ||= []
       @_after_load << block if block_given?
@@ -34,7 +41,10 @@ module Padrino
     end
 
     ##
-    # Returns the used $LOAD_PATHS from padrino
+    # The used +$LOAD_PATHS+ from Padrino.
+    #
+    # @return [Array<String>]
+    #   The load paths used by Padrino.
     #
     def load_paths
       @_load_paths_was = %w(lib models shared).map { |path| Padrino.root(path) }
@@ -42,7 +52,11 @@ module Padrino
     end
 
     ##
-    # Requires necessary dependencies as well as application files from root lib and models
+    # Requires necessary dependencies as well as application files from root
+    # lib and models.
+    #
+    # @return [Boolean]
+    #   returns true if Padrino is not already bootstraped otherwise else.
     #
     def load!
       return false if loaded?
@@ -60,7 +74,9 @@ module Padrino
     end
 
     ##
-    # Clear the padrino env
+    # Clear the padrino env.
+    #
+    # @return [NilClass]
     #
     def clear!
       Padrino.clear_middleware!
@@ -75,7 +91,7 @@ module Padrino
     end
 
     ##
-    # Method for reloading required applications and their files
+    # Method for reloading required applications and their files.
     #
     def reload!
       Padrino.before_load.each(&:call) # Run before hooks
@@ -84,14 +100,18 @@ module Padrino
     end
 
     ##
-    # This adds the ablity to instantiate Padrino.load! after Padrino::Application definition.
+    # This adds the ablity to instantiate {Padrino.load!} after
+    # {Padrino::Application} definition.
     #
     def called_from
       @_called_from || first_caller
     end
 
     ##
-    # Return true if Padrino was loaded with Padrino.load!
+    # Determines whether Padrino was loaded with {Padrino.load!}.
+    #
+    # @return [Boolean]
+    #   Specifies whether Padrino was loaded.
     #
     def loaded?
       Thread.current[:padrino_loaded]
@@ -102,21 +122,23 @@ module Padrino
     # If you use this method we can perform correctly a Padrino.reload!
     # Another good thing that this method are dependency check, for example:
     #
-    #   models
-    #    \-- a.rb => require something of b.rb
-    #    \-- b.rb
+    #   # models
+    #   #  \-- a.rb => require something of b.rb
+    #   #  \-- b.rb
     #
     # In the example above if we do:
     #
     #   Dir["/models/*.rb"].each { |r| require r }
     #
-    # we get an error, because we try to require first a.rb that need +something+ of b.rb.
+    # we get an error, because we try to require first +a.rb+ that need
+    # _something_ of +b.rb+.
     #
-    # With +require_dependencies+ we don't have this problem.
+    # With this method we don't have this problem.
     #
-    # ==== Examples
+    # @param [Array<String>] paths
+    #   The paths to require.
     #
-    #   # For require all our app libs we need to do:
+    # @example For require all our app libs we need to do:
     #   require_dependencies("#{Padrino.root}/lib/**/*.rb")
     #
     def require_dependencies(*paths)
@@ -158,10 +180,13 @@ module Padrino
 
     ##
     # Returns default list of path globs to load as dependencies
-    # Appends custom dependency patterns to the be loaded for Padrino
+    # Appends custom dependency patterns to the be loaded for Padrino.
     #
-    # ==== Examples
-    #    Padrino.dependency_paths << "#{Padrino.root}/uploaders/*.rb"
+    # @return [Array<String>]
+    #   The dependencey paths.
+    #
+    # @example
+    #   Padrino.dependency_paths << "#{Padrino.root}/uploaders/*.rb"
     #
     def dependency_paths
       @_dependency_paths_was = [
@@ -172,7 +197,10 @@ module Padrino
     end
 
     ##
-    # Concat to $LOAD_PATH the given paths
+    # Concat to +$LOAD_PATH+ the given paths.
+    #
+    # @param [Array<String>] paths
+    #   The paths to concat.
     #
     def set_load_paths(*paths)
       $:.concat(paths); load_paths.concat(paths)

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

@@ -13,7 +13,10 @@ cs:
     abbr_day_names: [Ne, Po, Út, St, Čt, Pá, So]
     month_names: [~, Leden, Únor, Březen, Duben, Květen, Červen, Červenec, Srpen, Září, Říjen, Listopad, Prosinec]
     abbr_month_names: [~, Led, Úno, Bře, Dub, Kvě, Čvn, Čvc, Srp, Zář, Říj, Lis, Pro]
-    order: [:day, :month, :year]
+    order:
+      - day
+      - month
+      - year
 
   time:
     formats:

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

@@ -13,7 +13,10 @@ da:
     abbr_day_names: [sø, ma, ti, 'on', to, fr, lø]
     month_names: [~, januar, februar, marts, april, maj, juni, juli, august, september, oktober, november, december]
     abbr_month_names: [~, jan, feb, mar, apr, maj, jun, jul, aug, sep, okt, nov, dec]
-    order: [ :day, :month, :year ]
+    order:
+      - day
+      - month
+      - year
 
   time:
     formats:

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

@@ -13,7 +13,10 @@ de:
     abbr_day_names: [So, Mo, Di, Mi, Do, Fr, Sa]
     month_names: [~, Januar, Februar, März, April, Mai, Juni, Juli, August, September, Oktober, November, Dezember]
     abbr_month_names: [~, Jan, Feb, Mär, Apr, Mai, Jun, Jul, Aug, Sep, Okt, Nov, Dez]
-    order: [ :day, :month, :year ]
+    order:
+      - day
+      - month
+      - year
 
   time:
     formats:

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

@@ -13,7 +13,10 @@ en:
     abbr_day_names: [Sun, Mon, Tue, Wed, Thu, Fri, Sat]
     month_names: [~, January, February, March, April, May, June, July, August, September, October, November, December]
     abbr_month_names: [~, Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec]
-    order: [ :year, :month, :day ]
+    order:
+      - year
+      - month
+      - day
 
   time:
     formats:

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

@@ -13,7 +13,10 @@ es:
     abbr_day_names: [Dom, Lun, Mar, Mie, Jue, Vie, Sab]
     month_names: [~, Enero, Febrero, Marzo, Abril, Mayo, Junio, Julio, Agosto, Septiembre, Octubre, Noviembre, Diciembre]
     abbr_month_names: [~, Ene, Feb, Mar, Abr, May, Jun, Jul, Ago, Sep, Oct, Nov, Dic]
-    order: [ :day, :month, :year]
+    order: 
+      - day
+      - month
+      - year
 
   time:
     formats:

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

@@ -13,7 +13,10 @@ fr:
     abbr_day_names: [Lun, Mar, Mer, Jeu, Ven, Sam, Dim]
     month_names: [~, Janvier, Février, Mars, Avril, Mai, Juin, Juillet, Août, Septembre, Octobre, Novembre, Décembre]
     abbr_month_names: [~, Jan, Fev, Mar, Avr, Mai, Jui, Jui, Aou, Sep, Oct, Nov, Dec]
-    order: [ :day, :month, :year ]
+    order: 
+      - day
+      - month
+      - year
 
   time:
     formats:

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

@@ -13,7 +13,10 @@ hu:
     abbr_day_names: [vas, hét, kedd, sze, csüt, pén, szo]
     month_names: [~, január, február, március, április, május, június, július, augusztus, szeptember, oktober, november, december]
     abbr_month_names: [~, jan, febr, márc, ápr, máj, jún, júl, aug, szept, okt, nov, dec]
-    order: [ :year, :month, :day ]
+    order: 
+      - year
+      - month
+      - day
 
   time:
     formats:

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

@@ -13,7 +13,10 @@ it:
     abbr_day_names: [Dom, Lun, Mar, Mer, Gio, Ven, Sab]
     month_names: [~, Gennaio, Febbraio, Marzo, Aprile, Maggio, Giugno, Luglio, Agosto, Settembre, Ottobre, Novembre, Dicembre]
     abbr_month_names: [~, Gen, Feb, Mar, Apr, Mag, Giu, Lug, Ago, Set, Ott, Nov, Dic]
-    order: [ :day, :month, :year ]
+    order: 
+      - day
+      - month
+      - year
 
   time:
     formats:

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

@@ -13,7 +13,10 @@ ja:
     abbr_day_names: [日, 月, 火, 水, 木, 金, 土]
     month_names: [~, 一月, 二月, 三月, 四月, 五月, 六月, 七月, 八月, 九月, 十月, 十一月, 十二月]
     abbr_month_names: [~, 一月, 二月, 三月, 四月, 五月, 六月, 七月, 八月, 九月, 十月, 十一月, 十二月]
-    order: [ :year, :month, :day ]
+    order: 
+      - year
+      - month
+      - day
 
   time:
     formats:

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

@@ -0,0 +1,34 @@
+lv:
+  date:
+    formats:
+      # Use the strftime parameters for formats.
+      # When no format has been given, it uses default.
+      # You can provide other formats here if you like!
+      default: "%d.%m.%Y."
+      short: "%e. %B"
+      long: "%Y. gada %e. %B"
+      only_day: "%e"
+
+    day_names: [Svētdiena, Pirmdiena, Otrdiena, Trešdiena, Ceturtdiena, Piektdiena, Sestdiena]
+    abbr_day_names: [Sv, P, O, T, C, P, S]
+    month_names: [~, Janvāris, Februāris, Marts, Aprīlis, Maijs, Jūnijs, Jūlijs, Augusts, Septembris, Oktobris, Novembris, Decembris]
+    abbr_month_names: [~, Janv, Febr, Marts, Apr, Maijs, Jūn, Jūl, Aug, Sept, Okt, Nov, Dec]
+    order:
+      - day
+      - month
+      - year
+
+  time:
+    formats:
+      default: "%Y. gada %e. %B, %H:%M"
+      short: "%d.%m.%Y., %H:%M"
+      long: "%Y. gada %e. %B, %H:%M:%S"
+    am: "priekšpusdiena"
+    pm: "pēcpusdiena"
+
+# Used in array.to_sentence.
+  support:
+    array:
+      words_connector: ", "
+      two_words_connector: " un "
+      last_word_connector: ", un "

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

@@ -13,7 +13,10 @@ nl:
     abbr_day_names: [zo, ma, di, wo, do, vr, za]
     month_names: [~, januari, februari, maart, april, mei, juni, juli, augustus, september, oktober, november]
     abbr_month_names: [~, jan, feb, maa, apr, mei, jun, jul, aug, sep, okt, nov, dec]
-    order: [ :day, :month, :year ]
+    order:
+      - day
+      - month
+      - year
 
   time:
     formats:

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

@@ -13,7 +13,10 @@
     abbr_day_names: [sø, ma, ti, 'on', to, fr, lø]
     month_names: [~, januar, februar, mars, april, mai, juni, juli, august, september, oktober, november, desember]
     abbr_month_names: [~, jan, feb, mar, apr, maj, jun, jul, aug, sep, okt, nov, des]
-    order: [ :day, :month, :year ]
+    order:
+      - day
+      - month
+      - year
 
   time:
     formats:

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

@@ -13,7 +13,10 @@ pl:
     abbr_day_names: [nie, pon, wto, śro, czw, pia, sob]
     month_names: [~, Styczeń, Luty, Marzec, Kwiecień, Maj, Czerwiec, Lipiec, Sierpień, Wrzesień, Październik, Listopad, Grudzień]
     abbr_month_names: [~, sty, lut, mar, kwi, maj, cze, lip, sie, wrz, paź, lis, gru]
-    order: [ :year, :month, :day ]
+    order:
+      - year
+      - month
+      - day
 
   time:
     formats: