Skip to content

Commit

Permalink
Added rubocop (and rubocop-rspec, rubocop-rake) for code style consis…
Browse files Browse the repository at this point in the history
…tency

Auto-generated the `.rubocop.yml' file to follow existing styles with:

    rubocop --auto-gen-config --exclude-limit 0

Added running rubocop to github action script.
  • Loading branch information
noahfpf committed Aug 11, 2024
1 parent f06f85f commit cb2f587
Show file tree
Hide file tree
Showing 3 changed files with 286 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/ruby.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ jobs:
RAILS_VERSION: "${{ matrix.rails_version }}"
- name: Install Graphviz
run: sudo apt-get install graphviz
- name: Run code lint
run: bundle exec rubocop
env:
RAILS_VERSION: "${{ matrix.rails_version }}"
- name: Run tests
run: bundle exec rspec
env:
Expand Down
279 changes: 279 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,279 @@
require:
- rubocop-rake
- rubocop-rspec

AllCops:
NewCops: disable

Gemspec/OrderedDependencies:
Enabled: false

Layout/ArgumentAlignment:
Enabled: false

Layout/CaseIndentation:
Enabled: false

Layout/EmptyLineAfterGuardClause:
Enabled: false

Layout/EmptyLineAfterMagicComment:
Enabled: false

Layout/EmptyLinesAroundAccessModifier:
Enabled: false

Layout/EmptyLinesAroundBlockBody:
Enabled: false

Layout/ExtraSpacing:
Enabled: false

Layout/FirstHashElementIndentation:
Enabled: false

Layout/HashAlignment:
Enabled: false

Layout/SpaceAfterMethodName:
Enabled: false

Layout/SpaceAroundEqualsInParameterDefault:
Enabled: false

Layout/SpaceAroundOperators:
Enabled: false

Layout/SpaceBeforeBlockBraces:
Enabled: false

Layout/SpaceInsideBlockBraces:
Enabled: false

Layout/SpaceInsideHashLiteralBraces:
Enabled: false

Layout/TrailingWhitespace:
Enabled: false

Lint/AmbiguousBlockAssociation:
Enabled: false

Lint/ConstantDefinitionInBlock:
Enabled: false

Lint/DuplicateMethods:
Enabled: false

Lint/ParenthesesAsGroupedExpression:
Enabled: false

Lint/RedundantSplatExpansion:
Enabled: false

Lint/ShadowingOuterLocalVariable:
Enabled: false

Lint/ToJSON:
Enabled: false

Lint/UnusedBlockArgument:
Enabled: false

Lint/UnusedMethodArgument:
Enabled: false

Lint/UselessAssignment:
Enabled: false

Metrics/AbcSize:
Max: 32

Metrics/BlockLength:
Max: 195

Metrics/ClassLength:
Max: 170

Metrics/CyclomaticComplexity:
Max: 8

Metrics/MethodLength:
Max: 23

Naming/MemoizedInstanceVariableName:
Enabled: false

Naming/PredicateName:
Enabled: false

Naming/RescuedExceptionsVariableName:
Enabled: false

Style/BlockDelimiters:
Enabled: false

Style/ClassVars:
Enabled: false

Style/ColonMethodCall:
Enabled: false

Style/CombinableLoops:
Enabled: false

Style/ConditionalAssignment:
Enabled: false

Style/Documentation:
Enabled: false

Style/EmptyCaseCondition:
Enabled: false

Style/EmptyMethod:
Enabled: false

Style/Encoding:
Enabled: false

Style/ExpandPathArguments:
Enabled: false

Style/FrozenStringLiteralComment:
Enabled: false

Style/GlobalStdStream:
Enabled: false

Style/GuardClause:
Enabled: false

Style/HashSyntax:
Enabled: false

Style/IfUnlessModifier:
Enabled: false

Style/InverseMethods:
Enabled: false

Style/MethodCallWithoutArgsParentheses:
Enabled: false

Style/MutableConstant:
Enabled: false

Style/NumericLiteralPrefix:
Enabled: false

Style/PercentLiteralDelimiters:
Enabled: false

Style/RaiseArgs:
Enabled: false

Style/SafeNavigation:
Enabled: false

Style/SelfAssignment:
Enabled: false

Style/SpecialGlobalVars:
Enabled: false

Style/StderrPuts:
Enabled: false

Style/StringLiterals:
Enabled: false

Style/SymbolProc:
Enabled: false

Style/UnlessElse:
Enabled: false

Style/WordArray:
Enabled: false

Layout/LineLength:
Max: 156

RSpec/AnyInstance:
Enabled: false

RSpec/BeEq:
Enabled: false

RSpec/ContextWording:
Enabled: false

RSpec/DescribedClass:
Enabled: false

RSpec/EmptyExampleGroup:
Enabled: false

RSpec/EmptyLineAfterExampleGroup:
Enabled: false

RSpec/EmptyLineAfterSubject:
Enabled: false

RSpec/ExampleLength:
Max: 34

RSpec/ExampleWording:
Enabled: false

RSpec/ExpectChange:
Enabled: false

RSpec/HookArgument:
EnforcedStyle: each

RSpec/LeakyConstantDeclaration:
Enabled: false

RSpec/LetSetup:
Enabled: false

RSpec/MatchArray:
Enabled: false

RSpec/MessageSpies:
EnforcedStyle: receive

RSpec/MultipleExpectations:
Max: 16

RSpec/MultipleMemoizedHelpers:
Max: 6

RSpec/NamedSubject:
Enabled: false

RSpec/NestedGroups:
Max: 4

RSpec/NotToNot:
Enabled: false

RSpec/PredicateMatcher:
Enabled: false

RSpec/ReceiveCounts:
Enabled: false

RSpec/SpecFilePathFormat:
Enabled: false

RSpec/StubbedMock:
Enabled: false

RSpec/SubjectStub:
Enabled: false

RSpec/VerifiedDoubles:
Enabled: false
3 changes: 3 additions & 0 deletions gush.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ Gem::Specification.new do |spec|
spec.add_dependency "launchy", "~> 2.4"
spec.add_development_dependency "bundler"
spec.add_development_dependency "rake", "~> 12"
spec.add_development_dependency "rubocop", '~> 1.65.0'
spec.add_development_dependency "rubocop-rake", '~> 0.6.0'
spec.add_development_dependency "rubocop-rspec", '~> 3.0.3'
spec.add_development_dependency "rspec", '~> 3.0'
spec.add_development_dependency "pry", '~> 0.10'
end

0 comments on commit cb2f587

Please sign in to comment.