rubocop-sensei 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d4a1cf8bbb4e4c757fd5a37288f228f286243226a0b41e6fd5386b4395a6dda
-  data.tar.gz: bae6d9d937f300e9810d17b7b9c89e526e098dfe7a55377e6b85adb72f8fb399
+  metadata.gz: 5479d9e29fc19485cd4debdeb0f6441dc444003ed7f2472227abd0e4cd95680d
+  data.tar.gz: 524580de696dc8e3c808f683c92414f083b108c06e1e5a8ae393e12d5bca6a6a
 SHA512:
-  metadata.gz: 40d8370cffef0daab2933942f350f5cd9c45f1ada6bdae61995d718d5fd2264edf01e64dd75b00b69b3dd8e9cb6ba3807bc33579c884a02b26e2cfcb05a8881c
-  data.tar.gz: e2124c88db4b76cb21bc2fd38a6fb17afbb227def1cacc49b97144b16905c64c0aa1f4897662a3546c6e73929b302c089341f4ecdddc03f72fc365bf93259c0a
+  metadata.gz: ed56878a610c3dcfd5457d1ed94303dc002dfcc95fdd699ed34ec16a732f666b87496f27ad316386550865f362f17dfb9248cf0ac72b8e4e66ce47e303555897
+  data.tar.gz: 379348550eb3a117028c506a435410d707feeee23c3150827afb98ba240ae78cff9146d36be98a1eebe8d3badc54da5c1ea98f376dfa70214970eee0ff00695f

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   NewCops: enable
   SuggestExtensions: false
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 Naming/FileName:
  Exclude:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sensei (0.1.4)
+    rubocop-sensei (0.1.5)
       rubocop
       typeprof
 
@@ -9,52 +9,56 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    debug (1.7.1)
+    debug (1.8.0)
       irb (>= 1.5.0)
       reline (>= 0.3.1)
     diff-lcs (1.5.0)
     io-console (0.6.0)
-    irb (1.6.2)
-      reline (>= 0.3.0)
+    irb (1.7.3)
+      reline (>= 0.3.6)
     json (2.6.3)
-    minitest (5.17.0)
-    parallel (1.22.1)
-    parser (3.2.0.0)
+    language_server-protocol (3.17.0.3)
+    minitest (5.18.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rbs (2.8.3)
-    regexp_parser (2.6.2)
-    reline (0.3.2)
+    rbs (3.1.0)
+    regexp_parser (2.8.1)
+    reline (0.3.6)
       io-console (~> 0.5)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.43.0)
+    rspec-support (3.12.1)
+    rubocop (1.54.2)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    typeprof (0.21.4)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    typeprof (0.21.7)
       rbs (>= 1.8.1)
     unicode-display_width (2.4.2)
 

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2023 Kuniaki Igarashi
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,13 +1,15 @@
 # RuboSensei
 
 - RuboSensei は書いたRuby/Railsコードに対して、より良い書き方を教えてくれるツールです
-- RuboCop gem の仕組みをつかっています
+- RuboCop Gem の仕組みをつかっています
 - rubocopコマンドで良い書き方のアドバイスが表示されます
-- VSCodeプラグイン [Ruby Light](https://marketplace.visualstudio.com/items?itemName=r7kamura.vscode-ruby-light) をつかうと書いたコードのそばに表示できます
+- RuboCop に標準で入っているLSPをつかうとエディタ上で書いたコードのそばに表示できます
 
 ![demo](demo.gif)
 
-# 使い方
+# つかい方
+
+## インストール
 
 - Gemfile に以下を追加します。
 
@@ -31,13 +33,15 @@ Lecture:
   Enabled: true
 ```
 
+## rubocopコマンドからつかう
+
 - rubocop コマンドを実行します
   - $ bundle exec rubocop
 
 - rubocop コマンドに `--autocorrect` オプションを渡すと、対応している項目は自動修正も行います
   - $ bundle exec rubocop --autocorrect
 
-# 実行結果例
+- 実行結果例
 
 ```
 app/models/book.rb:12:5: C: Lecture/PreferMap: このeachメソッドはmapメソッドで置き換えられるかもしれません。
@@ -46,10 +50,23 @@ app/models/book.rb:12:5: C: Lecture/PreferMap: このeachメソッドはmapメ
     ^^^^^^^^^^^^^^^^^
 ```
 
-# .rubocop.yml の例
+## VSCode で書いているコード上にアドバイスする
+
+- VSCode で書いているコード上でリアルタイムにアドバイスを表示できます
+  - RuboCopに標準で入っているLSP機能と、VSCode拡張 vscode-rubocop をつかいます
+- VSCode拡張 vscode-rubocop をVSCodeへインストールして有効にします
+  - https://marketplace.visualstudio.com/items?itemName=rubocop.vscode-rubocop
+- rubocopコマンドが実行可能になっていれば、自動でRuboCopを実行して結果を表示します
+  - 手動でLSPを起動するコマンドを実行する必要はありません
+
+# .rubocop.yml の書き方例
+
+- RuboSenseiのアドバイスはLectureカテゴリとしてまとめられています
 
-- もしも.rubocop.ymlがないときは、たとえば次のような内容で作成します
-- RuboCopデフォルトの検査のうちStyle, LintカテゴリだけをONにするときの.rubocop.ymlの例
+## プロジェクトの.rubocop.ymlがないとき
+
+- たとえば次のような内容で作成します
+- RuboCopデフォルトの検査のうちStyle, LintカテゴリだけをONにして、RuboSenseiのアドバイス(Lectureカテゴリ)をONにするときの.rubocop.ymlの例
 
 ```
 AllCops:
@@ -69,7 +86,7 @@ Lecture:
   Enabled: true
 ```
 
-- RuboCopデフォルトの検査をオフにしてRuboSenseiが出力するLectureカテゴリだけをONにするときの.rubocop.ymlの例
+- RuboCopデフォルトの検査をオフにしてRuboSenseiのアドバイス(Lectureカテゴリ)をONにするときの.rubocop.ymlの例
 
 ```yaml
 AllCops:
@@ -85,6 +102,44 @@ Lecture/ReplaceElsif:
   Enabled: true
 ```
 
+## プロジェクトの.rubocop.ymlがあるとき
+
+- require設定に rubocop-sensei を追加します
+
+```yaml
+require:
+  - rubocop-sensei
+```
+
+- カテゴリ設定に Lecture を有効にする設定を追加します
+
+```yaml
+Lecture:
+  Enabled: true
+```
+
+## アドバイスを非表示にするとき
+
+- RuboSenseiのアドバイス表示時に書かれている名前を指定してEnabled: false設定を追記します
+
+```yaml
+Lecture:
+  Enabled: true
+
+Lecture/ReplaceElsif:
+  Enabled: false
+```
+
+- 全アドバイスをオフにするときはLectureカテゴリをEnabled: falseにします
+  - または、Lectureカテゴリの設定を削除します
+
+```yaml
+Lecture:
+  Enabled: false
+```
+
 # License
 
-MIT
+- Apache License Version 2.0
+  - https://www.apache.org/licenses/LICENSE-2.0
+- (RuboSensei v0.1.4 まではMITライセンス)

data/config/default.yml

@@ -1,3 +1,13 @@
+Lecture/ExplainPatternMatchCaseIn:
+  Description: 'Explain pattern match case in'
+  Enabled: true
+  VersionAdded: '0.1.5'
+
+Lecture/ExplainNumberedParameters:
+  Description: 'Explain numbered parameters'
+  Enabled: true
+  VersionAdded: '0.1.5'
+
 Lecture/ExplainSymbolToProc :
   Description: 'Explain receiver.method(&:method)'
   Enabled: true

data/lib/rubocop/cop/lecture/explain_numbered_parameters.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lecture
+      # foo.bar{ _1.baz } は foo.bar{|x| x.baz } と同じです。
+      # _1と書くことで、||で囲まれたブロック変数を書かずに短く書けます。
+      # ナンバーパラメータと呼ばれます。
+      # _1, _2, _3, ... と複数書くこともできます。
+      # foo.bar{ [_1,_2] } は foo.bar{|x,y| [x,y] }と同じです。
+      #
+      # @example
+      #   # good
+      #   foo.bar{ _1.baz }
+      #
+      #   # good
+      #   foo.bar{|x| x.baz }
+      #
+      class ExplainNumberedParameters < Base
+        MSG = <<~STRING
+          foo.bar{ _1.baz } は foo.bar{|x| x.baz } と同じです。
+          _1と書くことで、||で囲まれたブロック変数を書かずに短く書けます。
+          ナンバーパラメータと呼ばれます。
+          _1, _2, _3, ... と複数書くこともできます。
+          foo.bar{ [_1,_2] } は foo.bar{|x,y| [x,y] }と同じです。
+        STRING
+
+        def on_numblock(node)
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/lecture/explain_pattern_match_case_in.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lecture
+      # case in はパターンマッチ構文です。次のようにつかいます。
+      # case [1,2,3]
+      # in [x,2,3]
+      # end
+      # p x #=> 1
+      # caseにつづけて書いた式（この例では [1,2,3] ）を実行して、結果とマッチするものをin節に書いたパターン群から探します。
+      # in節には変数入りのパターンを書くことができ、caseにつづけて書いた式の結果とパターンとを対応させ、それぞれの変数に代入します。
+      #
+      # 便利なケースは、深いハッシュや配列にマッチさせるときや、複数の変数に代入するときです。
+      # case { a: [1,2,3], b: { c: 10 }}
+      # in { a: [x,2,3], b: { c: y }}
+      # end
+      # p x #=> 1
+      # p y #=> 10
+      #
+      # @example
+      #   # good
+      #   case [1,2,3]
+      #   in [x,2,3]
+      #   in [x,5,6]
+      #   end
+      #
+      class ExplainPatternMatchCaseIn < Base
+        MSG = <<~STRING
+          case in はパターンマッチ構文です。次のようにつかいます。
+          case [1,2,3]
+          in [x,2,3]
+          end
+          p x #=> 1
+          caseにつづけて書いた式（例では [1,2,3] ）を実行して、結果とマッチするものをin節に書いたパターン群から探します。
+          in節には変数入りのパターンを書くことができ、caseにつづけて書いた式の結果とパターンとを対応させ、それぞれの変数に代入します。
+        STRING
+
+        # 1行inでは呼ばれないことを確認済み
+        def on_case_match(node)
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/lecture/explain_symbol_to_proc.rb

@@ -10,7 +10,7 @@ module RuboCop
       # end
       #
       # @example
-      #   # bad
+      #   # good
       #   ["a","b","c"].map do |x|
       #     x.upcase
       #   end

data/lib/rubocop/cop/sensei_cops.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'lecture/explain_numbered_parameters'
+require_relative 'lecture/explain_pattern_match_case_in'
 require_relative 'lecture/prefer_symbol_to_proc'
 require_relative 'lecture/explain_symbol_to_proc'
 require_relative 'lecture/prefer_map'

data/lib/rubocop/sensei/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Sensei
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

data/rubocop-sensei.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Rubocop Sensei"
   spec.description = "."
   spec.homepage = "https://github.com/igaiga/rubocop-sensei"
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 

data/sample/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  DisabledByDefault: true
+
+require:
+  - rubocop-sensei
+
+Lecture:
+  Enabled: true

data/sample/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "rubocop", require: false
+gem "rubocop-sensei", require: false

data/sample/Gemfile.lock

@@ -0,0 +1,41 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rbs (3.0.4)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-sensei (0.1.4)
+      rubocop
+      typeprof
+    ruby-progressbar (1.13.0)
+    typeprof (0.21.7)
+      rbs (>= 1.8.1)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  rubocop
+  rubocop-sensei
+
+BUNDLED WITH
+   2.4.10

data/sample/target.rb

@@ -0,0 +1,4 @@
+result = []
+a.each do |x|
+  result << x * 2
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sensei
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Kuniaki Igarashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-21 00:00:00.000000000 Z
+date: 2023-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -50,11 +50,14 @@ files:
 - Gemfile
 - Gemfile.lock
 - 'LICENSE '
+- LICENSE.txt
 - README.md
 - Rakefile
 - config/default.yml
 - demo.gif
 - lib/rubocop-sensei.rb
+- lib/rubocop/cop/lecture/explain_numbered_parameters.rb
+- lib/rubocop/cop/lecture/explain_pattern_match_case_in.rb
 - lib/rubocop/cop/lecture/explain_symbol_to_proc.rb
 - lib/rubocop/cop/lecture/prefer_map.rb
 - lib/rubocop/cop/lecture/prefer_symbol_to_proc.rb
@@ -65,6 +68,10 @@ files:
 - lib/rubocop/sensei/inject.rb
 - lib/rubocop/sensei/version.rb
 - rubocop-sensei.gemspec
+- sample/.rubocop.yml
+- sample/Gemfile
+- sample/Gemfile.lock
+- sample/target.rb
 - sig/rubocop/sensei.rbs
 homepage: https://github.com/igaiga/rubocop-sensei
 licenses: []
@@ -79,14 +86,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.3
+rubygems_version: 3.4.16
 signing_key:
 specification_version: 4
 summary: Rubocop Sensei