faker_maker 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d52a9450058657ec1fba8756afa5a965a6f92fcf074ef5d05c0c2b7a1d09ea2
-  data.tar.gz: e0c12b011abd0337a5699a054c44e0b4fc3eb05f385b24a0dd9e54d2864ee611
+  metadata.gz: 6355e061188d88ab10d97dae93595abccbf2a73346b6220c265c9241198f93ba
+  data.tar.gz: 487700e0d8e88f4fb69d00796bb4d644263e7c91af91eea188caa7eaf82861c5
 SHA512:
-  metadata.gz: d467cdafe73e4ddd1cf0b1677f96c935f28430b09b2580b7a141d674d4c8690f6c850bacb8c2f2c22ad32805e9d2d2e8c86c77f5807a50018d375299f56c70b1
-  data.tar.gz: 4f4ede5c6ac0e3290952e29f03b90855c7112332a32a6ceaebe0d5b8ab54340388698bebcdaadabe390beb55a4ac91597200a8960e668e8fb9f0a276ad9f00e1
+  metadata.gz: e2e50d6ffa61e8164163d2157a65d8a3b93b24e442028e0e04951b25f8e298693bd3a8c6ff3ff948442c38c972f427ec05017020dd120b0cfeefdbb02ebd82b8
+  data.tar.gz: 4c1ae45972c019f0929b1c0337b20ebe4f92ecaa040811f515934d50ce38e826956c994a3043d1f8a27928921930a32980d4bff29fceffbb0c8a7a82f1d4ebd6

data/.rubocop.yml

@@ -43,4 +43,7 @@ Metrics/MethodLength:
   Enabled: false
 
 Lint/MissingSuper:
-  Enabled: false
+  Enabled: false
+
+AllCops:
+  NewCops: enable

data/Guardfile

@@ -17,7 +17,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'

data/docs/usage/audit_logs.md

@@ -0,0 +1,47 @@
+---
+layout: default
+title: Audit (History) Logs
+parent: Usage
+nav_order: 10
+---
+
+_(since 1.3.0)_
+
+# Audit logs
+
+It might be useful to collect the history of all the fakes generated by your factories. FakerMaker allows you to stream (or write to a file) all the instances it builds for you. This is optional and disabled by default.
+
+## Enable logging
+
+By default audit logging is disabled. The default output stream is `STDOUT`. The output target can either be an object that responds to `puts`, or be a string which will be interpreted as a file location to use to write to. If file path string is used, it will be opened in 'append' mode.
+
+```ruby
+FakerMaker.configure do |config|
+  config.audit = true
+  config.audit_destination = '/tmp/faker_maker_audit_logs'
+end
+```
+
+## Audit streams
+
+Immediately after each object is built and after the post-build hooks have completed, the instance details will be logged in line-delimited JSON (JSONL), to the stream or file. Each line is contained in an envelope containing the following metadata:
+
+* The timestamp at the time of logging
+* The name of factory
+* The class name of the object the factory instantiated
+
+For example, given the factory:
+
+```ruby
+FakerMaker.factory :user do 
+  name {'Patsy Stone'}
+  email {'patsy@fabulous.co.uk'}
+  admin {false}
+end
+```
+
+The audit log, on build, would look like:
+
+```
+{"timestamp":"2023-05-15T15:46:30+01:00","factory":"user","class":"User","body":{"name":"Patsy Stone","email":"patsy@fabulous.co.uk","admin":false}}
+```

data/faker_maker.gemspec

@@ -41,7 +41,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '>= 5.2', '< 7'
+  spec.add_dependency 'activesupport', '>= 5.2', '< 8'
 
   spec.add_development_dependency 'bundler',       '~> 2.0'
   spec.add_development_dependency 'faker',         '~> 2.1'
@@ -53,8 +53,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake',          '~> 13.0'
   spec.add_development_dependency 'rspec',         '~> 3.8'
   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'
+  spec.required_ruby_version = '>= 3.0'
 end

data/lib/faker_maker/attribute.rb

@@ -8,7 +8,7 @@ module FakerMaker
     def initialize( name, block = nil, options = {} )
       assert_valid_options options
       @name = name
-      @block = block || proc { nil }
+      @block = block || proc {}
       @cardinality = options[:has] || 1
       @translation = options[:json]
       @omit = *options[:omit]

