dont_comment 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rubocop.yml +10 -0
- data/.travis.yml +14 -0
- data/Gemfile +4 -0
- data/Guardfile +35 -0
- data/LICENSE +201 -0
- data/README.md +76 -0
- data/Rakefile +9 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/dont_comment.gemspec +39 -0
- data/exe/dont_comment +5 -0
- data/lib/dont_comment/cli.rb +48 -0
- data/lib/dont_comment/formatter/base.rb +13 -0
- data/lib/dont_comment/formatter/json.rb +23 -0
- data/lib/dont_comment/formatter/simple.rb +11 -0
- data/lib/dont_comment/formatter.rb +4 -0
- data/lib/dont_comment/offense.rb +9 -0
- data/lib/dont_comment/runner.rb +115 -0
- data/lib/dont_comment/version.rb +3 -0
- data/lib/dont_comment.rb +18 -0
- metadata +208 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 9a80bf842ae252027b99c5cdcecd93d33bd18c3c
|
4
|
+
data.tar.gz: 39fd5a0a8b0599e6fb34f2e598f83e3ec99646d3
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c08a35285f686ca35a10108b44113499139a9f50a924983d7348399d2ea35889a63cb5e5b7765adbe6a4be491146a0c6a9b826b77573ae0f96c576545bfd2810
|
7
|
+
data.tar.gz: bb3c13e09c1d760f2aabd9851317ede5889cec7dd7dc6a28ffc556a665df2c3677485821141507f460d4b0dc5746e4df8f60089cc72129b1bd00ebcc2122910c
|
data/.gitignore
ADDED
data/.rubocop.yml
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/Guardfile
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
# A sample Guardfile
|
2
|
+
# More info at https://github.com/guard/guard#readme
|
3
|
+
|
4
|
+
## Uncomment and set this to only include directories you want to watch
|
5
|
+
# directories %w(app lib config test spec features) \
|
6
|
+
# .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
|
7
|
+
|
8
|
+
## Note: if you are using the `directories` clause above and you are not
|
9
|
+
## watching the project directory ('.'), then you will want to move
|
10
|
+
## the Guardfile to a watched dir and symlink it back, e.g.
|
11
|
+
#
|
12
|
+
# $ mkdir config
|
13
|
+
# $ mv Guardfile config/
|
14
|
+
# $ ln -s config/Guardfile .
|
15
|
+
#
|
16
|
+
# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
|
17
|
+
|
18
|
+
guard :bundler do
|
19
|
+
require 'guard/bundler'
|
20
|
+
require 'guard/bundler/verify'
|
21
|
+
helper = Guard::Bundler::Verify.new
|
22
|
+
|
23
|
+
files = ['Gemfile']
|
24
|
+
files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
|
25
|
+
|
26
|
+
# Assume files are symlinked from somewhere
|
27
|
+
files.each { |file| watch(helper.real_path(file)) }
|
28
|
+
end
|
29
|
+
|
30
|
+
guard :minitest do
|
31
|
+
# with Minitest::Unit
|
32
|
+
watch(%r{^test/(.*)\/?test_(.*)\.rb$})
|
33
|
+
watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { |m| "test/#{m[1]}test_#{m[2]}.rb" }
|
34
|
+
watch(%r{^test/test_helper\.rb$}) { 'test' }
|
35
|
+
end
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,76 @@
|
|
1
|
+
# DontComment
|
2
|
+
|
3
|
+
Do not comment out unused code, use version control system instead and remove it!
|
4
|
+
|
5
|
+
|
6
|
+
## What's this?
|
7
|
+
|
8
|
+
If you use version control system, you must not comment out unused code.
|
9
|
+
|
10
|
+
For example, you can remove the old implementation in the following code.
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
# def some_method
|
14
|
+
# puts 'an old implementation'
|
15
|
+
# end
|
16
|
+
|
17
|
+
def some_method
|
18
|
+
puts 'a new implementation'
|
19
|
+
end
|
20
|
+
```
|
21
|
+
|
22
|
+
This tool detects this problem.
|
23
|
+
|
24
|
+
|
25
|
+
### Detect comment outs for debug
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
class ExampleController < ApplicationController
|
29
|
+
# before_action :validate_foobar
|
30
|
+
end
|
31
|
+
```
|
32
|
+
|
33
|
+
Sometime we comment out validation or something for debug.
|
34
|
+
If we forget to restore the comment before we commit the change, it will be a serious bug.
|
35
|
+
|
36
|
+
We can avoid the bug by this tool.
|
37
|
+
|
38
|
+
### False positives
|
39
|
+
|
40
|
+
Maybe, This tools will make many false positives.
|
41
|
+
I design this tools to use with a pull-request.
|
42
|
+
Do not use use this tool for all ruby files in your repository. It probably will not be useful.
|
43
|
+
|
44
|
+
## Installation
|
45
|
+
|
46
|
+
Add this line to your application's Gemfile:
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
gem 'dont_comment'
|
50
|
+
```
|
51
|
+
|
52
|
+
And then execute:
|
53
|
+
|
54
|
+
$ bundle
|
55
|
+
|
56
|
+
Or install it yourself as:
|
57
|
+
|
58
|
+
$ gem install dont_comment
|
59
|
+
|
60
|
+
### Requirements
|
61
|
+
|
62
|
+
- Ruby 2.4 or higher
|
63
|
+
|
64
|
+
## Usage
|
65
|
+
|
66
|
+
```bash
|
67
|
+
$ dont_comment some/ruby/file/path.rb
|
68
|
+
some/ruby/file/path.rb:3: Do not comment out unused code, use version control system instead and remove it!
|
69
|
+
some/ruby/file/path.rb:7: Do not comment out unused code, use version control system instead and remove it!
|
70
|
+
```
|
71
|
+
|
72
|
+
|
73
|
+
## Contributing
|
74
|
+
|
75
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/dont_comment.
|
76
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "dont_comment"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'dont_comment/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "dont_comment"
|
8
|
+
spec.version = DontComment::VERSION
|
9
|
+
spec.authors = ["Masataka Kuwabara"]
|
10
|
+
spec.email = ["kuwabara@pocke.me"]
|
11
|
+
|
12
|
+
spec.summary = %q{Do not comment out unused code, use version control system instead and remove it!}
|
13
|
+
spec.description = %q{Do not comment out unused code, use version control system instead and remove it!}
|
14
|
+
spec.homepage = "https://github.com/pocke/dont_comment"
|
15
|
+
spec.license = 'Apache-2.0'
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
18
|
+
f.match(%r{^(test|spec|features)/})
|
19
|
+
end
|
20
|
+
spec.bindir = "exe"
|
21
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
22
|
+
spec.require_paths = ["lib"]
|
23
|
+
|
24
|
+
spec.required_ruby_version = '>= 2.4'
|
25
|
+
|
26
|
+
spec.add_dependency 'parser'
|
27
|
+
|
28
|
+
spec.add_development_dependency "bundler", "~> 1.14"
|
29
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
30
|
+
spec.add_development_dependency "rubocop", ">= 0.48.1"
|
31
|
+
spec.add_development_dependency "meowcop"
|
32
|
+
|
33
|
+
# testing
|
34
|
+
spec.add_development_dependency "minitest", "~> 5.9.0"
|
35
|
+
spec.add_development_dependency "minitest-power_assert", "~> 0.2.0"
|
36
|
+
spec.add_development_dependency 'guard', '~> 2.13.0'
|
37
|
+
spec.add_development_dependency 'guard-minitest', '~> 2.4.4'
|
38
|
+
spec.add_development_dependency 'guard-bundler', '~> 2.1.0'
|
39
|
+
end
|
data/exe/dont_comment
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
module DontComment
|
2
|
+
class CLI
|
3
|
+
class ValidateError < StandardError; end
|
4
|
+
|
5
|
+
FormatterMap = {
|
6
|
+
simple: Formatter::Simple,
|
7
|
+
json: Formatter::JSON,
|
8
|
+
}
|
9
|
+
|
10
|
+
def initialize(argv, out = $stdout)
|
11
|
+
@argv = argv
|
12
|
+
@config = default_config
|
13
|
+
@out = out
|
14
|
+
end
|
15
|
+
|
16
|
+
def run
|
17
|
+
parse_args
|
18
|
+
validate_config
|
19
|
+
|
20
|
+
files = @argv
|
21
|
+
offenses = Runner.new(files).run
|
22
|
+
formatter_class.new(offenses).format(@out)
|
23
|
+
end
|
24
|
+
|
25
|
+
private
|
26
|
+
|
27
|
+
def parse_args
|
28
|
+
o = OptionParser.new
|
29
|
+
o.on('-f=FORMATTER', '--formatter=FORMATTER'){|v| @config[:formatter] = v.to_sym}
|
30
|
+
|
31
|
+
o.parse!(@argv)
|
32
|
+
end
|
33
|
+
|
34
|
+
def validate_config
|
35
|
+
raise ValidateError, "#{@config[:formatter]} is not a valid formatter name" unless formatter_class
|
36
|
+
end
|
37
|
+
|
38
|
+
def default_config
|
39
|
+
{
|
40
|
+
formatter: :simple,
|
41
|
+
}
|
42
|
+
end
|
43
|
+
|
44
|
+
def formatter_class
|
45
|
+
FormatterMap[@config[:formatter]]
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
module DontComment
|
2
|
+
module Formatter
|
3
|
+
class JSON < Base
|
4
|
+
def format(io)
|
5
|
+
array = @offenses.map do |offense|
|
6
|
+
loc = offense.loc
|
7
|
+
{
|
8
|
+
path: offense.relative_path,
|
9
|
+
location: {
|
10
|
+
start_line: loc.line,
|
11
|
+
start_column: loc.column,
|
12
|
+
end_line: loc.last_line,
|
13
|
+
end_column: loc.last_column,
|
14
|
+
}
|
15
|
+
}
|
16
|
+
end
|
17
|
+
|
18
|
+
json = ::JSON.generate(array)
|
19
|
+
io.print(json)
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
module DontComment
|
2
|
+
module Formatter
|
3
|
+
class Simple < Base
|
4
|
+
def format(io)
|
5
|
+
@offenses.each do |offense|
|
6
|
+
io.puts "#{offense.relative_path}:#{offense.loc.line}: Do not comment out unused code, use version control system instead and remove it!"
|
7
|
+
end
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,115 @@
|
|
1
|
+
module DontComment
|
2
|
+
class Runner
|
3
|
+
def initialize(files)
|
4
|
+
@files = files
|
5
|
+
end
|
6
|
+
|
7
|
+
def run
|
8
|
+
# TODO: configuralbe ruby version
|
9
|
+
parser_class = Parser::CurrentRuby
|
10
|
+
@files.map do |fname|
|
11
|
+
parser = parser_class.new
|
12
|
+
buffer = buffer(fname)
|
13
|
+
locs = comment_locations(parser, buffer)
|
14
|
+
|
15
|
+
ruby_code_locs = locs.select do |loc|
|
16
|
+
text = to_text(loc)
|
17
|
+
parsable?(parser_class, text) &&
|
18
|
+
like_ruby_code?(text)
|
19
|
+
end
|
20
|
+
|
21
|
+
ruby_code_locs.map{|loc| Offense.new(loc, fname)}
|
22
|
+
end.flatten
|
23
|
+
end
|
24
|
+
|
25
|
+
private
|
26
|
+
|
27
|
+
def buffer(fname)
|
28
|
+
Parser::Source::Buffer.new(fname, 1).tap do |buffer|
|
29
|
+
buffer.source = File.read(fname)
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
# @example
|
34
|
+
# One comment
|
35
|
+
# # foo
|
36
|
+
# # bar
|
37
|
+
# def foo; end
|
38
|
+
#
|
39
|
+
# One comment
|
40
|
+
# # foo
|
41
|
+
# def foo; end
|
42
|
+
#
|
43
|
+
# Two comments
|
44
|
+
# # foo
|
45
|
+
# def foo; end
|
46
|
+
# # bar
|
47
|
+
def comment_locations(parser, buffer)
|
48
|
+
_ast, comments, _tokens = parser.tokenize(buffer)
|
49
|
+
|
50
|
+
comments.each_with_object([]) do |comment, locs|
|
51
|
+
prev = locs.last
|
52
|
+
cur = comment.loc.expression
|
53
|
+
|
54
|
+
if prev && continuous_comment?(prev, cur)
|
55
|
+
locs[locs.size-1] = prev.join(cur)
|
56
|
+
else
|
57
|
+
locs.push(cur)
|
58
|
+
end
|
59
|
+
end.freeze
|
60
|
+
end
|
61
|
+
|
62
|
+
# @param prev [Parser::Source::Range]
|
63
|
+
# @param cur [Parser::Source::Range]
|
64
|
+
def continuous_comment?(prev, cur)
|
65
|
+
range_between(prev, cur).source.match?(/\A\s*\z/)
|
66
|
+
end
|
67
|
+
|
68
|
+
# @param prev [Parser::Source::Range]
|
69
|
+
# @param cur [Parser::Source::Range]
|
70
|
+
def range_between(prev, cur)
|
71
|
+
Parser::Source::Range.new(prev.source_buffer, prev.end_pos, cur.begin_pos)
|
72
|
+
end
|
73
|
+
|
74
|
+
# @param loc [Parser::Source::Range]
|
75
|
+
# @return [String]
|
76
|
+
def to_text(loc)
|
77
|
+
source = loc.source
|
78
|
+
source.each_line.map do |line|
|
79
|
+
line[/^\s*\#(.+)$/, 1]
|
80
|
+
end.join("\n")
|
81
|
+
end
|
82
|
+
|
83
|
+
# @param parser_class [Class]
|
84
|
+
# @param source [String]
|
85
|
+
# @return [true|false]
|
86
|
+
def parsable?(parser_class, source)
|
87
|
+
stderr = $stderr
|
88
|
+
$stderr = StringIO.new
|
89
|
+
|
90
|
+
parser_class.parse(source)
|
91
|
+
return true
|
92
|
+
rescue Parser::SyntaxError
|
93
|
+
return false
|
94
|
+
ensure
|
95
|
+
$stderr = stderr
|
96
|
+
end
|
97
|
+
|
98
|
+
# Check ascii
|
99
|
+
# @param source [String]
|
100
|
+
# @return [true|false]
|
101
|
+
def like_ruby_code?(source)
|
102
|
+
count_ascii = 0
|
103
|
+
count_non_ascii = 0
|
104
|
+
source.chars.each do |ch|
|
105
|
+
if ch.match?(/[[:ascii:]]/)
|
106
|
+
count_ascii += 1
|
107
|
+
else
|
108
|
+
count_non_ascii += 1
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
count_ascii / (count_ascii + count_non_ascii).to_f > 0.7
|
113
|
+
end
|
114
|
+
end
|
115
|
+
end
|
data/lib/dont_comment.rb
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
require 'parser/current'
|
2
|
+
|
3
|
+
require 'stringio'
|
4
|
+
require 'optparse'
|
5
|
+
require 'json'
|
6
|
+
require 'pathname'
|
7
|
+
|
8
|
+
require 'dont_comment/formatter'
|
9
|
+
require 'dont_comment/formatter/base'
|
10
|
+
require 'dont_comment/formatter/simple'
|
11
|
+
require 'dont_comment/formatter/json'
|
12
|
+
require 'dont_comment/cli'
|
13
|
+
require 'dont_comment/offense'
|
14
|
+
require 'dont_comment/runner'
|
15
|
+
require "dont_comment/version"
|
16
|
+
|
17
|
+
module DontComment
|
18
|
+
end
|
metadata
ADDED
@@ -0,0 +1,208 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: dont_comment
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Masataka Kuwabara
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-04-14 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: parser
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.14'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.14'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rubocop
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 0.48.1
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 0.48.1
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: meowcop
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: minitest
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: 5.9.0
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: 5.9.0
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: minitest-power_assert
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - "~>"
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: 0.2.0
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - "~>"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: 0.2.0
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: guard
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - "~>"
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: 2.13.0
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - "~>"
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: 2.13.0
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: guard-minitest
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - "~>"
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: 2.4.4
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - "~>"
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: 2.4.4
|
139
|
+
- !ruby/object:Gem::Dependency
|
140
|
+
name: guard-bundler
|
141
|
+
requirement: !ruby/object:Gem::Requirement
|
142
|
+
requirements:
|
143
|
+
- - "~>"
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: 2.1.0
|
146
|
+
type: :development
|
147
|
+
prerelease: false
|
148
|
+
version_requirements: !ruby/object:Gem::Requirement
|
149
|
+
requirements:
|
150
|
+
- - "~>"
|
151
|
+
- !ruby/object:Gem::Version
|
152
|
+
version: 2.1.0
|
153
|
+
description: Do not comment out unused code, use version control system instead and
|
154
|
+
remove it!
|
155
|
+
email:
|
156
|
+
- kuwabara@pocke.me
|
157
|
+
executables:
|
158
|
+
- dont_comment
|
159
|
+
extensions: []
|
160
|
+
extra_rdoc_files: []
|
161
|
+
files:
|
162
|
+
- ".gitignore"
|
163
|
+
- ".rubocop.yml"
|
164
|
+
- ".travis.yml"
|
165
|
+
- Gemfile
|
166
|
+
- Guardfile
|
167
|
+
- LICENSE
|
168
|
+
- README.md
|
169
|
+
- Rakefile
|
170
|
+
- bin/console
|
171
|
+
- bin/setup
|
172
|
+
- dont_comment.gemspec
|
173
|
+
- exe/dont_comment
|
174
|
+
- lib/dont_comment.rb
|
175
|
+
- lib/dont_comment/cli.rb
|
176
|
+
- lib/dont_comment/formatter.rb
|
177
|
+
- lib/dont_comment/formatter/base.rb
|
178
|
+
- lib/dont_comment/formatter/json.rb
|
179
|
+
- lib/dont_comment/formatter/simple.rb
|
180
|
+
- lib/dont_comment/offense.rb
|
181
|
+
- lib/dont_comment/runner.rb
|
182
|
+
- lib/dont_comment/version.rb
|
183
|
+
homepage: https://github.com/pocke/dont_comment
|
184
|
+
licenses:
|
185
|
+
- Apache-2.0
|
186
|
+
metadata: {}
|
187
|
+
post_install_message:
|
188
|
+
rdoc_options: []
|
189
|
+
require_paths:
|
190
|
+
- lib
|
191
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
192
|
+
requirements:
|
193
|
+
- - ">="
|
194
|
+
- !ruby/object:Gem::Version
|
195
|
+
version: '2.4'
|
196
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
197
|
+
requirements:
|
198
|
+
- - ">="
|
199
|
+
- !ruby/object:Gem::Version
|
200
|
+
version: '0'
|
201
|
+
requirements: []
|
202
|
+
rubyforge_project:
|
203
|
+
rubygems_version: 2.6.10
|
204
|
+
signing_key:
|
205
|
+
specification_version: 4
|
206
|
+
summary: Do not comment out unused code, use version control system instead and remove
|
207
|
+
it!
|
208
|
+
test_files: []
|