rubocop-sensei 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4417b210dffcd34adf72e0699d8f8fb835da4adf6495800f61b4d20337ef1789
-  data.tar.gz: 0e52dde379f1e0f6d1bef9e6e294c8504dc07862522712edcd2162ff0170ecc0
+  metadata.gz: 8d4a1cf8bbb4e4c757fd5a37288f228f286243226a0b41e6fd5386b4395a6dda
+  data.tar.gz: bae6d9d937f300e9810d17b7b9c89e526e098dfe7a55377e6b85adb72f8fb399
 SHA512:
-  metadata.gz: 6ce15e09a41f442788be5ef73bb6612d1c2716a2860f2d1fa71b1cb8788d6ee0861039e49bdb69436a0ef1010fa0d73a8fd88ae426930795059b89c50084ebf4
-  data.tar.gz: d9cf4aab057cc1af99cb732702eb6deda38ae9c6b4763b599ab36e836ae75a5ed86266990c68adfb7b093328f81d49db74c3a5752016369c9c1d550f1f902f7c
+  metadata.gz: 40d8370cffef0daab2933942f350f5cd9c45f1ada6bdae61995d718d5fd2264edf01e64dd75b00b69b3dd8e9cb6ba3807bc33579c884a02b26e2cfcb05a8881c
+  data.tar.gz: e2124c88db4b76cb21bc2fd38a6fb17afbb227def1cacc49b97144b16905c64c0aa1f4897662a3546c6e73929b302c089341f4ecdddc03f72fc365bf93259c0a

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    rubocop-sensei (0.1.3)
+    rubocop-sensei (0.1.4)
       rubocop
+      typeprof
 
 GEM
   remote: https://rubygems.org/
@@ -22,7 +23,8 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    rbs (2.8.3)
+    regexp_parser (2.6.2)
     reline (0.3.2)
       io-console (~> 0.5)
     rexml (3.2.5)
@@ -39,19 +41,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.42.0)
+    rubocop (1.43.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      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.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
+      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)
+      rbs (>= 1.8.1)
     unicode-display_width (2.4.2)
 
 PLATFORMS

data/README.md

@@ -1,4 +1,89 @@
-# Rubocop::Sensei
+# RuboSensei
+
+- RuboSensei は書いたRuby/Railsコードに対して、より良い書き方を教えてくれるツールです
+- RuboCop gem の仕組みをつかっています
+- rubocopコマンドで良い書き方のアドバイスが表示されます
+- VSCodeプラグイン [Ruby Light](https://marketplace.visualstudio.com/items?itemName=r7kamura.vscode-ruby-light) をつかうと書いたコードのそばに表示できます
+
+![demo](demo.gif)
+
+# 使い方
+
+- Gemfile に以下を追加します。
+
+```ruby
+group :development do
+  gem "rubocop", require: false
+  gem "rubocop-sensei", require: false
+end
+```
+
+- bundle installを実行します
+  - $ bundle install
+
+- .rubocop.yml へ以下を追加します
+
+```yaml
+require:
+  - rubocop-sensei
+
+Lecture:
+  Enabled: true
+```
+
+- rubocop コマンドを実行します
+  - $ bundle exec rubocop
+
+- rubocop コマンドに `--autocorrect` オプションを渡すと、対応している項目は自動修正も行います
+  - $ bundle exec rubocop --autocorrect
+
+# 実行結果例
+
+```
+app/models/book.rb:12:5: C: Lecture/PreferMap: このeachメソッドはmapメソッドで置き換えられるかもしれません。
+
+    array.each do |x| ...
+    ^^^^^^^^^^^^^^^^^
+```
+
+# .rubocop.yml の例
+
+- もしも.rubocop.ymlがないときは、たとえば次のような内容で作成します
+- RuboCopデフォルトの検査のうちStyle, LintカテゴリだけをONにするときの.rubocop.ymlの例
+
+```
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+require:
+  - rubocop-sensei
+
+Style:
+  Enabled: true
+
+Lint:
+  Enabled: true
+
+Lecture:
+  Enabled: true
+```
+
+- RuboCopデフォルトの検査をオフにしてRuboSenseiが出力するLectureカテゴリだけをONにするときの.rubocop.ymlの例
+
+```yaml
+AllCops:
+  DisabledByDefault: true
+
+require:
+  - rubocop-sensei
+
+Lecture:
+  Enabled: true
+
+Lecture/ReplaceElsif:
+  Enabled: true
+```
 
 # License
 

data/config/default.yml

@@ -1,3 +1,18 @@
+Lecture/ExplainSymbolToProc :
+  Description: 'Explain receiver.method(&:method)'
+  Enabled: true
+  VersionAdded: '0.1.4'
+
+Lecture/PreferSymbolToProc:
+  Description: 'might be replaced with method(&:method)'
+  Enabled: true
+  VersionAdded: '0.1.4'
+
+Lecture/PreferMap:
+  Description: '`each` can be replaced with `map`'
+  Enabled: true
+  VersionAdded: '0.1.3'
+
 Lecture/ReplaceElsif:
   Description: "`elsif` can be replaced with `case`"
   Enabled: true

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lecture
+      # foo.bar(&:baz) は次のコードと同じです。
+      #
+      # foo.bar do |x|
+      #   x.baz
+      # end
+      #
+      # @example
+      #   # bad
+      #   ["a","b","c"].map do |x|
+      #     x.upcase
+      #   end
+      #
+      #   # good
+      #   ["a","b","c"].map(&:upcase)
+      #
+      class ExplainSymbolToProc  < Base
+        MSG = <<~STRING
+          foo.bar(&:baz) は次のコードと同じです。
+
+          foo.bar do |x|
+            x.baz
+          end
+        STRING
+
+        def on_send(node)
+          block_pass_potential_node = node.arguments.first
+          if block_pass_potential_node &&
+             block_pass_potential_node.type == :block_pass &&
+             block_pass_potential_node.child_nodes.first.sym_type?
+            add_offense(node)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "typeprof"
+
+module RuboCop
+  module Cop
+    module Lecture
+      # `each`メソッドは`map`メソッドで置き換えられることがあります。
+      # eachメソッドの結果、Arrayを得ているときはmapで書き換え可能かを検討してみてください。
+      #
+      # @example
+      #   # bad
+      #   result = []
+      #   [1,2,3].each do |x|
+      #     result << x * 2
+      #   end
+      #
+      #   # good
+      #   [1,2,3].map do |x|
+      #     x * 2
+      #   end
+      #
+      class PreferMap < Base
+        MSG = <<~STRING
+          この`each`メソッドは`map`メソッドで置き換えられるかもしれません。
+        STRING
+
+        # TODO: auto correct
+        def on_block(node)
+          return unless node.child_nodes.any?{|x| x.respond_to?(:method_name) && x.method_name == :each}
+
+          # mapに書き換え可能そうか
+          begin
+            map_potential_methods = [:<<, :push, :unshift]
+            node.
+              child_nodes.
+              select{|x| x.respond_to?(:method_name)}.
+              select{|x| map_potential_methods.include?(x.method_name) }.each do |map_potential_method_node|
+
+              ## map_potential_methodsのレシーバの型がArrayであるかどうかをTypeProfで調査
+              receiver_variable_name = node.child_nodes.last.receiver.node_parts.first.to_s
+              rb_text = node.parent.source
+              rb_text += "\np #{receiver_variable_name}" # TypeProf調査行
+              target_line_number = rb_text.lines.count
+              rb_files = [["target.rb", rb_text]]
+              rbs_files = []
+
+              output = StringIO.new(String.new("")) # make mutable String object
+              options = { show_errors: true }
+              config = TypeProf::ConfigData.new(rb_files: rb_files, rbs_files: rbs_files, output: output, max_sec: 5, options: options)
+              TypeProf.analyze(config)
+              #=> "# TypeProf 0.21.4\n\n# Revealed types\n#  target.rb:6 #=> Array[Integer]\n\n# Classes\n"
+              expected_type = output.string.match(/target.rb:#{target_line_number}\s*#=>\s*(.+)$/).captures.first
+              #=> Array[SomeClass] or untyped or somethings
+              if expected_type.match(/(.+)\[.+\]/).captures.first == "Array"
+                add_offense(node)
+                return
+              end
+            end
+          rescue => e
+            # 解析失敗
+            # p e
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lecture
+      # TODO: 書き換え
+      # このブロックはmethod(&:method)で置き換えられるかもしれません。
+      #
+      # @example
+      #   # bad
+      #   ["a","b","c"].map do |x|
+      #     x.upcase
+      #   end
+      #
+      #   # good
+      #   ["a","b","c"].map(&:upcase)
+      #
+      class PreferSymbolToProc < Base
+        # TODO: 追記
+        MSG = <<~STRING
+          このブロックはmethod(&:method)で置き換えられるかもしれません。
+        STRING
+
+        # TODO: auto correct
+        def on_block(node)
+          target_nodes = node.child_nodes - [node.send_node] # ブロックが渡されている主メソッドは除く
+          send_type_nodes = target_nodes.select(&:send_type?) # :begin nodeが入らず、直下にあること
+          if send_type_nodes.count == 1 && !send_type_nodes.last.arguments?
+            add_offense(node)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sensei_cops.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'lecture/prefer_symbol_to_proc'
+require_relative 'lecture/explain_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.3"
+    VERSION = "0.1.4"
   end
 end

data/lib/rubocop-sensei.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubocop'
+require 'typeprof'
 
 require_relative 'rubocop/sensei'
 require_relative 'rubocop/sensei/version'

data/rubocop-sensei.gemspec

@@ -37,5 +37,6 @@ Gem::Specification.new do |spec|
   # guide at: https://bundler.io/guides/creating_gem.html
 
   spec.add_runtime_dependency 'rubocop'
+  spec.add_runtime_dependency 'typeprof'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sensei
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Kuniaki Igarashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: typeprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "."
 email:
 - kuniaki.igarashi@garnettech373.com
@@ -39,7 +53,11 @@ files:
 - README.md
 - Rakefile
 - config/default.yml
+- demo.gif
 - lib/rubocop-sensei.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
 - lib/rubocop/cop/lecture/replace_elsif.rb
 - lib/rubocop/cop/lecture/unless_else.rb
 - lib/rubocop/cop/sensei_cops.rb
@@ -68,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.3
 signing_key:
 specification_version: 4
 summary: Rubocop Sensei