faker_maker 1.1.8 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b2f1fd221b22d6e524e97f69eb399bda8d0584192e960fb79e457ac5bfe1bb1
-  data.tar.gz: 3c757c4d82d1d8a9bbb0fc31d32911fa8235c4b967eb92d9008d3d8217711f15
+  metadata.gz: 7d52a9450058657ec1fba8756afa5a965a6f92fcf074ef5d05c0c2b7a1d09ea2
+  data.tar.gz: e0c12b011abd0337a5699a054c44e0b4fc3eb05f385b24a0dd9e54d2864ee611
 SHA512:
-  metadata.gz: ee940fb5629d2a4f56402f164a3cbe11ad2a8150229dfeceeb596e78aa1a624b30bcd1f8518d3167750c97622b630595523448140358bd05e159327deccf38b3
-  data.tar.gz: 41f7f57bf43afe5c677592ae608d919aadac205cba4ddce3c4fd16602e6e7163d9cf060c1ce7722e9e77fb6eb4cf82028abc1dfb47f18cdd1ad8c379129f6c70
+  metadata.gz: d467cdafe73e4ddd1cf0b1677f96c935f28430b09b2580b7a141d674d4c8690f6c850bacb8c2f2c22ad32805e9d2d2e8c86c77f5807a50018d375299f56c70b1
+  data.tar.gz: 4f4ede5c6ac0e3290952e29f03b90855c7112332a32a6ceaebe0d5b8ab54340388698bebcdaadabe390beb55a4ac91597200a8960e668e8fb9f0a276ad9f00e1

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.rubocop.yml

@@ -35,3 +35,12 @@ Style/HashTransformKeys:
  
 Style/HashTransformValues:
   Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false

data/README.md

@@ -12,6 +12,7 @@
 <div align="center">
 
   [![Gem Version](https://badge.fury.io/rb/faker_maker.svg)](https://badge.fury.io/rb/faker_maker)
+  [![Downloads](https://img.shields.io/gem/dt/faker_maker)](https://rubygems.org/gems/faker_maker)
   ![CircleCI branch](https://img.shields.io/circleci/project/github/BillyRuffian/faker_maker/master.svg?style=flat-square)
   [![CodeFactor](https://www.codefactor.io/repository/github/billyruffian/faker_maker/badge?style=flat-square)](https://www.codefactor.io/repository/github/billyruffian/faker_maker)
   ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/BillyRuffian/faker_maker.svg?style=flat-square)
@@ -20,4 +21,4 @@
 
 FakerMaker is a simple factory builder so you can throw away your fixtures and generate test data instead.
 
-Read the [documentation here](https://billyruffian.github.io/faker_maker/).
+Read the [documentation here](https://billyruffian.github.io/faker_maker/).

data/docs/usage/json_field_names.md

@@ -9,21 +9,49 @@ nav_order: 4
 
 JavaScript likes to use camelCase, Ruby's idiom is to use snake_case. This can make make manipulating factory-built objects in ruby ugly. To avoid this, you can call your fields one thing and ask the JSON outputter to rename the field when generating JSON.
 
+Faker Maker provides two mechanisms for dealing with this.
+
+## Factory-wide attribute name re-writing (since 1.1.10)
+
+Using the `:naming` option to the factory, you can specify a naming strategy. Currently supported are:
+
+* `:json` camelCase with lowercase first letter
+* `:json_capitalized` CamelCase with uppercase first letter
+
 ```ruby
-FakerMaker.factory :vehicle do
+FakerMaker.factory :vehicle, naming: :json do
   wheels { 4 }
   colour { Faker::Color.color_name }
-  engine_capacity(json: 'engineCapacity') { rand( 600..2500 ) }
+  engine_capacity { rand( 600..2500 ) }
 end
 
 v = FM[:vehicle].build
 v.engine_capacity = 125
+
+v.to_json
+
+=> "{\"wheels\":4,\"colour\":\"blue\",\"engineCapacity\":125}"
 ```
 
-and calls to `as_json` and `to_json` will report the fieldname as `engineCapacity`.
+## Per-attribute naming
+
+You can override the name of the attribute on the individual attribute level.
 
 ```ruby
+FakerMaker.factory :vehicle do
+  wheels { 4 }
+  colour { Faker::Color.color_name }
+  engine_capacity(json: 'engineCapacity') { rand( 600..2500 ) }
+end
+
+v = FM[:vehicle].build
+v.engine_capacity = 125
+
 v.to_json
 
 => "{\"wheels\":4,\"colour\":\"blue\",\"engineCapacity\":125}"
-```
+```
+
+## Combining the two approaches
+
+If the factory has a `:naming` strategy defined and an attribute has its own `:json` name defined, the attribute's `:json` name will take precedence. 

data/docs/usage/lifecycle_hooks.md

@@ -16,7 +16,7 @@ For instance:
 
 ```ruby
 FakerMaker.factory :user do 
-  before_build do
+  before_build do |instance, factory|
     puts 'Building an instance of User'
   end
 
@@ -24,10 +24,8 @@ FakerMaker.factory :user do
   email {'patsy@fabulous.co.uk'}
   admin {false}
   
-  after_build do
-    puts "Built an instance of User (#{faker_maker_factory.instance.name})"
+  after_build do |instance, factory|
+    puts "Built an instance of User (#{instance.name})"
   end
 end
 ```
-
-Access to the factory object is through the `faker_maker_factory` method. The instance under construction is available through the `faker_maker_factory.instance` method.

data/faker_maker.gemspec

@@ -46,13 +46,15 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler',       '~> 2.0'
   spec.add_development_dependency 'faker',         '~> 2.1'
   spec.add_development_dependency 'guard',         '~> 2.16'
-  spec.add_development_dependency 'guard-bundler', '~> 2.2'
+  spec.add_development_dependency 'guard-bundler', '~> 3.0'
   spec.add_development_dependency 'guard-rubocop', '~> 1.3'
   spec.add_development_dependency 'guard-rspec',   '~> 4.7'
   spec.add_development_dependency 'pry',           '~> 0.12'
   spec.add_development_dependency 'rake',          '~> 13.0'
   spec.add_development_dependency 'rspec',         '~> 3.8'
-  spec.add_development_dependency 'rubocop',       '~> 0.68'
+  spec.add_development_dependency 'rubocop',       '~> 1.0'
   spec.add_development_dependency 'simplecov',     '~> 0.16'
   spec.add_development_dependency 'coveralls',     '~> 0.8'
+
+  spec.required_ruby_version = '>= 2.6'
 end

data/lib/faker_maker/attribute.rb

@@ -34,7 +34,7 @@ module FakerMaker
     def omit?( value )
       case value
       when nil
-        @omit.include? :nil
+        @omit.include?( :nil ) || @omit.include?( nil )
       when '', [], {}
         @omit.include? :empty
       else

data/lib/faker_maker/definition_proxy.rb

@@ -13,7 +13,7 @@ module FakerMaker
       @factory
     end
 
-    def method_missing(name, *args, &block) # rubocop:disable Style/MethodMissingSuper
+    def method_missing(name, *args, &block)
       attribute = FakerMaker::Attribute.new name, block, *args
       @factory.attach_attribute attribute
     end

data/lib/faker_maker/factory.rb

@@ -10,6 +10,16 @@ module FakerMaker
       assert_valid_options options
       @name = name.respond_to?(:to_sym) ? name.to_sym : name.to_s.underscore.to_sym
       @class_name = (options[:class] || @name).to_s.camelcase
+      @naming_strategy = case options[:naming]
+                         when :json
+                           FakerMaker::Naming::JSON
+                         when :json_capitalized, :json_capitalised
+                           FakerMaker::Naming::JSONCapitalized
+                         when nil
+                           nil
+                         else
+                           raise FakerMaker::NoSuchAttributeNamingStrategy, opttions[:naming]
+                         end
       @attributes = []
       @klass = nil
       @parent = options[:parent]
@@ -32,6 +42,7 @@ module FakerMaker
     end
 
     def build( attributes = {} )
+      @instance = nil
       before_build if respond_to? :before_build
       assert_only_known_attributes_for_override( attributes )
       populate_instance instance, attributes
@@ -67,7 +78,14 @@ module FakerMaker
         @json_key_map = {}.with_indifferent_access
         @json_key_map.merge!( FakerMaker[parent].json_key_map ) if parent?
         attributes.each_with_object( @json_key_map ) do |attr, map|
-          key = attr.translation? ? attr.translation : attr.name
+          key = if attr.translation?
+                  attr.translation
+                elsif @naming_strategy
+                  @naming_strategy.name(attr.name)
+                else
+                  attr.name
+                end
+
           map[attr.name] = key
         end
       end
@@ -85,7 +103,7 @@ module FakerMaker
     end
 
     def find_attribute( name = '' )
-      attributes.filter { |a| [a.name, a.translation].include? name }.first
+      attributes.filter { |a| [a.name, a.translation, @naming_strategy&.name(a.name)].include? name }.first
     end
 
     protected
@@ -142,7 +160,7 @@ module FakerMaker
     end
 
     def assert_valid_options( options )
-      options.assert_valid_keys :class, :parent
+      options.assert_valid_keys :class, :parent, :naming
     end
   end
 end

data/lib/faker_maker/lifecycle_hooks.rb

@@ -5,11 +5,11 @@ module FakerMaker
     # Lifecycle hooks which can be called during the building of an instance
     module DefinitionProxy
       def before_build(&block)
-        @factory.define_singleton_method(:before_build) { block.call }
+        @factory.define_singleton_method(:before_build) { yield(self.instance, self) }
       end
 
       def after_build(&block)
-        @factory.define_singleton_method(:after_build) { block.call }
+        @factory.define_singleton_method(:after_build) { yield(self.instance, self) }
       end
     end
   end

data/lib/faker_maker/naming/json.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FakerMaker
+  module Naming
+    # Use camelCase for naming
+    module JSON
+      def self.name(name)
+        name.to_s.camelize(:lower)
+      end
+    end
+  end
+end

data/lib/faker_maker/naming/json_capitalized.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FakerMaker
+  module Naming
+    # Use CamelCase for naming
+    module JSONCapitalized
+      def self.name(name)
+        name.to_s.camelize
+      end
+    end
+  end
+end

data/lib/faker_maker/naming.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module FakerMaker
+  # Base module for naming strategies
+  module Naming
+  end
+end

data/lib/faker_maker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FakerMaker
-  VERSION = '1.1.8'
+  VERSION = '1.2.1'
 end

data/lib/faker_maker.rb

@@ -9,7 +9,10 @@ require 'faker_maker/base'
 require 'faker_maker/lifecycle_hooks'
 require 'faker_maker/definition_proxy'
 require 'faker_maker/factory'
-require 'faker_maker/lifecycle_hooks'
+
+require 'faker_maker/naming'
+require 'faker_maker/naming/json'
+require 'faker_maker/naming/json_capitalized'
 require 'faker_maker/version'
 
 # FakerMaker module for generating Fakes
@@ -19,6 +22,7 @@ module FakerMaker
   class Error < StandardError; end
   class NoSuchFactoryError < StandardError; end
   class NoSuchAttributeError < StandardError; end
+  class NoSuchAttributeNamingStrategy < StandardError; end
   # Your code goes here...
 
   module_function

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faker_maker
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.2.1
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-01 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -162,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.68'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.68'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -208,6 +208,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".coveralls.yml"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -246,6 +247,9 @@ files:
 - lib/faker_maker/definition_proxy.rb
 - lib/faker_maker/factory.rb
 - lib/faker_maker/lifecycle_hooks.rb
+- lib/faker_maker/naming.rb
+- lib/faker_maker/naming/json.rb
+- lib/faker_maker/naming/json_capitalized.rb
 - lib/faker_maker/version.rb
 homepage: https://billyruffian.github.io/faker_maker/
 licenses:
@@ -254,7 +258,7 @@ metadata:
   homepage_uri: https://billyruffian.github.io/faker_maker/
   source_code_uri: https://github.com/BillyRuffian/faker_maker
   changelog_uri: https://github.com/BillyRuffian/faker_maker/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -262,15 +266,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: FakerMaker bakes fakes.
 test_files: []