rubocop-sensei 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47bef4bcd3ea0dc376372709a49308840b766ca216fcb05017f4a6900c31dd83
-  data.tar.gz: f2b90b2573cf06ac25b91a44f150038d9343e6a020e63a5cc65e7a7b246ba569
+  metadata.gz: c13f70806132906347c4d5e1f38a1f173635fe7c7d799a3734bce52e2f6ed9ea
+  data.tar.gz: 6a56681e15b4aa00effdebd37452606022d79ba1766d01c36dbba8ed2b426056
 SHA512:
-  metadata.gz: ad93f37ce2557726a5594662eb38fd4d75946cc2d46ba7673c602ee8353dfc1c565e633ab76d4088521b6f1d1dcb6fe64b9ab98111aa9ffdf323be1bb4ddaf05
-  data.tar.gz: 4bc4eac17a618626da23e88f7fe31f6d31b02ce766459145acdc23c8418c494ca0abce72e64862b9da861878ef2d66e3015903c8b749df76e207c6d04b4bc930
+  metadata.gz: f91f6c01b096d5dbf77474ddb3e5e8fc2c53f535df88dff4440b04272f8094cac459733ab6050b48e0fa19d4ff4a09c7fdd5ab6aee700ceec6f9fb7ec39be544
+  data.tar.gz: 32ed8ab0037586822119e8e5c9ba5cc36f233c9808c5e433826b856155de77db93dc1d180d4c7f9cbba6221142dea4f16d5966be7525fa3a0e46b30a69a51ef9

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## 0.1.7 (2023-10-25)
+
+- Lecture/ExplainBangBang
+- Lecture/ExplainOrAssign
+- Lecture/ExplainLonelyOperator
+
 ## 0.1.6 (2023-07-18)
 
 - Lecture/ExplainPatternMatchIn

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sensei (0.1.6)
+    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/config/default.yml

@@ -1,8 +1,23 @@
+Lecture/ExplainBangBang:
+  Description: "!!variable の説明"
+  Enabled: true
+  VersionAdded: "0.1.7"
+
+Lecture/ExplainLonelyOperator:
+  Description: "&. の説明"
+  Enabled: true
+  VersionAdded: "0.1.7"
+
 Lecture/ExplainNumberedParameters:
   Description: "ナンバーパラメータの説明"
   Enabled: true
   VersionAdded: "0.1.5"
 
+Lecture/ExplainOrAssign:
+  Description: "||= の説明"
+  Enabled: true
+  VersionAdded: "0.1.7"
+
 Lecture/ExplainPatternMatchCaseIn:
   Description: "パターンマッチ case in の説明"
   Enabled: true
@@ -39,6 +54,6 @@ Lecture/ReplaceElsif:
   VersionAdded: "0.1.0"
 
 Lecture/UnlessElse:
-  Description: "unless else はやめてif に書き換えよう"
+  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/sensei_cops.rb

@@ -1,11 +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/explain_pattern_match_in'
 require_relative 'lecture/explain_pattern_match_rocket'
-require_relative 'lecture/prefer_symbol_to_proc'
 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.6"
+    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.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Kuniaki Igarashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -57,7 +57,10 @@ files:
 - 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
@@ -96,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