hanami 1.3.3 → 2.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ec1be46fff34a0e6278e8c08a20742d87622bb24ef82b5320c7f71c9900bc6d
-  data.tar.gz: b88a1a45b04427a79a7c7d828353bca49df12de456815d35ff84c18ff09dcda0
+  metadata.gz: 1c197523a333228ef0596099b121a0f3a3e02c4a5a0da3f3f4fe837e794b7cf8
+  data.tar.gz: 5a7526ef47fc6f64ebffdae725d26a17944e390274dbc478ff52d593c7ba63b9
 SHA512:
-  metadata.gz: 97ff7cbc39b2dca8623431ff84024f854d504618742035242f3ee6ca84af419ba6126812e2e7316f4cb1025f1b5be1b0f383ea7c9acc4947a726c4012e301ec0
-  data.tar.gz: 53c4e2fe586a644adc84a32fa8f19ea41553796e0aeb33d40e0d60185a99bb225a6809b618693e0663569acd7bd040c402928629d8a54cdc63ee9e0a55bc5df2
+  metadata.gz: dd55bf77935140473affae77676eae8afe042f385dee3288dd9d80729fb887899f89950f26b83e2b793161545347cdc3dab8a5f6e0915013aa333c2caf2e080d
+  data.tar.gz: d254599b55640e0e3a27b718c1ae7141a40662c7291e60463d9620383cc419d49f06f5c8d1712b484f50ba758b71bf3f0ae79729452243532a0769e00478af8b

data/CHANGELOG.md

@@ -1,30 +1,54 @@
 # Hanami
 The web, with simplicity.
 
-## v1.3.3 - 2019-09-20
+## v2.0.0.alpha1 - 2019-01-30
 ### Added
-- [Gray Manley] Standardize file loading for `.env` files (see: https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use)
+- [Luca Guidi] Implemented from scratch `hanami version`
+- [Luca Guidi] Implemented from scratch `hanami server`
+- [Luca Guidi] Main configuration is opinionated: when a setting is not specified in generated code, it uses a framework default.
+- [Luca Guidi] Main configuration setting `environment`: to yield env based settings (e.g. `config.environment(:production) { |c| c.logger = {...} }`)
+- [Luca Guidi] Main configuration setting `base_url`: to set the base URL of the app (e.g. `config.base_url = "https://example.com"`)
+- [Luca Guidi] Main configuration setting `logger`: to set the logger options (e.g. `config.logger = { level: :info, format: :json }`)
+- [Luca Guidi] Main configuration setting `routes`: to set the path to routes file (e.g. `config.routes = "path/to/routes"`)
+- [Luca Guidi] Main configuration setting `cookies`: to set cookies options (e.g. `config.cookies = { max_age: 300 }`)
+- [Luca Guidi] Main configuration setting `sessions`: to set session options (e.g. `config.sessions = :cookie, { secret: "abc" }`)
+- [Luca Guidi] Main configuration setting `default_request_format`: to set the fallback for request format (aka MIME Type) (e.g. `config.default_request_format = :json`)
+- [Luca Guidi] Main configuration setting `default_response_format`: to set the default response format (aka MIME Type) (e.g. `config.default_response_format = :json`)
+- [Luca Guidi] Main configuration setting `middleware` to mount Rack middleware (e.g. `config.middleware.use MyMiddleware, "argument"`)
+- [Luca Guidi] Main configuration setting `security` to set security settings (see below)
+- [Luca Guidi] Main configuration setting `inflections` to configure inflections (e.g. `config.inflections { |i| i.plural "virus", "viruses" }`)
+- [Luca Guidi] Main configuration security setting `x_frame_options`: defaults to `"deny"` (e.g. `config.security.x_frame_options = "sameorigin"`)
+- [Luca Guidi] Main configuration security setting `x_content_type_options`: defaults to `"nosniff"` (e.g. `config.security.x_content_type_options = nil`)
+- [Luca Guidi] Main configuration security setting `x_xss_protection`: defaults to `"1; mode=block"` (e.g. `config.security.x_xss_protection = "1"`)
+- [Luca Guidi] Main configuration security setting `content_security_policy`: defaults to `"form-action 'self'; frame-ancestors 'self'; base-uri 'self'; default-src 'none'; script-src 'self'; connect-src 'self'; img-src 'self' https: data:; style-src 'self' 'unsafe-inline' https:; font-src 'self'; object-src 'none'; plugin-types application/pdf; child-src 'self'; frame-src 'self'; media-src 'self'"`
+  (e.g. `config.security.content_security_policy[:style_src] += " https://my.cdn.example"` to add another source)
+  (e.g. `config.security.content_security_policy[:plugin_types] = nil` to override the settings)
 
-### Fixed
-- [Alfonso Uceda & Luca Guidi] Ensure to use `:host` option when mounting an application in main router (e.g. `mount Beta::Application.new, at: "/", host: "beta.hanami.test"`)
-
-## v1.3.2 - 2019-07-26
-### Added
-- [Luca Guidi] Support both `hanami-validations` 1 and 2
-
-### Fixed
-- [Wisnu Adi Nurcahyo] Ensure `hanami generate` syntax for Welcome page is compatible with ZSH
-- [Luca Guidi] Don't let `hanami` to crash when called without `bundle exec`
-
-## v1.3.1 - 2019-01-18
-### Added
-- [Luca Guidi] Official support for Ruby: MRI 2.6
-- [Luca Guidi] Support `bundler` 2.0+
-
-### Fixed
-- [Aidan Coyle] Remove from app generator support for deprecated `force_ssl` setting
-- [Alessandro Caporrini] Remove from app generator support for deprecated `body_parsers` setting
-- [Daphne Rouw & Sean Collins] Make app generator to work when code in `config/enviroment.rb` uses double quotes
+### Changed
+- [Luca Guidi] Drop support for Ruby: MRI 2.3, and 2.4.
+- [Luca Guidi] `Hanami::Application` must be used as superclass for main application under `config/application.rb` (e.g. `Bookshelf::Application`)
+- [Luca Guidi] Main configuration is available at `config/application.rb` instead of `config/enviroment.rb`
+- [Luca Guidi] Removed `Hanami.configure` in favor of main application configuration (e.g. `Bookshelf::Application.config`)
+- [Luca Guidi] Removed DSL syntax for main configuration (from `cookies max_age: 600` to `config.cookies = { max_age: 600 }`)
+- [Luca Guidi] Per enviroment settings must be wrapped in a block (e.g. `config.enviroment(:production) { |c| c.logger = {} }`)
+- [Luca Guidi] Concrete applications are no longer supported (e.g. `Web::Application` in `apps/web/application.rb`)
+- [Luca Guidi] Main routes must be configured at `config/routes.rb`:
+```ruby
+# frozen_string_literal: true
+
+Hanami.application.routes do
+  mount :web, at: "/" do
+    root to: "home#index"
+  end
+
+  mount :admin, at: "/admin" do
+    root to: "home#index"
+  end
+end
+```
+- [Luca Guidi] Per application routes are no longer supported (e.g. `apps/web/config/routes.rb`)
+- [Luca Guidi] Removed `shotgun` and code reloading from the core. Code reloading is implemented by `hanami-reloader` gem.
+- [Luca Guidi] Removed support for `.hanamirc`
 
 ## v1.3.0 - 2018-10-24
 ### Added

data/FEATURES.md

@@ -3,13 +3,7 @@
 
 ## Features
 
-## v1.3.3 - 2019-09-20
-
-- Standardize file loading for `.env` files (see: https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use)
-
-## v1.3.2 - 2019-07-26
-
-## v1.3.1 - 2019-01-18
+## v2.0.0.alpha1 - 2019-01-30
 
 ## v1.3.0 - 2018-10-24
 

data/LICENSE.md

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

data/README.md

@@ -33,7 +33,7 @@ These components are designed to be used independently or together in a Hanami a
 
 ## Installation
 
