rubocop-athix 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c628faf28d1e28ac81f22394abb6033b4a9c4e2c59e44024d54fbf8a18d8547c
+  data.tar.gz: 6a5c87c969a037778098c9d0e7a671b8bb19054e26407c871b2437231de47e79
+SHA512:
+  metadata.gz: 978e01d88b7d9ddf3034542782463b630c902328d0d5f2efb6e44b5785b3e94297d2053151aebbca904b6a76c22a166e69b9d37b6d03c54a628f6e31cb245121
+  data.tar.gz: 3a882212d40cf4dec3ae9102dd0878cc4e8e6b791ea79d9a27b0eb2fa7358c8ad8e2ff082e601c4f86c2fc94b1635e817c0c2bce1739535b7b00bddd78be3257

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Josh Buker
+
+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,52 @@
+# RuboCop Athix
+
+Contains my commonly used styling overrides for Rubocop.
+
+## Usage
+
+### Rails Applications
+
+**Gemfile**
+
+```ruby
+gem 'rubocop-athix'
+gem 'rubocop-rails'
+gem 'rubocop-rspec'
+```
+
+**.rubocop.yml**
+
+```yaml
+inherit_gem:
+  rubocop-athix:
+    - config/rails.yml
+```
+
+### Ruby Gems
+
+```ruby
+gem 'rubocop-athix'
+gem 'rubocop-rspec'
+```
+
+**.rubocop.yml**
+
+```yaml
+inherit_gem:
+  rubocop-athix:
+    - config/gems.yml
+```
+
+### Other Ruby code
+
+```ruby
+gem 'rubocop-athix'
+```
+
+**.rubocop.yml**
+
+```yaml
+inherit_gem:
+  rubocop-athix:
+    - config/default.yml
+```

data/config/_layout.yml

@@ -0,0 +1,33 @@
+##
+# 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.
+#
+Layout/LineLength:
+  IgnoredPatterns: ['it { should']
+  Max: 80
+
+# Variable assignment can be indented weirdly, so align to the ending statement
+# instead
+Layout/CaseIndentation:
+  EnforcedStyle: end
+# 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
+# Force prettier hash alignment
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+# It can be unclear if a line is truly ended unless the dot is on the method
+# receiver
+Layout/DotPosition:
+  EnforcedStyle: trailing
+# Allow extra spaces when aligning to other operators...
+# (doesn't seem to work all the time though)
+Layout/SpaceAroundOperators:
+  AllowForAlignment: true

data/config/_metrics.yml

@@ -0,0 +1,3 @@
+# TODO: Is there a good way to break up specs without it getting unwieldy?
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context', 'configure']

data/config/_rspec.yml

@@ -0,0 +1,5 @@
+##
+# `should` is shorter than `is_expected.to` and visually superior.
+#
+RSpec/ImplicitExpect:
+  EnforcedStyle: should

data/config/_style.yml

@@ -0,0 +1,21 @@
+##
+# ¯\_(ツ)_/¯
+#
+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]`, in my opinion.
+#
+Style/SymbolArray:
+  EnforcedStyle: brackets

data/config/default.yml

@@ -0,0 +1,13 @@
+inherit_from:
+  - _layout.yml
+  - _metrics.yml
+  - _rspec.yml
+  - _style.yml
+
+require:
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0.0

data/config/gems.yml

@@ -0,0 +1,4 @@
+inherit_from: default.yml
+
+require:
+  - rubocop-rspec

data/config/rails.yml

@@ -0,0 +1,17 @@
+inherit_from: default.yml
+
+require:
+  - rubocop-rails
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'config/**/*'
+    - 'coverage/**/*'
+    - 'db/**/*'
+    - 'lib/templates/**/*'
+    - 'log/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'Gemfile'

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-athix
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Buker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-25 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: 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-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 Athix's commonly used RuboCop overrides.
+email: crypto@joshbuker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- 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/athix/rubocop-athix
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/athix/rubocop-athix/issues
+  changelog_uri: https://github.com/athix/rubocop-athix/releases/tag/v0.0.1
+  source_code_uri: https://github.com/athix/rubocop-athix/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 Athix
+test_files: []