rubocop-sensei 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5479d9e29fc19485cd4debdeb0f6441dc444003ed7f2472227abd0e4cd95680d
-  data.tar.gz: 524580de696dc8e3c808f683c92414f083b108c06e1e5a8ae393e12d5bca6a6a
+  metadata.gz: 47bef4bcd3ea0dc376372709a49308840b766ca216fcb05017f4a6900c31dd83
+  data.tar.gz: f2b90b2573cf06ac25b91a44f150038d9343e6a020e63a5cc65e7a7b246ba569
 SHA512:
-  metadata.gz: ed56878a610c3dcfd5457d1ed94303dc002dfcc95fdd699ed34ec16a732f666b87496f27ad316386550865f362f17dfb9248cf0ac72b8e4e66ce47e303555897
-  data.tar.gz: 379348550eb3a117028c506a435410d707feeee23c3150827afb98ba240ae78cff9146d36be98a1eebe8d3badc54da5c1ea98f376dfa70214970eee0ff00695f
+  metadata.gz: ad93f37ce2557726a5594662eb38fd4d75946cc2d46ba7673c602ee8353dfc1c565e633ab76d4088521b6f1d1dcb6fe64b9ab98111aa9ffdf323be1bb4ddaf05
+  data.tar.gz: 4bc4eac17a618626da23e88f7fe31f6d31b02ce766459145acdc23c8418c494ca0abce72e64862b9da861878ef2d66e3015903c8b749df76e207c6d04b4bc930

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,34 @@
+# Change log
+
+## 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.6)
       rubocop
       typeprof
 

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,44 @@
+Lecture/ExplainNumberedParameters:
+  Description: "ナンバーパラメータの説明"
+  Enabled: true
+  VersionAdded: "0.1.5"
+
 Lecture/ExplainPatternMatchCaseIn:
-  Description: 'Explain pattern match case in'
+  Description: "パターンマッチ case in の説明"
   Enabled: true
-  VersionAdded: '0.1.5'
+  VersionAdded: "0.1.5"
 
-Lecture/ExplainNumberedParameters:
-  Description: 'Explain numbered parameters'
+Lecture/ExplainPatternMatchIn:
+  Description: "1行パターンマッチ in の説明"
   Enabled: true
-  VersionAdded: '0.1.5'
+  VersionAdded: "0.1.6"
 
-Lecture/ExplainSymbolToProc :
-  Description: 'Explain receiver.method(&:method)'
+Lecture/ExplainPatternMatchRocket:
+  Description: "1行パターンマッチ => の説明"
   Enabled: true
-  VersionAdded: '0.1.4'
+  VersionAdded: "0.1.6"
 
-Lecture/PreferSymbolToProc:
-  Description: 'might be replaced with method(&:method)'
+Lecture/ExplainSymbolToProc :
+  Description: "receiver.method(&:method) の説明"
   Enabled: true
-  VersionAdded: '0.1.4'
+  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_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

@@ -2,6 +2,8 @@
 
 require_relative 'lecture/explain_numbered_parameters'
 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_map'

data/lib/rubocop/sensei/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Sensei
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   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.6
 platform: ruby
 authors:
 - Kuniaki Igarashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-15 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -47,17 +47,20 @@ 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_numbered_parameters.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

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.