hanami 1.3.5 → 2.0.0.alpha1

data/lib/hanami/config/cookies.rb

@@ -1,69 +0,0 @@
-module Hanami
-  # @api private
-  module Config
-    # Cookies configuration
-    #
-    # @since 0.3.0
-    # @api private
-    class Cookies
-
-      # Return the routes for this application
-      #
-      # @return [Hash] options for cookies
-      #
-      # @since 0.3.0
-      # @api private
-      attr_reader :default_options
-
-      # Cookies configuration
-      #
-      # httponly option enabled by default.
-      # Prevent attackers to steal cookies via JavaScript,
-      # Eg. alert(document.cookie) will fail
-      #
-      # @param options [Hash, TrueClass, FalseClass] optional cookies options
-      # @param configuration [Hanami::Configuration] the application configuration
-      #
-      # @since 0.3.0
-      # @api private
-      #
-      # @see https://github.com/rack/rack/blob/master/lib/rack/utils.rb #set_cookie_header!
-      # @see https://www.owasp.org/index.php/HttpOnly
-      #
-      # @example Enable cookies with boolean
-      #   module Web
-      #     class Application < Hanami::Application
-      #       configure do
-      #         # ...
-      #         cookies true
-      #       end
-      #     end
-      #   end
-      #
-      # @example Enable cookies with options
-      #   module Web
-      #     class Application < Hanami::Application
-      #       configure do
-      #         # ...
-      #         cookies max_age: 300
-      #       end
-      #     end
-      #   end
-      def initialize(configuration, options = {})
-        @options         = options
-        @default_options = { httponly: true, secure: configuration.ssl? }
-        @default_options.merge!(options) if options.is_a?(::Hash)
-      end
-
-      # Return if cookies are enabled
-      #
-      # @return [TrueClass, FalseClass] enabled cookies
-      #
-      # @since 0.3.0
-      # @api private
-      def enabled?
-        @options.respond_to?(:empty?) ? !@options.empty? : !!@options
-      end
-    end
-  end
-end

data/lib/hanami/config/framework_configuration.rb

@@ -1,43 +0,0 @@
-module Hanami
-  # @api private
-  module Config
-    # Collects all the settings for a given framework configuration and then
-    # forwards them when the application is loaded.
-    #
-    # @since 0.2.0
-    # @api private
-    class FrameworkConfiguration < BasicObject
-      # @since 0.2.0
-      # @api private
-      def initialize(&blk)
-        @blocks   = [blk || ::Proc.new { }]
-        @settings = []
-      end
-
-      # @since 0.2.0
-      # @api private
-      def __apply(configuration)
-        @blocks.compact.each do |blk|
-          configuration.instance_eval(&blk)
-        end
-
-        @settings.each do |(m, args, blk)|
-          configuration.public_send(m, *args, &blk)
-        end
-      end
-
-      # @since 0.6.0
-      # @api private
-      def __add(&blk)
-        @blocks << blk
-        self
-      end
-
-      # @since 0.2.0
-      # @api private
-      def method_missing(m, *args, &blk)
-        @settings.push([m, args, blk])
-      end
-    end
-  end
-end

data/lib/hanami/config/load_paths.rb

@@ -1,46 +0,0 @@
-require 'hanami/utils'
-
-module Hanami
-  # @api private
-  module Config
-    # Define the load paths where the application should load
-    #
-    # @since 0.1.0
-    # @api private
-    class LoadPaths < Utils::LoadPaths
-      # Overrides Utils::LoadPath initialize method
-      #
-      # @see Hanami::Utils::LoadPaths#initialize
-      #
-      # @since 0.1.0
-      # @api private
-      def initialize(root)
-        super()
-        @root = root
-      end
-
-      # Requires relative @pats [Utils::Kernel.Array] variable via each method
-      #
-      # @see Hanami::Utils::LoadPaths#each
-      #
-      # @since 0.1.0
-      # @api private
-      def load!
-        each do |path|
-          Utils.require!(path)
-        end
-      end
-
-      protected
-
-      # Overrides Utils::LoadPath realpath method
-      #
-      # @see Hanami::Utils::LoadPaths#realpath
-      #
-      # @api private
-      def realpath(path)
-        @root.join(path).realpath
-      end
-    end
-  end
-end

data/lib/hanami/config/mapper.rb

@@ -1,47 +0,0 @@
-require 'hanami/utils/kernel'
-
-module Hanami
-  # @since 0.1.0
-  # @api private
-  module Config
-    # Block or file mapper
-    #
-    # @since 0.1.0
-    # @api private
-    class Mapper
-      # @api private
-      EXTNAME = '.rb'
-
-      # @since 0.1.0
-      # @api private
-      def initialize(root, path, &blk)
-        @path, @blk = path, blk
-        @path = root.join(path) if root && path
-      end
-
-      # @since 0.1.0
-      # @api private
-      def to_proc
-        return @blk if @blk
-
-        code = realpath.read
-        Proc.new { eval(code) }
-      end
-
-      private
-      # @since 0.1.0
-      # @api private
-      def realpath
-        Utils::Kernel.Pathname("#{ @path }#{ EXTNAME }").realpath
-      rescue Errno::ENOENT
-        raise ArgumentError, error_message
-      end
-
-      # @since 0.1.0
-      # @api private
-      def error_message
-        'You must specify a block or a file.'
-      end
-    end
-  end
-end

data/lib/hanami/config/routes.rb

@@ -1,20 +0,0 @@
-require 'hanami/config/mapper'
-
-module Hanami
-  # @since 0.1.0
-  # @api private
-  module Config
-    # Defines a route set
-    #
-    # @since 0.1.0
-    # @api private
-    class Routes < Mapper
-      private
-      # @since 0.1.0
-      # @api private
-      def error_message
-        'You must specify a block or a file for routes definitions.'
-      end
-    end
-  end
-end

data/lib/hanami/config/security.rb

@@ -1,110 +0,0 @@
-module Hanami
-  # @since 0.3.0
-  # @api private
-  module Config
-    # Security policies are stored here.
-    #
-    # @since 0.3.0
-    class Security
-      # @since 0.3.0
-      # @api private
-      X_FRAME_OPTIONS_HEADER = 'X-Frame-Options'.freeze
-
-      # @since 0.8.0
-      # @api private
-      X_CONTENT_TYPE_OPTIONS_HEADER = 'X-Content-Type-Options'.freeze
-
-      # @since 0.8.0
-      # @api private
-      X_XSS_PROTECTION_HEADER = 'X-XSS-Protection'.freeze
-
-      # @since 0.3.0
-      # @api private
-      CONTENT_SECURITY_POLICY_HEADER = 'Content-Security-Policy'.freeze
-
-      # @since 0.8.0
-      # @api private
-      SEPARATOR = ';'.freeze
-
-      # @since 0.8.0
-      # @api private
-      SPACED_SEPARATOR = "#{ SEPARATOR } ".freeze
-
-      # X-Frame-Options headers' value
-      #
-      # @overload x_frame_options(value)
-      #   Sets the given value
-      #   @param value [String] for X-Frame-Options header.
-      #
-      # @overload x_frame_options
-      #   Gets the value
-      #   @return [String] X-Frame-Options header's value
-      #
-      # @since 0.3.0
-      def x_frame_options(value = nil)
-        if value.nil?
-          @x_frame_options
-        else
-          @x_frame_options = value
-        end
-      end
-
-      # X-Content-Type-Options headers' value
-      #
-      # @overload x_content_type_options(value)
-      #   Sets the given value
-      #   @param value [String] for X-Content-Type-Options header.
-      #
-      # @overload x_content_type_options
-      #   Gets the value
-      #   @return [String] X-Content-Type-Options header's value
-      #
-      # @since 0.8.0
-      def x_content_type_options(value = nil)
-        if value.nil?
-          @x_content_type_options
-        else
-          @x_content_type_options = value
-        end
-      end
-
-      # X-XSS-Protection headers' value
-      #
-      # @overload x_xss_protection(value)
-      #   Sets the given value
-      #   @param value [String] for X-XSS-Protection header.
-      #
-      # @overload x_xss_protection
-      #   Gets the value
-      #   @return [String] X-XSS-Protection header's value
-      #
-      # @since 0.8.0
-      def x_xss_protection(value = nil)
-        if value.nil?
-          @x_xss_protection
-        else
-          @x_xss_protection = value
-        end
-      end
-
-      # Content-Policy-Security headers' value
-      #
-      # @overload content_security_policy(value)
-      #   Sets the given value
-      #   @param value [String] for Content-Security-Policy header.
-      #
-      # @overload content_security_policy
-      #   Gets the value
-      #   @return [String] Content-Security-Policy header's value
-      #
-      # @since 0.3.0
-      def content_security_policy(value = nil)
-        if value.nil?
-          @content_security_policy
-        else
-          @content_security_policy = value.split(SEPARATOR).map(&:strip).join(SPACED_SEPARATOR)
-        end
-      end
-    end
-  end
-end

data/lib/hanami/config/sessions.rb

@@ -1,119 +0,0 @@
-require 'ipaddr'
-require 'hanami/utils/string'
-
-module Hanami
-  # @since 0.2.0
-  # @api private
-  module Config
-    # Sessions configuration
-    #
-    # @since 0.2.0
-    # @api private
-    class Sessions
-
-      # Ruby namespace for Rack session adapters
-      #
-      # @since 0.2.0
-      # @api private
-      RACK_NAMESPACE = 'Rack::Session::%s'.freeze
-
-      # Localhost string for detecting localhost host configuration
-      #
-      # @since 0.2.0
-      # @api private
-      BLACKLISTED_DOMAINS = %w(localhost).freeze
-
-      # HTTP sessions configuration
-      #
-      # @param adapter [Symbol,String,Class] the session adapter
-      # @param options [Hash] the optional session options
-      # @param configuration [Hanami::Configuration] the application configuration
-      #
-      # @since 0.2.0
-      # @api private
-      #
-      # @see http://www.rubydoc.info/github/rack/rack/Rack/Session/Abstract/ID
-      # @see https://www.rubydoc.info/github/rack/rack/Rack/Session/Cookie
-      def initialize(adapter = nil, options = {}, configuration = nil)
-        @adapter       = adapter
-        @options       = options
-        @configuration = configuration
-      end
-
-      # Check if the sessions are enabled
-      #
-      # @return [FalseClass,TrueClass] the result of the check
-      #
-      # @since 0.2.0
-      # @api private
-      def enabled?
-        !!@adapter
-      end
-
-      # Returns the Rack middleware and the options
-      #
-      # @return [Array] Rack middleware and options
-      #
-      # @since 0.2.0
-      # @api private
-      def middleware
-        middleware = case @adapter
-                     when Symbol
-                       RACK_NAMESPACE % Utils::String.classify(@adapter)
-                     else
-                       @adapter
-                     end
-
-        [middleware, options]
-      end
-
-      private
-
-      # @since 0.2.0
-      # @api private
-      def options
-        default_options.merge(@options)
-      end
-
-      # @since 0.2.0
-      # @api private
-      def default_options
-        result = if @configuration
-          { domain: domain, secure: @configuration.ssl? }
-        else
-          {}
-        end
-
-        if s = cookies_adapter_serializer
-          result[:coder] = s
-        end
-
-        result
-      end
-
-      # @since 0.2.0
-      # @api private
-      def domain
-        domain = @configuration.host
-        if !BLACKLISTED_DOMAINS.include?(domain) && !ip_address?(domain)
-          domain
-        end
-      end
-
-      # @since 0.2.0
-      # @api private
-      def ip_address?(string)
-        !!IPAddr.new(string) rescue false
-      end
-
-      # @since 1.3.5
-      # @api private
-      def cookies_adapter_serializer
-        return nil unless @adapter == :cookie
-
-        require "rack/session/cookie"
-        Rack::Session::Cookie::Base64::JSON.new
-      end
-    end
-  end
-end

data/lib/hanami/configuration/app.rb

@@ -1,21 +0,0 @@
-require "delegate"
-
-module Hanami
-  # @api private
-  class Configuration
-    # @api private
-    class App < SimpleDelegator
-      # @api private
-      attr_reader :path_prefix
-      # @api private
-      attr_reader :host
-
-      # @api private
-      def initialize(app, options = {})
-        super(app)
-        @path_prefix = options[:at]
-        @host = options[:host]
-      end
-    end
-  end
-end

data/lib/hanami/early_hints.rb

@@ -1,129 +0,0 @@
-# frozen_string_literal: true
-
-module Hanami
-  # HTTP/2 Early Hints Rack middleware
-  #
-  # It sends extra responses **before** the main response is sent.
-  # These extra responses are HTTP/2 Early Hints (103).
-  # They specify the web assets (javascripts, stylesheets, etc..) to be "pushed",
-  # so modern browsers pre-fetch them in parallel with the main HTTP response.
-  #
-  # @see https://tools.ietf.org/html/draft-ietf-httpbis-early-hints-05
-  #
-  # @since 1.2.0
-  # @api private
-  class EarlyHints
-    # @since 1.2.0
-    # @api private
-    class NotSupportedByServerError < ::StandardError
-      # @since 1.2.0
-      # @api private
-      def initialize
-        super("Current Ruby server doesn't support Early Hints.\nPlease make sure to use a web server with Early Hints enabled (only Puma for now).")
-      end
-    end
-
-    # @since 1.2.0
-    # @api private
-    def initialize(app)
-      @app = app
-    end
-
-    # @param env [Hash] Rack env
-    #
-    # @return [Array,Rack::Response] a Rack response
-    #
-    # @raise [Hanami::EarlyHints::NotSupportedByServerError] if the current Ruby
-    #   server doesn't support Early Hints
-    #
-    # @since 1.2.0
-    # @api private
-    def call(env)
-      @app.call(env).tap do
-        send_early_hints(env)
-      end
-    end
-
-    private
-
-    # Pushing a lot of assets may exceed the limit of HTTP headers of a single
-    # Early Hints (103) response.
-    #
-    # For this reason we send multiple Early Hints (103) responses for each `n`
-    # assets. We call this `n` number `BATCH_SIZE`.
-    #
-    # If the current page needs to push 23 assets, it will send 3 Early Hints
-    # (103) responses:
-    #
-    #   1. Response #1: 10 assets
-    #   2. Response #2: 10 assets
-    #   3. Response #3: 3 assets
-    #
-    # @since 1.2.0
-    # @api private
-    BATCH_SIZE = 10
-
-    # Rack servers that support Early Hints (only Puma for now),
-    # inject an object into the Rack env to send multiple Early Hints (103)
-    # responses.
-    #
-    # @since 1.2.0
-    # @api private
-    #
-    # @see https://github.com/puma/puma/pull/1403
-    RACK_EARLY_HINTS_ENV_KEY = "rack.early_hints"
-
-    # This cache key is used by `hanami-assets` to collect the assets that are
-    # eligible to be pushed.
-    #
-    # It stores these values in a thread-local variable.
-    #
-    # NOTE: if changing this key here, it MUST be changed into `hanami-assets` as well
-    #
-    # @since 1.2.0
-    # @api private
-    CACHE_KEY = :__hanami_assets
-
-    # Tries to send multiple Early Hints (103) HTTP responses, if there are
-    # assets eligible.
-    #
-    # @param env [Hash] Rack env
-    #
-    # @raise [Hanami::EarlyHints::NotSupportedByServerError] if the current Ruby
-    #   server doesn't support Early Hints
-    #
-    # @since 1.2.0
-    # @api private
-    def send_early_hints(env)
-      return if Thread.current[CACHE_KEY].nil?
-
-      Thread.current[CACHE_KEY].each_slice(BATCH_SIZE) do |slice|
-        link = slice.map do |asset, options|
-          ret = %(<#{asset}>; rel=preload)
-          ret += "; as=#{options[:as]}" unless options[:as].nil?
-          ret += "; crossorigin" if options[:crossorigin]
-          ret
-        end.join("\n")
-
-        send_early_hints_response(env, link)
-      end
-    end
-
-    # Tries to send an Early Hints (103) HTTP response for a batch of assets
-    #
-    # @param env [Hash] Rack env
-    # @param link [String] the serialized HTTP `Link` headers
-    #
-    # @raise [Hanami::EarlyHints::NotSupportedByServerError] if the current Ruby
-    #   server doesn't support Early Hints
-    #
-    # @since 1.2.0
-    # @api private
-    def send_early_hints_response(env, link)
-      env[RACK_EARLY_HINTS_ENV_KEY].call("Link" => link)
-    rescue NoMethodError => exception
-      raise exception if env.key?(RACK_EARLY_HINTS_ENV_KEY)
-      raise NotSupportedByServerError
-    end
-  end
-end

data/lib/hanami/env.rb

@@ -1,69 +0,0 @@
-begin
-  require 'dotenv/parser'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
-end
-
-module Hanami
-  # Encapsulate access to ENV
-  #
-  # @since 0.9.0
-  # @api private
-  class Env
-    # Create a new instance
-    #
-    # @param env [#[],#[]=] a Hash like object. It defaults to ENV
-    #
-    # @return [Hanami::Env]
-    #
-    # @since 0.9.0
-    # @api private
-    def initialize(env: ENV)
-      @env = env
-    end
-
-    # Return a value, if found
-    #
-    # @param key [String] the key
-    #
-    # @return [String,NilClass] the value, if found
-    #
-    # @since 0.9.0
-    # @api private
-    def [](key)
-      @env[key]
-    end
-
-    # Sets a value
-    #
-    # @param key [String] the key
-    # @param value [String] the value
-    #
-    # @since 0.9.0
-    # @api private
-    def []=(key, value)
-      @env[key] = value
-    end
-
-    # Loads a dotenv file and updates self
-    #
-    # @param path [String, Pathname] the path to the dotenv file
-    #
-    # @return void
-    #
-    # @since 0.9.0
-    # @api private
-    def load!(path)
-      return unless defined?(Dotenv::Parser)
-
-      contents = ::File.open(path, "rb:bom|utf-8", &:read)
-      parsed   = Dotenv::Parser.call(contents)
-
-      parsed.each do |k, v|
-        next if @env.has_key?(k)
-
-        @env[k] = v
-      end
-      nil
-    end
-  end
-end