factory_bot_factory 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a5446b4470b7e8fb666695ea54aecc662725ccbab46afc1425b19feb4a2f996
-  data.tar.gz: 3dbffe0f96d8135c177e9f78fd25506c8bdcb0c89a37fc423d2b045f2df819ed
+  metadata.gz: 683013489cb5caa6aedb9dd6f5aeea5e961e79fb78647f11b984629b8e5edea5
+  data.tar.gz: c31acd1032b0b136f6f29263a7910b2a943f85df96411aaa7c66a4f5d36b64e0
 SHA512:
-  metadata.gz: 768c46d1e6981210d158ee455bc590bd3e4743f05fc58f9f9d99955ae6a0f41d80bd897f1b5eba4333c4e1b1db0a18973ea7a9f0e5a75913699131d134e0a0d4
-  data.tar.gz: 5adf7eba8856308b52c77d3734189bd0d2bc8c10327bab60b63570514055c90577ca981088d281e80a72c839696ced6866339b5a752ee88a6aa92d0f1a36fe5a
+  metadata.gz: c20d1624c1dcf7b845718361526938901236061891691c9978161763f4aad965867caaee1ee29ff52434df6918a9ac6c9f38eb0e17353ce2d927d85c51344bc8
+  data.tar.gz: a6eff9d1210bd3e288a46309208b69faeae0c7c2c55b313afaff43d1423368dc8f31cef02df02657391f7d3b7bcfb5083a849d015de0fae7fea6cf91d4e46f47

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    factory_bot_factory (0.0.3)
+    factory_bot_factory (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -26,7 +26,7 @@ GEM
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rake (10.5.0)
+    rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -48,13 +48,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (>= 2.2.10)
   factory_bot
   factory_bot_factory!
   faker
   pry (~> 0.13.1)
-  rake (~> 10.0)
+  rake (>= 11.2.2)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.17.3
+   2.2.27

data/README.md

@@ -1,5 +1,7 @@
 # Factory Bot Factory
 
+[![Gem Version](https://badge.fury.io/rb/factory_bot_factory.svg)](https://rubygems.org/gems/factory_bot_factory) ![Gem Version](https://app.travis-ci.com/cdragon1116/factory_bot_factory.svg?branch=main)
+
 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.
@@ -19,7 +21,16 @@ Or install it yourself as:
     $ gem install factory_bot_factory
 
 
-## Quick Demo
+## Qucik Usage
+
+```ruby
+FactoryBotFactory.build({ id: 1 })
+FactoryBotFactory.build(OpenStruct.new(id: 1))
+FactoryBotFactory.build(User.last)
+```
+
+
+## More Options
 
 - Build a Hash Factory
 
@@ -27,11 +38,11 @@ Or install it yourself as:
 require 'factory_bot_factory'
 
 data = { id: 1, tags: ["tag1", "tag2"], address: { country: "US" }  }
-puts FactoryBotFactory.build("order_hash", Hash, data)
+puts FactoryBotFactory.build(data)
 
 # output
 FactoryBot.define do
-  factory :order_hash, class: Hash do
+  factory :hash, class: Hash do
     id { 1 }
     tags do
       [
@@ -53,11 +64,11 @@ end
 
 ```ruby
 data = { id: 1, tags: ["tag1", "tag2"], address: { country: "US" }  }
-puts FactoryBotFactory.build("order_hash", Hash, data, nested_level: 2)
+puts FactoryBotFactory.build(data, nested_level: 2)
 
 # output
 FactoryBot.define do
-  factory :order_hash, class: Hash do
+  factory :hash, class: Hash do
     id { 1 }
     tags do
       [
@@ -65,11 +76,11 @@ FactoryBot.define do
         "tag2"
       ]
     end
-    address { build(:order_hash_address) }
+    address { build(:hash_address) }
     initialize_with { attributes }
   end
 
-  factory :order_hash_address, class: Hash do
+  factory :hash_address, class: Hash do
     country { "US" }
     initialize_with { attributes }
   end
@@ -79,34 +90,44 @@ end
 - Export the file somewhere
 
 ```ruby
-FactoryBotFactory.build("order_hash", Hash, data, file_path: "spec/factories/order_hash.rb")
+FactoryBotFactory.build(data, file_path: "spec/factories/order_hash.rb")
 
 require 'factory_bot'
 FactoryBot.reload
 FactoryBot.build(:order_hash, id: 2)
-
 ```
 
-## Supported Factories
+- Specifize Factory Name
 
-- Hash
 ```ruby
-FactoryBotFactory.build("order_hash", Hash, data)
-```
+puts FactoryBotFactory.build({ id: 1 }, factory_name: 'order')
 
-- OpenStruct
-```
-FactoryBotFactory.build("order_open_struct", OpenStruct, data)
+# output
+FactoryBot.define do
+  factory :order, class: Hash do
+    id { 1 }
+    initialize_with { attributes }
+  end
+end
 ```
 
-- Your ActiveModel or ActiveRecord Model
-```
-FactoryBotFactory.build("user", User, user_instance)
+- Specifize Output Data Structure: Hash, OpenStruct and your ActiveModel or ActiveRecord Model
+
+```ruby
+puts FactoryBotFactory.build({ id: 1 }, klass: OpenStruct)
+
+# output
+FactoryBot.define do
+  factory :hash, class: OpenStruct do
+    id { 1 }
+    to_create {}
+  end
+end
 ```
 
 ## Configure your own converter
 
-- Configure
+- Configuration
 
 ```ruby
 FactoryBotFactory.configure do |config|
@@ -120,12 +141,15 @@ FactoryBotFactory.configure do |config|
     end
   end
 end
+```
 
-FactoryBotFactory.build("order_hash", Hash, { name: 'My Name', id: "de9515ee-006e-4a28-8af3-e88a5c771b93" })
+- Output
+```ruby
+FactoryBotFactory.build({ name: 'My Name', id: "de9515ee-006e-4a28-8af3-e88a5c771b93" })
 
 # output
 FactoryBot.define do
-  factory :order_hash, class: Hash do
+  factory :hash, class: Hash do
     name { Faker::Name.name }
     id { Random.uuid() }
     initialize_with { attributes }
@@ -133,8 +157,7 @@ FactoryBot.define do
 end
 ```
 
-See move converters 'lib/factory_bot_factory/config.rb'
-
+See more converters [Here](https://github.com/cdragon1116/factory_bot_factory/blob/master/lib/factory_bot_factory/config.rb#L3-L9)
 
 ## Contributing
 

data/factory_bot_factory.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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"

data/lib/factory_bot_factory/attribute.rb

@@ -0,0 +1,27 @@
+module FactoryBotFactory
+  class Attribute
+    attr_reader :key, :value, :options
+
+    def initialize(key, value, options = {})
+      @key     = key
+      @value   = value
+      @options = options
+    end
+
+    def build
+      options = [key, value, options]
+
+      values = if value.nil? || value == "null"
+        FactoryBotFactory.config.nil_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.hash_converter.call(*options)
+      else value.is_a?(OpenStruct)
+        FactoryBotFactory.config.open_struct_converter.call(*options)
+      end
+    end
+  end
+end

data/lib/factory_bot_factory/base.rb

@@ -1,16 +1,33 @@
 module FactoryBotFactory
   class Base
     class << self
-      def build(factory_name, klass, data, options = {})
+      def build(*args)
+        factory_name, klass, data, options = build_args(*args)
+        options ||= {}
+
+        raise ArgumentError if factory_name.nil? || klass.nil? || !valid_data?(data)
         raise NestedToDeepError, 'Only support 5 nested levels' if options[:nested_level].to_i > 5
 
-        factory(klass, data).new(options.merge(factory_name: factory_name)).generate(data)
-      rescue => e
-        puts "Please check your input data and make sure you pass supported type of factory."
+        factory(klass, data).new({ factory_name: factory_name }.merge(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 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
           Object.const_get("FactoryBotFactory::ModelFactory")

data/lib/factory_bot_factory/factories/base_factory.rb

@@ -1,5 +1,6 @@
 module FactoryBotFactory
   class BaseFactory
+
     def initialize(options = {})
       @factory_name  = options[:factory_name]
       @file_path     = options[:file_path]
@@ -24,12 +25,17 @@ module FactoryBotFactory
       end
 
       output = output.join(LineWriter::NEW_LINE)
-      File.open(@file_path, 'w') {|f| f.write(output) } if @file_path
+      write_to_file(output) if @file_path
       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) }
+    end
+
     def build_factory(name, value, level)
       raise "This method should be implemented in a subclass"
     end

data/lib/factory_bot_factory/factories/hash_factory.rb

@@ -1,3 +1,5 @@
+require 'factory_bot_factory/factories/base_factory.rb'
+
 module FactoryBotFactory
   class HashFactory < BaseFactory
     def build_factory(name, value, level)

data/lib/factory_bot_factory/factories/open_struct_factory.rb

@@ -1,3 +1,5 @@
+require 'factory_bot_factory/factories/base_factory.rb'
+
 module FactoryBotFactory
   class OpenStructFactory < BaseFactory
     def build_factory(name, value, level)

data/lib/factory_bot_factory/line_writer.rb

@@ -1,31 +1,17 @@
+require "factory_bot_factory/attribute"
+
 module FactoryBotFactory
   class LineWriter
     NEW_LINE     = "\n".freeze
     WHITE_SPACE  = "\s".freeze
     INDENT_SPACE = 2
 
-    attr_reader :hash_converter, :string_converter, :numertic_converter, :open_struct_converter, :nil_converter
-
     def initialize(options = {})
-      @options               = options
+      @options = options
     end
 
     def build(key, value)
-      options = [key, value, @options]
-
-      values = if value.nil? || value == "null"
-        FactoryBotFactory.config.nil_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.hash_converter.call(*options)
-      else value.is_a?(OpenStruct)
-        FactoryBotFactory.config.open_struct_converter.call(*options)
-      end
-
-      wrap_block(key, values)
+      wrap_block(key, Attribute.new(key, value, @options).build)
     end
 
     def build_nested_line(prefix, key)

data/lib/factory_bot_factory/version.rb

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

data/lib/factory_bot_factory.rb

@@ -2,21 +2,23 @@ require "json"
 require "factory_bot_factory/version"
 
 # Load all Factories and Converters
-Dir.glob("#{File.dirname(__FILE__)}/factory_bot_factory/factories/*").each { |file| require(file) }
 Dir.glob("#{File.dirname(__FILE__)}/factory_bot_factory/converters/*").each { |file| require(file) }
+require "factory_bot_factory/config"
 
-require 'factory_bot_factory/line_writer.rb'
 require 'factory_bot_factory/base.rb'
-require "factory_bot_factory/config"
+require 'factory_bot_factory/line_writer.rb'
+Dir.glob("#{File.dirname(__FILE__)}/factory_bot_factory/factories/*").each { |file| require(file) }
+
 
 module FactoryBotFactory
   class Error < StandardError; end
   class NestedToDeepError < Error; end
+  class FileExistsError < ::FactoryBotFactory::Error; end
 
   class << self
-    def build(factory_name, klass, data, options = {})
+    def build(*args)
       configure
-      Base.build(factory_name, klass, data, options)
+      Base.build(*args)
     end
 
     def configure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_factory
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - cdragon
@@ -14,30 +14,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 11.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 11.2.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +114,7 @@ files:
 - bin/setup
 - factory_bot_factory.gemspec
 - lib/factory_bot_factory.rb
+- lib/factory_bot_factory/attribute.rb
 - lib/factory_bot_factory/base.rb
 - lib/factory_bot_factory/config.rb
 - lib/factory_bot_factory/converters/hash_converter.rb