tdc 0.3.4 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf0ce48e5dd1a629ad0c5240f9c3d8c344b46cf368e01bb842eefb3454167b4e
-  data.tar.gz: a85d7fef856826f3a4a4112c4e4186c1e813f8a52de500466ba0b9acfe559fe5
+  metadata.gz: 2887adedbcb323e7d03e75b65538c2afc1edbe5f4ea84c0555e50dda77bc1305
+  data.tar.gz: a8be475b6e7edcd72ab2047cab59a198e984b921d4893ca5bac25ef0476540ea
 SHA512:
-  metadata.gz: 250b3ebace2728d87756a51f7075c3f318637997e5473bb90c4cccd820326f77ebf00429e57e885467d837b969c166b43f5044d75b028022f0dcd1464f7967bd
-  data.tar.gz: 8082f7dbdcd16c0a7cacb94af1479d0df9e4a12a83ec57556f0e6a865e18d5a5d7fa4d14cc2e3e8c3886c2ae2373bf64733e138072f262b1efc27e89ea259798
+  metadata.gz: f1aaaf060b8e5b85ab96487279471521b9a04738a63cf360473905a6834d08bfc3bd3ddef01c5b2e571736b87177b74a21ee5cba24860e56bcdb206e208e3962
+  data.tar.gz: dc9cd3002213b1b5c2f6d95f09b986249c30fe239a28e788f06462d00f496b02a3cbc707d5236bd987d44ea435e9b516adbb777f480cce24a0ca22a06b59fe52

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,56 +55,24 @@ 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:
     - 'Rakefile'
 
-Style/RedundantAssignment:
-  Enabled: true
-
-Style/RedundantFetchBlock:
-  Enabled: true
-
-Style/RedundantFileExtensionInRequire:
-  Enabled: true
-
-Style/RedundantRegexpCharacterClass:
-  Enabled: true
-
-Style/RedundantRegexpEscape:
-  Enabled: true
+# We are not going to optimize by freezing strings.
+Style/MutableConstant:
+  Enabled: false
 
 # No need to mention StandardError.
 Style/RescueStandardError:
@@ -150,6 +89,6 @@ Style/StringLiterals:
 Style/SymbolArray:
   Enabled: false
 
-# We are not going to optimize by freezing strings.
-Style/MutableConstant:
+# I prefer not to use %w or %W for an array of words.
+Style/WordArray:
   Enabled: false

data/CHANGELOG.md

@@ -6,12 +6,47 @@ 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`
+
+## [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`
+
+#### Breaking Changes
+
+- Drop the `with_definition` method from `SingularGenerator`
+
 ## [0.3.4] - 2020-08-05
 
 #### Breaking Changes
 
 - Introduce the `GenerationContext` abstraction
-- All generators are initialized with an instance of `Tdc::GenerationContext`
+- All generators are initialized with an instance of `Tdc::Generators::GenerationContext`
 
 ## [0.3.3] - 2020-08-04
 

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,18 @@ 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/catalog_entries.rb

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

data/lib/tdc/generators/configurable_generator.rb

@@ -3,8 +3,6 @@ module Tdc
     #
     # 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
 
@@ -13,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
@@ -41,19 +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 }
-
-        # 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)
+      def run_extended_attribute_interpreters(instance_definition)
+        interpreters.each { |interpreter| interpreter.interpret(instance_definition) }
+      end
 
-          # Add a standard _at attribute.
-          instance_definition[k.delete_suffix("x")] = atx_context.instance_eval(v)
-        end
+      def interpreters
+        Tdc::ExtendedAttributes::InterpreterRegistry.instance.interpreters
       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/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.4"
+  VERSION = "0.3.8"
 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.4
+  version: 0.3.8
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-08-11 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,6 +131,10 @@ 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
@@ -139,7 +143,6 @@ files:
 - 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/singular_generator.rb

@@ -1,39 +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 with_definition(additional_definitions)
-        @additional_definitions = additional_definitions.stringify_keys.reject { |_, v| v == :missing_definition }
-
-        self
-      end
-
-      def generate
-        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, "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