cmpfs.Ruby

Compare File-System entities, for Ruby

• Introduction
• Installation
• Components
• Examples
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
    • Efferent (fan-out)
      • Runtime Dependencies (aka "Normal Dependencies")
      • Development Dependencies
    • Afferent (fan-in)
      • Runtime dependents
      • Development dependents
  • Related projects
  • License

cmpfs.Ruby provides platform-independent facilities for comparing file contents, for both binary and text files.

It has no dependencies on any other non-standard library.

Install via gem as in:

gem install cmpfs-ruby

or add it to your Gemfile.

Use via require, as in:

require 'cmpfs'

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 extending or includeing the CmpFS module.

Examples are provided in the examples directory, along with a markdown description for each. A detailed list TOC of them is provided in EXAMPLES.md.

examples/compare_two_binary_files.rb:

#! /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:

#! /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 ############################# #

GitHub Page

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/cmpfs.Ruby.

Libraries upon which cmpfs.Ruby depends:

• <none>;

• rake;
• test-unit;
• xqsr3;

Projects that depend on cmpfs.Ruby:

• <none>;

• <none>;

• C/C++ cmpfs — same product idea (binary/text file and stream comparison); recovery into freelibs is planned beside this gem (not yet published as a sibling tree here);

cmpfs.Ruby is released under the 3-clause BSD license. See LICENSE for details.