workitcop 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 105f11e7651eb4303dfb37311cb725b555d55f6e67699a61b59e948d2a7a4b2b
-  data.tar.gz: 93a36d5502242fdde058da0b9edc6b9746a5b7d5cd9ef1deaab4cb0590ed47ee
+  metadata.gz: 27336368b30a080fc58a6053182931a6abb0addbf3481fc19266a008ab574c3a
+  data.tar.gz: 23cbb18bc27d25f68003200c0eb505efec7200f45b4634fe32d9e69a2b72cdf5
 SHA512:
-  metadata.gz: 519e92ed299bd9a0d72d7cd56b30d4b8eaeb959122d84d5d74d6b99cac48d620b587230b5ee0b2b90903a4a9456fca11628b7270371b5892809c23392433e6d2
-  data.tar.gz: 76ce34040930118778dc28a5c53661d758b70cf0e836e8789e7ee4e532aa96a79aac5b6ff5062de55b7645b94a5a756c5bea58d8e88c675ea6e519e41112de79
+  metadata.gz: 9ed01c88aeabb5f4759e710555ba6566d248f800e7fc239ea0634f7a2d735acf6e5551c244fa81e810fc617438bb5094f33d344014300917e5c7afb1dec12d39
+  data.tar.gz: f5ff520cccd27c6d58c687b2a9bf7ab34d38c931c37dd03e6f4037831ecd56309964402301572ddd3faaab6e986fac9f3ec5e2c98488153fb9399a20beeef920

data/CHANGELOG.md

@@ -1,5 +1,16 @@
-## [Unreleased]
+# Change log
 
-## [0.1.0] - 2022-06-17
+## Unreleased
+
+## 0.2.0 - 2022-11-07
+
+- Add new `Workit/ActionArgs` cop. ([@ydah])
+- Add new `Workit/NoopRescue` cop. ([@ydah])
+
+## 0.1.0 - 2022-07-04
 
 - Initial release
+
+<!-- Contributors -->
+
+[@ydah]: https://github.com/ydah

data/CODE_OF_CONDUCT.md

@@ -10,21 +10,21 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div
 
 Examples of behavior that contributes to a positive environment for our community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -74,11 +74,11 @@ Community leaders will follow these Community Impact Guidelines in determining t
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+available at <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
-[homepage]: https://www.contributor-covenant.org
-
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
+
+[homepage]: https://www.contributor-covenant.org

data/README.md

@@ -1,4 +1,4 @@
-# Workitcop
+# Workitcop [![Gem Version](https://badge.fury.io/rb/workitcop.svg)](https://badge.fury.io/rb/workitcop) [![CI](https://github.com/ydah/workitcop/actions/workflows/ci.yml/badge.svg)](https://github.com/ydah/workitcop/actions/workflows/ci.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/77fd345a1f0e8ab706ed/maintainability)](https://codeclimate.com/github/ydah/workitcop/maintainability)
 
 Custom cops for [RuboCop](https://github.com/rubocop/rubocop).
 
@@ -6,20 +6,39 @@ Custom cops for [RuboCop](https://github.com/rubocop/rubocop).
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add workitcop
+```command
+bundle add workitcop
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install workitcop
+```command
+gem install workitcop
+```
 
 ## Usage
 
+You need to tell RuboCop to load the Workitcop extension.
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: workitcop
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
 ```yaml
-# .rubocop.yml
 require:
+  - rubocop-other-extension
   - workitcop
 ```
 
+Now you can run `rubocop` and it will automatically load the Workitcop
+cops together with the standard cops.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/default.yml

@@ -1,3 +1,28 @@
+---
+inherit_mode:
+  merge:
+    - Exclude
+
+Workit/ActionArgs:
+  Description: |
+    Check for controller action must be using `action_args`.
+  Enabled: pending
+  VersionAdded: '0.2'
+  Include:
+    - 'controllers/**/*'
+  ControllerMethods:
+    - index
+    - show
+    - create
+    - update
+    - cancel
+    - destroy
+
+Workit/NoopRescue:
+  Description: 'Check for suppress or ignore checked exception.'
+  Enabled: false
+  VersionAdded: '0.2'
+
 Workit/RestrictOnSend:
   Description: |
     Check for `RESTRICT_ON_SEND` is defined if `on_send` or `after_send` are defined.

data/lib/rubocop/cop/workit/action_args.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Workit
+      # Check for controller action must be using `action_args`.
+      #
+      # @example
+      #   # bad
+      #   class FooController
+      #     def index
+      #       # ...
+      #     end
+      #   end
+      #
+      #   # good
+      #   class FooController
+      #     def index(foo:)
+      #       # ...
+      #     end
+      #
+      #     def not_action
+      #       # ...
+      #     end
+      #   end
+      #
+      class ActionArgs < Base
+        MSG = "Consider using `action_args`."
+
+        def on_def(node)
+          add_offense(node) if !node.arguments? && controller_methods.include?(node.method_name.to_s)
+        end
+
+        private
+
+        def controller_methods
+          cop_config.fetch("ControllerMethods", [])
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/workit/noop_rescue.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Workit
+      # Check for suppress or ignore checked exception.
+      #
+      # @example
+      #   # bad
+      #   foo rescue nil
+      #
+      #   # bad
+      #   def foo
+      #     do_something
+      #   rescue StandardError => e
+      #     # no op
+      #   end
+      #
+      #   # good
+      #   foo rescue do_something
+      #
+      #   # good
+      #   def foo
+      #     do_something
+      #   rescue StandardError => e
+      #     do_something
+      #   end
+      #
+      class NoopRescue < Base
+        MSG = "Don't suppress or ignore checked exception."
+
+        # @!method send_node_include?(node)
+        def_node_search :send_node_include?, <<~PATTERN
+          (send ...)
+        PATTERN
+
+        def on_resbody(node)
+          add_offense(node) if noop?(node.body)
+        end
+
+        private
+
+        def noop?(node)
+          return true unless node
+
+          !send_node_include?(node)
+        end
+      end
+    end
+  end
+end

data/lib/workitcop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Workitcop
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/workitcop.rb

@@ -3,6 +3,8 @@
 require_relative "workitcop/inject"
 require_relative "workitcop/version"
 
+require_relative "rubocop/cop/workit/action_args"
+require_relative "rubocop/cop/workit/noop_rescue"
 require_relative "rubocop/cop/workit/restrict_on_send"
 
 module Workitcop

metadata

@@ -1,51 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: workitcop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ydah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '1.31'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '1.31'
 description:
 email:
 - t.yudai92@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
 files:
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - config/default.yml
+- lib/rubocop/cop/workit/action_args.rb
+- lib/rubocop/cop/workit/noop_rescue.rb
 - lib/rubocop/cop/workit/restrict_on_send.rb
 - lib/workitcop.rb
 - lib/workitcop/inject.rb
 - lib/workitcop/version.rb
-- sig/workitcop.rbs
-- workitcop.gemspec
 homepage: https://github.com/ydah/workitcop
 licenses:
 - MIT

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,21 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-  SuggestExtensions: false
-  NewCops: enable
-
-Layout/LineLength:
-  Enabled: false
-
-Metrics:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes

data/Gemfile

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec
-
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.21"

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/sig/workitcop.rbs

@@ -1,4 +0,0 @@
-module Workitcop
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end

data/workitcop.gemspec

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/workitcop/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "workitcop"
-  spec.version = Workitcop::VERSION
-  spec.authors = ["ydah"]
-  spec.email = ["t.yudai92@gmail.com"]
-
-  spec.summary = "Custom cops for `RuboCop`."
-  spec.homepage = "https://github.com/ydah/workitcop"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
-  spec.metadata["rubygems_mfa_required"] = "true"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.add_runtime_dependency "rubocop", ">= 1.27"
-end