Created
January 26, 2024 01:24
-
-
Save tcannonfodder/21a150119e776947c49d70e4b1507318 to your computer and use it in GitHub Desktop.
Practical Framework code quality setup
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Use the latest 2.1 version of CircleCI pipeline process engine. | |
# See: https://circleci.com/docs/configuration-reference | |
version: 2.1 | |
rails_build: &rails_build | |
resource_class: small | |
docker: | |
- image: cimg/ruby:3.2-browsers | |
- image: cimg/postgres:16.1 | |
environment: | |
POSTGRES_DB: rails_app | |
POSTGRES_PASSWORD: '' | |
POSTGRES_USER: circleci-demo-ruby | |
environment: | |
BUNDLE_JOBS: '3' | |
BUNDLE_RETRY: '3' | |
PGHOST: 127.0.0.1 | |
PGPASSWORD: '' | |
PGUSER: circleci-demo-ruby | |
RAILS_ENV: test | |
PARALLEL_WORKERS: 3 | |
COVERAGE: 1 | |
HEADLESS_TESTS: true | |
orbs: | |
bun: ksylvest/bun@1.0.1 | |
ruby: circleci/ruby@2.1.1 | |
jobs: | |
lint: | |
resource_class: small | |
docker: | |
- image: cimg/ruby:3.2 | |
steps: | |
- checkout | |
- run: | |
name: Setup Interpolated Environment Variables | |
command: | | |
echo 'export BUNDLE_GITHUB__COM="x-access-token:$PRIVATE_REPO_TOKEN"' >> "$BASH_ENV" | |
- ruby/install-deps | |
- ruby/rubocop-check: | |
format: progress | |
label: Inspecting with Rubocop | |
parallel: true | |
- run: bundle exec bundler-audit --update | |
- run: bundle exec brakeman -q -w2 | |
coverage: | |
resource_class: small | |
docker: | |
- image: cimg/ruby:3.2 | |
environment: | |
RAILS_ENV: test | |
steps: | |
- checkout | |
- attach_workspace: | |
at: . | |
- run: | |
name: Setup Interpolated Environment Variables | |
command: | | |
echo 'export BUNDLE_GITHUB__COM="x-access-token:$PRIVATE_REPO_TOKEN"' >> "$BASH_ENV" | |
- ruby/install-deps | |
- run: | |
name: Merge and check coverage | |
command: | | |
bundle exec rake coverage:report | |
- store_artifacts: | |
path: coverage | |
- run: | |
name: Setup Code Climate test-reporter | |
command: | | |
curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter | |
chmod +x ./cc-test-reporter | |
- run: | |
name: Format coverage results for CodeClimate | |
command: | | |
./cc-test-reporter format-coverage -t simplecov -o tmp/codeclimate.json | |
- run: | |
name: Upload to CodeClimate | |
command: | | |
./cc-test-reporter upload-coverage -i tmp/codeclimate.json | |
test: | |
<<: *rails_build | |
steps: | |
- checkout | |
- run: | |
name: Setup Interpolated Environment Variables | |
command: | | |
echo 'export BUNDLE_GITHUB__COM="x-access-token:$PRIVATE_REPO_TOKEN"' >> "$BASH_ENV" | |
- ruby/install-deps | |
- bun/install | |
- run: bun install | |
- run: | |
command: dockerize -wait tcp://localhost:5432 -timeout 1m | |
name: Wait for DB | |
- run: | |
command: bundle exec rails db:schema:load --trace | |
name: Database setup | |
- run: bundle exec rails test | |
- store_test_results: | |
path: test/reports | |
- store_artifacts: | |
path: log/ | |
- store_artifacts: | |
path: tmp/capybara/ | |
- run: | |
name: Stash Coverage Results | |
command: | | |
mkdir coverage_results | |
cp -R coverage/.resultset.json coverage_results/.resultset-${CIRCLE_JOB}-${CIRCLE_NODE_INDEX}.json | |
- persist_to_workspace: | |
root: . | |
paths: | |
- coverage_results | |
test-system: | |
<<: *rails_build | |
resource_class: medium | |
steps: | |
- checkout | |
- run: | |
name: Setup Interpolated Environment Variables | |
command: | | |
echo 'export BUNDLE_GITHUB__COM="x-access-token:$PRIVATE_REPO_TOKEN"' >> "$BASH_ENV" | |
- ruby/install-deps | |
- bun/install | |
- run: bun install | |
- run: | |
command: dockerize -wait tcp://localhost:5432 -timeout 1m | |
name: Wait for DB | |
- run: | |
command: bundle exec rails db:schema:load --trace | |
name: Database setup | |
- run: bundle exec rails test:system | |
- store_test_results: | |
path: test/reports | |
- store_artifacts: | |
path: log/ | |
- store_artifacts: | |
path: tmp/capybara/ | |
- run: | |
name: Stash Coverage Results | |
command: | | |
mkdir coverage_results | |
cp -R coverage/.resultset.json coverage_results/.resultset-${CIRCLE_JOB}-${CIRCLE_NODE_INDEX}.json | |
- persist_to_workspace: | |
root: . | |
paths: | |
- coverage_results | |
workflows: | |
build_and_test: | |
jobs: | |
- lint | |
- test | |
- test-system | |
- coverage: | |
requires: | |
- test | |
- test-system | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Omakase Ruby styling for Rails | |
inherit_gem: | |
rubocop-rails-omakase: rubocop.yml | |
# Your own specialized rules go here | |
require: | |
- rubocop-rails | |
- rubocop-performance | |
- rubocop-minitest | |
AllCops: | |
TargetRubyVersion: 3.2 | |
TargetRailsVersion: 7.1 | |
NewCops: enable | |
Exclude: | |
- db/schema.rb | |
- db/migrate/* | |
- vendor/**/* | |
Bundler/OrderedGems: | |
ConsiderPunctuation: true | |
Layout/ArgumentAlignment: | |
EnforcedStyle: with_first_argument | |
Layout/ConditionPosition: | |
Enabled: false | |
Layout/DotPosition: | |
EnforcedStyle: leading | |
Layout/EmptyLines: | |
Exclude: | |
- test/**/* | |
- lib/practical_framework/tests/**/*.rb | |
- db/seeds/**/*.rb | |
Layout/IndentationConsistency: | |
EnforcedStyle: indented_internal_methods | |
Layout/LineLength: | |
AllowHeredoc: true | |
AllowURI: true | |
Max: 120 | |
Exclude: | |
- Gemfile | |
- test/**/* | |
- lib/practical_framework/tests/**/*.rb | |
Layout/SpaceBeforeBlockBraces: | |
Enabled: false | |
Layout/SpaceInsideHashLiteralBraces: | |
Enabled: false | |
Layout/SpaceInsideArrayLiteralBrackets: | |
Enabled: false | |
Layout/SpaceInsideBlockBraces: | |
Enabled: false | |
Layout/TrailingEmptyLines: | |
Enabled: false | |
Lint/AssignmentInCondition: | |
Enabled: true | |
AllowSafeAssignment: false | |
Lint/AmbiguousOperator: | |
Enabled: false | |
Lint/AmbiguousRegexpLiteral: | |
Enabled: false | |
Lint/DeprecatedClassMethods: | |
Enabled: false | |
Lint/ElseLayout: | |
Enabled: false | |
Lint/FlipFlop: | |
Enabled: false | |
Lint/LiteralInInterpolation: | |
Enabled: false | |
Lint/Loop: | |
Enabled: false | |
Lint/MissingSuper: | |
Enabled: false | |
Lint/ParenthesesAsGroupedExpression: | |
Enabled: false | |
Lint/RequireParentheses: | |
Enabled: false | |
Lint/SuppressedException: | |
Enabled: false | |
Lint/UnderscorePrefixedVariableName: | |
Enabled: false | |
Lint/UnusedMethodArgument: | |
Enabled: false | |
Lint/UselessAssignment: | |
Exclude: | |
- test/**/* | |
- lib/practical_framework/tests/**/*.rb | |
- db/seeds/**/*.rb | |
Metrics/BlockLength: | |
Exclude: | |
- test/**/*.rb | |
- config/**/*.rb | |
- db/migrate/*.rb | |
- lib/tasks/**/*.rake | |
- lib/practical_framework/tests/**/*.rb | |
- Gemfile | |
- app/components/**/*.rb | |
Metrics/BlockNesting: | |
Enabled: false | |
Metrics/AbcSize: | |
Enabled: false | |
Metrics/ClassLength: | |
Enabled: false | |
Metrics/CyclomaticComplexity: | |
Enabled: false | |
Metrics/MethodLength: | |
Enabled: false | |
Metrics/ModuleLength: | |
Exclude: | |
- test/**/* | |
- lib/practical_framework/tests/**/*.rb | |
Metrics/ParameterLists: | |
Enabled: false | |
Naming/AccessorMethodName: | |
Enabled: false | |
Naming/AsciiIdentifiers: | |
Enabled: false | |
Naming/FileName: | |
Enabled: false | |
Naming/MemoizedInstanceVariableName: | |
Enabled: false | |
Naming/PredicateName: | |
ForbiddenPrefixes: | |
- is_ | |
Naming/VariableNumber: | |
Enabled: false | |
Style/Alias: | |
Enabled: false | |
Style/ArrayJoin: | |
Enabled: false | |
Style/AsciiComments: | |
Enabled: false | |
Style/Attr: | |
Enabled: false | |
Style/CaseEquality: | |
Enabled: false | |
Style/CharacterLiteral: | |
Enabled: false | |
Style/ClassAndModuleChildren: | |
Enabled: false | |
Style/ClassVars: | |
Enabled: false | |
Style/CollectionMethods: | |
PreferredMethods: | |
find: false | |
reduce: inject | |
collect: map | |
find_all: false | |
Style/ColonMethodCall: | |
Enabled: false | |
Style/CommentAnnotation: | |
Enabled: false | |
Style/Documentation: | |
Enabled: false | |
Style/DoubleNegation: | |
Enabled: false | |
Style/EachWithObject: | |
Enabled: false | |
Style/EmptyLiteral: | |
Enabled: false | |
Style/Encoding: | |
Enabled: false | |
Style/EvenOdd: | |
Enabled: false | |
Style/FormatString: | |
Enabled: false | |
Style/FormatStringToken: | |
EnforcedStyle: template | |
Style/GlobalVars: | |
Enabled: false | |
Style/GuardClause: | |
Enabled: false | |
Style/HashSyntax: | |
EnforcedShorthandSyntax: never | |
Style/IfUnlessModifier: | |
Enabled: false | |
Style/IfWithSemicolon: | |
Enabled: false | |
Style/InlineComment: | |
Enabled: false | |
Style/Lambda: | |
Enabled: false | |
Style/LambdaCall: | |
Enabled: false | |
Style/LineEndConcatenation: | |
Enabled: false | |
Style/ModuleFunction: | |
Enabled: false | |
Style/NegatedIf: | |
Enabled: false | |
Style/NegatedWhile: | |
Enabled: false | |
Style/Next: | |
Enabled: false | |
Style/NilComparison: | |
Enabled: false | |
Style/NumberedParameters: | |
Enabled: true | |
EnforcedStyle: allow_single_line | |
Style/NumberedParametersLimit: | |
Enabled: true | |
Max: 1 | |
Style/NumericLiterals: | |
Enabled: false | |
Style/NumericPredicate: | |
EnforcedStyle: comparison | |
Style/OneLineConditional: | |
Enabled: false | |
Style/ParallelAssignment: | |
Enabled: false | |
Style/PercentLiteralDelimiters: | |
PreferredDelimiters: | |
"%": "()" | |
"%i": "()" | |
"%q": "()" | |
"%Q": "()" | |
"%r": "{}" | |
"%s": "()" | |
"%w": "()" | |
"%W": "()" | |
"%x": "()" | |
Style/PerlBackrefs: | |
Enabled: false | |
Style/Proc: | |
Enabled: false | |
Style/RaiseArgs: | |
Enabled: false | |
Style/RegexpLiteral: | |
Enabled: false | |
Style/SelfAssignment: | |
Enabled: false | |
Style/SignalException: | |
Enabled: false | |
Style/SingleLineBlockParams: | |
Enabled: false | |
Style/SingleLineMethods: | |
Enabled: false | |
Style/SpecialGlobalVars: | |
Enabled: false | |
Style/StringLiterals: | |
Enabled: false | |
Style/TrailingCommaInArguments: | |
Enabled: false | |
Style/TrailingCommaInArrayLiteral: | |
Enabled: false | |
Style/TrailingCommaInHashLiteral: | |
Enabled: false | |
Style/RedundantReturn: | |
Enabled: false | |
Style/TrivialAccessors: | |
Enabled: false | |
Style/VariableInterpolation: | |
Enabled: false | |
Style/WhenThen: | |
Enabled: false | |
Style/WhileUntilModifier: | |
Enabled: false | |
Style/FrozenStringLiteralComment: | |
EnforcedStyle: always | |
Enabled: true | |
Lint/SymbolConversion: | |
EnforcedStyle: consistent | |
Enabled: true | |
Style/WordArray: | |
Enabled: false | |
Rails/ActionFilter: | |
Enabled: false | |
Rails/Delegate: | |
Enabled: false | |
Rails/DynamicFindBy: | |
Enabled: false | |
Rails/Output: | |
Include: | |
- app/**/*.rb | |
- config/**/*.rb | |
- db/**/*.rb | |
- lib/**/*.rb | |
- test/**/*.rb | |
Rails/RequestReferer: | |
EnforcedStyle: referrer | |
Rails/SkipsModelValidations: | |
Enabled: false | |
Rails/I18nLocaleTexts: | |
Enabled: false | |
Performance/RedundantMerge: | |
Enabled: false | |
Performance/TimesMap: | |
Enabled: false | |
Rails/FilePath: | |
Enabled: false | |
# Temporary disable this until Ruby 3.3.1 is released | |
Naming/BlockForwarding: | |
Enabled: false |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment