twiglet 3.5.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00772aa96a6be0df63c418fc7cc077cf599e9909af51e00be9992bf78d298660
-  data.tar.gz: 479f94b2de093c797e863b66f02287e37d1b1c5aa58931553bdff269844ed792
+  metadata.gz: 65882a52b10620b9a6ab5ff439b9f377e135308055618474510f232d14be0ec5
+  data.tar.gz: 97fb56dced537bc5bf3e0ddebfc6cf2be076466241eaef4b63437a278664fe47
 SHA512:
-  metadata.gz: 17317a0d26e6b66b573e5eeeafc7d4957c6bdb87e70f320279098cb405464e68fe29a56cbe4421663d809cf39b6e7f72d5d5b5c0261fecd59766bf420e928250
-  data.tar.gz: 222e608e335c4a6406e08376356f1cd7e42c89ea09f7d4eba6432fc33aa26d614421f60ef123d45b2eed73ab334741b50fbf096ee17631f38dbf8930cb4c4397
+  metadata.gz: '09a38113c797bec07068cd08a3d2c00fceac2f1617956ce88cb775c8c2fb86344377569f0df5b75d47e93ab8bc1a6c94fadd6d2ec2190edfcefc0d648a471f67'
+  data.tar.gz: e37658db9af2be233a93c3f6ef7ea776a4ae51bbbbd09afb85a5e77c5b13a7172fd7ca141b87241edb1ebf7678f7a4ca1485629a6ef97c7921da7b9a33b32009

data/.github/workflows/codeql-analysis.yml

@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,7 +53,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -67,4 +67,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/project-board.yml

@@ -0,0 +1,17 @@
+name: Automatically add new Issues to Silversmith's GitHub project board
+# https://github.com/orgs/simplybusiness/projects/3
+# New issues in this repository will be added to the board.
+on:
+  issues:
+    types: [ opened, reopened ]
+
+jobs:
+  track_issues:
+    uses: simplybusiness/github-action-reusable-workflows/.github/workflows/project-board.yaml@master
+    with:
+      pr-id: ${{ github.event.issue.node_id }}
+      project-number: 3
+      org: simplybusiness
+      actor: ${{ github.actor }}
+    secrets:
+      github-token: ${{ secrets.SILVERSMITHS_PROJECT_MANAGEMENT }}

data/.github/workflows/version-forget-me-not.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-18.04
 
     steps:
-      - uses: simplybusiness/version-forget-me-not@V2.1.1
+      - uses: simplybusiness/version-forget-me-not@v2.3.0
         env:
           ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VERSION_FILE_PATH: "lib/twiglet/version.rb"

data/lib/twiglet/logger.rb

@@ -42,17 +42,26 @@ module Twiglet
       @validator.custom_error_handler = block
     end
 
+    def debug(message_or_error = nil, &block)
+      message = message_or_error.is_a?(Exception) ? error_message(message_or_error) : message_or_error
+
+      super(message, &block)
+    end
+
+    def info(message_or_error = nil, &block)
+      message = message_or_error.is_a?(Exception) ? error_message(message_or_error) : message_or_error
+
+      super(message, &block)
+    end
+
+    def warn(message_or_error = nil, &block)
+      message = message_or_error.is_a?(Exception) ? error_message(message_or_error) : message_or_error
+
+      super(message, &block)
+    end
+
     def error(message = nil, error = nil, &block)
-      if error
-        error_fields = {
-          error: {
-            type: error.class.to_s,
-            message: error.message
-          }
-        }
-        add_stack_trace(error_fields, error)
-        message = Message.new(message).merge(error_fields)
-      end
+      message = error_message(error, message) if error
 
       super(message, &block)
     end
@@ -76,6 +85,18 @@ module Twiglet
 
     private
 
+    def error_message(error, message = nil)
+      error_fields = {
+        error: {
+          type: error.class.to_s,
+          message: error.message
+        }
+      }
+      add_stack_trace(error_fields, error)
+      message = error.message if message.nil? || message.empty?
+      Message.new(message).merge(error_fields)
+    end
+
     def add_stack_trace(hash_to_add_to, error)
       hash_to_add_to[:error][:stack_trace] = error.backtrace if error.backtrace
     end

data/lib/twiglet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twiglet
-  VERSION = '3.5.1'
+  VERSION = '3.6.0'
 end

data/test/logger_test.rb

@@ -361,6 +361,31 @@ describe Twiglet::Logger do
 
       assert_equal 'StandardError', actual_log[:error][:type]
     end
+
+    it 'can log just an error as "error", if no message is given' do
+      e = StandardError.new('some error')
+      @logger.error(nil, e)
+
+      actual_log = read_json(@buffer)
+
+      assert_equal 'some error', actual_log[:message]
+      assert_equal 'StandardError', actual_log[:error][:type]
+      assert_equal 'some error', actual_log[:error][:message]
+    end
+
+    [:debug, :info, :warn].each do |level|
+      it "can log an error with type, error message etc.. as '#{level}'" do
+        error_message = "error to be logged as #{level}"
+        e = StandardError.new(error_message)
+        @logger.public_send(level, e)
+
+        actual_log = read_json(@buffer)
+
+        assert_equal error_message, actual_log[:message]
+        assert_equal 'StandardError', actual_log[:error][:type]
+        assert_equal error_message, actual_log[:error][:message]
+      end
+    end
   end
 
   describe 'text logging' do
@@ -420,6 +445,15 @@ describe Twiglet::Logger do
         assert_equal 'a block log message', actual_log[:message]
       end
     end
+
+    it 'should ignore the given progname if a block is also given' do
+      block = proc { 'a block log message' }
+      @logger.info('my-program-name', &block)
+      actual_log = read_json(@buffer)
+
+      assert_equal 'info', actual_log[:log][:level]
+      assert_equal 'a block log message', actual_log[:message]
+    end
   end
 
   describe 'dotted keys' do

data/twiglet.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |gem|
   gem.description           = 'Like a log, only smaller.'
 
   gem.files                 = `git ls-files`.split("\n")
-  gem.test_files            = `git ls-files -- {test}/*`.split("\n")
 
   gem.require_paths         = ['lib']
   gem.required_ruby_version = '>= 2.6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.6.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -92,6 +92,7 @@ files:
 - ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/dobby-actions.yml"
 - ".github/workflows/gem-publish.yml"
+- ".github/workflows/project-board.yml"
 - ".github/workflows/ruby.yml"
 - ".github/workflows/version-forget-me-not.yml"
 - ".gitignore"