cmpfs-ruby 0.2.0 → 0.2.1.2

data/lib/cmpfs/compare.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         cmpfs/version.rb
+# File:     cmpfs/version.rb
 #
-# Purpose:      Version for cmpfs.Ruby library
+# Purpose:  Version for cmpfs.Ruby library
 #
-# Created:      1st March 2019
-# Updated:      13th March 2019
+# Created:  1st March 2019
+# Updated:  1st April 2024
 #
-# Home:         http://github.com/synesissoftware/cmpfs.Ruby
+# Home:     http://github.com/synesissoftware/cmpfs.Ruby
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -46,12 +47,13 @@
 
 if RUBY_VERSION >= '2'
 
-	require 'cmpfs/compare/api_2'
+  require 'cmpfs/compare/api_2'
 else
 
-	require 'cmpfs/compare/api_1_9'
+  require 'cmpfs/compare/api_1_9'
 end
 
+
 =begin
 =end
 
@@ -73,32 +75,32 @@ module CmpFS
 #
 module Compare
 
-	def self.extended receiver
+  def self.extended receiver
 
-		receiver.class_eval do
+    receiver.class_eval do
 
-			extend CmpFS_Compare_Methods
-		end
+      extend CmpFS_Compare_Methods
+    end
 
-		$stderr.puts "#{receiver} extended by #{CmpFS_Compare_Methods}" if $DEBUG
-	end
+    $stderr.puts "#{receiver} extended by #{CmpFS_Compare_Methods}" if $DEBUG
+  end
 
-	def self.included receiver
+  def self.included receiver
 
-		receiver.class_eval do
+    receiver.class_eval do
 
-			include CmpFS_Compare_Methods
-		end
+      include CmpFS_Compare_Methods
+    end
 
-		$stderr.puts "#{receiver} included #{CmpFS_Compare_Methods}" if $DEBUG
-	end
+    $stderr.puts "#{receiver} included #{CmpFS_Compare_Methods}" if $DEBUG
+  end
 
-	extend CmpFS_Compare_Methods
-	include CmpFS_Compare_Methods
+  extend CmpFS_Compare_Methods
+  include CmpFS_Compare_Methods
 
 end # module Compare
 end # module CmpFS
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/cmpfs/version.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         cmpfs/version.rb
+# File:     cmpfs/version.rb
 #
-# Purpose:      Version for cmpfs.Ruby library
+# Purpose:  Version for cmpfs.Ruby library
 #
-# Created:      1st March 2019
-# Updated:      13th March 2019
+# Created:  1st March 2019
+# Updated:  2nd April 2024
 #
-# Home:         http://github.com/synesissoftware/cmpfs.Ruby
+# Home:     http://github.com/synesissoftware/cmpfs.Ruby
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -49,23 +50,23 @@
 
 module CmpFS
 
-	# Current version of the cmpfs.Ruby library
-	VERSION				=	'0.2.0'
+  # Current version of the cmpfs.Ruby library
+  VERSION           = '0.2.1.2'
 
-	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:
+  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:
+  VERSION_REVISION  = VERSION_PATCH # :nodoc:
 
 end # module CmpFS
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/cmpfs.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         cmpfs.rb
+# File:     cmpfs.rb
 #
-# Purpose:      Primary require for cmpfs.Ruby library
+# Purpose:  Primary require for cmpfs.Ruby library
 #
-# Created:      1st March 2019
-# Updated:      13th March 2019
+# Created:  1st March 2019
+# Updated:  2nd April 2024
 #
-# Home:         http://github.com/synesissoftware/cmpfs.Ruby
+# Home:     http://github.com/synesissoftware/cmpfs.Ruby
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -53,25 +54,28 @@ require 'cmpfs/version'
 ## Root module for *cmpfs*
 module CmpFS
 
-	def self.extended receiver
+  def self.extended receiver
 
-		receiver.class_eval do
+    receiver.class_eval do
 
-			extend CmpFS::Compare
-		end
+      extend CmpFS::Compare
+    end
 
-		$stderr.puts "#{receiver} extended by #{CmpFS}" if $DEBUG
-	end
+    $stderr.puts "#{receiver} extended by #{CmpFS}" if $DEBUG
+  end
 
-	def self.included receiver
+  def self.included receiver
 
-		receiver.class_eval do
+    receiver.class_eval do
 
-			include CmpFS::Compare
-		end
+      include CmpFS::Compare
+    end
 
-		$stderr.puts "#{receiver} included #{CmpFS}" if $DEBUG
-	end
+    $stderr.puts "#{receiver} included #{CmpFS}" if $DEBUG
+  end
 
 end # module CmpFS
 
+
+# ############################## end of file ############################# #
+

data/test/unit/compare/tc_compare_binary.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 
@@ -10,94 +10,95 @@ require 'test/unit'
 require 'stringio'
 require 'tempfile'
 
+
 class Test_CmpFS_Compare_compare_binary < Test::Unit::TestCase
 
-	def test_compare_binary_identical_1
+  def test__compare_binary__identical_1
 
-		lhs		=	StringIO.new 'abcdefghijiklmno'
-		rhs_eq	=	StringIO.new 'abcdefghijiklmno'
+    lhs     = StringIO.new 'abcdefghijiklmno'
+    rhs_eq  = StringIO.new 'abcdefghijiklmno'
 
-		assert CmpFS::Compare.compare_binary(lhs, rhs_eq), 'streams should be the same'
+    assert CmpFS::Compare.compare_binary(lhs, rhs_eq), 'streams should be the same'
 
-		rhs_ne	=	StringIO.new 'abcdefghijiklmn'
+    rhs_ne  = StringIO.new 'abcdefghijiklmn'
 
-		assert_false CmpFS::Compare.compare_binary(lhs, rhs_ne), 'streams should not be the same'
-	end
+    assert_false CmpFS::Compare.compare_binary(lhs, rhs_ne), 'streams should not be the same'
+  end
 
-	def test_compare_binary_identical_2
+  def test__compare_binary__identical_2
 
-		lhs_f = Tempfile.new('compare_binary-2')
+    lhs_f = Tempfile.new('compare_binary-2')
 
-		begin
+    begin
 
-			lhs_f << 'abcdefghijiklmno'
+      lhs_f << 'abcdefghijiklmno'
 
-			lhs_f.rewind
-			lhs_f.close
+      lhs_f.rewind
+      lhs_f.close
 
-			rhs_eq	=	StringIO.new 'abcdefghijiklmno'
+      rhs_eq  = StringIO.new 'abcdefghijiklmno'
 
-			assert CmpFS::Compare.compare_binary(lhs_f.path, rhs_eq), 'streams should be the same'
+      assert CmpFS::Compare.compare_binary(lhs_f.path, rhs_eq), 'streams should be the same'
 
-			rhs_ne	=	StringIO.new 'abcdefghijiklmnop'
+      rhs_ne  = StringIO.new 'abcdefghijiklmnop'
 
-			assert_false CmpFS::Compare.compare_binary(lhs_f.path, rhs_ne), 'streams should not be the same'
-		ensure
+      assert_false CmpFS::Compare.compare_binary(lhs_f.path, rhs_ne), 'streams should not be the same'
+    ensure
 
-			lhs_f.unlink
-		end
-	end
+      lhs_f.unlink
+    end
+  end
 
-	def test_compare_binary_identical_3
+  def test__compare_binary__identical_3
 
-		lhs_f = Tempfile.new('compare_binary-3')
+    lhs_f = Tempfile.new('compare_binary-3')
 
-		begin
+    begin
 
-			lhs_f << 'abcdefghijiklmno'
+      lhs_f << 'abcdefghijiklmno'
 
-			lhs_f.rewind
-			lhs_f.close
+      lhs_f.rewind
+      lhs_f.close
 
 
-			rhs_eq_f = Tempfile.new('compare_binary-3')
+      rhs_eq_f = Tempfile.new('compare_binary-3')
 
-			begin
+      begin
 
-				rhs_eq_f << 'abcdefghijiklmno'
+        rhs_eq_f << 'abcdefghijiklmno'
 
-				rhs_eq_f.rewind
-				rhs_eq_f.close
+        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
+        assert CmpFS::Compare.compare_binary(lhs_f.path, rhs_eq_f.path), 'streams should be the same'
+      ensure
 
-				rhs_eq_f.unlink
-			end
+        rhs_eq_f.unlink
+      end
 
 
-			rhs_ne_f = Tempfile.new('compare_binary-3')
+      rhs_ne_f = Tempfile.new('compare_binary-3')
 
-			begin
+      begin
 
-				rhs_ne_f << 'xyz'
+        rhs_ne_f << 'xyz'
 
-				rhs_ne_f.rewind
-				rhs_ne_f.close
+        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
+        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
+        rhs_ne_f.unlink
+      end
 
-		ensure
+    ensure
 
-			lhs_f.unlink
-		end
-	end
+      lhs_f.unlink
+    end
+  end
 end
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/test/unit/compare/ts_all.rb

@@ -2,7 +2,7 @@
 #
 # executes all other tests
 
