rubocop-vendor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 258d2b7bbbebb511c338bdd04579bae2c6e0bb7e08ae292b39dc45b27174d11b
+  data.tar.gz: 531b18092f1058d1b68c151e63dbf1e2d252601ae980b78115e72c2ad5f0464f
+SHA512:
+  metadata.gz: 0d460a6b2433b8530ae862e1fe79436c47340a45a83739253e1e89894cba05f03924e55c80c93b3d2fd5aebc7d14edd268ba8902e46c9e2a9d7adf366e9804fe
+  data.tar.gz: 11c90c0c37f76378f3c2b385bbcd1d1b20d5a0283a9a9b8023f3bf6c315953d3a05784a8b7ef20765f6da82a2c495fec5f0c046b06339d2a4746c32c26fb745d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Wealthsimple
+
+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.

data/README.md

@@ -0,0 +1,74 @@
+# RuboCop Vendor
+
+[![Gem Version](https://badge.fury.io/rb/rubocop-vendor.svg)](https://badge.fury.io/rb/rubocop-vendor)
+[![CircleCI](https://circleci.com/gh/wealthsimple/rubocop-vendor.svg?style=svg)](https://circleci.com/gh/wealthsimple/rubocop-vendor)
+
+Vendor integration analysis for your projects, as an extension to [RuboCop](https://github.com/rubocop-hq/rubocop).
+
+## Installation
+
+Just install the `rubocop-vendor` gem
+
+```sh
+gem install rubocop-vendor
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```ruby
+gem 'rubocop-vendor'
+```
+
+## Usage
+
+You need to tell RuboCop to load the Vendor extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-vendor
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Vendor
+cops together with the standard cops.
+
+### Command line
+
+```sh
+rubocop --require rubocop-vendor
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-vendor'
+end
+```
+
+## The Cops
+
+All cops are located under
+[`lib/rubocop/cop/vendor`](lib/rubocop/cop/vendor), and contain
+examples/documentation.
+
+In your `.rubocop.yml`, you may treat the Vendor cops just like any other
+cop. For example:
+
+```yaml
+Vednor/RollbarLogger:
+  Exclude:
+    - lib/example.rb
+```
+
+## Contributing
+
+Checkout the [contribution guidelines](CONTRIBUTING.md).
+
+## License
+
+`rubocop-vendor` is MIT licensed. [See the accompanying file](LICENSE) for
+the full text.

data/config/default.yml

@@ -0,0 +1,16 @@
+# This is the default configuration file.
+
+Vendor/RollbarInterpolation:
+  Description: 'Avoid interpolation to improve error grouping.'
+  Enabled: true
+  VersionAdded: '0.1.0'
+
+Vendor/RollbarLogger:
+  Description: 'Use logger instead of `Rollbar.debug`, `info` or `warning` calls.'
+  Enabled: true
+  VersionAdded: '0.1.0'
+
+Vendor/RollbarWithException:
+  Description: 'Always pass exception parameter when calling `Rollbar.error` or `critical`.'
+  Enabled: true
+  VersionAdded: '0.1.0'

data/lib/rubocop/cop/vendor/rollbar_interpolation.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Vendor
+      # This cop checks for interpolated message when calling `Rollbar.error`
+      # and suggests sending extra fields as hash parameter instead.
+      #
+      # The main reason for this suggestion is that Rollbar will have a harder
+      # time grouping messages that are dynamic.
+      #
+      # @example
+      #   # bad
+      #   Rollbar.error(e, "Unable to sync account #{account.id}")
+      #
+      #   # good
+      #   Rollbar.error(e, "Unable to sync account", account_id: account.id)
+      #
+      class RollbarInterpolation < Cop
+        MSG = 'Send extra fields as hash parameter instead of interpolated message.'
+
+        def_node_matcher :bad_method?, <<-PATTERN
+          (send
+            (const nil? :Rollbar) {:error :critical}
+            (...) $(dstr ...) ...)
+        PATTERN
+
+        def on_send(node)
+          interpolated_string = bad_method?(node)
+          return unless interpolated_string
+
+          add_offense(interpolated_string)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/vendor/rollbar_logger.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Vendor
+      # This cop checks for non-error usage of Rollbar and suggests using
+      # `Rails.logger` instead.
+      #
+      # The main reason for this suggestion is that Rollbar has a quota that is
+      # often multiple times smaller than the log quota and it may become
+      # expensive, also an error tracker should *not* be used as a logger.
+      #
+      # @example
+      #   # bad
+      #   Rollbar.info("Stale message")
+      #
+      #   # good
+      #   Rails.logger.info("Stale message")
+      #
+      class RollbarLogger < Cop
+        MSG = 'Use `Rails.logger` for `debug`, `info` or `warning` calls.'
+
+        def_node_matcher :bad_method?, <<-PATTERN
+          (send $(const nil? :Rollbar) {:debug :info :warning} ...)
+        PATTERN
+
+        def on_send(node)
+          rollbar_call = bad_method?(node)
+          return unless rollbar_call
+
+          add_offense(rollbar_call)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.expression, 'Rails.logger')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/vendor/rollbar_with_exception.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Vendor
+      # This cop checks for the exception *not* being passed when calling
+      # `Rollbar.error` or `Rollbar.critical` and suggests sending it as
+      # the first parameter.
+      #
+      # The main reason for this suggestion is that Rollbar will display the
+      # stack trace along with the error message which will be useful
+      # when debugging the issue. If the error is not needed consider using the
+      # logger instead.
+      #
+      # @example
+      #   # bad
+      #   Rollbar.error("Unable to sync account")
+      #
+      #   # good
+      #   Rollbar.error(exception, "Unable to sync account")
+      #
+      class RollbarWithException < Cop
+        include RangeHelp
+
+        MSG = 'Send exception as first parameter when calling `error` or `critical`.'
+
+        def_node_matcher :bad_method?, <<-PATTERN
+          (send
+            (const nil? :Rollbar) {:error :critical}
+            !$(lvar _)
+            ...)
+        PATTERN
+
+        def on_send(node)
+          first_param = bad_method?(node)
+          return unless first_param
+
+          begin_pos = first_param.loc.expression.begin.begin_pos
+          add_offense(first_param, location: range_between(begin_pos, begin_pos + 1))
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/vendor_cops.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module RuboCop
+end
+
+require_relative 'vendor/rollbar_interpolation'
+require_relative 'vendor/rollbar_logger'
+require_relative 'vendor/rollbar_with_exception'

data/lib/rubocop/vendor/inject.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Vendor
+    # 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)
+        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/vendor/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Vendor
+    module Version
+      STRING = '0.1.0'
+    end
+  end
+end

data/lib/rubocop/vendor.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # RuboCop Vendor project namespace
+  module Vendor
+    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-vendor.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/vendor'
+require_relative 'rubocop/vendor/version'
+require_relative 'rubocop/vendor/inject'
+
+RuboCop::Vendor::Inject.defaults!
+
+require_relative 'rubocop/cop/vendor_cops'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-vendor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danilo Cabello
+- Marco Costa
+- Osman Currim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      A collection of RuboCop cops to check for vendor integration
+      in Ruby code.
+email: foss@wealthsimple.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- config/default.yml
+- lib/rubocop-vendor.rb
+- lib/rubocop/cop/vendor/rollbar_interpolation.rb
+- lib/rubocop/cop/vendor/rollbar_logger.rb
+- lib/rubocop/cop/vendor/rollbar_with_exception.rb
+- lib/rubocop/cop/vendor_cops.rb
+- lib/rubocop/vendor.rb
+- lib/rubocop/vendor/inject.rb
+- lib/rubocop/vendor/version.rb
+homepage: https://github.com/wealthsimple/rubocop-vendor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubocop-vendor.readthedocs.io/
+  changelog_uri: https://github.com/wealthsimple/rubocop-vendor/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/wealthsimple/rubocop-vendor/
+  documentation_uri: https://rubocop-vendor.readthedocs.io/
+  bug_tracker_uri: https://github.com/wealthsimple/rubocop-vendor/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Automatic vendor integration checking tool for Ruby code.
+test_files: []