factory_bot_factory 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3759620bd063f6090d72c455055888f658fcd1348304983ca5c595a053d3302c
-  data.tar.gz: aa08b76ac4326ac1157a0f1c4e8cb87a5136e4a5f6a4bbc3811bed378f051443
+  metadata.gz: 87990d0dd64bc2e27d69c168a55f6057336b57796d44f5e6f6a807bd4182b26d
+  data.tar.gz: 037046cca064e07df3b08e7dbb9216856282e93b8f57bf76fae80e2f915e9980
 SHA512:
-  metadata.gz: 1d38b330bad4022cb2cdca6acaeed2ff38791e38d99fb5c168c0927b764a86791fae4f6c9ce8a033efbe0b12f4f51fe55e4f99bb1dbfc86478b4e31f4b2147be
-  data.tar.gz: a4d7f9f6c9d2ec67810648aee8eaafd283a0cc324169e1b72fcf30bf04a6e5212b0b3bf2dad9f8d4a0bf6bb7b9ae45f91746caf23b913f06f6be0c355c5e97bd
+  metadata.gz: 0c4af2c20e34c6f3cd0b955be96f8b9b17c459266742bb77302851a96177ffc277b3b16d3e64fa2392657387f55a748b965a2f0d978e09dbe228b99f5b7d4023
+  data.tar.gz: 4517dea66cccabe7abe4a27cd1b7e090c309491348db5957cfcf6cadb7bb4d3255803d6b5c3333cc25f409e330ab24db9f4a5dad31e8a0fb4ab5dc32e49f59a2

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    factory_bot_factory (1.1.0)
+    factory_bot_factory (1.2.0)
+      factory_bot (>= 4.8.2)
 
 GEM
   remote: https://rubygems.org/
@@ -56,7 +57,6 @@ PLATFORMS
 DEPENDENCIES
   activerecord (> 5.0.0.1)
   bundler (>= 2.2.10)
-  factory_bot
   factory_bot_factory!
   faker
   pry (~> 0.13.1)

data/README.md

@@ -76,7 +76,7 @@ FactoryBot.reload
 FactoryBot.build(:hash, id: 2)
 ```
 
-- `factory_name` - Specifize Factory Name
+- `factory_name` - Specify Factory Name
 
 ```ruby
 puts FactoryBotFactory.build({ id: 1 }, factory_name: 'order')
@@ -90,7 +90,7 @@ FactoryBot.define do
 end
 ```
 
-- `klass` - Specifize Output Data Structure: Hash, OpenStruct and your ActiveModel or ActiveRecord Model
+- `klass` - Specify Output Data Structure: Hash, OpenStruct and your ActiveModel or ActiveRecord Model
 
 You can convert your Hash object to OpenStruct factory.
 
@@ -124,7 +124,8 @@ Converter should respond to `call` method and return single or array of executab
 
 ```ruby
 FactoryBotFactory.configure do |config|
-  config.string_converter = Proc.new { |k, v|
+  config.numeric_converter = Proc.new { |k, v| 'rand(99)' }
+  config.string_converter = Proc.new do |k, v|
     if v.to_s.match?(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/)
       'Random.uuid()'
     elsif k.to_s.include?('name')
@@ -132,9 +133,7 @@ FactoryBotFactory.configure do |config|
     else
       "'#{v}'"
     end
-  }
-
-  config.numeric_converter = Proc.new { |k, v| 'rand(99)' }
+  end
 end
 
 FactoryBotFactory.build({ name: 'My Name', id: "de9515ee-006e-4a28-8af3-e88a5c771b93", age: 10 })
