cmpfs-ruby 0.2.0 → 0.2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a5d807fbdecc4dcd49ac7cdda8b3de14cfa1249
-  data.tar.gz: 19ad4d748a6811d1dca9a4974ec4962fbf7477a1
+SHA256:
+  metadata.gz: 46fb5f08ba76dfb2e7850d848f46c57016635721b445974b280a8247d7d93ac0
+  data.tar.gz: 60baeea6023c1d8178ecfc5c54b3f8ab8fe9e2b562773785b5453c2a868d560a
 SHA512:
-  metadata.gz: b8764ee5e224d4be12e69e73086bb576aa211e6cf02d4c98a230e46c75e98c37ca4bdafb739ca07ffa43d3756633650c5a79833774a284d2d8632be64e0355ad
-  data.tar.gz: 8bddd4fa549ed5c977c0fbeb4d564be20fc394be832ad37c0c2c9e2226cb8df04cbdf35742c7f75a48751ffbd365b7d65e0d8bfc0947b0c23367d0e4745256d8
+  metadata.gz: ed2d57ba6d485a995ef08244373e7518a2212fff1560cc23be8809100200a83759c37416c4e9a37e5dc878ad5facf58d99b1baef9221d350ecf828b8b6711151
+  data.tar.gz: e9b77bf3cb58c210afbc64db805a2a7898a0fd8507a8f2e470df66cdbdd58c5799c8ec68bd0e23f832d30d5e16ff030ea81965e958804b35d1e2eec1efab6ee7

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,29 +1,144 @@
-# 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
 
-1. [Introduction](#introduction)
-2. [Installation](#installation)
-3. [Components](#components)
-4. [Examples](#examples)
-5. [Project Information](#project-information)
+## Table of Contents <!-- omit in toc -->
+
+- [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
 
 Install using `gem install cmpfs-ruby` or add it to your `Gemfile`.
 
+
 ## Components
 
-T.B.C.
+The primary components provided are the 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()`
+
+all of which are obtained when `extend`ing or `include`ing the `CmpFS` module.
+
 
 ## Examples
 
-T.B.C.
+**examples/compare_two_binary_files.rb**:
+```Ruby
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+
+require 'cmpfs'
+
+
+include CmpFS
+
+
+# command-line handling
+
+lhs_path, rhs_path =
+case ARGV.size
+when 0, 1
+
+  if '--help' == ARGV[0]
+
+    $stdout.puts "#$0: <lhs-path> <rhs-path>"
+
+    exit 0
+  end
+
+  abort "#$0: not enough arguments; use --help for usage"
+when 2
+
+  ARGV[0..2]
+else
+
+  abort "#$0: too many arguments; use --help for usage"
+end
+
+
+# main()
+
+
+$stdout.puts "binary comparison of '#{lhs_path}' with '#{rhs_path}':"
+
+$stdout.puts "files are #{compare_binary(lhs_path, rhs_path) ? '' : 'not '}equal"
+
+
+# ############################## end of file ############################# #
+```
+
+**examples/compare_two_text_files.rb**:
+```Ruby
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+
+require 'cmpfs'
+
+
+include CmpFS
+
+
+# command-line handling
+
+lhs_path, rhs_path =
+case ARGV.size
+when 0, 1
+
+  if '--help' == ARGV[0]
+
+    $stdout.puts "#$0: <lhs-path> <rhs-path>"
+
+    exit 0
+  end
+
+  abort "#$0: not enough arguments; use --help for usage"
+when 2
+
+  ARGV[0..2]
+else
+
+  abort "#$0: too many arguments; use --help for usage"
+end
+
+
+# main()
+
+
+$stdout.puts "text comparison of '#{lhs_path}' with '#{rhs_path}':"
+
+$stdout.puts "files are #{compare_text(lhs_path, rhs_path, skip_blank_lines: true, trim_lines: true) ? '' : 'not '}equal"
+
+
+# ############################## end of file ############################# #
+```
+
 
 ## Project Information
 
@@ -31,17 +146,24 @@ T.B.C.
 
 [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.
+**cmpfs.Ruby** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
+
+
+<!-- ########################### end of file ########################### -->
 

data/examples/compare_two_binary_files.rb

@@ -0,0 +1,44 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+
+require 'cmpfs'
+
+
+include CmpFS
+
+
+# command-line handling
+
+lhs_path, rhs_path =
+case ARGV.size
+when 0, 1
+
+  if '--help' == ARGV[0]
+
+    $stdout.puts "#$0: <lhs-path> <rhs-path>"
+
+    exit 0
+  end
+
+  abort "#$0: not enough arguments; use --help for usage"
+when 2
+
+  ARGV[0..2]
+else
+
+  abort "#$0: too many arguments; use --help for usage"
+end
+
+
+# main()
+
+
+$stdout.puts "binary comparison of '#{lhs_path}' with '#{rhs_path}':"
+
+$stdout.puts "files are #{compare_binary(lhs_path, rhs_path) ? '' : 'not '}equal"
+
+
+# ############################## end of file ############################# #
+

data/examples/compare_two_text_files.rb

@@ -0,0 +1,44 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+
+require 'cmpfs'
+
+
+include CmpFS
+
+
+# command-line handling
+
+lhs_path, rhs_path =
+case ARGV.size
+when 0, 1
+
+  if '--help' == ARGV[0]
+
+    $stdout.puts "#$0: <lhs-path> <rhs-path>"
+
+    exit 0
+  end
+
+  abort "#$0: not enough arguments; use --help for usage"
+when 2
+
+  ARGV[0..2]
+else
+
+  abort "#$0: too many arguments; use --help for usage"
+end
+
+
+# main()
+
+
+$stdout.puts "text comparison of '#{lhs_path}' with '#{rhs_path}':"
+
+$stdout.puts "files are #{compare_text(lhs_path, rhs_path, skip_blank_lines: true, trim_lines: true) ? '' : 'not '}equal"
+
+
+# ############################## end of file ############################# #
+

data/lib/cmpfs/compare/api_1_9.rb

@@ -1,139 +1,161 @@
 
 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
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +lhs_path+:: (+String+) The name of a file
+  #   - +rhs_path+:: (+String+) The name of a file
+  #   - +options+:: (+Hash+) Options that control the behaviour of the method
+  #
+  # * *Options:*
+  #
+  # === Return
+  # +true+ if the files have exactly the same content; +false+ otherwise.
+  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
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +lhs_stm+:: (stream) A stream object
+  #   - +rhs_stm+:: (stream) A stream object
+  #   - +options+:: (+Hash+) Options that control the behaviour of the method
+  #
+  # * *Options:*
+  #   - +:no_rewind+:: (boolean) Prevents the default behaviour of rewinding each stream before processing
+  #
+  # === Return
+  # +true+ if the streams have exactly the same content; +false+ otherwise.
+  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
+  #
+  # * *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 that control the behaviour of the method
+  #
+  # * *Options:*
+  #   - +:no_rewind+:: (boolean) Prevents the default behaviour of rewinding each stream before processing
+  #
+  # === 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 that control the behaviour of the method
+  #
+  # * *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 that control the behaviour of the method
+  #
+  # * *Options:*
+  #   - +:no_rewind+:: (boolean) Prevents the default behaviour of rewinding each 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 that control the behaviour of the method
+  #
+  # * *Options:*
+  #   - +:no_rewind+:: (boolean) Prevents the default behaviour of rewinding each 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 ############################# #