ezcater_rubocop 0.49.0 → 0.49.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 658b94f333cbe3db4ea125c96c9d48c5ea6f3872
-  data.tar.gz: e158a117e5a495d8e53654a16ff1ff52b23afaa9
+  metadata.gz: 77cb533aad14aeabbd81a2a067bc9e3a9c72b534
+  data.tar.gz: 1ffeb88c423c859677da81bf193aa4ef1d235e0f
 SHA512:
-  metadata.gz: 585116a2b06053cbea60115c7b7bd084de93937944efbcc41cb36880636bb87a06d3bd553ee55beb9a2bd90d508959542122a15a58b2aa83c090e7224b72916d
-  data.tar.gz: 8606ce62bfbb88ae21ee33caec361be270f74b312ac7bbfe6e590b34f3254298e7a228ed3623516a09714c0aa4d0f41d34b25ce26ec5f0944962faed6f5e3f48
+  metadata.gz: 94b5280e3f83fbd4b25c6561894d832545377dc663eb809b13d857e9a5602cea32e4c6442140f4ca37859938b90d69b9bef5b93c8fd4f8945275ebf0e9c7b9ca
+  data.tar.gz: 1ad03213dda42ab4b510e8e2886c7b6b047abb06adc4859d517d96ed0a48870522ab04f5497c3efb983ee750282f071a8f6b55c3a9698fea04f6469517e01a4e

data/.circleci/config.yml

@@ -0,0 +1,46 @@
+version: 2
+jobs:
+  build:
+    parallelism: 1
+    working_directory: ~/ezcater
+    docker:
+      - image: circleci/ruby:2.3.3
+    steps:
+      - checkout
+
+      # Restore bundle cache
+      - restore_cache:
+          keys:
+            - ruby-cache-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "ezcater_rubocop.gemspec" }}
+            - ruby-cache-{{ .Branch }}-
+            - ruby-cache-
+
+      # Bundle install dependencies
+      - run: gem install bundler --no-document
+      - run: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+      - run: bundle clean --force
+
+      # Store bundle cache
+      - save_cache:
+          key: ruby-cache-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "ezcater_rubocop.gemspec" }}
+          paths:
+            - vendor/bundle
+
+      # Run Rubocop
+      - run:
+          name: RuboCop
+          command: bundle exec rubocop
+
+      # Run rspec in parallel
+      - type: shell
+        command: |
+          bundle exec rspec --profile 10 \
+                            --format RspecJunitFormatter \
+                            --out test_results/rspec.xml \
+                            --format progress
+
+      # Save test results for timing analysis
+      - store_test_results:
+          path: test_results
+      - store_test_results:
+          path: tmp/capybara

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # ezcater_rubocop
 
+# v0.49.1
+- Add `Ezcater/RspecRequireBrowserMock` cop.
+
 # v0.49.0
 - Initial release.
 - Add `Ezcater/RspecRequireFeatureFlagMock` cop.

data/README.md

@@ -48,7 +48,8 @@ is updated.
 
 ## Custom Cops
 1. [RspecDotNotSelfDot](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rspec_dot_not_self_dot.rb) - Enforce ".<class method>" instead of "self.<class method>" for example group description.
-1. [RspecRequireFeatureFlagMock](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb) - Enforces consumers to user custom `mock_feature_flag` helpers when writing tests that require turning `FeatureFlag` functionality on and off.
+1. [RspecRequireBrowserMock](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rspec_require_browser_mock.rb) - Enforce use of `mock_ezcater_app`, `mock_chrome_browser` & `mock_custom_browser` helpers instead of mocking `Browser` or `EzBrowser` directly.
+1. [RspecRequireFeatureFlagMock](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb) - Enforce use of `mock_feature_flag` helper instead of mocking `FeatureFlag.is_active?` directly.
 1. [StyleDig](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/style_dig.rb) - Recommend `dig` for deeply nested access.
 
 ## Development

data/config/default.yml

@@ -4,6 +4,12 @@ Ezcater/RspecDotNotSelfDot:
   Include:
     - '**/*_spec.rb'
 
+Ezcater/RspecRequireBrowserMock:
+  Description: 'Enforce use of `mock_ezcater_app`, `mock_chrome_browser` & `mock_custom_browser` helpers instead of mocking `Browser` or `EzBrowser` directly.'
+  Enabled: true
+  Include:
+    - '**/*_spec.rb'
+
 Ezcater/RspecRequireFeatureFlagMock:
   Description: 'Enforce use of `mock_feature_flag` helpers instead of mocking `FeatureFlag.is_active?` directly.'
   Enabled: true

data/ezcater_rubocop.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "pry-byebug"
 
   spec.add_runtime_dependency "rubocop", "~> 0.49.1"

data/lib/ezcater_rubocop/version.rb

@@ -1,3 +1,3 @@
 module EzcaterRubocop
-  VERSION = "0.49.0".freeze
+  VERSION = "0.49.1".freeze
 end

data/lib/ezcater_rubocop.rb

@@ -12,6 +12,7 @@ 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)
 
+require "rubocop/cop/ezcater/rspec_require_browser_mock"
 require "rubocop/cop/ezcater/rspec_require_feature_flag_mock"
 require "rubocop/cop/ezcater/rspec_dot_not_self_dot"
 require "rubocop/cop/ezcater/style_dig"

data/lib/rubocop/cop/ezcater/rspec_require_browser_mock.rb

@@ -0,0 +1,55 @@
+module RuboCop
+  module Cop
+    module Ezcater
+      # Enforce use of `mock_ezcater_app`, `mock_chrome_browser` & `mock_custom_browser` helpers
+      # instead of mocking `Browser` or `EzBrowser` directly.
+      #
+      # @example
+      #
+      #   # good
+      #   mock_ezcater_app
+      #   mock_chrome_browser
+      #   mock_custom_browser
+      #   mock_ezcater_app(device: "My Device", version: "1.2.3", language: "en=US,en")
+      #   mock_chrome_browser(device: "My Device", version: "1.2.3", language: "en=US,en")
+      #   mock_custom_browser(user_agent: "My Custom Agent", language: "en=US,en")
+      #
+      #   # bad
+      #   allow(Browser).to receive...
+      #   allow(EzBrowser).to receive...
+      class RspecRequireBrowserMock < Cop
+        MSG = "Use the mocks provided by `BrowserHelpers` instead of mocking `%s`".freeze
+
+        def_node_matcher :browser_const?, <<~PATTERN
+          (const _ {:Browser, :EzBrowser})
+        PATTERN
+
+        def on_const(node)
+          return unless browser_const?(node) && node.descendants.empty?
+
+          # Walk to send node where method = :allow
+          match_node = node
+          match_node = match_node.parent while not_allow_send_node?(match_node.parent)
+          match_node = match_node.parent
+
+          # Validate send node, method = :allow; could have never been found
+          return unless allow_send_node?(match_node)
+
+          # Finish tree navigation to full line for highlighting
+          match_node = match_node.parent while match_node.parent
+          add_offense(match_node, :expression, MSG % node.source)
+        end
+
+        private
+
+        def not_allow_send_node?(node)
+          node && !allow_send_node?(node)
+        end
+
+        def allow_send_node?(node)
+          node && node.send_type? && node.method_name == :allow
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb

@@ -1,8 +1,7 @@
 module RuboCop
   module Cop
     module Ezcater
-      # Enforce usage of our `mock_feature_flag` helpers over explicit usage
-      # of allow(FeatureFlag) mocking.
+      # Enforce use of `mock_feature_flag` helper instead of mocking `FeatureFlag.is_active?` directly.
       #
       # @example
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.49.0
+  version: 0.49.1
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -119,6 +134,7 @@ files:
 - lib/ezcater_rubocop.rb
 - lib/ezcater_rubocop/version.rb
 - lib/rubocop/cop/ezcater/rspec_dot_not_self_dot.rb
+- lib/rubocop/cop/ezcater/rspec_require_browser_mock.rb
 - lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb
 - lib/rubocop/cop/ezcater/style_dig.rb
 - lib/rubocop/rspec/language/each_selector.rb