journald-logger 2.0.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79ce8cdc578a85397fcf5b32cfc6ffff1482667b07d13c94a76a8acb6b11fba3
-  data.tar.gz: f7f2aa5432b567bd1c096633caa7ee556295c7fed54252bbc9e4b19b661c2f62
+  metadata.gz: bf0682f32c2a2e7587b1289893403e1a5eb02e6cddcba526dc9260573ea1268a
+  data.tar.gz: 0c909e457098e41616dec4732b98aa23adf78b6cdbba08b81b199137420e776f
 SHA512:
-  metadata.gz: 36efaf90a438c87cbe074ba9714a526ae82b272183561689729dddfae73915dae2ff5b26da796ae80941ee152d4d77795b1cb8a45f0bd502f2edb63ba7e04eeb
-  data.tar.gz: dc77258eae320c96ea4f8839863dcd27f2c8e5813ed9d5cef71d7fb406bcb5bb94e98ef6d6f5ead25878dd6af7b18449008564733e1cc7245c135b5240540ab8
+  metadata.gz: c8fa2653047d79eb2d235a0f371ff6114e547e481c0a4976bed00be0e720a6998aa5298c810dd7e19ef2b694d51279f5de58e1190076d0471c94b78d9d7728ed
+  data.tar.gz: 46fd5fcee4a3c55ae14f69c6ce04ee58b2c8619a1d7e6d9e91b8479275d46919e8f1fec6c79ec5e73d761f63ea91222979216f83ca7162f029870915f9e3d626

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - "spec/**/*"
+    - "vendor/**/*"
+  TargetRubyVersion: 2.0
+
+Layout:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Style:
+  Enabled: false
+
+Naming:
+  Enabled: false

data/.travis.yml

@@ -1,14 +1,10 @@
-# test with minimum and current and previous version of ruby; try default version of rbx
-
 language: ruby
-os:
-  - xenial # we cannot actually test until xenial is added to Travis
+before_install:
+  - sudo apt-get install -y libsystemd-dev
+install: "bundle install"
 rvm:
-  - '2.0.0'
-  - '2.1.0'
-  - '2.2.4'
-  - '2.3.0'
-  - rbx
+  - 2.0.0
+  - 2.6.0
 script:
-  - bundle exec rake compile
-  - bundle exec rspec
+  - bundle exec rake build
+  - bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v3.0.0
+
+*December 3, 2019*
+
+- Do not override Ruby send method (API change)
+
 ## v2.0.4
 
 *October 9, 2018*

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in journald-logger.gemspec
 gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2016 Anton Smirnov
+Copyright (c) 2014 Anton Smirnov
 
 MIT License
 

data/README.md

@@ -1,8 +1,5 @@
 # journald-logger
 
-[![Gem Version](https://badge.fury.io/rb/journald-logger.svg)](http://badge.fury.io/rb/journald-logger)
-[![Reference Status](https://www.versioneye.com/ruby/journald-logger/reference_badge.svg)](https://www.versioneye.com/ruby/journald-logger/references)
-
 A Logger drop-in replacement that logs directly to systemd-journal with some additional features
 
 ## Usage
@@ -74,7 +71,7 @@ letters, numbers, underscores, cannot begin with underscore. Library upcases all
 Two methods which look similarly to native systemd-journal api
 
 ```ruby
-logger.send(
+logger.send_message(
   message: 'hi!',
   priority: Journald::LOG_NOTICE,
   any_field: 'any_value',
@@ -109,11 +106,15 @@ Exception logger automatically fills the following fields:
 EXCEPTION_CLASS=ExceptionRealClassName
 EXCEPTION_MESSAGE=Original exception message
 BACKTRACE=full backtrace
-CAUSE=exception cause
+CAUSE=exception cause (Ruby >= 2.1)
 GEM_LOGGER_MESSAGE_TYPE=Exception
 ```
 
-It also tries to log ```CODE_LINE```, ```CODE_FILE``` and ```CODE_FUNC``` and try to recurse into Cause and log it into a separate message with ```GEM_LOGGER_MESSAGE_TYPE=ExceptionCause```
+In Ruby 2.1+ it also tries to log ```CODE_LINE```, ```CODE_FILE``` and ```CODE_FUNC``` and to recurse into Cause and log it into a separate message with ```GEM_LOGGER_MESSAGE_TYPE=ExceptionCause```
+
+## Authors
+
+This library was written by Anton Smirnov and currently maintained by https://www.theforeman.org developers.
 
 ## License
 

data/Rakefile

@@ -1 +1,33 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+if Gem::Version.new(RUBY_VERSION) > Gem::Version.new("2.0")
+  namespace :rufo do
+    require "rufo"
+
+    def rufo_command(*switches, rake_args)
+      files_or_dirs = rake_args[:files_or_dirs] || "."
+      args = switches + files_or_dirs.split(" ")
+      Rufo::Command.run(args)
+    end
+
+    desc "Format Ruby code in current directory"
+    task :run, [:files_or_dirs] do |_task, rake_args|
+      rufo_command(rake_args)
+    end
+
+    desc "Check that no formatting changes are produced"
+    task :check, [:files_or_dirs] do |_task, rake_args|
+      rufo_command("--check", rake_args)
+    end
+  end
+
+  task :default => [:spec, :rubocop, :'rufo:check']
+else
+  # rufo is no longer Ruby 2.0 compatible yet we want to support old Ruby
+  task :default => [:spec, :rubocop]
+end

data/journald-logger.gemspec

@@ -1,27 +1,28 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'journald/modules/version'
+require "journald/modules/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'journald-logger'
-  spec.version       = Journald::Logger::VERSION
-  spec.authors       = ['Anton Smirnov']
-  spec.email         = ['sandfox@sandfox.me']
-  spec.summary       = %q{systemd-journal native logger}
-  # spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = 'https://github.com/sandfoxme/journald-logger'
-  spec.license       = 'MIT'
+  spec.name = "journald-logger"
+  spec.version = Journald::Logger::VERSION
+  spec.authors = ["Anton Smirnov"]
+  spec.email = ["sandfox@sandfox.me"]
+  spec.summary = %q{systemd-journal native logger}
+  spec.homepage = "https://github.com/theforeman/journald-logger"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = ">= 2.0.0"
 
-  spec.add_runtime_dependency 'journald-native', '~> 1.0'
+  spec.add_runtime_dependency "journald-native", "~> 1.0"
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec',   '~> 3.4'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rufo"
+  spec.add_development_dependency "rubocop", "~> 0.50.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
 end

data/lib/journald/classes/logger.rb

@@ -5,7 +5,7 @@ module Journald
     include Sysloggable
 
     def initialize(progname = nil, min_priority = nil, **tags)
-      @tags   = tags
+      @tags = tags
       @logger = Native
       self.min_priority = min_priority
       self.progname = progname
@@ -28,15 +28,15 @@ module Journald
     # systemd-journal style
 
     # send systemd-journal message
-    def send(hash)
+    def send_message(hash)
       hash_to_send = @tags.merge(hash)
       real_send(hash_to_send)
     end
 
     def print(priority, message)
-      send(
+      send_message(
         priority: priority,
-        message:  message,
+        message: message,
       )
     end
 
@@ -81,36 +81,36 @@ module Journald
 
     protected
 
-      # used internally by exception() and TraceLogger
-      def tag_trace_location(location)
-        tag code_file: location.path,
-            code_line: location.lineno,
-            code_func: location.label
-      end
+    # used internally by exception() and TraceLogger
+    def tag_trace_location(location)
+      tag code_file: location.path,
+          code_line: location.lineno,
+          code_func: location.label
+    end
 
-      def untag_trace_location
-        untag :code_file, :code_line, :code_func
-      end
+    def untag_trace_location
+      untag :code_file, :code_line, :code_func
+    end
 
     private
 
-      def real_send(hash)
-        hash = hash.delete_if { |_, v| v.nil? }
+    def real_send(hash)
+      hash = hash.delete_if { |_, v| v.nil? }
 
-        array_to_send = hash.map do |k,v|
-          key = k.to_s.upcase
-          value = v.to_s
+      array_to_send = hash.map do |k, v|
+        key = k.to_s.upcase
+        value = v.to_s
 
-          if key == 'PRIORITY'
-            priority = value.to_i
+        if key == "PRIORITY"
+          priority = value.to_i
 
-            return 0 if priority > @min_priority # DEBUG = 7, ALERT = 1
-          end
-
-          "#{key}=#{value}"
+          return 0 if priority > @min_priority # DEBUG = 7, ALERT = 1
         end
 
-        @logger.send(*array_to_send)
+        "#{key}=#{value}"
       end
+
+      @logger.send(*array_to_send)
+    end
   end
 end

data/lib/journald/classes/trace_logger.rb

@@ -5,25 +5,23 @@ module Journald
     end
 
     PASSTHROUGH_METHODS = [
-        :tag,
-        :tag_value,
-        :untag,
-        :progname,
-        :progname=,
-        :level,
-        :level=,
-        :sev_threshold,
-        :sev_threshold=,
-        :min_priority,
-        :min_priority=,
+      :tag,
+      :tag_value,
+      :untag,
+      :progname,
+      :progname=,
+      :level,
+      :level=,
+      :sev_threshold,
+      :sev_threshold=,
+      :min_priority,
+      :min_priority=,
     ]
 
-    METHODS = (
-      Journald::Logger.               public_instance_methods(false) +
-      Journald::Logger::Exceptionable.public_instance_methods(false) +
-      Journald::Logger::Loggable.     public_instance_methods(false) +
-      Journald::Logger::Sysloggable.  public_instance_methods(false)
-    )
+    METHODS = (Journald::Logger.public_instance_methods(false) +
+               Journald::Logger::Exceptionable.public_instance_methods(false) +
+               Journald::Logger::Loggable.public_instance_methods(false) +
+               Journald::Logger::Sysloggable.public_instance_methods(false))
 
     METHODS.each do |method|
       if PASSTHROUGH_METHODS.include? method
@@ -32,7 +30,7 @@ module Journald
         end
       else
         define_method(method) do |*args, &block|
-          @wrapped_logger.__send__(:tag_trace_location, caller_locations[0])
+          @wrapped_logger.__send__(:tag_trace_location, caller_locations(1..1).first)
           @wrapped_logger.public_send(method, *args, &block)
         end
       end

data/lib/journald/logger.rb

@@ -1,10 +1,10 @@
-require 'logger'
-require 'journald/native'
+require "logger"
+require "journald/native"
 
-require_relative 'modules/version'
-require_relative 'modules/exceptionable'
-require_relative 'modules/loggable'
-require_relative 'modules/sysloggable'
+require_relative "modules/version"
+require_relative "modules/exceptionable"
+require_relative "modules/loggable"
+require_relative "modules/sysloggable"
 
-require_relative 'classes/logger'
-require_relative 'classes/trace_logger'
+require_relative "classes/logger"
+require_relative "classes/trace_logger"

data/lib/journald/modules/exceptionable.rb

@@ -8,30 +8,30 @@ module Journald
 
       private
 
-        def real_exception(e, priority, is_cause)
-          # for Ruby 2.1 get cause if present
-          cause = if e.respond_to? :cause; e.cause; end
-          # for Ruby 2.1 get backtrace if present
-          bt = e.respond_to?(:backtrace_locations) &&
-               e.backtrace_locations &&
-               e.backtrace_locations.length > 0
+      def real_exception(e, priority, is_cause)
+        # for Ruby 2.1 get cause if present
+        cause = if e.respond_to? :cause; e.cause; end
+        # for Ruby 2.1 get backtrace if present
+        bt = e.respond_to?(:backtrace_locations) &&
+             e.backtrace_locations &&
+             e.backtrace_locations.length > 0
 
-          tag_trace_location(e.backtrace_locations[0]) if bt
+        tag_trace_location(e.backtrace_locations[0]) if bt
 
-          send(
-              priority:                 priority,
-              message:                  "Exception #{e.inspect}",
-              gem_logger_message_type:  is_cause ? 'ExceptionCause' : 'Exception',
-              exception_class:          e.class.name,
-              exception_message:        e.message,
-              backtrace:                bt ? e.backtrace.join("\n"): nil,
-              cause:                    cause ? cause.inspect : nil,
-          )
+        send_message(
+          priority: priority,
+          message: "Exception #{e.inspect}",
+          gem_logger_message_type: is_cause ? "ExceptionCause" : "Exception",
+          exception_class: e.class.name,
+          exception_message: e.message,
+          backtrace: bt ? e.backtrace.join("\n") : nil,
+          cause: cause ? cause.inspect : nil,
+        )
 
-          untag_trace_location if bt
+        untag_trace_location if bt
 
-          real_exception(cause, priority, true) if cause
-        end
+        real_exception(cause, priority, true) if cause
+      end
     end
   end
 end

data/lib/journald/modules/loggable.rb

@@ -5,32 +5,32 @@ module Journald
 
       # our map differs from Syslog::Logger
       LEVEL_MAP = {
-          ::Logger::UNKNOWN => LOG_ALERT,
-          ::Logger::FATAL   => LOG_CRIT,
-          ::Logger::ERROR   => LOG_ERR,
-          ::Logger::WARN    => LOG_WARNING,
-          ::Logger::INFO    => LOG_INFO,
-          ::Logger::DEBUG   => LOG_DEBUG,
+        ::Logger::UNKNOWN => LOG_ALERT,
+        ::Logger::FATAL => LOG_CRIT,
+        ::Logger::ERROR => LOG_ERR,
+        ::Logger::WARN => LOG_WARNING,
+        ::Logger::INFO => LOG_INFO,
+        ::Logger::DEBUG => LOG_DEBUG,
       }
 
-      def add(severity, message = nil, progname = nil, &block)
+      def add(severity, message = nil, progname = nil)
         priority = severity_to_priority(severity) || LEVEL_MAP[::Logger::UNKNOWN]
 
         # some black magic from Logger O__o
         progname ||= self.progname
         if message.nil?
           if block_given?
-            message = block.call
+            message = yield
           else
             message = progname
             progname = self.progname
           end
         end
 
-        send(
-            priority: priority,
-            message:  message,
-            syslog_identifier: progname,
+        send_message(
+          priority: priority,
+          message: message,
+          syslog_identifier: progname,
         )
       end
 
@@ -38,7 +38,7 @@ module Journald
 
       # add methods a la Logger.warn or Logger.error
       ::Logger::Severity::constants.each do |severity|
-        severity_key   = severity.downcase
+        severity_key = severity.downcase
         severity_value = ::Logger::Severity.const_get(severity)
 
         define_method(severity_key) do |progname = nil, &block|
@@ -60,7 +60,7 @@ module Journald
       # journald always logs everything
       def level
         priority = self.min_priority
-        LEVEL_MAP.select{|_,p| p <= priority}.keys.min
+        LEVEL_MAP.select { |_, p| p <= priority }.keys.min
       end
 
       def level=(severity)
@@ -101,9 +101,10 @@ module Journald
       def close; end
 
       private
-        def severity_to_priority(severity)
-          LEVEL_MAP[severity]
-        end
+
+      def severity_to_priority(severity)
+        LEVEL_MAP[severity]
+      end
     end
   end
 end

data/lib/journald/modules/version.rb

@@ -1,5 +1,5 @@
 module Journald
   class Logger
-    VERSION = '2.0.4'
+    VERSION = "3.0.0"
   end
 end

data/spec/journald_logger_spec.rb

@@ -1,39 +1,39 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe Journald::Logger do
-  describe 'acts as logger' do
+  describe "acts as logger" do
     before(:each) do
       allow(Journald::Native).to receive(:send).and_return(0)
-      @logger = Journald::Logger.new('rspec journald-logger', Journald::LOG_DEBUG)
+      @logger = Journald::Logger.new("rspec journald-logger", Journald::LOG_DEBUG)
     end
 
-    it 'logs things as logger' do
+    it "logs things as logger" do
       # todo: expects
-      @logger.warn 'test warn'
+      @logger.warn "test warn"
     end
 
-    it 'logs things as syslog' do
+    it "logs things as syslog" do
       # todo: expects
-      @logger.log_warning 'test log_warning'
+      @logger.log_warning "test log_warning"
     end
 
-    it 'adds tags' do
-      @logger.tag(tag1: 'value1')
-      @logger.tag(tag2: 'value2')
+    it "adds tags" do
+      @logger.tag(tag1: "value1")
+      @logger.tag(tag2: "value2")
 
-      expect(@logger.tag_value(:tag1)).to eq('value1')
+      expect(@logger.tag_value(:tag1)).to eq("value1")
 
-      @logger.tag(tag1: 'in-block-value') do
-        expect(@logger.tag_value(:tag1)).to eq('in-block-value')
+      @logger.tag(tag1: "in-block-value") do
+        expect(@logger.tag_value(:tag1)).to eq("in-block-value")
       end
 
-      expect(@logger.tag_value(:tag1)).to eq('value1') # expect old value to be restored
+      expect(@logger.tag_value(:tag1)).to eq("value1") # expect old value to be restored
     end
 
-    it 'logs exceptions' do
+    it "logs exceptions" do
       # todo: expects
       begin
-        raise 'logs exception'
+        raise "logs exception"
       rescue => e
         @logger.exception e
       end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'simplecov'
+require "simplecov"
 SimpleCov.start
 
-require_relative '../lib/journald/logger'
+require_relative "../lib/journald/logger"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: journald-logger
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 3.0.0
 platform: ruby
 authors:
 - Anton Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: journald-native
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -104,7 +133,7 @@ files:
 - lib/journald/modules/version.rb
 - spec/journald_logger_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/sandfoxme/journald-logger
+homepage: https://github.com/theforeman/journald-logger
 licenses:
 - MIT
 metadata: {}
@@ -123,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: systemd-journal native logger