super_awesome_print_rubocop 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 461520acb72e7858ca4ef5d9b80219caba363b62
-  data.tar.gz: b1ddda0d620cc4edbedcacce7be2a68552a72496
+SHA256:
+  metadata.gz: 9dca280edee9a1f1aaba324ef718998b1004a6ee3cccf67009ef01173e7d0e64
+  data.tar.gz: '03892ad7e7e1a204d55143f3d4bd2066f5acb594e0c73fe24f4751e3c12bfcd6'
 SHA512:
-  metadata.gz: 97dc862c3ebac9da345841d325cedece02719c984e6d5861a2ac7249a90d0992b40cd8ccbaa4678f9614a745a7df27f617ec59fb97c151a4e563397361c7aa69
-  data.tar.gz: a50a78804e2e354cb87ca40b7760cc1dabd6cdaa7b6e4d591b419181d6b1dc0f0ce804dcf37d06f7a969964694ac19b76f98729aa90dfcc1160637f9c747b55c
+  metadata.gz: 6c33e17b876ff1f26c4f6c25429eb3face5f5d48e73d9eb3ec6f4a136590f9d9c88aafb1a37aba0c67889bc705f35924460c8172315cc83bf9df74c64673d3be
+  data.tar.gz: 626998f6147c729256a92834572435585bbbfe0a9b5c81cb3108a2d3065564d0340db61e2be19c2df72a822b3efa488c60665b3b789087cd8bbcbf4a43124713

data/README.md

@@ -1,48 +1,70 @@
 # SuperAwesomePrintRubocop
 
