ezcater_rubocop 0.50.2.rc0 → 0.50.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc2b72196c2d978e118d0d6f13ff45f2a06549fe
-  data.tar.gz: 1d875ba7c900140c5f0f5c2ef99054d3eb297322
+  metadata.gz: 0d12c8292918b188ea1df51f50a4b2aaeba09808
+  data.tar.gz: '0219fcf647fe0325ac794de1498e822db2b429d9'
 SHA512:
-  metadata.gz: 2ceece608ed580d16420ed3697c6ec01a7d9db5763985a8dfe6c2d10e5b8129667f4b7b3b3c93ef3d4cd5677e1f7ee6f1099ecbbb69f407c4640bdab653a56d5
-  data.tar.gz: c22694f8ee893278028ebcd8451c75852fe267936489401bd681a3f2d291e4a465ff61fa9c9c4e9258fa06f8bcda947f191c0738240961beb0de1ec8303580bb
+  metadata.gz: b56adca97c94e2e92a1f9746ead3e0dab36b36f97f09dea46d5dd2f7c7ef0080391ae85814601ff0ebca93a7c4565306419267d8a7e8f6388caf7ea0ed14afbb
+  data.tar.gz: 7c2c268cf647c3dc634e17bb2d961663a1eaf00c0c284767240d0b427d4df2642d2465104fe79f97ea08137d229a197a3f585db3b9f06fc0d3623a80033ddb59

data/CHANGELOG.md

@@ -1,6 +1,8 @@
 # ezcater_rubocop
 
 ## v0.50.2 (unreleased)
+- Add `Ezcater/PrivateAttr` custom cop.
+- Configure `RSpec/ExampleLength` with a `Max` value of 25.
 - Add `circle_rubocop.rb` script.
 
 ## v0.50.1

data/README.md

@@ -56,6 +56,17 @@ Run `rubocop` for an entire project:
 See the `rubocop` command-line for additional options including auto-generating
 configuration for existing offenses and auto-correction.
 
+### Circle Script
+
+This gem contains a script, `circle_rubocop.rb`, that can be used to run RuboCop in CI.
+
+The behavior of the script is that all files are checked on master or if the rubocop
+configuration has changed. On non-master branches, only the files added or changed on
+the branch are checked.
+
+For non-master branches, `[rubocop skip]` can be included in the commit message to skip
+running rubocop.
+
 ## Versioning
 
 This gem is versioned based on the MAJOR.MINOR version of `rubocop`. The first
