hanami-utils 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cbb5f4adac5f75b2e56d9cb8bc2f2a5b91cf5e5
-  data.tar.gz: da1b1e8502a4b5fd322bfd9ee660d8b4a1c8d9c8
+  metadata.gz: e0ec07bde18ad072abdc5ba80712ccf9976d4139
+  data.tar.gz: 98916abdaf10d4a18848745fe00ba6b497a3e521
 SHA512:
-  metadata.gz: 268645d9ea4cb481333cee4315e51e466c3d1900417622d69139f02111a7a0cde5a9e36714a69ddb5c942a51c903420793d7421018a46440c0f7b483563f43ca
-  data.tar.gz: 3784235c1726f07be68e41a8f1d7ae67f0e0dbf4c760bb20f6dfaac994e2146c946042f903eb8549a742b0ce5ae94af77348bdac2dc7d86c59b12ee5089e0783
+  metadata.gz: 459b2bcf58fd4416d95421ed9d0af9995096caef9a32975a51ca69ebd771a8ba4352935f76f26702a1c248a7af256c01e0683101410800f02808761da548eaf7
+  data.tar.gz: 475a12099d5f21b95ccc7965571351e98f8b6eb55a46343952483eac7fdb3cb3f51daaa6818b99c5e991696caeda3a2bcb3910c078deb64e14a82e91f7612f0c

data/CHANGELOG.md

@@ -1,9 +1,22 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
-## v0.7.2 - 2016-05-20
+## v0.8.0 - 2016-07-22
+### Added
+- [Andrey Morskov] Introduced `Hanami::Utils::Blank`
+- [Anton Davydov] Allow to specify a default log level for `Hanami::Logger`
+- [Anton Davydov] Introduced default and JSON formatters for `Hanami::Logger`
+- [Erol Fornoles] Allow deep indifferent access for `Hanami::Utils::Attributes`
+- [Anton Davydov] Introduced `Hanami::Utils::Json` which is a proxy for `MultiJson` (from `multi_json` gem), or fallback to `JSON` from Ruby standard library.
+
 ### Fixed
-- [Luca Guidi] Make `Hanami::Utils::Kernel.BigDecimal` to convert negative `BigDecimal` or `BigDecimal` with negative exponent.
+
+- [Hiếu Nguyễn] Ensure `Hanami::Utils::String#classify` to return already classified strings as they are. Eg. `"AwesomeProject"` should return `"AwesomeProject"`, not `"Awesomeproject"`.
+- [TheSmartnik] Fix English pluralization for words ending with `"rses"`
+- [Rogério Ramos] Fix English pluralization for words ending with `"ice"`
+
+### Changed
+- [Luca Guidi] Drop support for Ruby 2.0, 2.1 and Rubinius. Official support for JRuby 9.0.5.0+.
 
 ## v0.7.1 - 2016-02-05
 ### Fixed

data/README.md

@@ -22,7 +22,7 @@ Ruby core extentions and class utilities for [Hanami](http://hanamirb.org)
 
 ## Rubies
 
-__Hanami::Utils__ supports Ruby (MRI) 2.2+, JRuby 9k+
+__Hanami::Utils__ supports Ruby (MRI) 2.2+, JRuby 9.0.5.0+
 
 ## Installation
 
@@ -63,6 +63,10 @@ Set of attributes with indifferent access. [[API doc](http://www.rubydoc.info/ge
 
 Enhanced version of Ruby's `BasicObject`. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/BasicObject)]
 
+### Hanami::Utils::Blank
+
+Checks for blank. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Blank)]
+
 ### Hanami::Utils::Callbacks
 
 Callbacks to decorate methods with `before` and `after` logic. It supports polymorphic callbacks (methods and procs). [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Callbacks)]

data/hanami-utils.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Hanami::Utils::VERSION
   spec.authors       = ['Luca Guidi', 'Trung Lê', 'Alfonso Uceda']
   spec.email         = ['me@lucaguidi.com', 'trung.le@ruby-journal.com', 'uceda73@gmail.com']
-  spec.description   = %q{Hanami utilities}
-  spec.summary       = %q{Ruby core extentions and Hanami utilities}
+  spec.description   = 'Hanami utilities'
+  spec.summary       = 'Ruby core extentions and Hanami utilities'
   spec.homepage      = 'http://hanamirb.org'
   spec.license       = 'MIT'
 
@@ -17,9 +17,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_development_dependency 'bundler',  '~> 1.6'
-  spec.add_development_dependency 'rake',     '~> 10'
-  spec.add_development_dependency 'minitest', '~> 5.4'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake',    '~> 11'
 end

data/lib/hanami-utils.rb

@@ -1 +1 @@
-require 'hanami/utils'
+require 'hanami/utils' # rubocop:disable Style/FileName

data/lib/hanami/interactor.rb

@@ -17,7 +17,7 @@ module Hanami
       # @api private
       #
       # @see Hanami::Interactor::Result#respond_to_missing?
-      METHODS = {initialize: true, success?: true, fail!: true, prepare!: true, errors: true, error: true}.freeze
+      METHODS = ::Hash[initialize: true, success?: true, fail!: true, prepare!: true, errors: true, error: true].freeze
 
       # Initialize a new result
       #
@@ -97,6 +97,7 @@ module Hanami
       end
 
       protected
+
       # @since 0.3.5
       # @api private
       def method_missing(m, *)
@@ -105,7 +106,7 @@ module Hanami
 
       # @since 0.3.5
       # @api private
-      def respond_to_missing?(method_name, include_all)
+      def respond_to_missing?(method_name, _include_all)
         method_name = method_name.to_sym
         METHODS[method_name] || @payload.key?(method_name)
       end
@@ -119,7 +120,7 @@ module Hanami
       # @since 0.3.5
       # @api private
       def __inspect
-        " @success=#{ @success } @payload=#{ @payload.inspect }"
+        " @success=#{@success} @payload=#{@payload.inspect}"
       end
     end
 
@@ -251,6 +252,7 @@ module Hanami
     end
 
     private
+
     # Check if proceed with <tt>#call</tt> invokation.
     # By default it returns <tt>true</tt>.
     #
@@ -459,7 +461,7 @@ module Hanami
       end
     end
 
-    # Expose local instance variables into the returing value of <tt>#call</tt>
+    # Expose local instance variables into the returning value of <tt>#call</tt>
     #
     # @param instance_variable_names [Symbol,Array<Symbol>] one or more instance
     #   variable names
@@ -490,7 +492,7 @@ module Hanami
     #   result.params # => NoMethodError
     def expose(*instance_variable_names)
       instance_variable_names.each do |name|
-        exposures[name] = "@#{ name }"
+        exposures[name] = "@#{name}"
       end
     end
   end

data/lib/hanami/logger.rb

@@ -1,34 +1,51 @@
+require 'set'
+require 'json'
 require 'logger'
 require 'hanami/utils/string'
+require 'hanami/utils/json'
+require 'hanami/utils/class_attribute'
 
 module Hanami
   # Hanami logger
   #
   # Implement with the same interface of Ruby std lib `Logger`.
-  # It uses `STDOUT` as output device.
-  #
+  # It uses `STDOUT`, `STDERR`, file name or open file as output stream.
   #
   #
   # When a Hanami application is initialized, it creates a logger for that specific application.
   # For instance for a `Bookshelf::Application` a `Bookshelf::Logger` will be available.
   #
-  # This is useful for auto-tagging the output. Eg (`[Booshelf]`).
-  #
-  # When used stand alone (eg. `Hanami::Logger.info`), it tags lines with `[Shared]`.
+  # This is useful for auto-tagging the output. Eg (`app=Booshelf`).
   #
+  # When used stand alone (eg. `Hanami::Logger.info`), it tags lines with `app=Shared`.
   #
   #
   # The available severity levels are the same of `Logger`:
   #
-  #   * debug
-  #   * error
-  #   * fatal
-  #   * info
-  #   * unknown
-  #   * warn
+  #   * DEBUG
+  #   * INFO
+  #   * WARN
+  #   * ERROR
+  #   * FATAL
+  #   * UNKNOWN
   #
   # Those levels are available both as class and instance methods.
   #
