hanami 1.0.0 → 1.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1942d51ca0465a143c823ccd7d0c074dc33b4ff1
-  data.tar.gz: ad0f56731ae8a04ff999473ca7abfbda98f4b429
+  metadata.gz: 0563f150b8f7f4d4d829600edba47e56e22d12a6
+  data.tar.gz: da1e14370a1c34df67516438b1f8b480f0c85f86
 SHA512:
-  metadata.gz: 502ab09ab805fecfed890fda4e291aecd0fd22613017ef19c11beb8f11e296fe2b22e634e673d56ba6301c18d407538ea1840e98b65d1b7650a7d7c303436c77
-  data.tar.gz: 18ff6036ff018c333a9a1e16f9b3eccc8416227b102ba59ebcef77e3d41de81ee5e2ec447c055223bc8dcd0aa7a921b6476a2a426bbd6e8d816e8a8385eba671
+  metadata.gz: 88b3c5a16d520bb93a27d262fd5c77d786095c6d5969c0b1f2d412a8f58c229ebd76225b4c05ecc7bc3d077b3ac411ae92f26d91564e826f6918aef2d9e8a257
+  data.tar.gz: c317261106b08f792784b56ed52e3834926c0a814ac64290345025bd0f0480a3d43b29f1136c10da0410d77d83dd5feaac1bc61e13d1f618da75ecc34439532a

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 # Hanami
 The web, with simplicity.
 
+## v1.1.0.beta1 - 2017-08-11
+### Added
+- [Ben Johnson] Allow to use custom logger as `Hanami.logger` (eg. `Hanami.configure { logger Timber::Logger.new($stdout) }`)
+- [akhramov] Generate spec file for application layout when generating a new app
+- [Anton Davydov] Generate `README.md` file for new projects
+- [Anton Davydov] Selectively boot apps via `HANAMI_APPS=web bundle exec hanami server`
+- [Marion Duprey & Gabriel Gizotti] Log payload (params) for non-GET HTTP requests
+- [Marion Duprey & Gabriel Gizotti] Filter sensitive data in logs
+
+### Fixed
+- [jarosluv] Ensure to remove the correct migration file when executing `hanami db destroy model`
+- [sovetnik] Fix require path for Minitest spec helper
+
 ## v1.0.0 - 2017-04-06
 
 ## v1.0.0.rc1 - 2017-03-31