@@ -71,6 +82,7 @@ the latest compatible version each time that the MAJOR.MINOR version of `rubocop
 is updated.
 
 ## Custom Cops
+1. [PrivateAttr](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/private_attr.rb) - Require methods from the `private_attr` gem.
 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. [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.

data/conf/rubocop.yml

@@ -31,6 +31,9 @@ Metrics/PerceivedComplexity:
 Rails:
   Enabled: false
 
+RSpec/ExampleLength:
+  Max: 25
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 

data/config/default.yml

@@ -1,3 +1,7 @@
+Ezcater/PrivateAttr:
+  Description: 'Require methods from the private_attr gem'
+  Enabled: true
+
 Ezcater/RspecDotNotSelfDot:
   Description: 'Enforce ".<class method>" instead of "self.<class method>" for example group description.'
   Enabled: true

data/ezcater_rubocop.gemspec

@@ -22,9 +22,20 @@ Gem::Specification.new do |spec|
       "public gem pushes."
   end
 
+  excluded_files = %w[.circleci/config.yml
+                      .gitignore
+                      .rspec
+                      .rubocop.yml
+                      .ruby-gemset
+                      .ruby-version
+                      .travis.yml
+                      bin/console
+                      bin/setup
+                      Rakefile]
+
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
-  end
+  end - excluded_files
   spec.bindir = "bin"
   spec.executables << "circle_rubocop.rb"
   spec.require_paths = ["lib"]

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/private_attr"
 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"

data/lib/ezcater_rubocop/version.rb

@@ -1,3 +1,3 @@
 module EzcaterRubocop
-  VERSION = "0.50.2.rc0".freeze
+  VERSION = "0.50.2.rc1".freeze
 end

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

@@ -0,0 +1,91 @@
+module RuboCop
+  module Cop
+    module Ezcater
+      # This cop checks for the use of `attr_accessor`, `attr_reader`, `attr_writer`
+      # and `alias_method` after the access modifiers `private` and `protected`
+      # and requires the use of methods from the private_attr gem instead.
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   class C
+      #     private
+      #
+      #     attr_accessor :foo
+      #     attr_reader :bar
+      #     attr_writer :baz
+      #     alias_method :foobar, foo
+      #   end
+      #
+      #
+      # @example
+      #
+      #   # good
+      #
+      #   class C
+      #     private_attr_accessor :foo
+      #     private_attr_reader :bar
+      #     private_attr_writer :baz
+      #     private_alias_method :foobar, :foo
+      #
+      #     private
+      #
+      #     def shy
+      #       puts "hi"
+      #     end
+      #   end
+      class PrivateAttr < Cop
+        ATTR_METHODS = %i[attr_accessor
+                          attr_reader
+                          attr_writer].freeze
+
+        ACCESS_AFFECTED_METHODS = (ATTR_METHODS + %i[alias_method]).to_set.freeze
+
+        MSG = "Use `%s_%s` instead".freeze
+
+        def on_class(node)
+          check_node(node.children[2]) # class body
+        end
+
+        def on_module(node)
+          check_node(node.children[1]) # module body
+        end
+
+        private
+
+        def check_node(node)
+          return unless node&.begin_type?
+
+          check_scope(node)
+        end
+
+        def format_message(visibility, method_name)
+          format(MSG, visibility, method_name)
+        end
+
+        def check_scope(node, current_visibility = :public)
+          node.children.reduce(current_visibility) do |visibility, child|
+            check_child_scope(child, visibility)
+          end
+        end
+
+        def check_child_scope(node, current_visibility)
+          if node.send_type?
+            if node.access_modifier? && !node.method?(:module_function)
+              current_visibility = node.method_name
+            elsif ACCESS_AFFECTED_METHODS.include?(node.method_name) && current_visibility != :public
+              add_offense(node,
+                          :expression,
+                          format_message(current_visibility, node.method_name))
+            end
+          elsif node.kwbegin_type?
+            check_scope(node, current_visibility)
+          end
+
+          current_visibility
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.50.2.rc0
+  version: 0.50.2.rc1
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2017-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,27 +116,18 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/circle_rubocop.rb
-- bin/console
-- bin/setup
 - conf/rubocop.yml
 - conf/rubocop_rails.yml
 - config/default.yml
 - ezcater_rubocop.gemspec
 - lib/ezcater_rubocop.rb
 - lib/ezcater_rubocop/version.rb
+- lib/rubocop/cop/ezcater/private_attr.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

data/.circleci/config.yml

@@ -1,46 +0,0 @@
-version: 2
-jobs:
-  build:
-    parallelism: 1
-    working_directory: ~/ezcater
-    docker:
-      - image: circleci/ruby:2.4.1
-    steps:
-      - checkout
-
-      # Restore bundle cache
-      - restore_cache:
-          keys:
-            - ruby-cache-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "ezcater_rubocop.gemspec" }}
-            - ruby-cache-{{ arch }}-{{ .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/.gitignore

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

data/.rspec

@@ -1,3 +0,0 @@
---require spec_helper.rb
---format documentation
---color

data/.rubocop.yml

@@ -1,6 +0,0 @@
-inherit_from:
-  - conf/rubocop.yml
-
-# Disable because aggregate_failures is configured globally
-RSpec/MultipleExpectations:
-  Enabled: false

data/.ruby-gemset

@@ -1 +0,0 @@
-ezcater_rubocop

data/.ruby-version

@@ -1 +0,0 @@
-2.4.1

data/.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.15.4
-script:
-  - bundle exec rubocop
-  - bundle exec rspec

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 "ezcater_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