mlh-rubocop-config 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64e67e65f6a944c6fb648802bea94dfa95c6eb1e45f5469cdc7bb7c2d13dbe82
+  data.tar.gz: 64712722fdc7a023c17eda70eb15252aff03b6c4ca543566234cee99e892c13e
+SHA512:
+  metadata.gz: 84201318f8e19a0a1b2ad36463703c4f5b5ed6ea6492b60ad68aa6ff5769318ed5969f57f02d3e16ab47c7ad37ba34a6276bdab0f4aa1d79ccc143d16a725dd9
+  data.tar.gz: 0f4f816591ffc86167dd1af13aa6ec232e772a7bf4c03e5a3dba16e61aaf40717380e3e08349af8395895e5c705c7114b6bffc6777b14decc8e8db991049eb5e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,144 @@
+require: 
+  - rubocop-rspec
+  - rubocop-rails
+  - rubocop-performance
+
+Layout/FirstHashElementIndentation:
+  Description: Enforces consistent indentation for the first key in a hash literal
+  EnforcedStyle: consistent
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  Description: Indent on multiline method call
+  EnforcedStyle: indented_relative_to_receiver
+  Enabled: true
+
+Lint/AmbiguousBlockAssociation:
+  Description: Allows change method as ambiguous block association
+  AllowedMethods: [change]
+  Enabled: true
+
+Metrics/AbcSize:
+  Description: Setting Max AbcSize to 30, default of 17 is arbitrary and too low
+  Max: 30
+  Enabled: false
+
+Metrics/BlockLength:
+  Description: Allow block to have any length
+  Enabled: false
+
+Metrics/ClassLength:
+  Description: Allow classes of any length
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Description: Disabaling the cop since it can be arbitrary
+  Enabled: false
+
+Metrics/MethodLength:
+  Description: Allow method to have any length
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Description: Allows instance variable name to be different than method name
+  Enabled: false
+
+Naming/VariableNumber:
+  Description: Makes sure that all numbered variables use snake case for their numbering.
+  EnforcedStyle: snake_case
+  CheckSymbols: false
+  Enabled: true
+
+# To do: Resolve the offense Style/Documentation
+Style/Documentation:
+  Description: Disabaling documentation
+  Enabled: false
+
+Style/HashSyntax:
+  Description: Force use of the 1.9 syntax for hash with no mixed keys
+  EnforcedStyle: ruby19_no_mixed_keys
+  Enabled: true
+
+Style/RegexpLiteral:
+  Description: Allow forward slashes within regular expressions
+  AllowInnerSlashes: true
+  Enabled: true
+
+Style/SymbolArray:
+  Description: Force arrays of symbols to use bracket notation
+  EnforcedStyle: brackets
+  Enabled: true
+
+Style/TernaryParentheses:
+  Description: Require parentheses in ternary conditions when they are complex
+  EnforcedStyle: require_parentheses_when_complex
+  Enabled: true
+
+Style/WordArray:
+  Description: Force arrays of words to use bracket notation instead of %w
+  EnforcedStyle: brackets
+  Enabled: true
+
+Rails/Blank:
+  Description: Allows usage of nil, empty and present
+  NilOrEmpty: false
+  NotPresent: false
+  UnlessPresent: false
+  Enabled: true
+
+Rails/FilePath:
+  Description: Enable argument type for file path joining
+  EnforcedStyle: arguments
+  Enabled: true
+
+Rails/LexicallyScopedActionFilter:
+  Description: Disable the cop as it has conflict with Lint/UselessMethodDefinition
+  Enabled: false
+
+Rails/NotNullColumn:
+  Description: Disable not null column to avoid error due to rubocop
+  Enabled: false
+  
+Rails/SkipsModelValidations:
+  Description: Allows update and update_columns for faster execution
+  AllowedMethods: ['update_all']
+  Enabled: true
+
+RSpec/AnyInstance:
+  Description: Allow stubbing instance of a class
+  Enabled: false
+
+RSpec/ContextWording:
+  Description: Does not restrict starting context wording using when, with or without
+  Enabled: false
+
+RSpec/ExampleLength:
+  Description: Allow test example to have any length
+  Enabled: false
+
+RSpec/MultipleExpectations: 
+  Description: Allow tests to contain multiple expectations 
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Description: Does not limit the number of let to an arbitrary number
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Description: Allow compact and nested style of children definitions at classes and modules
+  Enabled: false
+
+Style/FormatStringToken:
+  Description: Enforces template style for formatting strings
+  EnforcedStyle: template
+  Enabled: true
+
+Style/NumericPredicate:
+  Description: Allows the use of comparison operator
+  EnforcedStyle: comparison
+  Enabled: true
+
+Style/SymbolProc:
+  Description: Allows block for method with arguments
+  AllowMethodsWithArguments: true
+  Enabled: true

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mlh_rubocop_config.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rubocop'
+gem 'rubocop-performance'
+gem 'rubocop-rails'
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    mlh-rubocop-config (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.18.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rack (3.0.8)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rubocop (1.54.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.20.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  mlh-rubocop-config!
+  rake (~> 13.0)
+  rubocop
+  rubocop-performance
+  rubocop-rails
+  rubocop-rspec
+
+BUNDLED WITH
+   2.2.33

data/README.md

@@ -0,0 +1,34 @@
+# MLH Rubocop Configuration
+
+The MLH Rubocop Configuration provides a set of rules and guidelines for Ruby code.
+
+## Usage
+
+To use the MLH Rubocop Configuration in your Ruby project, follow these steps:
+
+1. Add the MLH Rubocop Configuration gem to your Gemfile:
+   ```ruby
+   gem "mlh-rubocop-config"
+   ```
+
+2. In your project's `.rubocop.yml` file, include the MLH Rubocop Configuration by using the inherit_gem directive:
+
+```
+inherit_gem:
+  mlh-rubocop-config: .rubocop.yml
+```
+
+## Example
+
+Here's an example of how your project's `.rubocop.yml` file might look like when using the MLH Rubocop Configuration:
+
+```
+# Inherit rules from the MLH Rubocop Configuration
+inherit_gem:
+  mlh-rubocop-config: .rubocop.yml
+
+# Add project-specific rules or overrides
+AllCops:
+  Exclude:
+    - spec/**/* # Exclude spec files from Rubocop analysis
+```

data/lib/mlh-rubocop-config/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MlhRubocopConfig
+  VERSION = '1.0.1'
+end

data/mlh-rubocop-config.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mlh-rubocop-config/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'mlh-rubocop-config'
+  spec.version = MlhRubocopConfig::VERSION
+  spec.authors = ['Major League Hacking (MLH)']
+  spec.email = ['hi@mlh.io']
+  spec.homepage = 'https://github.com/MLH/MLH-Rubocop-Config'
+  spec.summary = 'MLH Rubocop Configuration'
+  spec.description = 'MLH Rubocop Config is a customized set of rules and guidelines for Ruby code.'
+
+  spec.files = Dir['{**/}{.*,*}'].select { |path| File.file?(path) && path !~ /^(?:pkg|build)/ }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.add_dependency 'rubocop'
+  spec.add_dependency 'rubocop-performance'
+  spec.add_dependency 'rubocop-rails'
+  spec.add_dependency 'rubocop-rspec'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: mlh-rubocop-config
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Major League Hacking (MLH)
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MLH Rubocop Config is a customized set of rules and guidelines for Ruby
+  code.
+email:
+- hi@mlh.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/mlh-rubocop-config/version.rb
+- mlh-rubocop-config.gemspec
+homepage: https://github.com/MLH/MLH-Rubocop-Config
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: MLH Rubocop Configuration
+test_files: []