tdc 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea6a4c15535d29f9f7ab47c6ec12f4c20cc59f588543b19869324f5901097c24
-  data.tar.gz: c5d57e1578f9550a725f20f6ef396bd2bb3d5791773929afd9c6605d8686f2b3
+  metadata.gz: 6d7775cd9909b7d1aef1f59def823777cc24d6bbfc50ddfd41eda202f5f5f387
+  data.tar.gz: 11b7ddadec9d97e1953f34efdee8b66d6f0cb08213dd8d9a9e9d4ae8372687fa
 SHA512:
-  metadata.gz: 7829e509a7c5ef3c7db2b947ee109af96a442c662ccb15e0f5ab50a04e70f91eef039944b65a4b6dfcf9eae232e249146062067c79a2ca955cff2027b0aee649
-  data.tar.gz: 20eefb49010d15905073f5f823bdc171cc428e5c2ef1217d61ec17210d4426f4dd7de4312c56167cd4b67b37d43c2049b3cfc90b0a8b51f4577eb5c884b94841
+  metadata.gz: 1f396da321ee096251062cd35ff6add1d19292591dc8fa019509fe432f2fd7faea74844ee4583fbb30bc03e9f8106fbeabdb403732ec5098d70c40b69e2c216c
+  data.tar.gz: 69cfdaa1a302ae2d458f6775db22134953db4f6f584ba9af36970f4865d308de9a44d9c5c6ec10e7db0a4ec5c05d340254a4458dfc843d6676225459e2542660

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2020-07-19
+
+- Introduce the DefinitionResolver abstraction
+
 ## [0.2.4] - 2020-07-19
 
 - Improve Tdc::MissingOverrideError diagnostics

data/README.md

@@ -6,6 +6,8 @@
 
 Define your own test data generators by inheriting from ```StandardGenerator``` or ```SingularGenerator```. Best practice is to define an ```ApplicationStandardGenerator``` and an ```ApplicationSingularGenerator``` and have all other generators inherit from them.
 
+Define your own definition resolvers by inheriting from ```DefinitionResolver```. Best practice is to define an ```ApplicationDefinitionResolver``` and all other definition resolvers inherit from it.
+
 During generation the test data catalog will be represented by ```CatalogEntries``` that are populated by reading from ```YAML``` files with a ```DataDefinitionReader``` or provided directly by an ```InMemoryDataDefinition```.
 
 **Data Definition DSL**

data/lib/tdc.rb

@@ -33,6 +33,11 @@ require "tdc/generators/configurable_generator"
 require "tdc/generators/singular_generator"
 require "tdc/generators/standard_generator"
 
+# Definition Resolvers
+require "tdc/definition_resolvers"
+require "tdc/definition_resolvers/definition_resolver"
+require "tdc/definition_resolvers/tag_resolver"
+
 #
 # A framework for building a Test Data Catalog
 #

data/lib/tdc/definition_resolvers.rb

@@ -0,0 +1,7 @@
+module Tdc
+  #
+  # Namespace to host definition resolvers.
+  #
+  module DefinitionResolvers
+  end
+end

data/lib/tdc/definition_resolvers/definition_resolver.rb

@@ -0,0 +1,18 @@
+module Tdc
+  module DefinitionResolvers
+    #
+    # Base class for any definition resolver.
+    #
+    class DefinitionResolver
+      attr_reader :current_catalog
+
+      def configure_current_catalog(current_catalog)
+        @current_catalog = current_catalog
+      end
+
+      def resolve(_instance_definition)
+        raise Tdc::MissingOverrideError, "Implement the 'resolve' method"
+      end
+    end
+  end
+end

data/lib/tdc/definition_resolvers/tag_resolver.rb

@@ -0,0 +1,38 @@
+module Tdc
+  module DefinitionResolvers
+    #
+    # Knows how to resolve the tag value for the specified instance_definition key by replacing it
+    # with an object sourced from the current catalog.
+    #
+    class TagResolver < Tdc::DefinitionResolvers::DefinitionResolver
+      attr_reader :key, :source
+
+      def initialize(key:, source:)
+        @key = key
+        @source = source
+      end
+
+      def resolve(instance_definition)
+        return unless instance_definition.key?(key)
+
+        # Lookup the source catalog entry in the current_catalog.
+        catalog_entry = instance_eval("current_catalog.#{source}", __FILE__, __LINE__)
+
+        # Before resolution the instance definition value is a tag.
+        tag = instance_definition[key]
+
+        # Use the tag to source an object from the current catalog.
+        sourced_object = catalog_entry.send(tag)
+
+        unless sourced_object
+          message = "Could not find a tag reference for '#{key}' in the catalog entries provided."
+
+          raise Tdc::FatalError, message
+        end
+
+        # Replace the tag value with the sourced object.
+        instance_definition[key] = sourced_object
+      end
+    end
+  end
+end

data/lib/tdc/generators.rb

@@ -1,6 +1,6 @@
 module Tdc
   #
