salsify_rubocop 0.41.0 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 958e634bf861eaef7ab87caefdd93c5b2231a845
-  data.tar.gz: eca6466c32044673f76c67d22641cc9c2ed62b59
+  metadata.gz: d574fdef745a9e334e55b58c449deb2cb1807cc9
+  data.tar.gz: dffcaa9c8811f95ee57d170e5724cdbf8543ee46
 SHA512:
-  metadata.gz: f1deff4fab86c200b20a6cef653d558efa08b453797e51a56aa6a88fcd75ac6cb3f1cab039fcb17276a143e90299e303f627a3cf45cddd907eea615f06e43f3f
-  data.tar.gz: b9872d4adce997972c1ca05247ea85b7b6285dd6386cbf193dfa9e413852122d1d86beb1a1876ae90f0c36e4ebfa38abb91c6d347c088872e176ca8f208503c4
+  metadata.gz: 159db8ad25a634d544070cac994477049711ac2409dbd339b04b8cf86942976df9892a2785bf8ef0a6a0bd13777ab386c6422e0cdbee23fe81f7ae7bc76fb6f3
+  data.tar.gz: 4cab967d8390bb8bced638ea4e9b9e7b42ef6ddc6532e48555fb14d067b04a59d7e4b15c58fd09202968f29c0e6b902a2035d77b4157c82108c20af16bf965e7

data/.rspec

@@ -1,2 +1,4 @@
+--order rand
 --format documentation
 --color
+--require spec_helper

data/.rubocop.yml

@@ -1,3 +1,6 @@
+inherit_from:
+  - conf/rubocop.yml
+
 Metrics/LineLength:
   Exclude:
     - '*.gemspec'

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+  - 2.2.4
   - 2.3.1
-before_install: gem install bundler -v 1.12.4
-
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # salsify_rubocop
 
+## v0.42.0
+- Update to RuboCop v0.42.
+- Add `Salsify/RspecDocString` cop to check quoting for examples/example groups.
+
 ## v0.41.0
 - `.ruby-version` can be used to determine TargetRubyVersion in RuboCop v0.41
 - Change to `rubocop_rails` configuration:

data/conf/rubocop.yml

@@ -1,7 +1,12 @@
 inherit_from:
   - ../conf/rubocop_without_rspec.yml
 
-require: rubocop-rspec
+require: salsify_rubocop
+
+# See https://github.com/bbatsov/rubocop/pull/3343
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
 
 RSpec/DescribeClass:
   Enabled: false

data/config/default.yml

@@ -0,0 +1,9 @@
+Salsify/RspecDocString:
+  Description: 'Check that RSpec doc strings use the correct quoting.'
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+  Include:
+    - 'spec/**/*'

data/lib/rubocop/cop/salsify/rspec_doc_string.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Salsify
+      # Check that doc strings for example groups and examples use either
+      # single-quoted or double-quoted strings based on the enforced style.
+      #
+      # This cop is disabled by default.
+      #
+      # @example
+      #
+      #   # When EnforcedStyle is double_quotes
+      #   # Good
+      #   it "does something" do
+      #     ...
+      #   end
+      #
+      #   # When EnforcedStyle is single_quotes
+      #   # Good
+      #   it 'does something' do
+      #     ...
+      #   end
+      class RspecDocString < Cop
+        include ConfigurableEnforcedStyle
+
+        SINGLE_QUOTE_MSG =
+          'Example Group/Example doc strings must be single-quoted.'.freeze
+        DOUBLE_QUOTE_MSG =
+          'Example Group/Example doc strings must be double-quoted.'.freeze
+
+        DOCUMENTED_METHODS = [
+          :example_group, :describe, :context, :xdescribe, :xcontext,
+          :it, :example, :specify, :xit, :xexample, :xspecify,
+          :feature, :scenario, :xfeature, :xscenario,
+          :fdescribe, :fcontext, :focus, :fexample, :fit, :fspecify,
+          :ffeature, :fscenario
+        ].to_set.freeze
+
+        def on_send(node)
+          _receiver, method_name, *args = *node
+          return unless DOCUMENTED_METHODS.include?(method_name) &&
+            !args.empty? && args.first.str_type?
+
+          check_quotes(args.first)
+        end
+
+        private
+
+        def check_quotes(doc_node)
+          if wrong_quotes?(doc_node)
+            if style == :single_quotes
+              add_offense(doc_node, :expression, SINGLE_QUOTE_MSG)
+            else
+              add_offense(doc_node, :expression, DOUBLE_QUOTE_MSG)
+            end
+          end
+        end
+
+        def wrong_quotes?(node)
+          src = node.source
+          return false if src.start_with?('%', '?')
+          if style == :single_quotes
+            src !~ /^'/ && !double_quotes_acceptable?(node.str_content)
+          else
+            src !~ /^" | \\ | \#/x
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            str = node.str_content
+            if style == :single_quotes
+              corrector.replace(node.source_range, to_string_literal(str))
+            else
+              corrector.replace(node.source_range, str.inspect)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/salsify_rubocop.rb

@@ -1,5 +1,16 @@
 require 'salsify_rubocop/version'
+require 'rubocop-rspec'
 
-# Top-level gem module
-module SalsifyRubocop
-end
+# Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+# bit of our configuration. Based on approach from rubocop-rspec:
+DEFAULT_FILES = File.expand_path('../../config/default.yml', __FILE__)
+
+path = File.absolute_path(DEFAULT_FILES)
+hash = RuboCop::ConfigLoader.send(:load_yaml_configuration, path)
+config = RuboCop::Config.new(hash, path)
+puts "configuration from #{DEFAULT_FILES}" if RuboCop::ConfigLoader.debug?
+config = RuboCop::ConfigLoader.merge_with_default(config, path)
+RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
+
+# cops
+require 'rubocop/cop/salsify/rspec_doc_string'

data/lib/salsify_rubocop/version.rb

@@ -1,3 +1,3 @@
 module SalsifyRubocop
-  VERSION = '0.41.0'.freeze
+  VERSION = '0.42.0'.freeze
 end

data/salsify_rubocop.gemspec

@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_runtime_dependency 'rubocop', '~> 0.41.2'
-  spec.add_runtime_dependency 'rubocop-rspec', '~> 1.5.0'
+  spec.add_runtime_dependency 'rubocop', '~> 0.42.0'
+  spec.add_runtime_dependency 'rubocop-rspec', '~> 1.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salsify_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.41.0
+  version: 0.42.0
 platform: ruby
 authors:
 - Salsify, Inc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: 0.42.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: 0.42.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.5.1
 description: Shared shared RuboCop configuration
 email:
 - engineering@salsify.com
@@ -101,6 +101,8 @@ files:
 - conf/rubocop.yml
 - conf/rubocop_rails.yml
 - conf/rubocop_without_rspec.yml
+- config/default.yml
+- lib/rubocop/cop/salsify/rspec_doc_string.rb
 - lib/salsify_rubocop.rb
 - lib/salsify_rubocop/version.rb
 - salsify_rubocop.gemspec