tdc 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b38de678846606fd9e8563342d256585f38ff34a0cc4f969a3e5275e8d2c4d7e
-  data.tar.gz: f6158ca091edf735897be992e53b6d106eac7d0de863725fa2fd65eab1f4ddf8
+  metadata.gz: 2887adedbcb323e7d03e75b65538c2afc1edbe5f4ea84c0555e50dda77bc1305
+  data.tar.gz: a8be475b6e7edcd72ab2047cab59a198e984b921d4893ca5bac25ef0476540ea
 SHA512:
-  metadata.gz: d88d2c5bf021d945861c2e26ebc1336fdc9ae418cd74b01ef7135f8c9edcfbf7cb29dfe9dbd99b834d7a13572338cd6bd5587bb8a08baf6e1ed39a9db3ce8691
-  data.tar.gz: e30dfc82648765df615d1853861f48c7f204aea8ae375b1fcd48127fba4853fa316c216cc41cfcb2766bd2bf9b7a4cdc83e500909a0ad6656e96237db22f1353
+  metadata.gz: f1aaaf060b8e5b85ab96487279471521b9a04738a63cf360473905a6834d08bfc3bd3ddef01c5b2e571736b87177b74a21ee5cba24860e56bcdb206e208e3962
+  data.tar.gz: dc9cd3002213b1b5c2f6d95f09b986249c30fe239a28e788f06462d00f496b02a3cbc707d5236bd987d44ea435e9b516adbb777f480cce24a0ca22a06b59fe52

data/CHANGELOG.md

@@ -6,15 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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,13 +30,10 @@ 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"
 
@@ -34,11 +42,6 @@ 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/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,31 @@
+module Tdc
+  module ExtendedAttributes
+    class DefaultInterpreter < Tdc::ExtendedAttributes::InterpreterBase
+      def interpret(instance_definition)
+        extended_attribute_definitions = keep_extended_attributes(instance_definition)
+
+        extended_attribute_definitions.each do |k, v|
+          # Remove the original extended attribute.
+          instance_definition.delete(k)
+
+          # Add a standard attribute.
+          instance_definition[convert_to_standard_attribute(k)] = extended_attribute_context.instance_eval(v)
+        end
+      end
+
+      concerning :HookMethods do
+        def convert_to_standard_attribute(k) # rubocop:disable Naming/MethodParameterName
+          k.delete_suffix("x")
+        end
+
+        def extended_attribute_context
+          Time.zone
+        end
+
+        def keep_extended_attributes(instance_definition)
+          instance_definition.select { |k, _v| /_(at|date|on)x$/ =~ k }
+        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,32 @@
+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 << Tdc::ExtendedAttributes::DefaultInterpreter.new if @interpreters.empty?
+
+        @interpreters
+      end
+
+      def register_interpreter(interpreter)
+        raise Tdc::FatalError, <<~MSG unless interpreter.is_a?(Tdc::ExtendedAttributes::InterpreterBase)
+          Cannot register an interpreter unless it inherits from Tdc::ExtendedAttributes::InterpreterBase
+        MSG
+
+        @interpreters << interpreter
+      end
+    end
+  end
+end

data/lib/tdc/generators/configurable_generator.rb

@@ -11,7 +11,7 @@ module Tdc
       source_definition_from :instance_definition
 
       def run_resolvers_and_generate_instance
-        run_atx_resolvers(instance_definition)
+        run_extended_attribute_interpreters(instance_definition)
         run_definition_resolvers(instance_definition)
 
         generate_instance
@@ -39,20 +39,12 @@ module Tdc
         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
+      def run_extended_attribute_interpreters(instance_definition)
+        interpreters.each { |interpreter| interpreter.interpret(instance_definition) }
       end
 
-      def atx_context
-        Tdc::Generators::AtxContextFactory.instance.context
+      def interpreters
+        Tdc::ExtendedAttributes::InterpreterRegistry.instance.interpreters
       end
     end
   end

data/lib/tdc/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Alistair McKinnell
@@ -131,9 +131,12 @@ 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

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