factory_trace 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a4fdc48b79a78601b3d2340cbcdc79d8b360774b9902529e46a1451b8b8d17
-  data.tar.gz: cb65b8f2ba7ddcb4330c5c5a1655c2a608a8d53073ce48c819f07c9ea8ef848a
+  metadata.gz: 2a8964b9b2f6e4000d28ab545d781474d9c18668dbdb96a34de0c03b4282237f
+  data.tar.gz: 72a2d76a083cf9266e5296b3c538d7f9f49102acdd1328cd385fc1f9e8e3e6a8
 SHA512:
-  metadata.gz: 0674a565410c715b9ef283259dfb18a40b121b781ebcb19f09b1f91993f5393e7cdacb6f9bf32dd02fb8e680042997345a9669229c87f16a0bca8ebdfd4fe82e
-  data.tar.gz: 5a9c2d9fec08b8b0aea8935411b99cee0f863efb1e95bb78f868c7bf6f8ee44d9dbf49f28a46123505ed03071001fd728a646b37a3ef4fabdde1137c9561eb28
+  metadata.gz: 6096b82a57a43ab7ae87ef886f98ccda54dc0babb5e7a211d15a81464086e1fe479226af114fa745e5a47ce209df2fdcf0e81136f2058959e428147b98de248a
+  data.tar.gz: b683fd747531cbc50851834f2bbf0aa4a2f17c03e8eadbd7bc5ac2571312abd9046d2d4a46bd8499d0640e9f5e43e46e952583794a3a454ccc3c286029f42f6e

data/lib/factory_trace.rb

@@ -7,6 +7,7 @@ require 'factory_trace/configuration'
 require 'factory_trace/version'
 require 'factory_trace/helpers/converter'
 require 'factory_trace/helpers/statusable'
+require 'factory_trace/helpers/caller'
 require 'factory_trace/tracker'
 
 require 'factory_trace/structures/factory'
@@ -22,6 +23,12 @@ require 'factory_trace/readers/trace_reader'
 require 'factory_trace/writers/writer'
 require 'factory_trace/writers/report_writer'
 require 'factory_trace/writers/trace_writer'
+
+require 'factory_trace/monkey_patches/factory'
+require 'factory_trace/monkey_patches/trait'
+require 'factory_trace/monkey_patches/definition_proxy'
+require 'factory_trace/monkey_patches/dsl'
+
 # Integrations
 require 'integrations/rspec' if defined?(RSpec::Core)
 
@@ -29,6 +36,7 @@ module FactoryTrace
   class << self
     def start
       return unless configuration.enabled
+      trace_definitions! if configuration.trace_definition?
 
       tracker.track!
     end
@@ -67,5 +75,12 @@ module FactoryTrace
     def tracker
       @tracker ||= Tracker.new
     end
+
+    def trace_definitions!
+      FactoryBot::Factory.prepend(FactoryTrace::MonkeyPatches::Factory)
+      FactoryBot::Trait.prepend(FactoryTrace::MonkeyPatches::Trait)
+      FactoryBot::Syntax::Default::DSL.prepend(FactoryTrace::MonkeyPatches::Default::DSL)
+      FactoryBot::DefinitionProxy.prepend(FactoryTrace::MonkeyPatches::DefinitionProxy)
+    end
   end
 end

data/lib/factory_trace/configuration.rb

@@ -1,12 +1,17 @@
 module FactoryTrace
   class Configuration
-    attr_accessor :path, :enabled, :color, :mode
+    attr_accessor :path, :enabled, :color, :mode, :trace_definition
 
     def initialize
       @enabled = ENV.key?('FB_TRACE') || ENV.key?('FB_TRACE_FILE')
       @path = ENV['FB_TRACE_FILE']
       @color = path.nil?
       @mode = extract_mode(ENV['FB_TRACE']) || :full
+      @trace_definition = true
+    end
+
+    def trace_definition?
+      @trace_definition
     end
 
     def out

data/lib/factory_trace/helpers/caller.rb

@@ -0,0 +1,13 @@
+module FactoryTrace
+  module Helpers
+    module Caller
+      module_function
+
+      # @return [String] file and line where the original method was called
+      def location
+        location = caller_locations[1]
+        "#{location.absolute_path}:#{location.lineno}"
+      end
+    end
+  end
+end

data/lib/factory_trace/helpers/converter.rb

@@ -9,7 +9,8 @@ module FactoryTrace
       def trait(trait)
         FactoryTrace::Structures::Trait.new(
           trait.name.to_s,
-          declaration_names: extract_declarations(trait)
+          declaration_names: extract_declarations(trait),
+          definition_path: (trait.definition_path if trait.respond_to?(:definition_path))
         )
       end
 
@@ -21,7 +22,8 @@ module FactoryTrace
           factory.names.map(&:to_s),
           factory.defined_traits.map(&method(:trait)),
           parent_name: factory.send(:parent).respond_to?(:name) ? factory.send(:parent).name.to_s : nil,
