active_logger 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d656c1e99eace807d86b10c69f030cdbbbf7228a02bfa533fdc95ae3f481d849
-  data.tar.gz: 15ad4c1024bd1e0bbac497339123005e1823344d85d3addc928ec3baa5394a3e
+  metadata.gz: 50ac1681070fa355494e0e49c9b2cc73ec24a6c989627b12be37aa4f5c27d968
+  data.tar.gz: 59aaf06f6816b43c6dc8f795ac358ad0197b92cfe8dabbeb822b158e6a5f661a
 SHA512:
-  metadata.gz: 8471d55b78112605cbdd040f55a7f5d3f3e90d400caa84adfdda63926b3c4512b64a951f656e436b28d6ef7c6cc3377736606d767f3e891ddeafd8ad598b5dc5
-  data.tar.gz: 391cc5a5ec92bd2d249493cae0364c8750d2b6ed1cff8eea2a64acdb32d0b53576a77c26161a2ef2f5f3a47d9425d3fc9fb27c5eb9763069fc526470427fdf3f
+  metadata.gz: 075a32e06eeadc591c323b8df912b5e872d179cae608af7b7bf3d6229b4e5dfb6f37c0a46c0bc3b6a01e899e540aac612a9591c1bc5a5050087ef372d7c3f186
+  data.tar.gz: 412807005a9587d8ab6bc234ea8bf99d9bbfa3303aaafe32eb164c086a62d43409727259202cc5696bc7749c9943bcfec87c4872b02e1dc18dc7086e559c0c50

data/.rubocop.yml

@@ -11,7 +11,7 @@ AllCops:
 # ************************
 
 Layout/LineLength:
-  Max: 130
+  Enabled: false
 
 # ************************
 # METRICS

data/.rubocop_todo.yml

@@ -1,7 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-04-26 23:35:43 +0300 using RuboCop version 0.82.0.
+# on 2020-05-03 18:09:41 +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
 # versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/active_logger/formatters/syslog.rb'
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 7

data/Gemfile

@@ -9,3 +9,4 @@ gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'
 gem 'rubocop', '~> 0.81', require: false
 gem 'rubocop-rspec', '~> 1.38', require: false
+gem 'syslog_protocol', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_logger (0.6.1)
+    active_logger (0.7.0)
       activesupport (>= 5.0.0)
 
 GEM
@@ -50,6 +50,7 @@ GEM
     rubocop-rspec (1.38.1)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
+    syslog_protocol (0.9.2)
     thread_safe (0.3.6)
     tzinfo (1.2.6)
       thread_safe (~> 0.1)
@@ -65,6 +66,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (~> 0.81)
   rubocop-rspec (~> 1.38)
+  syslog_protocol
 
 BUNDLED WITH
    2.1.2

data/README.md

@@ -57,10 +57,6 @@ Available standard options:
 ```ruby
 logger = ActiveLogger.new :file, filename: 'log/development.log', keep: 30, size: 10
 logger.info 'test'
-
-# Alternative
-logger = ActiveLogger.new 'log/development.log', keep: 30, size: 10
-logger.info 'test'
 ```
 
 where:
@@ -120,6 +116,21 @@ end
 ActiveLogger.new STDOUT, formatter: Formatter
 ```
 
+### Example: Syslog
+
+You can use syslog (support only UDP protocol):
+
+```ruby
+logger = ActiveLogger.new :syslog, url: 'udp://sysloghost.com:514', facility: 'local3', maxsize: 1024
+logger.info 'test' # => <13>May  3 19:09:23 localhost console: test
+```
+
+Available options:
+
+* `url` - full url to syslog
+* `facility` - syslog facility (Example: 'user', 'local3', etc)
+* `maxsize` - maximum message size
+
 ## 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

@@ -19,10 +19,17 @@ module ActiveLogger # :nodoc:
   end
 end
 
+# Appenders
+require File.dirname(__FILE__) + '/active_logger/appenders/base'
+require File.dirname(__FILE__) + '/active_logger/appenders/file'
+require File.dirname(__FILE__) + '/active_logger/appenders/streams'
+require File.dirname(__FILE__) + '/active_logger/appenders/syslog'
+
 # 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'
+require File.dirname(__FILE__) + '/active_logger/formatters/syslog'
 
 # Helpers
 require File.dirname(__FILE__) + '/active_logger/helpers/base'
@@ -34,3 +41,9 @@ require File.dirname(__FILE__) + '/active_logger/tagged_logging'
 require File.dirname(__FILE__) + '/active_logger/logging'
 require File.dirname(__FILE__) + '/active_logger/logger'
 require File.dirname(__FILE__) + '/active_logger/repository'
+require File.dirname(__FILE__) + '/active_logger/appenders'
+
+ActiveLogger::Appenders.register(:stdout, ActiveLogger::Appenders::Stdout)
+ActiveLogger::Appenders.register(:stderr, ActiveLogger::Appenders::Stderr)
+ActiveLogger::Appenders.register(:file, ActiveLogger::Appenders::File)
+ActiveLogger::Appenders.register(:syslog, ActiveLogger::Appenders::Syslog)

data/lib/active_logger/appenders.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActiveLogger
+  module Appenders # :nodoc:
+    class NotFound < StandardError; end
+
+    @appenders = {}
+
+    def self.register(name, klass)
+      @appenders[name.to_sym] = klass
+    end
+
+    def self.new(type, options)
+      appender =
+        case type
+        when STDOUT then @appenders[:stdout]
+        when STDERR then @appenders[:stderr]
+        else @appenders[type]
+        end
+
+      raise NotFound, type if appender.nil?
+
+      appender.new(options)
+    end
+  end
+end

data/lib/active_logger/appenders/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
+
+module ActiveLogger
+  module Appenders
+    module Base # :nodoc:
+      def default_formatter
+        ActiveLogger::Formatters::Default.new
+      end
+    end
+  end
+end

data/lib/active_logger/appenders/file.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveLogger
+  module Appenders
+    class File < ActiveSupport::Logger # :nodoc:
+      include ActiveLogger::Appenders::Base
+
+      class FilenameNotSpecified < StandardError; end
+
+      def initialize(options)
+        raise FilenameNotSpecified if options[:filename].nil?
+
+        super(options[:filename], options[:keep], options[:size])
+      end
+    end
+  end
+end

data/lib/active_logger/appenders/streams.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveLogger
+  module Appenders
+    class Stdout < ActiveSupport::Logger # :nodoc:
+      include ActiveLogger::Appenders::Base
+
+      def initialize(options)
+        super(STDOUT, *options)
+      end
+    end
+
+    class Stderr < ActiveSupport::Logger # :nodoc:
+      include ActiveLogger::Appenders::Base
+
+      def initialize(options)
+        super(STDERR, *options)
+      end
+    end
+  end
+end

data/lib/active_logger/appenders/syslog.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'uri'
+require 'socket'
+require 'English'
+
+module ActiveLogger
+  module Appenders
+    class Syslog < ActiveSupport::Logger # :nodoc:
+      include ActiveLogger::Appenders::Base
+
+      class UrlNotKnown < StandardError; end
+
+      class UdpDevice # :nodoc:
+        def initialize(host:, port: 514)
+          @host = host
+          @port = port
+          @socket = UDPSocket.new
+        end
+
+        def write(message)
+          @socket.send(message, 0, @host, @port)
+        rescue StandardError => e
+          warn "#{self.class} error: #{$ERROR_INFO.class}: #{$ERROR_INFO}\nOriginal message: #{message} #{e.backtrace.join("\n")}"
+          raise e
+        end
+
+        def close
+          @socket.close
+        end
+      end
+
+      def initialize(options)
+        url = options.delete(:url)
+        uri = URI(url)
+        host = uri.host || 'localhost'
+        protocol = (uri.scheme || :syslog).to_sym
+        port = uri.port || 514
+        @maxsize = options.delete(:maxsize) || 1024
+        @facility = options.delete(:facility) || 'user'
+
+        case protocol
+        when :udp
+          super(UdpDevice.new(host: host, port: port))
+        else
+          raise UrlNotKnown, protocol
+        end
+      end
+
+      def default_formatter
+        ActiveLogger::Formatters::Syslog.new(maxsize: @maxsize, facility: @facility)
+      end
+    end
+  end
+end

data/lib/active_logger/formatters/syslog.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'syslog'
+require 'syslog_protocol'
+
+module ActiveLogger
+  module Formatters
+    class Syslog < Base # :nodoc:
+      attr_accessor :facility, :hostname, :maxsize
+
+      class LevelMap # :nodoc:
+        attr_accessor :trace, :debug, :info, :warn, :error, :fatal
+
+        def initialize(debug: ::Syslog::LOG_DEBUG, info: ::Syslog::LOG_INFO, warn: ::Syslog::LOG_WARNING, error: ::Syslog::LOG_ERR, fatal: ::Syslog::LOG_CRIT)
+          @debug = debug
+          @info  = info
+          @warn  = warn
+          @error = error
+          @fatal = fatal
+        end
+
+        def [](level)
+          public_send(level.to_s.downcase)
+        end
+      end
+
+      def initialize(hostname: nil, facility: nil, maxsize: nil)
+        @hostname = hostname
+        @facility = facility
+        @maxsize = maxsize
+      end
+
+      def call(severity, timestamp, progname, msg)
+        message = "#{tags_text}#{msg}"
+        program = progname || default_progname
+
+        syslog_packet(
+          tag: program.delete(' '),
+          content: message,
+          time: timestamp,
+          severity: LevelMap.new[severity],
+          facility: @facility,
+          maxsize: @maxsize || 1024,
+          host: @hostname
+        )
+      end
+
+      def syslog_packet(tag:, content:, facility: nil, time: nil, severity: nil, host: nil, maxsize: nil)
+        packet          = SyslogProtocol::Packet.new
+        packet.hostname = host || `hostname`.chomp
+        packet.facility = facility || 'user'
+        packet.tag      = tag
+        packet.content  = content
+        packet.time     = time
+        packet.severity = severity || 'notice'
+        maxsize ? packet.assemble(maxsize) : packet.assemble
+      end
+    end
+  end
+end

data/lib/active_logger/helpers/appender.rb

@@ -5,9 +5,6 @@ module ActiveLogger #:nodoc:
     module Appender #:nodoc:
       extend ActiveSupport::Concern
 
-      class AppenderNotFound < StandardError; end
-      class FilenameNotSpecified < StandardError; end
-
       class_methods do
         def appender(type, options = {})
           appenders << loggable(type, options)
@@ -18,26 +15,10 @@ module ActiveLogger #:nodoc:
         end
 
         def loggable(type, options = {})
-          parameters = []
-
-          case type
-          when :stdout, STDOUT
-            parameters << STDOUT
-          when :stderr, STDERR
-            parameters << STDERR
-          when String, Pathname
-            parameters = [type.to_s, options[:keep], options[:size]]
-          when :file
-            raise FilenameNotSpecified if options[:filename].nil?
-
-            parameters = [options[:filename], options[:keep], options[:size]]
-          else
-            raise AppenderNotFound
-          end
-
-          logger = ActiveLogger::Logger.new(*parameters)
+          logger = ActiveLogger::Appenders.new(type, options)
           logger.level = level
-          logger.formatter = formatter
+          default_formatter = logger.respond_to?(:default_formatter) ? logger.default_formatter : ActiveLogger::Formatters::Default.new
+          logger.formatter = formatter || default_formatter
           logger.progname = progname
           logger
         end

data/lib/active_logger/helpers/formatter.rb

@@ -13,6 +13,7 @@ module ActiveLogger #:nodoc:
             case formatter
             when :default then ActiveLogger::Formatters::Default.new
             when :json then ActiveLogger::Formatters::Json.new
+            when :syslog then ActiveLogger::Formatters::Syslog.new
             else
               raise FormatterNotFound unless formatter.class.ancestors.include?(ActiveLogger::Formatters::Base)
 
@@ -27,7 +28,7 @@ module ActiveLogger #:nodoc:
         private
 
         def reset!
-          @__formatter__ = ActiveLogger::Formatters::Default.new
+          @__formatter__ = nil
 
           super if defined?(super)
         end

data/lib/active_logger/logging.rb

@@ -15,10 +15,10 @@ module ActiveLogger
 
       reset!
 
-      self.formatter = options[:formatter] if options[:formatter]
-      self.level = options[:level] if options[:level]
-      self.progname = options[:progname] if options[:progname]
-      self.name = options[:name] if options[:name]
+      self.formatter = options.delete(:formatter) if options[:formatter]
+      self.level = options.delete(:level) if options[:level]
+      self.progname = options.delete(:progname) if options[:progname]
+      self.name = options.delete(:name) if options[:name]
 
       if block_given?
         block.arity.positive? ? block.call(self) : instance_eval(&block)

data/lib/active_logger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_logger
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Yury Snegirev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,9 +46,15 @@ files:
 - bin/console
 - bin/setup
 - lib/active_logger.rb
+- lib/active_logger/appenders.rb
+- lib/active_logger/appenders/base.rb
+- lib/active_logger/appenders/file.rb
+- lib/active_logger/appenders/streams.rb
+- lib/active_logger/appenders/syslog.rb
 - lib/active_logger/formatters/base.rb
 - lib/active_logger/formatters/default.rb
 - lib/active_logger/formatters/json.rb
+- lib/active_logger/formatters/syslog.rb
 - lib/active_logger/helpers/appender.rb
 - lib/active_logger/helpers/base.rb
 - lib/active_logger/helpers/formatter.rb