Share
Embed
Recommendations for making miscellaneous Custom Cops - 雑Custom Cop作りのススメ
Kaigi on Rails _2022_ new 「雑Custom Cop作りのススメ」の発表スライド
https://kaigionrails.org/2022/ #kaigionrails
ydah
October 09, 2022
Transcript
24 slides
-
• Name: Yudai T akada • GitHub: @ydah • T
witter: @ydah_ • An Open Source Software programmer. • Software Engineer at ANDPAD, Inc. • RuboCop Contributor. (Create and send patches) • Born and raised in Osaka. • Loves beer and coffee and metal bands 🍻 ☕ 🤘 self.inspect -
• Style/ObjectThen • Lint/ConstantOverwrittenInRescue • Lint/NonAtomicFileOperation • Rails/WhereMissing • Rails/FreezeTime
• RSpec/ChangeByZero • RSpec/Capybara/SpecificFinders • RSpec/Capybara/SpecificMatcher Add new cops -
• A Ruby static code analyzer (a.k.a. linter) and code
formatter. • Rubyの静的解析ツール What is RuboCop? -
• 自分で使う便利ツールとして作っていく • 例: action_argsを使っていないアクションを探す • 良さそうなものはブラッシュアップしてプロダクトに導入したり、RuboCopへパッチを送ったり • 置き場となるリポジトリを作っておくのがおすすめ •
思いついた時にサッと書けて試せる • リポジトリ自体も簡単に作れる “雑” Custom Cop -
Creating gem 'rubocop-foobar'... create rubocop-foobar/Gemfile create rubocop-foobar/lib/rubocop/foobar.rb create rubocop-foobar/lib/rubocop/foobar/version.rb create
rubocop-foobar/rubocop-foobar.gemspec create rubocop-foobar/Rakefile create rubocop-foobar/README.md create rubocop-foobar/bin/console create rubocop-foobar/bin/setup create rubocop-foobar/.gitignore Initializing git repo in /tmp/tmp.Gu7G94wX00/rubocop-foobar Gem 'rubocop-foobar' was successfully created. For more information on making a RubyGem visit https://bundler.io/guides/creating_gem.html create rubocop-foobar/lib/rubocop-foobar.rb create rubocop-foobar/lib/rubocop/foobar/inject.rb create rubocop-foobar/lib/rubocop/cop/foobar_cops.rb create rubocop-foobar/config/default.yml create rubocop-foobar/spec/spec_helper.rb create rubocop-foobar/.rspec update lib/rubocop/foobar.rb update lib/rubocop/foobar.rb update lib/rubocop/foobar/version.rb update rubocop-foobar.gemspec update rubocop-foobar.gemspec update Rakefile update Gemfile It's done! You can start developing a new extension of RuboCop in rubocop-foobar. For the next step, you can use the cop generator. $ bundle exec rake 'new_cop[Foobar/SuperCoolCopName]' -
Creating gem 'rubocop-foobar'... create rubocop-foobar/Gemfile create rubocop-foobar/lib/rubocop/foobar.rb create rubocop-foobar/lib/rubocop/foobar/version.rb create
rubocop-foobar/rubocop-foobar.gemspec create rubocop-foobar/Rakefile create rubocop-foobar/README.md create rubocop-foobar/bin/console create rubocop-foobar/bin/setup create rubocop-foobar/.gitignore Initializing git repo in /tmp/tmp.Gu7G94wX00/rubocop-foobar Gem 'rubocop-foobar' was successfully created. For more information on making a RubyGem visit https://bundler.io/guides/creating_gem.html create rubocop-foobar/lib/rubocop-foobar.rb create rubocop-foobar/lib/rubocop/foobar/inject.rb create rubocop-foobar/lib/rubocop/cop/foobar_cops.rb create rubocop-foobar/config/default.yml create rubocop-foobar/spec/spec_helper.rb create rubocop-foobar/.rspec update lib/rubocop/foobar.rb update lib/rubocop/foobar.rb update lib/rubocop/foobar/version.rb update rubocop-foobar.gemspec update rubocop-foobar.gemspec update Rakefile update Gemfile It's done! You can start developing a new extension of RuboCop in rubocop-foobar. For the next step, you can use the cop generator. $ bundle exec rake 'new_cop[Foobar/SuperCoolCopName]' -
[create] lib/rubocop/cop/foo_bar/cop_name.rb ★copの実装 [create] spec/rubocop/cop/foo_bar/cop_name_spec.rb ★テストコード [modify] lib/rubocop/cop/foobar_cops.rb - `require_relative 'foo_bar/cop_name'` was
injected. [modify] A configuration for the cop is added into config/default.yml. Do 4 steps: 1. Modify the description of FooBar/CopName in config/default.yml 2. Implement your new cop in the generated file! 3. Commit your new cop with a message such as e.g. "Add new `FooBar/CopName` cop" 4. Run `bundle exec rake changelog:new` to generate a changelog entry for your new cop. -
lib/rubocop/cop/foo_bar/cop_name.rb on_{node_type} は解析時に呼ばれる コールバックメソッド。 雛形の例だと以下を解析すると2回実行される。 bad_method.bad_method $ ruby-parse -e “bad_method.bad_method"
(send (send nil :bad_method) :bad_method)