factory_bot-awesome_linter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 617261095c26b3a682b99159a3cde1ec380c854be48bef7be0828db2e50c02a0
+  data.tar.gz: 9d2ab786572209fb46735949648e2efb78c1dcfd55ee4a5e6ea1cac2bd51df4f
+SHA512:
+  metadata.gz: b5f9217d10a5ece6f8375f750866de7d77d9ea58be815a3296468ed095d518d471c4e5951138c1ab0e54e8784effcb559b35ba2b5de04bbeb3b6b0b6c80b0eff
+  data.tar.gz: dfdf9392b11e132c1fad5c3ce4f07182e1c1f599623ef72ed01132305d88f5afeb3d577f7d605fa44c8f30021ee9bf2c2185765a38e006e9578515fd8c33bb05

data/lib/factory_bot-awesome_linter.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'ruby-progressbar'
+
+module FactoryBot
+  class AwesomeLinter
+    def self.lint!(*args, **kwargs)
+      new(*args, **kwargs).lint!
+    end
+
+    def initialize(*args, strategy: :create, traits: false, verbose: false)
+      if args.any?
+        @factories_to_lint = args[0]
+      else
+        FactoryBot.reload
+        @factories_to_lint = FactoryBot.factories
+      end
+
+      @factory_strategy  = strategy
+      @traits            = traits
+      @verbose           = verbose
+      @progress_bar      = ProgressBar.create(format: "\e[0;32m %c/%C |%w>%i| %e \e[0m")
+      @invalid_factories = []
+    end
+
+    attr_reader :progress_bar, :factories_to_lint, :invalid_factories
+
+    def lint!
+      progress_bar.total = calculate_total
+
+      factories_to_lint.each do |factory|
+        lint_factory(factory)
+        progress_bar.increment
+
+        next unless @traits
+
+        factory.definition.defined_traits.each do |trait|
+          lint_trait(factory, trait)
+          progress_bar.increment
+        end
+      end
+
+      progress_bar.stop
+
+      output_invalid_factories
+      invalid_factories.empty?
+    end
+
+    def calculate_total
+      factories_to_lint.reduce(0) do |count, factory|
+        # Compile factory to count enum traits
+        factory.compile
+
+        count + 1 + factory.definition.defined_traits.size
+      end
+    end
+
+    def lint_factory(factory)
+      cleaning do
+        FactoryBot.public_send(@factory_strategy, factory.name)
+      end
+    rescue StandardError => e
+      invalid_factory! e, factory
+    end
+
+    def lint_trait(factory, trait)
+      cleaning do
+        FactoryBot.public_send(@factory_strategy, factory.name, trait.name)
+      end
+    rescue StandardError => e
+      invalid_factory! e, factory
+    end
+
+    def invalid_factory!(error, factory, trait = nil)
+      name = ":#{factory.name}"
+      name += " + :#{trait.name}" if trait
+
+      invalid_factories << name
+
+      progress_bar.format = "\e[0;31m %c/%C |%w>%i| %e \e[0m"
+
+      progress_bar.log "\n  - Invalid factory: #{name}"
+      progress_bar.log "\n    \e[0;31m#{error.message}\e[0m"
+
+      error.backtrace[0..10].each do |s|
+        progress_bar.log "    \e[0;36m# #{s}\e[0m"
+      end
+
+      progress_bar.log "\n"
+    end
+
+    def output_invalid_factories
+      return if invalid_factories.empty?
+
+      $stdout.puts "\nInvalid factories:"
+
+      invalid_factories.each do |name|
+        $stdout.puts "  \e[0;31m- #{name}\e[0m"
+      end
+
+      $stdout.puts
+    end
+
+    def cleaning(&block)
+      if defined?(DatabaseCleaner)
+        DatabaseCleaner.cleaning(&block)
+      elsif defined?(ActiveRecord)
+        @activerecord_connection ||= ActiveRecord::Base.connection
+        @activerecord_connection.transaction(&block)
+      else
+        raise "No cleaning strategie available, you may require or include database-cleaner in your Gemfile"
+      end
+    end
+  end
+end

data/lib/factory_bot-awesome_linter/version.rb

@@ -0,0 +1,5 @@
+module FactoryBot
+  class AwesomeLinter
+    VERSION = '0.0.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: factory_bot-awesome_linter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Savater Sebastien
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+description:
+email:
+- savater.sebastien@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/factory_bot-awesome_linter.rb
+- lib/factory_bot-awesome_linter/version.rb
+homepage: https://github.com/inkstak/factory_bot-awesome_linter
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Enhanced linter for FactoryBot
+test_files: []