razorrisk-core-diagnostics 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cb8983ea3ea7fb82efa8fc51ca648ae188eacec
+  data.tar.gz: 89a05dfec7af4a985f6dd9317c391bdcf415cede
+SHA512:
+  metadata.gz: 438b3586b47dbdc4b6009a7513994d3e0822eb297d657ebbcf34570dec9074515938127e91c02540a7a1c1c4b233f01fc84c66cec3afbd5d276c770f5dc92c94
+  data.tar.gz: a6adf56e798df7e7b985406f80455d85553cdf60204e061cb0a9bdf0d3a7e242ae841d958398ae467306be6b64f176f16ef5a9dfa6acbf5bed9519cb03999001

data/Rakefile

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# ######################################################################## #
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
+
+# ##########################################################
+# bundler
+
+require 'rubygems'
+require 'bundler/setup'
+
+# ######################################################################## #
+# requires
+
+require 'razor_risk/razor/control/rake_helpers/diagnostic_tasks'
+require 'razor_risk/razor/control/rake_helpers/gem_tasks'
+require 'razor_risk/razor/control/rake_helpers/task_helpers'
+
+require 'rake'
+require 'rake/clean'
+
+# ##########################################################
+# includes
+
+include ::RazorRisk::Razor::Control # rubocop:todo Style/MixinUsage
+include ::Pantheios # rubocop:todo Style/MixinUsage
+
+# ##########################################################
+# Constants
+
+Spec = ::Gem::Specification.load(Dir['*.gemspec'].first)
+LogDir = 'log' # rubocop:todo Naming/ConstantName
+# rubocop:todo Naming/ConstantName
+LogThresholds = %i[informational informational].freeze
+# rubocop:enable Naming/ConstantName
+
+# ##########################################################
+# clean/clobber
+
+Dir[
+    'log',
+    'doc',
+].each { |f| CLEAN << f }
+Dir[
+    '.bundle',
+    'vendor',
+    'GEM_HOME',
+    '*.gem',
+].each { |f| CLOBBER << f }
+
+# ##########################################################
+# Tasks
+
+desc 'Run tests'
+task test: [:'gem:unit_test']
+
+desc 'Build gem'
+task :build_gem, [:path] => :'gem:build'
+
+desc 'Builds the Razor EntityConnector Gem'
+task :build, [:path] => [:build_gem]
+
+desc 'Push the gem to the gem server.'
+task deploy: :'gem:push'
+
+# ##########################################################
+# Hooks
+
+task :default do
+  puts 'Run \'bundler exec rake --tasks\' to see available tasks'
+end
+
+task :first do
+  ::Rake::Task[:'diagnostics:init'].execute(
+    name: Spec.name,
+    version: Spec.version.to_s,
+    directory: LogDir,
+    thresholds: LogThresholds
+  )
+end
+
+RakeHelpers::TaskHelpers.add_hooks
+
+# ############################## end of file ############################# #

data/lib/razor_risk/core/diagnostics/exceptions/rrcs_base_exception.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# ######################################################################## #
+# File:         lib/razor_risk/core/diagnostics/exceptions/rrcs_basic_exception.rb
+#
+# Purpose:      Definition of the
+#               ::RazorRisk::Core::Diagnostics::Exceptions::RRCSBaseException
+#               class
+#
+# Created:      10th December 2017
+# Updated:      28th January 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+require 'razor_risk/core/diagnostics/throwable'
+require 'xqsr3/diagnostics/exceptions/with_cause'
+
+module RazorRisk
+  module Core
+    module Diagnostics
+      module Exceptions
+        # Root exception for all Razor Risk exceptions
+        class RRCSBaseException < StandardError
+          include Throwable
+
+          include ::Xqsr3::Diagnostics::Exceptions::WithCause
+
+          def self.new(*args)
+            if self == RRCSBaseException
+              raise NoMethodError, "private method `new' called for #{self}:Class"
+          end
+
+            super
+          end
+          # rubocop:todo Style/CommentedKeyword
+        end # class RRCSBaseException
+        # rubocop:enable Style/CommentedKeyword
+      end # module Exceptions # rubocop:todo Style/CommentedKeyword
+    end # module Diagnostics # rubocop:todo Style/CommentedKeyword
+  end
+end
+
+# ############################## end of file ############################# #

data/lib/razor_risk/core/diagnostics/exceptions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'razor_risk/core/diagnostics/exceptions/rrcs_base_exception'

data/lib/razor_risk/core/diagnostics/logger/logger.rb

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# ######################################################################## #
+# File:         razor_risk/core/diagnostics/logger.rb
+#
+# Purpose:      Overriding pantheios.api module
+#
+# Author:       Razor Risk
+#
+# Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+# requires
+
+require 'pantheios'
+
+# Module Definitions
+
+module RazorRisk
+  module Core
+    module Diagnostics
+      module Logger
+        # Logs an arbitrary set of parameters at the given severity level
+        def log(severity, *args, &block)
+          return nil unless severity_logged? severity
+
+          log_or_trace_with_block_ 1, severity, args, &block
+        end
+
+        # Logs an array of parameters at the given severity level
+        def log_v(severity, argv, &block)
+          return nil unless severity_logged? severity
+
+          log_or_trace_with_block_ 1, severity, argv, &block
+        end
+
+        # Logs an arbitrary set of parameters at the Trace (:trace) level
+        def trace(*args, &block)
+          return nil unless tracing?
+
+          trace_with_block_ 1, args, &block
+        end
+
+        # Logs an array of parameters at the Trace (:trace) level
+        def trace_v(argv, &block)
+          return nil unless tracing?
+
+          trace_with_block_ 1, argv, &block
+        end
+
+        # Obtains a string-form of the timestamp
+        #
+        # Unless overridden, returns the value provided by
+        # +::Pantheios::Core::timestamp+
+        def timestamp(t)
+          ::Pantheios::Core.timestamp t, '%Y-%m-%dT%H:%M:%S.%6N'
+        end
+
+        # Obtains the process id
+        #
+        # Unless overridden, returns the value provided by
+        # +::Pantheios::Core::process_id+
+        def process_id
+          ::Pantheios::Core.process_id
+        end
+
+        # Obtains the program name
+        #
+        # Unless overridden, returns the value provided by
+        # +::Pantheios::Core::process_name+
+        def process_name
+          ::Pantheios::Core.process_name
+        end
+
+        # Obtains the string corresponding to the severity
+        #
+        # Unless overridden, returns the value provided by
+        # +::Pantheios::Core::severity_string+
+        def severity_string(severity)
+          sev = ::Pantheios::Core.severity_string severity
+          if %w[Alert Warning].include? sev
+            'WARN'
+          elsif %w[Notice Informational].include? sev
+            'INFO'
+          elsif %w[Debug-0 Debug-1 Debug-2 Debug-3 Debug-4].include? sev
+            'DEBUG'
+          elsif sev == 'Critical'
+            'FATAL'
+          elsif sev == 'Failure'
+            'ERROR'
+          else
+            sev.upcase
+          end
+        end
+
+        # Obtains the thread id
+        #
+        # Unless overridden, returns the value provided by
+        # +::Pantheios::Core::thread_id+
+        def thread_id
+          ::Pantheios::Core.thread_id
+        end
+
+        def prefix_elements
+          %i[timestamp process_name process_id severity]
+        end
+
+        def prefix(t, severity)
+          prefix_elements.map do |el|
+            case el
+            when :timestamp
+              timestamp t
+
+            when :program_name, :process_name
+              process_name.upcase
+
+            when :process_id
+              'RWS'
+
+            when :severity
+              severity_string severity
+            else
+              s = ::Symbol === el ? ":#{el}" : el.to_s
+              warn "ignoring unrecognised prefix_element '#{s}'"
+              nil
+            end
+          end.join(' ')
+        end
+
+        private
+
+        # Private implementation methods not meant for override
+        def log_or_trace_with_block_(call_depth, severity, argv, &block)
+          if severity == :trace
+            return ::Pantheios::Core.trace_v_impl self, 1 + call_depth, nil, severity, argv, &block
+          end
+
+          ::Pantheios::Core.log_v_impl self, severity, argv, &block
+        end
+
+        def trace_with_block_(call_depth, argv, &block)
+          ::Pantheios::Core.trace_v_impl self, 1 + call_depth, nil, :trace, argv, &block
+        end
+      end
+    end
+  end
+end

data/lib/razor_risk/core/diagnostics/logger.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'razor_risk/core/diagnostics/logger/logger'

data/lib/razor_risk/core/diagnostics/logic_errors/rrcs_logic_error.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# ######################################################################## #
+# File:         lib/razor_risk/core/diagnostics/logic_erors/rrcs_logic_error.rb
+#
+# Purpose:      Definition of the
+#               ::RazorRisk::Core::Diagnostics::LogicErrors::RRCSLogiError
+#               class
+#
+# Created:      10th December 2017
+# Updated:      28th January 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+require 'razor_risk/core/diagnostics/throwable'
+require 'xqsr3/diagnostics/exceptions/with_cause'
+
+module RazorRisk
+  module Core
+    module Diagnostics
+      module LogicErrors
+        # Root exception for all Razor Risk logic errors
+        class RRCSLogicError < RuntimeError
+          include Throwable
+
+          include ::Xqsr3::Diagnostics::Exceptions::WithCause
+
+          def faulted?
+            true
+        end
+
+          def self.new(*args)
+            if self == RRCSLogicError
+              raise NoMethodError, "private method `new' called for #{self}:Class"
+          end
+
+            super
+          end
+          # rubocop:todo Style/CommentedKeyword
+        end # class RRCSLogicError
+        # rubocop:enable Style/CommentedKeyword
+      end # module LogicErrors # rubocop:todo Style/CommentedKeyword
+    end # module Diagnostics # rubocop:todo Style/CommentedKeyword
+  end
+end
+
+# ############################## end of file ############################# #

data/lib/razor_risk/core/diagnostics/logic_errors.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'razor_risk/core/diagnostics/logic_errors/rrcs_logic_error'

data/lib/razor_risk/core/diagnostics/throwable.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RazorRisk
+  module Core
+    module Diagnostics
+      # Inclusion module incorporated into all Razor Risk exceptions and logic
+      # errors, which provides all thrown types with the Exception Vocabulary
+      # espoused in the article "Exceptions : The Worst Form of 'Error' Handling
+      # Except For All The Others", Matthew Wilson, ACCU Overload Journal #98,
+      # August 2010, available at https://accu.org/index.php/journals/1681 and at
+      # http://synesis.com.au/publishing/quality-matters/exceptions-the-worst-form-of-error-handling-apart-from-all-the-others.html
+      #
+      module Throwable
+        # Indicates whether the instance is thrown as part of normative
+        # behaviour
+        def normative?
+          false
+        end
+
+        # Indicates whether the instance is thrown to indicate a recoverable
+        # failure
+        def recoverable?
+          false
+        end
+
+        # Indicates whether the instance is thrown to indicate a
+        # practically-unrecoverable failure
+        def practically_unrecoverable?
+          false
+        end
+
+        # Indicates whether the instance is thrown to indicate a faulted
+        # contition (i.e. a fault arising from a defect arising from a
+        # programming error)
+        def faulted?
+          false
+        end
+      end # module Throwable # rubocop:todo Style/CommentedKeyword
+    end # module Diagnostics # rubocop:todo Style/CommentedKeyword
+  end # module Core # rubocop:todo Style/CommentedKeyword
+end # module RazorRisk # rubocop:todo Style/CommentedKeyword

data/lib/razor_risk/core/diagnostics/version.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# ##########################################################################
+#
+# Version for RazorRisk.Ruby.Core.Diagnostics library
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+module RazorRisk
+  module Core
+    module Diagnostics # rubocop:todo Style/Documentation
+      # Current version of the RazorRisk::Core::Diagnostics library
+      VERSION = '0.2.0'
+
+      private # rubocop:todo Lint/UselessAccessModifier
+
+      VERSION_PARTS_ = VERSION.split(/[.]/).collect(&:to_i)
+
+      public # rubocop:todo Lint/UselessAccessModifier
+
+      # Major version of the RazorRisk::Core::Diagnostics library
+      VERSION_MAJOR  = VERSION_PARTS_[0]
+      # Minor version of the RazorRisk::Core::Diagnostics library
+      VERSION_MINOR  = VERSION_PARTS_[1]
+      # Patch version of the RazorRisk::Core::Diagnostics library
+      VERSION_PATCH  = VERSION_PARTS_[2]
+      # Commit version of the RazorRisk::Core::Diagnostics library
+      VERSION_COMMIT = VERSION_PARTS_[3] || 0
+
+      # The description of the framework
+      DESCRIPTION    = "Razor Risk's Core Services' Diagnostics library"
+    end # module Diagnostics # rubocop:todo Style/CommentedKeyword
+  end # module Core # rubocop:todo Style/CommentedKeyword
+end # module RazorRisk # rubocop:todo Style/CommentedKeyword
+
+# ############################## end of file ############################# #

data/test/unit/core/diagnostics/exceptions/tc_rrcs_base_exception.rb

@@ -0,0 +1,86 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+# ##########################################################################
+#
+# Copyright (c) 2017 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################
+# load path
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *(['..'] * 4), 'lib')
+
+# ##########################################################
+# diagnostics
+
+unless $DEBUG
+
+  require 'pantheios/globals'
+  require 'pantheios/services/null_log_service'
+
+  ::Pantheios::Globals.INITIAL_SERVICE_CLASSES = [::Pantheios::Services::NullLogService]
+end
+
+# ##########################################################
+# code coverage
+
+require 'simplecov'
+
+# ##########################################################
+# requires
+
+require 'razor_risk/core/diagnostics/exceptions'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+# ##########################################################
+# tests
+
+# rubocop:todo Style/Documentation
+# rubocop:todo Naming/ClassAndModuleCamelCase
+class Test_RRCSBaseException < Test::Unit::TestCase
+  include ::RazorRisk::Core::Diagnostics::Exceptions
+
+  class TestException < RRCSBaseException
+  end
+  class TestExceptionWithParams < RRCSBaseException
+    def initialize(p0, p1) # rubocop:todo Naming/MethodParameterName
+      @attr0 = p0
+      @attr1 = p1
+    end
+
+    attr_reader :attr0
+    attr_reader :attr1
+  end
+  # rubocop:enable Style/Documentation
+
+  def test_type_exists_and_is_a_class
+    assert defined? RRCSBaseException
+
+    # rubocop:todo Style/CaseEquality
+    assert Class === RRCSBaseException
+    # rubocop:enable Style/CaseEquality
+  end
+
+  def test_construct_is_not_valid
+    assert_raise(::NoMethodError) { RRCSBaseException.new }
+  end
+
+  def test_construct_derived_class_is_valid
+    TestException.new
+  end
+
+  def test_construct_derived_class_with_params
+    x = TestExceptionWithParams.new 'a0', 'a1'
+
+    assert_equal 'a0', x.attr0
+    assert_equal 'a1', x.attr1
+  end
+end
+# rubocop:enable Naming/ClassAndModuleCamelCase
+
+# ############################## end of file ############################# #

data/test/unit/core/diagnostics/logic_errors/tc_rrcs_logic_error.rb

@@ -0,0 +1,68 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+# ##########################################################################
+#
+# Copyright (c) 2017 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################
+# load path
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *(['..'] * 4), 'lib')
+
+# ##########################################################
+# diagnostics
+
+unless $DEBUG
+
+  require 'pantheios/globals'
+  require 'pantheios/services/null_log_service'
+
+  ::Pantheios::Globals.INITIAL_SERVICE_CLASSES = [::Pantheios::Services::NullLogService]
+end
+
+# ##########################################################
+# code coverage
+
+require 'simplecov'
+
+# ##########################################################
+# requires
+
+require 'razor_risk/core/diagnostics/logic_errors'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+# ##########################################################
+# tests
+
+# rubocop:todo Style/Documentation
+# rubocop:todo Naming/ClassAndModuleCamelCase
+class Test_RRCSLogicError < Test::Unit::TestCase
+  include ::RazorRisk::Core::Diagnostics::LogicErrors
+
+  class TestError < RRCSLogicError
+  end
+
+  def test_type_exists_and_is_a_class
+    assert defined? RRCSLogicError
+
+    assert Class === RRCSLogicError # rubocop:todo Style/CaseEquality
+  end
+
+  def test_construct_is_not_valid
+    assert_raise(::NoMethodError) { RRCSLogicError.new }
+  end
+
+  def test_construct_derived_class_is_valid
+    TestError.new
+  end
+end
+# rubocop:enable Naming/ClassAndModuleCamelCase
+# rubocop:enable Style/Documentation
+
+# ############################## end of file ############################# #

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: razorrisk-core-diagnostics
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Razor Risk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: razorrisk-core-baseutilities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: pantheios-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.2
+- !ruby/object:Gem::Dependency
+  name: xqsr3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+description: Razor Risk's Core Services' Diagnostics library
+email: operations@razor-risk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/razor_risk/core/diagnostics/exceptions.rb
+- lib/razor_risk/core/diagnostics/exceptions/rrcs_base_exception.rb
+- lib/razor_risk/core/diagnostics/logger.rb
+- lib/razor_risk/core/diagnostics/logger/logger.rb
+- lib/razor_risk/core/diagnostics/logic_errors.rb
+- lib/razor_risk/core/diagnostics/logic_errors/rrcs_logic_error.rb
+- lib/razor_risk/core/diagnostics/throwable.rb
+- lib/razor_risk/core/diagnostics/version.rb
+- test/unit/core/diagnostics/exceptions/tc_rrcs_base_exception.rb
+- test/unit/core/diagnostics/logic_errors/tc_rrcs_logic_error.rb
+homepage: https://razor-risk.com/software
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: RazorRisk.Ruby.Core.Diagnostics
+test_files: []