active_logger 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57d404bf8defccccc9a8f05b57bf3779a512e5ac67a095ac1c994aa487fb7ee3
-  data.tar.gz: df5fa3f1b23c19126d86e197240c215ea6bedd9fce870e6ad0bfdda149f6dace
+  metadata.gz: 329985023815903e40757931bee2d0fef32a2f0e9e703570306b58acc403db34
+  data.tar.gz: 30d2bc94716af0bbb5781fa8d43404154bd5e11cda6fc94b7d3564e0d0d17a0a
 SHA512:
-  metadata.gz: b49cb0632467d2174d3f3f75e3abc2e54e1215ae4ff67f7bcf111048f6e24ef533a50ab75c6cb7880b4cd8176f03d3a09e6df7ae0cf46d8e79aa45676c2763e4
-  data.tar.gz: 76f8ee7fa78bab1250bcece99cb1f46edaeeab33dbab9d4bcd661e411feadf74e1157f8d9f3aeffb2b0f4b95a3e226e23f6d4dcf94e35b9d34dfbc472fce7cfb
+  metadata.gz: bc955d714639abbec8d7452915e4b6b166a7b5768b37cc29f14a61404aac48fd06d6d066e9c6f601824c8092dab56daefe6bc0ea834e760a2dca75dd44f180e7
+  data.tar.gz: 36fac211a1ffc773b51614d53ff72dcf0d3c83b6adebc511b8694a77bfa9d3e7dd0c00c17e710d111881594da046a76f0bf06dd8ea1bbfaa6232a5a879689ad9

data/.rubocop.yml

@@ -18,3 +18,6 @@ Metrics/MethodLength:
 # Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
   Max: 30
+
+RSpec/LeakyConstantDeclaration:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-04-22 16:12:47 +0300 using RuboCop version 0.82.0.
+# on 2020-04-22 17:28:02 +0300 using RuboCop version 0.82.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_logger (0.3.0)
+    active_logger (0.4.0)
       activesupport (>= 5.0.0)
 
 GEM

data/README.md

@@ -61,6 +61,59 @@ end
 logger.info 'test'
 ```
 
+### Example: Tagging
+
+```ruby
+logger = ActiveLogger.new STDOUT
+logger.tagged('API').info 'test'
+
+# or
+
+logger.tagged('API') do
+  logger.info 'test'
+end
+```
+
+### Example: Setting the Log Level
+
+```ruby
+ActiveLogger.new STDOUT, level: :info
+
+# or
+
+ActiveLogger.new do |al|
+  al.level = :debug
+
+  al.appender :stdout
+end
+```
+
+### Example: Formatters
+
+There are 2 standard formatters: `:default` and `:json`.
+
+```ruby
+ActiveLogger.new STDOUT, formatter: :json
+
+# or
+
+ActiveLogger.new do |al|
+  al.formatter = :json
+
+  al.appender :stdout
+end
+
+# or custom formatter
+
+class Formatter < ActiveLogger::Formatters::Base
+  def call(severity, timestamp, progname, msg)
+    "[#{severity}] [#{timestamp}] #{msg}"
+  end
+end
+
+ActiveLogger.new STDOUT, formatter: Formatter
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/active_logger.rb

@@ -11,8 +11,15 @@ module ActiveLogger # :nodoc:
   end
 end
 
+# Formatters
+require File.dirname(__FILE__) + '/active_logger/formatters/base'
+require File.dirname(__FILE__) + '/active_logger/formatters/default'
+require File.dirname(__FILE__) + '/active_logger/formatters/json'
+
 # Helpers
 require File.dirname(__FILE__) + '/active_logger/helpers/base'
+require File.dirname(__FILE__) + '/active_logger/helpers/level'
+require File.dirname(__FILE__) + '/active_logger/helpers/formatter'
 require File.dirname(__FILE__) + '/active_logger/helpers/appender'
 
 require File.dirname(__FILE__) + '/active_logger/tagged_logging'

data/lib/active_logger/formatters/base.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'English'
+
+module ActiveLogger
+  module Formatters
+    class Base < ActiveSupport::Logger::Formatter # :nodoc:
+      def call(severity, timestamp, progname, msg)
+        super(severity, timestamp, progname, msg)
+      end
+
+      def tagged(*tags)
+        new_tags = push_tags(*tags)
+        yield self
+      ensure
+        pop_tags(new_tags.size)
+      end
+
+      def push_tags(*tags)
+        @tags_text = nil
+        tags.flatten!
+        tags.reject!(&:blank?)
+        current_tags.concat tags
+        tags
+      end
+
+      def pop_tags(size = 1)
+        @tags_text = nil
+        current_tags.pop size
+      end
+
+      def clear_tags!
+        @tags_text = nil
+        current_tags.clear
+      end
+
+      def current_tags
+        # We use our object ID here to avoid conflicting with other instances
+        thread_key = @thread_key ||= "activelogger_tagged_logging_tags:#{object_id}"
+        Thread.current[thread_key] ||= []
+      end
+
+      def tags_text
+        @tags_text ||= begin
+          tags = current_tags
+          if tags.one?
+            "[#{tags[0]}] "
+          elsif tags.any?
+            tags.collect { |tag| "[#{tag}] " }.join
+          end
+        end
+      end
+
+      def pid
+        $PID
+      end
+    end
+  end
+end

data/lib/active_logger/formatters/default.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+# frozen_string_literal: true
+
+module ActiveLogger
+  module Formatters
+    class Default < Base # :nodoc:
+      def call(severity, timestamp, progname, msg)
+        super(severity, timestamp, progname, "#{tags_text}#{msg}")
+      end
+    end
+  end
+end

data/lib/active_logger/formatters/json.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ActiveLogger
+  module Formatters
+    class Json < Base # :nodoc:
+      def call(severity, timestamp, progname, msg)
+        {
+          progname: progname,
+          severity: severity,
+          timestamp: timestamp.utc.strftime(datetime_format),
+          tags: current_tags,
+          pid: pid,
+          message: msg
+        }.to_json + "\n"
+      end
+
+      def datetime_format
+        '%FT%T.%6NZ'
+      end
+    end
+  end
+end

data/lib/active_logger/helpers/appender.rb

@@ -13,10 +13,6 @@ module ActiveLogger #:nodoc:
         def appenders
           @appenders ||= []
         end
-
-        private
-
-        def reset!; end
       end
     end
   end

data/lib/active_logger/helpers/formatter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ActiveLogger #:nodoc:
+  module Helpers # :nodoc:
+    module Formatter #:nodoc:
+      extend ActiveSupport::Concern
+
+      class FormatterNotFound < StandardError; end
+
+      class_methods do
+        def formatter=(formatter)
+          @__formatter__ =
+            case formatter
+            when :default then ActiveLogger::Formatters::Default.new
+            when :json then ActiveLogger::Formatters::Json.new
+            else
+              raise FormatterNotFound unless formatter.class.ancestors.include?(ActiveLogger::Formatters::Base)
+
+              formatter
+            end
+        end
+
+        def formatter
+          @__formatter__
+        end
+
+        private
+
+        def reset!
+          @__formatter__ = ActiveLogger::Formatters::Default.new
+
+          super if defined?(super)
+        end
+      end
+    end
+  end
+end

data/lib/active_logger/helpers/level.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ActiveLogger #:nodoc:
+  module Helpers # :nodoc:
+    module Level #:nodoc:
+      extend ActiveSupport::Concern
+
+      SEVERITIES = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze
+
+      class LevelNotFound < StandardError; end
+
+      class_methods do
+        def level=(severity)
+          @__level__ =
+            case severity
+            when Integer then severity
+            when Symbol, String then SEVERITIES.index(severity.to_s.upcase)
+            else raise LevelNotFound
+            end
+        end
+
+        def level
+          @__level__
+        end
+
+        private
+
+        def reset!
+          @__level__ = ActiveSupport::Logger::DEBUG
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/active_logger/logger.rb

@@ -5,6 +5,8 @@ module ActiveLogger
     module_function
 
     include ActiveLogger::Helpers::Base
+    include ActiveLogger::Helpers::Level
+    include ActiveLogger::Helpers::Formatter
     include ActiveLogger::Helpers::Appender
 
     class AppenderNotFound < StandardError; end
@@ -16,6 +18,9 @@ module ActiveLogger
 
       reset!
 
+      self.formatter = options[:formatter] unless options[:formatter].nil?
+      self.level = options[:level] unless options[:level].nil?
+
       if block_given?
         block.arity.positive? ? block.call(self) : instance_eval(&block)
       else
@@ -47,6 +52,8 @@ module ActiveLogger
       end
 
       logger = ActiveSupport::Logger.new(*parameters)
+      logger.level = level
+      logger.formatter = formatter
       logger
     end
   end

data/lib/active_logger/tagged_logging.rb

@@ -5,55 +5,6 @@ require 'active_support/core_ext/object/blank'
 
 module ActiveLogger
   module TaggedLogging # :nodoc:
-    module Formatter # :nodoc:
-      # This method is invoked when a log event occurs.
-      def call(severity, timestamp, progname, msg)
-        super(severity, timestamp, progname, "#{tags_text}#{msg}")
-      end
-
-      def tagged(*tags)
-        new_tags = push_tags(*tags)
-        yield self
-      ensure
-        pop_tags(new_tags.size)
-      end
-
-      def push_tags(*tags)
-        @tags_text = nil
-        tags.flatten!
-        tags.reject!(&:blank?)
-        current_tags.concat tags
-        tags
-      end
-
-      def pop_tags(size = 1)
-        @tags_text = nil
-        current_tags.pop size
-      end
-
-      def clear_tags!
-        @tags_text = nil
-        current_tags.clear
-      end
-
-      def current_tags
-        # We use our object ID here to avoid conflicting with other instances
-        thread_key = @thread_key ||= "activesupport_tagged_logging_tags:#{object_id}"
-        Thread.current[thread_key] ||= []
-      end
-
-      def tags_text
-        @tags_text ||= begin
-          tags = current_tags
-          if tags.one?
-            "[#{tags[0]}] "
-          elsif tags.any?
-            tags.collect { |tag| "[#{tag}] " }.join
-          end
-        end
-      end
-    end
-
     module LocalTagStorage # :nodoc:
       attr_accessor :current_tags
 
@@ -70,10 +21,9 @@ module ActiveLogger
           logger.formatter.dup
         else
           # Ensure we set a default formatter so we aren't extending nil!
-          ActiveSupport::Logger::SimpleFormatter.new
+          ActiveLogger::Formatters::Default.new
         end
 
-      logger.formatter.extend Formatter
       logger.extend(self)
     end
 

data/lib/active_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveLogger
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_logger
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yury Snegirev
@@ -46,8 +46,13 @@ files:
 - bin/console
 - bin/setup
 - lib/active_logger.rb
+- lib/active_logger/formatters/base.rb
+- lib/active_logger/formatters/default.rb
+- lib/active_logger/formatters/json.rb
 - lib/active_logger/helpers/appender.rb
 - lib/active_logger/helpers/base.rb
+- lib/active_logger/helpers/formatter.rb
+- lib/active_logger/helpers/level.rb
 - lib/active_logger/logger.rb
 - lib/active_logger/tagged_logging.rb
 - lib/active_logger/version.rb