factory_trace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47eb79312468fdf6bb3625c9046f6372d44cf56b84b052d1018d049b4f2d25fb
+  data.tar.gz: 763c2b6a5b1af979b2a7ef3f64e5ed7beb2ce74a88e8f40826d5939b9fe338ae
+SHA512:
+  metadata.gz: 8376bf6ccb33ff20681d990ed2710cb7e821524d9748ac8ae9222a58215abdc735b35aa5f55f851e669bd8e44c2c3f81795a646783e8b81c63c90c168ab4c7d4
+  data.tar.gz: b1262635dc1965e4107987f0bf686ae6bc94ac468d60906af41c93bf8f988cccccc7331c08a0723f793c5c463f2538764edbc832f1ab2649c5bc930ab390fb5f

data/lib/factory_trace/check_unused.rb

@@ -0,0 +1,75 @@
+module FactoryTrace
+  class CheckUnused
+
+    # @param [Hash<Symbol, Set<Symbol>>]
+    def initialize(data)
+      @initial_data = data
+    end
+
+    # @return [Array<Hash>]
+    def check!
+      data = prepare(initial_data)
+
+      output = []
+
+      FactoryBot.factories.each do |factory|
+        unless data[factory.name.to_s]
+          output << {code: :unused, factory: factory}
+          next
+        end
+
+        factory.defined_traits.each do |trait|
+          output << {code: :unused, factory: factory, trait: trait} unless data[factory.name.to_s].include?(trait.name.to_s)
+        end
+      end
+
+      FactoryBot.traits.each do |trait|
+        output << {code: :unused, trait: trait} unless data['_traits'].include?(trait.name.to_s)
+      end
+
+      output
+    end
+
+    private
+
+    # Return new structure where each trait is moved to its own factory
+    #
+    # @param [Hash<Symbol, Set<Symbol>>]
+    #
+    # @return [Hash<String, Set<String>>]
+    def prepare(data)
+      # +_traits+ is for global traits
+      output = {'_traits' => Set.new}
+
+      data.each do |factory_name, trait_names|
+        factory_name = factory_name.to_s
+
+        output[factory_name] ||= Set.new
+
+        trait_names.each do |trait_name|
+          trait_name = trait_name.to_s
+
+          factory = FactoryBot.factories[factory_name]
+          trait_found = false
+
+          until factory.is_a?(FactoryBot::NullFactory)
+            if factory.defined_traits.any? { |trait| trait.name.to_s == trait_name }
+              trait_found = true
+              output[factory.name.to_s] ||= Set.new
+              output[factory.name.to_s] << trait_name
+              break
+            end
+            factory = factory.send(:parent)
+          end
+
+          # Belongs to global traits
+          output['_traits'] << trait_name unless trait_found
+        end
+      end
+
+      output
+    end
+
+    attr_reader :initial_data
+  end
+end

data/lib/factory_trace/configuration.rb

@@ -0,0 +1,16 @@
+module FactoryTrace
+  class Configuration
+    attr_accessor :path, :enabled
+
+    def initialize
+      @enabled = ENV.key?('FB_TRACE') || ENV.key?('FB_TRACE_FILE')
+      @path = ENV['FB_TRACE_FILE']
+    end
+
+    def out
+      return STDOUT unless path
+
+      File.open(path, 'w')
+    end
+  end
+end

data/lib/factory_trace/printer.rb

@@ -0,0 +1,32 @@
+module FactoryTrace
+  class Printer
+    def initialize(io)
+      @io = io
+    end
+
+    # @param [Array<Hash>] results
+    def print(results)
+      results.each do |result|
+        io.puts(convert(result))
+      end
+    end
+
+    private
+
+    # @param [Hash<Symbol, Object>] result
+    def convert(result)
+      suffix =
+        case
+        when result[:factory] && result[:trait]
+          "trait '#{result[:trait].name}' of factory '#{result[:factory].name}'"
+        when result[:factory]
+          "factory '#{result[:factory].name}'"
+        else
+          "global trait '#{result[:trait].name}'"
+        end
+      "#{result[:code]} #{suffix}"
+    end
+
+    attr_reader :io
+  end
+end

data/lib/factory_trace/tracker.rb

@@ -0,0 +1,21 @@
+require 'set'
+
+module FactoryTrace
+  class Tracker
+    attr_reader :storage
+
+    def initialize
+      @storage = {}
+    end
+
+    def track!
+      ActiveSupport::Notifications.subscribe('factory_bot.run_factory') do |_name, _start, _finish, _id, payload|
+        name = payload[:name]
+        traits = payload[:traits]
+
+        storage[name] ||= Set.new
+        storage[name] |= traits
+      end
+    end
+  end
+end

data/lib/factory_trace/version.rb

@@ -0,0 +1,3 @@
+module FactoryTrace
+  VERSION = '0.1.0'
+end

data/lib/factory_trace.rb

@@ -0,0 +1,46 @@
+# External dependencies
+require 'factory_bot'
+# Library
+require 'factory_trace/configuration'
+require 'factory_trace/version'
+require 'factory_trace/tracker'
+require 'factory_trace/check_unused'
+require 'factory_trace/printer'
+# Integrations
+require 'integrations/rspec'
+
+module FactoryTrace
+  class << self
+    def start
+      return unless configuration.enabled
+
+      tracker.track!
+    end
+
+    def stop
+      return unless configuration.enabled
+
+      result = CheckUnused.new(tracker.storage).check!
+
+      printer.print(result)
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    private
+
+    def tracker
+      @tracker ||= Tracker.new
+    end
+
+    def printer
+      @printer ||= Printer.new(configuration.out)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/lib/integrations/rspec.rb

@@ -0,0 +1,6 @@
+if defined?(RSpec)
+  RSpec.configure do |config|
+    config.before(:suite) { FactoryTrace.start }
+    config.after(:suite) { FactoryTrace.stop }
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: factory_trace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- djezzzl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- lawliet.djez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/factory_trace.rb
+- lib/factory_trace/check_unused.rb
+- lib/factory_trace/configuration.rb
+- lib/factory_trace/printer.rb
+- lib/factory_trace/tracker.rb
+- lib/factory_trace/version.rb
+- lib/integrations/rspec.rb
+homepage: https://github.com/djezzzl/factory_trace
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Provide an easy way to maintain factories and traits from FactoryBot
+test_files: []