xqsr3 0.29.2 → 0.30.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67a291e75a1f5250c92410e09cb8ce4afc2e706b
-  data.tar.gz: 17b2fd750488be59288a0ac67df35253455eadcd
+  metadata.gz: e0aae760822aa8749a7caeb361cc3c40fd3d374d
+  data.tar.gz: 223189ea29f2c140cc2a866b6cc0872f18f8a9fe
 SHA512:
-  metadata.gz: e2210e3dfc465b1c899c5dff468349d5c1df6d24aeecf96fc2c9bcb7186d1dbb1923bee39ee1e940493bb4f16b9b70c4c74e21f23752cb7977267f8beb83c7ca
-  data.tar.gz: 83e3b052e816d7eaf90dc5e27c2c8565693fe84108456f8f0417fdc156ef7c2cd3b5953443b20ebd7c66c94cb59e65dc8416baf45e8aa312daa652e91a26e717
+  metadata.gz: f190ff85d37defc8e7a9b7927a4cfea44945bb071f3d01a7090489fdbcc3dc365ad7f27970b5696096db37daa924376c8f1402aa51758f9b0220ba10a8d7a088
+  data.tar.gz: 75ab4d3ae800bf45f54de072b845a556c8edbd9d87198340a098e0f44cdb06681f0ffcd197ede43763de670c9d754aed08cf8df28f9de6369c9c497a1fd86184

data/LICENSE

@@ -17,9 +17,9 @@ modification, are permitted provided that the following conditions are met:
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

data/README.md

@@ -1,28 +1,73 @@
 # xqsr3
-eXtensions by fine Quantum for Standard Ruby and 3rd-party libraries
+e**X**tensions by fine **Q**uantum for **S**tandard **R**uby and **3**rd-party libraries
 
 [![Gem Version](https://badge.fury.io/rb/xqsr3.svg)](https://badge.fury.io/rb/xqsr3)
 
-## Installation & usage
+## Introduction
+
+**xqsr3** is a lightweight, low-coupling library of assorted extensions to standard ruby and 3rd-party libraries.
+
+It has **no dependencies** on any other non-standard library.
+
+It may be pronounced (lamely) as "excusers".
+
+## Table of Contents
+
+1. [Introduction](#introduction)
+2. [Installation](#installation)
+3. [Components](#components)
+4. [Project Information](#project-information)
+
+## Installation
 
 Install using `gem install xqsr3` or add it to your `Gemfile`.
 
-## Description
+## Components
 
-**xqsr3** is a lightweight, low-coupling library of assorted extensions to standard ruby and 3rd-party libraries.
+**xqsr3** provides components in the following categories:
 
-## Where to get help
+* Array Utilities
+* Command-line Utilities
+* Containers
+* Conversion
+* Diagnostics
+* Hash Utilities
+* IO
+* Quality
+* String Utilities
+* XML Utilities
+
+and extensions to the following standard library components:
+
+* Array extensions
+* Enumerable extensions
+* Hash extensions
+* IO extensions
+* Kernel extensions
+* String extensions
+* test/unit extensions
+
+## Project Information
+
+### Where to get help
 
 [GitHub Page](https://github.com/synesissoftware/xqsr3 "GitHub Page")
 
-## Contribution guidelines
+### Contribution guidelines
 
 Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/xqsr3.
 
-## Related projects
+### Related projects
+
+**xqsr3** is a runtime dependency in:
+
+* the **[libCLImate.Ruby](https://github.com/synesissoftware/libCLImate.Ruby)** library;
+
+and a development dependency in:
 
-**xqsr3** is used in the **[libCLImate.Ruby](https://github.com/synesissoftware/libCLImate.Ruby)** library.
+* the **[CLASP.Ruby](https://github.com/synesissoftware/CLASP.Ruby)** library;
+* the **[Pantheios.Ruby](https://github.com/synesissoftware/Pantheios.Ruby)** library;
 
-## License
+### License
 
-**xqsr3** is released under the 3-clause BSD license. See LICENSE for details.
+**xqsr3** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.

data/lib/xqsr3/containers/frequency_map.rb

@@ -215,6 +215,18 @@ class FrequencyMap
 		end
 	end
 
+	# Enumerates each entry pair - element + frequency - in key order
+	#
+	# Note: this method is more expensive than +each+ because an array of
+	# keys must be created and sorted from which enumeration is directed
+	def each_by_key
+
+		@counts.keys.sort.each do |key|
+
+			yield key, @counts[key]
+		end
+	end
+
 	# Enumerates each entry pair - element + frequency - in descending
 	# order of frequency
 	#

data/lib/xqsr3/quality/parameter_checking.rb

@@ -5,7 +5,7 @@
 # Purpose:      Definition of the ParameterChecking module
 #
 # Created:      12th February 2015
-# Updated:      20th September 2018
+# Updated:      18th October 2018
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
@@ -353,18 +353,20 @@ module ParameterChecking
 
 			unless types.any? do |t|
 
-					case t
-					when ::Class
+				case t
+				when ::Class
 
-						# the (presumed) scalar argument is of type t?
-						value.is_a?(t)
-					when ::Array
+					# the (presumed) scalar argument is of type t?
+					value.is_a?(t)
+				when ::Array
+
+					# the (presumed) vector argument's elements are the
+					# possible types
+					value.all? { |v| t.any? { |t2| v.is_a?(t2) }} if ::Array === value
+				else
 
-						# the (presumed) vector argument's elements are the
-						# possible types
-						value.all? { |v| t.any? { |t2| v.is_a?(t2) }} if ::Array === value
-					end
 				end
+			end then
 
 				failed_check	=	true
 

data/lib/xqsr3/version.rb

@@ -5,13 +5,13 @@
 # Purpose:      Version for Xqsr3 library
 #
 # Created:      3rd April 2016
-# Updated:      13th October 2018
+# Updated:      28th February 2019
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2016-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2016-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -50,7 +50,7 @@
 module Xqsr3
 
 	# Current version of the Xqsr3 library
-	VERSION				=	'0.29.2'
+	VERSION				=	'0.30.3'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/lib/xqsr3/xml/utilities/compare.rb

@@ -134,7 +134,7 @@ module Compare
 
 		def details
 
-			r	=	reason.to_s.gsub /_/, ' '
+			r	=	reason.to_s.gsub(/_/, ' ')
 
 			qualifying	=	''
 

data/test/performance/frequency_map.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+# File:         test/performance/frequency_map.rb
+#
+# Purpose:      COMPLETE_ME
+#
+# Created:      13th October 2018
+# Updated:      13th October 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright:    <<TBD>>
+#
+#############################################################################
+
+$:.unshift File.join(File.dirname($0), *(['..'] * 2), 'lib')
+
+require 'xqsr3/containers/frequency_map'
+
+require 'benchmark'
+
+include ::Xqsr3::Containers
+
+Benchmark.bm do |bm|
+
+	fm = FrequencyMap.new
+
+	(0...100000000).each do |n|
+
+		fm << (n % 4793)
+	end
+
+	bm.report('each       ') do
+
+		fm.each do |k, freq|
+
+		end
+	end
+
+	bm.report('each (by f)') do
+
+		fm.each_by_frequency do |k, freq|
+
+		end
+	end
+end
+

data/test/unit/containers/tc_frequency_map.rb

@@ -306,6 +306,27 @@ class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
 		assert_equal [:ghi, 2], r[2]
 	end
 
+	def test_each_by_key
+
+		fm = FrequencyMap.new
+
+		fm << :def
+		fm << :abc << :abc << :abc << :abc
+		fm << :ghi << :ghi
+
+		r = []
+
+		fm.each_by_key do |k, v|
+
+			r << [k, v]
+		end
+
+		assert_equal 3, r.size
+		assert_equal [:abc, 4], r[0]
+		assert_equal [:def, 1], r[1]
+		assert_equal [:ghi, 2], r[2]
+	end
+
 	def test_each_by_frequency
 
 		fm = FrequencyMap.new

data/test/unit/quality/tc_parameter_checking.rb

@@ -359,6 +359,11 @@ end
 
 			self.class.check_method_type_class :sym, ::String
 		end
+
+
+		# arrays of strings
+
+		assert_kind_of ::Array, check_method_type([ 'abc' ], [ ::String ])
 	end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xqsr3
 version: !ruby/object:Gem::Version
-  version: 0.29.2
+  version: 0.30.3
 platform: ruby
 authors:
 - Matt Wilson
@@ -80,6 +80,7 @@ files:
 - lib/xqsr3/version.rb
 - lib/xqsr3/xml/utilities/compare.rb
 - lib/xqsr3/xml/utilities/navigation.rb
+- test/performance/frequency_map.rb
 - test/unit/array_utilities/tc_join_with_or.rb
 - test/unit/array_utilities/ts_all.rb
 - test/unit/command_line_utilities/tc_map_option_string.rb
@@ -140,7 +141,7 @@ files:
 - test/unit/xml/utilities/ts_all.rb
 homepage: http://github.com/synesissoftware/xqsr3
 licenses:
-- BSD-3-clause
+- BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []