Skip to content

Commit 06d5603

Browse files
doudoudoudou
committed
chore: integrate rubocop
1 parent bee718b commit 06d5603

37 files changed

+1145
-779
lines changed

‎.rubocop-version

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1.64.1

‎.rubocop.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
inherit_from: .rubocop_todo.yml
2+
3+
inherit_gem:
4+
rubocop-rock: defaults.yml
5+
6+
AllCops:
7+
TargetRubyVersion: "2.5"
8+
NewCops: enable

‎.rubocop_todo.yml

+279
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,279 @@
1+
# This configuration was generated by
2+
# `rubocop --auto-gen-config --no-exclude-limit`
3+
# on 2024-06-20 16:53:58 UTC using RuboCop version 1.64.1.
4+
# The point is for the user to remove these configuration records
5+
# one by one as the offenses are removed from the code base.
6+
# Note that changes in the inspected code, or installation of new
7+
# versions of RuboCop, may require this file to be generated again.
8+
9+
# Offense count: 126
10+
# This cop supports safe autocorrection (--autocorrect).
11+
# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
12+
# URISchemes: http, https
13+
Layout/LineLength:
14+
Exclude:
15+
- 'lib/sdf/conversions.rb'
16+
- 'lib/sdf/joint.rb'
17+
- 'lib/sdf/link.rb'
18+
- 'lib/sdf/root.rb'
19+
- 'lib/sdf/spherical_coordinates.rb'
20+
- 'lib/sdf/xml.rb'
21+
- 'test/test_conversions.rb'
22+
- 'test/test_joint.rb'
23+
- 'test/test_link.rb'
24+
- 'test/test_model.rb'
25+
- 'test/test_physics.rb'
26+
- 'test/test_root.rb'
27+
- 'test/test_sensor.rb'
28+
- 'test/test_spherical_coordinates.rb'
29+
- 'test/test_world.rb'
30+
- 'test/test_xml.rb'
31+
32+
# Offense count: 1
33+
# This cop supports safe autocorrection (--autocorrect).
34+
# Configuration parameters: EnforcedStyle.
35+
# SupportedStyles: final_newline, final_blank_line
36+
Layout/TrailingEmptyLines:
37+
Exclude:
38+
- 'Rakefile'
39+
40+
# Offense count: 29
41+
# This cop supports unsafe autocorrection (--autocorrect-all).
42+
# Configuration parameters: AllowSafeAssignment.
43+
Lint/AssignmentInCondition:
44+
Exclude:
45+
- 'lib/sdf/axis.rb'
46+
- 'lib/sdf/axis_limit.rb'
47+
- 'lib/sdf/joint.rb'
48+
- 'lib/sdf/link.rb'
49+
- 'lib/sdf/model.rb'
50+
- 'lib/sdf/physics.rb'
51+
- 'lib/sdf/plugin.rb'
52+
- 'lib/sdf/root.rb'
53+
- 'lib/sdf/sensor.rb'
54+
- 'lib/sdf/spherical_coordinates.rb'
55+
- 'lib/sdf/xml.rb'
56+
57+
# Offense count: 1
58+
# Configuration parameters: AllowedParentClasses.
59+
Lint/MissingSuper:
60+
Exclude:
61+
- 'lib/sdf/xml.rb'
62+
63+
# Offense count: 3
64+
Lint/RescueException:
65+
Exclude:
66+
- 'lib/sdf/test.rb'
67+
- 'lib/sdf/xml.rb'
68+
69+
# Offense count: 4
70+
Lint/ShadowingOuterLocalVariable:
71+
Exclude:
72+
- 'lib/sdf/joint.rb'
73+
- 'lib/sdf/model.rb'
74+
- 'test/test_model.rb'
75+
76+
# Offense count: 1
77+
# Configuration parameters: AllowComments, AllowNil.
78+
Lint/SuppressedException:
79+
Exclude:
80+
- 'lib/sdf/xml.rb'
81+
82+
# Offense count: 5
83+
# This cop supports unsafe autocorrection (--autocorrect-all).
84+
# Configuration parameters: AutoCorrect.
85+
Lint/UselessAssignment:
86+
Exclude:
87+
- 'lib/sdf/conversions.rb'
88+
- 'test/test_xml.rb'
89+
90+
# Offense count: 2
91+
# This cop supports unsafe autocorrection (--autocorrect-all).
92+
# Configuration parameters: AutoCorrect.
93+
Lint/UselessMethodDefinition:
94+
Exclude:
95+
- 'lib/sdf/test.rb'
96+
97+
# Offense count: 12
98+
# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
99+
Metrics/AbcSize:
100+
Exclude:
101+
- 'lib/sdf/joint.rb'
102+
- 'lib/sdf/link.rb'
103+
- 'lib/sdf/model.rb'
104+
- 'lib/sdf/spherical_coordinates.rb'
105+
- 'lib/sdf/xml.rb'
106+
107+
# Offense count: 2
108+
# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
109+
# AllowedMethods: refine
110+
Metrics/BlockLength:
111+
Exclude:
112+
- '**/*.gemspec'
113+
- 'lib/sdf/joint.rb'
114+
- 'lib/sdf/xml.rb'
115+
116+
# Offense count: 2
117+
# Configuration parameters: CountBlocks, Max.
118+
Metrics/BlockNesting:
119+
Exclude:
120+
- 'lib/sdf/xml.rb'
121+
122+
# Offense count: 8
123+
# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
124+
Metrics/CyclomaticComplexity:
125+
Exclude:
126+
- 'lib/sdf/joint.rb'
127+
- 'lib/sdf/model.rb'
128+
- 'lib/sdf/root.rb'
129+
- 'lib/sdf/spherical_coordinates.rb'
130+
- 'lib/sdf/xml.rb'
131+
132+
# Offense count: 9
133+
# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
134+
Metrics/PerceivedComplexity:
135+
Exclude:
136+
- 'lib/sdf/joint.rb'
137+
- 'lib/sdf/model.rb'
138+
- 'lib/sdf/root.rb'
139+
- 'lib/sdf/spherical_coordinates.rb'
140+
- 'lib/sdf/xml.rb'
141+
142+
# Offense count: 1
143+
# Configuration parameters: ForbiddenDelimiters.
144+
# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$))
145+
Naming/HeredocDelimiterNaming:
146+
Exclude:
147+
- 'test/test_joint.rb'
148+
149+
# Offense count: 2
150+
# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
151+
# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
152+
Naming/MethodParameterName:
153+
Exclude:
154+
- 'lib/sdf.rb'
155+
- 'lib/sdf/conversions.rb'
156+
157+
# Offense count: 1
158+
# This cop supports unsafe autocorrection (--autocorrect-all).
159+
# Configuration parameters: MinBranchesCount.
160+
Style/CaseLikeIf:
161+
Exclude:
162+
- 'lib/sdf/model.rb'
163+
164+
# Offense count: 1
165+
# This cop supports unsafe autocorrection (--autocorrect-all).
166+
# Configuration parameters: EnforcedStyle.
167+
# SupportedStyles: nested, compact
168+
Style/ClassAndModuleChildren:
169+
Exclude:
170+
- 'lib/sdf/test.rb'
171+
172+
# Offense count: 9
173+
# Configuration parameters: AllowedConstants.
174+
Style/Documentation:
175+
Exclude:
176+
- 'spec/**/*'
177+
- 'test/**/*'
178+
- 'lib/sdf/axis.rb'
179+
- 'lib/sdf/axis_limit.rb'
180+
- 'lib/sdf/conversions.rb'
181+
- 'lib/sdf/frame.rb'
182+
- 'lib/sdf/joint.rb'
183+
- 'lib/sdf/link.rb'
184+
- 'lib/sdf/plugin.rb'
185+
- 'lib/sdf/world.rb'
186+
- 'lib/sdf/xml.rb'
187+
188+
# Offense count: 30
189+
# This cop supports unsafe autocorrection (--autocorrect-all).
190+
# Configuration parameters: EnforcedStyle.
191+
# SupportedStyles: always, always_true, never
192+
Style/FrozenStringLiteralComment:
193+
Exclude:
194+
- 'lib/sdf.rb'
195+
- 'lib/sdf/axis.rb'
196+
- 'lib/sdf/axis_limit.rb'
197+
- 'lib/sdf/conversions.rb'
198+
- 'lib/sdf/exceptions.rb'
199+
- 'lib/sdf/frame.rb'
200+
- 'lib/sdf/joint.rb'
201+
- 'lib/sdf/link.rb'
202+
- 'lib/sdf/model.rb'
203+
- 'lib/sdf/physics.rb'
204+
- 'lib/sdf/plugin.rb'
205+
- 'lib/sdf/root.rb'
206+
- 'lib/sdf/sensor.rb'
207+
- 'lib/sdf/spherical_coordinates.rb'
208+
- 'lib/sdf/test.rb'
209+
- 'lib/sdf/world.rb'
210+
- 'lib/sdf/xml.rb'
211+
- 'test/suite.rb'
212+
- 'test/test_axis.rb'
213+
- 'test/test_axis_limit.rb'
214+
- 'test/test_conversions.rb'
215+
- 'test/test_joint.rb'
216+
- 'test/test_link.rb'
217+
- 'test/test_model.rb'
218+
- 'test/test_physics.rb'
219+
- 'test/test_root.rb'
220+
- 'test/test_sensor.rb'
221+
- 'test/test_spherical_coordinates.rb'
222+
- 'test/test_world.rb'
223+
- 'test/test_xml.rb'
224+
225+
# Offense count: 3
226+
# This cop supports unsafe autocorrection (--autocorrect-all).
227+
# Configuration parameters: AllowSplatArgument.
228+
Style/HashConversion:
229+
Exclude:
230+
- 'lib/sdf/element.rb'
231+
- 'lib/sdf/xml.rb'
232+
- 'test/test_xml.rb'
233+
234+
# Offense count: 2
235+
# This cop supports unsafe autocorrection (--autocorrect-all).
236+
# Configuration parameters: AllowedReceivers.
237+
# AllowedReceivers: Thread.current
238+
Style/HashEachMethods:
239+
Exclude:
240+
- 'lib/sdf/model.rb'
241+
- 'lib/sdf/xml.rb'
242+
243+
# Offense count: 1
244+
# This cop supports unsafe autocorrection (--autocorrect-all).
245+
# Configuration parameters: EnforcedStyle.
246+
# SupportedStyles: literals, strict
247+
Style/MutableConstant:
248+
Exclude:
249+
- 'lib/sdf/xml.rb'
250+
251+
# Offense count: 1
252+
# Configuration parameters: AllowedMethods.
253+
# AllowedMethods: respond_to_missing?
254+
Style/OptionalBooleanParameter:
255+
Exclude:
256+
- 'lib/sdf/element.rb'
257+
258+
# Offense count: 2
259+
# This cop supports unsafe autocorrection (--autocorrect-all).
260+
# Configuration parameters: EnforcedStyle.
261+
# SupportedStyles: short, verbose
262+
Style/PreferredHashMethods:
263+
Exclude:
264+
- 'lib/sdf/joint.rb'
265+
- 'lib/sdf/xml.rb'
266+
267+
# Offense count: 1
268+
# This cop supports unsafe autocorrection (--autocorrect-all).
269+
# Configuration parameters: AllowedMethods, AllowedPatterns.
270+
Style/ReturnNilInPredicateMethodDefinition:
271+
Exclude:
272+
- 'lib/sdf/link.rb'
273+
274+
# Offense count: 1
275+
# This cop supports unsafe autocorrection (--autocorrect-all).
276+
# Configuration parameters: Mode.
277+
Style/StringConcatenation:
278+
Exclude:
279+
- 'lib/sdf/element.rb'