-          declaration_names: extract_declarations(factory)
+          declaration_names: extract_declarations(factory),
+          definition_path: (factory.definition_path if factory.respond_to?(:definition_path))
         )
       end
 

data/lib/factory_trace/monkey_patches/definition_proxy.rb

@@ -0,0 +1,13 @@
+module FactoryTrace
+  module MonkeyPatches
+    module DefinitionProxy
+      def factory(name, options = {}, &block)
+        @child_factories << [name, Helpers::Caller.location, options, block]
+      end
+
+      def trait(name, &block)
+        @definition.define_trait(FactoryBot::Trait.new(name, Helpers::Caller.location, &block))
+      end
+    end
+  end
+end

data/lib/factory_trace/monkey_patches/dsl.rb

@@ -0,0 +1,25 @@
+module FactoryTrace
+  module MonkeyPatches
+    module Default
+      module DSL
+        def factory(name, options = {}, &block)
+          caller_location = options.delete(:caller_location) || Helpers::Caller.location
+          factory = FactoryBot::Factory.new(name, caller_location, options)
+          proxy = FactoryBot::DefinitionProxy.new(factory.definition)
+          proxy.instance_eval(&block) if block_given?
+
+          FactoryBot.register_factory(factory)
+
+          proxy.child_factories.each do |(child_name, child_caller_location, child_options, child_block)|
+            parent_factory = child_options.delete(:parent) || name
+            factory(child_name, child_options.merge(parent: parent_factory, caller_location: child_caller_location), &child_block)
+          end
+        end
+
+        def trait(name, &block)
+          FactoryBot.register_trait(FactoryBot::Trait.new(name, Helpers::Caller.location, &block))
+        end
+      end
+    end
+  end
+end

data/lib/factory_trace/monkey_patches/factory.rb

@@ -0,0 +1,12 @@
+module FactoryTrace
+  module MonkeyPatches
+    module Factory
+      attr_reader :definition_path
+
+      def initialize(name, definition_path, options = {})
+        @definition_path = definition_path
+        super(name, options)
+      end
+    end
+  end
+end

data/lib/factory_trace/monkey_patches/trait.rb

@@ -0,0 +1,12 @@
+module FactoryTrace
+  module MonkeyPatches
+    module Trait
+      attr_reader :definition_path
+
+      def initialize(name, definition_path, &block)
+        @definition_path = definition_path
+        super(name, &block)
+      end
+    end
+  end
+end

data/lib/factory_trace/processors/find_unused.rb

@@ -13,15 +13,15 @@ module FactoryTrace
         output = []
 
         defined.factories.each do |factory|
-          output << {code: :unused, factory_names: factory.names} unless factory.status
+          output << append_definition_path({code: :unused, factory_names: factory.names}, factory) unless factory.status
 
           factory.traits.each do |trait|
-            output << {code: :unused, factory_names: factory.names, trait_name: trait.name} unless trait.status
+            output << append_definition_path({code: :unused, factory_names: factory.names, trait_name: trait.name}, trait) unless trait.status
           end
         end
 
         defined.traits.each do |trait|
-          output << {code: :unused, trait_name: trait.name} unless trait.status
+          output << append_definition_path({code: :unused, trait_name: trait.name}, trait) unless trait.status
         end
 
         output.unshift(code: :unused, value: output.size)
@@ -104,6 +104,15 @@ module FactoryTrace
           mark_trait(declaration_trait, declaration_factory, collection, status: status) if declaration_trait
         end
       end
+
+      # @param [Hash]
+      # @param [FactoryTrace::Structures::Factory|FactoryTrace::Structures::Trait]
+      #
+      # @return [Hash]
+      def self.append_definition_path(hash, object)
+        hash[:definition_path] = object.definition_path if object.definition_path
+        hash
+      end
     end
   end
 end

data/lib/factory_trace/readers/trace_reader.rb

@@ -42,7 +42,7 @@ module FactoryTrace
       private
 
       def parse_trait(hash)
-        FactoryTrace::Structures::Trait.new(hash['name'], declaration_names: hash['declaration_names'])
+        FactoryTrace::Structures::Trait.new(hash['name'], declaration_names: hash['declaration_names'], definition_path: hash['definition_path'])
       end
 
       def parse_factory(hash)
@@ -50,7 +50,8 @@ module FactoryTrace
           hash['names'],
           hash['traits'].map(&method(:parse_trait)),
           parent_name: hash['parent_name'],
-          declaration_names: hash['declaration_names']
+          declaration_names: hash['declaration_names'],
+          definition_path: hash['definition_path']
         )
       end
 

data/lib/factory_trace/structures/factory.rb

@@ -3,17 +3,19 @@ module FactoryTrace
     class Factory
       include Helpers::Statusable
 
