rubocop-mdsol 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92834a11847f8ca55b8c2f90149fce6a66bf68ab3786a4d9b4f85b3230ccd63f
-  data.tar.gz: 602685a360aad1801893619d31b192094530807727545d876c0365c78e6a52d5
+  metadata.gz: 9ea1fee9117692bb17d96ebfbf59955dbfd329010bf8802a65d3f45b89f238f5
+  data.tar.gz: caabfe16c4b05113edec4ace5265e7d00dd70c539e66a6a0ef4cf50e0e31bb8d
 SHA512:
-  metadata.gz: 20b149d79d773a80530631cf32e9b1e42eb39dbc65cea2ef3e43cb6695effedb1e187a94d6df0e8e81c75d754c022240cd4c58cd68ab23dacf1da08ff49b1b28
-  data.tar.gz: d5d84bfd222b879e17c71a8557b4e8b3f75921d33215138555f2d74fae4068c143daec2ed2449529263920ab49caeb5a03535d9994d77a425cb758a25e6a16df
+  metadata.gz: 1f0ddcd460d42ad310c8dd794eba171fa5895ecd6778def44faf6d4cf9dbe53d2aad2561cb3664deb52d16b08abe0be7881c6a8feb3a8a9b4fe328029bdeac0f
+  data.tar.gz: ea26682188a2187fcbb4760a6d32d70215f625e5e38c753220ad6daefeea9412c56b79b663dba36c95fb30067dbbcd0b82dc21f5a5b01917698f067e52c4b5bb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.3.0
+- Add custom cops: [`mdsol/log_with_data`](lib/rubocop/cop/mdsol/log_with_data.rb) and [`mdsol/unless_not_equal`](lib/rubocop/cop/mdsol/unless_not_equal.rb).
+- Drop Ruby 2.4, 2.5, and 2.6 support.
+
 # 0.2.0
 - Add rubocop-rspec.yml.
 

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -60,6 +60,23 @@ inherit_gem:
 # your customizations here...
 ```
 
+### Custom Cops
+
+To activate the custom cops (`mdsol/*`) shipped with this Gem:
+
+```yaml
+require: rubocop-mdsol
+
+# or using the array notation to specify multiple extensions:
+
+require:
+  - rubocop-mdsol
+  - rubocop-rails
+```
+
+All cops are located under
+[`lib/rubocop/cop/mdsol`](lib/rubocop/cop/mdsol) and contain examples/documentation.
+
 
 ## Recommended customizations
 

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+desc "Generate a new cop with a template"
+task :new_cop, [:cop] do |_task, args|
+  require "rubocop"
+
+  cop_name = args.fetch(:cop) do
+    warn "usage: bundle exec rake new_cop[Department/Name]"
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: "lib/rubocop/cop/mdsol_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
+
+  puts generator.todo
+end

data/config/default.yml

@@ -0,0 +1,9 @@
+Mdsol/LogWithData:
+  Description: Favor the `logger.<level>_with_data` method for structured logging.
+  Enabled: true
+  VersionAdded: 0.3.0
+
+Mdsol/UnlessNotEqual:
+  Description: Avoid double negative condition.
+  Enabled: true
+  VersionAdded: 0.3.0

data/lib/rubocop/cop/mdsol/log_with_data.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Mdsol
+      # Favor the logger.<level>_with_data method for structured logging.
+      #
+      # @example
+      #   # bad - string interpolations exceed the threshold (configurable via AllowedStringInterpolations setting)
+      #   Rails.logger.info("a message with more than 2 interpolations: #{foo} #{bar} #{baz}")
+      #
+      #   # bad - string interpolation contains Enumerable methods (:map, :collect)
+      #   Rails.logger.info("Deleted the following records: #{records.map(&:id)}")
+      #
+      #   # good
+      #   Rails.logger.info("a message")
+      #
+      #   # good - string interpolations are within the threshold (configurable via AllowedStringInterpolations setting)
+      #   Rails.logger.info("a message with 2 interpolations: #{foo} #{bar}")
+      #
+      #   # good
+      #   Rails.logger.info_with_data("Created the record", record_id: record.id, status: status)
+      #
+      #   # good
+      #   Rails.logger.info_with_data("Deleted the following records", record_ids: results.records.map(&:id))
+      class LogWithData < Base
+        MSG = "Use `logger.%<method>s_with_data(msg, data_hash)` instead. See https://github.com/mdsol/astinus#using-context-data-logging"
+
+        RESTRICT_ON_SEND = %i[logger debug info warn error].freeze
+        FORBIDDEN_ENUMERABLE_METHODS = %i[map collect].freeze
+        DEFAULT_STRING_INTERPOLATION_THRESHOLD = 2
+
+        # AST for code: `Rails.logger.debug("study creation request #{request} was status #{status}")`
+        # (send
+        #   (send
+        #     (const nil :Rails) :logger) :debug
+        #   (dstr
+        #     (str "study creation request ")
+        #     (begin
+        #       (send nil :request))
+        #     (str " was status ")
+        #     (begin
+        #       (send nil :status))))
+        def_node_matcher :logger_with_interpolation, <<~PATTERN
+          (send (send (const nil? $_) :logger) $_ $(dstr ...))
+        PATTERN
+
+        def on_send(node)
+          logger_with_interpolation(node) do |logger_owner, log_method, log_message|
+            return unless registered_logger_owners.include?(logger_owner.to_s)
+
+            if interpoloations_exceed_threshold?(log_message) || contain_forbidden_enumerable_method?(log_message)
+              msg = format(MSG, method: log_method.to_s)
+              add_offense(node, message: msg)
+            end
+          end
+        end
+
+        private
+
+        def registered_logger_owners
+          @registered_logger_owners ||= (["Rails"] + cop_config["LoggerOwners"].to_a).uniq
+        end
+
+        def interpoloations_exceed_threshold?(log_message_node)
+          log_message_node.child_nodes.count { |node| node.type == :begin } > string_interpolations_threshold
+        end
+
+        def string_interpolations_threshold
+          cop_config["AllowedStringInterpolations"] || DEFAULT_STRING_INTERPOLATION_THRESHOLD
+        end
+
+        def contain_forbidden_enumerable_method?(log_message_node)
+          log_message_node.each_descendant.any? do |descedant|
+            descedant.send_type? && FORBIDDEN_ENUMERABLE_METHODS.include?(descedant.method_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mdsol/unless_not_equal.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Mdsol
+      # Avoid double negative condition.
+      #
+      # @example
+      #   # bad
+      #   do_something unless a != b
+      #
+      #   # good
+      #   do_something if a == b
+      #
+      # Credit to Warut: https://github.com/mdsol/tenjin/pull/621#discussion_r748106992
+      class UnlessNotEqual < Base
+        extend AutoCorrector
+
+        MSG = "Avoid double negative. Write `%<correction>s` instead."
+
+        # AST for: `do_something unless a != b`
+        # (if
+        #   (send
+        #     (send nil :a) :!=
+        #     (send nil :b)) nil
+        #   (send nil :do_something))
+        def_node_matcher :unless_not_equal_match, <<~PATTERN
+          (if $(send $(...) :!= $(...)) ...)
+        PATTERN
+
+        def on_if(node)
+          return if node.ternary? || node.if? || node.elsif?
+
+          unless_not_equal_match(node) do |unless_body_node, left, right|
+            correction = "if #{left.source} == #{right.source}"
+            msg = format(MSG, correction: correction)
+            range = range_with_unless_modifier(unless_body_node)
+
+            add_offense(range, message: msg) do |corrector|
+              corrector.replace(range, correction)
+            end
+          end
+        end
+
+        private
+
+        def range_with_unless_modifier(unless_body_node)
+          leading_unless = "unless "
+          expand_range_to_left_by(unless_body_node, leading_unless.size)
+        end
+
+        def expand_range_to_left_by(node, length)
+          source_range = node.source_range
+          source_buffer = source_range.source_buffer
+          Parser::Source::Range.new(source_buffer, source_range.begin_pos - length, source_range.end_pos)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mdsol_cops.rb

@@ -0,0 +1,2 @@
+require_relative "mdsol/log_with_data"
+require_relative "mdsol/unless_not_equal"

data/lib/rubocop/mdsol/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Mdsol
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/mdsol/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Mdsol
+    VERSION = "0.3.0"
+  end
+end

data/lib/rubocop/mdsol.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "mdsol/version"
+
+module RuboCop
+  module Mdsol
+    class Error < StandardError; end
+    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-mdsol.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require_relative "rubocop/mdsol"
+require_relative "rubocop/mdsol/version"
+require_relative "rubocop/mdsol/inject"
+
+RuboCop::Mdsol::Inject.defaults!
+
+require_relative "rubocop/cop/mdsol_cops"

data/rubocop-mdsol.gemspec

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require_relative "lib/rubocop/mdsol/version"
+
 Gem::Specification.new do |spec|
   spec.name     = "rubocop-mdsol"
-  spec.version  = "0.2.0"
+  spec.version  = RuboCop::Mdsol::VERSION
   spec.authors  = ["Team Æ", "Team 10"]
   spec.email    = ["ae@mdsol.com", "team10@mdsol.com"]
   spec.license  = "MIT"
@@ -13,17 +15,15 @@ Gem::Specification.new do |spec|
     "changelog_uri" => "https://github.com/mdsol/rubocop-mdsol/blob/develop/CHANGELOG.md"
   }
 
-  spec.files    = Dir[
-    "CHANGELOG.md",
-    "MIT-LICENSE",
-    "README.md",
-    "rubocop-mdsol.gemspec",
-    "rubocop-rails.yml",
-    "rubocop-rspec.yml",
-    "rubocop.yml"
-  ]
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(\.|bin|spec)/)
+  end
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.7.0"
+  spec.require_paths = ["lib"]
 
   spec.add_dependency "rubocop", "~> 1.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-mdsol
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Team Æ
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -25,6 +25,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
 description: 
 email:
 - ae@mdsol.com
@@ -34,8 +76,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- Gemfile
 - MIT-LICENSE
 - README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-mdsol.rb
+- lib/rubocop/cop/mdsol/log_with_data.rb
+- lib/rubocop/cop/mdsol/unless_not_equal.rb
+- lib/rubocop/cop/mdsol_cops.rb
+- lib/rubocop/mdsol.rb
+- lib/rubocop/mdsol/inject.rb
+- lib/rubocop/mdsol/version.rb
 - rubocop-mdsol.gemspec
 - rubocop-rails.yml
 - rubocop-rspec.yml
@@ -54,14 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.15
 signing_key: 
 specification_version: 4
 summary: Base RuboCop configuration files for Ruby projects at Medidata