hanami 2.0.0.alpha7.1 → 2.0.0.beta1.1

data/FEATURES.md

@@ -1,8 +1,29 @@
 # Hanami
+
 ### The web, with simplicity.
 
 ## Features
 
+## v2.0.0.beta1 - 2021-07-20
+
+- Generate new apps using `app/` directory
+
+## v2.0.0.alpha8 - 2021-05-19
+
+## v2.0.0.alpha7.1 - 2021-03-09
+
+## v2.0.0.alpha7 - 2021-03-08
+
+## v2.0.0.alpha6 - 2021-02-10
+
+## v2.0.0.alpha5 - 2021-01-12
+
+## v2.0.0.alpha4 - 2021-12-07
+
+## v2.0.0.alpha3 - 2021-11-09
+
+## v2.0.0.alpha2 - 2021-05-04
+
 ## v2.0.0.alpha1 - 2019-01-30
 
 ## v1.3.3 - 2019-09-20
@@ -110,14 +131,14 @@
 - Assets preprocessors support (eg. Sass, ES6, Opal, Less, CoffeScript..)
 - Assets compressors (eg. YUI, UglifyJS2, Google Closure Compiler, Sass..)
 - Assets helpers:
-  * `javascript`
-  * `stylesheet`
-  * `favicon`
-  * `image`
-  * `video`
-  * `audio`
-  * `asset_path`
-  * `asset_url`
+  - `javascript`
+  - `stylesheet`
+  - `favicon`
+  - `image`
+  - `video`
+  - `audio`
+  - `asset_path`
+  - `asset_url`
 - Content Delivery Network (CDN) support for static assets (CDN mode)
 - Checksum suffix for static assets in production mode (Digest mode)
 - Support for third party gems as assets distribution channel (eg. `lotus-jquery`)
@@ -159,7 +180,7 @@
 - `Lotus.env` and `Lotus.env?` for current environment introspection (eg. `Lotus.env?(:test)` or `Lotus.env?(:staging, :production)`)
 - Allow repositories to execute raw query/commands against database
 - Automatic timestamps update for entities
-– Dirty Tracking for entities (via `Lotus::Entity::DirtyTracking`)
+  – Dirty Tracking for entities (via `Lotus::Entity::DirtyTracking`)
 - Nested RESTful resource(s)
 - String pluralization and singularization
 

data/README.md

@@ -14,10 +14,8 @@ It's made up of smaller, single-purpose libraries.
 This repository is for the full-stack framework,
 which provides the glue that ties all the parts together:
 
-* [**Hanami::Model**](https://github.com/hanami/model) - Persistence with entities, repositories and data mapper
 * [**Hanami::View**](https://github.com/hanami/view) - Presentation with a separation between views and templates
 * [**Hanami::Controller**](https://github.com/hanami/controller) - Full featured, fast and testable actions for Rack
-* [**Hanami::Validations**](https://github.com/hanami/validations) - Validations mixin for Ruby objects
 * [**Hanami::Router**](https://github.com/hanami/router) - Rack compatible HTTP router for Ruby
 * [**Hanami::Helpers**](https://github.com/hanami/helpers) - View helpers for Ruby applications
 * [**Hanami::Mailer**](https://github.com/hanami/mailer) - Mail for Ruby applications
@@ -54,7 +52,7 @@ Please follow along with the [Getting Started guide](https://guides.hanamirb.org
 
 ## Donations
 
-You can give back to Open Source, by supporting Hanami development via a [donation](https://salt.bountysource.com/teams/hanami). :green_heart:
+You can give back to Open Source, by supporting Hanami development via [GitHub Sponsors](https://github.com/sponsors/hanami).
 
 ### Supporters
 

data/hanami.gemspec

@@ -14,23 +14,33 @@ Gem::Specification.new do |spec|
   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") # rubocop:disable Layout/LineLength
-  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.files         = Dir[
+    "CODE_OF_CONDUCT.md",
+    "CHANGELOG.md",
+    "FEATURES.md",
+    "LICENSE.md",
+    "README.md",
+    "hanami.gemspec",
+    "lib/**/*"
+  ]
+
+  spec.test_files    = Dir["spec/**/*"]
   spec.require_paths = ["lib"]
   spec.metadata["rubygems_mfa_required"] = "true"
   spec.required_ruby_version = ">= 3.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  spec.add_dependency "bundler",           ">= 1.16", "< 3"
-  spec.add_dependency "dry-configurable",  "~> 0.12", ">= 0.12.1"
-  spec.add_dependency "dry-core",          "~> 0.4"
-  spec.add_dependency "dry-inflector",     "~> 0.2", ">= 0.2.1"
-  spec.add_dependency "dry-monitor"
-  spec.add_dependency "dry-system",        "~> 0.23", ">= 0.23.0"
-  spec.add_dependency "hanami-cli",        "~> 2.0.alpha"
-  spec.add_dependency "hanami-utils",      "~> 2.0.alpha"
-  spec.add_dependency "zeitwerk",          "~> 2.4"
+  spec.add_dependency "bundler",          ">= 1.16", "< 3"
+  spec.add_dependency "dry-configurable", "~> 0.15"
+  spec.add_dependency "dry-core",         "~> 0.7"
+  spec.add_dependency "dry-types",        "~> 1.5"
+  spec.add_dependency "dry-inflector",    "~> 0.2", ">= 0.2.1"
+  spec.add_dependency "dry-system",       "~> 0.25", ">= 0.25.0"
+  spec.add_dependency "dry-monitor",      "~> 0.6", ">= 0.6.0"
+  spec.add_dependency "hanami-cli",       "~> 2.0.beta"
+  spec.add_dependency "hanami-utils",     "~> 2.0.beta"
+  spec.add_dependency "zeitwerk",         "~> 2.4"
 
   spec.add_development_dependency "rspec",     "~> 3.8"
   spec.add_development_dependency "rack-test", "~> 1.1"

data/lib/hanami/app.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require_relative "configuration"
+require_relative "constants"
+require_relative "slice"
+require_relative "slice_name"
+
+module Hanami
+  # The Hanami app is a singular slice tasked with managing the core components of
+  # the app and coordinating overall app boot.
+  #
+  # For smaller apps, the app may be the only slice present, whereas larger apps
+  # may consist of many slices, with the app reserved for holding a small number
+  # of shared components only.
+  #
+  # @see Slice
+  #
+  # @api public
+  # @since 2.0.0
+  class App < Slice
+    @_mutex = Mutex.new
+
+    def self.inherited(subclass)
+      super
+
+      Hanami.app = subclass
+
+      subclass.extend(ClassMethods)
+
+      @_mutex.synchronize do
+        subclass.class_eval do
+          @configuration = Hanami::Configuration.new(app_name: slice_name, env: Hanami.env)
+          @autoloader = Zeitwerk::Loader.new
+
+          prepare_base_load_path
+        end
+      end
+    end
+
+    # App class interface
+    module ClassMethods
+      attr_reader :autoloader, :configuration
+
+      def app_name
+        slice_name
+      end
+
+      private
+
+      def prepare_base_load_path
+        base_path = root.join(LIB_DIR)
+        $LOAD_PATH.unshift(base_path) unless $LOAD_PATH.include?(base_path)
+      end
+
+      def prepare_all
+        # Make app-wide notifications available as early as possible
+        container.use(:notifications)
+
+        # Ensure all basic slice preparation is complete before we make adjustments below
+        # (which rely on the basic prepare steps having already run)
+        super
+
+        # Run specific prepare steps for the app slice. Note also that some
+        # standard steps have been skipped via the empty method overrides below.
+        prepare_app_component_dirs
+        prepare_app_providers
+
+        # The autoloader must be setup after the container is configured, which is the
+        # point at which any component dirs from other slices are added to the autoloader
+        app = self
+        container.after(:configure) do
+          app.send(:prepare_app_autoloader)
+        end
+      end
+
+      # Skip standard slice prepare steps that do not apply to the app slice
+      def prepare_container_component_dirs; end
+      def prepare_container_imports; end
+
+      # rubocop:disable Metrics/AbcSize
+
+      def prepare_app_component_dirs
+        # Component files in both `app/` and `app/lib/` define classes in the
+        # app's namespace
+
+        if root.join(APP_DIR, LIB_DIR).directory?
+          container.config.component_dirs.add(File.join(APP_DIR, LIB_DIR)) do |dir|
+            dir.namespaces.add_root(key: nil, const: app_name.name)
+          end
+        end
+
+        # When auto-registering components in app/, ignore files in `app/lib/` (these will
+        # be auto-registered as above), as well as the configured no_auto_register_paths
+        no_auto_register_paths = ([LIB_DIR] + configuration.no_auto_register_paths)
+          .map { |path|
+            path.end_with?(File::SEPARATOR) ? path : "#{path}#{File::SEPARATOR}"
+          }
+
+        if root.join(APP_DIR).directory?
+          container.config.component_dirs.add(APP_DIR) do |dir|
+            dir.namespaces.add_root(key: nil, const: app_name.name)
+            dir.auto_register = -> component {
+              relative_path = component.file_path.relative_path_from(root.join(APP_DIR)).to_s
+              !relative_path.start_with?(*no_auto_register_paths)
+            }
+          end
+        end
+      end
+
+      def prepare_app_providers
+        require_relative "providers/inflector"
+        register_provider(:inflector, source: Hanami::Providers::Inflector)
+
+        # Allow logger to be replaced by users with a manual provider, for advanced cases
+        unless container.providers.find_and_load_provider(:logger)
+          require_relative "providers/logger"
+          register_provider(:logger, source: Hanami::Providers::Logger)
+        end
+
+        require_relative "providers/rack"
+        register_provider(:rack, source: Hanami::Providers::Rack, namespace: true)
+      end
+
+      def prepare_app_autoloader
+        # Component dirs are automatically pushed to the autoloader by dry-system's
+        # zeitwerk plugin. This method adds other dirs that are not otherwise configured
+        # as component dirs.
+
+        # Autoload classes from `lib/[app_namespace]/`
+        if root.join(LIB_DIR, app_name.name).directory?
+          autoloader.push_dir(root.join(LIB_DIR, app_name.name), namespace: namespace)
+        end
+
+        autoloader.setup
+      end
+
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

data/lib/hanami/assets/application_configuration.rb

@@ -10,6 +10,11 @@ module Hanami
     class ApplicationConfiguration
       include Dry::Configurable
 
+      # @since 2.0.0
+      # @api private
+      attr_reader :base_configuration
+      protected :base_configuration
+
       setting :server_url, default: "http://localhost:8080"
 
       # @since 2.0.0
@@ -20,6 +25,11 @@ module Hanami
         @base_configuration = Assets::Configuration.new
       end
 
+      def initialize_copy(source)
+        super
+        @base_configuration = source.base_configuration.dup
+      end
+
       # @since 2.0.0
       # @api private
       def finalize!
@@ -37,10 +47,6 @@ module Hanami
 
       private
 
-      # @since 2.0.0
-      # @api private
-      attr_reader :base_configuration
-
       # @since 2.0.0
       # @api private
       def method_missing(name, *args, &block)

data/lib/hanami/configuration/actions/content_security_policy.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Hanami
+  class Configuration
+    class Actions
+      # Configuration for Content Security Policy in Hanami apps
+      #
+      # @since 2.0.0
+      class ContentSecurityPolicy
+        # @since 2.0.0
+        # @api private
+        def initialize(&blk)
+          @policy = {
+            base_uri: "'self'",
+            child_src: "'self'",
+            connect_src: "'self'",
+            default_src: "'none'",
+            font_src: "'self'",
+            form_action: "'self'",
+            frame_ancestors: "'self'",
+            frame_src: "'self'",
+            img_src: "'self' https: data:",
+            media_src: "'self'",
+            object_src: "'none'",
+            plugin_types: "application/pdf",
+            script_src: "'self'",
+            style_src: "'self' 'unsafe-inline' https:"
+          }
+
+          blk&.(self)
+        end
+
+        # @since 2.0.0
+        # @api private
+        def initialize_copy(original_object)
+          @policy = original_object.instance_variable_get(:@policy).dup
+          super
+        end
+
+        # Get a CSP setting
+        #
+        # @param key [Symbol] the underscored name of the CPS setting
+        # @return [String,NilClass] the CSP setting, if any
+        #
+        # @since 2.0.0
+        # @api public
+        #
+        # @example
+        #   module MyApp
+        #     class App < Hanami::App
+        #       config.actions.content_security_policy[:base_uri] # => "'self'"
+        #     end
+        #   end
+        def [](key)
+          @policy[key]
+        end
+
+        # Set a CSP setting
+        #
+        # @param key [Symbol] the underscored name of the CPS setting
+        # @param value [String] the CSP setting value
+        #
+        # @since 2.0.0
+        # @api public
+        #
+        # @example Replace a default value
+        #   module MyApp
+        #     class App < Hanami::App
+        #       config.actions.content_security_policy[:plugin_types] = nil
+        #     end
+        #   end
+        #
+        # @example Append to a default value
+        #   module MyApp
+        #     class App < Hanami::App
+        #       config.actions.content_security_policy[:script_src] += " https://my.cdn.test"
+        #     end
+        #   end
+        def []=(key, value)
+          @policy[key] = value
+        end
+
+        # Deletes a CSP key
+        #
+        # @param key [Symbol] the underscored name of the CPS setting
+        #
+        # @since 2.0.0
+        # @api public
+        #
+        # @example
+        #   module MyApp
+        #     class App < Hanami::App
+        #       config.actions.content_security_policy.delete(:object_src)
+        #     end
+        #   end
+        def delete(key)
+          @policy.delete(key)
+        end
+
+        # @since 2.0.0
+        # @api private
+        def to_str
+          @policy.map do |key, value|
+            "#{dasherize(key)} #{value}"
+          end.join(";\n")
+        end
+
+        private
+
+        # @since 2.0.0
+        # @api private
+        def dasherize(key)
+          key.to_s.gsub("_", "-")
+        end
+      end
+    end
+  end
+end

data/lib/hanami/configuration/actions/cookies.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Hanami
+  class Configuration
+    class Actions
+      # Wrapper for app-level configuration of HTTP cookies for Hanami actions.
+      # This decorates the hash of cookie options that is otherwise directly configurable
+      # on actions, and adds the `enabled?` method to allow app base action to
+      # determine whether to include the `Action::Cookies` module.
+      #
+      # @since 2.0.0
+      class Cookies
+        attr_reader :options
+
+        def initialize(options)
+          @options = options
+        end
+
+        def enabled?
+          !options.nil?
+        end
+
+        def to_h
+          options.to_h
+        end
+      end
+    end
+  end
+end

data/lib/hanami/configuration/actions/sessions.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "dry/core/constants"
+require "hanami/utils/string"
+require "hanami/utils/class"
+
+module Hanami
+  class Configuration
+    class Actions
+      # Configuration for HTTP sessions in Hanami actions
+      #
+      # @since 2.0.0
+      class Sessions
+        attr_reader :storage, :options
+
+        def initialize(storage = nil, *options)
+          @storage = storage
+          @options = options
+        end
+
+        def enabled?
+          !storage.nil?
+        end
+
+        def middleware
+          return [] if !enabled?
+
+          [[storage_middleware, options]]
+        end
+
+        private
+
+        def storage_middleware
+          require_storage
+
+          name = Utils::String.classify(storage)
+          Utils::Class.load!(name, ::Rack::Session)
+        end
+
+        def require_storage
+          require "rack/session/#{storage}"
+        end
+      end
+    end
+  end
+end

data/lib/hanami/configuration/actions.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
-# require_relative "application_configuration/cookies"
-# require_relative "application_configuration/sessions"
-# require_relative "application_configuration/content_security_policy"
-# require_relative "configuration"
-# require_relative "view_name_inferrer"
+require "dry/configurable"
+require "hanami/action/configuration"
+require_relative "actions/cookies"
+require_relative "actions/sessions"
+require_relative "actions/content_security_policy"
+require_relative "../slice/view_name_inferrer"
 
 module Hanami
   class Configuration
+    # Hanami actions configuration
+    #
+    # @since 2.0.0
     class Actions
       include Dry::Configurable
 
@@ -16,16 +20,19 @@ module Hanami
       setting :csrf_protection
 
       setting :name_inference_base, default: "actions"
-      setting :view_context_identifier, default: "view.context"
-      setting :view_name_inferrer, default: ViewNameInferrer
+      setting :view_context_identifier, default: "views.context"
+      setting :view_name_inferrer, default: Slice::ViewNameInferrer
       setting :view_name_inference_base, default: "views"
 
       attr_accessor :content_security_policy
 
+      attr_reader :base_configuration
+      protected :base_configuration
+
       def initialize(*, **options)
         super()
 
-        @base_configuration = Configuration.new
+        @base_configuration = Hanami::Action::Configuration.new
         @content_security_policy = ContentSecurityPolicy.new do |csp|
           if assets_server_url = options[:assets_server_url]
             csp[:script_src] += " #{assets_server_url}"
@@ -36,13 +43,19 @@ module Hanami
         configure_defaults
       end
 
+      def initialize_copy(source)
+        super
+        @base_configuration = source.base_configuration.dup
+        @content_security_policy = source.content_security_policy.dup
+      end
+
       def finalize!
         # A nil value for `csrf_protection` means it has not been explicitly configured
         # (neither true nor false), so we can default it to whether sessions are enabled
         self.csrf_protection = sessions.enabled? if csrf_protection.nil?
 
-        if self.content_security_policy
-          self.default_headers["Content-Security-Policy"] = self.content_security_policy.to_str
+        if content_security_policy
+          default_headers["Content-Security-Policy"] = content_security_policy.to_str
         end
       end
 
@@ -58,8 +71,6 @@ module Hanami
 
       private
 
-      attr_reader :base_configuration
-
       # Apply defaults for base configuration settings
       def configure_defaults
         self.default_request_format = :html

data/lib/hanami/configuration/logger.rb

@@ -11,9 +11,9 @@ module Hanami
     class Logger
       include Dry::Configurable
 
-      protected :config
+      attr_reader :app_name
 
-      setting :application_name
+      protected :config
 
       setting :level
 
@@ -29,9 +29,8 @@ module Hanami
 
       setting :logger_class, default: Hanami::Logger
 
-      def initialize(env:, application_name:)
-        @env = env
-        @application_name = application_name
+      def initialize(env:, app_name:)
+        @app_name = app_name
 
         config.level = case env
                        when :production
@@ -58,12 +57,16 @@ module Hanami
                         end
       end
 
-      def finalize!
-        config.application_name = @application_name.call
-      end
-
       def instance
-        logger_class.new(application_name, *options, stream: stream, level: level, formatter: formatter, filter: filters, colorizer: colors)
+        logger_class.new(
+          app_name.name,
+          *options,
+          stream: stream,
+          level: level,
+          formatter: formatter,
+          filter: filters,
+          colorizer: colors
+        )
       end
 
       private

data/lib/hanami/configuration/router.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "dry/configurable"
-require_relative "../application/routing/resolver"
+require_relative "../slice/routing/resolver"
 
 module Hanami
   class Configuration
@@ -22,11 +22,7 @@ module Hanami
         @base_configuration = base_configuration
       end
 
-      setting :routes_path, default: File.join("config", "routes")
-
-      setting :routes_class_name, default: "Routes"
-
-      setting :resolver, default: Application::Routing::Resolver
+      setting :resolver, default: Slice::Routing::Resolver
 
       # @api private
       # @since 2.0.0

data/lib/hanami/configuration/sessions.rb

@@ -30,7 +30,7 @@ module Hanami
       end
 
       def middleware
-        [[storage_middleware, options]]
+        [storage_middleware, options]
       end
 
       private