hanami-utils 0.9.2 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fed837067b96edc2d9f3b4e3a571e8fb9220dde
-  data.tar.gz: 69075fd83da706506ead576f6040384ab2c75a98
+  metadata.gz: 2ea1ca32894baa365b51feaeddc616f6fa55cc82
+  data.tar.gz: abb789173257a8b131d66a0aa6d1d2e161e1f549
 SHA512:
-  metadata.gz: 5aae813a308bc47f00c68cbeccde7bbe60c797a5c179c1e5e8637ed20dcdb20700b3888cc3901ade12125438960af64edd30779f1af6483347ae100316d91bd8
-  data.tar.gz: e9b15c795ed49e894014b58d7c32ee55259a80a665726658fc72d1f4fdff1183061b3136fcc2231fdf2daf9e10065e54b734ec2d3edc5cac0d6204a33655b5f2
+  metadata.gz: 212099661a2b3be79ca7c2218d5fda126331db1fe6b2625164dac6e2dbf0f1d9bd4f869e31d7c1fc227f96a926815408954abf160a8df852ebbb490ed70fb101
+  data.tar.gz: c21fbd4cfafd99203ae7b796a91d130ba72d382a18a0f57146c7d86fa375b30944f55060d701020b51c4c6af11dd50155ea40bb26397bfabe2ea42bc3c2cc2f0

data/CHANGELOG.md

@@ -1,14 +1,31 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
+## v1.0.0.beta1 - 2017-02-14
+### Added
+- [Luca Guidi] Official support for Ruby: MRI 2.4
+- [alexd16] Introduced `Utils::Hash#deep_symbolize!` for deep symbolization
+- [Luca Guidi] Introduced `Hanami::Utils.reload!` as a mechanism to force code reloading in development
+
+### Fixed
+- [alexd16 & Alfonso Uceda & Luca Guidi] Don't deeply symbolize `Hanami::Interactor::Result` payload
+– [Alfonso Uceda] `Hanami::Interactor::Result`: Don't transform objects that respond to `#to_hash` (like entities)
+- [Bhanu Prakash] Use `Utils::Json.generate` instead of the deprecated `.dump` for `Hanami::Logger` JSON formatter
+- [Luca Guidi] `Hanami::Logger`: when a `Hash` message is passed, don't nest it under `:message` key, but unwrap at the top level
+
+### Changed
+- [alexd16] `Utils::Hash#symbolize!` no longer symbolizes deep structures
+- [Luca Guidi & Alfonso Uceda] Improve readability for default logger formatter
+- [Luca Guidi] Use ISO-8601 time format for JSON logger formatter
+
 ## v0.9.2 - 2016-12-19
-## Added
+### Added
 - [Grachev Mikhail] Introduced `Hanami::Interactor::Result#failure?`
 
-## Fixed
+### Fixed
 - [Paweł Świątkowski] `Utils::Inflector.pluralize` Pluralize -en to -ens instead of -ina 
 
-## Changed
+### Changed
 - [Grachev Mikhail] Deprecate `Hanami::Interactor::Result#failing?` in favor of `#failure?`
 
 ## v0.9.1 - 2016-11-18

data/lib/hanami/interactor.rb

@@ -37,7 +37,7 @@ module Hanami
       # @since 0.3.5
       # @api private
       def initialize(payload = {})
-        @payload = _payload(payload)
+        @payload = payload
         @errors  = []
         @success = true
       end
@@ -125,7 +125,7 @@ module Hanami
       # @since 0.3.5
       # @api private
       def prepare!(payload)
-        @payload.merge!(_payload(payload))
+        @payload.merge!(payload)
         self
       end
 
@@ -144,12 +144,6 @@ module Hanami
         METHODS[method_name] || @payload.key?(method_name)
       end
 
-      # @since 0.3.5
-      # @api private
-      def _payload(payload)
-        Utils::Hash.new(payload).symbolize!
-      end
-
       # @since 0.3.5
       # @api private
       def __inspect
@@ -492,7 +486,7 @@ module Hanami
         include Utils::ClassAttribute
 
         class_attribute :exposures
-        self.exposures = Utils::Hash.new
+        self.exposures = {}
       end
     end
 
@@ -527,7 +521,7 @@ module Hanami
     #   result.params # => NoMethodError
     def expose(*instance_variable_names)
       instance_variable_names.each do |name|
-        exposures[name] = "@#{name}"
+        exposures[name.to_sym] = "@#{name}"
       end
     end
   end

data/lib/hanami/logger.rb

@@ -108,6 +108,10 @@ module Hanami
       # @api private
       NEW_LINE = $/
 
+      # @since 1.0.0.beta1
+      # @api private
+      RESERVED_KEYS = [:app, :severity, :time].freeze
+
       include Utils::ClassAttribute
 
       class_attribute :subclasses
@@ -137,15 +141,19 @@ module Hanami
       # @api private
       attr_writer :application_name
 
+      # @since 1.0.0.beta1
+      # @api private
+      attr_reader :application_name
+
       # @since 0.5.0
       # @api private
       #
       # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Formatter.html#method-i-call
       def call(severity, time, _progname, msg)
         _format({
-          app:      @application_name,
+          app:      application_name,
           severity: severity,
-          time:     time.utc
+          time:     time
         }.merge(
           _message_hash(msg)
         ))
@@ -173,7 +181,27 @@ module Hanami
       # @since 0.8.0
       # @api private
       def _format(hash)
