tdc 0.3.3 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e58c0fcfbfa32aa0dde6627786e39bbfaff4140d3326f144925113031163faf8
-  data.tar.gz: e9b5f186a199bd2cc3479fd9fd48087fd0f1d433006c03f2502c2cb48c6f300d
+  metadata.gz: b38de678846606fd9e8563342d256585f38ff34a0cc4f969a3e5275e8d2c4d7e
+  data.tar.gz: f6158ca091edf735897be992e53b6d106eac7d0de863725fa2fd65eab1f4ddf8
 SHA512:
-  metadata.gz: 10a3a536987b80e57169defc47b65496550fc3c9ba4fa91d9c6ec448b8debd77d24d44cf5dbe047d708979fd4d29e4b1186ef712d0cfcb0b094cd0418d6d2524
-  data.tar.gz: cfd63f4adcb438992e71a4e9ac8c20024c9b1f0d68d4a8eda5765456cb7054c602a3b7f97178f66f5c5e0876314180fd42404c7100d29382d544834e2239f010
+  metadata.gz: d88d2c5bf021d945861c2e26ebc1336fdc9ae418cd74b01ef7135f8c9edcfbf7cb29dfe9dbd99b834d7a13572338cd6bd5587bb8a08baf6e1ed39a9db3ce8691
+  data.tar.gz: e30dfc82648765df615d1853861f48c7f204aea8ae375b1fcd48127fba4853fa316c216cc41cfcb2766bd2bf9b7a4cdc83e500909a0ad6656e96237db22f1353

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,6 +6,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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::Generators::GenerationContext`
+
 ## [0.3.3] - 2020-08-04
 
 - Add the `empty?` method to `CatalogEntries`
@@ -55,5 +86,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### New Features
 
 - Avoid all PackManager dependencies
-
-

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.
 

data/lib/tdc.rb

@@ -19,6 +19,8 @@ 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"
@@ -30,7 +32,6 @@ 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

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/generators/atx_context_factory.rb

@@ -0,0 +1,20 @@
+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/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
 
@@ -44,9 +42,6 @@ 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)
@@ -55,6 +50,10 @@ module Tdc
           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

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

@@ -0,0 +1,15 @@
+module Tdc
+  module Generators
+    #
+    # Knows all the parameters that define the context for generation.
+    #
+    class GenerationContext
+      attr_reader :current_catalog, :data_definition
+
+      def initialize(current_catalog:, data_definition:)
+        @current_catalog = current_catalog
+        @data_definition = data_definition
+      end
+    end
+  end
+end

data/lib/tdc/generators/generator_base.rb

@@ -4,11 +4,13 @@ module Tdc
     # Abstract base class for all Test Data Catalog generators.
     #
     class GeneratorBase
-      attr_reader :data_definition, :current_catalog
+      attr_reader :generation_context
 
-      def initialize(data_definition, current_catalog)
-        @data_definition = data_definition
-        @current_catalog = current_catalog
+      # ARM (2020-08-05): For backwards compatibility. Consider removing.
+      delegate :current_catalog, :data_definition, to: :generation_context
+
+      def initialize(generation_context)
+        @generation_context = generation_context
       end
 
       def generate

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.3"
+  VERSION = "0.3.7"
 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.3
+  version: 0.3.7
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-04 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
@@ -133,12 +133,13 @@ files:
 - lib/tdc/definition_resolvers/tag_resolver.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
 - 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