diff-lcs 1.3 → 1.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +518 -0
  3. data/CODE_OF_CONDUCT.md +128 -0
  4. data/CONTRIBUTING.md +71 -0
  5. data/CONTRIBUTORS.md +49 -0
  6. data/{License.md → LICENCE.md} +21 -20
  7. data/Manifest.txt +84 -6
  8. data/README.md +92 -0
  9. data/Rakefile +104 -46
  10. data/SECURITY.md +41 -0
  11. data/bin/htmldiff +9 -6
  12. data/bin/ldiff +4 -1
  13. data/docs/artistic.txt +1 -1
  14. data/lib/diff/lcs/array.rb +2 -2
  15. data/lib/diff/lcs/backports.rb +13 -0
  16. data/lib/diff/lcs/block.rb +5 -5
  17. data/lib/diff/lcs/callbacks.rb +22 -17
  18. data/lib/diff/lcs/change.rb +44 -51
  19. data/lib/diff/lcs/htmldiff.rb +25 -14
  20. data/lib/diff/lcs/hunk.rb +174 -71
  21. data/lib/diff/lcs/internals.rb +57 -56
  22. data/lib/diff/lcs/ldiff.rb +101 -79
  23. data/lib/diff/lcs/string.rb +1 -1
  24. data/lib/diff/lcs/version.rb +7 -0
  25. data/lib/diff/lcs.rb +229 -212
  26. data/lib/diff-lcs.rb +2 -2
  27. data/mise.toml +5 -0
  28. data/spec/change_spec.rb +58 -34
  29. data/spec/diff_spec.rb +13 -9
  30. data/spec/fixtures/123_x +2 -0
  31. data/spec/fixtures/456_x +2 -0
  32. data/spec/fixtures/aX +1 -0
  33. data/spec/fixtures/bXaX +1 -0
  34. data/spec/fixtures/empty +0 -0
  35. data/spec/fixtures/file1.bin +0 -0
  36. data/spec/fixtures/file2.bin +0 -0
  37. data/spec/fixtures/four_lines +4 -0
  38. data/spec/fixtures/four_lines_with_missing_new_line +4 -0
  39. data/spec/fixtures/ldiff/diff.missing_new_line1-e +1 -0
  40. data/spec/fixtures/ldiff/diff.missing_new_line1-f +1 -0
  41. data/spec/fixtures/ldiff/diff.missing_new_line2-e +1 -0
  42. data/spec/fixtures/ldiff/diff.missing_new_line2-f +1 -0
  43. data/spec/fixtures/ldiff/error.diff.chef-e +2 -0
  44. data/spec/fixtures/ldiff/error.diff.chef-f +2 -0
  45. data/spec/fixtures/ldiff/error.diff.missing_new_line1-e +1 -0
  46. data/spec/fixtures/ldiff/error.diff.missing_new_line1-f +1 -0
  47. data/spec/fixtures/ldiff/error.diff.missing_new_line2-e +1 -0
  48. data/spec/fixtures/ldiff/error.diff.missing_new_line2-f +1 -0
  49. data/spec/fixtures/ldiff/output.diff +4 -0
  50. data/spec/fixtures/ldiff/output.diff-c +7 -0
  51. data/spec/fixtures/ldiff/output.diff-e +3 -0
  52. data/spec/fixtures/ldiff/output.diff-f +3 -0
  53. data/spec/fixtures/ldiff/output.diff-u +5 -0
  54. data/spec/fixtures/ldiff/output.diff.bin1 +0 -0
  55. data/spec/fixtures/ldiff/output.diff.bin1-c +0 -0
  56. data/spec/fixtures/ldiff/output.diff.bin1-e +0 -0
  57. data/spec/fixtures/ldiff/output.diff.bin1-f +0 -0
  58. data/spec/fixtures/ldiff/output.diff.bin1-u +0 -0
  59. data/spec/fixtures/ldiff/output.diff.bin2 +1 -0
  60. data/spec/fixtures/ldiff/output.diff.bin2-c +1 -0
  61. data/spec/fixtures/ldiff/output.diff.bin2-e +1 -0
  62. data/spec/fixtures/ldiff/output.diff.bin2-f +1 -0
  63. data/spec/fixtures/ldiff/output.diff.bin2-u +1 -0
  64. data/spec/fixtures/ldiff/output.diff.chef +4 -0
  65. data/spec/fixtures/ldiff/output.diff.chef-c +15 -0
  66. data/spec/fixtures/ldiff/output.diff.chef-e +3 -0
  67. data/spec/fixtures/ldiff/output.diff.chef-f +3 -0
  68. data/spec/fixtures/ldiff/output.diff.chef-u +9 -0
  69. data/spec/fixtures/ldiff/output.diff.chef2 +7 -0
  70. data/spec/fixtures/ldiff/output.diff.chef2-c +20 -0
  71. data/spec/fixtures/ldiff/output.diff.chef2-d +7 -0
  72. data/spec/fixtures/ldiff/output.diff.chef2-e +7 -0
  73. data/spec/fixtures/ldiff/output.diff.chef2-f +7 -0
  74. data/spec/fixtures/ldiff/output.diff.chef2-u +16 -0
  75. data/spec/fixtures/ldiff/output.diff.empty.vs.four_lines +5 -0
  76. data/spec/fixtures/ldiff/output.diff.empty.vs.four_lines-c +9 -0
  77. data/spec/fixtures/ldiff/output.diff.empty.vs.four_lines-e +6 -0
  78. data/spec/fixtures/ldiff/output.diff.empty.vs.four_lines-f +6 -0
  79. data/spec/fixtures/ldiff/output.diff.empty.vs.four_lines-u +7 -0
  80. data/spec/fixtures/ldiff/output.diff.four_lines.vs.empty +5 -0
  81. data/spec/fixtures/ldiff/output.diff.four_lines.vs.empty-c +9 -0
  82. data/spec/fixtures/ldiff/output.diff.four_lines.vs.empty-e +1 -0
  83. data/spec/fixtures/ldiff/output.diff.four_lines.vs.empty-f +1 -0
  84. data/spec/fixtures/ldiff/output.diff.four_lines.vs.empty-u +7 -0
  85. data/spec/fixtures/ldiff/output.diff.issue95_trailing_context +4 -0
  86. data/spec/fixtures/ldiff/output.diff.issue95_trailing_context-c +9 -0
  87. data/spec/fixtures/ldiff/output.diff.issue95_trailing_context-e +3 -0
  88. data/spec/fixtures/ldiff/output.diff.issue95_trailing_context-f +3 -0
  89. data/spec/fixtures/ldiff/output.diff.issue95_trailing_context-u +6 -0
  90. data/spec/fixtures/ldiff/output.diff.missing_new_line1 +5 -0
  91. data/spec/fixtures/ldiff/output.diff.missing_new_line1-c +14 -0
  92. data/spec/fixtures/ldiff/output.diff.missing_new_line1-e +0 -0
  93. data/spec/fixtures/ldiff/output.diff.missing_new_line1-f +0 -0
  94. data/spec/fixtures/ldiff/output.diff.missing_new_line1-u +9 -0
  95. data/spec/fixtures/ldiff/output.diff.missing_new_line2 +5 -0
  96. data/spec/fixtures/ldiff/output.diff.missing_new_line2-c +14 -0
  97. data/spec/fixtures/ldiff/output.diff.missing_new_line2-e +0 -0
  98. data/spec/fixtures/ldiff/output.diff.missing_new_line2-f +0 -0
  99. data/spec/fixtures/ldiff/output.diff.missing_new_line2-u +9 -0
  100. data/spec/fixtures/new-chef +4 -0
  101. data/spec/fixtures/new-chef2 +17 -0
  102. data/spec/fixtures/old-chef +4 -0
  103. data/spec/fixtures/old-chef2 +14 -0
  104. data/spec/hunk_spec.rb +49 -38
  105. data/spec/issues_spec.rb +132 -21
  106. data/spec/lcs_spec.rb +3 -3
  107. data/spec/ldiff_spec.rb +83 -30
  108. data/spec/patch_spec.rb +14 -20
  109. data/spec/sdiff_spec.rb +83 -81
  110. data/spec/spec_helper.rb +220 -165
  111. data/spec/traverse_balanced_spec.rb +138 -136
  112. data/spec/traverse_sequences_spec.rb +7 -9
  113. metadata +127 -77
  114. data/Code-of-Conduct.md +0 -74
  115. data/Contributing.md +0 -83
  116. data/History.md +0 -220
  117. data/README.rdoc +0 -84
  118. data/autotest/discover.rb +0 -1
metadata CHANGED
@@ -1,57 +1,42 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: diff-lcs
3
3
  version: !ruby/object:Gem::Version
4
- version: '1.3'
4
+ version: 1.6.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Austin Ziegler
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2017-01-18 00:00:00.000000000 Z
10
+ date: 2025-05-12 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
- name: hoe-doofus
15
- requirement: !ruby/object:Gem::Requirement
16
- requirements:
17
- - - "~>"
18
- - !ruby/object:Gem::Version
19
- version: '1.0'
20
- type: :development
21
- prerelease: false
22
- version_requirements: !ruby/object:Gem::Requirement
23
- requirements:
24
- - - "~>"
25
- - !ruby/object:Gem::Version
26
- version: '1.0'
27
- - !ruby/object:Gem::Dependency
28
- name: hoe-gemspec2
13
+ name: hoe
29
14
  requirement: !ruby/object:Gem::Requirement
30
15
  requirements:
31
16
  - - "~>"
32
17
  - !ruby/object:Gem::Version
33
- version: '1.1'
18
+ version: '4.0'
34
19
  type: :development
35
20
  prerelease: false
36
21
  version_requirements: !ruby/object:Gem::Requirement
37
22
  requirements:
38
23
  - - "~>"
39
24
  - !ruby/object:Gem::Version
40
- version: '1.1'
25
+ version: '4.0'
41
26
  - !ruby/object:Gem::Dependency
42
- name: hoe-git
27
+ name: hoe-halostatue
43
28
  requirement: !ruby/object:Gem::Requirement
44
29
  requirements:
45
30
  - - "~>"
46
31
  - !ruby/object:Gem::Version
47
- version: '1.6'
32
+ version: '2.0'
48
33
  type: :development
49
34
  prerelease: false
50
35
  version_requirements: !ruby/object:Gem::Requirement
51
36
  requirements:
52
37
  - - "~>"
53
38
  - !ruby/object:Gem::Version
54
- version: '1.6'
39
+ version: '2.0'
55
40
  - !ruby/object:Gem::Dependency
56
41
  name: hoe-rubygems
57
42
  requirement: !ruby/object:Gem::Requirement
@@ -66,20 +51,6 @@ dependencies:
66
51
  - - "~>"
67
52
  - !ruby/object:Gem::Version
68
53
  version: '1.0'
69
- - !ruby/object:Gem::Dependency
70
- name: hoe-travis
71
- requirement: !ruby/object:Gem::Requirement
72
- requirements:
73
- - - "~>"
74
- - !ruby/object:Gem::Version
75
- version: '1.2'
76
- type: :development
77
- prerelease: false
78
- version_requirements: !ruby/object:Gem::Requirement
79
- requirements:
80
- - - "~>"
81
- - !ruby/object:Gem::Version
82
- version: '1.2'
83
54
  - !ruby/object:Gem::Dependency
84
55
  name: rspec
85
56
  requirement: !ruby/object:Gem::Requirement
@@ -109,7 +80,7 @@ dependencies:
109
80
  version: '10.0'
110
81
  - - "<"
111
82
  - !ruby/object:Gem::Version
112
- version: '12'
83
+ version: '14'
113
84
  type: :development
114
85
  prerelease: false
115
86
  version_requirements: !ruby/object:Gem::Requirement
@@ -119,44 +90,41 @@ dependencies:
119
90
  version: '10.0'
120
91
  - - "<"
121
92
  - !ruby/object:Gem::Version
122
- version: '12'
93
+ version: '14'
123
94
  - !ruby/object:Gem::Dependency
124
95
  name: rdoc
125
96
  requirement: !ruby/object:Gem::Requirement
126
97
  requirements:
127
98
  - - ">="
128
99
  - !ruby/object:Gem::Version
129
- version: '0'
100
+ version: 6.3.1
101
+ - - "<"
102
+ - !ruby/object:Gem::Version
103
+ version: '7'
130
104
  type: :development
131
105
  prerelease: false
132
106
  version_requirements: !ruby/object:Gem::Requirement
133
107
  requirements:
134
108
  - - ">="
135
109
  - !ruby/object:Gem::Version
136
- version: '0'
137
- - !ruby/object:Gem::Dependency
138
- name: hoe
139
- requirement: !ruby/object:Gem::Requirement
140
- requirements:
141
- - - "~>"
142
- - !ruby/object:Gem::Version
143
- version: '3.16'
144
- type: :development
145
- prerelease: false
146
- version_requirements: !ruby/object:Gem::Requirement
147
- requirements:
148
- - - "~>"
110
+ version: 6.3.1
111
+ - - "<"
149
112
  - !ruby/object:Gem::Version
150
- version: '3.16'
113
+ version: '7'
151
114
  description: |-
152
115
  Diff::LCS computes the difference between two Enumerable sequences using the
153
116
  McIlroy-Hunt longest common subsequence (LCS) algorithm. It includes utilities
154
117
  to create a simple HTML diff output format and a standard diff-like tool.
155
118
 
156
- This is release 1.3, providing a tentative fix to a long-standing issue related
157
- to incorrect detection of a patch direction. Also modernizes the gem
158
- infrastructure, testing infrastructure, and provides a warning-free experience
159
- to Ruby 2.4 users.
119
+ This is release 1.6.1, providing a simple extension that allows for
120
+ Diff::LCS::Change objects to be treated implicitly as arrays and fixes a number
121
+ of formatting issues.
122
+
123
+ Ruby versions below 2.5 are soft-deprecated, which means that older versions are
124
+ no longer part of the CI test suite. If any changes have been introduced that
125
+ break those versions, bug reports and patches will be accepted, but it will be
126
+ up to the reporter to verify any fixes prior to release. The next major release
127
+ will completely break compatibility.
160
128
  email:
161
129
  - halostatue@gmail.com
162
130
  executables:
@@ -164,24 +132,27 @@ executables:
164
132
  - ldiff
165
133
  extensions: []
166
134
  extra_rdoc_files:
167
- - Code-of-Conduct.md
168
- - Contributing.md
169
- - History.md
170
- - License.md
135
+ - CHANGELOG.md
136
+ - CODE_OF_CONDUCT.md
137
+ - CONTRIBUTING.md
138
+ - CONTRIBUTORS.md
139
+ - LICENCE.md
171
140
  - Manifest.txt
172
- - README.rdoc
141
+ - README.md
142
+ - SECURITY.md
173
143
  - docs/COPYING.txt
174
144
  - docs/artistic.txt
175
145
  files:
176
146
  - ".rspec"
177
- - Code-of-Conduct.md
178
- - Contributing.md
179
- - History.md
180
- - License.md
147
+ - CHANGELOG.md
148
+ - CODE_OF_CONDUCT.md
149
+ - CONTRIBUTING.md
150
+ - CONTRIBUTORS.md
151
+ - LICENCE.md
181
152
  - Manifest.txt
182
- - README.rdoc
153
+ - README.md
183
154
  - Rakefile
184
- - autotest/discover.rb
155
+ - SECURITY.md
185
156
  - bin/htmldiff
186
157
  - bin/ldiff
187
158
  - docs/COPYING.txt
@@ -189,6 +160,7 @@ files:
189
160
  - lib/diff-lcs.rb
190
161
  - lib/diff/lcs.rb
191
162
  - lib/diff/lcs/array.rb
163
+ - lib/diff/lcs/backports.rb
192
164
  - lib/diff/lcs/block.rb
193
165
  - lib/diff/lcs/callbacks.rb
194
166
  - lib/diff/lcs/change.rb
@@ -197,10 +169,86 @@ files:
197
169
  - lib/diff/lcs/internals.rb
198
170
  - lib/diff/lcs/ldiff.rb
199
171
  - lib/diff/lcs/string.rb
172
+ - lib/diff/lcs/version.rb
173
+ - mise.toml
200
174
  - spec/change_spec.rb
201
175
  - spec/diff_spec.rb
176
+ - spec/fixtures/123_x
177
+ - spec/fixtures/456_x
178
+ - spec/fixtures/aX
179
+ - spec/fixtures/bXaX
202
180
  - spec/fixtures/ds1.csv
203
181
  - spec/fixtures/ds2.csv
182
+ - spec/fixtures/empty
183
+ - spec/fixtures/file1.bin
184
+ - spec/fixtures/file2.bin
185
+ - spec/fixtures/four_lines
186
+ - spec/fixtures/four_lines_with_missing_new_line
187
+ - spec/fixtures/ldiff/diff.missing_new_line1-e
188
+ - spec/fixtures/ldiff/diff.missing_new_line1-f
189
+ - spec/fixtures/ldiff/diff.missing_new_line2-e
190
+ - spec/fixtures/ldiff/diff.missing_new_line2-f
191
+ - spec/fixtures/ldiff/error.diff.chef-e
192
+ - spec/fixtures/ldiff/error.diff.chef-f
193
+ - spec/fixtures/ldiff/error.diff.missing_new_line1-e
194
+ - spec/fixtures/ldiff/error.diff.missing_new_line1-f
195
+ - spec/fixtures/ldiff/error.diff.missing_new_line2-e
196
+ - spec/fixtures/ldiff/error.diff.missing_new_line2-f
197
+ - spec/fixtures/ldiff/output.diff
198
+ - spec/fixtures/ldiff/output.diff-c
199
+ - spec/fixtures/ldiff/output.diff-e
200
+ - spec/fixtures/ldiff/output.diff-f
201
+ - spec/fixtures/ldiff/output.diff-u
202
+ - spec/fixtures/ldiff/output.diff.bin1
203
+ - spec/fixtures/ldiff/output.diff.bin1-c
204
+ - spec/fixtures/ldiff/output.diff.bin1-e
205
+ - spec/fixtures/ldiff/output.diff.bin1-f
206
+ - spec/fixtures/ldiff/output.diff.bin1-u
207
+ - spec/fixtures/ldiff/output.diff.bin2
208
+ - spec/fixtures/ldiff/output.diff.bin2-c
209
+ - spec/fixtures/ldiff/output.diff.bin2-e
210
+ - spec/fixtures/ldiff/output.diff.bin2-f
211
+ - spec/fixtures/ldiff/output.diff.bin2-u
212
+ - spec/fixtures/ldiff/output.diff.chef
213
+ - spec/fixtures/ldiff/output.diff.chef-c
214
+ - spec/fixtures/ldiff/output.diff.chef-e
215
+ - spec/fixtures/ldiff/output.diff.chef-f
216
+ - spec/fixtures/ldiff/output.diff.chef-u
217
+ - spec/fixtures/ldiff/output.diff.chef2
218
+ - spec/fixtures/ldiff/output.diff.chef2-c
219
+ - spec/fixtures/ldiff/output.diff.chef2-d
220
+ - spec/fixtures/ldiff/output.diff.chef2-e
221
+ - spec/fixtures/ldiff/output.diff.chef2-f
222
+ - spec/fixtures/ldiff/output.diff.chef2-u
223
+ - spec/fixtures/ldiff/output.diff.empty.vs.four_lines
224
+ - spec/fixtures/ldiff/output.diff.empty.vs.four_lines-c
225
+ - spec/fixtures/ldiff/output.diff.empty.vs.four_lines-e
226
+ - spec/fixtures/ldiff/output.diff.empty.vs.four_lines-f
227
+ - spec/fixtures/ldiff/output.diff.empty.vs.four_lines-u
228
+ - spec/fixtures/ldiff/output.diff.four_lines.vs.empty
229
+ - spec/fixtures/ldiff/output.diff.four_lines.vs.empty-c
230
+ - spec/fixtures/ldiff/output.diff.four_lines.vs.empty-e
231
+ - spec/fixtures/ldiff/output.diff.four_lines.vs.empty-f
232
+ - spec/fixtures/ldiff/output.diff.four_lines.vs.empty-u
233
+ - spec/fixtures/ldiff/output.diff.issue95_trailing_context
234
+ - spec/fixtures/ldiff/output.diff.issue95_trailing_context-c
235
+ - spec/fixtures/ldiff/output.diff.issue95_trailing_context-e
236
+ - spec/fixtures/ldiff/output.diff.issue95_trailing_context-f
237
+ - spec/fixtures/ldiff/output.diff.issue95_trailing_context-u
238
+ - spec/fixtures/ldiff/output.diff.missing_new_line1
239
+ - spec/fixtures/ldiff/output.diff.missing_new_line1-c
240
+ - spec/fixtures/ldiff/output.diff.missing_new_line1-e
241
+ - spec/fixtures/ldiff/output.diff.missing_new_line1-f
242
+ - spec/fixtures/ldiff/output.diff.missing_new_line1-u
243
+ - spec/fixtures/ldiff/output.diff.missing_new_line2
244
+ - spec/fixtures/ldiff/output.diff.missing_new_line2-c
245
+ - spec/fixtures/ldiff/output.diff.missing_new_line2-e
246
+ - spec/fixtures/ldiff/output.diff.missing_new_line2-f
247
+ - spec/fixtures/ldiff/output.diff.missing_new_line2-u
248
+ - spec/fixtures/new-chef
249
+ - spec/fixtures/new-chef2
250
+ - spec/fixtures/old-chef
251
+ - spec/fixtures/old-chef2
204
252
  - spec/hunk_spec.rb
205
253
  - spec/issues_spec.rb
206
254
  - spec/lcs_spec.rb
@@ -213,13 +261,17 @@ files:
213
261
  homepage: https://github.com/halostatue/diff-lcs
214
262
  licenses:
215
263
  - MIT
216
- - Artistic-2.0
217
- - GPL-2.0+
218
- metadata: {}
219
- post_install_message:
264
+ - Artistic-1.0-Perl
265
+ - GPL-2.0-or-later
266
+ metadata:
267
+ homepage_uri: https://github.com/halostatue/diff-lcs
268
+ changelog_uri: https://github.com/halostatue/diff-lcs/blob/main/CHANGELOG.md
269
+ source_code_uri: https://github.com/halostatue/diff-lcs
270
+ bug_tracker_uri: https://github.com/halostatue/diff-lcs/issues
271
+ rubygems_mfa_required: 'true'
220
272
  rdoc_options:
221
273
  - "--main"
222
- - README.rdoc
274
+ - README.md
223
275
  require_paths:
224
276
  - lib
225
277
  required_ruby_version: !ruby/object:Gem::Requirement
@@ -233,9 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
233
285
  - !ruby/object:Gem::Version
234
286
  version: '0'
235
287
  requirements: []
236
- rubyforge_project:
237
- rubygems_version: 2.5.1
238
- signing_key:
288
+ rubygems_version: 3.6.6
239
289
  specification_version: 4
240
290
  summary: Diff::LCS computes the difference between two Enumerable sequences using
241
291
  the McIlroy-Hunt longest common subsequence (LCS) algorithm
data/Code-of-Conduct.md DELETED
@@ -1,74 +0,0 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- In the interest of fostering an open and welcoming environment, we as
6
- contributors and maintainers pledge to making participation in our project and
7
- our community a harassment-free experience for everyone, regardless of age, body
8
- size, disability, ethnicity, gender identity and expression, level of experience,
9
- nationality, personal appearance, race, religion, or sexual identity and
10
- orientation.
11
-
12
- ## Our Standards
13
-
14
- Examples of behavior that contributes to creating a positive environment
15
- include:
16
-
17
- * Using welcoming and inclusive language
18
- * Being respectful of differing viewpoints and experiences
19
- * Gracefully accepting constructive criticism
20
- * Focusing on what is best for the community
21
- * Showing empathy towards other community members
22
-
23
- Examples of unacceptable behavior by participants include:
24
-
25
- * The use of sexualized language or imagery and unwelcome sexual attention or
26
- advances
27
- * Trolling, insulting/derogatory comments, and personal or political attacks
28
- * Public or private harassment
29
- * Publishing others' private information, such as a physical or electronic
30
- address, without explicit permission
31
- * Other conduct which could reasonably be considered inappropriate in a
32
- professional setting
33
-
34
- ## Our Responsibilities
35
-
36
- Project maintainers are responsible for clarifying the standards of acceptable
37
- behavior and are expected to take appropriate and fair corrective action in
38
- response to any instances of unacceptable behavior.
39
-
40
- Project maintainers have the right and responsibility to remove, edit, or
41
- reject comments, commits, code, wiki edits, issues, and other contributions
42
- that are not aligned to this Code of Conduct, or to ban temporarily or
43
- permanently any contributor for other behaviors that they deem inappropriate,
44
- threatening, offensive, or harmful.
45
-
46
- ## Scope
47
-
48
- This Code of Conduct applies both within project spaces and in public spaces
49
- when an individual is representing the project or its community. Examples of
50
- representing a project or community include using an official project e-mail
51
- address, posting via an official social media account, or acting as an appointed
52
- representative at an online or offline event. Representation of a project may be
53
- further defined and clarified by project maintainers.
54
-
55
- ## Enforcement
56
-
57
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
- reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59
- complaints will be reviewed and investigated and will result in a response that
60
- is deemed necessary and appropriate to the circumstances. The project team is
61
- obligated to maintain confidentiality with regard to the reporter of an incident.
62
- Further details of specific enforcement policies may be posted separately.
63
-
64
- Project maintainers who do not follow or enforce the Code of Conduct in good
65
- faith may face temporary or permanent repercussions as determined by other
66
- members of the project's leadership.
67
-
68
- ## Attribution
69
-
70
- This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
- available at [http://contributor-covenant.org/version/1/4][version]
72
-
73
- [homepage]: http://contributor-covenant.org
74
- [version]: http://contributor-covenant.org/version/1/4/
data/Contributing.md DELETED
@@ -1,83 +0,0 @@
1
- ## Contributing
2
-
3
- I value any contribution to Diff::LCS you can provide: a bug report, a feature
4
- request, or code contributions. Code contributions to Diff::LCS are especially
5
- <del>welcome</del>encouraged. Because Diff::LCS is a complex codebase, there
6
- are a few guidelines:
7
-
8
- * Code changes *will not* be accepted without tests. The test suite is
9
- written with [RSpec][].
10
- * Match my coding style.
11
- * Use a thoughtfully-named topic branch that contains your change. Rebase
12
- your commits into logical chunks as necessary.
13
- * Use [quality commit messages][].
14
- * Do not change the version number; when your patch is accepted and a release
15
- is made, the version will be updated at that point.
16
- * Submit a GitHub pull request with your changes.
17
- * New or changed behaviours require appropriate documentation.
18
-
19
- ### Test Dependencies
20
-
21
- Diff::LCS uses Ryan Davis’s [Hoe][] to manage the release process, and it adds
22
- a number of rake tasks. You will mostly be interested in:
23
-
24
- $ rake
25
-
26
- which runs the tests the same way that:
27
-
28
- $ rake spec
29
- $ rake travis
30
-
31
- will do.
32
-
33
- To assist with the installation of the development dependencies, I have
34
- provided a Gemfile pointing to the (generated) `diff-lcs.gemspec` file. This
35
- will permit you to do:
36
-
37
- $ bundle install
38
-
39
- to get the development dependencies. If you aleady have `hoe` installed, you
40
- can accomplish the same thing with:
41
-
42
- $ rake newb
43
-
44
- This task will install any missing dependencies, run the tests/specs, and
45
- generate the RDoc.
46
-
47
- You can run tests with code coverage analysis by running:
48
-
49
- $ rake spec:coverage
50
-
51
- ### Workflow
52
-
53
- Here's the most direct way to get your work merged into the project:
54
-
55
- * Fork the project.
56
- * Clone down your fork (`git clone git://github.com/<username>/diff-lcs.git`).
57
- * Create a topic branch to contain your change (`git checkout -b
58
- my_awesome_feature`).
59
- * Hack away, add tests. Not necessarily in that order.
60
- * Make sure everything still passes by running `rake`.
61
- * If necessary, rebase your commits into logical chunks, without errors.
62
- * Push the branch up (`git push origin my_awesome_feature`).
63
- * Create a pull request against halostatue/diff-lcs and describe what your
64
- change does and the why you think it should be merged.
65
-
66
- ### Contributors
67
-
68
- * Austin Ziegler created Diff::LCS.
69
-
70
- Thanks to everyone else who has contributed to Diff::LCS:
71
-
72
- * Kenichi Kamiya
73
- * Michael Granger
74
- * Vít Ondruch
75
- * Jon Rowe
76
- * Koichi Ito
77
- * Josef Strzibny
78
- * Josh Bronson
79
- * Mark Friedgan
80
-
81
- [Rspec]: http://rspec.info/documentation/
82
- [quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
83
- [Hoe]: https://github.com/seattlerb/hoe