-__Hanami__ supports Ruby (MRI) 2.3+
+__Hanami__ supports Ruby (MRI) 2.5+
 
 ```shell
 gem install hanami

data/bin/hanami

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
-require 'bundler'
-require 'hanami/cli/commands'
+# frozen_string_literal: true
 
-::Bundler.require(:plugins) if File.exist?(ENV["BUNDLE_GEMFILE"] || "Gemfile")
+require "bundler"
+require "hanami/cli/commands"
+
+Bundler.require(*Hanami.bundler_groups) if File.exist?(ENV["BUNDLE_GEMFILE"] || "Gemfile")
 Hanami::CLI.new(Hanami::CLI::Commands).call

data/hanami.gemspec

@@ -1,40 +1,36 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hanami/version'
+require "hanami/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'hanami'
+  spec.name          = "hanami"
   spec.version       = Hanami::VERSION
-  spec.authors       = ['Luca Guidi']
-  spec.email         = ['me@lucaguidi.com']
-  spec.summary       = 'The web, with simplicity'
-  spec.description   = 'Hanami is a web framework for Ruby'
-  spec.homepage      = 'http://hanamirb.org'
-  spec.license       = 'MIT'
+  spec.authors       = ["Luca Guidi"]
+  spec.email         = ["me@lucaguidi.com"]
+  spec.summary       = "The web, with simplicity"
+  spec.description   = "Hanami is a web framework for Ruby"
+  spec.homepage      = "http://hanamirb.org"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -c -o --exclude-standard -z -- lib/* bin/* LICENSE.md README.md CODE_OF_CONDUCT.md CHANGELOG.md FEATURES.md hanami.gemspec`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test)/})
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.5.0"
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  spec.add_dependency 'hanami-utils',       '~> 1.3'
-  spec.add_dependency 'hanami-validations', '>= 1.3', '< 3'
-  spec.add_dependency 'hanami-router',      '~> 1.3'
-  spec.add_dependency 'hanami-controller',  '~> 1.3'
-  spec.add_dependency 'hanami-view',        '~> 1.3'
-  spec.add_dependency 'hanami-helpers',     '~> 1.3'
-  spec.add_dependency 'hanami-mailer',      '~> 1.3'
-  spec.add_dependency 'hanami-assets',      '~> 1.3'
-  spec.add_dependency 'hanami-cli',         '~> 0.3'
-  spec.add_dependency 'concurrent-ruby',    '~> 1.0'
-  spec.add_dependency 'bundler',            '>= 1.6', '< 3'
+  spec.add_dependency "hanami-utils",      "~> 2.0.alpha"
+  spec.add_dependency "hanami-router",     "~> 2.0.alpha"
+  spec.add_dependency "hanami-controller", "~> 2.0.alpha"
+  spec.add_dependency "hanami-cli",        "~> 1.0.alpha"
+  spec.add_dependency "dry-system",        "~> 0.10"
+  spec.add_dependency "dry-inflector",     "~> 0.1", ">= 0.1.2"
+  spec.add_dependency "bundler",           ">= 1.16", "< 3"
 
-  spec.add_development_dependency 'rspec',     '~> 3.7'
-  spec.add_development_dependency 'rack-test', '~> 1.1'
-  spec.add_development_dependency 'aruba',     '~> 0.14'
-  spec.add_development_dependency 'rake',      '~> 12.0'
+  spec.add_development_dependency "rspec",     "~>  3.8"
+  spec.add_development_dependency "rack-test", "~> 1.1"
+  spec.add_development_dependency "rake",      "~> 12.0"
 end

data/lib/hanami.rb

@@ -1,4 +1,4 @@
-require 'thread'
+# frozen_string_literal: true
 
 # A complete web framework for Ruby
 #
@@ -6,277 +6,73 @@ require 'thread'
 #
 # @see http://hanamirb.org
 module Hanami
-  require 'hanami/version'
-  require 'hanami/frameworks'
-  require 'hanami/environment'
-  require 'hanami/app'
-  require 'hanami/application'
-  require 'hanami/components'
-  require 'hanami/configuration'
+  require "hanami/version"
+  require "hanami/frameworks"
+  require "hanami/container"
+  require "hanami/application"
 
-  # @api private
-  # @since 0.6.0
-  DEFAULT_PUBLIC_DIRECTORY = 'public'.freeze
-
-  # @api private
-  # @since 0.9.0
   @_mutex = Mutex.new
-  @_plugins = Concurrent::Array.new
 
-  # Configure Hanami project
-  #
-  # Please note that the code for this method is generated by `hanami new`.
-  #
-  # @param blk [Proc] the configuration block
-  #
-  # @since 0.9.0
-  #
-  # @example
-  #   # config/environment.rb
-  #
-  #   # ...
-  #
-  #   Hanami.configure do
-  #     mount Admin::Application, at: "/admin"
-  #     mount Web::Application,   at: "/"
-  #
-  #     model do
-  #       adapter :sql, ENV['DATABASE_URL']
-  #
-  #       migrations "db/migrations"
-  #       schema     "db/schema.sql"
-  #     end
-  #
-  #     mailer do
-  #       root "lib/bookshelf/mailers"
-  #
-  #       delivery do
-  #         development :test
-  #         test        :test
-  #         # production :smtp, address: ENV['SMTP_HOST'], port: ENV['SMTP_PORT']
-  #       end
-  #     end
-  #   end
-  def self.configure(&blk)
+  def self.application
     @_mutex.synchronize do
-      @_configuration = Hanami::Configuration.new(&blk)
-    end
-  end
+      raise "Hanami application not configured" unless defined?(@_application)
 
-  # Hanami configuration
-  #
-  # @return [Hanami::Configuration] the configuration
-  #
-  # @see Hanami.configure
-  #
-  # @since 0.9.0
-  # @api private
-  def self.configuration
-    @_mutex.synchronize do
-      raise "Hanami not configured" unless defined?(@_configuration)
-      @_configuration
+      @_application
     end
   end
 
-  # Configure a plugin
-  #
-  # @see Hanami.configure
-  #
-  # @since 1.2.0
-  def self.plugin(&blk)
-    @_plugins << blk
-  end
-
-  # Plugins registry
-  #
-  # NOTE: We can't use `Components` registry.
-  #
-  # Plugins are loaded when Bundler requires `Gemfile` gems.
-  # During this phase the `Components` that we can resolve are erased by the
-  # first incoming request in development.
-  # They are erased by a workaround that we had to put in place in `Hanami.boot`.
-  # This workaround is `Components.release` and it was introduced because
-  # `shotgun` failed to reload components, so we have to release for each
-  # incoming request.
-  # After the `Components` registry is cleared up, Hanami is able to resolve all
-  # the components from scratch.
-  #
-  # When we'll switch to `hanami-reloader` for development, we can remove
-  # `Components.release` and we'll be able to store plugins in `Components` and
-  # remove `Hanami.plugins` as well.
-  #
-  # @since 1.2.0
-  # @api private
-  def self.plugins
-    @_plugins
-  end
+  def self.application=(app)
+    @_mutex.synchronize do
+      raise "Hanami application already configured" if defined?(@_application)
 
-  # Boot your Hanami project
-  #
-  # NOTE: In case this is invoked many times, it guarantees that the boot
-  #   process happens only once.
-  #
-  # NOTE: This MUST NOT be wrapped by a Mutex, because it would cause a deadlock.
-  #
-  # @return [NilClass]
-  #
-  # @since 0.9.0
-  def self.boot
-    Components.release if code_reloading?
-    Components.resolve('all')
-    Hanami::Model.disconnect if defined?(Hanami::Model)
-    nil
+      @_application = app unless app.name.nil?
+    end
   end
 
-  # Main application that mounts many Rack and/or Hanami applications.
-  #
-  # This is used as integration point for:
-  #
-  #   * `config.ru` (`run Hanami.app`)
-  #   * Feature tests (`Capybara.app = Hanami.app`)
-  #
-  #
-  #
-  # It lazily loads your Hanami project, in case it wasn't booted on before.
-  # This is the case when `hanami server` isn't invoked, but we use different
-  # ways to run the project (eg. `rackup`).
-  #
-  # @return [Hanami::App] the app
-  #
-  # @since 0.9.0
-  # @api private
-  #
-  # @see Hanami.boot
   def self.app
-    boot
-    App.new(configuration, environment)
+    @_mutex.synchronize do
+      raise "Hanami.app not configured" unless defined?(@_app)
+
+      @_app
+    end
   end
 
