rubocul 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 450941d4c06ce5d313e3f86d1b09b08ab08b3df23e6c6c70a141122504bac941
-  data.tar.gz: 20120e021a893929d919cdf86376b717554f1fdf60ad84159f7cab1df85297f0
+  metadata.gz: d5272e1b0c785ffbd90df920558e8437537698494f99a653148d164cca52a7b7
+  data.tar.gz: a0ed2e74521e3fd37bb4d52d9616498d6f04f83d8f5d9a69cdb597bb2d8d7d1a
 SHA512:
-  metadata.gz: 7291594ff302fe7d7b4f222994782ea9cae1f38f929a2b8754ec293a1d079c85b7776bc8d308cce0fc9057d414fb8b1ca9fe268974221c4e89636d3fb62e0d9a
-  data.tar.gz: 379f38a6b19acadf599671008e9f86110ec2eecd9b4358dfbace92809010df8c496bcfbe8eb037bc157b335415ca919b432c6000b7237bbd60de2b610fe7b19c
+  metadata.gz: '08694ca5aee43a0db0343cfce44f08da39562a51c8b60323d60d5bdd11e0e1426c96ce9d484e39503c09ac3440ead6c4e01c2f945c88ec0eb578362f8a0a2816'
+  data.tar.gz: 2d341f83feb549e1a3dedb21c37701eb4919ecc0745714c06821e91a29ffc023b40dfa0b6ae164223688d5af349be82a2e37819273b58ace5fa22f1e9a8536c7

data/README.md

@@ -38,3 +38,7 @@ This project depends on `bixby`, which depends on `rubocop` and `rubocop-rspec`.
 ## Configuration Suggestion
 
 If a member of our team would like to suggest a change to our configuration, please open a github pull request with your change and an explanation of why you think it's necessary/valuable. Please add your new configuration to the `rubocop_default.yml` file.
+
+## Testing
+
+Note that testing of custom rubocop rules is not currently set up for this gem, but is planned for the future.  We have a test in the spec directory that we'll eventually want to run once tests are ready to go.

data/lib/rubocop/cop/cul/capybara_screenshots.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module CUL
+      # Do not commit specs that call `page.save_screenshot`
+      class CapybaraScreenshots < RuboCop::Cop::Cop
+        MSG = 'Remove debugging/instrumentation such as `page#save_screenshot` before committing.'
+        # This cop uses a node matcher for matching node pattern.
+        # See https://github.com/rubocop/rubocop-ast/blob/master/docs/modules/ROOT/pages/node_pattern.adoc
+        #
+        # For example
+        def_node_matcher :called_forbidden_method?, <<-PATTERN
+          (send (send nil? :page) :save_screenshot)
+        PATTERN
+
+        def on_send(node)
+          return unless called_forbidden_method?(node)
+          add_offense(node, location: :expression, message: MSG)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/cul_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'cul/capybara_screenshots'

data/lib/rubocop/cul.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative 'cop/cul_cops'

data/rubocul.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
   spec.name          = 'rubocul'
-  spec.version       = '2.0.1'
-  spec.authors       = ["Carla Galarza", "Eric O'Hanlon"]
+  spec.version       = '2.0.2'
+  spec.authors       = ["Carla Galarza", "Eric O'Hanlon", "Ben Armintor"]
 
   spec.summary       = 'A style configuration for Rubocop'
   spec.description   = 'Recommended Rubocop configuration for Ruby projects created by the Columbia University Libraries'

data/rubocul_default.yml

@@ -5,6 +5,9 @@ inherit_mode:
   merge:
     - Exclude
 
+require:
+ - ./lib/rubocop/cul.rb
+
 AllCops:
   Exclude:
     - 'app/javascript/**/*'

data/spec/rubocop/cop/cul/capybara_screenshots_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'rubocop'
+require 'rubocop/cul'
+
+RSpec.describe RuboCop::Cop::CUL::CapybaraScreenshots do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  # TODO: Write test code
+  #
+  # For example
+  it 'registers an offense when using calling `page#save_screenshot`' do
+    expect_offense(<<-RUBY.strip_indent)
+      page.save_screenshot
+      ^^^^^^^^^^^^^^^^^^^^ Remove debugging/instrumentation such as `page#save_screenshot` before committing.
+    RUBY
+  end
+
+  it 'does not register an offense when using `page#good_method`' do
+    expect_no_offenses(<<-RUBY.strip_indent)
+      page.good_method
+    RUBY
+  end
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocul
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Carla Galarza
 - Eric O'Hanlon
+- Ben Armintor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,8 +52,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/rubocop/cop/cul/capybara_screenshots.rb
+- lib/rubocop/cop/cul_cops.rb
+- lib/rubocop/cul.rb
 - rubocul.gemspec
 - rubocul_default.yml
+- spec/rubocop/cop/cul/capybara_screenshots_spec.rb
 homepage: http://github.com/cul/rubocul
 licenses: []
 metadata: {}