cmpfs-ruby 0.2.0 → 0.2.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 7a5d807fbdecc4dcd49ac7cdda8b3de14cfa1249
4
- data.tar.gz: 19ad4d748a6811d1dca9a4974ec4962fbf7477a1
2
+ SHA256:
3
+ metadata.gz: 62764eb741e0f301f90321e85c93b0dce924c67194106b0bd1303bf6aa546783
4
+ data.tar.gz: 5959477f700c9a53c720bb5576a09efaf86cce525e10b5523d043fc72c75918d
5
5
  SHA512:
6
- metadata.gz: b8764ee5e224d4be12e69e73086bb576aa211e6cf02d4c98a230e46c75e98c37ca4bdafb739ca07ffa43d3756633650c5a79833774a284d2d8632be64e0355ad
7
- data.tar.gz: 8bddd4fa549ed5c977c0fbeb4d564be20fc394be832ad37c0c2c9e2226cb8df04cbdf35742c7f75a48751ffbd365b7d65e0d8bfc0947b0c23367d0e4745256d8
6
+ metadata.gz: 0a07bfafb304a4a1ae80c144ff232b88617c34e6b8392457fd1b7454dbec32be79da00d03f137ec7e2cf089399876fd185a5b0aac31a1fb94131934b60b37498
7
+ data.tar.gz: 3e7e33b928703d0c48a2c41d3c765be2dcfd7c77bc8278bea466e9f39e1e76e8e7cd66f6a27083523d547f7d0021c72dee731aa4f0b7658ee7dcf2fa3029d1b5
data/LICENSE CHANGED
@@ -1,31 +1,32 @@
1
1
  cmpfs.Ruby
2
2
 
3
+ Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
3
4
  Copyright (c) 2019, Matthew Wilson and Synesis Software
4
5
  All rights reserved.
5
6
 
6
7
  Redistribution and use in source and binary forms, with or without
7
8
  modification, are permitted provided that the following conditions are met:
8
9
 
9
- * Redistributions of source code must retain the above copyright notice, this
10
- list of conditions and the following disclaimer.
10
+ * Redistributions of source code must retain the above copyright notice,
11
+ this list of conditions and the following disclaimer.
11
12
 
12
13
  * Redistributions in binary form must reproduce the above copyright notice,
13
14
  this list of conditions and the following disclaimer in the documentation
14
15
  and/or other materials provided with the distribution.
15
16
 
16
- * Neither the names of cmpfs or cmpfs.Ruby nor the names of the copyright
17
- holder nor the names of its contributors may be used to endorse or promote
18
- products derived from this software without specific prior written
19
- permission.
17
+ * Neither the names of cmpfs or cmpfs.Ruby nor the names of its contributors
18
+ or its copyright holders may be used to endorse or promote products
19
+ derived from this software without specific prior written permission.
20
20
 
21
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
22
- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25
- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26
- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27
- SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
21
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25
+ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28
+ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31
+ POSSIBILITY OF SUCH DAMAGE.
31
32
 
data/README.md CHANGED
@@ -1,17 +1,25 @@
1
- # cmpfs.Ruby
1
+ # cmpfs.Ruby <!-- omit in toc -->
2
+
2
3
  **Com**pare **F**ile-**S**ystem entities, for **Ruby**
3
4
 
5
+ [![Gem Version](https://badge.fury.io/rb/cmpfs-ruby.svg)](https://badge.fury.io/rb/cmpfs-ruby)
6
+
4
7
  ## Introduction
5
8
 
6
- T.B.C.
9
+ Provides platform-independent facilities for comparing file contents, for both binary and text files
7
10
 
8
- ## Table of Contents
11
+ ## Table of Contents <!-- omit in toc -->
9
12
 
10
- 1. [Introduction](#introduction)
11
- 2. [Installation](#installation)
12
- 3. [Components](#components)
13
- 4. [Examples](#examples)
14
- 5. [Project Information](#project-information)
13
+ - [Introduction](#introduction)
14
+ - [Installation](#installation)
15
+ - [Components](#components)
16
+ - [Examples](#examples)
17
+ - [Project Information](#project-information)
18
+ - [Where to get help](#where-to-get-help)
19
+ - [Contribution guidelines](#contribution-guidelines)
20
+ - [Dependencies](#dependencies)
21
+ - [Related projects](#related-projects)
22
+ - [License](#license)
15
23
 
16
24
  ## Installation
17
25
 
@@ -43,5 +51,8 @@ T.B.C.
43
51
 
44
52
  ### License
45
53
 
46
- **cmpfs.Gp** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
54
+ **cmpfs.Ruby** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
55
+
56
+
57
+ <!-- ########################### end of file ########################### -->
47
58
 
@@ -1,139 +1,140 @@
1
1
 
2
2
  if RUBY_VERSION >= '2'
3
3
 
4
- abort "This file required Ruby 1+: RUBY_VERSION='#{RUBY_VERSION}'"
4
+ abort "This file required Ruby 1+: RUBY_VERSION='#{RUBY_VERSION}'"
5
5
  end
6
6
 
7
7
  require 'cmpfs/compare/binary/internal_'
8
8
  require 'cmpfs/compare/text/internal_'
9
9
 
10
+
10
11
  module CmpFS
11
12
  module Compare
12
13
 
13
14
  module CmpFS_Compare_Methods
14
15
 
15
- # Compares two files, named by +lhs_path+ and +rhs_path+, in a binary
16
- # (exact) manner
17
- def compare_binary_files lhs_path, rhs_path, options = {}
18
-
19
- options ||= {}
20
-
21
- ::CmpFS::Compare::Binary::Internal_.compare_binary_files_ lhs_path, rhs_path, options
22
- end
23
-
24
- # Compares two streams, +lhs_stm+ and +rhs_stm+, in a binary
25
- # (exact) manner
26
- def compare_binary_streams lhs_stm, rhs_stm, options = {}
27
-
28
- options ||= {}
29
-
30
- ::CmpFS::Compare::Binary::Internal_.compare_binary_streams_ lhs_stm, rhs_stm, options
31
- end
32
-
33
- # Compares two files/streams in a binary (exact) manner
34
- #
35
- # == Signature
36
- #
37
- # == Return
38
- #
39
- # +true+ if the files/streams have exactly the same content; +false+
40
- # otherwise.
41
- def compare_binary lhs, rhs, options = {}
42
-
43
- options ||= {}
44
-
45
- ::CmpFS::Compare::Binary::Internal_.compare_binary_ lhs, rhs, options
46
- end
47
-
48
-
49
- # Compares two files, named by +lhs_path+ and +rhs_path+, in a textual
50
- # manner according to the given +options+
51
- #
52
- # === Signature
53
- #
54
- # * *Parameters:*
55
- # - +lhs_path+:: (String) The name of a file
56
- # - +rhs_path+:: (String) The name of a file
57
- # - +options+:: (Hash) Options
58
- #
59
- # * *Options:*
60
- # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
61
- # should be skipped from the comparison
62
- # - +:trim_lines+:: (boolean) Determines whether lines should be
63
- # trimmed of leading and trailing space (including EOL sequence)
64
- #
65
- # === Return
66
- #
67
- # +true+ if the files/streams have exactly the same content; +false+
68
- # otherwise.
69
- def compare_text_files lhs_path, rhs_path, options = {}
70
-
71
- options |= {}
72
-
73
- ::CmpFS::Compare::Text::Internal_.compare_text_files_ lhs_path, rhs_path, options
74
- end
75
-
76
- # Compares two streams, named by +lhs_stm+ and +rhs_stm+, in a textual
77
- # manner according to the given +options+
78
- #
79
- # === Signature
80
- #
81
- # * *Parameters:*
82
- # - +lhs_stm+:: (stream) A stream object
83
- # - +rhs_stm+:: (stream) A stream object
84
- # - +options+:: (Hash) Options
85
- #
86
- # * *Options:*
87
- # - +:no_rewind+:: (boolean) Prevents the default behaviour of
88
- # rewinding the stream before processing
89
- # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
90
- # should be skipped from the comparison
91
- # - +:trim_lines+:: (boolean) Determines whether lines should be
92
- # trimmed of leading and trailing space (including EOL sequence)
93
- #
94
- # === Return
95
- #
96
- # +true+ if the files/streams have exactly the same content; +false+
97
- # otherwise.
98
- def compare_text_streams lhs_stm, rhs_stm, options = {}
99
-
100
- options ||= {}
101
-
102
- ::CmpFS::Compare::Text::Internal_.compare_text_streams_ lhs_stm, rhs_stm, options
103
- end
104
-
105
- # Compares two files/streams, named by +lhs+ and +rhs+, in a textual
106
- # manner according to the given +options+
107
- #
108
- # === Signature
109
- #
110
- # * *Parameters:*
111
- # - +lhs+:: (String, stream) The name of a file, or a stream object
112
- # - +rhs+:: (String, stream) The name of a file, or a stream object
113
- # - +options+:: (Hash) Options
114
- #
115
- # * *Options:*
116
- # - +:no_rewind+:: (boolean) Prevents the default behaviour of
117
- # rewinding the stream before processing
118
- # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
119
- # should be skipped from the comparison
120
- # - +:trim_lines+:: (boolean) Determines whether lines should be
121
- # trimmed of leading and trailing space (including EOL sequence)
122
- #
123
- # === Return
124
- #
125
- # +true+ if the files/streams have exactly the same content; +false+
126
- # otherwise.
127
- def compare_text lhs, rhs, options = {}
128
-
129
- options ||= {}
130
-
131
- ::CmpFS::Compare::Text::Internal_.compare_text_ lhs, rhs, options
132
- end
16
+ # Compares two files, named by +lhs_path+ and +rhs_path+, in a binary
17
+ # (exact) manner
18
+ def compare_binary_files lhs_path, rhs_path, options = {}
19
+
20
+ options ||= {}
21
+
22
+ ::CmpFS::Compare::Binary::Internal_.compare_binary_files_ lhs_path, rhs_path, options
23
+ end
24
+
25
+ # Compares two streams, +lhs_stm+ and +rhs_stm+, in a binary
26
+ # (exact) manner
27
+ def compare_binary_streams lhs_stm, rhs_stm, options = {}
28
+
29
+ options ||= {}
30
+
31
+ ::CmpFS::Compare::Binary::Internal_.compare_binary_streams_ lhs_stm, rhs_stm, options
32
+ end
33
+
34
+ # Compares two files/streams in a binary (exact) manner
35
+ #
36
+ # == Signature
37
+ #
38
+ # == Return
39
+ #
40
+ # +true+ if the files/streams have exactly the same content; +false+
41
+ # otherwise.
42
+ def compare_binary lhs, rhs, options = {}
43
+
44
+ options ||= {}
45
+
46
+ ::CmpFS::Compare::Binary::Internal_.compare_binary_ lhs, rhs, options
47
+ end
48
+
49
+
50
+ # Compares two files, named by +lhs_path+ and +rhs_path+, in a textual
51
+ # manner according to the given +options+
52
+ #
53
+ # === Signature
54
+ #
55
+ # * *Parameters:*
56
+ # - +lhs_path+:: (String) The name of a file
57
+ # - +rhs_path+:: (String) The name of a file
58
+ # - +options+:: (Hash) Options
59
+ #
60
+ # * *Options:*
61
+ # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
62
+ # should be skipped from the comparison
63
+ # - +:trim_lines+:: (boolean) Determines whether lines should be
64
+ # trimmed of leading and trailing space (including EOL sequence)
65
+ #
66
+ # === Return
67
+ #
68
+ # +true+ if the files/streams have exactly the same content; +false+
69
+ # otherwise.
70
+ def compare_text_files lhs_path, rhs_path, options = {}
71
+
72
+ options |= {}
73
+
74
+ ::CmpFS::Compare::Text::Internal_.compare_text_files_ lhs_path, rhs_path, options
75
+ end
76
+
77
+ # Compares two streams, named by +lhs_stm+ and +rhs_stm+, in a textual
78
+ # manner according to the given +options+
79
+ #
80
+ # === Signature
81
+ #
82
+ # * *Parameters:*
83
+ # - +lhs_stm+:: (stream) A stream object
84
+ # - +rhs_stm+:: (stream) A stream object
85
+ # - +options+:: (Hash) Options
86
+ #
87
+ # * *Options:*
88
+ # - +:no_rewind+:: (boolean) Prevents the default behaviour of
89
+ # rewinding the stream before processing
90
+ # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
91
+ # should be skipped from the comparison
92
+ # - +:trim_lines+:: (boolean) Determines whether lines should be
93
+ # trimmed of leading and trailing space (including EOL sequence)
94
+ #
95
+ # === Return
96
+ #
97
+ # +true+ if the files/streams have exactly the same content; +false+
98
+ # otherwise.
99
+ def compare_text_streams lhs_stm, rhs_stm, options = {}
100
+
101
+ options ||= {}
102
+
103
+ ::CmpFS::Compare::Text::Internal_.compare_text_streams_ lhs_stm, rhs_stm, options
104
+ end
105
+
106
+ # Compares two files/streams, named by +lhs+ and +rhs+, in a textual
107
+ # manner according to the given +options+
108
+ #
109
+ # === Signature
110
+ #
111
+ # * *Parameters:*
112
+ # - +lhs+:: (String, stream) The name of a file, or a stream object
113
+ # - +rhs+:: (String, stream) The name of a file, or a stream object
114
+ # - +options+:: (Hash) Options
115
+ #
116
+ # * *Options:*
117
+ # - +:no_rewind+:: (boolean) Prevents the default behaviour of
118
+ # rewinding the stream before processing
119
+ # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
120
+ # should be skipped from the comparison
121
+ # - +:trim_lines+:: (boolean) Determines whether lines should be
122
+ # trimmed of leading and trailing space (including EOL sequence)
123
+ #
124
+ # === Return
125
+ #
126
+ # +true+ if the files/streams have exactly the same content; +false+
127
+ # otherwise.
128
+ def compare_text lhs, rhs, options = {}
129
+
130
+ options ||= {}
131
+
132
+ ::CmpFS::Compare::Text::Internal_.compare_text_ lhs, rhs, options
133
+ end
133
134
  end # module CmpFS_Compare_Methods
134
135
  end # module Compare
135
136
  end # module CmpFS
136
137
 
137
- # ############################## end of file ############################# #
138
138
 
139
+ # ############################## end of file ############################# #
139
140
 
@@ -1,127 +1,128 @@
1
1
 
2
2
  unless RUBY_VERSION >= '2'
3
3
 
4
- abort "This file required Ruby 2+: RUBY_VERSION='#{RUBY_VERSION}'"
4
+ abort "This file required Ruby 2+: RUBY_VERSION='#{RUBY_VERSION}'"
5
5
  end
6
6
 
7
7
  require 'cmpfs/compare/binary/internal_'
8
8
  require 'cmpfs/compare/text/internal_'
9
9
 
10
+
10
11
  module CmpFS
11
12
  module Compare
12
13
 
13
14
  module CmpFS_Compare_Methods
14
15
 
15
- # Compares two files, named by +lhs_path+ and +rhs_path+, in a binary
16
- # (exact) manner
17
- def compare_binary_files lhs_path, rhs_path, **options
18
-
19
- ::CmpFS::Compare::Binary::Internal_.compare_binary_files_ lhs_path, rhs_path, options
20
- end
21
-
22
- # Compares two streams, +lhs_stm+ and +rhs_stm+, in a binary
23
- # (exact) manner
24
- def compare_binary_streams lhs_stm, rhs_stm, **options
25
-
26
- ::CmpFS::Compare::Binary::Internal_.compare_binary_streams_ lhs_stm, rhs_stm, options
27
- end
28
-
29
- # Compares two files/streams in a binary (exact) manner
30
- #
31
- # == Signature
32
- #
33
- # == Return
34
- #
35
- # +true+ if the files/streams have exactly the same content; +false+
36
- # otherwise.
37
- def compare_binary lhs, rhs, **options
38
-
39
- ::CmpFS::Compare::Binary::Internal_.compare_binary_ lhs, rhs, options
40
- end
41
-
42
-
43
- # Compares two files, named by +lhs_path+ and +rhs_path+, in a textual
44
- # manner according to the given +options+
45
- #
46
- # === Signature
47
- #
48
- # * *Parameters:*
49
- # - +lhs_path+:: (String) The name of a file
50
- # - +rhs_path+:: (String) The name of a file
51
- # - +options+:: (Hash) Options
52
- #
53
- # * *Options:*
54
- # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
55
- # should be skipped from the comparison
56
- # - +:trim_lines+:: (boolean) Determines whether lines should be
57
- # trimmed of leading and trailing space (including EOL sequence)
58
- #
59
- # === Return
60
- #
61
- # +true+ if the files/streams have exactly the same content; +false+
62
- # otherwise.
63
- def compare_text_files lhs_path, rhs_path, **options
64
-
65
- ::CmpFS::Compare::Text::Internal_.compare_text_files_ lhs_path, rhs_path, options
66
- end
67
-
68
- # Compares two streams, named by +lhs_stm+ and +rhs_stm+, in a textual
69
- # manner according to the given +options+
70
- #
71
- # === Signature
72
- #
73
- # * *Parameters:*
74
- # - +lhs_stm+:: (stream) A stream object
75
- # - +rhs_stm+:: (stream) A stream object
76
- # - +options+:: (Hash) Options
77
- #
78
- # * *Options:*
79
- # - +:no_rewind+:: (boolean) Prevents the default behaviour of
80
- # rewinding the stream before processing
81
- # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
82
- # should be skipped from the comparison
83
- # - +:trim_lines+:: (boolean) Determines whether lines should be
84
- # trimmed of leading and trailing space (including EOL sequence)
85
- #
86
- # === Return
87
- #
88
- # +true+ if the files/streams have exactly the same content; +false+
89
- # otherwise.
90
- def compare_text_streams lhs_stm, rhs_stm, **options
91
-
92
- ::CmpFS::Compare::Text::Internal_.compare_text_streams_ lhs_stm, rhs_stm, options
93
- end
94
-
95
- # Compares two files/streams, named by +lhs+ and +rhs+, in a textual
96
- # manner according to the given +options+
97
- #
98
- # === Signature
99
- #
100
- # * *Parameters:*
101
- # - +lhs+:: (String, stream) The name of a file, or a stream object
102
- # - +rhs+:: (String, stream) The name of a file, or a stream object
103
- # - +options+:: (Hash) Options
104
- #
105
- # * *Options:*
106
- # - +:no_rewind+:: (boolean) Prevents the default behaviour of
107
- # rewinding the stream before processing
108
- # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
109
- # should be skipped from the comparison
110
- # - +:trim_lines+:: (boolean) Determines whether lines should be
111
- # trimmed of leading and trailing space (including EOL sequence)
112
- #
113
- # === Return
114
- #
115
- # +true+ if the files/streams have exactly the same content; +false+
116
- # otherwise.
117
- def compare_text lhs, rhs, **options
118
-
119
- ::CmpFS::Compare::Text::Internal_.compare_text_ lhs, rhs, options
120
- end
16
+ # Compares two files, named by +lhs_path+ and +rhs_path+, in a binary
17
+ # (exact) manner
18
+ def compare_binary_files lhs_path, rhs_path, **options
19
+
20
+ ::CmpFS::Compare::Binary::Internal_.compare_binary_files_ lhs_path, rhs_path, options
21
+ end
22
+
23
+ # Compares two streams, +lhs_stm+ and +rhs_stm+, in a binary
24
+ # (exact) manner
25
+ def compare_binary_streams lhs_stm, rhs_stm, **options
26
+
27
+ ::CmpFS::Compare::Binary::Internal_.compare_binary_streams_ lhs_stm, rhs_stm, options
28
+ end
29
+
30
+ # Compares two files/streams in a binary (exact) manner
31
+ #
32
+ # == Signature
33
+ #
34
+ # == Return
35
+ #
36
+ # +true+ if the files/streams have exactly the same content; +false+
37
+ # otherwise.
38
+ def compare_binary lhs, rhs, **options
39
+
40
+ ::CmpFS::Compare::Binary::Internal_.compare_binary_ lhs, rhs, options
41
+ end
42
+
43
+
44
+ # Compares two files, named by +lhs_path+ and +rhs_path+, in a textual
45
+ # manner according to the given +options+
46
+ #
47
+ # === Signature
48
+ #
49
+ # * *Parameters:*
50
+ # - +lhs_path+:: (String) The name of a file
51
+ # - +rhs_path+:: (String) The name of a file
52
+ # - +options+:: (Hash) Options
53
+ #
54
+ # * *Options:*
55
+ # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
56
+ # should be skipped from the comparison
57
+ # - +:trim_lines+:: (boolean) Determines whether lines should be
58
+ # trimmed of leading and trailing space (including EOL sequence)
59
+ #
60
+ # === Return
61
+ #
62
+ # +true+ if the files/streams have exactly the same content; +false+
63
+ # otherwise.
64
+ def compare_text_files lhs_path, rhs_path, **options
65
+
66
+ ::CmpFS::Compare::Text::Internal_.compare_text_files_ lhs_path, rhs_path, options
67
+ end
68
+
69
+ # Compares two streams, named by +lhs_stm+ and +rhs_stm+, in a textual
70
+ # manner according to the given +options+
71
+ #
72
+ # === Signature
73
+ #
74
+ # * *Parameters:*
75
+ # - +lhs_stm+:: (stream) A stream object
76
+ # - +rhs_stm+:: (stream) A stream object
77
+ # - +options+:: (Hash) Options
78
+ #
79
+ # * *Options:*
80
+ # - +:no_rewind+:: (boolean) Prevents the default behaviour of
81
+ # rewinding the stream before processing
82
+ # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
83
+ # should be skipped from the comparison
84
+ # - +:trim_lines+:: (boolean) Determines whether lines should be
85
+ # trimmed of leading and trailing space (including EOL sequence)
86
+ #
87
+ # === Return
88
+ #
89
+ # +true+ if the files/streams have exactly the same content; +false+
90
+ # otherwise.
91
+ def compare_text_streams lhs_stm, rhs_stm, **options
92
+
93
+ ::CmpFS::Compare::Text::Internal_.compare_text_streams_ lhs_stm, rhs_stm, options
94
+ end
95
+
96
+ # Compares two files/streams, named by +lhs+ and +rhs+, in a textual
97
+ # manner according to the given +options+
98
+ #
99
+ # === Signature
100
+ #
101
+ # * *Parameters:*
102
+ # - +lhs+:: (String, stream) The name of a file, or a stream object
103
+ # - +rhs+:: (String, stream) The name of a file, or a stream object
104
+ # - +options+:: (Hash) Options
105
+ #
106
+ # * *Options:*
107
+ # - +:no_rewind+:: (boolean) Prevents the default behaviour of
108
+ # rewinding the stream before processing
109
+ # - +:skip_blank_lines+:: (boolean) Determines whether blank lines
110
+ # should be skipped from the comparison
111
+ # - +:trim_lines+:: (boolean) Determines whether lines should be
112
+ # trimmed of leading and trailing space (including EOL sequence)
113
+ #
114
+ # === Return
115
+ #
116
+ # +true+ if the files/streams have exactly the same content; +false+
117
+ # otherwise.
118
+ def compare_text lhs, rhs, **options
119
+
120
+ ::CmpFS::Compare::Text::Internal_.compare_text_ lhs, rhs, options
121
+ end
121
122
  end # module CmpFS_Compare_Methods
122
123
  end # module Compare
123
124
  end # module CmpFS
124
125
 
125
- # ############################## end of file ############################# #
126
126
 
127
+ # ############################## end of file ############################# #
127
128