lotus-utils 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 119e1e01ae231b8dd402f6cda19aa9354663e439
-  data.tar.gz: 5e28d0a9c8e1b06a66acc3ff881ac08908a5b0a3
+  metadata.gz: 93d211db34674dbdfa9728cf23e72e6d3236f754
+  data.tar.gz: c88e28e49ec323d6e74a01c6f0371d29e97e0680
 SHA512:
-  metadata.gz: ea4c280a6b7c8b693d69bf132b85de349e0c459a4ac259f33d58313244ca97300aae686743f4f15fd00314c41d07b792151f78a02a2e2c75b9d157d4d3f744a3
-  data.tar.gz: 95432308fb5689d4a61292cd24553df16a37e039ac79760debe4813d961dadff081e8ccb993946891e86c57fe77d2e7b85822cd3d2096111031390c1a5d7af6a
+  metadata.gz: 2335cb45570fc4f67b6f5b1db5f8a938d9b94e1e3d49338d68f717f39fc046fb2dc573fd6070ccd5e7aaf47f5b01092b167d2f108ef3d9308e46a029d865a5b8
+  data.tar.gz: 4d2c770981d67118df3723dd306a20e3644ae454c114894c6dd4bd3f78974bc04bd575af1c8089e2b53d724d6d99147a72fe175be824302c6c6c1e5ff1f91996

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Lotus::Utils
 Ruby core extentions and class utilities for Lotus
 
+## v0.5.0 - 2015-06-23
+### Added
+- [Luca Guidi] Extracted `Lotus::Logger` from `lotusrb`
+
+### Changed
+- [Luca Guidi] `Lotus::Interactor::Result` contains only objects explicitly exposed via `Lotus::Interactor.expose`.
+
 ## v0.4.3 - 2015-05-22
 ### Added
 - [François Beausoleil] Improved `Lotus::Utils::Kernel` messages for `TypeError`.

data/lib/lotus/interactor.rb

@@ -1,4 +1,5 @@
 require 'lotus/utils/basic_object'
+require 'lotus/utils/class_attribute'
 require 'lotus/utils/hash'
 
 module Lotus
@@ -28,6 +29,7 @@ module Lotus
       # @api private
       def initialize(payload = {})
         @payload = _payload(payload)
+        @errors  = []
         @success = true
       end
 
@@ -58,7 +60,15 @@ module Lotus
       # @see Lotus::Interactor#error
       # @see Lotus::Interactor#error!
       def errors
-        @payload.fetch(:_errors) { [] }
+        @errors.dup
+      end
+
+      # @since 0.5.0
+      # @api private
+      def add_error(*errors)
+        @errors << errors
+        @errors.flatten!
+        nil
       end
 
       # Returns the first errors collected during an operation
@@ -122,6 +132,7 @@ module Lotus
 
       base.class_eval do
         prepend Interface
+        extend  ClassMethods
       end
     end
 
@@ -146,8 +157,8 @@ module Lotus
       #   class UpdateProfile
       #     include Lotus::Interactor
       #
-      #     def initialize(person, params)
-      #       @person = person
+      #     def initialize(user, params)
+      #       @user   = user
       #       @params = params
       #     end
       #
@@ -159,7 +170,6 @@ module Lotus
         super
       ensure
         @__result = ::Lotus::Interactor::Result.new
-        @_errors  = []
       end
 
       # Triggers the operation and return a result.
@@ -172,11 +182,12 @@ module Lotus
       #
       # @raise [NoMethodError] if this isn't implemented by the including class.
       #
-      # @example Instance variables in result payload
+      # @example Expose instance variables in result payload
       #   require 'lotus/interactor'
       #
       #   class Signup
       #     include Lotus::Interactor
+      #     expose :user, :params
       #
       #     def initialize(params)
       #       @params = params
@@ -194,13 +205,14 @@ module Lotus
       #
       #   result.user   # => #<User:0x007fa311105778 @id=1 @name="Luca">
       #   result.params # => { :name=>"Luca" }
-      #   result.foo    # => "Bar"
+      #   result.foo    # => raises NoMethodError
       #
       # @example Failed precondition
       #   require 'lotus/interactor'
       #
       #   class Signup
       #     include Lotus::Interactor
+      #     expose :user
       #
       #     def initialize(params)
       #       @params = params
@@ -308,6 +320,7 @@ module Lotus
     #
     #   class CreateRecord
     #     include Lotus::Interactor
+    #     expose :logger
     #
     #     def initialize
     #       @logger = []
@@ -341,7 +354,7 @@ module Lotus
     #   result.errors # => ["Prepare data error", "Persist error"]
     #   result.logger # => [:prepare_data!, :persist!, :sync!]
     def error(message)
-      @_errors << message
+      @__result.add_error message
       false
     end
 
@@ -360,6 +373,7 @@ module Lotus
     #
     #   class CreateRecord
     #     include Lotus::Interactor
+    #     expose :logger
     #
     #     def initialize
     #       @logger = []
@@ -417,20 +431,67 @@ module Lotus
     # @since 0.3.5
     # @api private
     def _prepare!
-      @__result.prepare!(_instance_variables)
+      @__result.prepare!(_exposures)
     end
 
-    # @since 0.3.5
+    # @since 0.5.0
     # @api private
-    def _instance_variables
+    def _exposures
       Hash[].tap do |result|
-        instance_variables.each do |iv|
-          name = iv.to_s.sub(/\A@/, '')
-          next if name.match(/\A__/)
-
-          result[name.to_sym] = instance_variable_get(iv)
+        self.class.exposures.each do |name, ivar|
+          result[name] = instance_variable_get(ivar)
         end
       end
     end
   end
+
+  # @since 0.5.0
+  # @api private
+  module ClassMethods
+    # @since 0.5.0
+    # @api private
+    def self.extended(interactor)
+      interactor.class_eval do
+        include Utils::ClassAttribute
+
+        class_attribute :exposures
+        self.exposures = Utils::Hash.new
+      end
+    end
+
+    # Expose local instance variables into the returing value of <tt>#call</tt>
+    #
+    # @param instance_variable_names [Symbol,Array<Symbol>] one or more instance
+    #   variable names
+    #
+    # @since 0.5.0
+    #
+    # @see Lotus::Interactor::Result
+    #
+    # @example Expose instance variable
+    #
+    #   class Signup
+    #     include Lotus::Interactor
+    #     expose :user
+    #
+    #     def initialize(params)
+    #       @params = params
+    #       @user   = User.new(@params[:user])
+    #     end
+    #
+    #     def call
+    #       # ...
+    #     end
+    #   end
+    #
+    #   result = Signup.new(user: { name: "Luca" }).call
+    #
+    #   result.user   # => #<User:0x007fa85c58ccd8 @name="Luca">
+    #   result.params # => NoMethodError
+    def expose(*instance_variable_names)
+      instance_variable_names.each do |name|
+        exposures[name] = "@#{ name }"
+      end
+    end
+  end
 end

data/lib/lotus/logger.rb

@@ -0,0 +1,141 @@
+require 'logger'
+require 'lotus/utils/string'
+
+module Lotus
+  # Lotus logger
+  #
+  # Implement with the same interface of Ruby std lib `Logger`.
+  # It uses `STDOUT` as output device.
+  #
+  #
+  #
+  # When a Lotus 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. `Lotus::Logger.info`), it tags lines with `[Shared]`.
+  #
+  #
+  #
+  # The available severity levels are the same of `Logger`:
+  #
+  #   * debug
+  #   * error
+  #   * fatal
+  #   * info
+  #   * unknown
+  #   * warn
+  #
+  # Those levels are available both as class and instance methods.
+  #
+  # @since 0.5.0
+  #
+  # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html
+  # @see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger/Severity.html
+  #
+  # @example Basic usage
+  #   require 'lotus'
+  #
+  #   module Bookshelf
+  #     class Application < Lotus::Application
+  #     end
+  #   end
+  #
+  #   # Initialize the application with the following code:
+  #   Bookshelf::Application.load!
+  #   # 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
+  #
+  # @example Standalone usage
+  #   require 'lotus'
+  #
+  #   Lotus::Logger.info('Hello')
+  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [Lotus] : Hello
+  #
+  #   Lotus::Logger.new.info('Hello')
+  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [Lotus] : Hello
+  #
+  # @example Custom tagging
+  #   require 'lotus'
+  #
+  #   Lotus::Logger.new('FOO').info('Hello')
+  #   # => I, [2015-01-10T21:55:12.727259 #80487]  INFO -- [FOO] : Hello
+  class Logger < ::Logger
+    # Lotus::Logger default formatter
+    #
+    # @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.5.0
+      # @api private
+      attr_writer :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)
+        progname = "[#{@application_name}] #{progname}"
+        super(severity, time.utc, progname, msg)
+      end
+    end
+
+    # Default application name.
+    # This is used as a fallback for tagging purposes.
+    #
+    # @since 0.5.0
+    # @api private
+    DEFAULT_APPLICATION_NAME = 'Lotus'.freeze
+
+    # @since 0.5.0
+    # @api private
+    attr_writer :application_name
+
+    # Initialize a logger
+    #
+    # @param application_name [String] an optional application name used for
+    #   tagging purposes
+    #
+    # @since 0.5.0
+    def initialize(application_name = nil)
+      super(STDOUT)
+
+      @application_name = application_name
+      @formatter        = Lotus::Logger::Formatter.new.tap { |f| f.application_name = self.application_name }
+    end
+
+    # Returns the current application name, this is used for tagging purposes
+    #
+    # @return [String] the application name
+    #
+    # @since 0.5.0
+    def application_name
+      @application_name || _application_name_from_namespace || _default_application_name
+    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
+    end
+
+    # @since 0.5.0
+    # @api private
+    def _default_application_name
+      DEFAULT_APPLICATION_NAME
+    end
+  end
+end

data/lib/lotus/utils/version.rb

@@ -3,6 +3,6 @@ module Lotus
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.4.3'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lotus-utils
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,7 @@ files:
 - LICENSE.md
 - README.md
 - lib/lotus/interactor.rb
+- lib/lotus/logger.rb
 - lib/lotus/utils.rb
 - lib/lotus/utils/attributes.rb
 - lib/lotus/utils/basic_object.rb
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby core extentions and Louts utilities