data/lib/faker_maker/auditable.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# FakerMaker module for generating Fakes
+module FakerMaker
+  # Mix-in module which provides the auditable functionality
+  module Auditable
+    def audit(instance)
+      envelope = audit_envelope(class: instance.class.name, body: instance.as_json)
+      audit_stream.puts(JSON.generate(envelope))
+      audit_stream.flush if audit_stream.respond_to?(:flush)
+    rescue StandardError => e
+      warn "FakerMaker Warning: #{e.class}: \"#{e.message}\" occurred. FakerMaker will disable audit logging. " \
+           'Further warnings supressed.'
+      FakerMaker.configuration.audit = false
+    end
+
+    private
+
+    def audit_stream
+      destination = FakerMaker.configuration.audit_destination
+      return destination if destination.respond_to?(:puts)
+
+      file_destination = File.new(destination, 'a')
+      FakerMaker.configuration.audit_destination = file_destination
+    end
+
+    def audit_envelope(**overrides)
+      {
+        timestamp: DateTime.now.iso8601,
+        factory: name.to_s,
+        **overrides
+      }
+    end
+  end
+end

data/lib/faker_maker/configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# FakerMaker module for generating Fakes
+module FakerMaker
+  # Configuration class, holds all the config options for FM
+  class Configuration
+    attr_writer :audit
+    attr_accessor :audit_destination
+
+    def initialize
+      @audit = false
+      @audit_destination = $stdout
+    end
+
+    def audit?
+      @audit
+    end
+  end
+
+  # Mixin to provide configuraton methods to an extending or implementing class
+  module Configurable
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configuration=(config)
+      @configuration = config
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+  end
+end

data/lib/faker_maker/factory.rb

@@ -4,6 +4,7 @@
 module FakerMaker
   # Factories construct instances of a fake
   class Factory
+    include Auditable
     attr_reader :name, :class_name, :parent
 
     def initialize( name, options = {} )
@@ -48,6 +49,7 @@ module FakerMaker
       populate_instance instance, attributes
       yield instance if block_given?
       after_build if respond_to? :after_build
+      audit(@instance) if FakerMaker.configuration.audit?
       instance
     end
 

data/lib/faker_maker/lifecycle_hooks.rb

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

data/lib/faker_maker/version.rb

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

data/lib/faker_maker.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require 'time'
+
 require 'active_support'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/object/json'
 require 'active_support/core_ext/string'
 require 'faker_maker/attribute'
+require 'faker_maker/auditable'
 require 'faker_maker/base'
+require 'faker_maker/configuration'
 require 'faker_maker/lifecycle_hooks'
 require 'faker_maker/definition_proxy'
 require 'faker_maker/factory'
@@ -18,6 +22,7 @@ require 'faker_maker/version'
 # FakerMaker module for generating Fakes
 module FakerMaker
   extend FakerMaker::Base
+  extend FakerMaker::Configurable
 
   class Error < StandardError; end
   class NoSuchFactoryError < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faker_maker
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -170,34 +170,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 description: FakerMaker is a simple factory builder so you can throw away your fixtures
   and generate test data instead.
 email:
@@ -206,8 +178,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".coveralls.yml"
 - ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
@@ -230,6 +200,7 @@ files:
 - docs/installation.md
 - docs/logo.png
 - docs/usage/arrays.md
+- docs/usage/audit_logs.md
 - docs/usage/building_instances.md
 - docs/usage/dependencies.md
 - docs/usage/destroying_factories.md
@@ -243,7 +214,9 @@ files:
 - img/unipug.svg
 - lib/faker_maker.rb
 - lib/faker_maker/attribute.rb
+- lib/faker_maker/auditable.rb
 - lib/faker_maker/base.rb
+- lib/faker_maker/configuration.rb
 - lib/faker_maker/definition_proxy.rb
 - lib/faker_maker/factory.rb
 - lib/faker_maker/lifecycle_hooks.rb
@@ -266,14 +239,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: FakerMaker bakes fakes.

data/.circleci/config.yml

@@ -1,13 +0,0 @@
-# Use the latest 2.1 version of CircleCI pipeline processing engine, see https://circleci.com/docs/2.0/configuration-reference/
-version: 2.1
-
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.6.3-stretch-node
-    steps:
-      - checkout
-      - run: gem update --system
-      - run: gem install bundler
-      - run: bundle install
-      - run: bundle exec rake spec

data/.coveralls.yml

@@ -1 +0,0 @@
-repo_token: K7czIqoKhrE9BRBk1ubEToyJkLgTk0frJ