rubocop-sensei 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5479d9e29fc19485cd4debdeb0f6441dc444003ed7f2472227abd0e4cd95680d
-  data.tar.gz: 524580de696dc8e3c808f683c92414f083b108c06e1e5a8ae393e12d5bca6a6a
+  metadata.gz: c13f70806132906347c4d5e1f38a1f173635fe7c7d799a3734bce52e2f6ed9ea
+  data.tar.gz: 6a56681e15b4aa00effdebd37452606022d79ba1766d01c36dbba8ed2b426056
 SHA512:
-  metadata.gz: ed56878a610c3dcfd5457d1ed94303dc002dfcc95fdd699ed34ec16a732f666b87496f27ad316386550865f362f17dfb9248cf0ac72b8e4e66ce47e303555897
-  data.tar.gz: 379348550eb3a117028c506a435410d707feeee23c3150827afb98ba240ae78cff9146d36be98a1eebe8d3badc54da5c1ea98f376dfa70214970eee0ff00695f
+  metadata.gz: f91f6c01b096d5dbf77474ddb3e5e8fc2c53f535df88dff4440b04272f8094cac459733ab6050b48e0fa19d4ff4a09c7fdd5ab6aee700ceec6f9fb7ec39be544
+  data.tar.gz: 32ed8ab0037586822119e8e5c9ba5cc36f233c9808c5e433826b856155de77db93dc1d180d4c7f9cbba6221142dea4f16d5966be7525fa3a0e46b30a69a51ef9

data/.rubocop.yml

@@ -6,3 +6,9 @@ AllCops:
 Naming/FileName:
  Exclude:
    - lib/rubocop-sensei.rb
+
+require:
+  - rubocop-sensei
+
+Lecture:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Change log
+
+## 0.1.7 (2023-10-25)
+
+- Lecture/ExplainBangBang
+- Lecture/ExplainOrAssign
+- Lecture/ExplainLonelyOperator
+
+## 0.1.6 (2023-07-18)
+
+- Lecture/ExplainPatternMatchIn
+- Lecture/ExplainPatternMatchRocket
+
+## 0.1.5 (2023-07-15)
+
+- Lecture/ExplainPatternMatchCaseIn
+- Lecture/ExplainNumberedParameters
+
+## 0.1.4 (2023-01-21)
+
+- Lecture/PreferMap
+- Lecture/PreferSymbolToProc
+- Lecture/ExplainSymbolToProc
+
+## 0.1.3 (2023-01-05)
+
+- Lecture/UnlessElse
+
+## 0.1.2 (2023-01-02)
+
+- bug fix
+
+## 0.1.1 (2022-12-31)
+
+- bug fix
+
+## 0.1.0 (2022-12-30)
+
+- Initial Release
+- Lecture/ReplaceElsif

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sensei (0.1.5)
+    rubocop-sensei (0.1.7)
       rubocop
       typeprof
 
@@ -9,6 +9,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    base64 (0.1.1)
     debug (1.8.0)
       irb (>= 1.5.0)
       reline (>= 0.3.1)
@@ -20,17 +21,17 @@ GEM
     language_server-protocol (3.17.0.3)
     minitest (5.18.1)
     parallel (1.23.0)
-    parser (3.2.2.3)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
     racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rbs (3.1.0)
-    regexp_parser (2.8.1)
+    rbs (3.2.2)
+    regexp_parser (2.8.2)
     reline (0.3.6)
       io-console (~> 0.5)
-    rexml (3.2.5)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -44,23 +45,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.54.2)
+    rubocop (1.57.1)
+      base64 (~> 0.1.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.2.2.4)
       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)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
-    typeprof (0.21.7)
+    typeprof (0.21.8)
       rbs (>= 1.8.1)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -5,8 +5,13 @@
 - rubocopコマンドで良い書き方のアドバイスが表示されます
 - RuboCop に標準で入っているLSPをつかうとエディタ上で書いたコードのそばに表示できます
 
+![demo](demo.png)
 ![demo](demo.gif)
 
+# 実装されているアドバイス
+
+- [config/default.yml](config/default.yml)
+
 # つかい方
 
 ## インストール

data/config/default.yml

@@ -1,34 +1,59 @@
-Lecture/ExplainPatternMatchCaseIn:
-  Description: 'Explain pattern match case in'
+Lecture/ExplainBangBang:
+  Description: "!!variable の説明"
+  Enabled: true
+  VersionAdded: "0.1.7"
+
+Lecture/ExplainLonelyOperator:
+  Description: "&. の説明"
   Enabled: true
-  VersionAdded: '0.1.5'
+  VersionAdded: "0.1.7"
 
 Lecture/ExplainNumberedParameters:
-  Description: 'Explain numbered parameters'
+  Description: "ナンバーパラメータの説明"
   Enabled: true
-  VersionAdded: '0.1.5'
+  VersionAdded: "0.1.5"
 
-Lecture/ExplainSymbolToProc :
-  Description: 'Explain receiver.method(&:method)'
+Lecture/ExplainOrAssign:
+  Description: "||= の説明"
   Enabled: true
-  VersionAdded: '0.1.4'
+  VersionAdded: "0.1.7"
 
-Lecture/PreferSymbolToProc:
-  Description: 'might be replaced with method(&:method)'
+Lecture/ExplainPatternMatchCaseIn:
+  Description: "パターンマッチ case in の説明"
+  Enabled: true
+  VersionAdded: "0.1.5"
+
+Lecture/ExplainPatternMatchIn:
+  Description: "1行パターンマッチ in の説明"
   Enabled: true
-  VersionAdded: '0.1.4'
+  VersionAdded: "0.1.6"
+
+Lecture/ExplainPatternMatchRocket:
+  Description: "1行パターンマッチ => の説明"
+  Enabled: true
+  VersionAdded: "0.1.6"
+
+Lecture/ExplainSymbolToProc :
+  Description: "receiver.method(&:method) の説明"
+  Enabled: true
+  VersionAdded: "0.1.4"
 
 Lecture/PreferMap:
-  Description: '`each` can be replaced with `map`'
+  Description: "この each メソッドは map メソッドで書き換えられるかもしれません"
+  Enabled: true
+  VersionAdded: "0.1.4"
+
+Lecture/PreferSymbolToProc:
+  Description: "method(&:method) で書き換えられるかもしれません"
   Enabled: true
-  VersionAdded: '0.1.3'
+  VersionAdded: "0.1.4"
 
 Lecture/ReplaceElsif:
-  Description: "`elsif` can be replaced with `case`"
+  Description: "elsif は case で書き換えよう"
   Enabled: true
   VersionAdded: "0.1.0"
 
 Lecture/UnlessElse:
-  Description: "Do not use `unless` with `else`. Rewrite these with the positive case first."
+  Description: "unless else はやめて if に書き換えよう"
   Enabled: true
   VersionAdded: "0.1.3"

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lecture
+      # `!!`はオブジェクトをtrueまたはfalseに変換する書き方です。
+      # 真偽反転の!が2回つかわれていると解釈すれば意味を取りやすいです。
+      # nilまたはfalseのときはfalseへ、それ以外はtrueへ変換します。
+      # !!は必ずtrueまたはfalseに変換するので、任意のオブジェクトやnilをメソッドから返したくないときによくつかわれます。
+      # メソッド名の末尾が?で終わるメソッドはtrue/falseを返す慣習になっているので、!!が便利につかえる場面が多いです。
+      # 一方で、ifで判定するときなど、メソッドの戻り値としてつかわないときは!!をつけずにそのままつかうことが多いです。
+      #
+      # @example
+      #   # good
+      #   foo = 1
+      #   !!foo
+      #
+      class ExplainBangBang < Base
+        MSG = <<~STRING
+          `!!`はオブジェクトをtrueまたはfalseに変換する書き方です。
+          真偽反転の!が2回つかわれていると解釈すれば意味を取りやすいです。
+          nilまたはfalseのときはfalseへ、それ以外はtrueへ変換します。
+
+          !!は必ずtrueまたはfalseに変換するので、任意のオブジェクトやnilをメソッドから返したくないときによくつかわれます。
+          メソッド名の末尾が?で終わるメソッドはtrue/falseを返す慣習になっているので、!!が便利につかえる場面が多いです。
+
+          一方で、ifで判定するときなど、メソッドの戻り値としてつかわないときは!!をつけずにそのままつかうことが多いです。
+        STRING
+
+        RESTRICT_ON_SEND = %i[!].freeze
+
+        def on_send(node)
+          if node.send_type? && node.method_name == :!
+            if node.children.any?{|n| n.respond_to?(:send_type?) && n.send_type? && n.method_name == :! }
+              add_offense(node)
+              return
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lecture
+      # `&.`はレシーバのnilチェックをしてメソッド呼び出しをする演算子です。
+      # foo&.methodでは、fooがnilのときはメソッド呼び出しをせずnilを返し、fooがnil以外ではmethodメソッドを呼び出します。
+      #
+      # &.は通称「ぼっち演算子」とも呼ばれます。人が1人でひざを抱えて座っているように見えるからです。
+      #
+      # @example
+      #   # good
+      #   foo = nil
+      #   foo&.upcase #=> nil
+      #
+      #   # good
+      #   foo = "ruby"
+      #   foo&.upcase #=> "RUBY"
+      #
+      class ExplainLonelyOperator < Base
+        MSG = <<~STRING
+          `&.`はレシーバのnilチェックをしてメソッド呼び出しをする演算子です。
+          foo&.methodでは、fooがnilのときはメソッド呼び出しをせずnilを返し、fooがnil以外ではmethodメソッドを呼び出します。
+
+          &.は通称「ぼっち演算子」とも呼ばれます。人が1人でひざを抱えて座っているように見えるからです。
+        STRING
+
+        def on_csend(node)
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lecture
+      # `foo ||= 1` は変数fooがnilまたはfalseのときに変数fooへ1を代入し、それ以外のときは何もしません。
+      # 変数 ||= 初期値 という形で初期化時によくつかわれます。
+      #
+      # `foo ||= 1` は `foo = foo || 1` と同じです。
+      # || は最初の項がnilまたはfalseのときだけ2項目を戻り値にして、それ以外のときは最初の項を戻り値にします。
+      #
+      # @example
+      #   # good
+      #   foo = 555
+      #   foo ||= 1
+      #   p foo #=> 555
+      #
+      #   foo = nil
+      #   foo ||= 1
+      #   p foo #=> 1
+      #
+      #   # bad
+      #   foo = false
+      #   foo ||= true
+      #   p foo #=> true # 既に代入済みのfalseが上書きされてしまった
+      #
+      class ExplainOrAssign < Base
+        MSG = <<~STRING
+          `foo ||= 1` は変数fooがnilまたはfalseのときに変数fooへ1を代入し、それ以外のときは何もしません。
+          変数 ||= 初期値 という形で初期化時によくつかわれます。
+
+          `foo ||= 1` は `foo = foo || 1` と同じです。
+          || は最初の項がnilまたはfalseのときだけ2項目を戻り値にして、それ以外のときは最初の項を戻り値にします。
+
+          ざっくりと
+          「変数に何か入っていたらそのまま、何も入っていなかったら||=の右に書かれたオブジェクトを初期値としてつかう」
+          と考えると覚えやすいかもしれません。
+
+          ただし、falseやnilを初期値につかうときは気をつけてください。
+          事前に意図的にfalseやnilが代入されているときにも代入されるので、意図しない動作になるかもしれません。
+        STRING
+
+        def on_or_asgn(node)
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lecture
+      # 1行パターンマッチです。
+      # [1,2,3] in [x,y,3]
+      # p x #=> 1
+      # p y #=> 2
+      # inの右側には変数入りのパターンを書くことができ、左側と対応させ、それぞれの変数に代入します。
+      #
+      # @example
+      #   # good
+      #   5 => x
+      #   p x #=> 5
+      #
+      #   # good
+      #   [1,2,3] in [x,y,3]
+      #   p x #=> 1
+      #   p y #=> 2
+      #
+      class ExplainPatternMatchIn < Base
+        MSG = <<~STRING
+          1行パターンマッチです。
+          inの右側には変数入りのパターンを書くことができ、左側と対応させ、それぞれの変数に代入します。
+
+          [1,2,3] in [x,y,3]
+          p x #=> 1
+          p y #=> 2
+
+          5 in x
+          p x #=> 5
+        STRING
+
+        def on_match_pattern_p(node)
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lecture
+      # 1行パターンマッチです。
+      # [1,2,3] => [x,y,3]
+      # p x #=> 1
+      # p y #=> 2
+      # =>の右側には変数入りのパターンを書くことができ、左側と対応させ、それぞれの変数に代入します。
+      #
+      # @example
+      #   # good
+      #   5 => x
+      #   p x #=> 5
+      #
+      #   # good
+      #   [1,2,3] => [x,y,3]
+      #   p x #=> 1
+      #   p y #=> 2
+      #
+      class ExplainPatternMatchRocket < Base
+        MSG = <<~STRING
+          1行パターンマッチです。
+          =>の右側には変数入りのパターンを書くことができ、左側と対応させ、それぞれの変数に代入します。
+
+          [1,2,3] => [x,y,3]
+          p x #=> 1
+          p y #=> 2
+
+          5 => x
+          p x #=> 5
+        STRING
+
+        def on_match_pattern(node)
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sensei_cops.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
+require_relative 'lecture/explain_bang_bang'
+require_relative 'lecture/explain_lonely_operator'
 require_relative 'lecture/explain_numbered_parameters'
+require_relative 'lecture/explain_or_assign'
 require_relative 'lecture/explain_pattern_match_case_in'
-require_relative 'lecture/prefer_symbol_to_proc'
+require_relative 'lecture/explain_pattern_match_in'
+require_relative 'lecture/explain_pattern_match_rocket'
 require_relative 'lecture/explain_symbol_to_proc'
+require_relative 'lecture/prefer_symbol_to_proc'
 require_relative 'lecture/prefer_map'
 require_relative 'lecture/replace_elsif'
 require_relative 'lecture/unless_else'

data/lib/rubocop/sensei/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sensei
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Kuniaki Igarashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-15 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -47,17 +47,23 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- 'LICENSE '
 - LICENSE.txt
 - README.md
 - Rakefile
 - config/default.yml
 - demo.gif
+- demo.png
 - lib/rubocop-sensei.rb
+- lib/rubocop/cop/lecture/explain_bang_bang.rb
+- lib/rubocop/cop/lecture/explain_lonely_operator.rb
 - lib/rubocop/cop/lecture/explain_numbered_parameters.rb
+- lib/rubocop/cop/lecture/explain_or_assign.rb
 - lib/rubocop/cop/lecture/explain_pattern_match_case_in.rb
+- lib/rubocop/cop/lecture/explain_pattern_match_in.rb
+- lib/rubocop/cop/lecture/explain_pattern_match_rocket.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
@@ -93,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.16
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Rubocop Sensei

data/LICENSE

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright 2022 Kuniaki Igarashi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.