-      attr_reader :names, :parent_name, :traits, :declaration_names
+      attr_reader :names, :parent_name, :traits, :declaration_names, :definition_path
 
       # @param [Array<String>] names
       # @param [Array<FactoryTrace::Structure::Trait>] traits
       # @param [String|nil] parent_name
       # @param [Array<String>] declaration_names
-      def initialize(names, traits, parent_name: nil, declaration_names: [])
+      # @param [String] definition_path
+      def initialize(names, traits, parent_name: nil, declaration_names: [], definition_path: nil)
         @names = names
         @traits = traits
         @parent_name = parent_name
         @declaration_names = declaration_names
+        @definition_path = definition_path
       end
 
       # @return [Hash<Symbol, Object>]
@@ -22,7 +24,8 @@ module FactoryTrace
           names: names,
           traits: traits.map(&:to_h),
           parent_name: parent_name,
-          declaration_names: declaration_names
+          declaration_names: declaration_names,
+          definition_path: definition_path
         }
       end
 
@@ -42,7 +45,8 @@ module FactoryTrace
         names == factory.names &&
           traits == factory.traits &&
           parent_name == factory.parent_name &&
-          declaration_names == factory.declaration_names
+          declaration_names == factory.declaration_names &&
+          definition_path == factory.definition_path
       end
     end
   end

data/lib/factory_trace/structures/trait.rb

@@ -3,20 +3,23 @@ module FactoryTrace
     class Trait
       include Helpers::Statusable
 
-      attr_reader :name, :declaration_names
+      attr_reader :name, :declaration_names, :definition_path
 
       # @param [String] name
       # @param [Array<String>] declaration_names
-      def initialize(name, declaration_names: [])
+      # @param [String] definition_path
+      def initialize(name, declaration_names: [], definition_path: nil)
         @name = name
         @declaration_names = declaration_names
+        @definition_path = definition_path
       end
 
       # @return [Hash<Symbol, Object>]
       def to_h
         {
           name: name,
-          declaration_names: declaration_names
+          declaration_names: declaration_names,
+          definition_path: definition_path
         }
       end
 
@@ -24,7 +27,7 @@ module FactoryTrace
       def ==(trait)
         return false unless trait.is_a?(FactoryTrace::Structures::Trait)
 
-        name == trait.name && declaration_names == trait.declaration_names
+        name == trait.name && declaration_names == trait.declaration_names && definition_path == trait.definition_path
       end
     end
   end

data/lib/factory_trace/version.rb

@@ -1,3 +1,3 @@
 module FactoryTrace
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/lib/factory_trace/writers/report_writer.rb

@@ -31,11 +31,11 @@ module FactoryTrace
         when result[:value]
           colorize(total_color, "total number of unique #{humanize_code(result[:code])} factories & traits: #{result[:value]}")
         when result[:factory_names] && result[:trait_name]
-          "#{humanize_code(result[:code])} trait #{colorize(:blue, result[:trait_name])} of factory #{list(result[:factory_names])}"
+          append_definition_path(result) { "#{humanize_code(result[:code])} trait #{colorize(:blue, result[:trait_name])} of factory #{list(result[:factory_names])}" }
         when result[:factory_names]
-          "#{humanize_code(result[:code])} factory #{list(result[:factory_names])}"
+          append_definition_path(result) { "#{humanize_code(result[:code])} factory #{list(result[:factory_names])}" }
         else
-          "#{humanize_code(result[:code])} global trait #{colorize(:blue, result[:trait_name])}"
+          append_definition_path(result) { "#{humanize_code(result[:code])} global trait #{colorize(:blue, result[:trait_name])}" }
         end
       end
 
@@ -45,6 +45,13 @@ module FactoryTrace
         "#{COLORS[color]}#{msg}\e[0m"
       end
 
+      def append_definition_path(result)
+        msg = yield
+        return msg unless configuration.trace_definition? && result[:definition_path]
+
+        "#{msg} => #{result[:definition_path]}"
+      end
+
       def humanize_code(code)
         CODES[code]
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_trace
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - djezzzl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-28 00:00:00.000000000 Z
+date: 2019-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -77,8 +77,13 @@ files:
 - exe/factory_trace
 - lib/factory_trace.rb
 - lib/factory_trace/configuration.rb
+- lib/factory_trace/helpers/caller.rb
 - lib/factory_trace/helpers/converter.rb
 - lib/factory_trace/helpers/statusable.rb
+- lib/factory_trace/monkey_patches/definition_proxy.rb
+- lib/factory_trace/monkey_patches/dsl.rb
+- lib/factory_trace/monkey_patches/factory.rb
+- lib/factory_trace/monkey_patches/trait.rb
 - lib/factory_trace/preprocessors/extract_defined.rb
 - lib/factory_trace/preprocessors/extract_used.rb
 - lib/factory_trace/processors/find_unused.rb