@@ -19,6 +32,7 @@ The web, with simplicity.
 - [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
+- [Jimmy Börjesson] Make `apps/web/application.rb` code to wrap around the 80th column
 
 ### Changed
 - [Luca Guidi] Removed deprecated `ApplicationConfiguration#default_format`. Use `#default_request_format` instead.

data/FEATURES.md

@@ -3,6 +3,18 @@
 
 ## Features
 
+## v1.1.0 (unreleased)
+
+- One-To-Many association (aka `belongs_to`)
+- One-To-One association (aka `has_one`)
+- Many-To-Many association (aka `has_many :through`)
+- Allow third-party developers to register commands for CLI (eg `hanami generate webpack`)
+- Introduced new extra behaviors for entity manual schema: `:schema` (default), `:strict`, `:weak`, and `:permissive`
+- Custom logger for `Hanami.logger`
+- Selectively boot apps via `HANAMI_APPS=web` env var
+- Log payload (params) for non-GET HTTP requests
+- Filter sensitive data in logs
+
 ### v1.0.0 - 2017-04-06
 
 - Logger rotation

data/README.md

@@ -25,6 +25,7 @@ which provides the glue that ties all the parts together:
 * [**Hanami::Helpers**](https://github.com/hanami/helpers) - View helpers for Ruby applications
 * [**Hanami::Mailer**](https://github.com/hanami/mailer) - Mail for Ruby applications
 * [**Hanami::Assets**](https://github.com/hanami/assets) - Assets management for Ruby
+* [**Hanami::CLI**](https://github.com/hanami/cli) - Ruby command line interface
 * [**Hanami::Utils**](https://github.com/hanami/utils) - Ruby core extensions and class utilities
 
 These components are designed to be used independently or together in a Hanami application.
@@ -52,7 +53,9 @@ You can give back to Open Source, by supporting Hanami development via a [donati
 
 ### Supporters
 
+  * [Trung Lê](https://github.com/joneslee85)
   * [James Carlson](https://github.com/jxxcarlson)
+  * [Creditas](https://www.creditas.com.br/)
 
 ## Contact
 

data/bin/hanami

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-
 require 'bundler'
-require 'hanami/cli'
-Hanami::Cli.start
+require 'hanami/cli/commands'
+
+Hanami::CLI.new(Hanami::CLI::Commands).call

data/hanami.gemspec

@@ -21,16 +21,16 @@ Gem::Specification.new do |spec|
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.add_dependency 'hanami-utils',       '~> 1.0'
-  spec.add_dependency 'hanami-validations', '~> 1.0'
-  spec.add_dependency 'hanami-router',      '~> 1.0'
-  spec.add_dependency 'hanami-controller',  '~> 1.0'
-  spec.add_dependency 'hanami-view',        '~> 1.0'
-  spec.add_dependency 'hanami-helpers',     '~> 1.0'
-  spec.add_dependency 'hanami-mailer',      '~> 1.0'
-  spec.add_dependency 'hanami-assets',      '~> 1.0'
+  spec.add_dependency 'hanami-utils',       '1.1.0.beta1'
+  spec.add_dependency 'hanami-validations', '1.1.0.beta1'
+  spec.add_dependency 'hanami-router',      '1.1.0.beta1'
+  spec.add_dependency 'hanami-controller',  '1.1.0.beta1'
+  spec.add_dependency 'hanami-view',        '1.1.0.beta1'
+  spec.add_dependency 'hanami-helpers',     '1.1.0.beta1'
+  spec.add_dependency 'hanami-mailer',      '1.1.0.beta1'
+  spec.add_dependency 'hanami-assets',      '1.1.0.beta1'
+  spec.add_dependency 'hanami-cli',         '0.1.0.beta1'
   spec.add_dependency 'concurrent-ruby',    '~> 1.0'
-  spec.add_dependency 'thor',               '~> 0.19'
   spec.add_dependency 'bundler',            '~> 1.13'
 
   spec.add_development_dependency 'rspec',     '~>  3.5'

data/lib/hanami.rb

@@ -118,6 +118,33 @@ module Hanami
     App.new(configuration, environment)
   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')
+
+    allowed_apps = ENV['HANAMI_APPS'].to_s.split(',')
+    allowed_apps.include?(app.to_s.downcase)
+  end
+
   # Return root of the project (top level directory).
   #
   # @return [Pathname] root path

data/lib/hanami/action/routing_helpers.rb

@@ -25,7 +25,7 @@ module Hanami
     #   end
     module RoutingHelpers
       def self.included(base)
-        factory = "#{Utils::String.new(base).namespace}.routes"
+        factory = "#{Utils::String.namespace(base)}.routes"
 
         base.class_eval <<-END_EVAL, __FILE__, __LINE__
           private

data/lib/hanami/application_configuration.rb

@@ -1012,10 +1012,6 @@ module Hanami
 
     # Defines a relative pattern to find controllers.
     #
-    # Hanami supports multiple architectures (aka application structures), this
-    # setting helps to understand the namespace where to find applications'
-    # controllers and actions.
-    #
     # By default this equals to <tt>"Controllers::%{controller}::%{action}"</tt>
     # That means controllers must be structured like this:
     # <tt>Bookshelf::Controllers::Dashboard::Index</tt>, where <tt>Bookshelf</tt>
@@ -1143,10 +1139,6 @@ module Hanami
 
     # Defines a relative pattern to find views:.
     #
-    # Hanami supports multiple architectures (aka application structures), this
-    # setting helps to understand the namespace where to find applications'
-    # views:.
-    #
     # By default this equals to <tt>"Views::%{controller}::%{action}"</tt>
     # That means views must be structured like this:
     # <tt>Bookshelf::Views::Dashboard::Index</tt>, where <tt>Bookshelf</tt> is

data/lib/hanami/application_name.rb

@@ -102,9 +102,7 @@ module Hanami
     # @since 0.2.1
     # @api private
     def sanitize(name)
-      Utils::String.new(
-        name.strip
-      ).namespace.underscore.to_s
+      Utils::String.transform(name.strip, :namespace, :underscore)
     end
   end
 end

data/lib/hanami/application_namespace.rb

@@ -7,7 +7,7 @@ module Hanami
     # @api private
     def self.resolve(name)
       Utils::Class.load!(
-        Utils::String.new(name).namespace
+        Utils::String.namespace(name)
       )
     end
   end

data/lib/hanami/cli/commands.rb

@@ -0,0 +1,101 @@
+require 'hanami/cli'
+require 'ostruct'
+
+module Hanami
+  # Hanami CLI
+  #
+  # @since 1.1.0
+  class CLI
+    # Register a command to expand Hanami CLI
+    #
+    # @param name [String] the command name
+    # @param command [NilClass,Hanami::CLI::Command,Hanami::CLI::Commands::Command]
+    #   the optional command
+    # @param aliases [Array<String>] an optional list of aliases
+    #
+    # @since 1.1.0
+    #
+    # @example Third party gem
+    #   require "hanami/cli/commands"
+    #
+    #   module Hanami
+    #     module Webpack
+    #       module CLI
+    #         module Commands
+    #           class Generate < Hanami::CLI::Command
+    #             desc "Generate Webpack config"
+    #
+    #             def call(*)
+    #               # ...
+    #             end
+    #           end
+    #         end
+    #       end
+    #     end
+    #   end
+    #
+    #   Hanami::CLI.register "generate webpack", Hanami::Webpack::CLI::Commands::Generate
+    #
+    #   # $ bundle exec hanami generate
+    #   # Commands:
+    #   #   hanami generate action APP ACTION                    # Generate an action for app
+    #   #   hanami generate app APP                              # Generate an app
+    #   #   hanami generate mailer MAILER                        # Generate a mailer
+    #   #   hanami generate migration MIGRATION                  # Generate a migration
+    #   #   hanami generate model MODEL                          # Generate a model
+    #   #   hanami generate secret [APP]                         # Generate session secret
+    #   #   hanami generate webpack                              # Generate Webpack configuration
+    def self.register(name, command = nil, aliases: [], &blk)
+      Commands.register(name, command, aliases: aliases, &blk)
+    end
+
+    # CLI commands registry
+    #
+    # @since 1.1.0
+    # @api private
+    module Commands
+      extend Hanami::CLI::Registry
+
+      # CLI command context
+      #
+      # @since 1.1.0
+      # @api private
+      class Context < OpenStruct
+        # @since 1.1.0
+        # @api private
+        def initialize(data)
+          data = data.each_with_object({}) do |(k, v), result|
+            v = Utils::String.new(v) if v.is_a?(::String)
+            result[k] = v
+          end
+
+          super(data)
+          freeze
+        end
+
+        # @since 1.1.0
+        # @api private
+        def with(data)
+          self.class.new(to_h.merge(data))
+        end
+
+        # @since 1.1.0
+        # @api private
+        def binding
+          super
+        end
+      end
+
+      require "hanami/cli/commands/command"
+      require "hanami/cli/commands/assets"
+      require "hanami/cli/commands/console"
+      require "hanami/cli/commands/db"
+      require "hanami/cli/commands/destroy"
+      require "hanami/cli/commands/generate"
+      require "hanami/cli/commands/new"
+      require "hanami/cli/commands/routes"
+      require "hanami/cli/commands/server"
+      require "hanami/cli/commands/version"
+    end
+  end
+end

data/lib/hanami/cli/commands/assets.rb

@@ -0,0 +1,16 @@
+module Hanami
+  # Hanami CLI
+  #
+  # @since 1.1.0
+  class CLI
+    module Commands
+      # @since 1.1.0
+      # @api private
+      module Assets
+        require "hanami/cli/commands/assets/precompile"
+      end
+    end
+
+    register "assets precompile", Commands::Assets::Precompile
+  end
+end

data/lib/hanami/cli/commands/assets/precompile.rb

@@ -0,0 +1,42 @@
+module Hanami
+  class CLI
+    module Commands
+      module Assets
+        # @since 1.1.0
+        # @api private
+        class Precompile < Command
+          requires "apps.assets.configurations"
+
+          desc "Precompile assets for deployment"
+
+          example [
+            "                      # Basic usage",
+            "HANAMI_ENV=production # Precompile assets for production environment"
+          ]
+
+          # @since 1.1.0
+          # @api private
+          def call(**options)
+            context = Context.new(options: options)
+
+            precompile_assets(context)
+          end
+
+          private
+
+          # @since 1.1.0
+          # @api private
+          def precompile_assets(*)
+            Hanami::Assets.precompile(configurations)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def configurations
+            requirements['apps.assets.configurations']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/command.rb

@@ -0,0 +1,180 @@
+require 'hanami'
+require 'hanami/environment'
+require 'hanami/components'
+require 'hanami/cli/command'
+require 'hanami/cli/commands/project'
+require 'hanami/cli/commands/templates'
+require 'concurrent'
+require 'hanami/utils/files'
+require 'erb'
+
+module Hanami
+  # Hanami CLI
+  #
+  # @since 1.1.0
+  class CLI
+    module Commands
+      # Abstract command
+      #
+      # @since 1.1.0
+      class Command < Hanami::CLI::Command
+        # @since 1.1.0
+        # @api private
+        def self.inherited(component)
+          super
+
+          component.class_eval do
+            @_requirements = Concurrent::Array.new
+            extend ClassMethods
+            prepend InstanceMethods
+          end
+        end
+
+        # Class level interface
+        #
+        # @since 1.1.0
+        module ClassMethods
+          # Requires an internal Hanami component
+          #
+          # @param names [Array<String>] the name of one or more components
+          #
+          # @since 1.1.0
+          #
+          # @example
+          #   require "hanami/cli/commands"
+          #
+          #   module HanamiDatabaseHelpers
+          #     class TruncateTables < Hanami::CLI::Commands::Command
+          #       requires "model.configuration"
+          #
+          #       def call(*)
+          #         url = requirements["model.configuration"].url
+          #         # ...
+          #       end
+          #     end
+          #   end
+          #
+          #   Hanami::CLI.register "db truncate", HanamiDatabaseHelpers::TruncateTables
+          def requires(*names)
+            requirements.concat(names)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def requirements
+            @_requirements
+          end
+        end
+
+        # @since 1.1.0
+        # @api private
+        module InstanceMethods
+          # @since 1.1.0
+          # @api private
+          def call(**options)
+            if self.class.requirements.any?
+              environment = Hanami::Environment.new(options)
+              environment.require_project_environment
+
+              requirements.resolved('environment', environment)
+              requirements.resolve(self.class.requirements)
+
+              options = environment.to_options.merge(options)
+            end
+
+            super(options)
+          rescue StandardError => e
+            warn e.message
+            exit(1)
+          end
+        end
+
+        # @since 1.1.0
+        # @api private
+        def initialize(command_name:, out: $stdout, files: Utils::Files)
+          super(command_name: command_name)
+
+          @out       = out
+          @files     = files
+          @templates = Templates.new(self.class)
+        end
+
+        private
+
+        # Template renderer
+        #
+        # @since 1.1.0
+        # @api private
+        class Renderer
+          # @since 1.1.0
+          # @api private
+          TRIM_MODE = "-".freeze
+
+          # @since 1.1.0
+          # @api private
+          def initialize
+            freeze
+          end
+
+          # @since 1.1.0
+          # @api private
+          def call(template, context)
+            ::ERB.new(template, nil, TRIM_MODE).result(context)
+          end
+        end
+
+        # @since 1.1.0
+        # @api private
+        SAY_FORMATTER = "%<operation>12s  %<path>s\n".freeze
+
+        # @since 1.1.0
+        # @api private
+        attr_reader :out
+
+        # @since 1.1.0
+        # @api private
+        attr_reader :files
+
+        # @since 1.1.0
+        # @api private
+        attr_reader :templates
+
+        # @since 1.1.0
+        # @api private
+        def render(path, context)
+          template = File.read(path)
+          renderer = Renderer.new
+
+          renderer.call(template, context.binding)
+        end
+
+        # @since 1.1.0
+        # @api private
+        def generate_file(source, destination, context)
+          files.write(
+            destination,
+            render(source, context)
+          )
+        end
+
+        # @since 1.1.0
+        # @api private
+        def say(operation, path)
+          out.puts(SAY_FORMATTER % { operation: operation, path: path }) # rubocop:disable Style/FormatString
+        end
+
+        # @since 1.1.0
+        # @api private
+        def project
+          Project
+        end
+
+        # @since 1.1.0
+        # @api private
+        def requirements
+          Hanami::Components
+        end
+      end
+    end
+  end
+end