-RuboCop's cop for https://github.com/olegantonyan/super_awesome_print.
-rubocop will fail if you have `sap` in the code.
+[![CI](https://github.com/olegantonyan/super_awesome_print_rubocop/actions/workflows/ci.yml/badge.svg)](https://github.com/olegantonyan/super_awesome_print_rubocop/actions/workflows/ci.yml)
+
+A [RuboCop](https://rubocop.org) cop that flags leftover `sap` and `sapf` debug calls from [super_awesome_print](https://github.com/olegantonyan/super_awesome_print), so they don't reach production.
+
+Requires Ruby 2.7+ and RuboCop 1.0+.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'super_awesome_print_rubocop'
+gem 'super_awesome_print_rubocop', require: false
 ```
 
-And then execute:
+And then run:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+Or install it yourself:
 
     $ gem install super_awesome_print_rubocop
 
-Add this line to your `rubocop.yml`:
+Enable it in `.rubocop.yml`. On RuboCop 1.72 or newer:
 
-```ruby
-require: 'super_awesome_print_rubocop'
+```yaml
+plugins:
+  - super_awesome_print_rubocop
+```
+
+On older RuboCop:
+
+```yaml
+require:
+  - super_awesome_print_rubocop
 ```
 
 ## Usage
 
-Run `rubocop` as usual. It should fail if you have `sap` call in your code.
+Run `rubocop` as usual. It reports every `sap` or `sapf` call, including `self.sap`:
+
+```
+app/controllers/posts_controller.rb:3:3: C: SuperAwesomePrint/Avoid: Avoid sap in production.
+  sap @posts
+  ^^^^^^^^^^
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies, then `bundle exec rake test` to run the tests. Run `bin/console` for an interactive prompt.
+
+To test against a specific RuboCop version, set `RUBOCOP_VERSION` to a version requirement. Older RuboCop versions may need an older Ruby (CI runs RuboCop 1.0 on Ruby 2.7):
+
+    $ RUBOCOP_VERSION='~> 1.71.0' bundle update rubocop
+    $ RUBOCOP_VERSION='~> 1.71.0' bundle exec rake test
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, then run `bundle exec rake release`. This creates a git tag for the version, pushes git commits and tags, and pushes the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/super_awesome_print_rubocop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/olegantonyan/super_awesome_print_rubocop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the SuperAwesomePrintRubocop project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/olegantonyan/super_awesome_print_rubocop/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SuperAwesomePrintRubocop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/olegantonyan/super_awesome_print_rubocop/blob/master/CODE_OF_CONDUCT.md).

data/config/default.yml

@@ -0,0 +1,3 @@
+SuperAwesomePrint/Avoid:
+  Description: 'Checks for leftover `sap` and `sapf` debug calls.'
+  Enabled: true

data/lib/rubocop/cop/super_awesome_print/avoid.rb

@@ -1,20 +1,18 @@
-require 'rubocop'
-
 module RuboCop
   module Cop
     module SuperAwesomePrint
-      class Avoid < Cop # rubocop:disable Style/Documentation
-        MSG = 'Avoid `sap` and `sapf` in production'.freeze
+      class Avoid < Base
+        MSG = 'Avoid `%<method>s` in production.'.freeze
+        RESTRICT_ON_SEND = %i[sap sapf].freeze
 
-        def_node_matcher :sap?, <<-END
-          (send nil
-            {:sap :sapf}
-            ...)
-        END
+        def_node_matcher :sap_call?, <<-PATTERN
+          (send {nil? self} {:sap :sapf} ...)
+        PATTERN
 
         def on_send(node)
-          return unless sap?(node)
-          add_offense(node, :expression, format(MSG, node.source))
+          return unless sap_call?(node)
+
+          add_offense(node, message: format(MSG, method: node.method_name))
         end
       end
     end

data/lib/rubocop/super_awesome_print_rubocop/plugin.rb

@@ -0,0 +1,26 @@
+require 'lint_roller'
+
+module SuperAwesomePrintRubocop
+  class Plugin < LintRoller::Plugin
+    def about
+      LintRoller::About.new(
+        name: 'super_awesome_print_rubocop',
+        version: VERSION,
+        homepage: 'https://github.com/olegantonyan/super_awesome_print_rubocop',
+        description: 'Flags leftover super_awesome_print debug calls (`sap`, `sapf`).'
+      )
+    end
+
+    def supported?(context)
+      context.engine == :rubocop
+    end
+
+    def rules(_context)
+      LintRoller::Rules.new(
+        type: :path,
+        config_format: :rubocop,
+        value: File.expand_path('../../../config/default.yml', __dir__)
+      )
+    end
+  end
+end

data/lib/rubocop/super_awesome_print_rubocop/version.rb

@@ -1,3 +1,3 @@
 module SuperAwesomePrintRubocop
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/super_awesome_print_rubocop.rb

@@ -1,2 +1,4 @@
+require 'rubocop'
 require 'rubocop/super_awesome_print_rubocop/version'
+require 'rubocop/super_awesome_print_rubocop/plugin'
 require 'rubocop/cop/super_awesome_print/avoid'

metadata

@@ -1,97 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: super_awesome_print_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Oleg Antonyan
-autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: lint_roller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
+        version: '1.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ensure you do not have `sap` in production from SuperAwesomePrint gem
+description: Flags leftover `sap` and `sapf` calls from the super_awesome_print gem.
 email:
 - oleg.b.antonyan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
+- config/default.yml
 - lib/rubocop/cop/super_awesome_print/avoid.rb
+- lib/rubocop/super_awesome_print_rubocop/plugin.rb
 - lib/rubocop/super_awesome_print_rubocop/version.rb
 - lib/super_awesome_print_rubocop.rb
-- super_awesome_print_rubocop.gemspec
-homepage: http://github.com/olegantonyan/super_awesome_print_rubocop
+homepage: https://github.com/olegantonyan/super_awesome_print_rubocop
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  default_lint_roller_plugin: SuperAwesomePrintRubocop::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -99,16 +91,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
-summary: Ensure you do not have `sap` in production from SuperAwesomePrint gem
+summary: RuboCop cop that keeps super_awesome_print debug calls out of your code
 test_files: []

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.4
-before_install: gem install bundler -v 1.15.3

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at oleg.b.antonyan@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in super_awesome_print_rubocop.gemspec
-gemspec

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "super_awesome_print_rubocop"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/super_awesome_print_rubocop.gemspec

@@ -1,29 +0,0 @@
-# coding: utf-8
-lib = ::File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rubocop/super_awesome_print_rubocop/version'
-
-::Gem::Specification.new do |spec|
-  spec.name          = 'super_awesome_print_rubocop'
-  spec.version       = ::SuperAwesomePrintRubocop::VERSION
-  spec.authors       = ['Oleg Antonyan']
-  spec.email         = ['oleg.b.antonyan@gmail.com']
-
-  spec.summary       = 'Ensure you do not have `sap` in production from SuperAwesomePrint gem'
-  spec.description   = 'Ensure you do not have `sap` in production from SuperAwesomePrint gem'
-  spec.homepage      = 'http://github.com/olegantonyan/super_awesome_print_rubocop'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| ::File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-
-  spec.add_dependency 'rubocop'
-end