-        hash.map { |k, v| "#{k}=#{v}" }.join(SEPARATOR) + NEW_LINE
+        result = RESERVED_KEYS.map { |k| "[#{hash[k]}]" }.join(SEPARATOR)
+        return _format_error(result, hash) if hash.key?(:error)
+
+        values = hash.each_with_object([]) do |(k, v), memo|
+          memo << v unless RESERVED_KEYS.include?(k)
+        end
+
+        result << " #{values.join(SEPARATOR)}#{NEW_LINE}"
+        result
+      end
+
+      def _format_error(result, hash)
+        result << " #{hash[:error]}:" if hash.key?(:error)
+        result << " #{hash[:message]}#{NEW_LINE}"
+        if hash.key?(:backtrace)
+          hash[:backtrace].each do |line|
+            result << "from #{line}#{NEW_LINE}"
+          end
+        end
+
+        result
       end
     end
 
@@ -192,7 +220,8 @@ module Hanami
       # @since 0.8.0
       # @api private
       def _format(hash)
-        Hanami::Utils::Json.dump(hash)
+        hash[:time] = hash[:time].utc.iso8601
+        Hanami::Utils::Json.generate(hash) + NEW_LINE
       end
     end
 
@@ -201,7 +230,7 @@ module Hanami
     #
     # @since 0.5.0
     # @api private
-    DEFAULT_APPLICATION_NAME = 'Hanami'.freeze
+    DEFAULT_APPLICATION_NAME = 'hanami'.freeze
 
     # @since 0.8.0
     # @api private

data/lib/hanami/utils.rb

@@ -49,11 +49,45 @@ module Hanami
     #
     # @since 0.9.0
     def self.require!(directory)
+      for_each_file_in(directory) { |file| require_relative(file) }
+    end
+
+    # Recursively reload Ruby files under the given directory.
+    #
+    # If the directory is relative, it implies it's the path from current directory.
+    # If the directory is absolute, it uses as it is.
+    #
+    # It respects file separator of the current operating system.
+    # A pattern like <tt>"path/to/files"</tt> will work both on *NIX and Windows machines.
+    #
+    # @param directory [String, Pathname] the directory
+    #
+    # @since 1.0.0.beta1
+    # @api private
+    def self.reload!(directory)
+      for_each_file_in(directory) { |file| load(file) }
+    end
+
+    # Recursively scans through the given directory and yields the given block
+    # for each Ruby source file.
+    #
+    # If the directory is relative, it implies it's the path from current directory.
+    # If the directory is absolute, it uses as it is.
+    #
+    # It respects file separator of the current operating system.
+    # A pattern like <tt>"path/to/files"</tt> will work both on *NIX and Windows machines.
+    #
+    # @param directory [String, Pathname] the directory
+    # @param blk [Proc] the block to yield
+    #
+    # @since 1.0.0.beta1
+    # @api private
+    def self.for_each_file_in(directory, &blk)
       directory = directory.to_s.gsub(%r{(\/|\\)}, File::SEPARATOR)
       directory = Pathname.new(Dir.pwd).join(directory).to_s
       directory = File.join(directory, '**', '*.rb') unless directory =~ /(\*\*)/
 
-      FileList[directory].each { |file| require_relative file }
+      FileList[directory].each(&blk)
     end
   end
 end

data/lib/hanami/utils/basic_object.rb

@@ -35,9 +35,9 @@ module Hanami
         __id__
       end
 
-      # Interface for <tt>pp</pp>
+      # Interface for pp
       #
-      # @return [String] the pretty printable inspection of the object
+      # @return [String] the pretty-printable inspection of the object
       #
       # @since 0.9.0
       #

data/lib/hanami/utils/hash.rb

@@ -48,7 +48,7 @@ module Hanami
         @hash.default_proc = blk
       end
 
-      # Convert in-place all the keys to Symbol instances, nested hashes are converted too.
+      # Convert in-place all the keys to Symbol instances.
       #
       # @return [Hash] self
       #
@@ -61,11 +61,34 @@ module Hanami
       #   hash.symbolize!
       #
       #   hash.keys    # => [:a, :b]
-      #   hash.inspect # => {:a=>23, :b=>{:c=>["x", "y", "z"]}}
+      #   hash.inspect # => { :a => 23, :b => { 'c' => ["x", "y", "z"] } }
       def symbolize!
         keys.each do |k|
           v = delete(k)
-          v = self.class.new(v).symbolize! if v.respond_to?(:to_hash)
+          self[k.to_sym] = v
+        end
+
+        self
+      end
+
+      # Convert in-place all the keys to Symbol instances, nested hashes are converted too.
+      #
+      # @return [Hash] self
+      #
+      # @since 1.0.0.beta1
+      #
+      # @example
+      #   require 'hanami/utils/hash'
+      #
+      #   hash = Hanami::Utils::Hash.new 'a' => 23, 'b' => { 'c' => ['x','y','z'] }
+      #   hash.deep_symbolize!
+      #
+      #   hash.keys    # => [:a, :b]
+      #   hash.inspect # => {:a=>23, :b=>{:c=>["x", "y", "z"]}}
+      def deep_symbolize!
+        keys.each do |k|
+          v = delete(k)
+          v = self.class.new(v).deep_symbolize! if v.respond_to?(:to_hash)
 
           self[k.to_sym] = v
         end

data/lib/hanami/utils/version.rb

@@ -3,6 +3,6 @@ module Hanami
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.9.2'.freeze
+    VERSION = '1.0.0.beta1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-utils
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,9 +91,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8