‎History.txt

-2
This file was deleted.

‎Manifest.txt

-11
This file was deleted.

‎Rakefile

+12-29
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,18 @@
1-
task :default
2-
3-
package_name = 'sdf'
4-
begin
5-
require 'hoe'
6-
7-
Hoe::plugin :yard
1+
# frozen_string_literal: true
82

9-
hoe_spec = Hoe.spec package_name do
10-
self.version = ''
11-
self.developer "Sylvain Joyeux", "[email protected]"
12-
self.license 'LGPLv3+'
13-
self.extra_deps <<
14-
['rake', '>= 0.8.0'] <<
15-
["hoe", ">= 3.0.0"] <<
16-
["hoe-yard", ">= 0.1.2"]
3+
require "rake/testtask"
4+
require "yard"
5+
require "yard/rake/yardoc_task"
176

18-
self.summary = 'Library to read SDF files from Ruby'
19-
self.readme_file = FileList['README*'].first
20-
self.description = paragraphs_of(readme_file, 3..5).join("\n\n")
7+
task :default
218

22-
self.spec_extras = {
23-
:required_ruby_version => '>= 1.8.7'
24-
}
25-
end
9+
Rake::TestTask.new
2610

27-
# If you need to deviate from the defaults, check utilrb's Rakefile as an example
11+
task :rubocop do
12+
system(ENV["RUBOCOP_CMD"] || "rubocop", exception: true)
13+
end
14+
task test: :rubocop
2815

29-
Rake.clear_tasks(/^default$/)
30-
task :default => []
31-
task :doc => :yard
16+
YARD::Rake::YardocTask.new
17+
task "doc" => "yard"
3218

33-
rescue LoadError => e
34-
puts "Extension for '#{package_name}' cannot be build -- loading gem failed: #{e}"
35-
end

0 commit comments

Comments
 (0)