tdc 0.3.7 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b38de678846606fd9e8563342d256585f38ff34a0cc4f969a3e5275e8d2c4d7e
-  data.tar.gz: f6158ca091edf735897be992e53b6d106eac7d0de863725fa2fd65eab1f4ddf8
+  metadata.gz: 83b4405ab9ec996fbab35d7228931e03d5bf18966df916b631d36d6aecca4393
+  data.tar.gz: 942728ff3d354bb5dc516c777606766b798ae218b4fd85ec4823cfad7e9d1875
 SHA512:
-  metadata.gz: d88d2c5bf021d945861c2e26ebc1336fdc9ae418cd74b01ef7135f8c9edcfbf7cb29dfe9dbd99b834d7a13572338cd6bd5587bb8a08baf6e1ed39a9db3ce8691
-  data.tar.gz: e30dfc82648765df615d1853861f48c7f204aea8ae375b1fcd48127fba4853fa316c216cc41cfcb2766bd2bf9b7a4cdc83e500909a0ad6656e96237db22f1353
+  metadata.gz: 1a783d54d2a3af00fcd0d8366b1a55190503fda3350308179f5eb778f2fab6f3601b7c6eded92bd27a123a39303160ffa19381902228e8e11ab5f4213deda20c
+  data.tar.gz: 5cc30405e4369c739e5a77370bf663d0813a2a72e2bdbaa7791bd8c1f966c5337c477689c4f968b82d20ee41bc3d22f94baa0731fb0d38948f6001137d4f56c6

data/.rubocop.yml

@@ -21,6 +21,10 @@ Metrics/BlockLength:
 Naming/MemoizedInstanceVariableName:
   EnforcedStyleForLeadingUnderscores: required
 
+Naming/VariableNumber:
+  Enabled: true
+  EnforcedStyle: snake_case
+
 RSpec/AnyInstance:
   Enabled: false
 

data/CHANGELOG.md

@@ -6,15 +6,46 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.2] - 2020-08-22
+
+- Extended attributes use `_xa` suffix
+
+## [0.4.1] - 2020-08-22
+
+- Add the `first` method to `CatalogEntries`
+
+## [0.4.0] - 2020-08-14
+
+#### New Features
+
+- Drop requirement that an empty test data definition file must be provided 
+
+## [0.3.9] - 2020-08-12
+
+#### Breaking Changes
+
+- Collapse `ConfigurableGenerator` into `StandardGenerator`
+
+## [0.3.8] - 2020-08-11
+
+#### New Features
+
+- Multiple subclass instances of `ExtendedAttributes::InterpreterBase` may be registered
+- A default extended attribute interpreter recognizes `_atx`, `_datex`, or `_onx` date/time attributes
+
+#### Breaking Changes
+
+- Rename `AtxContextFactory` to `ExtendedAttributes::InterpreterRegistry`
+
 ## [0.3.7] - 2020-08-10
 
 #### New Features
 
-- Register a context with the AtxContextFactory
+- Register a context with the `AtxContextFactory`
 
 ## [0.3.6.1] - 2020-08-10
 
-- Add the AtxContextFactory abstraction
+- Add the `AtxContextFactory` abstraction
 
 ## [0.3.6] - 2020-08-06
 

data/README.md

