README.adoc in caliber-0.31.0 vs README.adoc in caliber-0.32.0

- old
+ new

@@ -2,29 +2,31 @@ :toclevels: 5 :figure-caption!: :rubocop_link: link:https://docs.rubocop.org/rubocop[RuboCop] :rubocop_capybara_link: link:https://docs.rubocop.org/rubocop-capybara[RuboCop Capybara] +:rubocop_factory_bot_link: link:https://docs.rubocop.org/rubocop-factory_bot/[RuboCop FactoryBot] :rubocop_performance_link: link:https://docs.rubocop.org/rubocop-performance[RuboCop Performance] :rubocop_thread_safety_link: link:https://github.com/rubocop/rubocop-thread_safety[RuboCop Thread Safety] :rubocop_rake_link: link:https://docs.rubocop.org/rubocop-rspec[RuboCop Rake] :rubocop_rspec_link: link:https://docs.rubocop.org/rubocop-rspec[RuboCop RSpec] = Caliber This gem provides global link:https://docs.rubocop.org/rubocop[RuboCop] configurations for ensuring -high quality _and_ consistent software development practices. +high quality _and consistent_ software development practices. -_Due to the ever changing nature of the RuboCop ecosystem -- and the fact that it's very easy to fall behind quickly -- this gem takes an aggressive approach to staying up to date with latest changes within the RuboCop community. This also means this gem will probably never reach Version 1.0.0 because new changes are being introduced in each minor release. That said, if you always want to be on top of recent changes -- *because you know how costly technical debt is* -- then this gem has you covered. 🎉_ +_Due to the ever changing nature of the RuboCop ecosystem -- and the fact you can fall behind quickly -- this gem takes an aggressive approach to staying atop the latest changes. This also means this gem might never reach Version 1.0.0 because new -- often breaking -- changes are being introduced in each minor release. That said, if you always want to keep pace with recent changes -- *because you know how costly technical debt is* -- then this gem has you covered. 🎉_ toc::[] == Features * Provides a global configuration for the following code quality gems: ** {rubocop_link} ** {rubocop_capybara_link} +** {rubocop_factory_bot_link} ** {rubocop_performance_link} ** {rubocop_thread_safety_link} ** {rubocop_rake_link} ** {rubocop_rspec_link} @@ -81,18 +83,19 @@ That's it! === Customization -You can customize the gem by specifiying what you need: +You can customize the gem by specifying what you need: [source,yaml] ---- inherit_gem: caliber: - config/ruby.yml - config/capybara.yml + - config/factory_bot.yml - config/performance.yml - config/thread.yml - config/rake.yml - config/rspec.yml ---- @@ -112,10 +115,11 @@ The above will require and load the configurations for following gems: * {rubocop_link} * {rubocop_capybara_link} +* {rubocop_factory_bot_link} * {rubocop_performance_link} * {rubocop_thread_safety_link} * {rubocop_rake_link} * {rubocop_rspec_link} @@ -141,10 +145,25 @@ - config/capybara.yml ---- The above will only require the {rubocop_capybara_link} gem _and_ load the associated configuration. +💡 This is a dependency of {rubocop_rspec_link} so doesn't need to be directly required if already requiring {rubocop_rspec_link}. + +*FactoryBot* + +[source,yaml] +---- +inherit_gem: + caliber: + - config/factory_bot.yml +---- + +The above will only require the {rubocop_factory_bot_link} gem _and_ load the associated configuration. + +💡 This is a dependency of {rubocop_rspec_link} so doesn't need to be directly required if already requiring {rubocop_rspec_link}. + *Performance* [source,yaml] ---- inherit_gem: @@ -204,10 +223,11 @@ [source,yaml] ---- inherit_from: - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/ruby.yml - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/capybara.yml + - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/factory_bot.yml - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/performance.yml - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/thread.yml - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/rake.yml - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/rspec.yml ---- @@ -216,10 +236,11 @@ Lastly, when using this YAML import approach, you'll not benefit from having all gems you need required and installed for you. So you'll need to manually require these gems in your `Gemfile`: * {rubocop_link} * {rubocop_capybara_link} +* {rubocop_factory_bot_link} * {rubocop_performance_link} * {rubocop_thread_safety_link} * {rubocop_rake_link} * {rubocop_rspec_link} @@ -266,10 +287,11 @@ When both RuboCop and Caliber are in sync, the following will be output: .... RUBY: ✓ CAPYBARA: ✓ +FACTORY_BOT: ✓ PERFORMANCE: ✓ THREAD: ✓ RAKE: ✓ RSPEC: ✓ .... @@ -280,9 +302,10 @@ .... RUBY: * Lint/BinaryOperatorWithIdenticalOperands * Lint/ConstantDefinitionInBlock CAPYBARA: ✓ +FACTORY_BOT: ✓ PERFORMANCE: ✓ THREAD: ✓ RAKE: ✓ RSPEC: * RSpec/StubbedMock