hanami 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4e1d0e19757f037bb968b5c6acf17695db9b4e5
-  data.tar.gz: 5302957753149246d98fbc7a57a1c12ccd71cfad
+  metadata.gz: 35905305b2c9f5a20e639bf4de5ffc10c439732f
+  data.tar.gz: 86d99d157ea672bdddf8ecc338fe16abf833a099
 SHA512:
-  metadata.gz: 2710c2f33d3ae3babd5f8b7414b30c05af685608f045c0d8e00af2cbf953e1991433a5e687d360bbacf26832ceddf2835898aac1776476167bfff92c97d2a344
-  data.tar.gz: 15076a475ce82f35d55310d642207f3016c17b6ad856dab20dc99fa10f2ffee0356c140a73e805615a44667a7372fabbd4f3d939b1ae970a092320204840b5f7
+  metadata.gz: 55642dce6b8a8548a92592f843573488f9da21c6d099ab27f29b667c9249a5c0f7ed4ff584447b7ddd10cdedbbc3a92da34e349c6107979bcd80fa6eded53e76
+  data.tar.gz: c6ef7285048eb156ebf594bf632d51ac3b1149f49c1ec8869eebce0feb215b87c5cfb7145b005004ba290766a1e2a8e28c7e37eb5dd279b8fcb4ef063f1bc822

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Hanami
 The web, with simplicity.
 
+## v1.0.0.beta3 - 2017-03-17
+### Fixed
+- [Luca Guidi] Try to disconnect from database at the boot time. This is useful to prune stale connection during production deploys.
+- [Tobias Sandelius] Don't mount `Hanami::CommonLogger` middleware if logging is disabled for the project.
+- [Anton Davydov] Don't configure mailers, if it's mailing is disabled for the project.
+- [Marcello Rocha] Ensure code reloading don't misconfigure mailer settings
+
+### Changed
+- [Luca Guidi] Removed deprecated `ApplicationConfiguration#default_format`. Use `#default_request_format` instead.
+
 ## v1.0.0.beta2 - 2017-03-02
 
 ## v1.0.0.beta1 - 2017-02-14

data/FEATURES.md

@@ -3,6 +3,8 @@
 
 ## Features
 
+## v1.0.0.beta3 - 2017-03-17
+
 ## v1.0.0.beta2 - 2017-03-02
 - Added: `Action#unsafe_send_file` to send files outside of the public directory
 

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2016 Luca Guidi
+Copyright © 2014-2017 Luca Guidi
 
 MIT License
 

data/README.md

@@ -129,4 +129,4 @@ Released under MIT License.
 
 This project was formerly known as Lotus (`lotusrb`).
 
-Copyright © 2014-2016 Luca Guidi.
+Copyright © 2014-2017 Luca Guidi.

data/hanami.gemspec

@@ -21,14 +21,14 @@ Gem::Specification.new do |spec|
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.add_dependency 'hanami-utils',       '~> 1.0.0.beta2'
-  spec.add_dependency 'hanami-validations', '~> 1.0.0.beta1'
-  spec.add_dependency 'hanami-router',      '~> 1.0.0.beta2'
-  spec.add_dependency 'hanami-controller',  '~> 1.0.0.beta2'
-  spec.add_dependency 'hanami-view',        '~> 1.0.0.beta1'
-  spec.add_dependency 'hanami-helpers',     '~> 1.0.0.beta1'
-  spec.add_dependency 'hanami-mailer',      '~> 1.0.0.beta1'
-  spec.add_dependency 'hanami-assets',      '~> 1.0.0.beta1'
+  spec.add_dependency 'hanami-utils',       '~> 1.0.0.beta3'
+  spec.add_dependency 'hanami-validations', '~> 1.0.0.beta2'
+  spec.add_dependency 'hanami-router',      '~> 1.0.0.beta3'
+  spec.add_dependency 'hanami-controller',  '~> 1.0.0.beta3'
+  spec.add_dependency 'hanami-view',        '~> 1.0.0.beta2'
+  spec.add_dependency 'hanami-helpers',     '~> 1.0.0.beta2'
+  spec.add_dependency 'hanami-mailer',      '~> 1.0.0.beta2'
+  spec.add_dependency 'hanami-assets',      '~> 1.0.0.beta2'
   spec.add_dependency 'concurrent-ruby',    '~> 1.0'
   spec.add_dependency 'thor',               '~> 0.19'
   spec.add_dependency 'bundler',            '~> 1.13'

data/lib/hanami.rb

@@ -82,13 +82,9 @@ module Hanami
   # NOTE: In case this is invoked many times, it guarantees that the boot
   #   process happens only once.
   #
-  # NOTE: There is no reason to cache the result with `@_booted`, because it
-  #   already caches it internally.
-  #
   # NOTE: This MUST NOT be wrapped by a Mutex, because it would cause a deadlock.
   #
   # @since 0.9.0
-  # @api private
   def self.boot
     Components.release if code_reloading?
     Components.resolve('all')
@@ -135,7 +131,6 @@ module Hanami
   # @return [Pathname] public directory
   #
   # @since 0.6.0
-  # @api private
   #
   # @example
   #   Hanami.public_directory # => #<Pathname:/Users/luca/Code/bookshelf/public>

data/lib/hanami/action/csrf_protection.rb

@@ -1,6 +1,7 @@
 require 'securerandom'
 
 module Hanami
+  # @api private
   module Action
     # Invalid CSRF Token
     #
@@ -154,6 +155,23 @@ module Hanami
       # Override and return <tt>false</tt> if you want to bypass security check.
       #
       # @since 0.4.0
+      #
+      # @example
+      #   module Web::Controllers::Books
+      #     class Create
+      #       include Web::Action
+      #
+      #       def call(params)
+      #         # ...
+      #       end
+      #
+      #       private
+      #
+      #       def verify_csrf_token?
+      #         false
+      #       end
+      #     end
+      #   end
       def verify_csrf_token?
         !IDEMPOTENT_HTTP_METHODS[request_method]
       end
@@ -167,6 +185,23 @@ module Hanami
       # @raise [Hanami::Action::InvalidCSRFTokenError]
       #
       # @since 0.4.0
+      #
+      # @example
+      #   module Web::Controllers::Books
+      #     class Create
+      #       include Web::Action
+      #
+      #       def call(params)
+      #         # ...
+      #       end
+      #
+      #       private
+      #
+      #       def handle_invalid_csrf_token
+      #         # custom invalid CSRF management goes here
+      #       end
+      #     end
+      #   end
       def handle_invalid_csrf_token
         session.clear
         raise InvalidCSRFTokenError.new

data/lib/hanami/app.rb

@@ -63,7 +63,7 @@ module Hanami
     # @since 0.9.0
     # @api private
     def middleware(environment)
-      builder.use Hanami::CommonLogger, Hanami.logger
+      builder.use Hanami::CommonLogger, Hanami.logger unless Hanami.logger.nil?
       builder.use Rack::ContentLength
 
       if middleware = environment.static_assets_middleware # rubocop:disable Lint/AssignmentInCondition

data/lib/hanami/application.rb

@@ -50,6 +50,7 @@ module Hanami
     # Class interface for Hanami applications
     #
     # @since 0.9.0
+    # @api private
     module ClassMethods
       # Override Ruby's Class#extended
       #
@@ -146,6 +147,7 @@ module Hanami
     # @return [Hanami::Application] a new instance of the application
     #
     # @since 0.1.0
+    # @api private
     def initialize
       @renderer   = RenderingPolicy.new(configuration)
       @middleware = configuration.middleware

data/lib/hanami/application_configuration.rb

@@ -1,5 +1,4 @@
 require 'hanami/utils/kernel'
-require 'hanami/utils/deprecation'
 require 'hanami/environment'
 require 'hanami/middleware'
 require 'hanami/config/cookies'
@@ -843,17 +842,6 @@ module Hanami
       end
     end
 
-    # Set a format as default fallback for all the requests without a strict
-    # requirement for the mime type.
-    #
-    # @since 0.1.0
-    #
-    # @deprecated Use {#default_request_format} instead.
-    def default_format(format = nil)
-      Hanami::Utils::Deprecation.new('default_format is deprecated, please use default_request_format')
-      default_request_format(format)
-    end
-
     # The URI scheme for this application.
     # This is used by the router helpers to generate absolute URLs.
     #
@@ -1502,6 +1490,7 @@ module Hanami
 
     private
 
+    # @api private
     attr_reader :configurations
 
     # @since 0.2.0

data/lib/hanami/application_name.rb

@@ -4,11 +4,13 @@ module Hanami
   # An application name.
   #
   # @since 0.2.1
+  # @api private
   class ApplicationName
 
     # A list of words that are prohibited from forming the application name
     #
     # @since 0.2.1
+    # @api private
     RESERVED_WORDS = %w(hanami).freeze
 
     # Initialize and check against reserved words
@@ -29,6 +31,7 @@ module Hanami
     # @return [Hanami::ApplicationName] a new instance of the application name
     #
     # @since 0.2.1
+    # @api private
     def initialize(name)
       @name = sanitize(name.to_s)
       ensure_validity!
@@ -42,6 +45,7 @@ module Hanami
     #   ApplicationName.new("my-App ").to_s # => "my_app"
     #
     # @since 0.2.1
+    # @api private
     def to_s
       @name
     end
@@ -59,6 +63,7 @@ module Hanami
     #   ApplicationName.new("my-app").to_env_s => "MY_APP"
     #
     # @since 0.2.1
+    # @api private
     def to_env_s
       @name.upcase.gsub(/\W/, '_')
     end
@@ -73,6 +78,7 @@ module Hanami
     #   Hanami::ApplicationName.invalid?("hanami") # => true
     #
     # @since 0.2.1
+    # @api private
     def self.invalid?(name)
       RESERVED_WORDS.include?(name)
     end
@@ -81,8 +87,8 @@ module Hanami
 
     # Raises RuntimeError with explanation if the provided name is invalid.
     #
-    # @api private
     # @since 0.2.1
+    # @api private
     def ensure_validity!
       if self.class.invalid?(@name)
         raise RuntimeError,
@@ -93,8 +99,8 @@ module Hanami
 
     # Cleans a string to be a functioning application name.
     #
-    # @api private
     # @since 0.2.1
+    # @api private
     def sanitize(name)
       Utils::String.new(
         name.strip

data/lib/hanami/application_namespace.rb

@@ -2,7 +2,9 @@ require 'hanami/utils/class'
 require 'hanami/utils/string'
 
 module Hanami
+  # @api private
   class ApplicationNamespace
+    # @api private
     def self.resolve(name)
       Utils::Class.load!(
         Utils::String.new(name).namespace

data/lib/hanami/assets/asset.rb

@@ -1,6 +1,7 @@
 require 'hanami/utils/file_list'
 
 module Hanami
+  # @api private
   module Assets
     # Requested asset
     #

data/lib/hanami/cli.rb

@@ -5,6 +5,7 @@ require 'hanami/commands/new/app'
 require 'hanami/commands/new/container'
 
 module Hanami
+  # @api private
   class Cli < Thor
     # include Thor::Actions
     extend CliBase
@@ -13,6 +14,7 @@ module Hanami
     long_desc <<-EOS
     `hanami version` prints the version of the bundled hanami gem.
     EOS
+    # @api private
     def version
       require 'hanami/version'
       puts "v#{ Hanami::VERSION }"
@@ -38,6 +40,7 @@ module Hanami
     method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
     method_option :code_reloading, desc: 'Code reloading', type: :boolean, default: true
     method_option :help, desc: 'Displays the usage message'
+    # @api private
     def server
       if options[:help]
         invoke :help, ['server']
@@ -58,6 +61,7 @@ module Hanami
     method_option :pid, desc: 'path to write a pid file after daemonize'
     method_option :environment, desc: 'path to environment configuration (config/environment.rb)'
     method_option :help, desc: 'displays the usage message'
+    # @api private
     def rackserver
       if options[:help]
         invoke :help, ['rackserver']
@@ -77,6 +81,7 @@ module Hanami
     method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
     method_option :engine, desc: "Choose a specific console engine: (#{Hanami::Commands::Console::ENGINES.keys.join('/')})"
     method_option :help, desc: 'Displays the usage method'
+    # @api private
     def console
       if options[:help]
         invoke :help, ['console']
@@ -104,6 +109,7 @@ $ > hanami new fancy_app --hanami-head=true
     method_option :test, desc: "Project test framework (#{Hanami::Generators::TestFramework::VALID_FRAMEWORKS.join('/')})", default: Hanami::Hanamirc::DEFAULT_TEST_SUITE
     method_option :hanami_head, desc: 'Use hanami HEAD (true/false)', type: :boolean, default: false
     method_option :help, desc: 'Displays the usage method'
+    # @api private
     def new(application_name=nil)
       if options[:help]
         invoke :help, ['new']
@@ -123,6 +129,7 @@ $ > hanami new fancy_app --hanami-head=true
     EOS
     method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
     method_option :help, desc: 'Displays the usage method'
+    # @api private
     def routes
       if options[:help]
         invoke :help, ['routes']

data/lib/hanami/cli_base.rb

@@ -1,4 +1,5 @@
 module Hanami
+  # @api private
   module CliBase
     # Add new custom CLI command to special CLI class.
     # Please be careful. This is a private method that
@@ -28,10 +29,12 @@ module Hanami
       class_eval(&blk) if block_given?
     end
 
+    # @api private
     def banner(command, nspace = true, subcommand = false)
       super(command, nspace, namespace != 'hanami:cli')
     end
 
+    # @api private
     def handle_argument_error(command, error, args, arity)
       name = [(namespace == 'hanami:cli' ? nil : namespace), command.name].compact.join(" ")
 

data/lib/hanami/cli_sub_commands/assets.rb

@@ -13,6 +13,8 @@ module Hanami
       namespace :assets
 
       desc 'precompile', 'Precompile assets for deployment'
+      # @since 0.6.0
+      # @api private
       def precompile
         require 'hanami/commands/assets/precompile'
         Hanami::Commands::Assets::Precompile.new(options).start

data/lib/hanami/cli_sub_commands/db.rb

@@ -1,4 +1,5 @@
 module Hanami
+  # @api private
   class CliSubCommands
     # A set of subcommands related to DB
     #
@@ -14,6 +15,8 @@ module Hanami
 
       desc 'console', 'Start DB console'
       method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
+      # @since 0.6.0
+      # @api private
       def console(name = nil)
         if options[:help]
           invoke :help, ['console']
@@ -25,6 +28,8 @@ module Hanami
 
       desc 'create', 'Create database for current environment'
       method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
+      # @since 0.6.0
+      # @api private
       def create
         if options[:help]
           invoke :help, ['create']
@@ -37,6 +42,8 @@ module Hanami
 
       desc 'drop', 'Drop database for current environment'
       method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
+      # @since 0.6.0
+      # @api private
       def drop
         if options[:help]
           invoke :help, ['drop']
@@ -49,6 +56,8 @@ module Hanami
 
       desc 'migrate', 'Migrate database for current environment'
       method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
+      # @since 0.6.0
+      # @api private
       def migrate(version = nil)
         if options[:help]
           invoke :help, ['migrate']
@@ -60,6 +69,8 @@ module Hanami
 
       desc 'apply', 'Migrate, dump schema, delete migrations (experimental)'
       method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
+      # @since 0.6.0
+      # @api private
       def apply
         if options[:help]
           invoke :help, ['apply']
@@ -72,6 +83,8 @@ module Hanami
 
       desc 'prepare', 'Create and migrate database'
       method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
+      # @since 0.6.0
+      # @api private
       def prepare
         if options[:help]
           invoke :help, ['prepare']
@@ -82,10 +95,10 @@ module Hanami
         end
       end
 
-      # @since 0.6.0
-      # @api private
       desc 'version', 'Current database version'
       method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
+      # @since 0.6.0
+      # @api private
       def version
         if options[:help]
           invoke :help, ['version']