-  # Check if an application is allowed to load.
-  #
-  # The list of applications to be loaded can be set via the `HANAMI_APPS`
-  # env variable. If the HANAMI_APPS env variable is not set, it defaults
-  # to loading all applications.
-  #
-  # @return [TrueClass,FalseClass] the result of the check
-  #
-  # @since 1.1.0
-  #
-  # @example
-  #
-  #   # Mount hanami app for specific app
-  #   Hanami.configure do
-  #     if Hanami.app?(:web)
-  #       require_relative '../apps/web/application'
-  #       mount Web::Application, at: '/'
-  #     end
-  #   end
-  #
-  def self.app?(app)
-    return true unless ENV.key?('HANAMI_APPS')
+  def self.app=(app)
+    @_mutex.synchronize do
+      raise "Hanami.app already configured" if defined?(@_app)
 
-    allowed_apps = ENV['HANAMI_APPS'].to_s.split(',')
-    allowed_apps.include?(app.to_s.downcase)
+      @_app = app
+    end
   end
 
-  # Return root of the project (top level directory).
-  #
-  # @return [Pathname] root path
-  #
-  # @since 0.3.2
-  #
-  # @example
-  #   Hanami.root # => #<Pathname:/Users/luca/Code/bookshelf>
   def self.root
-    environment.root
-  end
-
-  # Project public directory
-  #
-  # @return [Pathname] public directory
-  #
-  # @since 0.6.0
-  #
-  # @example
-  #   Hanami.public_directory # => #<Pathname:/Users/luca/Code/bookshelf/public>
-  def self.public_directory
-    root.join(DEFAULT_PUBLIC_DIRECTORY)
+    Container.root
   end
 
-  # Return the current environment
-  #
-  # @return [String] the current environment
-  #
-  # @since 0.3.1
-  #
-  # @see Hanami::Environment#environment
-  #
-  # @example
-  #   Hanami.env => "development"
   def self.env
-    environment.environment
+    (ENV["HANAMI_ENV"] || "development").to_sym
   end
 
-  # Check to see if specified environment(s) matches the current environment.
-  #
-  # If multiple names are given, it returns true, if at least one of them
-  # matches the current environment.
-  #
-  # @return [TrueClass,FalseClass] the result of the check
-  #
-  # @since 0.3.1
-  #
-  # @see Hanami.env
-  #
-  # @example Single name
-  #   puts ENV['HANAMI_ENV'] # => "development"
-  #
-  #   Hanami.env?(:development)  # => true
-  #   Hanami.env?('development') # => true
-  #
-  #   Hanami.env?(:production)   # => false
-  #
-  # @example Multiple names
-  #   puts ENV['HANAMI_ENV'] # => "development"
-  #
-  #   Hanami.env?(:development, :test)   # => true
-  #   Hanami.env?(:production, :staging) # => false
   def self.env?(*names)
-    environment.environment?(*names)
+    names.map(&:to_sym).include?(env)
   end
 
-  # Current environment
-  #
-  # @return [Hanami::Environment] environment
-  #
-  # @api private
-  # @since 0.3.2
-  def self.environment
-    Components.resolved('environment') do
-      Environment.new
-    end
+  def self.logger
+    Container[:logger]
   end
 
-  # Check if code reloading is enabled.
-  #
-  # @return [TrueClass,FalseClass] the result of the check
-  #
-  # @since 1.0.0
-  # @api private
-  #
-  # @see https://guides.hanamirb.org/projects/code-reloading
-  def self.code_reloading?
-    environment
-    Components.resolve('code_reloading')
-    Components['code_reloading']
+  def self.boot
+    @_mutex.synchronize do
+      raise "Hanami application already booted" if defined?(@_booted)
+
+      @_booted = true
+    end
+
+    Container.finalize!
+    self.app = application.new
   end
 
-  # Project logger
-  #
-  # @return [Hanami::Logger] the logger
-  #
-  # @since 1.0.0
-  def self.logger
-    Components['logger']
+  def self.bundler_groups
+    [:plugins]
   end
 end