hanami-utils 1.0.0.beta3 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 627e0486c780c11f9ce000f6d80b2a8b691b5e45
-  data.tar.gz: 033e15d05ac40fb8ad76174108a4b54b0aeb21ca
+  metadata.gz: 451f3a95a054ee9c8b43e77ff9b508606c587cd4
+  data.tar.gz: 6290517874803863fbbb295739a7d25e4d3e6b61
 SHA512:
-  metadata.gz: 8bc330a6116872fb4a8d072d74fe99d8b961b1c78cdb4e9237b4153283148e704fa3a0d60369b23cb3b733076b7e200fe4ddaafa908a928cc12c3e6e3d1f92e5
-  data.tar.gz: 68670773d3fa4ef2b4d30030fdeb08f52d752a46366c94dd9f8abf0713d95ed91fc33b524ef7c3998bc274bee677a18fe32944f56b34e70dcc431a7a00d0766b
+  metadata.gz: 677588b9ad278e4496e0a08025e6f73efbcf4eaebfcb2e3a47f722fa39017217cfe1cbf9602c3593b6c691e3bda7e7bfb3f60b7b3463402c592b5840265a0585
+  data.tar.gz: e4c52ea6103c19e69b18802a31719da59c6ff14fc48e509e26dffd5750432300467b857bf6c60a8db91a5de0a4134e7b61b02c219c7281e872003459b9d6348a

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
+## v1.0.0.rc1 - 2017-03-31
+### Added
+- [Luca Guidi] Allow `Hanami::Logger#initialize` to accept arguments to be compliant with Ruby's `Logger`
+
 ## v1.0.0.beta3 - 2017-03-17
 ### Fixed
 - [Luca Guidi] Use `$stdout` instead of `STDOUT` as default stream for `Hanami::Logger`

data/hanami-utils.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hanami/utils/version'
@@ -6,8 +7,8 @@ require 'hanami/utils/version'
 Gem::Specification.new do |spec|
   spec.name          = 'hanami-utils'
   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.authors       = ['Luca Guidi']
+  spec.email         = ['me@lucaguidi.com']
   spec.description   = 'Hanami utilities'
   spec.summary       = 'Ruby core extentions and Hanami utilities'
   spec.homepage      = 'http://hanamirb.org'

data/lib/hanami/interactor.rb

@@ -21,7 +21,6 @@ module Hanami
                        success?:    true,
                        successful?: true,
                        failure?:    true,
-                       failing?:    true,
                        fail!:       true,
                        prepare!:    true,
                        errors:      true,
@@ -211,12 +210,12 @@ module Hanami
       #     end
       #
       #     def call
-      #       @user = UserRepository.persist(@user)
+      #       @user = UserRepository.new.persist(@user)
       #     end
       #   end
       #
       #   result = Signup.new(name: 'Luca').call
-      #   result.failing? # => false
+      #   result.failure? # => false
       #   result.successful? # => true
       #
       #   result.user   # => #<User:0x007fa311105778 @id=1 @name="Luca">
@@ -237,7 +236,7 @@ module Hanami
       #
       #     # THIS WON'T BE INVOKED BECAUSE #valid? WILL RETURN false
       #     def call
-      #       @user = UserRepository.persist(@user)
+      #       @user = UserRepository.new.persist(@user)
       #     end
       #
       #     private
@@ -248,7 +247,7 @@ module Hanami
       #
       #   result = Signup.new(name: nil).call
       #   result.successful? # => false
-      #   result.failing? # => true
+      #   result.failure? # => true
       #
       #   result.user   # => #<User:0x007fa311105778 @id=nil @name="Luca">
       #
@@ -303,7 +302,7 @@ module Hanami
     #
     #     private
     #     def persist_email_test!
-    #       @email_test = EmailTestRepository.persist(@email_test)
+    #       @email_test = EmailTestRepository.new.persist(@email_test)
     #     end
     #
     #     # IF THIS RAISES AN EXCEPTION WE FORCE A FAILURE

data/lib/hanami/logger.rb

@@ -110,7 +110,7 @@ module Hanami
 
       # @since 1.0.0.beta1
       # @api private
-      RESERVED_KEYS = [:app, :severity, :time].freeze
+      RESERVED_KEYS = %i(app severity time).freeze
 
       include Utils::ClassAttribute
 
@@ -256,12 +256,127 @@ 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).
+    # @param args [Array<Object>] an optional set of arguments to honor Ruby's
+    #   `Logger#initialize` arguments. See Ruby documentation for details.
+    #
+    # @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). It defaults to `$stderr`.
+    #
+    # @param level [Integer,String] logging level. It can be expressed as an
+    #   integer, according to Ruby's `Logger` from standard library or as a
+    #   string with the name of the level
+    #
+    # @param formatter [Symbol,#_format] a formatter - We support `:json` as
+    #   JSON formatter or an object that respond to `#_format(data)`
     #
     # @since 0.5.0
-    def initialize(application_name = nil, stream: $stdout, level: DEBUG, formatter: nil)
-      super(stream)
+    #
+    # @see https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html#class-Logger-label-How+to+create+a+logger
+    #
+    # @example Basic usage
+    #   require 'hanami/logger'
+    #
+    #   logger = Hanami::Logger.new
+    #   logger.info "Hello World"
+    #
+    #   # => [Hanami] [DEBUG] [2017-03-30 15:41:01 +0200] Hello World
+    #
+    # @example Custom application name
+    #   require 'hanami/logger'
+    #
+    #   logger = Hanami::Logger.new('bookshelf')
+    #   logger.info "Hello World"
+    #
+    #   # => [bookshelf] [DEBUG] [2017-03-30 15:44:23 +0200] Hello World
+    #
+    # @example Logger level (Integer)
+    #   require 'hanami/logger'
+    #
+    #   logger = Hanami::Logger.new(level: 2) # WARN
+    #   logger.info "Hello World"
+    #   # => true
+    #
+    #   logger.info "Hello World"
+    #   # => true
+    #
+    #   logger.warn "Hello World"
+    #   # => [Hanami] [WARN] [2017-03-30 16:00:48 +0200] Hello World
+    #
+    # @example Logger level (Constant)
+    #   require 'hanami/logger'
+    #
+    #   logger = Hanami::Logger.new(level: Hanami::Logger::WARN)
+    #   logger.info "Hello World"
+    #   # => true
+    #
+    #   logger.info "Hello World"
+    #   # => true
+    #
+    #   logger.warn "Hello World"
+    #   # => [Hanami] [WARN] [2017-03-30 16:00:48 +0200] Hello World
+    #
+    # @example Logger level (String)
+    #   require 'hanami/logger'
+    #
+    #   logger = Hanami::Logger.new(level: 'warn')
+    #   logger.info "Hello World"
+    #   # => true
+    #
+    #   logger.info "Hello World"
+    #   # => true
+    #
+    #   logger.warn "Hello World"
+    #   # => [Hanami] [WARN] [2017-03-30 16:00:48 +0200] Hello World
+    #
+    # @example Use a file
+    #   require 'hanami/logger'
+    #
+    #   logger = Hanami::Logger.new(stream: "development.log")
+    #   logger.info "Hello World"
+    #
+    #   # => true
+    #
+    #   File.read("development.log")
+    #   # =>
+    #   #  # Logfile created on 2017-03-30 15:52:48 +0200 by logger.rb/56815
+    #   #  [Hanami] [DEBUG] [2017-03-30 15:52:54 +0200] Hello World
+    #
+    # @example Period rotation
+    #   require 'hanami/logger'
+    #
+    #   # Rotate daily
+    #   logger = Hanami::Logger.new('bookshelf', 'daily', stream: 'development.log')
+    #
+    # @example File size rotation
+    #   require 'hanami/logger'
+    #
+    #   # leave 10 old log files where the size is about 1,024,000 bytes
+    #   logger = Hanami::Logger.new('bookshelf', 10, 1024000, stream: 'development.log')
+    #
+    # @example Use a StringIO
+    #   require 'hanami/logger'
+    #
+    #   stream = StringIO.new
+    #   logger = Hanami::Logger.new(stream: stream)
+    #   logger.info "Hello World"
+    #
+    #   # => true
+    #
+    #   stream.rewind
+    #   stream.read
+    #
+    #   # => "[Hanami] [DEBUG] [2017-03-30 15:55:22 +0200] Hello World\n"
+    #
+    # @example JSON formatter
+    #   require 'hanami/logger'
+    #
+    #   logger = Hanami::Logger.new(formatter: :json)
+    #   logger.info "Hello World"
+    #
+    #   # => {"app":"Hanami","severity":"DEBUG","time":"2017-03-30T13:57:59Z","message":"Hello World"}
+    def initialize(application_name = nil, *args, stream: $stdout, level: DEBUG, formatter: nil)
+      super(stream, *args)
 
       @level            = _level(level)
       @stream           = stream

data/lib/hanami/utils/callbacks.rb

@@ -44,7 +44,7 @@ module Hanami
         #   # Append a Proc to be used as a callback, it will be wrapped by `Callback`
         #   # The optional argument(s) correspond to the one passed when invoked the chain with `run`.
         #   chain.append { Authenticator.authenticate! }
-        #   chain.append { |params| ArticleRepository.find(params[:id]) }
+        #   chain.append { |params| ArticleRepository.new.find(params[:id]) }
         #
         #   # Append a Symbol as a reference to a method name that will be used as a callback.
         #   # It will wrapped by `MethodCallback`
@@ -83,7 +83,7 @@ module Hanami
         #   # Add a Proc to be used as a callback, it will be wrapped by `Callback`
         #   # The optional argument(s) correspond to the one passed when invoked the chain with `run`.
         #   chain.prepend { Authenticator.authenticate! }
-        #   chain.prepend { |params| ArticleRepository.find(params[:id]) }
+        #   chain.prepend { |params| ArticleRepository.new.find(params[:id]) }
         #
         #   # Add a Symbol as a reference to a method name that will be used as a callback.
         #   # It will wrapped by `MethodCallback`

data/lib/hanami/utils/version.rb

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

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-utils
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Luca Guidi
-- Trung Lê
-- Alfonso Uceda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,8 +41,6 @@ dependencies:
 description: Hanami utilities
 email:
 - me@lucaguidi.com
-- trung.le@ruby-journal.com
-- uceda73@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -95,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby core extentions and Hanami utilities