faker_maker 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e70530ef4ef67e59247210037bbdbe4fd0c23c6c26666b1459db6f5ac9f65a5e
-  data.tar.gz: f007f3658015e759942885a786424b4f444f34b4d655ab64f5da5044e90274df
+  metadata.gz: e265f317bfd43d44382e9db7e9359c7c0bf21e946b361c3d0973d9ca0cd9c6d1
+  data.tar.gz: 5765b8eff404d6e8156ef05b5dc3fff0fd1f747d53fb5e2bd8a50867ed459f47
 SHA512:
-  metadata.gz: 42b0194260b51a49a03063183da089d885291211f4bc5ef3583b0df79d0ecac6f742ada1a7c0541fef24c2bded3056d91b83697db487eee2f569326dd00324d5
-  data.tar.gz: cf02455a97627cb404d7cb6365d8485d5ff8266797e91bb9745eeb8a40499575832b31cd4dfceaedeea8634aed6c7b5ee0ccc78922243be5fecbd6f322da1e1e
+  metadata.gz: 68c81cf0d7fc4be3bd21e303fb2315bbfd0b99b438292e6a5e525451a39e21ccf72d309210f0ad7c868a67c510534c540b94f3c80f321924783fdc5babe90350
+  data.tar.gz: 17aa8890f8e86834810742ecc6d10784c2a4e673af059db8f0249a7bfb4cd9b84335cf34ad416b879f7b824632cbd9003bbcba8340a55a82b8100985f19741dd

data/.gitignore

@@ -7,5 +7,6 @@
 /spec/reports/
 /tmp/
 
+Gemfile.lock
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -123,6 +123,28 @@ FakerMaker.factory :basket do
 end
 ```
 
+JSON keys are often have a different stylistic convention than Ruby's snake-case so you can override the attribute's name when is come to generating JSON:
+
+```ruby
+FakerMaker.factory :item do
+  name( json: 'productName' ) { Faker::Commerce.product_name }
+  price( json: 'ticketPrice' ) { Faker::Commerce.price }
+end
+```
+
+so in Ruby you would access the attribute using the attribute name as in:
+
+```ruby
+item = FM[:item].build
+puts item
+```
+
+but `item.to_json` would produce:
+
+```javascript
+{"productName":"Enormous Silk Pants","ticketPrice":55.35}
+```
+
 ### Building instances
 
 Instances are Plain Ol' Ruby Objects and the attributes are attached with getters and setters with their values assigned to the value return from their block at build time. 

data/lib/faker_maker/attribute.rb

@@ -1,12 +1,13 @@
 module FakerMaker
   class Attribute
-    attr_reader :name, :block
+    attr_reader :name, :block, :translation
 
     def initialize name, options={}, block
       assert_valid_options options
       @name = name
       @block = block
       @cardinality = options[:has] || 1
+      @translation = options[:json]
       @array = options[:array] == true 
     end
 
@@ -22,6 +23,10 @@ module FakerMaker
       end
     end
 
+    def translation?
+      ! @translation.blank?
+    end
+
     private 
 
     def forced_array?
@@ -29,7 +34,7 @@ module FakerMaker
     end
 
     def assert_valid_options options
-      options.assert_valid_keys :has, :array
+      options.assert_valid_keys :has, :array, :json
     end
 
   end

data/lib/faker_maker/factory.rb

@@ -32,6 +32,7 @@ module FakerMaker
         @klass = Class.new @parent_class
         Object.const_set @class_name, @klass
         attach_attributes_to_class
+        attach_json_overrides_to_class
       end
       @klass
     end
@@ -44,6 +45,18 @@ module FakerMaker
       ! @parent.nil?
     end
 
+    def json_key_map
+      unless @json_key_map
+        @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
+          map[attr.name] = key
+        end
+      end
+      @json_key_map
+    end
+
     protected 
 
     def populate_instance instance
@@ -59,6 +72,7 @@ module FakerMaker
 
         instance.send "#{attr.name}=", value
       end
+      instance.instance_variable_set( :@fm_factory, self )
     end
 
     private
@@ -71,6 +85,13 @@ module FakerMaker
       @attributes.each do |attr|
         @klass.send( :attr_accessor, attr.name )
       end
+      @klass.send( :attr_reader, :fm_factory )
+    end
+
+    def attach_json_overrides_to_class
+      @klass.define_method :as_json do |options={}|
+        super( options.merge( except: 'fm_factory' ) ).transform_keys{ |key| @fm_factory.json_key_map[key] || key }
+      end
     end
 
     def assert_valid_options options

data/lib/faker_maker/version.rb

@@ -1,3 +1,3 @@
 module FakerMaker
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faker_maker
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2019-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,7 +120,6 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,65 +0,0 @@
-PATH
-  remote: .
-  specs:
-    faker_maker (0.1.0)
-      activesupport (>= 5.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.4)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    faker (1.9.3)
-      i18n (>= 0.7)
-    i18n (1.5.3)
-      concurrent-ruby (~> 1.0)
-    json (2.2.0)
-    method_source (0.9.2)
-    minitest (5.11.3)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  faker (>= 1.9)
-  faker_maker!
-  pry
-  rake (~> 10.0)
-  rspec (>= 3.8)
-  simplecov (>= 0.16)
-
-BUNDLED WITH
-   2.0.1