factory_bot_factory 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 683013489cb5caa6aedb9dd6f5aeea5e961e79fb78647f11b984629b8e5edea5
-  data.tar.gz: c31acd1032b0b136f6f29263a7910b2a943f85df96411aaa7c66a4f5d36b64e0
+  metadata.gz: 3759620bd063f6090d72c455055888f658fcd1348304983ca5c595a053d3302c
+  data.tar.gz: aa08b76ac4326ac1157a0f1c4e8cb87a5136e4a5f6a4bbc3811bed378f051443
 SHA512:
-  metadata.gz: c20d1624c1dcf7b845718361526938901236061891691c9978161763f4aad965867caaee1ee29ff52434df6918a9ac6c9f38eb0e17353ce2d927d85c51344bc8
-  data.tar.gz: a6eff9d1210bd3e288a46309208b69faeae0c7c2c55b313afaff43d1423368dc8f31cef02df02657391f7d3b7bcfb5083a849d015de0fae7fea6cf91d4e46f47
+  metadata.gz: 1d38b330bad4022cb2cdca6acaeed2ff38791e38d99fb5c168c0927b764a86791fae4f6c9ce8a033efbe0b12f4f51fe55e4f99bb1dbfc86478b4e31f4b2147be
+  data.tar.gz: a4d7f9f6c9d2ec67810648aee8eaafd283a0cc324169e1b72fcf30bf04a6e5212b0b3bf2dad9f8d4a0bf6bb7b9ae45f91746caf23b913f06f6be0c355c5e97bd

data/Gemfile.lock

@@ -1,11 +1,16 @@
 PATH
   remote: .
   specs:
-    factory_bot_factory (1.0.0)
+    factory_bot_factory (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
     activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
@@ -40,6 +45,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    sqlite3 (1.4.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     zeitwerk (2.4.2)
@@ -48,6 +54,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (> 5.0.0.1)
   bundler (>= 2.2.10)
   factory_bot
   factory_bot_factory!
@@ -55,6 +62,7 @@ DEPENDENCIES
   pry (~> 0.13.1)
   rake (>= 11.2.2)
   rspec (~> 3.0)
+  sqlite3
 
 BUNDLED WITH
    2.2.27

data/README.md

@@ -4,7 +4,7 @@
 
 A Gem that helps you generate FactoryBot's Factory file from exsiting Hash, OpenStruct or ActiveModels.
 
-The main purpose is to speed up the process of building big factory.
+![factory_bot_factory_speed_demo](https://user-images.githubusercontent.com/39395058/133921801-e6c2b61d-71f1-4b99-b096-a0304fdbce87.gif)
 
 ## Installation
 
@@ -14,53 +14,32 @@ gem 'factory_bot_factory'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install factory_bot_factory
-
-
-## Qucik Usage
-
-```ruby
-FactoryBotFactory.build({ id: 1 })
-FactoryBotFactory.build(OpenStruct.new(id: 1))
-FactoryBotFactory.build(User.last)
+```
+$ gem install factory_bot_factory
 ```
 
 
-## More Options
-
-- Build a Hash Factory
+## Quick Demo
 
 ```ruby
 require 'factory_bot_factory'
 
-data = { id: 1, tags: ["tag1", "tag2"], address: { country: "US" }  }
-puts FactoryBotFactory.build(data)
-
-# output
-FactoryBot.define do
-  factory :hash, class: Hash do
-    id { 1 }
-    tags do
-      [
-        "tag1",
-        "tag2"
-      ]
-    end
-    address do
-      {
-        "country": "US"
-      }
-    end
-    initialize_with { attributes }
-  end
-end
+puts FactoryBotFactory.build({ id: 1 })
+puts FactoryBotFactory.build(OpenStruct.new(id: 1))
+puts FactoryBotFactory.build(User.last)
+puts FactoryBotFactory.build(User.new)
 ```
 
-- Nested Hash Factory
+
+## More Options
+
+- `nested_level` - Build Nested Hash Factory (only support Hash and OpenStruct)
 
 ```ruby
 data = { id: 1, tags: ["tag1", "tag2"], address: { country: "US" }  }
@@ -87,17 +66,17 @@ FactoryBot.define do
 end
 ```
 
-- Export the file somewhere
+- `file_path` - Export output as file somewhere
 
 ```ruby
-FactoryBotFactory.build(data, file_path: "spec/factories/order_hash.rb")
+FactoryBotFactory.build(data, file_path: "spec/factories/hash.rb")
 
 require 'factory_bot'
 FactoryBot.reload
-FactoryBot.build(:order_hash, id: 2)
+FactoryBot.build(:hash, id: 2)
 ```
 
-- Specifize Factory Name
+- `factory_name` - Specifize Factory Name
 
 ```ruby
 puts FactoryBotFactory.build({ id: 1 }, factory_name: 'order')
@@ -111,27 +90,41 @@ FactoryBot.define do
 end
 ```
 
-- Specifize Output Data Structure: Hash, OpenStruct and your ActiveModel or ActiveRecord Model
+- `klass` - Specifize Output Data Structure: Hash, OpenStruct and your ActiveModel or ActiveRecord Model
+
+You can convert your Hash object to OpenStruct factory.
 
 ```ruby
-puts FactoryBotFactory.build({ id: 1 }, klass: OpenStruct)
+puts FactoryBotFactory.build({ id: 1 }, factory_name: 'order', klass: OpenStruct)
 
 # output
 FactoryBot.define do
-  factory :hash, class: OpenStruct do
+  factory :order, class: OpenStruct do
     id { 1 }
     to_create {}
   end
 end
 ```
 
-## Configure your own converter
+## Configuration
+
+- Default factory path
+
+By configuring `factory_path`, it allows file auto-generation without specifying `file_path`.
+
+```ruby
+FactoryBotFactory.configure do |config|
+  config.factory_path = 'spec/factories'
+end
+```
+
+- Customize your own converter:
 
-- Configuration
+Converter should respond to `call` method and return single or array of executable values.
 
 ```ruby
 FactoryBotFactory.configure do |config|
-  config.string_converter   = Proc.new do |k, v|
+  config.string_converter = Proc.new { |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')
@@ -139,25 +132,25 @@ FactoryBotFactory.configure do |config|
     else
       "'#{v}'"
     end
-  end
+  }
+
+  config.numeric_converter = Proc.new { |k, v| 'rand(99)' }
 end
-```
 
-- Output
-```ruby
-FactoryBotFactory.build({ name: 'My Name', id: "de9515ee-006e-4a28-8af3-e88a5c771b93" })
+FactoryBotFactory.build({ name: 'My Name', id: "de9515ee-006e-4a28-8af3-e88a5c771b93", age: 10 })
 
 # output
 FactoryBot.define do
   factory :hash, class: Hash do
     name { Faker::Name.name }
     id { Random.uuid() }
+    age { rand(99) }
     initialize_with { attributes }
   end
 end
 ```
 
-See more converters [Here](https://github.com/cdragon1116/factory_bot_factory/blob/master/lib/factory_bot_factory/config.rb#L3-L9)
+See more converters [Here](https://github.com/cdragon1116/factory_bot_factory/blob/release/1.1.0/lib/factory_bot_factory/config.rb#L3-L13)
 
 ## Contributing
 

data/factory_bot_factory.gemspec

@@ -30,4 +30,6 @@ Gem::Specification.new do |spec|
   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"
 end

data/lib/factory_bot_factory/attribute.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module FactoryBotFactory
   class Attribute
     attr_reader :key, :value, :options
@@ -13,12 +15,20 @@ module FactoryBotFactory
 
       values = if value.nil? || value == "null"
         FactoryBotFactory.config.nil_converter.call(*options)
+      elsif value.is_a?(DateTime) || value.is_a?(Time)
+        FactoryBotFactory.config.date_time_converter.call(*options)
+      elsif value.is_a?(Date)
+        FactoryBotFactory.config.date_converter.call(*options)
       elsif value.is_a?(String) || value.is_a?(Symbol)
         FactoryBotFactory.config.string_converter.call(*options)
       elsif value.is_a?(Numeric)
-        FactoryBotFactory.config.numertic_converter.call(*options)
-      elsif value.is_a?(Hash) || value.is_a?(Array)
+        FactoryBotFactory.config.numeric_converter.call(*options)
+      elsif value.is_a?(BigDecimal)
+        FactoryBotFactory.config.big_decimal_converter.call(*options)
+      elsif value.is_a?(Hash)
         FactoryBotFactory.config.hash_converter.call(*options)
+      elsif value.is_a?(Array)
+        FactoryBotFactory.config.array_converter.call(*options)
       else value.is_a?(OpenStruct)
         FactoryBotFactory.config.open_struct_converter.call(*options)
       end

data/lib/factory_bot_factory/base.rb

@@ -24,17 +24,23 @@ module FactoryBotFactory
         end
       end
 
-      def valid_data?(data)
-        data.is_a?(Hash) || data.is_a?(OpenStruct) || data.respond_to?(:attributes)
-      end
-
       def factory(klass, data)
-        if data.respond_to?(:attributes) && klass == data.class
+        if active_record?(data) && klass == data.class
+          Object.const_get("FactoryBotFactory::ActiveRecordFactory")
+        elsif data.respond_to?(:attributes) && klass == data.class
           Object.const_get("FactoryBotFactory::ModelFactory")
         else
           Object.const_get("FactoryBotFactory::#{klass}Factory")
         end
       end
+
+      def valid_data?(data)
+        data.is_a?(Hash) || data.is_a?(OpenStruct) || data.respond_to?(:attributes)
+      end
+
+      def active_record?(data)
+        Object.const_defined?("ActiveRecord::Base") && data.class.is_a?(ActiveRecord::Base)
+      end
     end
   end
 end

data/lib/factory_bot_factory/config.rb

@@ -3,15 +3,24 @@ module FactoryBotFactory
     DEFAULT_CONVERTERS = {
       hash_converter:        Converters::HashConverter,
       string_converter:      Converters::StringConverter,
-      numertic_converter:    Converters::NumericConverter,
+      numeric_converter:     Converters::NumericConverter,
+      big_decimal_converter: Converters::NumericConverter,
       open_struct_converter: Converters::HashConverter,
-      nil_converter:         Converters::NilConverter
+      nil_converter:         Converters::NilConverter,
+      date_time_converter:   Converters::DateTimeConverter,
+      date_converter:        Converters::StringConverter,
+      array_converter:       Converters::HashConverter
     }
 
-    attr_accessor :hash_converter, :string_converter, :numertic_converter, :open_struct_converter, :nil_converter
+    DEFAULT_OPTIONS = {
+      factory_path: nil
+    }.merge(DEFAULT_CONVERTERS)
+
+    attr_accessor *DEFAULT_OPTIONS.keys
 
     def initialize(options = {})
-      options = DEFAULT_CONVERTERS.merge(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
   end

data/lib/factory_bot_factory/converters/data_time_converter.rb

@@ -0,0 +1,9 @@
+module FactoryBotFactory
+  module Converters
+    class DateTimeConverter
+      def self.call(key, value, options = {})
+        "\"#{value}\""
+      end
+    end
+  end
+end

data/lib/factory_bot_factory/factories/active_record_factory.rb

@@ -0,0 +1,9 @@
+require 'factory_bot_factory/factories/model_factory'
+
+module FactoryBotFactory
+  class ActiveRecordFactory < ModelFactory
+    def build_factory(name, value, level, _options = {})
+      super
+    end
+  end
+end

data/lib/factory_bot_factory/factories/base_factory.rb

@@ -11,7 +11,7 @@ module FactoryBotFactory
 
     def generate(data)
       output = LineWriter.wrap_definition do
-        @factory_queue << [@factory_name, data, @nested_level]
+        push_to_factory_queue(@factory_name, data, @nested_level)
         inner_output = []
 
         loop do
@@ -22,21 +22,26 @@ module FactoryBotFactory
         end
 
         inner_output
-      end
+      end.join(LineWriter::NEW_LINE)
 
-      output = output.join(LineWriter::NEW_LINE)
-      write_to_file(output) if @file_path
+      write_to_file(output)
       output
     end
 
     private
 
     def write_to_file(output)
-      raise FileExistsError, "File already exists in #{@file_path}" if File.file?(@file_path)
-      File.open(@file_path, 'w') {|f| f.write(output) }
+      path = @file_path
+      factory_path = FactoryBotFactory.config.factory_path
+      return unless path || factory_path
+      path ||= factory_path + "/#{@factory_name}.rb"
+
+      raise FileExistsError, "File already exists in #{path}" if File.file?(path)
+
+      File.open(path, 'w') {|f| f.write(output) }
     end
 
-    def build_factory(name, value, level)
+    def build_factory(name, value, level, options)
       raise "This method should be implemented in a subclass"
     end
 
@@ -44,15 +49,15 @@ module FactoryBotFactory
       return @line_writer.build(key, value) if current_level == max_level
 
       if is_key_value_pair?(value)
-        push_to_factory_queue(name, key, value, max_level)
+        push_to_factory_queue("#{name}_#{key}", value, max_level - 1)
         @line_writer.build_nested_line(name, key)
       else
         @line_writer.build(key, value)
       end
     end
 
-    def push_to_factory_queue(name, key, value, max_level)
-      @factory_queue.push(["#{name}_#{key}", value, max_level - 1])
+    def push_to_factory_queue(name, value, max_level, options = {})
+      @factory_queue.push([name, value, max_level, options])
     end
 
     def is_key_value_pair?(value)

data/lib/factory_bot_factory/factories/hash_factory.rb

@@ -2,7 +2,7 @@ require 'factory_bot_factory/factories/base_factory.rb'
 
 module FactoryBotFactory
   class HashFactory < BaseFactory
-    def build_factory(name, value, level)
+    def build_factory(name, value, level, _options = {})
       output = LineWriter.wrap_factory(name, 'Hash') do
         inner_output = []
         value = value.attributes if value.respond_to?(:attributes)

data/lib/factory_bot_factory/factories/model_factory.rb

@@ -1,6 +1,6 @@
 module FactoryBotFactory
   class ModelFactory < BaseFactory
-    def build_factory(name, value, level)
+    def build_factory(name, value, level, _options = {})
       output = LineWriter.wrap_factory(name, value.class.name) do
         inner_output = []
         value.attributes.each do |key, value|

data/lib/factory_bot_factory/factories/open_struct_factory.rb

@@ -2,7 +2,7 @@ require 'factory_bot_factory/factories/base_factory.rb'
 
 module FactoryBotFactory
   class OpenStructFactory < BaseFactory
-    def build_factory(name, value, level)
+    def build_factory(name, value, level, _options = {})
       output = LineWriter.wrap_factory(name, 'OpenStruct') do
         inner_output = []
         value = value.attributes if value.respond_to?(:attributes)

data/lib/factory_bot_factory/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_factory
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - cdragon
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
 description: A Gem that generate FactoryBot's Factory file from exsiting Hash, OpenStruct
   or Models.
 email: cdragon1116@gmail.com
@@ -117,10 +145,12 @@ files:
 - lib/factory_bot_factory/attribute.rb
 - lib/factory_bot_factory/base.rb
 - lib/factory_bot_factory/config.rb
+- lib/factory_bot_factory/converters/data_time_converter.rb
 - lib/factory_bot_factory/converters/hash_converter.rb
 - lib/factory_bot_factory/converters/nil_converter.rb
 - lib/factory_bot_factory/converters/numeric_converter.rb
 - lib/factory_bot_factory/converters/string_converter.rb
+- lib/factory_bot_factory/factories/active_record_factory.rb
 - lib/factory_bot_factory/factories/base_factory.rb
 - lib/factory_bot_factory/factories/hash_factory.rb
 - lib/factory_bot_factory/factories/model_factory.rb