factory_bot-awesome_linter 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4a2f5d05d6d9ca4043893d5c91205e859ba510a16a79437e20d7346a5f80d75
-  data.tar.gz: 477c1487d7b700b374b27e3e0943e27664ffd5892ebdcdbcb07e7d67bd34ed3c
+  metadata.gz: ae90b0c8efc9e341ac25b4edc3455c4cd9e73734a45b53d2501b8491e409b3c3
+  data.tar.gz: 5d43d76e260da885ce7a70cd139b3b0dee54e7faf73ca733583e853e3e6abecf
 SHA512:
-  metadata.gz: dc8fb4c26f797fcaef3820e45df7cb255432941feec7ccd6ca40b239a322e7b8a48eacf7ccbf3b329c94eec9be69a822336af0aaa0db56e4f7dd0ce1078164e9
-  data.tar.gz: 94b4841a8604386094d5927c06f3dc5c2db6541fbd020bbf87d929f953d54d860eb930ce44f556edd121991bd9a184da53d23decebef6482a5527d725c9f4a82
+  metadata.gz: 5c06274829cba67b130a75d0b585e3ad74228381c119fc39ad63d9fa709bd42f4027b437415827a76fbaf21641f47f3b14845ed5e2f58fcb8da90c3531799c05
+  data.tar.gz: 1837ff2d64c83ea65f15b089b4dd7c022b6394597d10ca0678e6962eb6d23074b1aaaa06ad6791f8fe09c3bb69733b12d7c2731c08916ab8c5fc948bc740e8fb

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2022 Savater Sebastien
+
+MIT License
+
+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,123 @@
+# Awesome linter for FactoryBot
+
+This gem enhances [FactoryBot linter](https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#linting-factories)
+
+* it wraps factories creation:
+  * within DatabaseCleaner if present
+  * within ActiveRecord within transaction if DatabaseCleaner is not present but ActiveRecord is
+
+* it displays a progress bar and quickly display failures (just like [fuubar](https://github.com/thekompanee/fuubar))
+* it shows backtraces when factories failed
+* it lints all factories and traits by default
+* it allows easy selection of factories
+* it reloads cached factories before each run
+
+[![Gem Version](https://badge.fury.io/rb/factory_bot-awesome_linter.svg)](https://rubygems.org/gems/factory_bot-awesome_linter)
+[![CI Status](https://github.com/inkstak/factory_bot-awesome_linter/actions/workflows/ci.yml/badge.svg)](https://github.com/inkstak/factory_bot-awesome_linter/actions/workflows/ci.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9bb8b75ea8c66b1a9c94/maintainability)](https://codeclimate.com/github/inkstak/factory_bot-awesome_linter/maintainability)
+<!-- [![Test Coverage](https://api.codeclimate.com/v1/badges/9bb8b75ea8c66b1a9c94/test_coverage)](https://codeclimate.com/github/inkstak/factory_bot-awesome_linter/test_coverage) -->
+
+## Installation
+
+Add these line to your application's Gemfile:
+
+```ruby
+gem 'factory_bot-awesome_linter'
+```
+
+## Usage
+
+Just run:
+
+```ruby
+FactoryBot::AwesomeLinter.lint!
+```
+
+All factories are included by default.
+You can select factories to lint by passing their names, a regexp, or factories:
+
+```ruby
+FactoryBot::AwesomeLinter.lint!(:user)
+FactoryBot::AwesomeLinter.lint!(:user, :account)
+FactoryBot::AwesomeLinter.lint!(/^new_/)
+
+factories_to_lint = FactoryBot.factories.reject do |factory|
+  factory.name =~ /^old_/
+end
+
+FactoryBot::AwesomeLinter.lint!(*factories_to_lint)
+```
+
+All traits are included by default.  
+You can exclude them:
+
+```ruby
+FactoryBot::AwesomeLinter.lint!(traits: false)
+```
+
+Default linting strategy is `:create`.  
+You can specify another or multiple strategies used for linting:
+
+```ruby
+FactoryBot::AwesomeLinter.lint!(strategy: :build)
+FactoryBot::AwesomeLinter.lint!(strategy: %i[create build_stubbed])
+```
+
+All arguments can be combined:
+
+```ruby
+FactoryBot::AwesomeLinter.lint!(:user, strategy: :build, traits: false)
+```
+
+## Rake task
+
+Create the following task in `lib/tasks/factory_bot.rake`
+
+```ruby
+namespace :factory_bot do
+  desc "Verify that all FactoryBot factories are valid"
+  task lint: :environment do
+    if Rails.env.test?
+      abort unless FactoryBot::AwesomeLinter.lint!
+    else
+      puts "Wrong environment detected to run factory_bot:lint"
+      puts "Running `bundle exec bin/rails factory_bot:lint RAILS_ENV='test'` instead"
+
+      system("bundle exec bin/rails factory_bot:lint RAILS_ENV='test'")
+      exit $CHILD_STATUS.exitstatus
+    end
+  end
+end
+```
+
+Then run :
+
+```
+bundle exec bin/rails factory_bot:lint RAILS_ENV='test'
+```
+
+## TODO
+
+* Add tests
+
+## Contributing
+
+1. Don't hesitate to submit your feature/idea/fix in [issues](https://github.com/inkstak/factory_bot-awesome_linter)
+2. Fork the [repository](https://github.com/inkstak/factory_bot-awesome_linter)
+3. Create your feature branch
+4. Ensure Rubocop are passing
+4. Create a pull request
+
+### Lint
+
+```bash
+bundle exec rubocop
+```
+
+## License & credits
+
+Inspired by the awesome work from [Thoughtbot](https://github.com/thoughtbot/factory_bot).
+
+Please see [LICENSE](https://github.com/inkstak/factory_bot-awesome_linter/blob/main/LICENSE) for further details.
+
+Contributors: [./graphs/contributors](https://github.com/inkstak/factory_bot-awesome_linter/graphs/contributors)

data/lib/factory_bot-awesome_linter/version.rb

@@ -1,5 +1,5 @@
 module FactoryBot
   class AwesomeLinter
-    VERSION = '1.0.5'.freeze
+    VERSION = "1.0.6".freeze
   end
 end

data/lib/factory_bot-awesome_linter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'factory_bot'
-require 'ruby-progressbar'
+require "factory_bot"
+require "ruby-progressbar"
 
 module FactoryBot
   class AwesomeLinter
@@ -11,10 +11,9 @@ module FactoryBot
 
     def initialize(*args, strategy: :create, traits: true)
       @factories_to_lint = load_factories(*args)
-
-      @factory_strategy  = strategy
-      @traits            = traits
-      @progress_bar      = ProgressBar.create(format: "\e[0;32m %c/%C |%w>%i| %e \e[0m")
+      @factory_strategies = Array.wrap(strategy)
+      @traits = traits
+      @progress_bar = ProgressBar.create(format: "\e[0;32m %c/%C |%w>%i| %e \e[0m")
       @invalid_factories = []
     end
 
@@ -72,18 +71,22 @@ module FactoryBot
     end
 
     def lint_factory(factory)
-      cleaning do
-        FactoryBot.public_send(@factory_strategy, factory.name)
+      @factory_strategies.each do |stategy|
+        cleaning do
+          FactoryBot.public_send(stategy, factory.name)
+        end
       end
-    rescue StandardError => e
+    rescue => e
       invalid_factory! e, factory
     end
 
     def lint_trait(factory, trait)
-      cleaning do
-        FactoryBot.public_send(@factory_strategy, factory.name, trait.name)
+      @factory_strategies.each do |stategy|
+        cleaning do
+          FactoryBot.public_send(stategy, factory.name, trait.name)
+        end
       end
-    rescue StandardError => e
+    rescue => e
       invalid_factory! e, factory, trait
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot-awesome_linter
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Savater Sebastien
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -39,12 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.11.0
 description:
-email:
-- savater.sebastien@gmail.com
+email: github.60k5k@simplelogin.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/factory_bot-awesome_linter.rb
 - lib/factory_bot-awesome_linter/version.rb
 homepage: https://github.com/inkstak/factory_bot-awesome_linter
@@ -66,8 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: Enhanced linter for FactoryBot
+summary: An awesome linter for FactoryBot
 test_files: []