lumberjack_syslog_device 1.1.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05cda0528c884ab6d20bc8248c33a4ceaea7e03d7290597a0f38a416792298dd
-  data.tar.gz: 77d51847f6bedd3c998084b6d7346351f3757cb7981f8b97f06b76a053ca6c13
+  metadata.gz: ae9edfa3889248b54ab6ab7daca3d417a6879a1a16bd15cda77b9f913f19d418
+  data.tar.gz: c416513472887a7b4a34ff6194d84db8620a485298f0cd03e542d2270a26448c
 SHA512:
-  metadata.gz: 531c7966e066dd4618058306c096553cad8fd6ce36e0e40794bcaffad6ec1bee8456cf3178c456ea6b99a896a066f98a5af1406fb577a5b4123286bd2c0f92a0
-  data.tar.gz: 848b6bc544c0e437648e1f7b73d337f8b83790ab264cc8f8f667367a1be3c3c6d12973fc13a4834781b9976826759d80f5ea5bf9d43245ec17f9b6068c02c14b
+  metadata.gz: 6c6d7ad6cb82f45738370573a8d215a658296848b54f87e663819b20178ab6363872fc4aaac6edd9786238bfe1930721351969d89e9ce09e9f7b233585518242
+  data.tar.gz: d31ba78fa6219ebeffd579c6edeb54d119e3d24c6df85c0a86930d9e9652d966ebea4c6566ab8878df1d0cb2b9567fec03e7f79ca6c1d57dc2a2cb62185d4554

data/.github/dependabot.yml

@@ -1,4 +1,3 @@
-# Dependabot update strategy
 version: 2
 updates:
   - package-ecosystem: bundler
@@ -6,7 +5,10 @@ updates:
     schedule:
       interval: weekly
     allow:
-      # Automatically keep all runtime dependencies updated
       - dependency-name: "*"
         dependency-type: "production"
-    versioning-strategy: lockfile-only
+    versioning-strategy: increase-if-necessary
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly

data/.github/workflows/continuous_integration.yml

@@ -3,19 +3,12 @@ name: Continuous Integration
 on:
   push:
     branches:
-      - master
+      - main
       - actions-*
-    tags:
-      - v*
   pull_request:
     branches-ignore:
       - actions-*
-
-env:
-  BUNDLE_CLEAN: "true"
-  BUNDLE_PATH: vendor/bundle
-  BUNDLE_JOBS: 3
-  BUNDLE_RETRY: 3
+  workflow_dispatch:
 
 jobs:
   build:
@@ -26,22 +19,20 @@ jobs:
         include:
           - ruby: "ruby"
             standardrb: true
+            yard: true
           - ruby: "3.0"
           - ruby: "2.7"
-          - ruby: "2.6"
-          - ruby: "2.5"
-          - ruby: "2.4"
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby}}
-    - name: Install gems
-      run: |
-        bundle install
-    - name: Run Tests
-      run: bundle exec rake
-    - name: standardrb
-      if: matrix.standardrb
-      run:  bundle exec standardrb
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Ruby CI
+        uses: bdurand/github-actions/ruby-ci@b7560883d5f8557f5d69fe8bd82721bbb5ed76df # v1.0.4
+        with:
+          ruby: ${{ matrix.ruby }}
+          appraisal: ${{ matrix.appraisal }}
+          bundler: ${{ matrix.bundler }}
+          standardrb: ${{ matrix.standardrb }}
+          yard: ${{ matrix.yard }}
+          frozen_strings: ${{ matrix.frozen_strings }}

data/.standard.yml

@@ -1,10 +1,3 @@
-# I really just have issues with the automatic "semantic blocks"
-
-ruby_version: 2.4
+ruby_version: 2.7
 
 format: progress
-
-ignore:
-  - 'spec/**/*':
-    - Lint/UselessAssignment
-    - Lint/Void

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 2.0.1
+
+### Fixed
+
+- Fixed `close` raising a `NoMethodError` due to referencing an unset lock and connection.
+- Fixed the syslog connection being closed and reopened on every write when using the default facility. The facility now defaults to `Syslog::LOG_USER` so the connection reuse check matches what syslog reports.
+- A nil progname now opens syslog with a nil ident so syslog defaults to the program name instead of an empty string.
+- Unmapped severity values are now logged as `Syslog::LOG_ALERT` instead of raising a `TypeError`.
+- The log mask is now reset when reusing a connection opened elsewhere with a more restrictive mask.
+
+## 2.0.0
+
+### Added
+
+- Lumberjack 2 support.
+
+### Changed
+
+- Updated default template to `{{message}} {{attributes}}`. Unit of work is no longer supported in Lumberjack 2.
+- Updated attribute formatting to use tag formatting specified in the `:tag_format` option rather than hardcoding the format.
+
+### Removed
+
+- Support for Ruby < 2.7.
+
+## 1.1.1
+
+### Changed
+
+- Always cast values to strings before logging to syslog (thanks @eremeyev).
+
+## 1.1.0
+
+### Added
+
+- Add support for lumberjack 1.1 tags.
+
+## 1.0.0
+
+### Added
+
+- Initial release.

data/README.md

@@ -1,8 +1,8 @@
 # Lumberjack Syslog Device
 
 [![Continuous Integration](https://github.com/bdurand/lumberjack_syslog_device/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/lumberjack_syslog_device/actions/workflows/continuous_integration.yml)
-[![Regression Test](https://github.com/bdurand/lumberjack_syslog_device/actions/workflows/regression_test.yml/badge.svg)](https://github.com/bdurand/lumberjack_syslog_device/actions/workflows/regression_test.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/lumberjack_syslog_device.svg)](https://badge.fury.io/rb/lumberjack_syslog_device)
 
 This gem provides a logging device for the [lumberjack](https://github.com/bdurand/lumberjack) gem that will log to syslog, the centralized system logging facility. See http://en.wikipedia.org/wiki/Syslog for more information on syslog.
 

data/VERSION

@@ -1 +1 @@
-1.1.1
+2.0.1

data/lib/lumberjack/syslog_device.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "syslog"
+require "lumberjack"
+
+# Lumberjack is a simple, powerful, and very fast logging utility that can be a drop
+# in replacement for Logger or ActiveSupport::BufferedLogger.
+module Lumberjack
+  # This Lumberjack device logs output to syslog. There can only be one connection to syslog
+  # open at a time. If you use syslog elsewhere in your application, you'll need to pass
+  # :close_connection => true to the constructor. Otherwise, the connection will be kept
+  # open between +write+ calls.
+  class SyslogDevice < Device
+    VERSION = ::File.read(::File.join(__dir__, "..", "..", "VERSION")).strip.freeze
+
+    # Mapping of Lumberjack severity levels to syslog priority levels
+    SEVERITY_MAP = {
+      Severity::TRACE => Syslog::LOG_DEBUG,
+      Severity::DEBUG => Syslog::LOG_DEBUG,
+      Severity::INFO => Syslog::LOG_INFO,
+      Severity::WARN => Syslog::LOG_WARNING,
+      Severity::ERROR => Syslog::LOG_ERR,
+      Severity::FATAL => Syslog::LOG_CRIT,
+      Severity::UNKNOWN => Syslog::LOG_ALERT
+    }
+
+    # Literal percent character
+    PERCENT = "%"
+    # Escaped percent character for syslog format strings
+    ESCAPED_PERCENT = "%%"
+
+    # Default template for formatting log messages
+    DEFAULT_TEMPLATE = "{{message}} {{attributes}}"
+    # Default format for rendering log entry attributes
+    DEFAULT_ATTRIBUTE_FORMAT = "[%s:%s]"
+
+    DeviceRegistry.add(:syslog, self)
+
+    @@lock = Mutex.new
+
+    # Create a new SyslogDevice. The options control how messages are written to syslog.
+    #
+    # The template can be specified using the :template option. This can
+    # either be a Proc or a string that will compile into a Template object.
+    # If the template is a Proc, it should accept an LogEntry as its only argument and output a string.
+    # If the template is a template string, it will be used to create a Template.
+    # The default template is +{{message}} {{attributes}}+.
+    #
+    # The :close_connection option can be used to specify that the connection to syslog should be
+    # closed after every +write+ call. This will slow down performance, but will allow you to use syslog
+    # elsewhere in your application.
+    #
+    # The :options option will pass through options to syslog. The default is
+    # Syslog::LOG_PID | Syslog::LOG_CONS. Available values for the bit map are:
+    # * Syslog::LOG_CONS - Write directly to system console if there is an error while sending to system logger.
+    # * Syslog::LOG_NDELAY - Open the connection immediately (normally, the connection is opened when the first message is logged).
+    # * Syslog::LOG_NOWAIT - Don't wait for child processes that may have been created while logging the message.
+    # * Syslog::LOG_ODELAY - The converse of LOG_NDELAY; opening of the connection is delayed.
+    # * Syslog::LOG_PERROR - Print to stderr as well.
+    # * Syslog::LOG_PID - Include PID with each message.
+    #
+    # The :facility option will pass through a facility to syslog. Available values are
+    # * Syslog::LOG_AUTH
+    # * Syslog::LOG_AUTHPRIV
+    # * Syslog::LOG_CRON
+    # * Syslog::LOG_DAEMON
+    # * Syslog::LOG_FTP
+    # * Syslog::LOG_KERN
+    # * Syslog::LOG_LOCAL0 through Syslog::LOG_LOCAL7
+    # * Syslog::LOG_LPR
+    # * Syslog::LOG_MAIL
+    # * Syslog::LOG_NEWS
+    # * Syslog::LOG_SYSLOG
+    # * Syslog::LOG_USER (default)
+    # * Syslog::LOG_UUCP
+    def initialize(options = {})
+      @template = options[:template] || DEFAULT_TEMPLATE
+      attribute_format = options[:attribute_format] || DEFAULT_ATTRIBUTE_FORMAT
+      @template = Template.new(@template, attribute_format: attribute_format) if @template.is_a?(String)
+
+      @syslog_options = options[:options] || (Syslog::LOG_PID | Syslog::LOG_CONS)
+      # Syslog substitutes LOG_USER for a nil facility; normalize here so the
+      # connection reuse check in open_syslog matches what syslog reports back.
+      @syslog_facility = options[:facility] || Syslog::LOG_USER
+      @close_connection = options[:close_connection]
+    end
+
+    # Write a log entry to syslog.
+    #
+    # @param entry [Lumberjack::LogEntry] the log entry to write
+    # @return [void]
+    def write(entry)
+      message = @template.call(entry).to_s.chomp.gsub(PERCENT, ESCAPED_PERCENT)
+      severity = SEVERITY_MAP[entry.severity] || Syslog::LOG_ALERT
+      @@lock.synchronize do
+        syslog = open_syslog(entry.progname)
+        begin
+          syslog.log(severity, message)
+        ensure
+          syslog.close if @close_connection
+        end
+      end
+    end
+
+    # Close the syslog connection.
+    #
+    # @return [void]
+    def close
+      flush
+      @@lock.synchronize do
+        syslog_implementation.close if syslog_implementation.opened?
+      end
+    end
+
+    private
+
+    # Open syslog with ident set to progname. If it is already open with a different
+    # ident, close it and reopen it.
+    def open_syslog(progname) # :nodoc:
+      syslog_impl = syslog_implementation
+      if syslog_impl.opened?
+        if (progname.nil? || syslog_impl.ident == progname.to_s) && @syslog_facility == syslog_impl.facility && @syslog_options == syslog_impl.options
+          syslog_impl.mask = Syslog::LOG_UPTO(Syslog::LOG_DEBUG)
+          return syslog_impl
+        else
+          syslog_impl.close
+        end
+      end
+      # Pass nil rather than an empty string when there is no progname so that
+      # syslog falls back to the program name for the ident.
+      syslog = syslog_impl.open(progname&.to_s, @syslog_options, @syslog_facility)
+      syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_DEBUG)
+      syslog
+    end
+
+    # Provided for testing purposes
+    def syslog_implementation # :nodoc:
+      Syslog
+    end
+  end
+end

data/lib/lumberjack_syslog_device.rb

@@ -1,128 +1,3 @@
 # frozen_string_literal: true
 
-require "syslog"
-require "lumberjack"
-
-module Lumberjack
-  # This Lumberjack device logs output to syslog. There can only be one connection to syslog
-  # open at a time. If you use syslog elsewhere in your application, you'll need to pass
-  # :close_connection => true to the constructor. Otherwise, the connection will be kept
-  # open between +write+ calls.
-  class SyslogDevice < Device
-    SEVERITY_MAP = {
-      Severity::DEBUG => Syslog::LOG_DEBUG,
-      Severity::INFO => Syslog::LOG_INFO,
-      Severity::WARN => Syslog::LOG_WARNING,
-      Severity::ERROR => Syslog::LOG_ERR,
-      Severity::FATAL => Syslog::LOG_CRIT,
-      Severity::UNKNOWN => Syslog::LOG_ALERT
-    }
-
-    PERCENT = "%"
-    ESCAPED_PERCENT = "%%"
-
-    @@lock = Mutex.new
-
-    # Create a new SyslogDevice. The options control how messages are written to syslog.
-    #
-    # The template can be specified using the :template option. This can
-    # either be a Proc or a string that will compile into a Template object.
-    # If the template is a Proc, it should accept an LogEntry as its only argument and output a string.
-    # If the template is a template string, it will be used to create a Template.
-    # The default template is `:message (#:unit_of_work_id) :tags`.
-    #
-    # The :close_connection option can be used to specify that the connection to syslog should be
-    # closed after every +write+ call. This will slow down performance, but will allow you to use syslog
-    # elsewhere in your application.
-    #
-    # The :options option will pass through options to syslog. The default is
-    # Syslog::LOG_PID | Syslog::LOG_CONS. Available values for the bit map are:
-    # * Syslog::LOG_CONS - Write directly to system console if there is an error while sending to system logger.
-    # * Syslog::LOG_NDELAY - Open the connection immediately (normally, the connection is opened when the first message is logged).
-    # * Syslog::LOG_NOWAIT - Don't wait for child processes that may have been created while logging the message.
-    # * Syslog::LOG_ODELAY - The converse of LOG_NDELAY; opening of the connection is delayed.
-    # * Syslog::LOG_PERROR - Print to stderr as well.
-    # * Syslog::LOG_PID - Include PID with each message.
-    #
-    # The :facility option will pass through a facility to syslog. Available values are
-    # * Syslog::LOG_AUTH
-    # * Syslog::LOG_AUTHPRIV
-    # * Syslog::LOG_CRON
-    # * Syslog::LOG_DAEMON
-    # * Syslog::LOG_FTP
-    # * Syslog::LOG_KERN
-    # * Syslog::LOG_LOCAL0 through Syslog::LOG_LOCAL7
-    # * Syslog::LOG_LPR
-    # * Syslog::LOG_MAIL
-    # * Syslog::LOG_NEWS
-    # * Syslog::LOG_SYSLOG
-    # * Syslog::LOG_USER (default)
-    # * Syslog::LOG_UUCP
-    def initialize(options = {})
-      @template = options[:template] || default_template
-      @template = Template.new(@template) if @template.is_a?(String)
-      @syslog_options = options[:options] || (Syslog::LOG_PID | Syslog::LOG_CONS)
-      @syslog_facility = options[:facility]
-      @close_connection = options[:close_connection]
-      @syslog_identity = nil
-    end
-
-    def write(entry)
-      message = @template.call(entry).to_s.gsub(PERCENT, ESCAPED_PERCENT)
-      @@lock.synchronize do
-        syslog = open_syslog(entry.progname)
-        begin
-          syslog.log(SEVERITY_MAP[entry.severity], message)
-        ensure
-          syslog.close if @close_connection
-        end
-      end
-    end
-
-    def close
-      flush
-      @lock.synchronize do
-        @syslog.close if @syslog&.opened?
-      end
-    end
-
-    private
-
-    # Open syslog with ident set to progname. If it is already open with a different
-    # ident, close it and reopen it.
-    def open_syslog(progname) # :nodoc:
-      syslog_impl = syslog_implementation
-      if syslog_impl.opened?
-        if (progname.nil? || syslog_impl.ident == progname.to_s) && @syslog_facility == syslog_impl.facility && @syslog_options == syslog_impl.options
-          return syslog_impl
-        else
-          syslog_impl.close
-        end
-      end
-      syslog = syslog_impl.open(progname.to_s, @syslog_options, @syslog_facility)
-      syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_DEBUG)
-      syslog
-    end
-
-    # Provided for testing purposes
-    def syslog_implementation # :nodoc:
-      Syslog
-    end
-
-    def default_template
-      lambda do |entry|
-        tags = entry.tags
-        if tags && !tags.empty?
-          message = String.new(entry.message)
-          message << " (#{entry.unit_of_work_id})" if entry.unit_of_work_id
-          tags.each do |name, value|
-            message << " [#{name}:#{value.inspect}]" unless name == Lumberjack::LogEntry::UNIT_OF_WORK_ID
-          end
-          message
-        else
-          entry.message
-        end
-      end
-    end
-  end
-end
+require_relative "lumberjack/syslog_device"

data/lumberjack_syslog_device.gemspec

@@ -8,6 +8,12 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/bdurand/lumberjack_syslog_device"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   ignore_files = %w[
@@ -26,9 +32,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">=2.4"
-
-  spec.add_dependency "lumberjack", ">=1.1"
+  spec.required_ruby_version = ">=2.7"
 
-  spec.add_development_dependency "bundler"
+  spec.add_dependency "lumberjack", ">=2.0"
+  spec.add_dependency "syslog"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack_syslog_device
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lumberjack
@@ -16,29 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: syslog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -47,19 +45,21 @@ extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
 - ".github/workflows/continuous_integration.yml"
-- ".github/workflows/regression_test.yml"
 - ".standard.yml"
-- CHANGE_LOG.md
-- MIT_LICENSE
+- CHANGELOG.md
+- MIT_LICENSE.txt
 - README.md
 - VERSION
+- lib/lumberjack/syslog_device.rb
 - lib/lumberjack_syslog_device.rb
 - lumberjack_syslog_device.gemspec
 homepage: https://github.com/bdurand/lumberjack_syslog_device
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/bdurand/lumberjack_syslog_device
+  source_code_uri: https://github.com/bdurand/lumberjack_syslog_device
+  changelog_uri: https://github.com/bdurand/lumberjack_syslog_device/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -67,15 +67,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A logging device for the lumberjack gem that writes log entries to syslog.
 test_files: []

data/.github/workflows/regression_test.yml

@@ -1,29 +0,0 @@
-name: Regression Test
-on:
-  workflow_dispatch:
-  schedule:
-    - cron: "0 15 * * 1"
-env:
-  BUNDLE_CLEAN: "true"
-  BUNDLE_PATH: vendor/bundle
-  BUNDLE_JOBS: 3
-  BUNDLE_RETRY: 3
-jobs:
-  specs:
-    name: Run specs
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Set up Ruby ${{ matrix.ruby }}
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ruby
-      - name: Install bundler
-        run: |
-          bundle update
-      - name: Run specs
-        run: |
-          bundle exec rake spec

data/CHANGE_LOG.md

@@ -1,23 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## 1.1.1
-
-### Changed
-
-- Always cast values to strings before logging to syslog (thanks @eremeyev).
-
-## 1.1.0
-
-### Added
-
-- Add support for lumberjack 2.0 tags.
-
-## 1.0.0
-
-### Added
-
-- Initial release.