+  # Also Hanami::Logger support different formatters. Now available only two:
+  #
+  #   * Formatter (default)
+  #   * JSONFormatter
+  #
+  # And if you want to use custom formatter you need create new class inherited from
+  # `Formatter` class and define `_format` private method like this:
+  #
+  #   class CustomFormatter < Formatter
+  #     private
+  #     def _format(hash)
+  #       # ...
+  #     end
+  #   end
+  #
   # @since 0.5.0
   #
   # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html
@@ -47,34 +64,75 @@ module Hanami
   #   # or
   #   Bookshelf::Application.new
   #
-  #   Bookshelf::Logger.info('Hello')
-  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [Bookshelf] : Hello
-  #
   #   Bookshelf::Logger.new.info('Hello')
-  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [Bookshelf] : Hello
+  #   # => app=Bookshelf severity=INFO time=1988-09-01 00:00:00 UTC message=Hello
   #
   # @example Standalone usage
-  #   require 'hanami'
-  #
-  #   Hanami::Logger.info('Hello')
-  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [Hanami] : Hello
+  #   require 'hanami/logger'
   #
   #   Hanami::Logger.new.info('Hello')
-  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [Hanami] : Hello
+  #   # => app=Hanami severity=INFO time=2016-05-27 10:14:42 UTC message=Hello
   #
   # @example Custom tagging
-  #   require 'hanami'
+  #   require 'hanami/logger'
   #
   #   Hanami::Logger.new('FOO').info('Hello')
-  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [FOO] : Hello
+  #   # => app=FOO severity=INFO time=2016-05-27 10:14:42 UTC message=Hello
+  #
+  # @example Write to file
+  #   require 'hanami'
+  #
+  #   Hanami::Logger.new(stream: 'logfile.log').info('Hello')
+  #   # in logfile.log
+  #   # => app=FOO severity=INFO time=2016-05-27 10:14:42 UTC message=Hello
+  #
+  # @example Use JSON formatter
+  #   require 'hanami'
+  #
+  #   Hanami::Logger.new(formatter: Hanami::Logger::JSONFormatter).info('Hello')
+  #   # => "{\"app\":\"Hanami\",\"severity\":\"INFO\",\"time\":\"1988-09-01 00:00:00 UTC\",\"message\":\"Hello\"}"
   class Logger < ::Logger
-    # Hanami::Logger default formatter
+    # Hanami::Logger default formatter.
+    # This formatter returns string in key=value format.
     #
     # @since 0.5.0
     # @api private
     #
     # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Formatter.html
     class Formatter < ::Logger::Formatter
+      # @since 0.8.0
+      # @api private
+      SEPARATOR = ' '.freeze
+
+      # @since 0.8.0
+      # @api private
+      NEW_LINE = $/
+
+      include Utils::ClassAttribute
+
+      class_attribute :subclasses
+      self.subclasses = Set.new
+
+      def self.fabricate(formatter, application_name)
+        case formatter
+        when Symbol
+          (subclasses.find { |s| s.eligible?(formatter) } || self).new
+        when nil
+          new
+        else
+          formatter
+        end.tap { |f| f.application_name = application_name }
+      end
+
+      def self.inherited(subclass)
+        super
+        subclasses << subclass
+      end
+
+      def self.eligible?(name)
+        name == :default
+      end
+
       # @since 0.5.0
       # @api private
       attr_writer :application_name
@@ -83,9 +141,58 @@ module Hanami
       # @api private
       #
       # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Formatter.html#method-i-call
-      def call(severity, time, progname, msg)
-        progname = "[#{@application_name}] #{progname}"
-        super(severity, time.utc, progname, msg)
+      def call(severity, time, _progname, msg)
+        _format({
+          app:      @application_name,
+          severity: severity,
+          time:     time.utc
+        }.merge(
+          _message_hash(msg)
+        ))
+      end
+
+      private
+
+      # @since 0.8.0
+      # @api private
+      def _message_hash(message) # rubocop:disable Metrics/MethodLength
+        case message
+        when Hash
+          message
+        when Exception
+          Hash[
+            message:   message.message,
+            backtrace: message.backtrace || [],
+            error:     message.class
+          ]
+        else
+          Hash[message: message]
+        end
+      end
+
+      # @since 0.8.0
+      # @api private
+      def _format(hash)
+        hash.map { |k, v| "#{k}=#{v}" }.join(SEPARATOR) + NEW_LINE
+      end
+    end
+
+    # Hanami::Logger JSON formatter.
+    # This formatter returns string in JSON format.
+    #
+    # @since 0.5.0
+    # @api private
+    class JSONFormatter < Formatter
+      def self.eligible?(name)
+        name == :json
+      end
+
+      private
+
+      # @since 0.8.0
+      # @api private
+      def _format(hash)
+        Hanami::Utils::Json.dump(hash)
       end
     end
 
@@ -96,6 +203,17 @@ module Hanami
     # @api private
     DEFAULT_APPLICATION_NAME = 'Hanami'.freeze
 
+    # @since 0.8.0
+    # @api private
+    LEVELS = Hash[
+      'debug'   => DEBUG,
+      'info'    => INFO,
+      'warn'    => WARN,
+      'error'   => ERROR,
+      'fatal'   => FATAL,
+      'unknown' => UNKNOWN
+    ].freeze
+
     # @since 0.5.0
     # @api private
     attr_writer :application_name
@@ -105,12 +223,17 @@ module Hanami
     # @param application_name [String] an optional application name used for
     #   tagging purposes
     #
+    # @param stream [String, IO, StringIO, Pathname] an optional log stream. This is a filename
+    # (String) or IO object (typically STDOUT, STDERR, or an open file).
+    #
     # @since 0.5.0
-    def initialize(application_name = nil)
-      super(STDOUT)
+    def initialize(application_name = nil, stream: STDOUT, level: DEBUG, formatter: nil)
+      super(stream)
 
+      @level            = _level(level)
+      @stream           = stream
       @application_name = application_name
-      @formatter        = Hanami::Logger::Formatter.new.tap { |f| f.application_name = self.application_name }
+      @formatter        = Formatter.fabricate(formatter, self.application_name)
     end
 
     # Returns the current application name, this is used for tagging purposes
@@ -122,14 +245,28 @@ module Hanami
       @application_name || _application_name_from_namespace || _default_application_name
     end
 
+    # @since 0.8.0
+    # @api private
+    def level=(value)
+      super _level(value)
+    end
+
+    # Close the logging stream if this stream isn't an STDOUT
+    #
+    # @since 0.8.0
+    def close
+      super unless [STDOUT, $stdout].include?(@stream)
+    end
+
     private
+
     # @since 0.5.0
     # @api private
     def _application_name_from_namespace
       class_name = self.class.name
       namespace  = Utils::String.new(class_name).namespace
 
-      class_name != namespace and return namespace
+      class_name != namespace and return namespace # rubocop:disable Style/AndOr
     end
 
     # @since 0.5.0
@@ -137,5 +274,16 @@ module Hanami
     def _default_application_name
       DEFAULT_APPLICATION_NAME
     end
+
+    # @since 0.8.0
+    # @api private
+    def _level(level)
+      case level
+      when DEBUG..UNKNOWN
+        level
+      else
+        LEVELS.fetch(level.to_s.downcase, DEBUG)
+      end
+    end
   end
 end

data/lib/hanami/utils/attributes.rb

@@ -66,11 +66,20 @@ module Hanami
       #   attributes[:unknown]      # => nil
       #   attributes['unknown']     # => nil
       def get(attribute)
-        @attributes[attribute.to_s]
+        value = @attributes
+
+        keys = attribute.to_s.split('.')
+        keys.each do |key|
+          break unless value
+
+          value = value[key]
+        end
+
+        value.is_a?(Hash) ? self.class.new(value) : value
       end
 
       # @since 0.3.4
-      alias_method :[], :get
+      alias [] get
 
       # Set the given value for the given attribute
       #