@@ -150,7 +149,7 @@ FactoryBot.define do
 end
 ```
 
-See more converters [Here](https://github.com/cdragon1116/factory_bot_factory/blob/release/1.1.0/lib/factory_bot_factory/config.rb#L3-L13)
+See more converters [Here](https://github.com/cdragon1116/factory_bot_factory/blob/main/lib/factory_bot_factory/config.rb#L3-L13)
 
 ## Contributing
 

data/factory_bot_factory.gemspec

@@ -23,13 +23,15 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 1.8.6'
 
   spec.add_development_dependency "bundler", ">= 2.2.10"
   spec.add_development_dependency 'rake', '>= 11.2.2'
   spec.add_development_dependency "pry", '~> 0.13.1'
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "faker"
   spec.add_development_dependency "activerecord", "> 5.0.0.1"
   spec.add_development_dependency "sqlite3"
+
+  spec.add_dependency "factory_bot", '>= 4.8.2'
 end

data/lib/factory_bot_factory/base.rb

@@ -1,29 +1,18 @@
 module FactoryBotFactory
   class Base
     class << self
-      def build(*args)
-        factory_name, klass, data, options = build_args(*args)
-        options ||= {}
+      def build(data, options = {})
+        options[:klass] ||= data.class
+        options[:factory_name] ||= data.class.name.downcase
 
-        raise ArgumentError if factory_name.nil? || klass.nil? || !valid_data?(data)
+        raise ArgumentError, "Unsupported data type. Supported format: Hash, OpenStruct, ActiveRecord instance." unless valid_data?(data)
         raise NestedToDeepError, 'Only support 5 nested levels' if options[:nested_level].to_i > 5
 
-        factory(klass, data).new({ factory_name: factory_name }.merge(options)).generate(data)
+        factory(options[:klass], data).new(options).generate(data)
       end
 
       private
 
-      def build_args(*args)
-        # To be deprecated
-        if args[0].is_a?(String) || args[0].is_a?(Symbol) && args.size >= 3
-          args
-        else
-          arg = args[0]
-          options = args[1..-1].inject({}) { |h, _h| h.merge(_h) } if args[1..-1]
-          [arg.class.name.downcase, (options[:klass] || arg.class), arg, options]
-        end
-      end
-
       def factory(klass, data)
         if active_record?(data) && klass == data.class
           Object.const_get("FactoryBotFactory::ActiveRecordFactory")

data/lib/factory_bot_factory/config.rb

@@ -13,15 +13,20 @@ module FactoryBotFactory
     }
 
     DEFAULT_OPTIONS = {
-      factory_path: nil
+      factory_path: nil,
+      print_output: false
     }.merge(DEFAULT_CONVERTERS)
 
     attr_accessor *DEFAULT_OPTIONS.keys
 
     def initialize(options = {})
       options = DEFAULT_OPTIONS.merge(options)
-      options[:factory_path] = options[:factory_path][0..-2] if options[:factory_path]&.end_with?("/")
       options.each { |k, v| instance_variable_set(:"@#{k}", v) }
     end
+
+    def factory_path=(path)
+      path = path[0..-2] if path&.end_with?("/")
+      @factory_path = path
+    end
   end
 end

data/lib/factory_bot_factory/factories/base_factory.rb

@@ -1,44 +1,57 @@
+require "factory_bot_factory/file_writer"
+
 module FactoryBotFactory
   class BaseFactory
 
+    attr_reader :file_path
+
     def initialize(options = {})
       @factory_name  = options[:factory_name]
-      @file_path     = options[:file_path]
+      @file_path     = build_file_path(options[:file_path])
       @nested_level  = [(options[:nested_level] || 1), 5].min
       @line_writer   = LineWriter.new(options)
       @factory_queue = []
     end
 
     def generate(data)
-      output = LineWriter.wrap_definition do
-        push_to_factory_queue(@factory_name, data, @nested_level)
-        inner_output = []
+      push_to_factory_queue(@factory_name, data, @nested_level)
+      output = []
 
-        loop do
-          factory_option = @factory_queue.shift
-          inner_output += build_factory(*factory_option)
-          break if @factory_queue.empty?
-          inner_output << LineWriter::WHITE_SPACE
-        end
+      loop do
+        factory_option = @factory_queue.shift
+        output += build_factory(*factory_option)
+        break if @factory_queue.empty?
+        output << LineWriter::WHITE_SPACE
+      end
 
-        inner_output
-      end.join(LineWriter::NEW_LINE)
+      if @file_path
+        write_file(output)
+      else
+        output = LineWriter.wrap_definition { output }
+      end
 
-      write_to_file(output)
       output
+    ensure
+      FactoryBot.reload if Object.const_defined?("FactoryBot")
+      puts(output) if FactoryBotFactory.config.print_output
     end
 
     private
 
-    def write_to_file(output)
-      path = @file_path
-      factory_path = FactoryBotFactory.config.factory_path
-      return unless path || factory_path
-      path ||= factory_path + "/#{@factory_name}.rb"
+    def build_file_path(input_path = nil)
+      return input_path if input_path
+      return if FactoryBotFactory.config.factory_path.nil?
+      FactoryBotFactory.config.factory_path + "/#{@factory_name}.rb"
+    end
 
-      raise FileExistsError, "File already exists in #{path}" if File.file?(path)
+    def write_file(output)
+      validate_existing_factory!
+      FileWriter.new(@file_path).write(output)
+    end
 
-      File.open(path, 'w') {|f| f.write(output) }
+    def validate_existing_factory!
+      return unless Object.const_defined?("FactoryBot") && FactoryBot.factories.registered?(@factory_name.to_s)
+      raise FactoryExistsError, "[FactoryBotFactory] Factory #{@factory_name} already exists. Please check your existing factories."
     end
 
     def build_factory(name, value, level, options)
@@ -46,13 +59,13 @@ module FactoryBotFactory
     end
 
     def build_nested_attribute(name, key, value, current_level, max_level)
-      return @line_writer.build(key, value) if current_level == max_level
+      return @line_writer.write(key, value) if current_level == max_level
 
       if is_key_value_pair?(value)
         push_to_factory_queue("#{name}_#{key}", value, max_level - 1)
-        @line_writer.build_nested_line(name, key)
+        @line_writer.write_nested_line(name, key)
       else
-        @line_writer.build(key, value)
+        @line_writer.write(key, value)
       end
     end
 

data/lib/factory_bot_factory/factories/model_factory.rb

@@ -4,7 +4,7 @@ module FactoryBotFactory
       output = LineWriter.wrap_factory(name, value.class.name) do
         inner_output = []
         value.attributes.each do |key, value|
-          inner_output += build_nested_attribute(value.class.name, key, value, 1, 1)
+          inner_output += build_nested_attribute(name, key, value, 1, 1)
         end
         inner_output
       end

data/lib/factory_bot_factory/file_writer.rb

@@ -0,0 +1,31 @@
+require 'factory_bot_factory/logger'
+
+module FactoryBotFactory
+  class FileWriter
+    attr_reader :file_paht, :output
+
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def write(output)
+      if File.file?(@file_path)
+        output  = regroup_existing_lines(output)
+        message = "New Factory successfully write to an existing file."
+      else
+        output  = LineWriter.wrap_definition { output }
+        message = "New Factory successfully write to a new file."
+      end
+
+      FactoryBot.reload if Object.const_defined?("FactoryBot")
+
+      File.open(@file_path, 'w') {|f| f.write(output) }
+      Logger.alert(message + "\nPlease check your file in #{@file_path}")
+      output
+    end
+
+    def regroup_existing_lines(output)
+      File.read(@file_path) + LineWriter::NEW_LINE + LineWriter.wrap_definition { output }
+    end
+  end
+end

data/lib/factory_bot_factory/line_writer.rb

@@ -10,11 +10,11 @@ module FactoryBotFactory
       @options = options
     end
 
-    def build(key, value)
+    def write(key, value)
       wrap_block(key, Attribute.new(key, value, @options).build)
     end
 
-    def build_nested_line(prefix, key)
+    def write_nested_line(prefix, key)
       ["#{key} { build(:#{prefix}_#{key}) }"]
     end
 
@@ -35,11 +35,19 @@ module FactoryBotFactory
         "#{WHITE_SPACE * INDENT_SPACE * level}#{value}"
       end
 
+      def indent_lines(level, value)
+        value.map { |s| indent(level, s) }
+      end
+
+      def join(lines)
+        lines.join(LineWriter::NEW_LINE)
+      end
+
       def wrap_definition(&_block)
         output = ["FactoryBot.define do"]
         output += yield.map { |s| indent(1, s) }
         output << "end"
-        output
+        output.join(LineWriter::NEW_LINE)
       end
 
       def wrap_factory(name, target, &_block)

data/lib/factory_bot_factory/logger.rb

@@ -0,0 +1,41 @@
+module FactoryBotFactory
+  class Logger
+    PREFIX = "[FactoryBotFactory Logger]".freeze
+
+    def self.alert(message)
+      message = message.split("\n").map { |m| "#{PREFIX} #{m}" }.join("\n")
+      puts ColorString.new(message).yellow
+    end
+  end
+end
+
+class ColorString < String
+  # colorization
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+
+  def blue
+    colorize(34)
+  end
+
+  def pink
+    colorize(35)
+  end
+
+  def light_blue
+    colorize(36)
+  end
+end

data/lib/factory_bot_factory/version.rb

@@ -1,3 +1,3 @@
 module FactoryBotFactory
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/factory_bot_factory.rb

@@ -7,6 +7,7 @@ require "factory_bot_factory/config"
 
 require 'factory_bot_factory/base.rb'
 require 'factory_bot_factory/line_writer.rb'
+require 'factory_bot_factory/file_writer.rb'
 Dir.glob("#{File.dirname(__FILE__)}/factory_bot_factory/factories/*").each { |file| require(file) }
 
 
@@ -14,11 +15,13 @@ module FactoryBotFactory
   class Error < StandardError; end
   class NestedToDeepError < Error; end
   class FileExistsError < ::FactoryBotFactory::Error; end
+  class FactoryExistsError < ::FactoryBotFactory::Error; end
 
   class << self
-    def build(*args)
+    def build(data, options = {})
       configure
-      Base.build(*args)
+
+      Base.build(data, options)
     end
 
     def configure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_factory
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - cdragon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-19 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.8.2
 description: A Gem that generate FactoryBot's Factory file from exsiting Hash, OpenStruct
   or Models.
 email: cdragon1116@gmail.com
@@ -155,7 +155,9 @@ files:
 - lib/factory_bot_factory/factories/hash_factory.rb
 - lib/factory_bot_factory/factories/model_factory.rb
 - lib/factory_bot_factory/factories/open_struct_factory.rb
+- lib/factory_bot_factory/file_writer.rb
 - lib/factory_bot_factory/line_writer.rb
+- lib/factory_bot_factory/logger.rb
 - lib/factory_bot_factory/version.rb
 homepage: https://github.com/cdragon1116/factory_bot_factory
 licenses:
@@ -169,7 +171,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="