mimi-logger 0.2.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff39280fa18ca6e038a4be72c73e2ef5872c59f1
-  data.tar.gz: 5a99829862fc9034cc8c55e39cf1e51eedc24d36
+  metadata.gz: 4f4073d2c2cedcbb6741dfee2fb68376c3dfcfde
+  data.tar.gz: f279d8dd3b2eade0caaf2981bf90886506856a5e
 SHA512:
-  metadata.gz: e8e7353ece0c06be660cefdc308c3d58fa76373caf2de99e0f44fbe1a5b51152327e5c9ea8291ac6d7fedfd8bbbcd20e2c36918656ef1a0f29989815381b40cb
-  data.tar.gz: 10f7a8bfe01ea80fa3bc0a1fbe4e94cc015279fc1f91d7fd5bc88403157f85b3ebfb6521dcd35efa431ab0808f63de09205a87ef844edc12aedfeba43966c9ba
+  metadata.gz: d4b7606b4f8f079c275b5345318a9de9b382a0b33ed70be9463c5e843791dbf9fef21841ccbef4204c92439cc73306576736d20c9ffb44a45c348d5c2df95128
+  data.tar.gz: '0865e2709e8d6911c8e67f2d181b342170bcb67466bafea817e652d0d57e26f85dfa73a3a58362283641c2d5e4218873a93dc8a845e2e8e6e698e619bcc4415e'

data/lib/mimi/logger/version.rb

@@ -1,5 +1,5 @@
 module Mimi
   class Logger
-    VERSION = '0.2.5'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/mimi/logger.rb

@@ -22,12 +22,34 @@ module Mimi
     delegate %i[debug? info? warn? error? fatal? << add log] => :logger_instance
     delegate %i[context_id context_id= new_context! with_new_context with_preserved_context] => self
 
-    default_options(
-      format: 'json',   # 'string' or 'json'
-      log_context: true,
-      level: 'info',
-      cr_character: '↲' # alternative CR: ↵ ↲ ⏎
-    )
+    # Mimi::logger module manifest
+    #
+    def self.manifest
+      {
+        logger_format: {
+          desc: 'String or JSON',
+          default: 'json',
+          hidden: true
+        },
+        logger_context: {
+          desc: 'Logger will log context',
+          type: :boolean,
+          default: true,
+          hidden: true
+        },
+        logger_level: {
+          desc: 'Logger severity level threshold',
+          default: 'info',
+          type: ['debug', 'info', 'warn', 'error', 'fatal']
+        },
+        logger_cr_character: {
+          desc: 'Logger replaces new line with alternative CR character',
+          default: '↲', # alternative CR: ↵ ↲ ⏎
+          type: :string,
+          hidden: true
+        }
+      }
+    end
 
     # Creates a new Logger instance
     #
@@ -49,9 +71,12 @@ module Mimi
       opts ||= {}
       raise ArgumentError, '(io, opts) are expected as parameters' unless args.empty?
 
-      @options = self.class.module_options.deep_merge(opts)
+      # module configured?
+      self.class.configure() if self.class.options.empty?
+
+      @options = self.class.options.deep_merge(opts)
       @logger_instance = ::Logger.new(io)
-      @logger_instance.level = self.class.level_from_any(options[:level])
+      @logger_instance.level = self.class.level_from_any(options[:logger_level])
       io.sync = true if io.respond_to?(:sync=)
       @logger_instance.formatter = self.class.formatter(options)
     end
@@ -138,14 +163,14 @@ module Mimi
     # @return [Proc]
     # @private
     #
-    def self.formatter(options)
-      case options[:format].to_s
+    def self.formatter(local_options)
+      case local_options[:logger_format].to_s
       when 'json'
-        formatter_json(options)
+        formatter_json(local_options)
       when 'string'
-        formatter_string(options)
+        formatter_string(local_options)
       else
-        raise "Invalid format specified for Mimi::Logger: '#{module_options[:format]}'"
+        raise "Invalid format specified for Mimi::Logger: '#{local_options[:logger_format]}'"
       end
     end
 
@@ -155,10 +180,10 @@ module Mimi
     # @return [Proc]
     # @private
     #
-    def self.formatter_json(options)
+    def self.formatter_json(local_options)
       proc do |severity, _datetime, _progname, message|
         h = formatter_message_args_to_hash(message)
-        h[:c] = context_id if options[:log_context]
+        h[:c] = context_id if local_options[:logger_context]
         h[:s] = severity.to_s[0]
         JSON.dump(h) + "\n"
       end
@@ -170,13 +195,13 @@ module Mimi
     # @return [Proc]
     # @private
     #
-    def self.formatter_string(options)
+    def self.formatter_string(local_options)
       proc do |severity, _datetime, _progname, message|
         h = formatter_message_args_to_hash(message)
         parts = []
         parts << severity.to_s[0]
-        parts << context_id if options[:log_context]
-        parts << h[:m].to_s.tr("\n", options[:cr_character])
+        parts << context_id if local_options[:logger_context]
+        parts << h[:m].to_s.tr("\n", local_options[:logger_cr_character])
         parts << '...' unless h.except(:m).empty?
         parts.join(', ') + "\n"
       end
@@ -290,16 +315,6 @@ module Mimi
         yield
       end
     end
-
-    # @private
-    def self.module_manifest
-      {
-        log_level: {
-          desc: 'Logging level (any of the "debug", "info", "warn", "error", "fatal")',
-          default: 'info'
-        }
-      }
-    end
   end # class Logger
 end # module Mimi
 

data/mimi-logger.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'mimi-core'
+  spec.add_dependency 'mimi-core', '~> 1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mimi-logger
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimi-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: A pre-configured logger for microservice applications