-  # Namespace to host generators
+  # Namespace to host generators.
   #
   module Generators
   end

data/lib/tdc/generators/configurable_generator.rb

@@ -14,7 +14,7 @@ module Tdc
 
       def run_resolvers_and_generate_instance
         run_atx_resolvers(instance_definition)
-        run_tag_resolvers(instance_definition)
+        run_definition_resolvers(instance_definition)
 
         generate_instance
       end
@@ -29,7 +29,7 @@ module Tdc
       #
       # Hook method: subclasses may include the DefinitionResolvable concern to override.
       #
-      def run_tag_resolvers(_instance_definition)
+      def run_definition_resolvers(_instance_definition)
         # Do nothing
       end
 

data/lib/tdc/generators/definition_resolvable.rb

@@ -1,61 +1,59 @@
 module Tdc
   module Generators
     #
-    # Knows how to resolve tag values in an instance definition. The tag value will be replaced
-    # with a model instance from the current catalog.
+    # Knows how to resolve attribute values in an instance definition. The attribute value will be replaced
+    # by the result of invoking the specified resolver.
     #
-    # The resolve_tag class macro is provided for generators to define tag resolution.
+    # The resolve_tag class macro is provided for generators to define tag resolution. The test data definition
+    # YAML file has attribute values than contain a catalog entry tag.
     #
     # Example:
     #
-    # Suppose a particular instance definition contained { subcomponent: sc_snackers_minis }
-    # then a generator could resolve the subcomponent by defining:
+    # Suppose a particular instance definition contained { subcomponent: sc_snackers_minis } then a generator
+    # could resolve the subcomponent tag to the current catalog by defining:
     #
     #   resolve_tag key: :subcomponent, source: "item_master.items"
     #
+    # The resolve_definition class macro is provided for generators to define definition resolution. The test data
+    # definition YAML file has attribute values than contain an arbitrary value that will typically be replaced by
+    # an instance of an object returned by the specified resolver.
+    #
+    # Example:
+    #
+    # Suppose a particular instance definition contained { pallet_number: P0001 } then a generator could resolve
+    # the pallet_number to a pallet instance by defining:
+    #
+    #   resolve_definition :pallet_number, to: :pallet_id, resolver: "TestDataCatalog::Resolvers::PalletNumberResolver"
+    #
+    # The PalletNumberResolver class inherits from Tdc::DefinitionResolvers::DefinitionResolver.
+    #
     module DefinitionResolvable
       extend ActiveSupport::Concern
 
       included do
-        class_attribute :_tag_resolvers, instance_writer: false
-        self._tag_resolvers = []
+        class_attribute :_definition_resolvers, instance_writer: false
+
+        self._definition_resolvers = []
       end
 
       class_methods do
-        def resolve_tag(key:, source:)
-          _tag_resolvers << [key, source]
+        def resolve_definition(key:, to: nil, resolver:)
+          resolver_instance = resolver.constantize.new(key: key, to: to || key)
+
+          _definition_resolvers << resolver_instance
         end
-      end
 
-      def run_tag_resolvers(instance_definition)
-        _tag_resolvers.each { |key, source| _resolve_tag_reference(instance_definition, key, source) }
+        def resolve_tag(key:, source:)
+          _definition_resolvers << Tdc::DefinitionResolvers::TagResolver.new(key: key, source: source)
+        end
       end
 
-      private
-
-      #
-      # Replace the tag value for the specified instance_definition key with an object sourced from the current catalog.
-      #
-      def _resolve_tag_reference(instance_definition, key, source)
-        return unless instance_definition.key?(key)
-
-        # Lookup the source catalog entry in the current_catalog.
-        catalog_entry = instance_eval("current_catalog.#{source}", __FILE__, __LINE__)
+      def run_definition_resolvers(instance_definition)
+        _definition_resolvers.each do |definition_resolver|
+          definition_resolver.configure_current_catalog(current_catalog)
 
-        # Before resolution the instance definition value is a tag.
-        tag = instance_definition[key]
-
-        # Use the tag to source an object from the current catalog.
-        sourced_object = catalog_entry.send(tag)
-
-        unless sourced_object
-          message = "Could not find a tag reference for '#{key}' in the catalog entries provided."
-
-          raise Tdc::FatalError, message
+          definition_resolver.resolve(instance_definition)
         end
-
-        # Replace the tag value with the sourced object.
-        instance_definition[key] = sourced_object
       end
     end
   end

data/lib/tdc/version.rb

@@ -1,3 +1,3 @@
 module Tdc
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -128,6 +128,9 @@ files:
 - lib/tdc.rb
 - lib/tdc/data_definition.rb
 - lib/tdc/data_definition_file_reader.rb
+- lib/tdc/definition_resolvers.rb
+- lib/tdc/definition_resolvers/definition_resolver.rb
+- lib/tdc/definition_resolvers/tag_resolver.rb
 - lib/tdc/fatal_error.rb
 - lib/tdc/generators.rb
 - lib/tdc/generators/catalog_entries.rb