ezcater_rubocop 0.49.0.rc0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 243fe8dda3fbb6400334541d005458302781fa18
+  data.tar.gz: e308cca3c409fedfc1495ea97acf255b3cf25fb0
+SHA512:
+  metadata.gz: df2042d9d1f7a3cf3531f5cfd56a405d65563c99158a7c8dfbb099f8ad5adf2bca7d26f406c3e93960d618a239c151e2b503727d792b2b3376f4da7dc3532391
+  data.tar.gz: 0c8e05a4ba6ffb5b2f968e04957370b171f1e0da2f3e21a2abe49976029686a9ea616efd291944a19bb77ad03576f7727c8e1f1cca3580a36693645f0441ff2d

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  DisplayCopNames: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+  - "*.gemspec"
+  - "spec/**/*.rb"
+
+Metrics/MethodLength:
+  Enabled: true
+  CountComments: false
+  Max: 25
+
+Metrics/LineLength:
+  Max: 120
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.ruby-gemset

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

@@ -0,0 +1,8 @@
+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/CHANGELOG.md

@@ -0,0 +1,7 @@
+# ezcater_rubocop
+
+# v0.49.0 (unreleased)
+- Initial release.
+- Add `Ezcater/RequireFeatureFlagMock` cop.
+- Add `Ezcater/RspecDotNotSelfDot` cop.
+- Add `Ezcater/StyleDig` cop.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ezCater, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# ezcater_rubocop
+
+ezCater custom cops, and eventually shared rubocop configuration.
+
+[RuboCop](https://github.com/bbatsov/rubocop) is a static code analyzer that
+can enforce style conventions as well as identify common problems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem "ezcater_rubocop", require: false
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ezcater_rubocop
+
+## Usage
+
+Run `rubocop` for an entire project:
+
+    $ bundle exec rubocop
+
+See the `rubocop` command-line for additional options including auto-generating
+configuration for existing offenses and auto-correction.
+
+## Versioning
+
+This gem is versioned based on the MAJOR.MINOR version of `rubocop`. The first
+release of the `ezcater_rubocop` gem was v0.49.0.
+
+The patch version for this gem does _not_ correspond to the patch version of
+`rubocop`. The patch version for this gem will change any time that one of its
+configurations is modified _or_ its dependency on `rubocop` is changed to require
+a different patch version.
+
+This gem also includes a dependency on `rubocop-rspec` that will be updated to
+the latest compatible version each time that the MAJOR.MINOR version of `rubocop`
+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. [StyleDig](https://github.com/ezcater/ezcater_rubocop/blob/master/lib/rubocop/cop/ezcater/style_dig.rb) - Recommend `dig` for deeply nested access.
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ezcater/ezcater_rubocop.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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/config/default.yml

@@ -0,0 +1,16 @@
+Ezcater/RspecDotNotSelfDot:
+  Description: 'Enforce ".<class method>" instead of "self.<class method>" for example group description.'
+  Enabled: true
+  Include:
+    - '**/*_spec.rb'
+
+Ezcater/RspecRequireFeatureFlagMock:
+  Description: 'Enforce use of `mock_feature_flag` helpers instead of mocking `FeatureFlag.is_active?` directly.'
+  Enabled: true
+  Include:
+    - '**/*_spec.rb'
+
+Ezcater/StyleDig:
+  Description: 'Recommend `dig` for deeply nested access.'
+  Enabled: true
+  AutoCorrect: false

data/ezcater_rubocop.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ezcater_rubocop/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ezcater_rubocop"
+  spec.version       = EzcaterRubocop::VERSION
+  spec.authors       = ["ezCater, Inc"]
+  spec.email         = ["engineering@ezcater.com"]
+
+  spec.summary       = "ezCater custom cops and shared configuration"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/ezcater/ezcater_rubocop"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_development_dependency "pry-byebug"
+
+  spec.add_runtime_dependency "rubocop", "~> 0.49.1"
+  spec.add_runtime_dependency "rubocop-rspec", "~> 1.15.1"
+end

data/lib/ezcater_rubocop.rb

@@ -0,0 +1,17 @@
+require "ezcater_rubocop/version"
+require "rubocop-rspec"
+
+# 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)
+
+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/ezcater_rubocop/version.rb

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

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

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module RuboCop
+  module Cop
+    module Ezcater
+      # Use ".<class method>" instead of "self.<class method>" in RSpec example
+      # group descriptions.
+      #
+      # @example
+      #
+      #   # good
+      #   describe ".does_stuff" do
+      #     ...
+      #   end
+      #
+      #   # bad
+      #   describe "self.does_stuff" do
+      #     ...
+      #   end
+      class RspecDotNotSelfDot < Cop
+        SELF_DOT_REGEXP = /["']self\./
+        MSG = 'Use ".<class method>" instead of "self.<class method>" for example group description.'.freeze
+
+        def_node_matcher :example_group_match, <<-PATTERN
+          (send _ #{RuboCop::RSpec::Language::ExampleGroups::ALL.node_pattern_union} $_ ...)
+        PATTERN
+
+        def on_send(node)
+          example_group_match(node) do |doc|
+            add_offense(doc, :expression, MSG) if SELF_DOT_REGEXP =~ doc.source
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(Parser::Source::Range.new(node.source_range.source_buffer,
+                                                       node.source_range.begin_pos + 1,
+                                                       node.source_range.begin_pos + 5))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module RuboCop
+  module Cop
+    module Ezcater
+      # Enforce usage of our `mock_feature_flag` helpers over explicit usage
+      # of allow(FeatureFlag) mocking.
+      #
+      # @example
+      #
+      #   # good
+      #   mock_feature_flag("MyFeatureFlag", true)
+      #   mock_feature_flag("MyFeatureFlag", { user: current_user }, true)
+      #
+      #   # bad
+      #   allow(FeatureFlag).to receive(:is_active?).and_return(true)
+      #   allow(FeatureFlag).to receive(:is_active?).with("MyFeatureFlag").and_return(true)
+      #   allow(FeatureFlag).to receive(:is_active?).with("MyFeatureFlag", user: current_user).and_return(true)
+      class RspecRequireFeatureFlagMock < Cop
+        MSG = "Use the `mock_feature_flag` helper instead of mocking `allow(FeatureFlag)`".freeze
+
+        def_node_matcher :feature_flag_const?, <<~PATTERN
+          (const _ :FeatureFlag)
+        PATTERN
+
+        def on_const(node)
+          return unless feature_flag_const?(node)
+
+          # 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)
+        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/style_dig.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+module RuboCop
+  module Cop
+    module Ezcater
+      # Use `dig` for deeply nested access.
+      #
+      # @example
+      #
+      #   # good
+      #   my_hash.dig('foo', 'bar')
+      #   my_array.dig(0, 1)
+      #
+      #   # bad
+      #   my_hash['foo']['bar']
+      #   my_hash['foo'] && my_hash['foo']['bar']
+      #   my_array[0][1]
+
+      class StyleDig < Cop
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 2.3
+
+        MSG = "Use `dig` for nested access.".freeze
+
+        def_node_matcher :nested_access_match, <<-PATTERN
+          (send (send (send _receiver !:[]) :[] _) :[] _)
+        PATTERN
+
+        def on_send(node)
+          return unless nested_access_match(node) && !conditional_assignment?(node)
+          match_node = node
+          # walk to outermost access node
+          match_node = match_node.parent while access_node?(match_node.parent)
+          add_offense(match_node, :expression, MSG)
+        end
+
+        def autocorrect(node)
+          access_node = node
+          source_args = [access_node.method_args.first.source]
+          while access_node?(access_node.children.first)
+            access_node = access_node.children.first
+            source_args << access_node.method_args.first.source
+          end
+          root_node = access_node.children.first
+
+          lambda do |corrector|
+            range = Parser::Source::Range.new(node.source_range.source_buffer,
+                                              root_node.source_range.end_pos,
+                                              node.source_range.end_pos)
+            corrector.replace(range, ".dig(#{source_args.reverse.join(', ')})")
+          end
+        end
+
+        private
+
+        def conditional_assignment?(node)
+          node.parent && node.parent.or_asgn_type? && (node.parent.children.first == node)
+        end
+
+        def access_node?(node)
+          node && node.send_type? && node.method_name == :[]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/language/each_selector.rb

@@ -0,0 +1,13 @@
+# Monkey-patch SelectorSet to allow enumeration of selectors.
+
+module RuboCop
+  module RSpec
+    module Language
+      class SelectorSet
+        def each(&blk)
+          selectors.each(&blk)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: ezcater_rubocop
+version: !ruby/object:Gem::Version
+  version: 0.49.0.rc0
+platform: ruby
+authors:
+- ezCater, Inc
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.1
+description: ezCater custom cops and shared configuration
+email:
+- engineering@ezcater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- ezcater_rubocop.gemspec
+- 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_feature_flag_mock.rb
+- lib/rubocop/cop/ezcater/style_dig.rb
+- lib/rubocop/rspec/language/each_selector.rb
+homepage: https://github.com/ezcater/ezcater_rubocop
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: ezCater custom cops and shared configuration
+test_files: []