rubocop-g2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93db5770ceb2c22b543018310d3861508680cbb7b19c72a234ce5a37ebae7b45
+  data.tar.gz: 07fc64c88d2bacd823c5a8334b0767c747d9df1c50adec62e0cbb2b11bddda09
+SHA512:
+  metadata.gz: 3c171ab233dece2ebb9cacadb7994ede48542a8e03dee1304e8be97caa42b3ecb4d18d0df71bd696aa8e05b1d725c9b414cf3fe9ac1cd13c290acde155c006d9
+  data.tar.gz: 982b0cd0addf3ca594555d9343c1466448cac5abe0fa09f70db7e086772b6f0d5bfd379dee13b90aa3686ed5704db408b8b03e8e5b01b31023a364d1262ebbca

data/.gitignore

@@ -0,0 +1,4 @@
+/.idea
+/.bundle
+.rspec_status
+/pkg

data/.rubocop.yml

@@ -0,0 +1,102 @@
+require:
+  - rubocop-rspec
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Layout/ClassStructure:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+  IgnoredPatterns:
+    - ^#
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 500
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ParameterLists:
+  Max: 5
+
+Style/AndOr:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  AutoCorrect: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    '%w': '()'
+    '%W': '()'
+    '%i': '()'
+    '%I': '()'
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.6

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    rubocop-g2 (1.0.0)
+      rubocop (= 0.82.0)
+      rubocop-rspec (= 1.39.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.3)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pry
+  rake (~> 12.3.1)
+  rspec (~> 3.7)
+  rubocop-g2!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,12 @@
+# rubocop-g2
+
+This repo contains custom rubocop rules for G2.
+
+A good starting point for writing a custom parser is the `ruby-parse` command. This parses a snippet of ruby code with the same parser that rubocop ultimately uses to analyze code.
+
+For example, `ruby-parse -e "class Foo < Draper; end"` returns
+```
+(class
+  (const nil :Foo)
+  (const nil :Draper) nil)
+```

data/Rakefile

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

data/config/rails/default.yml

@@ -0,0 +1,20 @@
+Rails:
+  Enabled: true
+
+Rails/DynamicFindBy:
+  Whitelist:
+    - find_by_sql
+    - find_by_friendly_id
+
+Rails/FilePath:
+  EnforcedStyle: slashes
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Rails/UnknownEnv:
+  Environments:
+    - production
+    - test
+    - development
+    - staging

data/config/rspec/default.yml

@@ -0,0 +1,13 @@
+AllCops:
+  RSpec:
+    Patterns:
+      - '_spec.rb$'
+
+Lint/Void:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 6

data/config/ruby/default.yml

@@ -0,0 +1,96 @@
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Layout/ClassStructure:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+  IgnoredPatterns:
+    - ^#
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 500
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ParameterLists:
+  Max: 5
+
+Style/AndOr:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  AutoCorrect: true
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    '%w': '()'
+    '%W': '()'
+    '%i': '()'
+    '%I': '()'
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false

data/lib/rubocop/cop/g2/aggregates_model_boundary.rb

@@ -0,0 +1,38 @@
+module RuboCop
+  module Cop
+    module G2
+      class AggregatesModelBoundary < RuboCop::Cop::Cop
+        MSG = 'Do not directly reference an aggregate model outside of the aggregates engine. You should do all CRUD'\
+              ' operations through new or existing service objects in the engine.'.freeze
+
+        AGGREGATE_MODELS = %w(
+          :AnswerAggregateValue
+          :AnswerAggregateDistribution
+          :ReportQuarterAnswerAggregateValue
+          :ReportQuarterAnswerAggregateDistribution
+          :HighestRatedAnswerAggregate
+          :HighestRatedAnswerAggregateDistribution
+        ).freeze
+
+        AGGREGATES_ENGINE_PATH = 'engines/aggregates'.freeze
+        SPEC_PATH = 'spec'.freeze
+
+        def_node_matcher :direct_model_reference?, <<~PATTERN
+          (const (const _ :Aggregates) {#{AGGREGATE_MODELS.join(' ')}})
+        PATTERN
+
+        def on_const(node)
+          return if ignored_file?
+          add_offense(node, location: :expression) if direct_model_reference?(node)
+        end
+
+        private
+
+        def ignored_file?
+          file_path = processed_source.path || ''
+          file_path.include?(AGGREGATES_ENGINE_PATH) || file_path.include?(SPEC_PATH)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/g2/ban_decorators.rb

@@ -0,0 +1,29 @@
+module RuboCop
+  module Cop
+    module G2
+      class BanDecorators < RuboCop::Cop::Cop
+        MSG = 'Please avoid creating new Draper decorators or extending existing decorators.'.freeze
+
+        DECORATOR_CLASSES = %w(Draper::Decorator).freeze
+
+        def on_class(node)
+          parent_class = full_class_name(node)
+          add_offense(node, location: :expression) if DECORATOR_CLASSES.include?(parent_class)
+        end
+
+        private
+
+        def full_class_name(node)
+          parent_class = node.parent_class
+          return if parent_class.nil?
+
+          modules = [parent_class.children[1].to_s]
+          parent_class.each_descendant do |desc|
+            modules << desc.children[1].to_s
+          end
+          modules.reverse.join('::')
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/g2/predicate_memoization.rb

@@ -0,0 +1,34 @@
+module RuboCop
+  module Cop
+    module G2
+      class PredicateMemoization < RuboCop::Cop::Cop
+        MSG = 'Do not use `@foo ||= bar` to memoize predicate methods, since `false` or `nil` return values will not'\
+              ' be memoized with this approach.'.freeze
+
+        def on_def(node)
+          return unless predicate_method?(node)
+
+          offending_nodes(node).each do |offender|
+            add_offense(offender, location: :expression)
+          end
+        end
+
+        private
+
+        def predicate_method?(node)
+          node.method_name.to_s.end_with?('?')
+        end
+
+        def offending_nodes(node)
+          node.each_descendant(:or_asgn).select do |or_assignment|
+            instance_var_assignment?(or_assignment)
+          end
+        end
+
+        def instance_var_assignment?(assignment)
+          assignment.children.first.type == :ivasgn
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/g2/raw_connection_execute.rb

@@ -0,0 +1,19 @@
+module RuboCop
+  module Cop
+    module G2
+      class RawConnectionExecute < RuboCop::Cop::Cop
+        MSG = 'The result returned by this statement is manually memory managed. Please use one of the'\
+              ' exec_query/exec_update/exec_insert/exec_delete wrappers instead.'.freeze
+
+        def_node_matcher :raw_connection_execute?, <<~PATTERN
+          (send (send _ :connection) :execute _)
+        PATTERN
+
+        def on_send(node)
+          return unless raw_connection_execute?(node)
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/g2/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module G2
+    VERSION = '1.0.0'.freeze
+  end
+end

data/lib/rubocop-g2.rb

@@ -0,0 +1,3 @@
+# rubocop:disable Naming/FileName
+require 'rubocop_g2'
+# rubocop:enable Naming/FileName

data/lib/rubocop_g2.rb

@@ -0,0 +1,7 @@
+require 'rubocop'
+
+require_relative 'rubocop/g2/version'
+require_relative 'rubocop/cop/g2/ban_decorators'
+require_relative 'rubocop/cop/g2/predicate_memoization'
+require_relative 'rubocop/cop/g2/raw_connection_execute'
+require_relative 'rubocop/cop/g2/aggregates_model_boundary'

data/rubocop-g2.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop/g2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-g2'
+  spec.version       = RuboCop::G2::VERSION
+  spec.authors       = ['Paul Mannino']
+  spec.email         = ['pmannino@g2.com']
+
+  spec.summary       = 'Custom cops for G2.'
+  spec.homepage      = 'https://g2.com'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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_dependency 'rubocop', '0.82.0'
+  spec.add_dependency 'rubocop-rspec', '1.39.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 12.3.1'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-g2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Paul Mannino
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: 
+email:
+- pmannino@g2.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- config/rails/default.yml
+- config/rspec/default.yml
+- config/ruby/default.yml
+- lib/rubocop-g2.rb
+- lib/rubocop/cop/g2/aggregates_model_boundary.rb
+- lib/rubocop/cop/g2/ban_decorators.rb
+- lib/rubocop/cop/g2/predicate_memoization.rb
+- lib/rubocop/cop/g2/raw_connection_execute.rb
+- lib/rubocop/g2/version.rb
+- lib/rubocop_g2.rb
+- rubocop-g2.gemspec
+homepage: https://g2.com
+licenses: []
+metadata: {}
+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: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Custom cops for G2.
+test_files: []