rubocop-csa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f45498f4d55951d432a429026e94b206145d124c3139bcd50cc3a7b92ef90085
+  data.tar.gz: a3a9d0e80a52eab92324450293e61078a494bade1457bbebbefeae8357cb8dab
+SHA512:
+  metadata.gz: 1b758d20fcf367823cc3f383d5400dbfea99a496631db8d2d9b0dfdc11b7a29831048415ac6443959e81f0c90806a76e12aded9d90e6b31cde9b13fedcd70af2
+  data.tar.gz: c5f60f2ea5396b7adb17beb032ddfbf99fba303f1ca7c9d1877c0c67075ebda2f5556ed72394a2b6ba41c051721f3f2ee5d1eb1fcd07765295a52745f09a0932

data/README.md

@@ -0,0 +1,61 @@
+# RuboCop CSA
+
+Provides a centralized location for CSA's commonly used RuboCop overrides.
+
+## TODO
+
+- [ ] Add slim linting
+- [ ] Investigate multi-line for shoulda matchers (`it { should`...)
+
+## Usage
+
+### Rails Applications
+
+**Gemfile**
+
+```ruby
+gem 'rubocop-csa'
+gem 'rubocop-rails'
+gem 'rubocop-rspec'
+```
+
+**.rubocop.yml**
+
+```yaml
+inherit_gem:
+  rubocop-csa:
+    - config/rails.yml
+```
+
+### Ruby Gems
+
+**Gemfile**
+
+```ruby
+gem 'rubocop-csa'
+gem 'rubocop-rspec'
+```
+
+**.rubocop.yml**
+
+```yaml
+inherit_gem:
+  rubocop-csa:
+    - config/gems.yml
+```
+
+### Other Ruby code
+
+**Gemfile**
+
+```ruby
+gem 'rubocop-csa'
+```
+
+**.rubocop.yml**
+
+```yaml
+inherit_gem:
+  rubocop-csa:
+    - config/default.yml
+```

data/config/_layout.yml

@@ -0,0 +1,55 @@
+##
+# 80 Characters allows codebases to be more easily read in split screen mode,
+# as well as on other sources such as terminal and Github.
+#
+# That said, one-line expectations in RSpec commonly exceed this limit, and the
+# readability is significantly hindered when attempting to break these into
+# multiple lines.
+#
+#
+# CURRENTLY DISABLED
+#
+# LineLength affects other cops and it will take a ton of time to fix all the
+# violations trying to get it to 80. Maybe we try this in the future, but a
+# "best practice" approach seems best for now.
+#
+# Layout/LineLength:
+#   IgnoredPatterns: ['it { should', 'I18n.t']
+#   Max: 80
+
+##
+# Variable assignment can be indented weirdly, so align to the ending statement
+# instead.
+#
+# If we hate this, remove it. (came from Josh's personal settings)
+#
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+##
+# It can be unclear if a line is truly ended unless the dot is on the method
+# receiver.
+#
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+##
+# Lines can get stupidly long if we indent it to the other params/args.
+#
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+##
+# Allow extra spaces when aligning to other operators...
+# (doesn't seem to work all the time though)
+#
+Layout/SpaceAroundOperators:
+  AllowForAlignment: true
+
+##
+# Agreed in office to enforce outdent.
+#
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent

data/config/_metrics.yml

@@ -0,0 +1,14 @@
+##
+# Similarly to migrations, spec blocks will be huge by design.
+#
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context']
+  Exclude:
+    - 'spec/support/webmock_stubs.rb'
+
+# TODO: was live on CCSK, disabling to see if
+# issue is resolved.
+# This file had an issue with this cop:
+# app/controllers/oauths_controller.rb
+# Metrics/BlockNesting:
+#   Enabled: false

data/config/_rspec.yml

@@ -0,0 +1,13 @@
+##
+# `should` is shorter than `is_expected.to` and visually superior.
+#
+RSpec/ImplicitExpect:
+  EnforcedStyle: should
+
+##
+# RSpec wants "when this" type of formatting, but we group models via context by
+# mechanisms.
+#
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/models/**/*'

data/config/_style.yml

@@ -0,0 +1,73 @@
+##
+# ¯\_(ツ)_/¯
+#
+Style/AsciiComments:
+  AllowedChars: ['ツ', '¯']
+
+##
+# This cop suggests changes that are not functionally equivalent, and its value
+# is currently debated within the ruby community.
+#
+# See: https://github.com/bbatsov/ruby-style-guide/issues/556
+#
+Style/ModuleFunction:
+  Enabled: false
+
+##
+# The readability of `[:some, :various, :symbols]` is superior to
+# `%i[some various symbols]`
+#
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+##
+# Try and make rubocop follow our internal guidelines on hash styling...
+#
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+  UseHashRocketsWithSymbolValues: true
+
+##
+# Favor implicit returns for simple code, but feel free to use explicit return
+# when it helps readability.
+#
+Style/RedundantReturn:
+  Enabled: false
+
+##
+# Official style guide wants %w[some group of words], but we don't care.
+#
+Style/WordArray:
+  Enabled: false
+
+##
+# Only require using "raise" outside of specs
+# ("fail" is preferred in specs)
+#
+Style/SignalException:
+  Exclude:
+    - 'spec/**/*'
+
+##
+# Compact style is more compact, but is not functionally equivalent when the
+# parent module has not yet been defined.
+#
+# e.g. This works:
+#
+#    module CloudSecurityAlliance
+#      class Application < Rails::Application
+#        ...
+#      end
+#    end
+#
+# While this throws "Uninitialized constant CloudSecurityAlliance":
+#
+#    class CloudSecurityAlliance::Application < Rails::Application
+#
+# Which could be corrected (ugily) by changing it to this:
+#
+#    module CloudSecurityAlliance; end
+#    class CloudSecurityAlliance::Application < Rails::Application
+#
+Style/ClassAndModuleChildren:
+  Enabled: false

data/config/default.yml

@@ -0,0 +1,14 @@
+inherit_from:
+  - _layout.yml
+  - _metrics.yml
+  - _rspec.yml
+  - _style.yml
+
+require:
+  - rubocop-rake
+  - rubocop-performance
+  - rubocop-thread_safety
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0.0

data/config/gems.yml

@@ -0,0 +1,7 @@
+inherit_from:
+  - default.yml
+  - _rspec.yml
+
+require:
+  - rubocop-faker
+  - rubocop-rspec

data/config/rails.yml

@@ -0,0 +1,55 @@
+inherit_from:
+  - default.yml
+  - _rspec.yml
+
+require:
+  - rubocop-faker
+  - rubocop-rails
+  - rubocop-rspec
+  # We currently only translate on CCSK Platform
+  # - rubocop-i18n
+
+AllCops:
+  Exclude:
+    ####################################
+    ## Folders that should be ignored ##
+    ####################################
+    - 'bin/**/*'
+    - 'coverage/**/*'
+    - 'lib/templates/**/*'
+    - 'log/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
+    ##########################
+    ## Auto-generated files ##
+    ##########################
+    # Generated by rails when running migrations
+    - 'db/schema.rb'
+    # Heroku injects this file during the build process and causes:
+    # Lint/UnneededCopDisableDirective: Unnecessary disabling of all cops.
+    - 'lib/tasks/heroku_clear_tasks'
+
+##
+# In the rest of the app, using the logger makes sense. However, it seems to
+# not play nicely when generating the seeds, and `puts` is pretty
+# straight-forward.
+#
+Rails/Output:
+  Exclude:
+    - 'db/seeds/*.rb'
+    - 'db/seeds.rb'
+
+##
+# This cop makes no sense in the context of migrations.
+#
+Metrics/AbcSize:
+  Exclude:
+    - 'db/migrate/*.rb'
+
+##
+# This cop makes no sense in the context of migrations.
+#
+Metrics/MethodLength:
+  Exclude:
+    - 'db/migrate/*.rb'

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-csa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cloud Security Alliance
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Provides a centralized location for CSA's commonly used RuboCop overrides.
+email: support@cloudsecurityalliance.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- config/_layout.yml
+- config/_metrics.yml
+- config/_rspec.yml
+- config/_style.yml
+- config/default.yml
+- config/gems.yml
+- config/rails.yml
+homepage: https://github.com/CloudSecurityAlliance/rubocop-csa
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/CloudSecurityAlliance/rubocop-csa/issues
+  changelog_uri: https://github.com/CloudSecurityAlliance/rubocop-csa/releases/tag/v0.0.1
+  source_code_uri: https://github.com/CloudSecurityAlliance/rubocop-csa/tree/v0.0.1
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: RuboCop preferences for CSA
+test_files: []