tdc 0.3.5 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f0fa7ec99a40148ff1ca3fccaaa4ffeee29cc12034dc688b0957deeeb5df9a1
-  data.tar.gz: 2bcd19c81b665611f4f7abbfc8d23fb79db098b84eb837de5e6e6a67a69d7cf7
+  metadata.gz: 40158a1118d92cb453c0197da1eea7850c19ba2bba98306806bf920f167d16b8
+  data.tar.gz: '09f31030294fadabb38f88c6976d56774670b636ec43bb2ae4d62a96ad234087'
 SHA512:
-  metadata.gz: 7cc7b66e9a063bd23e6ccfc482f187b1c8b1a8b2950e16984785c2f9c5c40615e2fb0375e59afd2d374ca3d782719d5f164ac4a2d177d746f0858551b0804061
-  data.tar.gz: dd2476bd5f82a387b89353e790661263d1c28b5c65f901ec01d0f50c3efcf1e716904eacab039f2c39fd44c91f97aeb4dd386dc884a3de07029354c8549acd43
+  metadata.gz: 40758219403185741dbc04f645f5f7d19a07ff004514cf5c5d9c7a4312085d4918d8d2694204c643bcb97f808c8c958b002b7c2e684748d8d1621e1b9f49f182
+  data.tar.gz: 41777ff45589fc3de09026e86e0e26220cd863a95861fd866a337f53b23ec0211f4d4ced7d0feac6cabbf563175f6b6234888b441c80d30bd848bad2f42cef16

data/.rubocop.yml

@@ -2,39 +2,19 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  NewCops: enable
+  TargetRubyVersion: 2.6
 
   Exclude:
     - 'bin/**/*'
 
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 # Rubocop and I cannot agree.
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
 
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-
-Lint/DuplicateElsifCondition:
-  Enabled: true
-
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
 Metrics/BlockLength:
   Enabled: false
 
@@ -68,15 +48,6 @@ 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
@@ -84,37 +55,16 @@ Style/BlockDelimiters:
     - 'let'
     - 'subject'
 
-Style/CaseLikeIf:
-  Enabled: true
-
 Style/Documentation:
   Enabled: false
 
 Style/EmptyMethod:
   EnforcedStyle: expanded
 
-Style/ExponentialNotation:
-  Enabled: true
-
 # We can ignore this small performance improvement.
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-Style/HashAsLastArrayItem:
-  Enabled: true
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashLikeCase:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
 # We like to use the hash rocket in rake files.
 Style/HashSyntax:
   Exclude:
@@ -124,21 +74,6 @@ Style/HashSyntax:
 Style/MutableConstant:
   Enabled: false
 
-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,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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`
+
+## [0.3.6.1] - 2020-08-10
+
+- Add the `AtxContextFactory` abstraction
+
+## [0.3.6] - 2020-08-06
+
+#### Breaking Changes
+
+- Drop the `SingularGenerator` abstraction
+
 ## [0.3.5] - 2020-08-06
 
 - Add the `single_entry` method to `CatalogEntries`

data/README.md

@@ -4,7 +4,7 @@
 
 **Extension Points**
 
-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 test data generators by inheriting from ```StandardGenerator```. Best practice is to define an ```ApplicationStandardGenerator``` and have all other generators inherit from it.
 
 Define your own definition resolvers by inheriting from ```DefinitionResolver```. Best practice is to define an ```ApplicationDefinitionResolver``` and all other definition resolvers inherit from it.
 
@@ -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/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/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_file_reader.rb

@@ -6,6 +6,8 @@ module Tdc
     EMPTY_DEFINITIONS = []
 
     def initialize(catalog_root_directory)
+      super()
+
       @catalog_root_directory = catalog_root_directory
     end
 

data/lib/tdc/definition_resolvers/tag_resolver.rb

@@ -8,6 +8,8 @@ module Tdc
       attr_reader :key, :source
 
       def initialize(key:, source:)
+        super()
+
         @key = key
         @source = source
       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,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/definition_sourcable.rb

@@ -38,7 +38,7 @@ module Tdc
         definition_source&.key?(key) ? definition_source.fetch(key) : super
       end
 
-      def respond_to_missing?(method, include_all = false)
+      def respond_to_missing?(method, include_all = false) # rubocop:disable Style/OptionalBooleanParameter
         key = transform_method_to_definition_source_key(method)
 
         definition_source&.key?(key) ? true : super

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/in_memory_data_definition.rb

@@ -4,6 +4,8 @@ module Tdc
   #
   class InMemoryDataDefinition < Tdc::DataDefinition
     def initialize(path_elements_data = {})
+      super()
+
       @store = path_elements_data
     end
 

data/lib/tdc/version.rb

@@ -1,3 +1,3 @@
 module Tdc
-  VERSION = "0.3.5"
+  VERSION = "0.3.9"
 end

data/tdc.gemspec

@@ -32,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.88"
+  spec.add_development_dependency "rubocop", "~> 0.89"
   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.3.5
+  version: 0.3.9
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-07 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.88'
+        version: '0.89'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.88'
+        version: '0.89'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -131,15 +131,17 @@ 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/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
 - lib/tdc/generators/generator_base.rb
-- lib/tdc/generators/singular_generator.rb
 - lib/tdc/generators/standard_generator.rb
 - lib/tdc/in_memory_data_definition.rb
 - lib/tdc/missing_override_error.rb

data/lib/tdc/generators/configurable_generator.rb

@@ -1,60 +0,0 @@
-module Tdc
-  module Generators
-    #
-    # Knows how to provide a configurable instance definition.
-    #
-    # Shared implementation between the StandardGenerator and the SingularGenerator abstract classes.
-    #
-    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 }
-
-        # 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")] = atx_context.instance_eval(v)
-        end
-      end
-    end
-  end
-end

data/lib/tdc/generators/singular_generator.rb

@@ -1,29 +0,0 @@
-module Tdc
-  module Generators
-    #
-    # Abstract class for defining generators that define a single model instance.
-    #
-    # See also StandardGenerator.
-    #
-    class SingularGenerator < Tdc::Generators::ConfigurableGenerator
-      def generate
-        configure_instance_definition(singular_instance_definition)
-
-        run_resolvers_and_generate_instance
-      end
-
-      private
-
-      def singular_instance_definition
-        all_instance_definitions = instance_definitions
-
-        if all_instance_definitions.many?
-          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.
-        all_instance_definitions.first.except("tag")
-      end
-    end
-  end
-end