apple-system-logger 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e182b091ff2fa39fbb9dc1d3c7be600dbaed9c26f58ce11bde5e3ee5bf49f7
-  data.tar.gz: 1a0c1e78f9fe1e2afac44673aef8a5d727499da4da047b9a924ce140bcaef066
+  metadata.gz: 47eaba8480a9a1a1645cb05b1097fae01083b9d9f10052ee2818472739b8eaff
+  data.tar.gz: 8d726f6fbeb7764af96d897cc925b7c609dce96b327e26140e514e8df381bcae
 SHA512:
-  metadata.gz: d9b0376b2561d155fa634f32152c3713d141a654580f1bb0d9525c6424b28a7c17c911dc309593d08a1c4045aed79d90a723f9d2bc990e3e75353102cdc05c22
-  data.tar.gz: 9532a7cf33d9573f3e574133adeed15a9e138ee3b4ecb110d1237b91b84676882ab7b3a049c73f5811d5c936f627c9e51b8c4aedc2bc7b5e7fb528a9aaf8e1f2
+  metadata.gz: 9a98f320a286f69bf5eab1813c70e5f6c635be8117b3bc5a8f8fc37c78fc1111ed54d86795e0b44ed57ffca2ee72b6d5c76a5d5cebabd5885081714fa2619510
+  data.tar.gz: 0b53d9d699d57e1c36482eb2134b4b6c2aff8078a39e67c2a0d9682754b898f228251b583e112929a1d41daa70d464ad272afe80fb5fa106d5fee5f81c00b473

data/CHANGES.md

@@ -1,3 +1,9 @@
+## 0.1.3 - 28-Dec-2025
+* Fixed the missing message parameter for the error and fatal methods.
+* Added stricter enforcement for search keys.
+* The constructor was modified internally for proper initialization.
+* Some rubocop cleanup, spec updates, and workflow action tweaks.
+
 ## 0.1.2 - 28-Oct-2020
 * Added the :stderr option.
 * Added a Gemfile.

data/Gemfile

@@ -1,7 +1,2 @@
-source 'https://rubygems.org' do
-  gem 'ffi', '~> 1.1'
-  group 'test' do
-    gem 'rake'
-    gem 'rspec', '~> 3.9'
-  end
-end
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -1,11 +1,16 @@
+[![Ruby](https://github.com/djberg96/apple-system-logger/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/apple-system-logger/actions/workflows/ruby.yml)
+
 ## apple-system-logger
 A Ruby interface for the Apple system logger.
 
 ## Installation
 gem install apple-system-logger
 
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/apple-system-logger/main/certs/djberg96_pub.pem)`
+
 ## Synopsis
-```
+```ruby
 require 'apple-system-logger'
 
 # With defaults
@@ -40,7 +45,7 @@ because the API does not explicitly forbid other file descriptors, nor
 does it raise an error.
 
 ## Copyright
-(C) 2020 Daniel J. Berger, All Rights Reserved
+(C) 2020-2025 Daniel J. Berger, All Rights Reserved
 
 ## Warranty
 This package is provided "as is" and without any express or

data/Rakefile

@@ -1,10 +1,7 @@
 require 'rake'
 require 'rake/clean'
-require 'rbconfig'
 require 'rspec/core/rake_task'
-include RbConfig
-
-RSpec::Core::RakeTask.new(:spec)
+require 'rubocop/rake_task'
 
 CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx', '**/*.lock')
 
@@ -12,7 +9,7 @@ namespace 'gem' do
   desc "Create the apple-system-logger gem"
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('apple-system-logger.gemspec'))
+    spec = Gem::Specification.load('apple-system-logger.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
     Gem::Package.build(spec)
   end
@@ -24,4 +21,16 @@ namespace 'gem' do
   end
 end
 
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = true
+  t.rspec_opts = '-f documentation -w'
+end
+
+RuboCop::RakeTask.new
+
+# Clean up afterwards
+Rake::Task[:spec].enhance do
+  Rake::Task[:clean].invoke
+end
+
 task :default => :spec

data/apple-system-logger.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'apple-system-logger'
-  spec.version    = '0.1.2'
+  spec.version    = '0.1.3'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'
@@ -15,14 +15,17 @@ Gem::Specification.new do |spec|
   spec.add_dependency('ffi', '~> 1.1')
   spec.add_development_dependency('rake')
   spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('rubocop')
+  spec.add_development_dependency('rubocop-rspec')
 
   spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/apple-system-logger',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/apple-system-logger/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/apple-system-logger/blob/master/CHANGES',
-    'documentation_uri' => 'https://github.com/djberg96/apple-system-logger/wiki',
-    'source_code_uri'   => 'https://github.com/djberg96/apple-system-logger',
-    'wiki_uri'          => 'https://github.com/djberg96/apple-system-logger/wiki'
+    'homepage_uri'          => 'https://github.com/djberg96/apple-system-logger',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/apple-system-logger/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/apple-system-logger/blob/main/CHANGES.md',
+    'documentation_uri'     => 'https://github.com/djberg96/apple-system-logger/wiki',
+    'source_code_uri'       => 'https://github.com/djberg96/apple-system-logger',
+    'wiki_uri'              => 'https://github.com/djberg96/apple-system-logger/wiki',
+    'rubygems_mfa_required' => 'true'
   }
 
   spec.description = <<-EOF

data/lib/apple/system/logger/constants.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module Apple
   module System
     module LoggerConstants
-      ASL_KEY_TIME     = "Time"
-      ASL_KEY_HOST     = "Host"
-      ASL_KEY_SENDER   = "Sender"
-      ASL_KEY_FACILITY = "Facility"
-      ASL_KEY_PID      = "PID"
-      ASL_KEY_UID      = "UID"
-      ASL_KEY_GID      = "GID"
-      ASL_KEY_LEVEL    = "Level"
-      ASL_KEY_MSG      = "Message"
+      ASL_KEY_TIME     = 'Time'
+      ASL_KEY_HOST     = 'Host'
+      ASL_KEY_SENDER   = 'Sender'
+      ASL_KEY_FACILITY = 'Facility'
+      ASL_KEY_PID      = 'PID'
+      ASL_KEY_UID      = 'UID'
+      ASL_KEY_GID      = 'GID'
+      ASL_KEY_LEVEL    = 'Level'
+      ASL_KEY_MSG      = 'Message'
 
       ASL_LEVEL_EMERG   = 0
       ASL_LEVEL_ALERT   = 1

data/lib/apple/system/logger/functions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ffi'
 
 module Apple
@@ -6,22 +8,22 @@ module Apple
       extend FFI::Library
       ffi_lib FFI::Library::LIBC
 
-      attach_function(:asl_add_log_file, [:pointer, :int], :int)
+      attach_function(:asl_add_log_file, %i[pointer int], :int)
       attach_function(:asl_close, [:pointer], :void)
       attach_function(:asl_free, [:pointer], :void)
-      attach_function(:asl_get, [:pointer, :string], :string)
-      attach_function(:asl_key, [:pointer, :uint32], :string)
-      attach_function(:asl_log, [:pointer, :pointer, :int, :string, :varargs], :int)
+      attach_function(:asl_get, %i[pointer string], :string)
+      attach_function(:asl_key, %i[pointer uint32], :string)
+      attach_function(:asl_log, %i[pointer pointer int string varargs], :int)
       attach_function(:asl_new, [:uint32], :pointer)
-      attach_function(:asl_open, [:string, :string, :uint32], :pointer)
-      attach_function(:asl_remove_log_file, [:pointer, :int], :int)
-      attach_function(:asl_search, [:pointer, :pointer], :pointer)
-      attach_function(:asl_send, [:pointer, :pointer], :int)
-      attach_function(:asl_set, [:pointer, :string, :string], :int)
-      attach_function(:asl_set_filter, [:pointer, :int], :int)
-      attach_function(:asl_set_query, [:pointer, :string, :string, :uint32], :int)
-      attach_function(:asl_unset, [:pointer, :string], :int)
-      attach_function(:asl_vlog, [:pointer, :pointer, :int, :string, :pointer], :int)
+      attach_function(:asl_open, %i[string string uint32], :pointer)
+      attach_function(:asl_remove_log_file, %i[pointer int], :int)
+      attach_function(:asl_search, %i[pointer pointer], :pointer)
+      attach_function(:asl_send, %i[pointer pointer], :int)
+      attach_function(:asl_set, %i[pointer string string], :int)
+      attach_function(:asl_set_filter, %i[pointer int], :int)
+      attach_function(:asl_set_query, %i[pointer string string uint32], :int)
+      attach_function(:asl_unset, %i[pointer string], :int)
+      attach_function(:asl_vlog, %i[pointer pointer int string pointer], :int)
       attach_function(:aslresponse_free, [:pointer], :void)
       attach_function(:aslresponse_next, [:pointer], :pointer)
     end

data/lib/apple/system/logger.rb

@@ -1,14 +1,19 @@
+# frozen_string_literal: true
+
 require_relative 'logger/functions'
 require_relative 'logger/constants'
 
+# The Apple module serves as a namespace only.
 module Apple
+  # The System module serves only as a namespace.
   module System
+    # The Logger class encapsulates the logging functions of the OSX logging API.
     class Logger
       include Apple::System::LoggerFunctions
       include Apple::System::LoggerConstants
 
       # The version of this library.
-      VERSION = '0.1.2'.freeze
+      VERSION = '0.1.3'
 
       # A syslogd facility. The system default is 'user'.
       attr_reader :facility
@@ -69,18 +74,12 @@ module Apple
         @logdev   = kwargs[:logdev]
         @stderr   = kwargs[:stderr]
 
-        if @logdev || @facility || @progname
-          options = ASL_OPT_NO_DELAY | ASL_OPT_NO_REMOTE
-          options |= ASL_OPT_STDERR if @stderr
+        options = ASL_OPT_NO_DELAY | ASL_OPT_NO_REMOTE
+        options |= ASL_OPT_STDERR if @stderr
 
-          @aslclient = asl_open(@progname, @facility, options)
+        @aslclient = asl_open(@progname, @facility, options)
 
-          if @logdev
-            asl_add_log_file(@aslclient, @logdev.fileno)
-          end
-        else
-          @aslclient = nil
-        end
+        asl_add_log_file(@aslclient, @logdev.fileno) if @logdev
 
         @aslmsg = asl_new(ASL_TYPE_MSG)
         asl_set(@aslmsg, ASL_KEY_FACILITY, @facility) if @facility
@@ -145,11 +144,11 @@ module Apple
 
       # Log an error message.
       #
-      def error
+      def error(message)
         asl_log(@aslclient, @aslmsg, ASL_LEVEL_ERR, message)
       end
 
-      # Returns true if the current severity level allows for the printing of erro messages.
+      # Returns true if the current severity level allows for the printing of error messages.
       #
       def error?
         level >= ASL_LEVEL_ERR
@@ -157,7 +156,7 @@ module Apple
 
       # Log a fatal message. For this library that means an ASL_LEVEL_CRIT message.
       #
-      def fatal
+      def fatal(message)
         asl_log(@aslclient, @aslmsg, ASL_LEVEL_CRIT, message)
       end
 
@@ -224,12 +223,12 @@ module Apple
       #   log.search(:uid => 501, :time => Time.now - 3600)
       #
       def search(query)
-        value  = nil
         aslmsg = asl_new(ASL_TYPE_QUERY)
         result = []
 
         query.each do |key, value|
           asl_key = map_key_to_asl_key(key)
+
           flags = ASL_QUERY_OP_EQUAL
           flags = (flags | ASL_QUERY_OP_NUMERIC) if value.is_a?(Numeric)
           flags = (flags | ASL_QUERY_OP_TRUE) if value == true
@@ -281,16 +280,16 @@ module Apple
 
       def map_key_to_asl_key(key)
         {
-          :time     => ASL_KEY_TIME,
-          :host     => ASL_KEY_HOST,
-          :sender   => ASL_KEY_SENDER,
+          :time => ASL_KEY_TIME,
+          :host => ASL_KEY_HOST,
+          :sender => ASL_KEY_SENDER,
           :facility => ASL_KEY_FACILITY,
-          :pid      => ASL_KEY_PID,
-          :uid      => ASL_KEY_UID,
-          :gid      => ASL_KEY_GID,
-          :level    => ASL_KEY_LEVEL,
-          :message  => ASL_KEY_MSG
-        }[key]
+          :pid => ASL_KEY_PID,
+          :uid => ASL_KEY_UID,
+          :gid => ASL_KEY_GID,
+          :level => ASL_KEY_LEVEL,
+          :message => ASL_KEY_MSG
+        }.fetch(key)
       end
     end
   end

data/lib/apple-system-logger.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'apple/system/logger'

data/spec/apple-system-logger_spec.rb

@@ -1,125 +1,131 @@
+# frozen_string_literal: true
+
 require 'apple-system-logger'
 
 RSpec.describe Apple::System::Logger do
   let(:log){ described_class.new }
 
-  context "version" do
-    example "version constant is set to expected value" do
-      expect(described_class::VERSION).to eql('0.1.2')
+  context 'version' do
+    example 'version constant is set to expected value' do
+      expect(described_class::VERSION).to eql('0.1.3')
     end
 
-    example "version constant is frozen" do
+    example 'version constant is frozen' do
       expect(described_class::VERSION).to be_frozen
     end
   end
 
-  context "instance methods" do
-    example "defines a facility method" do
+  context 'instance methods' do
+    example 'defines a facility method' do
       expect(log).to respond_to(:facility)
     end
 
-    example "the default facility is nil" do
+    example 'the default facility is nil' do
       expect(log.facility).to be_nil
     end
 
-    example "defines a level method" do
+    example 'defines a level method' do
       expect(log).to respond_to(:level)
     end
 
-    example "the default level is debug" do
+    example 'the default level is debug' do
       expect(log.level).to eql(Apple::System::Logger::ASL_LEVEL_DEBUG)
     end
 
-    example "defines a progname method" do
+    example 'defines a progname method' do
       expect(log).to respond_to(:progname)
     end
 
-    example "the default progname is nil" do
+    example 'the default progname is nil' do
       expect(log.progname).to be_nil
     end
 
-    example "defines a logdev method" do
+    example 'defines a logdev method' do
       expect(log).to respond_to(:logdev)
     end
 
-    example "the default logdev is nil" do
+    example 'the default logdev is nil' do
       expect(log.logdev).to be_nil
     end
   end
 
-  context "logging methods" do
-    example "there is a << method" do
+  context 'logging methods' do
+    example 'there is a << method' do
       expect(log).to respond_to(:<<)
     end
 
-    example "there is an add method" do
+    example 'there is an add method' do
       expect(log).to respond_to(:add)
     end
 
-    example "there is a debug method" do
+    example 'there is a debug method' do
       expect(log).to respond_to(:debug)
     end
 
-    example "there is a debug? method that returns the expected value" do
+    example 'there is a debug? method that returns the expected value' do
       expect(log.debug?).to be true
     end
 
-    example "there is an info method" do
+    example 'there is an info method' do
       expect(log).to respond_to(:info)
     end
 
-    example "there is a info? method that returns the expected value" do
+    example 'there is a info? method that returns the expected value' do
       expect(log.info?).to be true
     end
 
-    example "there is a warn method" do
+    example 'there is a warn method' do
       expect(log).to respond_to(:warn)
     end
 
-    example "there is a warn? method that returns the expected value" do
+    example 'there is a warn? method that returns the expected value' do
       expect(log.warn?).to be true
     end
 
-    example "there is an error method" do
+    example 'there is an error method' do
       expect(log).to respond_to(:error)
     end
 
-    example "there is a error? method that returns the expected value" do
+    example 'there is a error? method that returns the expected value' do
       expect(log.error?).to be true
     end
 
-    example "there is a fatal method" do
-      expect(log).to respond_to(:error)
+    example 'there is a fatal method' do
+      expect(log).to respond_to(:fatal)
     end
 
-    example "there is a fatal? method that returns the expected value" do
+    example 'there is a fatal? method that returns the expected value' do
       expect(log.fatal?).to be true
     end
 
-    example "there is an unknown method" do
+    example 'there is an unknown method' do
       expect(log).to respond_to(:unknown)
     end
 
-    example "there is a close method" do
+    example 'there is a close method' do
       expect(log).to respond_to(:close)
     end
 
-    example "calling close on the logger instance works as expected" do
+    example 'calling close on the logger instance works as expected' do
       expect(log.close).to be_nil
       expect(log.close).to be_nil
     end
   end
 
-  context "search" do
-    example "there is a search method" do
+  context 'search' do
+    example 'there is a search method' do
       expect(log).to respond_to(:search)
     end
 
-    example "a basic search returns the expected results" do
+    example 'a basic search returns the expected results' do
       result = log.search(:sender => 'bootlog', :level => 5)
-      expect(result).to be_a_kind_of(Array)
-      expect(result.first).to be_a_kind_of(Hash)
+      expect(result).to be_a(Array)
+      expect(result.first).to be_a(Hash)
       expect(result.size).to be >= 1
     end
+
+    example 'search keys must be valid' do
+      expect{ log.search(:bogus => 'bootlog') }.to raise_error(KeyError)
+    end
   end
 end

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: apple-system-logger
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +34,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2020-10-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -79,6 +78,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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-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'
 description: "    The apple-system-logger library provides an interface for the Apple
   System\n    Library. You can both write to, and search, your mac's system logs using\n
   \   this library using an API that is very similar to the stdlib Logger interface.
@@ -107,11 +134,11 @@ licenses:
 metadata:
   homepage_uri: https://github.com/djberg96/apple-system-logger
   bug_tracker_uri: https://github.com/djberg96/apple-system-logger/issues
-  changelog_uri: https://github.com/djberg96/apple-system-logger/blob/master/CHANGES
+  changelog_uri: https://github.com/djberg96/apple-system-logger/blob/main/CHANGES.md
   documentation_uri: https://github.com/djberg96/apple-system-logger/wiki
   source_code_uri: https://github.com/djberg96/apple-system-logger
   wiki_uri: https://github.com/djberg96/apple-system-logger/wiki
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -126,8 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A Ruby interface for the Apple System Logger
 test_files: