hanami-utils 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dea1058f5a2e36476b0cce2df0003d62e5b1d59
-  data.tar.gz: 604c338783e3894f7f858b405591690ec29fbac0
+  metadata.gz: 627e0486c780c11f9ce000f6d80b2a8b691b5e45
+  data.tar.gz: 033e15d05ac40fb8ad76174108a4b54b0aeb21ca
 SHA512:
-  metadata.gz: b3044e152c6c5ddafb61facaa9a684f6490cf84c607612ad9c17e3e342b71003a3c734dfb455629548f531cf4a738ac08941c053c1d0439f5ff391661385b08e
-  data.tar.gz: 4f8dc8490e07396d49dbba0655df548e6ce617a7c0414b834235ce99a53ccaec9bcc3461db79201c1b2615296eebb3103c8c0c2e33cf20224e0abef71d84ae9d
+  metadata.gz: 8bc330a6116872fb4a8d072d74fe99d8b961b1c78cdb4e9237b4153283148e704fa3a0d60369b23cb3b733076b7e200fe4ddaafa908a928cc12c3e6e3d1f92e5
+  data.tar.gz: 68670773d3fa4ef2b4d30030fdeb08f52d752a46366c94dd9f8abf0713d95ed91fc33b524ef7c3998bc274bee677a18fe32944f56b34e70dcc431a7a00d0766b

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
+## v1.0.0.beta3 - 2017-03-17
+### Fixed
+- [Luca Guidi] Use `$stdout` instead of `STDOUT` as default stream for `Hanami::Logger`
+
+### Changed
+- [Luca Guidi] Removed `Utils::Attributes`
+- [Luca Guidi] Removed deprecated `Hanami::Interactor::Result#failing?`
+- [Luca Guidi] Removed deprecated `Utils::Json.load` and `.dump`
+
 ## v1.0.0.beta2 - 2017-03-02
 ### Changed
 - [Anton Davydov] Made `Utils::Blank` private API

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2016 Luca Guidi
+Copyright © 2014-2017 Luca Guidi
 
 MIT License
 

data/README.md

@@ -55,10 +55,6 @@ Standardized Service Object with small interface and rich returning result. [[AP
 
 Enhanced version of Ruby's `Logger`. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Logger)]
 
-### Hanami::Utils::Attributes
-
-Set of attributes with indifferent access. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Attributes)]
-
 ### Hanami::Utils::BasicObject
 
 Enhanced version of Ruby's `BasicObject`. [[API doc](http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/BasicObject)]
@@ -134,6 +130,6 @@ __Hanami::Utils__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2016 Luca Guidi – Released under MIT License
+Copyright © 2014-2017 Luca Guidi – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-utils`).

data/lib/hanami/interactor.rb

@@ -1,7 +1,6 @@
 require 'hanami/utils/basic_object'
 require 'hanami/utils/class_attribute'
 require 'hanami/utils/hash'
-require 'hanami/utils/deprecation'
 
 module Hanami
   # Hanami Interactor
@@ -54,18 +53,6 @@ module Hanami
       # @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.9.2
-      #
-      # @deprecated Use {#failure?} instead
-      def failing?
-        Utils::Deprecation.new("`Hanami::Interactor::Result#failing?' is deprecated, please use `Hanami::Interactor::Result#failure?'")
-        failure?
-      end
-
       # Check if the current status is not successful
       #
       # @return [TrueClass,FalseClass] the result of the check

data/lib/hanami/logger.rb

@@ -39,12 +39,12 @@ module Hanami
   # 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)
-  #       # ...
+  #     class CustomFormatter < Formatter
+  #       private
+  #       def _format(hash)
+  #         # ...
+  #       end
   #     end
-  #   end
   #
   # @since 0.5.0
   #
@@ -128,11 +128,13 @@ module Hanami
         end.tap { |f| f.application_name = application_name }
       end
 
+      # @api private
       def self.inherited(subclass)
         super
         subclasses << subclass
       end
 
+      # @api private
       def self.eligible?(name)
         name == :default
       end
@@ -192,6 +194,7 @@ module Hanami
         result
       end
 
+      # @api private
       def _format_error(result, hash)
         result << " #{hash[:error]}:" if hash.key?(:error)
         result << " #{hash[:message]}#{NEW_LINE}"
@@ -211,6 +214,7 @@ module Hanami
     # @since 0.5.0
     # @api private
     class JSONFormatter < Formatter
+      # @api private
       def self.eligible?(name)
         name == :json
       end
@@ -253,10 +257,10 @@ module Hanami
     #   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).
+    # (String) or IO object (typically `$stdout`, `$stderr`, or an open file).
     #
     # @since 0.5.0
-    def initialize(application_name = nil, stream: STDOUT, level: DEBUG, formatter: nil)
+    def initialize(application_name = nil, stream: $stdout, level: DEBUG, formatter: nil)
       super(stream)
 
       @level            = _level(level)

data/lib/hanami/utils/blank.rb

@@ -1,6 +1,7 @@
 module Hanami
   module Utils
     # Checks for blank
+    #
     # @since 0.8.0
     # @api private
     class Blank

data/lib/hanami/utils/callbacks.rb

@@ -170,6 +170,7 @@ module Hanami
 
         private
 
+        # @api private
         def callables(callbacks, block)
           callbacks.push(block) if block
           callbacks.map { |c| Factory.fabricate(c) }
@@ -179,7 +180,7 @@ module Hanami
       # Callback factory
       #
       # @since 0.1.0
-      # @private
+      # @api private
       class Factory
         # Instantiates a `Callback` according to if it responds to #call.
         #
@@ -213,8 +214,9 @@ module Hanami
       # It wraps an object that responds to #call
       #
       # @since 0.1.0
-      # @private
+      # @api private
       class Callback
+        # @api private
         attr_reader :callback
 
         # Initialize by wrapping the given callback
@@ -224,7 +226,7 @@ module Hanami
         # @return [Callback] self
         #
         # @since 0.1.0
-        #
+        # @api private
         def initialize(callback)
           @callback = callback
         end
@@ -237,6 +239,7 @@ module Hanami
         # @return [void, Object] It may return a value, it depends on the callback.
         #
         # @since 0.1.0
+        # @api private
         #
         # @see Hanami::Utils::Callbacks::Chain#run
         def call(context, *args)
@@ -248,7 +251,7 @@ module Hanami
       # It wraps a symbol or a string representing a method name that is implemented by the context within it will be called.
       #
       # @since 0.1.0
-      # @private
+      # @api private
       class MethodCallback < Callback
         # Executes the callback within the given context and eventually passing the given arguments.
         # Those arguments will be passed according to the arity of the target method.
@@ -259,6 +262,7 @@ module Hanami
         # @return [void, Object] It may return a value, it depends on the callback.
         #
         # @since 0.1.0
+        # @api private
         #
         # @see Hanami::Utils::Callbacks::Chain#run
         def call(context, *args)
@@ -271,10 +275,12 @@ module Hanami
           end
         end
 
+        # @api private
         def hash
           callback.hash
         end
 
+        # @api private
         def eql?(other)
           hash == other.hash
         end

data/lib/hanami/utils/class_attribute.rb

@@ -8,6 +8,7 @@ module Hanami
     #
     # @see Hanami::Utils::ClassAttribute::ClassMethods
     module ClassAttribute
+      # @api private
       def self.included(base)
         base.extend ClassMethods
       end
@@ -75,6 +76,7 @@ module Hanami
         protected
 
         # @see Class#inherited
+        # @api private
         def inherited(subclass)
           class_attributes.each do |attr|
             value = send(attr)
@@ -89,7 +91,7 @@ module Hanami
         private
 
         # Class accessor for class attributes.
-        # @private
+        # @api private
         def class_attributes
           @class_attributes ||= Set.new
         end

data/lib/hanami/utils/deprecation.rb

@@ -63,6 +63,7 @@ module Hanami
 
       private
 
+      # @api private
       def caller_index
         Utils.jruby? || Utils.rubinius? ? 1 : 2
       end

data/lib/hanami/utils/escape.rb

@@ -415,7 +415,7 @@ module Hanami
       #   <div>&lt;script&gt;alert(1);&lt;&#x2F;script&gt;</div>
       #
       # @example Bad practice
-      #   # WRONG Use Escape.html_attribute
+      #   # WRONG Use Escape.html_attribute instead
       #   <a title="<%= Hanami::Utils::Escape.html('...') %>">link</a>
       def self.html(input)
         input = encode(input)

data/lib/hanami/utils/inflector.rb

@@ -6,8 +6,6 @@ module Hanami
     # String inflector
     #
     # @since 0.4.1
-    #
-    # rubocop:disable Style/PerlBackrefs
     module Inflector # rubocop:disable Metrics/ModuleLength
       # Rules for irregular plurals
       #
@@ -347,6 +345,7 @@ module Hanami
       # rubocop:disable Metrics/AbcSize
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Style/PerlBackrefs
       def self.pluralize(string)
         return string if string.nil? || string =~ Utils::Blank::STRING_MATCHER
 
@@ -385,6 +384,7 @@ module Hanami
           string + S
         end
       end
+      # rubocop:enable Style/PerlBackrefs
       # rubocop:enable Metrics/AbcSize
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/MethodLength
@@ -402,6 +402,7 @@ module Hanami
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/MethodLength
       # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Style/PerlBackrefs
       def self.singularize(string)
         return string if string.nil? || string =~ Utils::Blank::STRING_MATCHER
 
@@ -448,11 +449,11 @@ module Hanami
           string.chop
         end
       end
+      # rubocop:enable Style/PerlBackrefs
       # rubocop:enable Metrics/AbcSize
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/MethodLength
       # rubocop:enable Metrics/PerceivedComplexity
     end
-    # rubocop:enable Style/PerlBackrefs
   end
 end

data/lib/hanami/utils/json.rb

@@ -4,8 +4,6 @@ rescue LoadError
   require 'json'
 end
 
-require 'hanami/utils/deprecation'
-
 module Hanami
   module Utils
     # JSON wrapper
@@ -26,20 +24,6 @@ module Hanami
           MultiJson.load(payload)
         end
 
-        # FIXME: remove this alias, when Hanami::Utils::Json.load will be removed
-        #
-        # @since 0.9.1
-        # @api private
-        alias load parse
-
-        # FIXME: remove this method, when Hanami::Utils::Json.dump will be removed
-        #
-        # @since 0.9.1
-        # @api private
-        def dump(object)
-          generate(object)
-        end
-
         # @since 0.9.1
         # @api private
         def generate(object)
@@ -57,22 +41,6 @@ module Hanami
       end
       # rubocop:enable Style/ClassVars
 
-      # Load the given JSON payload into Ruby objects.
-      #
-      # @param payload [String] a JSON payload
-      #
-      # @return [Object] the result of the loading process
-      #
-      # @raise [Hanami::Utils::Json::ParserError] if the paylod is invalid
-      #
-      # @since 0.8.0
-      #
-      # @deprecated Use {.parse} instead
-      def self.load(payload)
-        Hanami::Utils::Deprecation.new("`Hanami::Utils::Json.load' is deprecated, please use `Hanami::Utils::Json.parse'")
-        @@engine.load(payload)
-      end
-
       # Parse the given JSON paylod
       #
       # @param payload [String] a JSON payload
@@ -86,20 +54,6 @@ module Hanami
         @@engine.parse(payload)
       end
 
-      # Dump the given object into a JSON payload
-      #
-      # @param object [Object] any object
-      #
-      # @return [String] the result of the dumping process
-      #
-      # @since 0.8.0
-      #
-      # @deprecated Use {.generate} instead
-      def self.dump(object)
-        Hanami::Utils::Deprecation.new("`Hanami::Utils::Json.dump' is deprecated, please use `Hanami::Utils::Json.generate'")
-        @@engine.dump(object)
-      end
-
       # Generate a JSON document from the given object
       #
       # @param object [Object] any object

data/lib/hanami/utils/kernel.rb

@@ -6,11 +6,11 @@ require 'bigdecimal'
 require 'hanami/utils'
 require 'hanami/utils/string'
 
-# Define top level constant Boolean, so it can be easily used by other libraries
-# in coercions DSLs
-#
-# @since 0.3.0
 unless defined?(Boolean)
+  # Define top level constant Boolean, so it can be easily used by other libraries
+  # in coercions DSLs
+  #
+  # @since 0.3.0
   class Boolean
   end
 end
@@ -19,10 +19,7 @@ module Hanami
   module Utils
     # Kernel utilities
     # @since 0.1.1
-    #
-    # rubocop:disable Style/MethodName
-    # rubocop:disable Metrics/ModuleLength
-    module Kernel
+    module Kernel # rubocop:disable Metrics/ModuleLength
       # Matcher for numeric values
       #
       # @since 0.3.3

data/lib/hanami/utils/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-utils
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,7 +57,6 @@ files:
 - lib/hanami/interactor.rb
 - lib/hanami/logger.rb
 - lib/hanami/utils.rb
-- lib/hanami/utils/attributes.rb
 - lib/hanami/utils/basic_object.rb
 - lib/hanami/utils/blank.rb
 - lib/hanami/utils/callbacks.rb

data/lib/hanami/utils/attributes.rb

@@ -1,141 +0,0 @@
-require 'hanami/utils/hash'
-
-module Hanami
-  module Utils
-    # A set of attributes.
-    #
-    # It internally stores the data as a Hash.
-    #
-    # All the operations convert keys to strings.
-    # This strategy avoids memory attacks due to Symbol abuses when parsing
-    # untrusted input.
-    #
-    # At the same time, this allows to get/set data with the original key or
-    # with the string representation. See the examples below.
-    #
-    # @since 0.3.2
-    class Attributes
-      # Initialize a set of attributes
-      # All the keys of the given Hash are recursively converted to strings.
-      #
-      # @param hash [#to_h] a Hash or any object that implements #to_h
-      #
-      # @return [Hanami::Utils::Attributes] self
-      #
-      # @since 0.3.2
-      #
-      # @example
-      #   require 'hanami/utils/attributes'
-      #
-      #   attributes = Hanami::Utils::Attributes.new(a: 1, b: { 2 => [3, 4] })
-      #   attributes.to_h # => { "a" => 1, "b" => { "2" => [3, 4] } }
-      def initialize(hash = {})
-        @attributes = Utils::Hash.new(hash, &nil).stringify!
-      end
-
-      # Get the value associated with the given attribute
-      #
-      # @param attribute [#to_s] a String or any object that implements #to_s
-      #
-      # @return [Object,NilClass] the associated value, if present
-      #
-      # @since 0.3.2
-      #
-      # @example
-      #   require 'hanami/utils/attributes'
-      #
-      #   attributes = Hanami::Utils::Attributes.new(a: 1, 'b' => 2, 23 => 'foo')
-      #
-      #   attributes.get(:a)  # => 1
-      #   attributes.get('a') # => 1
-      #   attributes[:a]      # => 1
-      #   attributes['a']     # => 1
-      #
-      #   attributes.get(:b)  # => 2
-      #   attributes.get('b') # => 2
-      #   attributes[:b]      # => 2
-      #   attributes['b']     # => 2
-      #
-      #   attributes.get(23)   # => "foo"
-      #   attributes.get('23') # => "foo"
-      #   attributes[23]       # => "foo"
-      #   attributes['23']     # => "foo"
-      #
-      #   attributes.get(:unknown)  # => nil
-      #   attributes.get('unknown') # => nil
-      #   attributes[:unknown]      # => nil
-      #   attributes['unknown']     # => nil
-      def get(attribute)
-        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 [] get
-
-      # Set the given value for the given attribute
-      #
-      # @param attribute [#to_s] a String or any object that implements #to_s
-      # @param value [Object] any value
-      #
-      # @return [NilClass]
-      #
-      # @since 0.3.2
-      #
-      # @example
-      #   require 'hanami/utils/attributes'
-      #
-      #   attributes = Hanami::Utils::Attributes.new
-      #
-      #   attributes.set(:a, 1)
-      #   attributes.get(:a)  # => 1
-      #   attributes.get('a') # => 1
-      #
-      #   attributes.set('b', 2)
-      #   attributes.get(:b)  # => 2
-      #   attributes.get('b') # => 2
-      #
-      #   attributes.set(23, 'foo')
-      #   attributes.get(23)   # => "foo"
-      #   attributes.get('23') # => "foo"
-      def set(attribute, value)
-        @attributes[attribute.to_s] = value
-        nil
-      end
-
-      # Returns a deep duplicated copy of the attributes as a Hash
-      #
-      # @return [::Hash]
-      #
-      # @since 0.3.2
-      def to_h
-        ::Hash[].tap do |result|
-          @attributes.each do |k, v|
-            result[k] = _read_value(v)
-          end
-        end
-      end
-
-      private
-
-      # @since 0.4.1
-      # @api private
-      def _read_value(value)
-        case val = value
-        when ::Hash, ::Hanami::Utils::Hash, ->(v) { v.respond_to?(:hanami_nested_attributes?) }
-          val.to_h
-        else
-          val
-        end
-      end
-    end
-  end
-end