-this_dir	=	File.expand_path(File.dirname(__FILE__))
+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 }

data/test/unit/tc_compare_binary.rb

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

data/test/unit/tc_compare_text.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../../lib')
 
@@ -10,56 +10,110 @@ require 'test/unit'
 require 'stringio'
 require 'tempfile'
 
+
 class Test_CmpFS_compare_text < Test::Unit::TestCase
 
-	include ::CmpFS
+  include ::CmpFS
+
+  def test__compare_text__empty
+
+    lhs     = StringIO.new
+    rhs_eq  = StringIO.new
+
+    assert compare_text(lhs, rhs_eq), 'streams should be the same'
+  end
+
+  def test__compare_text__blank_lines
+
+    lhs = StringIO.new <<END_OF_INPUT
+
+
+END_OF_INPUT
+    rhs_eq  = StringIO.new <<END_OF_INPUT
+
 
-	def test_compare_text_identical_1
+END_OF_INPUT
 
-		lhs		=	StringIO.new
-		rhs_eq	=	StringIO.new
+    assert compare_text(lhs, rhs_eq), 'streams should be the same'
+  end
 
-		lhs << "line-1\n"
-		rhs_eq << "line-1\n"
+  def test__compare_text__identical_lines_1
 
-		lhs << "line-2\n"
-		rhs_eq << "line-2\n"
+    lhs     = StringIO.new <<END_OF_INPUT
+line-1
+line-2
 
-		assert compare_text(lhs, rhs_eq), 'streams should be the same'
+END_OF_INPUT
+    rhs_eq  = StringIO.new <<END_OF_INPUT
+line-1
+line-2
 
-		rhs_ne	=	StringIO.new
+END_OF_INPUT
 
-		rhs_ne << "line-1\n"
-		rhs_ne << "line2\n"
+    assert compare_text(lhs, rhs_eq), 'streams should be the same'
+  end
 
-		assert_false compare_text(lhs, rhs_ne), 'streams should not be the same'
-	end
+  def test__compare_text__different_lines_1
 
-	def test_compare_text_same_with_blank_lines_1
+    lhs     = StringIO.new <<END_OF_INPUT
+line-1
+line-2
 
-		lhs		=	StringIO.new
-		rhs_eq	=	StringIO.new
+END_OF_INPUT
+    rhs_ne  = StringIO.new <<END_OF_INPUT
+line-1
+line2
 
-		lhs << "line-1\n"
-		lhs << "\n"
-		rhs_eq << "line-1\n"
+END_OF_INPUT
 
-		lhs << " line-2\n"
-		rhs_eq << "line-2\n"
+    assert_false compare_text(lhs, rhs_ne), 'streams should not be the same'
+  end
 
-		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'
+  def test__compare_text__different_lines_2
 
-		rhs_ne	=	StringIO.new
+    lhs     = StringIO.new <<END_OF_INPUT
+line-1
 
-		rhs_ne << "line-1\n"
-		rhs_ne << "line2\n"
+line-2
+END_OF_INPUT
+    rhs_ne  = StringIO.new <<END_OF_INPUT
+line-1
+line-2
 
-		assert_false compare_text(lhs, rhs_ne), 'streams should not be the same'
-	end
+END_OF_INPUT
 
+    assert_false compare_text(lhs, rhs_ne), 'streams should not be the same'
+  end
+
+  def test__compare_text__different_streams_with_permutations_of_trim_and_skip_1
+
+    lhs     = StringIO.new <<END_OF_INPUT
+line-1
+
+  line-2
+END_OF_INPUT
+    rhs_eq  = StringIO.new <<END_OF_INPUT
+line-1
+line-2
+END_OF_INPUT
+
+    assert_false compare_text(lhs, rhs_eq), 'streams should not be the same'
+    assert_false compare_text(lhs, rhs_eq, trim_lines: false, skip_blank_lines: true), 'streams should not be the same'
+    assert_false compare_text(lhs, rhs_eq, trim_lines: true, skip_blank_lines: false), '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 <<END_OF_INPUT
+line-1
+line2
+END_OF_INPUT
+
+    assert_false compare_text(lhs, rhs_ne), 'streams should not be the same'
+    assert_false compare_text(lhs, rhs_ne, trim_lines: false, skip_blank_lines: true), 'streams should not be the same'
+    assert_false compare_text(lhs, rhs_ne, trim_lines: true, skip_blank_lines: false), 'streams should not be the same'
+    assert_false compare_text(lhs, rhs_ne, trim_lines: true, skip_blank_lines: true), 'streams should not be the same'
+  end
 end
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #