cmpfs-ruby 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a5d807fbdecc4dcd49ac7cdda8b3de14cfa1249
+  data.tar.gz: 19ad4d748a6811d1dca9a4974ec4962fbf7477a1
+SHA512:
+  metadata.gz: b8764ee5e224d4be12e69e73086bb576aa211e6cf02d4c98a230e46c75e98c37ca4bdafb739ca07ffa43d3756633650c5a79833774a284d2d8632be64e0355ad
+  data.tar.gz: 8bddd4fa549ed5c977c0fbeb4d564be20fc394be832ad37c0c2c9e2226cb8df04cbdf35742c7f75a48751ffbd365b7d65e0d8bfc0947b0c23367d0e4745256d8

data/LICENSE

@@ -0,0 +1,31 @@
+cmpfs.Ruby
+
+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 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.
+
+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

@@ -0,0 +1,47 @@
+# cmpfs.Ruby
+**Com**pare **F**ile-**S**ystem entities, for **Ruby**
+
+## Introduction
+
+T.B.C.
+
+## Table of Contents
+
+1. [Introduction](#introduction)
+2. [Installation](#installation)
+3. [Components](#components)
+4. [Examples](#examples)
+5. [Project Information](#project-information)
+
+## Installation
+
+Install using `gem install cmpfs-ruby` or add it to your `Gemfile`.
+
+## Components
+
+T.B.C.
+
+## Examples
+
+T.B.C.
+
+## Project Information
+
+### Where to get help
+
+[GitHub Page](https://github.com/synesissoftware/cmpfs.Ruby "GitHub Page")
+
+### Contribution guidelines
+
+Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/cmpfs.Ruby.
+
+### Dependencies
+
+### Related projects
+
+T.B.C.
+
+### License
+
+**cmpfs.Gp** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
+

data/lib/cmpfs.rb

@@ -0,0 +1,77 @@
+
+# ######################################################################## #
+# File:         cmpfs.rb
+#
+# Purpose:      Primary require for cmpfs.Ruby library
+#
+# Created:      1st March 2019
+# Updated:      13th March 2019
+#
+# Home:         http://github.com/synesissoftware/cmpfs.Ruby
+#
+# Author:       Matthew Wilson
+#
+# 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 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 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.
+#
+# 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.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+require 'cmpfs/compare'
+require 'cmpfs/version'
+
+## Root module for *cmpfs*
+module CmpFS
+
+	def self.extended receiver
+
+		receiver.class_eval do
+
+			extend CmpFS::Compare
+		end
+
+		$stderr.puts "#{receiver} extended by #{CmpFS}" if $DEBUG
+	end
+
+	def self.included receiver
+
+		receiver.class_eval do
+
+			include CmpFS::Compare
+		end
+
+		$stderr.puts "#{receiver} included #{CmpFS}" if $DEBUG
+	end
+
+end # module CmpFS
+

data/lib/cmpfs/compare.rb

@@ -0,0 +1,104 @@
+
+# ######################################################################## #
+# File:         cmpfs/version.rb
+#
+# Purpose:      Version for cmpfs.Ruby library
+#
+# Created:      1st March 2019
+# Updated:      13th March 2019
+#
+# Home:         http://github.com/synesissoftware/cmpfs.Ruby
+#
+# Author:       Matthew Wilson
+#
+# 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 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 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.
+#
+# 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.
+#
+# ######################################################################## #
+
+
+if RUBY_VERSION >= '2'
+
+	require 'cmpfs/compare/api_2'
+else
+
+	require 'cmpfs/compare/api_1_9'
+end
+
+=begin
+=end
+
+module CmpFS
+
+# The comparison module, which may be used directly, and which may be
+# extended or included
+#
+# Important functions:
+#
+# - +CmpFS::Compare.compare_binary_files()+
+# - +CmpFS::Compare.compare_binary_streams()+
+# - +CmpFS::Compare.compare_binary()+
+#
+# - +CmpFS::Compare.compare_text_files()+
+# - +CmpFS::Compare.compare_text_streams()+
+# - +CmpFS::Compare.compare_text()+
+#
+#
+module Compare
+
+	def self.extended receiver
+
+		receiver.class_eval do
+
+			extend CmpFS_Compare_Methods
+		end
+
+		$stderr.puts "#{receiver} extended by #{CmpFS_Compare_Methods}" if $DEBUG
+	end
+
+	def self.included receiver
+
+		receiver.class_eval do
+
+			include CmpFS_Compare_Methods
+		end
+
+		$stderr.puts "#{receiver} included #{CmpFS_Compare_Methods}" if $DEBUG
+	end
+
+	extend CmpFS_Compare_Methods
+	include CmpFS_Compare_Methods
+
+end # module Compare
+end # module CmpFS
+
+# ############################## end of file ############################# #
+
+

data/lib/cmpfs/compare/api_1_9.rb

@@ -0,0 +1,139 @@
+
+if RUBY_VERSION >= '2'
+
+	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
+end # module CmpFS_Compare_Methods
+end # module Compare
+end # module CmpFS
+
+# ############################## end of file ############################# #
+
+

data/lib/cmpfs/compare/api_2.rb

@@ -0,0 +1,127 @@
+
+unless RUBY_VERSION >= '2'
+
+	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
+end # module CmpFS_Compare_Methods
+end # module Compare
+end # module CmpFS
+
+# ############################## end of file ############################# #
+
+

data/lib/cmpfs/compare/binary/internal_.rb

@@ -0,0 +1,96 @@
+
+#require 'xqsr3'
+
+require 'fileutils'
+require 'stringio'
+
+module CmpFS
+module Compare
+module Binary
+
+module Internal_
+
+		def self.determine_param_type_ p
+
+			case p
+			when ::IO, ::StringIO
+
+				return :io
+			when ::String
+
+				return :path
+			else
+
+				return :path if p.respond_to?(:to_str)
+
+				return nil
+			end
+		end
+
+		def self.compare_binary_files_ lhs_path, rhs_path, options
+
+			FileUtils.compare_file lhs_path, rhs_path
+		end
+
+		def self.compare_binary_streams_ lhs_stm, rhs_stm, options
+
+			FileUtils.compare_stream lhs_stm, rhs_stm
+		end
+
+		def self.compare_binary_ lhs, rhs, options
+
+
+			lhs_type	=	self.determine_param_type_ lhs
+			rhs_type	=	self.determine_param_type_ rhs
+
+			raise ArgumentError, "lhs is of unsupported type '#{lhs.class}'" unless lhs_type
+			raise ArgumentError, "rhs is of unsupported type '#{rhs.class}'" unless rhs_type
+
+			if lhs_type == rhs_type
+
+				case lhs_type
+				when :io
+
+					return self.compare_binary_streams_ lhs, rhs, options
+				when :path
+
+					return self.compare_binary_files_ lhs, rhs, options
+				end
+			else
+
+				case lhs_type
+				when :io
+
+					if :path == rhs_type
+
+						File.open(rhs, 'rb') do |rhs_f|
+
+							return self.compare_binary_streams_ lhs, rhs_f, options
+						end
+					end
+				when :path
+
+					if :path == lhs_type
+
+						File.open(lhs, 'rb') do |lhs_f|
+
+							return self.compare_binary_streams_ lhs_f, rhs, options
+						end
+					end
+				end
+			end
+
+			warn "#{__method__}: incompatible types (#{lhs.type}, #{rhs.type})"
+
+			nil
+		end
+
+end # module Internal_
+
+end # module Binary
+end # module Compare
+end # module CmpFS
+
+# ############################## end of file ############################# #
+
+

data/lib/cmpfs/compare/text/internal_.rb

@@ -0,0 +1,159 @@
+
+#require 'xqsr3'
+
+require 'fileutils'
+require 'stringio'
+
+module CmpFS
+module Compare
+module Text
+
+module Internal_
+
+		def self.determine_param_type_ p
+
+			case p
+			when ::IO, ::StringIO
+
+				return :io
+			when ::String
+
+				return :path
+			else
+
+				return :path if p.respond_to?(:to_str)
+
+				return nil
+			end
+		end
+
+		def self.next_line_or_nil_ en, options
+
+			trimming_lines	=	options[:trim_lines]
+			skipping_blanks	=	options[:skip_blank_lines]
+
+			num_read		=	0
+
+			begin
+
+				loop do
+
+					line = en.next
+
+					num_read += 1
+
+					line = line.strip if trimming_lines
+
+					if line.empty? && skipping_blanks
+
+						next
+					end
+
+					return [ line, num_read ]
+				end
+			rescue StopIteration
+
+			end
+
+			return [ nil, num_read ]
+		end
+
+		def self.compare_text_files_ lhs_path, rhs_path, options
+
+			File.open(lhs_path, 'r') do |lhs_stm|
+
+				File.open(rhs_path, 'r') do |rhs_stm|
+
+					self.compare_text_streams_ lhs_stm, rhs_stm, options.merge(no_rewind: true)
+				end
+			end
+		end
+
+		def self.compare_text_streams_ lhs_stm, rhs_stm, options
+
+			lhs_en	=	lhs_stm.each_line
+			rhs_en	=	rhs_stm.each_line
+
+			unless options[:no_rewind]
+
+				lhs_en.rewind if lhs_stm.respond_to?(:rewind)
+				rhs_en.rewind if rhs_stm.respond_to?(:rewind)
+			end
+
+			lhs_ix	=	0
+			rhs_ix	=	0
+
+			loop do
+
+				lhs_ln, lhs_nr	=	self.next_line_or_nil_ lhs_en, options
+				rhs_ln, rhs_nr	=	self.next_line_or_nil_ rhs_en, options
+
+				if lhs_ln != rhs_ln
+
+					return false
+				else
+
+					return true if lhs_ln.nil?
+				end
+			end
+
+			return true
+		end
+
+		def self.compare_text_ lhs, rhs, options
+
+			lhs_type	=	self.determine_param_type_ lhs
+			rhs_type	=	self.determine_param_type_ rhs
+
+			raise ArgumentError, "lhs is of unsupported type '#{lhs.class}'" unless lhs_type
+			raise ArgumentError, "rhs is of unsupported type '#{rhs.class}'" unless rhs_type
+
+			if lhs_type == rhs_type
+
+				case lhs_type
+				when :io
+
+					return self.compare_text_streams_ lhs, rhs, options
+				when :path
+
+					return self.compare_text_files_ lhs, rhs, options
+				end
+			else
+
+				case lhs_type
+				when :io
+
+					if :path == rhs_type
+
+						File.open(rhs, 'r') do |rhs_f|
+
+							return self.compare_text_streams_ lhs, rhs_f, options
+						end
+					end
+				when :path
+
+					if :path == lhs_type
+
+						File.open(lhs, 'r') do |lhs_f|
+
+							return self.compare_text_streams_ lhs_f, rhs, options
+						end
+					end
+				end
+			end
+
+			warn "#{__method__}: incompatible types (#{lhs.type}, #{rhs.type})"
+
+			nil
+		end
+
+end # module Internal_
+
+end # module Text
+end # module Compare
+end # module CmpFS
+
+# ############################## end of file ############################# #
+
+
+

data/lib/cmpfs/version.rb

@@ -0,0 +1,71 @@
+
+# ######################################################################## #
+# File:         cmpfs/version.rb
+#
+# Purpose:      Version for cmpfs.Ruby library
+#
+# Created:      1st March 2019
+# Updated:      13th March 2019
+#
+# Home:         http://github.com/synesissoftware/cmpfs.Ruby
+#
+# Author:       Matthew Wilson
+#
+# 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 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 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.
+#
+# 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.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module CmpFS
+
+	# Current version of the cmpfs.Ruby library
+	VERSION				=	'0.2.0'
+
+	private
+	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+	public
+	# Major version of the cmpfs.Ruby library
+	VERSION_MAJOR		=	VERSION_PARTS_[0] # :nodoc:
+	# Minor version of the cmpfs.Ruby library
+	VERSION_MINOR		=	VERSION_PARTS_[1] # :nodoc:
+	# Revision version of the cmpfs.Ruby library
+	VERSION_PATCH		=	VERSION_PARTS_[2] # :nodoc:
+
+	VERSION_REVISION	=	VERSION_PATCH # :nodoc:
+
+end # module CmpFS
+
+# ############################## end of file ############################# #
+
+

data/test/unit/compare/tc_compare_binary.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../../lib')
+
+require 'cmpfs/compare'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+require 'stringio'
+require 'tempfile'
+
+class Test_CmpFS_Compare_compare_binary < Test::Unit::TestCase
+
+	def test_compare_binary_identical_1
+
+		lhs		=	StringIO.new 'abcdefghijiklmno'
+		rhs_eq	=	StringIO.new 'abcdefghijiklmno'
+
+		assert CmpFS::Compare.compare_binary(lhs, rhs_eq), 'streams should be the same'
+
+		rhs_ne	=	StringIO.new 'abcdefghijiklmn'
+
+		assert_false CmpFS::Compare.compare_binary(lhs, rhs_ne), 'streams should not be the same'
+	end
+
+	def test_compare_binary_identical_2
+
+		lhs_f = Tempfile.new('compare_binary-2')
+
+		begin
+
+			lhs_f << 'abcdefghijiklmno'
+
+			lhs_f.rewind
+			lhs_f.close
+
+			rhs_eq	=	StringIO.new 'abcdefghijiklmno'
+
+			assert CmpFS::Compare.compare_binary(lhs_f.path, rhs_eq), 'streams should be the same'
+
+			rhs_ne	=	StringIO.new 'abcdefghijiklmnop'
+
+			assert_false CmpFS::Compare.compare_binary(lhs_f.path, rhs_ne), 'streams should not be the same'
+		ensure
+
+			lhs_f.unlink
+		end
+	end
+
+	def test_compare_binary_identical_3
+
+		lhs_f = Tempfile.new('compare_binary-3')
+
+		begin
+
+			lhs_f << 'abcdefghijiklmno'
+
+			lhs_f.rewind
+			lhs_f.close
+
+
+			rhs_eq_f = Tempfile.new('compare_binary-3')
+
+			begin
+
+				rhs_eq_f << 'abcdefghijiklmno'
+
+				rhs_eq_f.rewind
+				rhs_eq_f.close
+
+				assert CmpFS::Compare.compare_binary(lhs_f.path, rhs_eq_f.path), 'streams should be the same'
+			ensure
+
+				rhs_eq_f.unlink
+			end
+
+
+			rhs_ne_f = Tempfile.new('compare_binary-3')
+
+			begin
+
+				rhs_ne_f << 'xyz'
+
+				rhs_ne_f.rewind
+				rhs_ne_f.close
+
+				assert_false CmpFS::Compare.compare_binary(lhs_f.path, rhs_ne_f.path), 'streams should not be the same'
+			ensure
+
+				rhs_ne_f.unlink
+			end
+
+		ensure
+
+			lhs_f.unlink
+		end
+	end
+end
+
+# ############################## end of file ############################# #
+
+

data/test/unit/compare/ts_all.rb

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+#
+# executes all other tests
+
+this_dir	=	File.expand_path(File.dirname(__FILE__))
+
+# all tc_*rb in current directory
+Dir[File.join(this_dir, 'tc_*rb')].each { |file| require file }
+
+# all ts_*rb in immediate sub-directories
+Dir[File.join(this_dir, '*', 'ts_*rb')].each { |file| require file }
+

data/test/unit/tc_compare_binary.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../lib')
+
+require 'cmpfs'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+require 'stringio'
+require 'tempfile'
+
+class Test_CmpFS_compare_binary < Test::Unit::TestCase
+
+	include ::CmpFS
+
+	def test_compare_binary_identical_1
+
+		lhs		=	StringIO.new 'abcdefghijiklmno'
+		rhs_eq	=	StringIO.new 'abcdefghijiklmno'
+
+		assert compare_binary(lhs, rhs_eq), 'streams should be the same'
+
+		rhs_ne	=	StringIO.new 'abcdefghijiklmn'
+
+		assert_false compare_binary(lhs, rhs_ne), 'streams should not be the same'
+	end
+
+	def test_compare_binary_identical_2
+
+		lhs_f = Tempfile.new('compare_binary-2')
+
+		begin
+
+			lhs_f << 'abcdefghijiklmno'
+
+			lhs_f.rewind
+			lhs_f.close
+
+			rhs_eq	=	StringIO.new 'abcdefghijiklmno'
+
+			assert compare_binary(lhs_f.path, rhs_eq), 'streams should be the same'
+
+			rhs_ne	=	StringIO.new 'abcdefghijiklmnop'
+
+			assert_false compare_binary(lhs_f.path, rhs_ne), 'streams should not be the same'
+		ensure
+
+			lhs_f.unlink
+		end
+	end
+
+	def test_compare_binary_identical_3
+
+		lhs_f = Tempfile.new('compare_binary-3')
+
+		begin
+
+			lhs_f << 'abcdefghijiklmno'
+
+			lhs_f.rewind
+			lhs_f.close
+
+
+			rhs_eq_f = Tempfile.new('compare_binary-3')
+
+			begin
+
+				rhs_eq_f << 'abcdefghijiklmno'
+
+				rhs_eq_f.rewind
+				rhs_eq_f.close
+
+
+				assert compare_binary(lhs_f.path, rhs_eq_f.path), 'streams should be the same'
+			ensure
+
+				rhs_eq_f.unlink
+			end
+
+
+			rhs_ne_f = Tempfile.new('compare_binary-3')
+
+			begin
+
+				rhs_ne_f << 'xyz'
+
+				rhs_ne_f.rewind
+				rhs_ne_f.close
+
+
+				assert_false compare_binary(lhs_f.path, rhs_ne_f.path), 'streams should not be the same'
+			ensure
+
+				rhs_ne_f.unlink
+			end
+
+		ensure
+
+			lhs_f.unlink
+		end
+	end
+end
+
+# ############################## end of file ############################# #
+
+

data/test/unit/tc_compare_text.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../lib')
+
+require 'cmpfs'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+require 'stringio'
+require 'tempfile'
+
+class Test_CmpFS_compare_text < Test::Unit::TestCase
+
+	include ::CmpFS
+
+	def test_compare_text_identical_1
+
+		lhs		=	StringIO.new
+		rhs_eq	=	StringIO.new
+
+		lhs << "line-1\n"
+		rhs_eq << "line-1\n"
+
+		lhs << "line-2\n"
+		rhs_eq << "line-2\n"
+
+		assert compare_text(lhs, rhs_eq), 'streams should be the same'
+
+		rhs_ne	=	StringIO.new
+
+		rhs_ne << "line-1\n"
+		rhs_ne << "line2\n"
+
+		assert_false compare_text(lhs, rhs_ne), 'streams should not be the same'
+	end
+
+	def test_compare_text_same_with_blank_lines_1
+
+		lhs		=	StringIO.new
+		rhs_eq	=	StringIO.new
+
+		lhs << "line-1\n"
+		lhs << "\n"
+		rhs_eq << "line-1\n"
+
+		lhs << " line-2\n"
+		rhs_eq << "line-2\n"
+
+		assert_false compare_text(lhs, rhs_eq), 'streams should not be the same'
+		assert compare_text(lhs, rhs_eq, trim_lines: true, skip_blank_lines: true), 'streams should be the same'
+
+		rhs_ne	=	StringIO.new
+
+		rhs_ne << "line-1\n"
+		rhs_ne << "line2\n"
+
+		assert_false compare_text(lhs, rhs_ne), 'streams should not be the same'
+	end
+
+end
+
+# ############################## end of file ############################# #
+
+

data/test/unit/tc_version.rb

@@ -0,0 +1,37 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../lib')
+
+require 'cmpfs/version'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+class Test_version < Test::Unit::TestCase
+
+	def test_has_VERSION
+
+		assert defined? CmpFS::VERSION
+	end
+
+	def test_has_VERSION_MAJOR
+
+		assert defined? CmpFS::VERSION_MAJOR
+	end
+
+	def test_has_VERSION_MINOR
+
+		assert defined? CmpFS::VERSION_MINOR
+	end
+
+	def test_has_VERSION_REVISION
+
+		assert defined? CmpFS::VERSION_REVISION
+	end
+
+	def test_VERSION_has_consistent_format
+
+		assert_equal CmpFS::VERSION, "#{CmpFS::VERSION_MAJOR}.#{CmpFS::VERSION_MINOR}.#{CmpFS::VERSION_PATCH}"
+	end
+end
+

data/test/unit/ts_all.rb

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+#
+# executes all other tests
+
+this_dir	=	File.expand_path(File.dirname(__FILE__))
+
+# all tc_*rb in current directory
+Dir[File.join(this_dir, 'tc_*rb')].each { |file| require file }
+
+# all ts_*rb in immediate sub-directories
+Dir[File.join(this_dir, '*', 'ts_*rb')].each { |file| require file }
+

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: cmpfs-ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Matt Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xqsr3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.31'
+description: |
+  Compare File-System entities, for Ruby is a library that provides comparison
+  functions for file-system entities - files and streams - including binary and
+  filtering textual comparisons.
+email: matthew@synesis.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cmpfs/compare/api_1_9.rb
+- lib/cmpfs/compare/api_2.rb
+- lib/cmpfs/compare/binary/internal_.rb
+- lib/cmpfs/compare/text/internal_.rb
+- lib/cmpfs/compare.rb
+- lib/cmpfs/version.rb
+- lib/cmpfs.rb
+- test/unit/compare/tc_compare_binary.rb
+- test/unit/compare/ts_all.rb
+- test/unit/tc_compare_binary.rb
+- test/unit/tc_compare_text.rb
+- test/unit/tc_version.rb
+- test/unit/ts_all.rb
+- README.md
+- LICENSE
+homepage: http://github.com/synesissoftware/cmpfs.Ruby
+licenses:
+- BSD 3-Clause
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: CmpFS.Ruby
+test_files: []