tdc 0.2.3 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea4c40daa383ebc80a1109132a3a8ded7bb6f89a77cb49b928bed2db838fbf6
-  data.tar.gz: fda5f7f22c87bcb36a7b4c072ad85809bb1f1f78e7bb621396fa746511c34dd0
+  metadata.gz: e58c0fcfbfa32aa0dde6627786e39bbfaff4140d3326f144925113031163faf8
+  data.tar.gz: e9b5f186a199bd2cc3479fd9fd48087fd0f1d433006c03f2502c2cb48c6f300d
 SHA512:
-  metadata.gz: d085e28662d3038b7609fb58d7e8b50fceca95a624cc9d0192b27d803f31bbaa1fff87996a93500a91557a8c45fc1b5adad26f4f6b6fe4dbf7bffafb11782640
-  data.tar.gz: 1ae1baacafb85ec5fbc8ed58d7f2de790cf68b75fa84461712f0b7e3cbf7f361335005cfdb8c23dd8e3c39576bdc496aa27b9272ef059f54ef2fb8f6f9638a73
+  metadata.gz: 10a3a536987b80e57169defc47b65496550fc3c9ba4fa91d9c6ec448b8debd77d24d44cf5dbe047d708979fd4d29e4b1186ef712d0cfcb0b094cd0418d6d2524
+  data.tar.gz: cfd63f4adcb438992e71a4e9ac8c20024c9b1f0d68d4a8eda5765456cb7054c602a3b7f97178f66f5c5e0876314180fd42404c7100d29382d544834e2239f010

data/.rubocop.yml

@@ -10,6 +10,9 @@ AllCops:
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
 
+Metrics/LineLength:
+  Max: 120
+
 # Rubocop and I cannot agree.
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
@@ -17,6 +20,15 @@ Layout/MultilineMethodCallBraceLayout:
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
 Lint/RaiseException:
   Enabled: true
 
@@ -35,9 +47,6 @@ RSpec/AnyInstance:
 RSpec/ExampleLength:
   Max: 15
 
-Metrics/LineLength:
-  Max: 120
-
 RSpec/DescribeClass:
   Enabled: false
 
@@ -59,11 +68,24 @@ RSpec/MultipleExpectations:
 RSpec/SubjectStub:
   Enabled: false
 
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
 Style/BlockDelimiters:
   Enabled: true
   EnforcedStyle: line_count_based
   BracesRequiredMethods:
     - 'let'
+    - 'subject'
+
+Style/CaseLikeIf:
+  Enabled: true
 
 Style/Documentation:
   Enabled: false
@@ -78,9 +100,15 @@ Style/ExponentialNotation:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/HashAsLastArrayItem:
+  Enabled: true
+
 Style/HashEachMethods:
   Enabled: true
 
+Style/HashLikeCase:
+  Enabled: true
+
 Style/HashTransformKeys:
   Enabled: true
 
@@ -92,6 +120,21 @@ Style/HashSyntax:
   Exclude:
     - 'Rakefile'
 
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
 # No need to mention StandardError.
 Style/RescueStandardError:
   EnforcedStyle: implicit

data/CHANGELOG.md

@@ -6,6 +6,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.3] - 2020-08-04
+
+- Add the `empty?` method to `CatalogEntries`
+- Evaluate `_atx` attribute values against a `Time.zone` instance
+
+## [0.3.2] - 2020-07-27
+
+- Return `self` from `DefinitionResolver#configure_current_catalog` to make it chainable
+
+## [0.3.1] - 2020-07-25
+
+- Support DefinitionResolver instance registration
+
+## [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

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

@@ -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/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,20 @@
+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
+
+        self
+      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/catalog_entries.rb

@@ -8,6 +8,10 @@ module Tdc
       def add_catalog_entry(tag, entry)
         send("#{tag}=", entry)
       end
+
+      def empty?
+        to_h.empty?
+      end
     end
   end
 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
@@ -23,13 +23,13 @@ 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
 
@@ -44,12 +44,15 @@ module Tdc
       def run_atx_resolvers(instance_definition)
         atx_definitions = instance_definition.select { |k, _v| /_atx$/ =~ k }
 
+        # ARM (2020-08-04): Move all the way out so that all generators use the same atx_context.
+        atx_context = Time.zone
+
         atx_definitions.each do |k, v|
           # Remove the original _atx attribute.
           instance_definition.delete(k)
 
           # Add a standard _at attribute.
-          instance_definition[k.delete_suffix("x")] = eval(v) # rubocop:disable Security/Eval
+          instance_definition[k.delete_suffix("x")] = atx_context.instance_eval(v)
         end
       end
     end

data/lib/tdc/generators/definition_resolvable.rb

@@ -1,61 +1,48 @@
 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 registered 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 register_definition_resolver class macro is provided for generators to define and register their own
+    # definition resolvers. 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.
+    #
     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 register_definition_resolver(resolver_instance)
+          _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:)
+          register_definition_resolver(Tdc::DefinitionResolvers::TagResolver.new(key: key, source: source))
+        end
       end
 
-      private
+      def run_definition_resolvers(instance_definition)
+        _definition_resolvers.each do |definition_resolver|
+          definition_resolver.configure_current_catalog(current_catalog)
 
-      #
-      # 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__)
-
-        # 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/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

@@ -6,12 +6,6 @@ module Tdc
     # See also StandardGenerator.
     #
     class SingularGenerator < Tdc::Generators::ConfigurableGenerator
-      def initialize(data_definition, current_catalog)
-        super
-
-        @additional_definitions = {}
-      end
-
       def with_definition(additional_definitions)
         @additional_definitions = additional_definitions.stringify_keys.reject { |_, v| v == :missing_definition }
 
@@ -19,13 +13,17 @@ 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
 

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.3"
+  VERSION = "0.3.3"
 end

data/tdc.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = "A simple framework for creating a Test Data Catalog"
   spec.homepage = "https://github.com/nulogy/tdc"
+  spec.license = "MIT"
 
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
@@ -31,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", ">= 12.1", "< 13.1"
   spec.add_development_dependency "rspec", ">= 3.9", "< 4.0"
-  spec.add_development_dependency "rubocop", "~> 0.82"
-  spec.add_development_dependency "rubocop-rspec", "~> 1.38"
+  spec.add_development_dependency "rubocop", "~> 0.88"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.42"
   spec.add_development_dependency "simplecov", "~> 0.17"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.3
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,28 +70,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: '0.88'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: '0.88'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.38'
+        version: '1.42'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.38'
+        version: '1.42'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -143,7 +146,8 @@ files:
 - lib/tdc/with_indifferent_access_decorator.rb
 - tdc.gemspec
 homepage: https://github.com/nulogy/tdc
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/nulogy/tdc
   changelog_uri: https://github.com/nulogy/tdc/blob/master/CHANGELOG.md
@@ -164,7 +168,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