cmpfs-ruby 0.2.0 → 0.2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a5d807fbdecc4dcd49ac7cdda8b3de14cfa1249
-  data.tar.gz: 19ad4d748a6811d1dca9a4974ec4962fbf7477a1
+SHA256:
+  metadata.gz: 62764eb741e0f301f90321e85c93b0dce924c67194106b0bd1303bf6aa546783
+  data.tar.gz: 5959477f700c9a53c720bb5576a09efaf86cce525e10b5523d043fc72c75918d
 SHA512:
-  metadata.gz: b8764ee5e224d4be12e69e73086bb576aa211e6cf02d4c98a230e46c75e98c37ca4bdafb739ca07ffa43d3756633650c5a79833774a284d2d8632be64e0355ad
-  data.tar.gz: 8bddd4fa549ed5c977c0fbeb4d564be20fc394be832ad37c0c2c9e2226cb8df04cbdf35742c7f75a48751ffbd365b7d65e0d8bfc0947b0c23367d0e4745256d8
+  metadata.gz: 0a07bfafb304a4a1ae80c144ff232b88617c34e6b8392457fd1b7454dbec32be79da00d03f137ec7e2cf089399876fd185a5b0aac31a1fb94131934b60b37498
+  data.tar.gz: 3e7e33b928703d0c48a2c41d3c765be2dcfd7c77bc8278bea466e9f39e1e76e8e7cd66f6a27083523d547f7d0021c72dee731aa4f0b7658ee7dcf2fa3029d1b5

data/LICENSE

@@ -1,31 +1,32 @@
 cmpfs.Ruby
 
+Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
 Copyright (c) 2019, Matthew Wilson and Synesis Software
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
 
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
-* Neither the names of cmpfs or cmpfs.Ruby nor the names of the copyright
-  holder nor the names of its contributors may be used to endorse or promote
-  products derived from this software without specific prior written
-  permission.
+* Neither the names of cmpfs or cmpfs.Ruby nor the names of its contributors
+  or its copyright holders 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
-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
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+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 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
 

data/README.md

@@ -1,17 +1,25 @@
-# cmpfs.Ruby
+# cmpfs.Ruby <!-- omit in toc -->
+
 **Com**pare **F**ile-**S**ystem entities, for **Ruby**
 
