tdc 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c04de93f4bf48d68994ce4b8adab06f21ebd2f44e3d47ce6f221400cdc8495d
-  data.tar.gz: 93a7c7a9d9dc4ea4480cc464cf6dc7c6526b6e941a68d74de956572e3fe71864
+  metadata.gz: 6d7775cd9909b7d1aef1f59def823777cc24d6bbfc50ddfd41eda202f5f5f387
+  data.tar.gz: 11b7ddadec9d97e1953f34efdee8b66d6f0cb08213dd8d9a9e9d4ae8372687fa
 SHA512:
-  metadata.gz: 4986b573ecf8e32558cbfafddba2218a21896f7b01c6197b42bdab1b117cdee729dd3f0cc58fb8907e577223dad3fcd42890a8fedc937e1a9f4280a3be2be224
-  data.tar.gz: 25aad449a81724ff044343015835148683c540ba3080d298841152bca2b5ac79d29557f1b2de17d7e986d1556629c20a542e4360a7ece7c3c6998c3fc5971402
+  metadata.gz: 1f396da321ee096251062cd35ff6add1d19292591dc8fa019509fe432f2fd7faea74844ee4583fbb30bc03e9f8106fbeabdb403732ec5098d70c40b69e2c216c
+  data.tar.gz: 69cfdaa1a302ae2d458f6775db22134953db4f6f584ba9af36970f4865d308de9a44d9c5c6ec10e7db0a4ec5c05d340254a4458dfc843d6676225459e2542660

data/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.rspec

@@ -1,3 +1,3 @@
 --format documentation
 --color
---require spec_helper
+--require tdc_spec_helper

data/.rubocop.yml

@@ -64,10 +64,14 @@ Style/BlockDelimiters:
   EnforcedStyle: line_count_based
   BracesRequiredMethods:
     - 'let'
+    - 'subject'
 
 Style/Documentation:
   Enabled: false
 
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
 Style/ExponentialNotation:
   Enabled: true
 

data/CHANGELOG.md

@@ -6,6 +6,26 @@ 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
+
+## [0.2.3] - 2020-05-21
+
+- Update the diagram in the README
+
+## [0.2.2] - 2020-05-20
+
+- Adding specs
+
+## [0.2.1] - 2020-05-19
+
+- Adding specs
+
 ## [0.2.0] - 2020-05-19
 
 #### Breaking Changes

data/README.md

@@ -4,7 +4,9 @@
 
 **Extension Points**
 
-Define your own test data generators by inheriting from ```StandardGenerator``` or ```Singular Generator```.
+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/lib/tdc.rb

@@ -1,24 +1,43 @@
 require "ostruct"
+require "yaml"
 
+require "active_support"
 require "active_support/concern"
-require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext"
 
+require "tdc/version"
+
+# Errors
+require "tdc/fatal_error"
+require "tdc/missing_override_error"
+
+# Data Definition Hierarchy
 require "tdc/data_definition"
 require "tdc/data_definition_file_reader"
-require "tdc/fatal_error"
 require "tdc/in_memory_data_definition"
-require "tdc/version"
 require "tdc/with_indifferent_access_decorator"
 
+# Generators
 require "tdc/generators"
+
+# Current Catalog
 require "tdc/generators/catalog_entries"
+
+# Concerns
 require "tdc/generators/definition_resolvable"
 require "tdc/generators/definition_sourcable"
+
+# Generator Hierarchy
 require "tdc/generators/generator_base"
-require "tdc/generators/instance_definition_configurable"
+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/data_definition.rb

@@ -4,7 +4,7 @@ module Tdc
   #
   class DataDefinition
     def read(*_path_elements)
-      raise MissingOverrideError
+      raise MissingOverrideError, "Implement the 'read' method"
     end
 
     def with_indifferent_access

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/{instance_definition_configurable.rb → configurable_generator.rb}

@@ -5,27 +5,16 @@ module Tdc
     #
     # Shared implementation between the StandardGenerator and the SingularGenerator abstract classes.
     #
-    module InstanceDefinitionConfigurable
-      extend ActiveSupport::Concern
+    class ConfigurableGenerator < Tdc::Generators::GeneratorBase
+      include Tdc::Generators::DefinitionSourcable
 
-      included do
-        include Tdc::Generators::DefinitionSourcable
+      attr_reader :instance_definition
 
-        attr_reader :instance_definition
-
-        source_definition_from :instance_definition
-      end
-
-      private
-
-      def configure_instance_definition(instance_definition)
-        @instance_definition = instance_definition
-        configure_definition_source(instance_definition)
-      end
+      source_definition_from :instance_definition
 
       def run_resolvers_and_generate_instance
         run_atx_resolvers(instance_definition)
-        run_tag_resolvers(instance_definition)
+        run_definition_resolvers(instance_definition)
 
         generate_instance
       end
@@ -34,16 +23,24 @@ module Tdc
       # Hook method: subclasses are expected to define how to generate a model instance.
       #
       def generate_instance
-        raise Tdc::MissingOverrideError
+        raise Tdc::MissingOverrideError, "Implement the 'generate_instance' method"
       end
 
       #
       # 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
 
+      private
+
+      def configure_instance_definition(instance_definition)
+        @instance_definition = instance_definition
+
+        configure_definition_source(instance_definition)
+      end
+
       def run_atx_resolvers(instance_definition)
         atx_definitions = instance_definition.select { |k, _v| /_atx$/ =~ k }
 

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/generators/definition_sourcable.rb

@@ -35,13 +35,13 @@ module Tdc
       def method_missing(method, *args)
         key = transform_method_to_definition_source_key(method)
 
-        definition_source.key?(key) ? definition_source.fetch(key) : super
+        definition_source&.key?(key) ? definition_source.fetch(key) : super
       end
 
       def respond_to_missing?(method, include_all = false)
         key = transform_method_to_definition_source_key(method)
 
-        definition_source.key?(key) ? true : super
+        definition_source&.key?(key) ? true : super
       end
 
       def transform_method_to_definition_source_key(method)

data/lib/tdc/generators/generator_base.rb

@@ -12,11 +12,11 @@ module Tdc
       end
 
       def generate
-        raise Tdc::MissingOverrideError
+        raise Tdc::MissingOverrideError, "Implement the 'generate' method"
       end
 
       def instance_definitions
-        raise Tdc::MissingOverrideError
+        raise Tdc::MissingOverrideError, "Implement the 'instance_definitions' method"
       end
     end
   end

data/lib/tdc/generators/singular_generator.rb

@@ -5,15 +5,7 @@ module Tdc
     #
     # See also StandardGenerator.
     #
-    class SingularGenerator < Tdc::Generators::GeneratorBase
-      include Tdc::Generators::InstanceDefinitionConfigurable
-
-      def initialize(data_definition, current_catalog)
-        super
-
-        @additional_definitions = {}
-      end
-
+    class SingularGenerator < Tdc::Generators::ConfigurableGenerator
       def with_definition(additional_definitions)
         @additional_definitions = additional_definitions.stringify_keys.reject { |_, v| v == :missing_definition }
 
@@ -21,18 +13,22 @@ module Tdc
       end
 
       def generate
-        configure_instance_definition(singular_instance_definition.merge(@additional_definitions))
+        configure_instance_definition(singular_instance_definition.merge(additional_definitions))
 
         run_resolvers_and_generate_instance
       end
 
       private
 
+      def additional_definitions
+        @additional_definitions || {}
+      end
+
       def singular_instance_definition
         all_instance_definitions = instance_definitions
 
         if all_instance_definitions.many?
-          raise Tdc::FatalError, "For the moment we only generate a single model instance"
+          raise Tdc::FatalError, "A singular generator only generates a single model instance"
         end
 
         # Delete the tag so that the models do not need to filter it out.

data/lib/tdc/generators/standard_generator.rb

@@ -5,9 +5,7 @@ module Tdc
     #
     # See also SingularGenerator.
     #
-    class StandardGenerator < Tdc::Generators::GeneratorBase
-      include Tdc::Generators::InstanceDefinitionConfigurable
-
+    class StandardGenerator < Tdc::Generators::ConfigurableGenerator
       def generate
         CatalogEntries.new.tap do |catalog_entries|
           instance_definitions.each do |instance_definition|

data/lib/tdc/missing_override_error.rb

@@ -1,7 +1,3 @@
 module Tdc
-  class MissingOverrideError < Tdc::FatalError
-    def initialize
-      super("Must be implemented")
-    end
-  end
+  MissingOverrideError = Class.new(Tdc::FatalError)
 end

data/lib/tdc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,6 +113,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -127,13 +128,16 @@ 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
+- lib/tdc/generators/configurable_generator.rb
 - lib/tdc/generators/definition_resolvable.rb
 - lib/tdc/generators/definition_sourcable.rb
 - lib/tdc/generators/generator_base.rb
-- lib/tdc/generators/instance_definition_configurable.rb
 - lib/tdc/generators/singular_generator.rb
 - lib/tdc/generators/standard_generator.rb
 - lib/tdc/in_memory_data_definition.rb
@@ -163,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A simple framework for creating a Test Data Catalog