lumberjack_syslog_device 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb001f870d1cfccdc29ec125be18dcff064b2d78e2731205db30704a9d2170c2
-  data.tar.gz: b9a73d61ec0ef1be9dd31cb35b36d405d265a8de5a2692480a3f98faef270c23
+  metadata.gz: 54c251e482e25bc736ad9947d10faee5afe7ea0df526df3ba7aaf80cb2487258
+  data.tar.gz: 1a190f22ebeb58d6b93388184b01270c8348f00444e3d94b122239c89791c9da
 SHA512:
-  metadata.gz: 15851b8b81b2480ca0735173b9f9e2fa1b4d05147d6b4d64979c06a984df8adfd965fe384e4b8073c4b219bb6973948ada88a2aaae3a3647b8ed175ba683c4b7
-  data.tar.gz: 537be3b73a57c3d62abbcb31442c9d88242fa44e884b4b73739e8f72edb0272a383fa9ed0110bfda74a931f705367ca7bae97be137b460345ec33cda011923bd
+  metadata.gz: 0d0091c9a2887b37f471fe65ce665fca5047d399c116ccf29305d401b1888c9094cd0c09bc98f4682043241aed7df2da0b1434b3d8e7959453bcb503b4a23ef0
+  data.tar.gz: 8dcb7a000c0c391fe1d92a07e7e0bf021fdd3120ddccdde277f5a33ff902bdb86f38a895b6437001ce61d039a9a42a8a7cbc772a86c53e58d7a7600a9b400a6f

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# Dependabot update strategy
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: weekly
+    allow:
+      # Automatically keep all runtime dependencies updated
+      - dependency-name: "*"
+        dependency-type: "production"
+    versioning-strategy: lockfile-only

data/.github/workflows/continuous_integration.yml

@@ -0,0 +1,47 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - main
+      - actions-*
+  pull_request:
+    branches-ignore:
+      - actions-*
+  workflow_dispatch:
+
+env:
+  BUNDLE_CLEAN: "true"
+  BUNDLE_PATH: vendor/bundle
+  BUNDLE_JOBS: 3
+  BUNDLE_RETRY: 3
+
+jobs:
+  build:
+    name: ${{ matrix.ruby }} build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - ruby: "ruby"
+            standardrb: true
+            yard: true
+          - ruby: "3.0"
+          - ruby: "2.7"
+    steps:
+    - uses: actions/checkout@v4
+    - 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: yard
+      if: matrix.yard == true
+      run:  bundle exec yard --fail-on-warning

data/.standard.yml

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

data/CHANGE_LOG.md

@@ -1,3 +1,38 @@
-# 2.0.0
+# Changelog
+All notable changes to this project will be documented in this file.
 
-* Add support for lumberjack 2.0 tags
+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.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,11 +1,12 @@
 # Lumberjack Syslog Device
 
-[![Build Status](https://travis-ci.org/bdurand/lumberjack_syslog_device.svg?branch=master)](https://travis-ci.org/bdurand/lumberjack_syslog_device)
-[![Maintainability](https://api.codeclimate.com/v1/badges/61785ec7e33012f55d65/maintainability)](https://codeclimate.com/github/bdurand/lumberjack_syslog_device/maintainability)
+[![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)
+[![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.
 
-## Example Usage
+## Usage
 
 ```ruby
 require 'lumberjack_syslog_device'
@@ -15,4 +16,32 @@ logger = Lumberjack::Logger.new(device)
 logger.info("Write me to syslog!")
 ```
 
-See SyslogDevice for more details.
+See the docs in the Lumberjack::SyslogDevice file for more details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lumberjack_syslog_device'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install lumberjack_syslog_device
+```
+
+## Contributing
+
+Open a pull request on GitHub.
+
+Please use the [standardrb](https://github.com/testdouble/standard) syntax and lint your code with `standardrb --fix` before submitting.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION

@@ -1 +1 @@
-1.1.0
+2.0.0

data/lib/lumberjack/syslog_device.rb

@@ -0,0 +1,136 @@
+# 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_facility = options[:facility]
+      @close_connection = options[:close_connection]
+      @syslog_identity = nil
+    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)
+      @@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
+
+    # Close the syslog connection.
+    #
+    # @return [void]
+    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
+  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).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 && @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) && @syslog_facility == syslog_impl.facility && @syslog_options == syslog_impl.options
-          return syslog_impl
-        else
-          syslog_impl.close
-        end
-      end
-      syslog = syslog_impl.open(progname, @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

@@ -1,16 +1,22 @@
 Gem::Specification.new do |spec|
-  spec.name = 'lumberjack_syslog_device'
+  spec.name = "lumberjack_syslog_device"
   spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
-  spec.authors = ['Brian Durand']
-  spec.email = ['bbdurand@gmail.com']
+  spec.authors = ["Brian Durand"]
+  spec.email = ["bbdurand@gmail.com"]
 
   spec.summary = "A logging device for the lumberjack gem that writes log entries to syslog."
   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/CHANGE_LOG.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(
+  ignore_files = %w[
     .gitignore
     .travis.yml
     Appraisals
@@ -19,15 +25,17 @@ Gem::Specification.new do |spec|
     Rakefile
     gemfiles/
     spec/
-  )
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject{ |f| ignore_files.any?{ |path| f.start_with?(path) } }
+  ]
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
   end
 
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">=2.7"
 
-  spec.add_dependency "lumberjack", ">=1.1"
+  spec.add_dependency "lumberjack", ">=2.0"
+  spec.add_dependency "syslog"
 
-  spec.add_development_dependency("rspec", ["~> 3.0"])
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack_syslog_device
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brian Durand
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lumberjack
@@ -16,30 +15,30 @@ 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: rspec
+  name: syslog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,24 +51,29 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
 email:
 - bbdurand@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/continuous_integration.yml"
+- ".standard.yml"
 - CHANGE_LOG.md
-- MIT_LICENSE
+- 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/CHANGE_LOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -77,15 +81,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A logging device for the lumberjack gem that writes log entries to syslog.
 test_files: []