@@ -13,3 +13,5 @@ During generation the test data catalog will be represented by ```CatalogEntries
 **Data Definition DSL**
 
 ```DefinitionResolvable``` and ```DefinitionSourcable``` provide a DSL that you may use in your generators to work more easily with a ```DataDefinition```.
+
+By registering a class instance that inherits from ```ExtendedAttributes::InterpreterBase``` with the ```ExtendedAttributes::InterpreterRegistry``` you may extend the DSL that is used to interpret attribute values. 

data/lib/tdc.rb

@@ -7,10 +7,21 @@ require "active_support/core_ext"
 
 require "tdc/version"
 
-# Errors
+# Definition Resolvers
+require "tdc/definition_resolvers"
+require "tdc/definition_resolvers/definition_resolver"
+require "tdc/definition_resolvers/tag_resolver"
+
+# Tdc Errors
 require "tdc/fatal_error"
 require "tdc/missing_override_error"
 
+# Extended Attributes
+require "tdc/extended_attributes"
+require "tdc/extended_attributes/interpreter_base"
+require "tdc/extended_attributes/default_interpreter"
+require "tdc/extended_attributes/interpreter_registry"
+
 # Data Definition Hierarchy
 require "tdc/data_definition"
 require "tdc/data_definition_file_reader"
@@ -19,26 +30,17 @@ require "tdc/with_indifferent_access_decorator"
 
 # Generators
 require "tdc/generators"
-require "tdc/generators/atx_context_factory"
-require "tdc/generators/generation_context"
-
-# Current Catalog
 require "tdc/generators/catalog_entries"
+require "tdc/generators/generation_context"
 
-# Concerns
+# Generator Concerns
 require "tdc/generators/definition_resolvable"
 require "tdc/generators/definition_sourcable"
 
 # Generator Hierarchy
 require "tdc/generators/generator_base"
-require "tdc/generators/configurable_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_file_reader.rb

@@ -29,7 +29,7 @@ module Tdc
       if File.exist?(definitions_file)
         load_yaml(definitions_file) || EMPTY_DEFINITIONS
       else
-        missing_data_definition(definitions_file)
+        EMPTY_DEFINITIONS
       end
     end
 
@@ -45,11 +45,5 @@ module Tdc
     def expand_erb(definitions_file)
       ERB.new(File.read(definitions_file)).result
     end
-
-    def missing_data_definition(definitions_file)
-      return EMPTY_DEFINITIONS if ENV.key?("TDC_IGNORE_MISSING_TEST_DATA_DEFINITION_ERROR")
-
-      raise Tdc::FatalError, "Missing test definitions file: '#{definitions_file}'"
-    end
   end
 end

data/lib/tdc/extended_attributes.rb

@@ -0,0 +1,7 @@
+module Tdc
+  #
+  # Namespace to host extended attributes.
+  #
+  module ExtendedAttributes
+  end
+end

data/lib/tdc/extended_attributes/default_interpreter.rb

@@ -0,0 +1,47 @@
+module Tdc
+  module ExtendedAttributes
+    #
+    # Know how on interpret extended attributes.
+    #
+    # Note: extended attribute keys are expected to be strings rather than symbols.
+    #
+    class DefaultInterpreter < Tdc::ExtendedAttributes::InterpreterBase
+      def interpret(instance_definition)
+        extended_attribute_definitions = keep_extended_attributes(instance_definition)
+
+        extended_attribute_definitions.each do |extended_attribute_key, extended_attribute_value|
+          # Remove the extended attribute.
+          instance_definition.delete(extended_attribute_key)
+
+          # Add the extended attribute back as a standard attribute.
+          instance_definition[convert_to_standard_attribute(extended_attribute_key)] =
+            extended_attribute_context.instance_eval(extended_attribute_value)
+        end
+      end
+
+      concerning :HookMethods do
+        def extended_attribute_context
+          Time.zone
+        end
+      end
+
+      private
+
+      EXTENDED_ATTRIBUTE_SUFFIX = "_xa"
+
+      def convert_to_standard_attribute(extended_attribute_key)
+        extended_attribute_key.delete_suffix(EXTENDED_ATTRIBUTE_SUFFIX)
+      end
+
+      def extended_attribute?(extended_attribute_key)
+        extended_attribute_key.end_with?(EXTENDED_ATTRIBUTE_SUFFIX)
+      end
+
+      def keep_extended_attributes(instance_definition)
+        instance_definition.select do |extended_attribute_key, _|
+          extended_attribute?(extended_attribute_key)
+        end
+      end
+    end
+  end
+end

data/lib/tdc/extended_attributes/interpreter_base.rb

@@ -0,0 +1,9 @@
+module Tdc
+  module ExtendedAttributes
+    class InterpreterBase
+      def interpret(_instance_definition)
+        raise Tdc::MissingOverrideError, "Implement the 'keep_extended_attributes' method"
+      end
+    end
+  end
+end

data/lib/tdc/extended_attributes/interpreter_registry.rb

@@ -0,0 +1,36 @@
+module Tdc
+  module ExtendedAttributes
+    #
+    # Knows the class instances that interpret extended attribute values.
+    #
+    class InterpreterRegistry
+      include Singleton
+
+      def self.register(interpreter:)
+        instance.register_interpreter(interpreter)
+      end
+
+      def initialize
+        @interpreters = []
+      end
+
+      def interpreters
+        @interpreters.empty? ? [default_interpreter] : @interpreters
+      end
+
+      def register_interpreter(interpreter)
+        raise Tdc::FatalError, <<~MSG.chomp unless interpreter.is_a?(Tdc::ExtendedAttributes::InterpreterBase)
+          Cannot register an interpreter unless it inherits from Tdc::ExtendedAttributes::InterpreterBase
+        MSG
+
+        @interpreters << interpreter
+      end
+
+      private
+
+      def default_interpreter
+        @_default_interpreter ||= Tdc::ExtendedAttributes::DefaultInterpreter.new
+      end
+    end
+  end
+end

data/lib/tdc/generators/catalog_entries.rb

@@ -13,10 +13,14 @@ module Tdc
         to_h.empty?
       end
 
+      def first
+        to_h.first&.second
+      end
+
       def single_entry
         raise Tdc::FatalError, "There is more than one entry" if to_h.many?
 
-        to_h.first.second
+        first
       end
     end
   end

data/lib/tdc/generators/standard_generator.rb

@@ -1,11 +1,15 @@
 module Tdc
   module Generators
     #
-    # Abstract class for defining generators that define a collection of model instances.
+    # Knows how to provide a configurable instance definition.
     #
-    # See also SingularGenerator.
-    #
-    class StandardGenerator < Tdc::Generators::ConfigurableGenerator
+    class StandardGenerator < Tdc::Generators::GeneratorBase
+      include Tdc::Generators::DefinitionSourcable
+
+      attr_reader :instance_definition
+
+      source_definition_from :instance_definition
+
       def generate
         CatalogEntries.new.tap do |catalog_entries|
           instance_definitions.each do |instance_definition|
@@ -21,6 +25,43 @@ module Tdc
           end
         end
       end
+
+      def run_resolvers_and_generate_instance
+        run_extended_attribute_interpreters(instance_definition)
+        run_definition_resolvers(instance_definition)
+
+        generate_instance
+      end
+
+      #
+      # Hook method: subclasses are expected to define how to generate a model instance.
+      #
+      def generate_instance
+        raise Tdc::MissingOverrideError, "Implement the 'generate_instance' method"
+      end
+
+      #
+      # Hook method: subclasses may include the DefinitionResolvable concern to override.
+      #
+      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_extended_attribute_interpreters(instance_definition)
+        interpreters.each { |interpreter| interpreter.interpret(instance_definition) }
+      end
+
+      def interpreters
+        Tdc::ExtendedAttributes::InterpreterRegistry.instance.interpreters
+      end
     end
   end
 end

data/lib/tdc/version.rb

@@ -1,3 +1,3 @@
 module Tdc
-  VERSION = "0.3.7"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.2
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -131,11 +131,13 @@ files:
 - lib/tdc/definition_resolvers.rb
 - lib/tdc/definition_resolvers/definition_resolver.rb
 - lib/tdc/definition_resolvers/tag_resolver.rb
+- lib/tdc/extended_attributes.rb
+- lib/tdc/extended_attributes/default_interpreter.rb
+- lib/tdc/extended_attributes/interpreter_base.rb
+- lib/tdc/extended_attributes/interpreter_registry.rb
 - lib/tdc/fatal_error.rb
 - lib/tdc/generators.rb
-- lib/tdc/generators/atx_context_factory.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/generation_context.rb

data/lib/tdc/generators/atx_context_factory.rb

@@ -1,20 +0,0 @@
-module Tdc
-  module Generators
-    #
-    # Knows a class instance that supplies the instance_eval context for interpreting _atx attribute values.
-    #
-    class AtxContextFactory
-      include Singleton
-
-      attr_reader :context
-
-      def self.register(context:)
-        AtxContextFactory.instance.instance_variable_set(:@context, context)
-      end
-
-      def initialize
-        @context = Time.zone
-      end
-    end
-  end
-end

data/lib/tdc/generators/configurable_generator.rb

@@ -1,59 +0,0 @@
-module Tdc
-  module Generators
-    #
-    # Knows how to provide a configurable instance definition.
-    #
-    class ConfigurableGenerator < Tdc::Generators::GeneratorBase
-      include Tdc::Generators::DefinitionSourcable
-
-      attr_reader :instance_definition
-
-      source_definition_from :instance_definition
-
-      def run_resolvers_and_generate_instance
-        run_atx_resolvers(instance_definition)
-        run_definition_resolvers(instance_definition)
-
-        generate_instance
-      end
-
-      #
-      # Hook method: subclasses are expected to define how to generate a model instance.
-      #
-      def generate_instance
-        raise Tdc::MissingOverrideError, "Implement the 'generate_instance' method"
-      end
-
-      #
-      # Hook method: subclasses may include the DefinitionResolvable concern to override.
-      #
-      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 }
-
-        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")] = atx_context.instance_eval(v)
-        end
-      end
-
-      def atx_context
-        Tdc::Generators::AtxContextFactory.instance.context
-      end
-    end
-  end
-end