pantheios-ruby 0.11.2 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba27a1f4565489233730df50c8742a400e7c8cee
-  data.tar.gz: 6589a0a3912e4c690e9eaf11f3128a2e775639d6
+  metadata.gz: 11967109aaed8da770e480f5e845e9cac404d665
+  data.tar.gz: af33cdea7f4977ec3bac10a0e7b5db1546de7d2b
 SHA512:
-  metadata.gz: ecb01f00e31caff3b26b1c550499c1a6a94d0a7733dac43b578dc0d30dcdebaef9e1df0afc26fe4dbfa5fa1716a50821bedf5271ddae91d130576bb0e9dd8354
-  data.tar.gz: 9a381fc7a7ad2f2c39edf9514ea47e9484ccf9701aa3098d2b9db70d160fd4ddb3474535f9ca3ad9828622107dbc0a721798db25572c70ac1015b665ea949b21
+  metadata.gz: deccf69e633dc5d8d596312e285e6708adca6c36000e1a273d707b6474583afa51c9acae9cafa68137bc7a3b34ad5afcd8e854de75e5563e05e88ecd96b67013
+  data.tar.gz: c6e66cd2de127d5dcaa270d3af1da1fc999632bcee26a0cd2741f0b94e24e86485a79e69e5dbf00e40b18fd094e5ec1100334ae194de1f5d867331ff41dc6ae9

data/lib/pantheios/api.rb

@@ -5,13 +5,13 @@
 # Purpose:      The Pantheios.Ruby API (::Pantheios::API)
 #
 # Created:      2nd April 2011
-# Updated:      24th December 2017
+# Updated:      22nd January 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2011-2017, Matthew Wilson and Synesis Software
+# Copyright (c) 2011-2018, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -77,54 +77,54 @@ module Pantheios
 module API
 
 	# Logs an arbitrary set of parameters at the given severity level
-	def log severity, *args
+	def log severity, *args, &block
 
 		return nil unless severity_logged? severity
 
-		log_or_trace 1, severity, args
+		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
+	def log_v severity, argv, &block
 
 		return nil unless severity_logged? severity
 
-		log_or_trace 1, severity, argv
+		log_or_trace_with_block_ 1, severity, argv, &block
 	end
 
 	# Logs an arbitrary set of parameters at the Trace (:trace) level
-	def trace *args
+	def trace *args, &block
 
 		return nil unless tracing?
 
-		::Pantheios::Core.trace_v_prep self, 1, args
+		trace_with_block_ 1, args, &block
 	end
 
 	# Logs an array of parameters at the Trace (:trace) level
-	def trace_v argv
+	def trace_v argv, &block
 
 		return nil unless tracing?
 
-		::Pantheios::Core.trace_v_prep self, 1, argv
+		trace_with_block_ 1, argv, &block
 	end
 
 	if Util::VersionUtil.version_compare(RUBY_VERSION, [ 2, 1 ]) >= 0
 
-	def trace_blv b, lvars
+	def trace_blv b, lvars, &block
 
 		return nil unless tracing?
 
-		::Pantheios::Core.trace_v_impl self, 1, ApplicationLayer::ParamNameList[*lvars], :trace, lvars.map { |lv| b.local_variable_get(lv) }
+		::Pantheios::Core.trace_v_impl(self, 1, ApplicationLayer::ParamNameList[*lvars], :trace, lvars.map { |lv| b.local_variable_get(lv) }, &block)
 	end
 	end # RUBY_VERSION
 
 	if Util::VersionUtil.version_compare(RUBY_VERSION, [ 2, 2 ]) >= 0
 
-	def trace_b b
+	def trace_b b, &block
 
 		return nil unless tracing?
 
-		::Pantheios::Core.trace_v_impl self, 1, ApplicationLayer::ParamNameList[*b.local_variables], :trace, b.local_variables.map { |lv| b.local_variable_get(lv) }
+		::Pantheios::Core.trace_v_impl(self, 1, ApplicationLayer::ParamNameList[*b.local_variables], :trace, b.local_variables.map { |lv| b.local_variable_get(lv) }, &block)
 	end
 	end # RUBY_VERSION
 
@@ -259,14 +259,19 @@ module API
 	private
 
 	# Private implementation method that should not need to be overridden
-	def log_or_trace call_depth, severity, argv
+	def log_or_trace_with_block_ call_depth, severity, argv, &block
 
 		if :trace == severity
 
-			return ::Pantheios::Core.trace_v_impl self, 1 + call_depth, nil, severity, argv
+			return ::Pantheios::Core.trace_v_impl self, 1 + call_depth, nil, severity, argv, &block
 		end
 
-		::Pantheios::Core.log_raw self, severity, argv.join
+		::Pantheios::Core.log_v_impl self, severity, argv, &block
+	end
+
+	def trace_with_block_ call_depth, argv, &block
+
+		return ::Pantheios::Core.trace_v_impl self, 1 + call_depth, nil, :trace, argv, &block
 	end
 
 end # module API

data/lib/pantheios/core.rb

@@ -5,7 +5,7 @@
 # Purpose:      The Pantheios.Ruby core (::Pantheios::Core)
 #
 # Created:      2nd April 2011
-# Updated:      8th January 2018
+# Updated:      22nd January 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
@@ -88,7 +88,7 @@ module Core
 		# :nodoc:
 		class State
 
-			def initialize default_fe
+			def initialize default_fe, **options
 
 				@mx_service			=	Mutex.new
 				@front_end			=	nil
@@ -148,13 +148,22 @@ module Core
 				return r
 			end
 
-			def severity_logged? severity
+			if ::Pantheios::Globals.SYNCHRONISED_SEVERITY_LOGGED?
 
-				@mx_service.synchronize do
+				def severity_logged? severity
+
+					@mx_service.synchronize do
 
-					return nil unless @front_end
+						return nil unless @front_end
 
-					@front_end.severity_logged? severity
+						@front_end.severity_logged? severity
+					end
+				end
+			else
+
+				def severity_logged? severity
+
+					return @front_end.severity_logged? severity
 				end
 			end
 
@@ -354,20 +363,72 @@ module Core
 	end
 
 
+
 	# Internal implementation method, not to be called by application code
-	def self.trace_v_prep prefix_provider, call_depth, argv
+	def self.get_block_value_ &block
+
+		case block.arity
+		when 0
 
-		if ApplicationLayer::ParamNameList === argv[0]
+			yield
+		when 1
 
-			self.trace_v_impl prefix_provider, 1 + call_depth, argv[0], :trace, argv[1..-1]
+			yield severity
+		when 2
+
+			yield severity, argv
+		when 3
+
+			yield severity, argv, self
 		else
 
-			self.trace_v_impl prefix_provider, 1 + call_depth, nil, :trace, argv
+			warn 'too many parameters in logging block'
+
+			yield severity, argv, self
 		end
 	end
 
 	# Internal implementation method, not to be called by application code
-	def self.trace_v_impl prefix_provider, call_depth, param_list, severity, argv
+	def self.log_v_impl prefix_provider, severity, argv, &block
+
+		argv << get_block_value_(&block) if block_given?
+
+		self.log_raw prefix_provider, severity, argv.join
+	end
+
+	# Internal implementation method, not to be called by application code
+	def self.trace_v_impl prefix_provider, call_depth, param_list, severity, argv, &block
+
+		unless param_list
+
+			if ApplicationLayer::ParamNameList === argv[0]
+
+				param_list	=	argv.shift
+			end
+		end
+
+		if block_given?
+
+			br = get_block_value_ &block
+
+			if ApplicationLayer::ParamNameList === br
+
+				param_list	=	br
+			else
+				if ::Array === br
+
+					if ApplicationLayer::ParamNameList === br[0]
+
+						param_list	=	br.shift
+					end
+
+					argv += br
+				else
+
+					argv << br
+				end
+			end
+		end
 
 		case param_list
 		when nil

data/lib/pantheios/globals.rb

@@ -5,7 +5,7 @@
 # Purpose:      The Pantheios.Ruby "globals" (::Pantheios::Globals)
 #
 # Created:      24th December 2017
-# Updated:      8th January 2018
+# Updated:      22nd January 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
@@ -54,6 +54,18 @@ module Pantheios
 #
 # NOTE: The "globals" in this namespace are operative before
 # +::Pantheios::Core+ and +::Pantheios::API+
+#
+# === Variables
+#
+# * *HAS_CASCADED_INCLUDES* [boolean] Determines whether including
+#   +::Pantheios+ also includes all relevant parts of subordinate
+#   namespaces. See the documentation for the +::Pantheios+ namespace for
+#   further details
+#
+# * *SYNCHRONISED_SEVERITY_LOGGED* [boolean] Determines whether the core
+#   protects the call to the underlying log-service's +severity_logged?+
+#   with a mutex (which has a non-trivial cost).
+#
 module Globals
 
 	module Internals_
@@ -64,17 +76,24 @@ module Globals
 
 	module Helpers_
 
-		def self.cattr receiver, name, types, initial_value
+		def self.cattr receiver, name, types, initial_value, **options
+
+			if options[:boolean] && types.nil?
+
+				types = Internals_::TRUTHY_CLASSES
+			end
 
 			types = nil if !types.nil? && types.empty?
 
 			receiver.class_eval do
 
-				field_name = '@' + name
+				field_name	=	'@' + name
+				get_name	=	name
+				get_name	+=	'?' if options[:boolean]
 
 				instance_variable_set field_name, initial_value
 
-				define_singleton_method(name) do
+				define_singleton_method(get_name) do
 
 					instance_variable_get field_name
 				end
@@ -98,6 +117,8 @@ module Globals
 
 	Helpers_.cattr self, 'INITIAL_SERVICE_CLASSES', nil, nil
 
+	Helpers_.cattr self, 'SYNCHRONISED_SEVERITY_LOGGED', nil, true, boolean: true
+
 	def self.included receiver
 
 		abort "Attempt to include #{self} into #{receiver}. This is not allowed"

data/lib/pantheios/version.rb

@@ -5,7 +5,7 @@
 # Purpose:      Version for Pantheios.Ruby library
 #
 # Created:      2nd April 2011
-# Updated:      8th January 2018
+# Updated:      22nd 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
@@ -50,7 +50,7 @@
 module Pantheios
 
 	# Current version of the Pantheios.Ruby library
-	VERSION				=	'0.11.2'
+	VERSION				=	'0.12.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/performance/test_perf_simple_statements.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+# File:         test/performance/test_perf_simple_statements.rb
+#
+# Purpose:      COMPLETE_ME
+#
+# Created:      22nd January 2018
+# Updated:      22nd January 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright:    <<TBD>>
+#
+#############################################################################
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 2), 'lib')
+
+require 'pantheios/globals'
+require 'pantheios/services/null_log_service'
+
+::Pantheios::Globals.INITIAL_SERVICE_CLASSES = [ ::Pantheios::Services::NullLogService ]
+
+require 'pantheios'
+
+require 'benchmark'
+
+include Pantheios
+
+N = 5000000
+
+def severity_logged? severity
+
+	return false
+end
+
+
+Benchmark.benchmark(Benchmark::CAPTION, 24, Benchmark::FORMAT, 'total:', 'avg:') do |r|
+
+	at_0 = r.report("arguments (1-arg)") do
+
+		for i in (0...N) do
+
+			log :notice, 'the cat in the hat.'
+		end
+	end
+
+	bt_0 = r.report("blocks (1-arg)") do
+
+		for i in (0...N) do
+
+			log(:notice) { 'the cat in the hat!' }
+		end
+	end
+
+	at_1 = r.report("arguments (simple)") do
+
+		for i in (0...N) do
+
+			log :notice, 'the ', 'cat ', 'in ', 'the ', 'hat.'
+		end
+	end
+
+	bt_1 = r.report("blocks (simple)") do
+
+		for i in (0...N) do
+
+			log(:notice) { 'the ' + 'cat ' + 'in ' + 'the ' + 'hat!' }
+		end
+	end
+
+	at_2 = r.report("arguments (complex)") do
+
+		cat	=	'cat'
+		hat	=	:hat
+		t	=	Time.now
+
+		for i in (0...N) do
+
+			log :notice, "the #{cat} in the #{hat} (#{t})"
+		end
+	end
+
+	bt_2 = r.report("blocks (complex)") do
+
+		cat	=	'cat'
+		hat	=	:hat
+		t	=	Time.now
+
+		for i in (0...N) do
+
+			log(:notice) { "the #{cat} in the #{hat} (#{t})" }
+		end
+	end
+
+	[ at_0 + at_1 + at_2 + bt_0 + bt_1 + bt_2, (at_0 + at_1 + at_2 + bt_0 + bt_1 + bt_2) / 2 ]
+end
+
+

data/test/performance/test_perf_trace_variants.rb

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+# File:         test/performance/test_perf_trace_variants.rb
+#
+# Purpose:      COMPLETE_ME
+#
+# Created:      22nd January 2018
+# Updated:      22nd January 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright:    <<TBD>>
+#
+#############################################################################
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 2), 'lib')
+
+require 'pantheios/globals'
+require 'pantheios/services/null_log_service'
+
+::Pantheios::Globals.INITIAL_SERVICE_CLASSES = [ ::Pantheios::Services::NullLogService ]
+
+require 'pantheios'
+
+require 'benchmark'
+
+include Pantheios
+
+N = 1000000
+T = Time.now
+
+def severity_logged? severity
+
+	return ::Pantheios::Core.severity_logged? severity
+end
+
+
+def blank_trace p0, p1, p2, p3, t
+
+	trace
+end
+
+def anonymous_trace p0, p1, p2, p3, t
+
+	trace p0, p1, p2, p3, t
+end
+
+def parameter_trace p0, p1, p2, p3, t
+
+	trace ParamNames[ :p0, :p1, :p2, :p3, :t ], p0, p1, p2, p3, t
+end
+
+def parameter_cond p0, p1, p2, p3, t
+
+	trace ParamNames[ :p0, :p1, :p2, :p3, :t ], p0, p1, p2, p3, t if severity_logged? :trace
+end
+
+def names_in_block p0, p1, p2, p3, t
+
+	trace(p0, p1, p2, p3, t) { ParamNames[ :p0, :p1, :p2, :p3, :t ] }
+end
+
+def all_in_block p0, p1, p2, p3, t
+
+	trace { [ ParamNames[ :p0, :p1, :p2, :p3, :t ], p0, p1, p2, p3, t ] }
+end
+
+
+Benchmark.benchmark(Benchmark::CAPTION, 24, Benchmark::FORMAT, 'total:', 'avg:') do |r|
+
+	t_log = r.report('plain log') do
+
+		for i in (0...N) do
+
+			log :abc, 'd', 'ef', 't=', T
+		end
+	end
+
+	t_blank_trace = r.report('blank_trace') do
+
+		for i in (0...N) do
+
+			blank_trace :abc, 'd', 'ef', 't=', T
+		end
+	end
+
+	t_anonymous_trace = r.report('anonymous_trace') do
+
+		for i in (0...N) do
+
+			anonymous_trace :abc, 'd', 'ef', 't=', T
+		end
+	end
+
+	t_parameter_trace = r.report('parameter_trace') do
+
+		for i in (0...N) do
+
+			parameter_trace :abc, 'd', 'ef', 't=', T
+		end
+	end
+
+	t_parameter_cond = r.report('parameter_cond') do
+
+		for i in (0...N) do
+
+			parameter_cond :abc, 'd', 'ef', 't=', T
+		end
+	end
+
+	t_names_in_block = r.report('names_in_block') do
+
+		for i in (0...N) do
+
+			names_in_block :abc, 'd', 'ef', 't=', T
+		end
+	end
+
+	t_all_in_block = r.report('all_in_block') do
+
+		for i in (0...N) do
+
+			all_in_block :abc, 'd', 'ef', 't=', T
+		end
+	end
+
+#	[ at_0 + at_1 + at_2 + bt_0 + bt_1 + bt_2, (at_0 + at_1 + at_2 + bt_0 + bt_1 + bt_2) / 2 ]
+end
+
+

data/test/scratch/log_using_blocks.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+# File:         test/scratch/log_using_blocks.rb
+#
+# Purpose:      COMPLETE_ME
+#
+# Created:      22nd January 2018
+# Updated:      22nd January 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright:    <<TBD>>
+#
+#############################################################################
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 2), 'lib')
+
+require 'pantheios'
+
+include Pantheios
+
+log :notice, 'program starting ...'
+
+log(:notice) { 'program started' }
+
+def f param0, param1
+
+	trace
+
+	log :trace
+
+	trace param0, param1
+
+	log :trace, param0, param1
+
+	trace ParamNames[ :param0, :param1 ], param0, param1
+
+	log :trace, ParamNames[ :param0, :param1 ], param0, param1
+
+	trace { [ ParamNames[ :param0, :param1 ], param0, param1 ] }
+end
+
+def g param0, param1
+
+	trace(param0, param1) { [ ParamNames[ :param0, :param1 ]] }
+
+	f param0, param1
+end
+
+def h param0, param1, param2
+
+	trace(param0, param1, param2) { ParamNames[ :param0, :param1, :param2 ] }
+
+	g param0, param1
+end
+
+
+f :abc, 'def'
+
+puts
+
+g :ghi, 'k'
+
+puts
+
+h 'lmnop', :q, :rst
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pantheios-ruby
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xqsr3
@@ -51,6 +51,9 @@ files:
 - lib/pantheios/util/thread_util.rb
 - lib/pantheios/util/version_util.rb
 - lib/pantheios/version.rb
+- test/performance/test_perf_simple_statements.rb
+- test/performance/test_perf_trace_variants.rb
+- test/scratch/log_using_blocks.rb
 - test/unit/application_layer/tc_param_name_list.rb
 - test/unit/application_layer/tc_stock_severity_levels.rb
 - test/unit/application_layer/ts_all.rb