hanami 0.0.0 → 0.7.0

data/lib/hanami/commands/routes.rb

@@ -0,0 +1,41 @@
+module Hanami
+  module Commands
+    # Display application/container routes.
+    #
+    # It is run with:
+    #
+    #   `bundle exec hanami routes`
+    #
+    # @since 0.1.0
+    # @api private
+    class Routes
+      # @param options [Hash] Environment's options
+      #
+      # @since 0.1.0
+      # @see Hanami::Environment#initialize
+      def initialize(options)
+        @environment = Hanami::Environment.new(options)
+        @environment.require_application_environment
+      end
+
+      # Display to STDOUT application routes
+      #
+      # @since 0.1.0
+      def start
+        puts app.routes.inspector.to_s
+      end
+
+      private
+
+      # @since 0.1.0
+      # @api private
+      def app
+        if @environment.container?
+          Hanami::Container.new
+        else
+          Hanami::Application.applications.first.new
+        end
+      end
+    end
+  end
+end

data/lib/hanami/commands/server.rb

@@ -0,0 +1,79 @@
+require 'rack'
+
+module Hanami
+  module Commands
+    # Rack compatible server.
+    #
+    # It is run with:
+    #
+    #   `bundle exec hanami server`
+    #
+    # It runs the application, by using the server specified in your `Gemfile`
+    # (eg. Puma or Unicorn).
+    #
+    # It enables code reloading by default.
+    # This feature is implemented via process fork and requires `shotgun` gem.
+    #
+    # @since 0.1.0
+    # @api private
+    class Server < ::Rack::Server
+      attr_reader :options
+
+      # @param options [Hash] Environment's options
+      #
+      # @since 0.1.0
+      # @see Hanami::Environment#initialize
+      def initialize(options)
+        @_env    = Hanami::Environment.new(options)
+        @options = _extract_options(@_env)
+
+        if code_reloading?
+          require 'shotgun'
+          @app = Shotgun::Loader.new(@_env.rackup.to_s)
+        end
+      end
+
+      # Primarily this removes the ::Rack::Chunked middleware
+      # which is the cause of Safari content-length bugs.
+      #
+      # @since 0.1.0
+      def middleware
+        mw = Hash.new { |e, m| e[m] = [] }
+        mw["deployment"].concat([::Rack::ContentLength, ::Rack::CommonLogger])
+        mw["development"].concat(mw["deployment"] + [::Rack::ShowExceptions, ::Rack::Lint])
+        mw
+      end
+
+      # Kickstart shotgun preloader if code reloading is supported
+      #
+      # @since 0.1.0
+      def start
+        if code_reloading?
+          Shotgun.enable_copy_on_write
+          Shotgun.preload
+        end
+
+        super
+      end
+
+      private
+
+      # @since 0.1.0
+      # @api private
+      def _extract_options(env)
+        env.to_options.merge(
+          config:      env.rackup.to_s,
+          Host:        env.host,
+          Port:        env.port,
+          AccessLog:   []
+        )
+      end
+
+      # @since 0.1.0
+      # @api private
+      def code_reloading?
+        @_env.code_reloading?
+      end
+    end
+  end
+end

data/lib/hanami/config/configure.rb

@@ -0,0 +1,17 @@
+require 'hanami/config/mapper'
+
+module Hanami
+  module Config
+    # Define configuration of application of
+    # a specific environment
+    #
+    # @since 0.2.0
+    # @api private
+    class Configure < Mapper
+      private
+      def error_message
+        'You must specify a block or a file for configuration definition'
+      end
+    end
+  end
+end

data/lib/hanami/config/cookies.rb

@@ -0,0 +1,68 @@
+module Hanami
+  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

@@ -0,0 +1,42 @@
+module Hanami
+  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

@@ -0,0 +1,27 @@
+require 'hanami/utils/load_paths'
+
+module Hanami
+  module Config
+    # Define the load paths where the application should load
+    #
+    # @since 0.1.0
+    # @api private
+    class LoadPaths < Utils::LoadPaths
+      PATTERN = '**/*.rb'.freeze
+
+      def load!(root)
+        @root = root
+
+        each do |path|
+          Dir.glob(path.join(PATTERN)).each { |file| require file }
+        end
+      end
+
+      protected
+      def realpath(path)
+        @root.join(path).realpath
+      end
+    end
+  end
+end
+

data/lib/hanami/config/mapper.rb

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

data/lib/hanami/config/mapping.rb

@@ -0,0 +1,12 @@
+require 'hanami/config/mapper'
+
+module Hanami
+  module Config
+    class Mapping < Mapper
+      private
+      def error_message
+        'You must specify a block or a file for database mapping definitions.'
+      end
+    end
+  end
+end

data/lib/hanami/config/routes.rb

@@ -0,0 +1,16 @@
+require 'hanami/config/mapper'
+
+module Hanami
+  module Config
+    # Defines a route set
+    #
+    # @since 0.1.0
+    # @api private
+    class Routes < Mapper
+      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

@@ -0,0 +1,58 @@
+module Hanami
+  module Config
+    # Security policies are stored here.
+    #
+    # @since 0.3.0
+    class Security
+      # @since 0.3.0
+      # @api private
+      #
+      # @see Hanami::Loader#_configure_controller_framework!
+      X_FRAME_OPTIONS_HEADER = 'X-Frame-Options'.freeze
+
+      # @since 0.3.0
+      # @api private
+      #
+      # @see Hanami::Loader#_configure_controller_framework!
+      CONTENT_SECURITY_POLICY_HEADER = 'Content-Security-Policy'.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
+
+      # 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
+        end
+      end
+    end
+  end
+end

data/lib/hanami/config/sessions.rb

@@ -0,0 +1,97 @@
+require 'ipaddr'
+require 'hanami/utils/string'
+
+module Hanami
+  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
+      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.new(@adapter).classify
+                     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
+        if @configuration
+          { domain: domain, secure: @configuration.ssl? }
+        else
+          {}
+        end
+      end
+
+      def domain
+        domain = @configuration.host
+        if !BLACKLISTED_DOMAINS.include?(domain) && !ip_address?(domain)
+          domain
+        end
+      end
+
+      def ip_address?(string)
+        !!IPAddr.new(string) rescue false
+      end
+    end
+  end
+end