+[![Gem Version](https://badge.fury.io/rb/cmpfs-ruby.svg)](https://badge.fury.io/rb/cmpfs-ruby)
+
 ## Introduction
 
-T.B.C.
+Provides platform-independent facilities for comparing file contents, for both binary and text files
 
-## Table of Contents
+## Table of Contents <!-- omit in toc -->
 
-1. [Introduction](#introduction)
-2. [Installation](#installation)
-3. [Components](#components)
-4. [Examples](#examples)
-5. [Project Information](#project-information)
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Components](#components)
+- [Examples](#examples)
+- [Project Information](#project-information)
+  - [Where to get help](#where-to-get-help)
+  - [Contribution guidelines](#contribution-guidelines)
+  - [Dependencies](#dependencies)
+  - [Related projects](#related-projects)
+  - [License](#license)
 
 ## Installation
 
@@ -43,5 +51,8 @@ T.B.C.
 
 ### License
 
-**cmpfs.Gp** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
+**cmpfs.Ruby** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
+
+
+<!-- ########################### end of file ########################### -->
 

data/lib/cmpfs/compare/api_1_9.rb

@@ -1,139 +1,140 @@
 
 if RUBY_VERSION >= '2'
 
-	abort "This file required Ruby 1+: RUBY_VERSION='#{RUBY_VERSION}'"
+  abort "This file required Ruby 1+: RUBY_VERSION='#{RUBY_VERSION}'"
 end
 
 require 'cmpfs/compare/binary/internal_'
 require 'cmpfs/compare/text/internal_'
 
+
 module CmpFS
 module Compare
 
 module CmpFS_Compare_Methods
 
-	# Compares two files, named by +lhs_path+ and +rhs_path+, in a binary
-	# (exact) manner
-	def compare_binary_files lhs_path, rhs_path, options = {}
-
-		options ||= {}
-
-		::CmpFS::Compare::Binary::Internal_.compare_binary_files_ lhs_path, rhs_path, options
-	end
-
-	# Compares two streams, +lhs_stm+ and +rhs_stm+, in a binary
-	# (exact) manner
-	def compare_binary_streams lhs_stm, rhs_stm, options = {}
-
-		options ||= {}
-
-		::CmpFS::Compare::Binary::Internal_.compare_binary_streams_ lhs_stm, rhs_stm, options
-	end
-
-	# Compares two files/streams in a binary (exact) manner
-	#
-	# == Signature
-	#
-	# == Return
-	#
-	# +true+ if the files/streams have exactly the same content; +false+
-	# otherwise.
-	def compare_binary lhs, rhs, options = {}
-
-		options ||= {}
-
-		::CmpFS::Compare::Binary::Internal_.compare_binary_ lhs, rhs, options
-	end
-
-
-	# Compares two files, named by +lhs_path+ and +rhs_path+, in a textual
-	# manner according to the given +options+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +lhs_path+:: (String) The name of a file
-	#   - +rhs_path+:: (String) The name of a file
-	#   - +options+:: (Hash) Options
-	#
-	# * *Options:*
-	#   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
-	#      should be skipped from the comparison
-	#   - +:trim_lines+:: (boolean) Determines whether lines should be
-	#      trimmed of leading and trailing space (including EOL sequence)
-	#
-	# === Return
-	#
-	# +true+ if the files/streams have exactly the same content; +false+
-	# otherwise.
-	def compare_text_files lhs_path, rhs_path, options = {}
-
-		options |= {}
-
-		::CmpFS::Compare::Text::Internal_.compare_text_files_ lhs_path, rhs_path, options
-	end
-
-	# Compares two streams, named by +lhs_stm+ and +rhs_stm+, in a textual
-	# manner according to the given +options+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +lhs_stm+:: (stream) A stream object
-	#   - +rhs_stm+:: (stream) A stream object
-	#   - +options+:: (Hash) Options
-	#
-	# * *Options:*
-	#   - +:no_rewind+:: (boolean) Prevents the default behaviour of
-	#      rewinding the stream before processing
-	#   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
-	#      should be skipped from the comparison
-	#   - +:trim_lines+:: (boolean) Determines whether lines should be
-	#      trimmed of leading and trailing space (including EOL sequence)
-	#
-	# === Return
-	#
-	# +true+ if the files/streams have exactly the same content; +false+
-	# otherwise.
-	def compare_text_streams lhs_stm, rhs_stm, options = {}
-
-		options ||= {}
-
-		::CmpFS::Compare::Text::Internal_.compare_text_streams_ lhs_stm, rhs_stm, options
-	end
-
-	# Compares two files/streams, named by +lhs+ and +rhs+, in a textual
-	# manner according to the given +options+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +lhs+:: (String, stream) The name of a file, or a stream object
-	#   - +rhs+:: (String, stream) The name of a file, or a stream object
-	#   - +options+:: (Hash) Options
-	#
-	# * *Options:*
-	#   - +:no_rewind+:: (boolean) Prevents the default behaviour of
-	#      rewinding the stream before processing
-	#   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
-	#      should be skipped from the comparison
-	#   - +:trim_lines+:: (boolean) Determines whether lines should be
-	#      trimmed of leading and trailing space (including EOL sequence)
-	#
-	# === Return
-	#
-	# +true+ if the files/streams have exactly the same content; +false+
-	# otherwise.
-	def compare_text lhs, rhs, options = {}
-
-		options ||= {}
-
-		::CmpFS::Compare::Text::Internal_.compare_text_ lhs, rhs, options
-	end
+  # Compares two files, named by +lhs_path+ and +rhs_path+, in a binary
+  # (exact) manner
+  def compare_binary_files lhs_path, rhs_path, options = {}
+
+    options ||= {}
+
+    ::CmpFS::Compare::Binary::Internal_.compare_binary_files_ lhs_path, rhs_path, options
+  end
+
+  # Compares two streams, +lhs_stm+ and +rhs_stm+, in a binary
+  # (exact) manner
+  def compare_binary_streams lhs_stm, rhs_stm, options = {}
+
+    options ||= {}
+
+    ::CmpFS::Compare::Binary::Internal_.compare_binary_streams_ lhs_stm, rhs_stm, options
+  end
+
+  # Compares two files/streams in a binary (exact) manner
+  #
+  # == Signature
+  #
+  # == Return
+  #
+  # +true+ if the files/streams have exactly the same content; +false+
+  # otherwise.
+  def compare_binary lhs, rhs, options = {}
+
+    options ||= {}
+
+    ::CmpFS::Compare::Binary::Internal_.compare_binary_ lhs, rhs, options
+  end
+
+
+  # Compares two files, named by +lhs_path+ and +rhs_path+, in a textual
+  # manner according to the given +options+
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +lhs_path+:: (String) The name of a file
+  #   - +rhs_path+:: (String) The name of a file
+  #   - +options+:: (Hash) Options
+  #
+  # * *Options:*
+  #   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
+  #      should be skipped from the comparison
+  #   - +:trim_lines+:: (boolean) Determines whether lines should be
+  #      trimmed of leading and trailing space (including EOL sequence)
+  #
+  # === Return
+  #
+  # +true+ if the files/streams have exactly the same content; +false+
+  # otherwise.
+  def compare_text_files lhs_path, rhs_path, options = {}
+
+    options |= {}
+
+    ::CmpFS::Compare::Text::Internal_.compare_text_files_ lhs_path, rhs_path, options
+  end
+
+  # Compares two streams, named by +lhs_stm+ and +rhs_stm+, in a textual
+  # manner according to the given +options+
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +lhs_stm+:: (stream) A stream object
+  #   - +rhs_stm+:: (stream) A stream object
+  #   - +options+:: (Hash) Options
+  #
+  # * *Options:*
+  #   - +:no_rewind+:: (boolean) Prevents the default behaviour of
+  #      rewinding the stream before processing
+  #   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
+  #      should be skipped from the comparison
+  #   - +:trim_lines+:: (boolean) Determines whether lines should be
+  #      trimmed of leading and trailing space (including EOL sequence)
+  #
+  # === Return
+  #
+  # +true+ if the files/streams have exactly the same content; +false+
+  # otherwise.
+  def compare_text_streams lhs_stm, rhs_stm, options = {}
+
+    options ||= {}
+
+    ::CmpFS::Compare::Text::Internal_.compare_text_streams_ lhs_stm, rhs_stm, options
+  end
+
+  # Compares two files/streams, named by +lhs+ and +rhs+, in a textual
+  # manner according to the given +options+
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +lhs+:: (String, stream) The name of a file, or a stream object
+  #   - +rhs+:: (String, stream) The name of a file, or a stream object
+  #   - +options+:: (Hash) Options
+  #
+  # * *Options:*
+  #   - +:no_rewind+:: (boolean) Prevents the default behaviour of
+  #      rewinding the stream before processing
+  #   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
+  #      should be skipped from the comparison
+  #   - +:trim_lines+:: (boolean) Determines whether lines should be
+  #      trimmed of leading and trailing space (including EOL sequence)
+  #
+  # === Return
+  #
+  # +true+ if the files/streams have exactly the same content; +false+
+  # otherwise.
+  def compare_text lhs, rhs, options = {}
+
+    options ||= {}
+
+    ::CmpFS::Compare::Text::Internal_.compare_text_ lhs, rhs, options
+  end
 end # module CmpFS_Compare_Methods
 end # module Compare
 end # module CmpFS
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/cmpfs/compare/api_2.rb

@@ -1,127 +1,128 @@
 
 unless RUBY_VERSION >= '2'
 
-	abort "This file required Ruby 2+: RUBY_VERSION='#{RUBY_VERSION}'"
+  abort "This file required Ruby 2+: RUBY_VERSION='#{RUBY_VERSION}'"
 end
 
 require 'cmpfs/compare/binary/internal_'
 require 'cmpfs/compare/text/internal_'
 
+
 module CmpFS
 module Compare
 
 module CmpFS_Compare_Methods
 
-	# Compares two files, named by +lhs_path+ and +rhs_path+, in a binary
-	# (exact) manner
-	def compare_binary_files lhs_path, rhs_path, **options
-
-		::CmpFS::Compare::Binary::Internal_.compare_binary_files_ lhs_path, rhs_path, options
-	end
-
-	# Compares two streams, +lhs_stm+ and +rhs_stm+, in a binary
-	# (exact) manner
-	def compare_binary_streams lhs_stm, rhs_stm, **options
-
-		::CmpFS::Compare::Binary::Internal_.compare_binary_streams_ lhs_stm, rhs_stm, options
-	end
-
-	# Compares two files/streams in a binary (exact) manner
-	#
-	# == Signature
-	#
-	# == Return
-	#
-	# +true+ if the files/streams have exactly the same content; +false+
-	# otherwise.
-	def compare_binary lhs, rhs, **options
-
-		::CmpFS::Compare::Binary::Internal_.compare_binary_ lhs, rhs, options
-	end
-
-
-	# Compares two files, named by +lhs_path+ and +rhs_path+, in a textual
-	# manner according to the given +options+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +lhs_path+:: (String) The name of a file
-	#   - +rhs_path+:: (String) The name of a file
-	#   - +options+:: (Hash) Options
-	#
-	# * *Options:*
-	#   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
-	#      should be skipped from the comparison
-	#   - +:trim_lines+:: (boolean) Determines whether lines should be
-	#      trimmed of leading and trailing space (including EOL sequence)
-	#
-	# === Return
-	#
-	# +true+ if the files/streams have exactly the same content; +false+
-	# otherwise.
-	def compare_text_files lhs_path, rhs_path, **options
-
-		::CmpFS::Compare::Text::Internal_.compare_text_files_ lhs_path, rhs_path, options
-	end
-
-	# Compares two streams, named by +lhs_stm+ and +rhs_stm+, in a textual
-	# manner according to the given +options+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +lhs_stm+:: (stream) A stream object
-	#   - +rhs_stm+:: (stream) A stream object
-	#   - +options+:: (Hash) Options
-	#
-	# * *Options:*
-	#   - +:no_rewind+:: (boolean) Prevents the default behaviour of
-	#      rewinding the stream before processing
-	#   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
-	#      should be skipped from the comparison
-	#   - +:trim_lines+:: (boolean) Determines whether lines should be
-	#      trimmed of leading and trailing space (including EOL sequence)
-	#
-	# === Return
-	#
-	# +true+ if the files/streams have exactly the same content; +false+
-	# otherwise.
-	def compare_text_streams lhs_stm, rhs_stm, **options
-
-		::CmpFS::Compare::Text::Internal_.compare_text_streams_ lhs_stm, rhs_stm, options
-	end
-
-	# Compares two files/streams, named by +lhs+ and +rhs+, in a textual
-	# manner according to the given +options+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +lhs+:: (String, stream) The name of a file, or a stream object
-	#   - +rhs+:: (String, stream) The name of a file, or a stream object
-	#   - +options+:: (Hash) Options
-	#
-	# * *Options:*
-	#   - +:no_rewind+:: (boolean) Prevents the default behaviour of
-	#      rewinding the stream before processing
-	#   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
-	#      should be skipped from the comparison
-	#   - +:trim_lines+:: (boolean) Determines whether lines should be
-	#      trimmed of leading and trailing space (including EOL sequence)
-	#
-	# === Return
-	#
-	# +true+ if the files/streams have exactly the same content; +false+
-	# otherwise.
-	def compare_text lhs, rhs, **options
-
-		::CmpFS::Compare::Text::Internal_.compare_text_ lhs, rhs, options
-	end
+  # Compares two files, named by +lhs_path+ and +rhs_path+, in a binary
+  # (exact) manner
+  def compare_binary_files lhs_path, rhs_path, **options
+
+    ::CmpFS::Compare::Binary::Internal_.compare_binary_files_ lhs_path, rhs_path, options
+  end
+
+  # Compares two streams, +lhs_stm+ and +rhs_stm+, in a binary
+  # (exact) manner
+  def compare_binary_streams lhs_stm, rhs_stm, **options
+
+    ::CmpFS::Compare::Binary::Internal_.compare_binary_streams_ lhs_stm, rhs_stm, options
+  end
+
+  # Compares two files/streams in a binary (exact) manner
+  #
+  # == Signature
+  #
+  # == Return
+  #
+  # +true+ if the files/streams have exactly the same content; +false+
+  # otherwise.
+  def compare_binary lhs, rhs, **options
+
+    ::CmpFS::Compare::Binary::Internal_.compare_binary_ lhs, rhs, options
+  end
+
+
+  # Compares two files, named by +lhs_path+ and +rhs_path+, in a textual
+  # manner according to the given +options+
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +lhs_path+:: (String) The name of a file
+  #   - +rhs_path+:: (String) The name of a file
+  #   - +options+:: (Hash) Options
+  #
+  # * *Options:*
+  #   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
+  #      should be skipped from the comparison
+  #   - +:trim_lines+:: (boolean) Determines whether lines should be
+  #      trimmed of leading and trailing space (including EOL sequence)
+  #
+  # === Return
+  #
+  # +true+ if the files/streams have exactly the same content; +false+
+  # otherwise.
+  def compare_text_files lhs_path, rhs_path, **options
+
+    ::CmpFS::Compare::Text::Internal_.compare_text_files_ lhs_path, rhs_path, options
+  end
+
+  # Compares two streams, named by +lhs_stm+ and +rhs_stm+, in a textual
+  # manner according to the given +options+
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +lhs_stm+:: (stream) A stream object
+  #   - +rhs_stm+:: (stream) A stream object
+  #   - +options+:: (Hash) Options
+  #
+  # * *Options:*
+  #   - +:no_rewind+:: (boolean) Prevents the default behaviour of
+  #      rewinding the stream before processing
+  #   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
+  #      should be skipped from the comparison
+  #   - +:trim_lines+:: (boolean) Determines whether lines should be
+  #      trimmed of leading and trailing space (including EOL sequence)
+  #
+  # === Return
+  #
+  # +true+ if the files/streams have exactly the same content; +false+
+  # otherwise.
+  def compare_text_streams lhs_stm, rhs_stm, **options
+
+    ::CmpFS::Compare::Text::Internal_.compare_text_streams_ lhs_stm, rhs_stm, options
+  end
+
+  # Compares two files/streams, named by +lhs+ and +rhs+, in a textual
+  # manner according to the given +options+
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +lhs+:: (String, stream) The name of a file, or a stream object
+  #   - +rhs+:: (String, stream) The name of a file, or a stream object
+  #   - +options+:: (Hash) Options
+  #
+  # * *Options:*
+  #   - +:no_rewind+:: (boolean) Prevents the default behaviour of
+  #      rewinding the stream before processing
+  #   - +:skip_blank_lines+:: (boolean) Determines whether blank lines
+  #      should be skipped from the comparison
+  #   - +:trim_lines+:: (boolean) Determines whether lines should be
+  #      trimmed of leading and trailing space (including EOL sequence)
+  #
+  # === Return
+  #
+  # +true+ if the files/streams have exactly the same content; +false+
+  # otherwise.
+  def compare_text lhs, rhs, **options
+
+    ::CmpFS::Compare::Text::Internal_.compare_text_ lhs, rhs, options
+  end
 end # module CmpFS_Compare_Methods
 end # module Compare
 end # module CmpFS
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #