syslog 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52f533359f850a1836a3161e0f87512e7db229c3f2914766e55797e60a283806
-  data.tar.gz: 28c1054089a598e4784387f3a98f192189683b5673f46355694f1561d2d4c103
+  metadata.gz: 83c32c413293d9c1902db61758c3f53403e5e0f1218a8ec8fa1477eb63413559
+  data.tar.gz: 49df9dd2ac69c88ebd80c2b3d572066c65382295e791ad688aa30eb758667e02
 SHA512:
-  metadata.gz: a86150afc0aa20e6af3ef8cca7f135030b58aeedec37dca817e0747a2c67af56712af042f0265b9f4968a171690ca03d4f4b1c1ac86b9d0361aa2224d71c65fc
-  data.tar.gz: b931344ddf90fa04c8a84361a032fd864e7572c0d5efbd0659bbb667b9804ba1a44b59615f57645536b2e47ed33b3d763a81c332d6f1a6b9735814d0d0df84b6
+  metadata.gz: ca7483657ae6615cffeedd4fbf9641863eae3ac1e7f1f2cfddf3a634fc99c16e0dc8661d72c247e359654e56108c6b907465e97a76e653b328f2a42c307b06aa
+  data.tar.gz: 3df3ce9c54557473f754e57f7792419ca2c9b52301b8c8cd14a786238de2a052a448ae9de4f9b6b8dc10bd1d1bdc38ffde9611a3612a76f87e8663c3671e9304

data/.github/release.yml

@@ -0,0 +1,4 @@
+changelog:
+  exclude:
+    labels:
+      - dependencies # Added by Dependabot

data/.github/workflows/push_gem.yml

@@ -23,24 +23,24 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1
         with:
           egress-policy: audit
 
-      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@a6e6f86333f0a2523ece813039b8b4be04560854 # v1.190.0
+        uses: ruby/setup-ruby@90be1154f987f4dc0fe0dd0feedac9e473aa4ba8 # v1.286.0
         with:
           bundler-cache: true
           ruby-version: ruby
 
       - name: Publish to RubyGems
-        uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32 # v1.1.1
+        uses: rubygems/release-gem@1c162a739e8b4cb21a676e97b087e8268d8fc40b # v1.1.2
 
       - name: Create GitHub release
         run: |
           tag_name="$(git describe --tags --abbrev=0)"
           gh release create "${tag_name}" --verify-tag --generate-notes
         env:
-          GITHUB_TOKEN: ${{ secrets.MATZBOT_GITHUB_WORKFLOW_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/test.yml

@@ -3,21 +3,31 @@ name: build
 on: [push, pull_request]
 
 jobs:
+  ruby-versions:
+    uses: ruby/actions/.github/workflows/ruby_versions.yml@master
+    with:
+      min_version: 2.5
+
   build:
+    needs: ruby-versions
     name: build (${{ matrix.ruby }} / ${{ matrix.os }})
     strategy:
+      fail-fast: false
       matrix:
-        ruby: [ 2.7, 2.6, 2.5, head ]
+        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
         os: [ ubuntu-latest, macos-latest, windows-latest ]
         exclude:
           - { os: macos-latest, ruby: '2.5' }
+          - { os: windows-latest, ruby: 'truffleruby' }
+          - { os: windows-latest, ruby: 'truffleruby-head' }
         include:
-          - { os: macos-13, ruby: '2.5' }
+          - { os: macos-15-intel, ruby: '2.5' }
+          - { os: macos-15-intel, ruby: '3.4' }
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
     - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@90be1154f987f4dc0fe0dd0feedac9e473aa4ba8 # v1.286.0
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: Install dependencies

data/Rakefile

@@ -7,14 +7,20 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
-require 'rake/extensiontask'
-Rake::ExtensionTask.new("syslog_ext") do |ext|
-  ext.ext_dir = 'ext/syslog'
+if RUBY_ENGINE == 'jruby'
+  # nothing to compile for JRuby
+  task :compile do end
+else
+  require 'rake/extensiontask'
+  Rake::ExtensionTask.new("syslog_ext") do |ext|
+    ext.ext_dir = 'ext/syslog'
 
-  # In contrast to "gem install" a "rake compile" is expecting the C-ext file even on Windows.
-  # Work around by creating a dummy so file.
-  task "#{ext.tmp_dir}/#{ext.platform}/stage/lib" do |t|
-    touch "#{ext.tmp_dir}/#{ext.platform}/#{ext.name}/#{RUBY_VERSION}/#{ext.name}.so"
+    # In contrast to "gem install" a "rake compile" is expecting the C-ext file even on Windows.
+    # Work around by creating a dummy so file.
+    task "#{ext.tmp_dir}/#{ext.platform}/stage/lib" do |t|
+      touch "#{ext.tmp_dir}/#{ext.platform}/#{ext.name}/#{RUBY_VERSION}/#{ext.name}.so"
+    end
   end
 end
+
 task :default => :test

data/ext/syslog/extconf.rb

@@ -14,7 +14,7 @@ def windows?
   RbConfig::CONFIG["host_os"] =~ /mswin|mingw/
 end
 
-if windows?
+if windows? || RUBY_ENGINE == 'jruby'
   generate_dummy_makefile
 else
   have_library("log") # for Android

data/ext/syslog/syslog.c

@@ -12,7 +12,7 @@
 #include "ruby/util.h"
 #include <syslog.h>
 
-#define SYSLOG_VERSION "0.3.0"
+#define SYSLOG_VERSION "0.4.0"
 
 /* Syslog class */
 static VALUE mSyslog;

data/lib/syslog/jruby.rb

@@ -0,0 +1,364 @@
+#  Created by Ari Brown on 2008-02-23.
+#  For rubinius. All pwnage reserved.
+
+# ** Syslog(Module)
+
+# Included Modules: Syslog::Constants
+
+# require 'syslog'
+
+# A Simple wrapper for the UNIX syslog system calls that might be handy
+# if you're writing a server in Ruby.  For the details of the syslog(8)
+# architecture and constants, see the syslog(3) manual page of your
+# platform.
+require 'ffi'
+
+if FFI::Platform::IS_WINDOWS
+  raise LoadError, "Syslog not supported on this platform"
+end
+
+module Syslog
+  module Constants
+    Java::jnr.constants.platform.Syslog.values.each do |const|
+      next if const.name == '__UNKNOWN_CONSTANT__'
+      next if !const.defined?
+      const_set const.name, const.value
+    end
+  end
+  include Constants
+
+  module Level
+    if defined? Constants::LOG_EMERG
+      LOG_EMERG = Constants::LOG_EMERG
+
+      def emerg(*args)
+        Syslog.log(LOG_EMERG, *args)
+      end
+    end
+    if defined? Constants::LOG_ALERT
+      LOG_ALERT = Constants::LOG_ALERT
+
+      def alert(*args)
+        Syslog.log(LOG_ALERT, *args)
+      end
+    end
+    if defined? Constants::LOG_CRIT
+      LOG_CRIT = Constants::LOG_CRIT
+
+      def crit(*args)
+        Syslog.log(LOG_CRIT, *args)
+      end
+    end
+    if defined? Constants::LOG_ERR
+      LOG_ERR = Constants::LOG_ERR
+
+      def err(*args)
+        Syslog.log(LOG_ERR, *args)
+      end
+    end
+    if defined? Constants::LOG_WARNING
+      LOG_WARNING = Constants::LOG_WARNING
+
+      def warning(*args)
+        Syslog.log(LOG_WARNING, *args)
+      end
+    end
+    if defined? Constants::LOG_NOTICE
+      LOG_NOTICE = Constants::LOG_NOTICE
+
+      def notice(*args)
+        Syslog.log(LOG_NOTICE, *args)
+      end
+    end
+    if defined? Constants::LOG_INFO
+      LOG_INFO = Constants::LOG_INFO
+
+      def info(*args)
+        Syslog.log(LOG_INFO, *args)
+      end
+    end
+    if defined? Constants::LOG_DEBUG
+      LOG_DEBUG = Constants::LOG_DEBUG
+
+      def debug(*args)
+        syslog_write(LOG_DEBUG, *args)
+      end
+    end
+  end
+
+  module Facility
+    if defined? Constants::LOG_AUTH
+      LOG_AUTH = Constants::LOG_AUTH
+    end
+    if defined? Constants::LOG_AUTHPRIV
+      LOG_AUTHPRIV = Constants::LOG_AUTHPRIV
+    end
+    if defined? Constants::LOG_CONSOLE
+      LOG_CONSOLE = Constants::LOG_CONSOLE
+    end
+    if defined? Constants::LOG_CRON
+      LOG_CRON = Constants::LOG_CRON
+    end
+    if defined? Constants::LOG_DAEMON
+      LOG_DAEMON = Constants::LOG_DAEMON
+    end
+    if defined? Constants::LOG_FTP
+      LOG_FTP = Constants::LOG_FTP
+    end
+    if defined? Constants::LOG_KERN
+      LOG_KERN = Constants::LOG_KERN
+    end
+    if defined? Constants::LOG_LPR
+      LOG_LPR = Constants::LOG_LPR
+    end
+    if defined? Constants::LOG_MAIL
+      LOG_MAIL = Constants::LOG_MAIL
+    end
+    if defined? Constants::LOG_NEWS
+      LOG_NEWS = Constants::LOG_NEWS
+    end
+    if defined? Constants::LOG_NTP
+      LOG_NTP = Constants::LOG_NTP
+    end
+    if defined? Constants::LOG_SECURITY
+      LOG_SECURITY = Constants::LOG_SECURITY
+    end
+    if defined? Constants::LOG_SYSLOG
+      LOG_SYSLOG = Constants::LOG_SYSLOG
+    end
+    if defined? Constants::LOG_USER
+      LOG_USER = Constants::LOG_USER
+    end
+    if defined? Constants::LOG_UUCP
+      LOG_UUCP = Constants::LOG_UUCP
+    end
+    if defined? Constants::LOG_LOCAL0
+      LOG_LOCAL0 = Constants::LOG_LOCAL0
+    end
+    if defined? Constants::LOG_LOCAL1
+      LOG_LOCAL1 = Constants::LOG_LOCAL1
+    end
+    if defined? Constants::LOG_LOCAL2
+      LOG_LOCAL2 = Constants::LOG_LOCAL2
+    end
+    if defined? Constants::LOG_LOCAL3
+      LOG_LOCAL3 = Constants::LOG_LOCAL3
+    end
+    if defined? Constants::LOG_LOCAL4
+      LOG_LOCAL4 = Constants::LOG_LOCAL4
+    end
+    if defined? Constants::LOG_LOCAL5
+      LOG_LOCAL5 = Constants::LOG_LOCAL5
+    end
+    if defined? Constants::LOG_LOCAL6
+      LOG_LOCAL6 = Constants::LOG_LOCAL6
+    end
+    if defined? Constants::LOG_LOCAL7
+      LOG_LOCAL7 = Constants::LOG_LOCAL7
+    end
+  end
+
+  module Foreign
+    extend FFI::Library
+    ffi_lib FFI::Platform::LIBC
+
+    # methods
+    attach_function :open, "openlog", [:pointer, :int, :int], :void
+    attach_function :close, "closelog", [], :void
+    attach_function :write, "syslog", [:int, :string, :varargs], :void
+    attach_function :set_mask, "setlogmask", [:int], :int
+  end
+
+  class << self
+
+    ##
+    # returns the ident of the last open call
+    def ident
+      @opened ? @ident : nil
+    end
+
+    ##
+    # returns the options of the last open call
+    def options
+      @opened ? @options : nil
+    end
+
+    ##
+    # returns the facility of the last open call
+    def facility
+      @opened ? @facility : nil
+    end
+
+    ##
+    # mask
+    #   mask=(mask)
+    #
+    # Returns or sets the log priority mask.  The value of the mask
+    # is persistent and will not be reset by Syslog::open or
+    # Syslog::close.
+    #
+    # Example:
+    #   Syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_ERR)
+    def mask
+      @mask ||= -1
+      @opened ? @mask : nil
+    end
+    attr_writer :mask
+
+    ##
+    #   open(ident = $0, logopt = Syslog::LOG_PID | Syslog::LOG_CONS, facility = Syslog::LOG_USER) [{ |syslog| ... }]
+    #
+    # Opens syslog with the given options and returns the module
+    # itself.  If a block is given, calls it with an argument of
+    # itself.  If syslog is already opened, raises RuntimeError.
+    #
+    # Examples:
+    #   Syslog.open('ftpd', Syslog::LOG_PID | Syslog::LOG_NDELAY, Syslog::LOG_FTP)
+    #   open!(ident = $0, logopt = Syslog::LOG_PID | Syslog::LOG_CONS, facility = Syslog::LOG_USER)
+    #   reopen(ident = $0, logopt = Syslog::LOG_PID | Syslog::LOG_CONS, facility = Syslog::LOG_USER)
+    def open(ident=nil, opt=nil, fac=nil)
+      raise "Syslog already open" unless not @opened
+
+      ident ||= $0
+      opt ||= Constants::LOG_PID | Constants::LOG_CONS
+      fac ||= Constants::LOG_USER
+
+      @ident = ident
+      @options = opt
+      @facility = fac
+      @ident_memory = if ident
+                        FFI::MemoryPointer.from_string(ident)
+                      else
+                        nil
+                      end
+      Foreign.open(@ident_memory, opt, fac)
+
+      @opened = true
+
+      # Calling set_mask twice is the standard way to set the 'default' mask
+      @mask = Foreign.set_mask(0)
+      Foreign.set_mask(@mask)
+
+      if block_given?
+        begin
+          yield self
+        ensure
+          close
+        end
+      end
+
+      self
+    end
+
+    ##
+    # like open, but closes it first
+    def reopen(*args, &block)
+      close
+      open(*args, &block)
+    end
+
+    alias_method :open!, :reopen
+
+    ##
+    # Is it open?
+    def opened?
+      @opened || false
+    end
+
+    ##
+    # Close the log
+    # close will raise an error if it is already closed
+    def close
+      raise "Syslog not opened" unless @opened
+
+      Foreign.close
+      @ident = nil
+      @options = @facility = @mask = -1;
+      @opened = false
+    end
+
+    ##
+    #   log(Syslog::LOG_CRIT, "The %s is falling!", "sky")
+    #
+    # Doesn't take any platform specific printf statements
+    #   logs things to $stderr
+    #   log(Syslog::LOG_CRIT, "Welcome, %s, to my %s!", "leethaxxor", "lavratory")
+    def log(pri, *args)
+      write(pri, *args)
+    end
+
+    ##
+    # handy little shortcut for LOG_EMERG as the priority
+    def emerg(*args);  write(Syslog::LOG_EMERG,   *args); end
+
+    ##
+    # handy little shortcut for LOG_ALERT as the priority
+    def alert(*args);  write(Syslog::LOG_ALERT,   *args); end
+
+    ##
+    # handy little shortcut for LOG_ERR as the priority
+    def err(*args);    write(Syslog::LOG_ERR,     *args); end
+
+    ##
+    # handy little shortcut for LOG_CRIT as the priority
+    def crit(*args);   write(Syslog::LOG_CRIT,    *args); end
+
+    ##
+    # handy little shortcut for LOG_WARNING as the priority
+    def warning(*args);write(Syslog::LOG_WARNING, *args); end
+
+    ##
+    # handy little shortcut for LOG_NOTICE as the priority
+    def notice(*args); write(Syslog::LOG_NOTICE,  *args); end
+
+    ##
+    # handy little shortcut for LOG_INFO as the priority
+    def info(*args);   write(Syslog::LOG_INFO,    *args); end
+
+    ##
+    # handy little shortcut for LOG_DEBUG as the priority
+    def debug(*args);  write(Syslog::LOG_DEBUG,   *args); end
+
+    ##
+    #   LOG_MASK(pri)
+    #
+    # HACK copied from macro
+    # Creates a mask for one priority.
+    def LOG_MASK(pri)
+      1 << pri
+    end
+
+    ##
+    #   LOG_UPTO(pri)
+    # HACK copied from macro
+    # Creates a mask for all priorities up to pri.
+    def LOG_UPTO(pri)
+      (1 << ((pri)+1)) - 1
+    end
+
+    def inspect
+      if @opened
+        "<#%s: opened=true, ident=\"%s\", options=%d, facility=%d, mask=%d>" %
+          [self.name, @ident, @options, @facility, @mask]
+      else
+        "<##{self.name}: opened=false>"
+      end
+    end
+
+    ##
+    #   Syslog.instance # => Syslog
+    # Returns the Syslog module
+    def instance
+      self
+    end
+
+    FORMAT_STRING = '%s'
+    def write(pri, format, *args)
+      raise "Syslog must be opened before write" unless @opened
+
+      message = format % args
+      Foreign.write(pri, FORMAT_STRING, :string, message, :pointer, nil)
+    end
+    private :write
+  end
+end

data/lib/syslog.rb

@@ -1,10 +1,14 @@
 begin
-  require 'syslog_ext'
+  if RUBY_ENGINE == 'jruby'
+    require 'syslog/jruby'
+  else
+    require 'syslog_ext'
+  end
 rescue LoadError
   raise LoadError.new(<<-EOS)
-    Can't load Syslog!
-
-    Syslog is not supported on your system. For Windows
-    we recommend using the win32-eventlog gem.
-  EOS
+      Can't load Syslog!
+  
+      Syslog is not supported on your system. For Windows
+      we recommend using the win32-eventlog gem.
+    EOS
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: syslog
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Akinori MUSHA
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -35,6 +34,7 @@ files:
 - ".git-blame-ignore-revs"
 - ".github/CODEOWNERS"
 - ".github/dependabot.yml"
+- ".github/release.yml"
 - ".github/workflows/push_gem.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -49,6 +49,7 @@ files:
 - ext/syslog/syslog.c
 - ext/syslog/syslog.txt
 - lib/syslog.rb
+- lib/syslog/jruby.rb
 - lib/syslog/logger.rb
 - syslog.gemspec
 homepage: https://github.com/ruby/syslog
@@ -58,7 +59,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ruby/syslog
   source_code_uri: https://github.com/ruby/syslog
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Ruby interface for the POSIX system logging facility.
 test_files: []