hanami-utils 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0ec07bde18ad072abdc5ba80712ccf9976d4139
-  data.tar.gz: 98916abdaf10d4a18848745fe00ba6b497a3e521
+  metadata.gz: 93e8362df57ad7209539ecd8383ee1f1b60ea68e
+  data.tar.gz: 854db004fcc6912bef61404d58feda11e6589d2e
 SHA512:
-  metadata.gz: 459b2bcf58fd4416d95421ed9d0af9995096caef9a32975a51ca69ebd771a8ba4352935f76f26702a1c248a7af256c01e0683101410800f02808761da548eaf7
-  data.tar.gz: 475a12099d5f21b95ccc7965571351e98f8b6eb55a46343952483eac7fdb3cb3f51daaa6818b99c5e991696caeda3a2bcb3910c078deb64e14a82e91f7612f0c
+  metadata.gz: f30cb4ccc8c96a99808534957ec785f8036cd1baf9362bca8e9f8f15cfad044406c5bb34820b6c6b64faf4cc20e3cbd6ef36e08193754adf2c6980ef9a6f5862
+  data.tar.gz: 734d3c0994e2ccba6e9176c497c17c8093693da2b434dbd2476383128a57f83819c7f63382ba39a22057cbd6b72361dd6ec9e51a4989d0c5d070d3c2837f7b1c

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
+## v0.9.0 - 2016-11-15
+### Added
+– [Luca Guidi] Introduced `Utils.require!` to recursively require Ruby files with an order that is consistent across platforms
+– [Luca Guidi] Introduced `Utils::FileList` as cross-platform ordered list of files, alternative to `Dir.glob`
+- [Luca Guidi] Make `Utils::BasicObject` pretty printable 
+- [Grachev Mikhail] Added `Interactor::Result#successful?` and `#failing?`
+
+### Fixed
+- [Pascal Betz] Ensure `Utils::Class.load!` to lookup constant only within the given namespace
+
+### Changed
+- [Luca Guidi] Make `Utils::Hash` only compatible with objects that respond to `#to_hash`
+- [Luca Guidi] Official support for Ruby: MRI 2.3+ and JRuby 9.1.5.0+
+
 ## v0.8.0 - 2016-07-22
 ### Added
 - [Andrey Morskov] Introduced `Hanami::Utils::Blank`

data/README.md

@@ -1,6 +1,6 @@
 # Hanami::Utils
 
-Ruby core extentions and class utilities for [Hanami](http://hanamirb.org)
+Ruby core extensions and class utilities for [Hanami](http://hanamirb.org)
 
 ## Status
 
@@ -22,7 +22,7 @@ Ruby core extentions and class utilities for [Hanami](http://hanamirb.org)
 
 ## Rubies
 
-__Hanami::Utils__ supports Ruby (MRI) 2.2+, JRuby 9.0.5.0+
+__Hanami::Utils__ supports Ruby (MRI) 2.3+, JRuby 9.1.5.0+
 
 ## Installation
 

data/hanami-utils.gemspec

@@ -17,7 +17,7 @@ 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.2.0'
+  spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake',    '~> 11'

data/lib/hanami/interactor.rb

@@ -17,7 +17,14 @@ module Hanami
       # @api private
       #
       # @see Hanami::Interactor::Result#respond_to_missing?
-      METHODS = ::Hash[initialize: true, success?: true, fail!: true, prepare!: true, errors: true, error: true].freeze
+      METHODS = ::Hash[initialize:  true,
+                       success?:    true,
+                       successful?: true,
+                       failing?:    true,
+                       fail!:       true,
+                       prepare!:    true,
+                       errors:      true,
+                       error:       true].freeze
 
       # Initialize a new result
       #
@@ -37,11 +44,23 @@ module Hanami
       #
       # @return [TrueClass,FalseClass] the result of the check
       #
-      # @since 0.3.5
-      def success?
+      # @since 0.8.1
+      def successful?
         @success && errors.empty?
       end
 
+      # @since 0.3.5
+      alias success? successful?
+
+      # Check if the current status is not successful
+      #
+      # @return [TrueClass,FalseClass] the result of the check
+      #
+      # @since 0.8.1
+      def failing?
+        !successful?
+      end
+
       # Force the status to be a failure
       #
       # @since 0.3.5
@@ -202,7 +221,8 @@ module Hanami
       #   end
       #
       #   result = Signup.new(name: 'Luca').call
-      #   result.success? # => true
+      #   result.failing? # => false
+      #   result.successful? # => true
       #
       #   result.user   # => #<User:0x007fa311105778 @id=1 @name="Luca">
       #   result.params # => { :name=>"Luca" }
@@ -232,7 +252,8 @@ module Hanami
       #   end
       #
       #   result = Signup.new(name: nil).call
-      #   result.success? # => false
+      #   result.successful? # => false
+      #   result.failing? # => true
       #
       #   result.user   # => #<User:0x007fa311105778 @id=nil @name="Luca">
       #
@@ -299,7 +320,7 @@ module Hanami
     #   end
     #
     #   result = CreateEmailTest.new(account_id: 1).call
-    #   result.success? # => false
+    #   result.successful? # => false
     def fail!
       @__result.fail!
       throw :fail
@@ -351,7 +372,7 @@ module Hanami
     #   end
     #
     #   result = CreateRecord.new.call
-    #   result.success? # => false
+    #   result.successful? # => false
     #
     #   result.errors # => ["Prepare data error", "Persist error"]
     #   result.logger # => [:prepare_data!, :persist!, :sync!]
@@ -405,7 +426,7 @@ module Hanami
     #   end
     #
     #   result = CreateRecord.new.call
-    #   result.success? # => false
+    #   result.successful? # => false
     #
     #   result.errors # => ["Prepare data error", "Persist error"]
     #   result.logger # => [:prepare_data!, :persist!]

data/lib/hanami/utils.rb

@@ -1,6 +1,10 @@
-require 'hanami/utils/version'
-
+# Hanami - The web, with simplicity
+#
+# @since 0.1.0
 module Hanami
+  require 'hanami/utils/version'
+  require 'hanami/utils/file_list'
+
   # Ruby core extentions and Hanami utilities
   #
   # @since 0.1.0
@@ -32,5 +36,24 @@ module Hanami
     def self.rubinius?
       RUBY_ENGINE == HANAMI_RUBINIUS
     end
+
+    # Recursively require 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 0.9.0
+    def self.require!(directory)
+      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 }
+    end
   end
 end

data/lib/hanami/utils/basic_object.rb

@@ -24,6 +24,28 @@ module Hanami
         "#<#{self.class}:#{'%x' % (__id__ << 1)}#{__inspect}>" # rubocop:disable Style/FormatString
       end
 
+      # Alias for __id__
+      #
+      # @return [Fixnum] the object id
+      #
+      # @since 0.9.0
+      #
+      # @see http://ruby-doc.org/core/Object.html#method-i-object_id
+      def object_id
+        __id__
+      end
+
+      # Interface for <tt>pp</pp>
+      #
+      # @return [String] the pretty printable inspection of the object
+      #
+      # @since 0.9.0
+      #
+      # @see https://ruby-doc.org/stdlib/libdoc/pp/rdoc/PP.html
+      def pretty_print(*)
+        inspect
+      end
+
       # Returns true if responds to the given method.
       #
       # @return [TrueClass,FalseClass] the result of the check

data/lib/hanami/utils/blank.rb

@@ -37,7 +37,7 @@ module Hanami
         when FalseClass, NilClass
           true
         else
-          object.respond_to?(:empty?) ? !!object.empty? : !self
+          object.respond_to?(:empty?) ? object.empty? : !self
         end
       end
     end

data/lib/hanami/utils/class.rb

@@ -38,7 +38,7 @@ module Hanami
       #   # with missing constant
       #   Hanami::Utils::Class.load!('Unknown') # => raises NameError
       def self.load!(name, namespace = Object)
-        namespace.const_get(name.to_s)
+        namespace.const_get(name.to_s, false)
       end
 
       # Loads a class for the given name, only if it's defined.
@@ -69,7 +69,7 @@ module Hanami
       #   # with explicit namespace
       #   Hanami::Utils::Class.load('Service', App) # => App::Service
       def self.load(name, namespace = Object)
-        load!(name, namespace) if namespace.const_defined?(name.to_s)
+        load!(name, namespace) if namespace.const_defined?(name.to_s, false)
       end
 
       # Loads a class from the given pattern name and namespace
@@ -112,7 +112,7 @@ module Hanami
       def self.load_from_pattern!(pattern, namespace = Object)
         String.new(pattern).tokenize do |token|
           begin
-            return namespace.const_get(token)
+            return namespace.const_get(token, false)
           rescue NameError # rubocop:disable Lint/HandleExceptions
           end
         end

data/lib/hanami/utils/file_list.rb

@@ -0,0 +1,20 @@
+module Hanami
+  module Utils
+    # Ordered file list, consistent across operating systems
+    #
+    # @since 0.9.0
+    module FileList
+      # Return an ordered list of files, consistent across operating systems
+      #
+      # It has the same signature of <tt>Dir.glob</tt>, it just guarantees to
+      # order the results before to return them.
+      #
+      # @since 0.9.0
+      #
+      # @see https://ruby-doc.org/core/Dir.html#method-c-glob
+      def self.[](*args)
+        Dir.glob(*args).sort!
+      end
+    end
+  end
+end

data/lib/hanami/utils/hash.rb

@@ -44,7 +44,7 @@ module Hanami
       #
       #   hash.to_h # => { 'foo' => ['bar'] }
       def initialize(hash = {}, &blk)
-        @hash = hash.to_h
+        @hash = hash.to_hash
         @hash.default_proc = blk
       end
 
@@ -65,7 +65,7 @@ module Hanami
       def symbolize!
         keys.each do |k|
           v = delete(k)
-          v = self.class.new(v).symbolize! if v.is_a?(::Hash) || v.is_a?(self.class)
+          v = self.class.new(v).symbolize! if v.respond_to?(:to_hash)
 
           self[k.to_sym] = v
         end
@@ -90,7 +90,7 @@ module Hanami
       def stringify!
         keys.each do |k|
           v = delete(k)
-          v = self.class.new(v).stringify! if v.is_a?(::Hash) || v.is_a?(self.class)
+          v = self.class.new(v).stringify! if v.respond_to?(:to_hash)
 
           self[k.to_s] = v
         end
@@ -224,7 +224,7 @@ module Hanami
       # @see http://www.ruby-doc.org/core/Hash.html#method-i-to_h
       def to_h
         @hash.each_with_object({}) do |(k, v), result|
-          v = v.to_h if v.is_a?(self.class)
+          v = v.to_h if v.respond_to?(:to_hash)
           result[k] = v
         end
       end
@@ -278,13 +278,11 @@ module Hanami
       #
       # @raise [NoMethodError] If doesn't respond to the given method
       def method_missing(m, *args, &blk)
-        if respond_to?(m)
-          h = @hash.__send__(m, *args, &blk)
-          h = self.class.new(h) if h.is_a?(::Hash)
-          h
-        else
-          raise NoMethodError.new(%(undefined method `#{m}' for #{@hash}:#{self.class}))
-        end
+        raise NoMethodError.new(%(undefined method `#{m}' for #{@hash}:#{self.class})) unless respond_to?(m)
+
+        h = @hash.__send__(m, *args, &blk)
+        h = self.class.new(h) if h.is_a?(::Hash)
+        h
       end
 
       # Override Ruby's respond_to_missing? in order to support ::Hash interface

data/lib/hanami/utils/kernel.rb

@@ -10,8 +10,10 @@ require 'hanami/utils/string'
 # in coercions DSLs
 #
 # @since 0.3.0
-class Boolean
-end unless defined?(Boolean)
+unless defined?(Boolean)
+  class Boolean
+  end
+end
 
 module Hanami
   module Utils

data/lib/hanami/utils/load_paths.rb

@@ -110,7 +110,7 @@ module Hanami
       #   paths = Hanami::Utils::LoadPaths.new
       #   paths << '.' << '../..'
       def push(*paths)
-        @paths.push(*paths) # rubocop:disable Performance/PushSplat
+        @paths.push(*paths)
         @paths = Kernel.Array(@paths)
         self
       end

data/lib/hanami/utils/string.rb

@@ -399,13 +399,11 @@ module Hanami
       #
       # @raise [NoMethodError] If doesn't respond to the given method
       def method_missing(m, *args, &blk)
-        if respond_to?(m)
-          s = @string.__send__(m, *args, &blk)
-          s = self.class.new(s) if s.is_a?(::String)
-          s
-        else
-          raise NoMethodError.new(%(undefined method `#{m}' for "#{@string}":#{self.class}))
-        end
+        raise NoMethodError.new(%(undefined method `#{m}' for "#{@string}":#{self.class})) unless respond_to?(m)
+
+        s = @string.__send__(m, *args, &blk)
+        s = self.class.new(s) if s.is_a?(::String)
+        s
       end
 
       # Override Ruby's respond_to_missing? in order to support ::String interface

data/lib/hanami/utils/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-utils
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,7 @@ files:
 - lib/hanami/utils/deprecation.rb
 - lib/hanami/utils/duplicable.rb
 - lib/hanami/utils/escape.rb
+- lib/hanami/utils/file_list.rb
 - lib/hanami/utils/hash.rb
 - lib/hanami/utils/inflector.rb
 - lib/hanami/utils/io.rb
@@ -87,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="