tdc 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d7775cd9909b7d1aef1f59def823777cc24d6bbfc50ddfd41eda202f5f5f387
-  data.tar.gz: 11b7ddadec9d97e1953f34efdee8b66d6f0cb08213dd8d9a9e9d4ae8372687fa
+  metadata.gz: 2f0fa7ec99a40148ff1ca3fccaaa4ffeee29cc12034dc688b0957deeeb5df9a1
+  data.tar.gz: 2bcd19c81b665611f4f7abbfc8d23fb79db098b84eb837de5e6e6a67a69d7cf7
 SHA512:
-  metadata.gz: 1f396da321ee096251062cd35ff6add1d19292591dc8fa019509fe432f2fd7faea74844ee4583fbb30bc03e9f8106fbeabdb403732ec5098d70c40b69e2c216c
-  data.tar.gz: 69cfdaa1a302ae2d458f6775db22134953db4f6f584ba9af36970f4865d308de9a44d9c5c6ec10e7db0a4ec5c05d340254a4458dfc843d6676225459e2542660
+  metadata.gz: 7cc7b66e9a063bd23e6ccfc482f187b1c8b1a8b2950e16984785c2f9c5c40615e2fb0375e59afd2d374ca3d782719d5f164ac4a2d177d746f0858551b0804061
+  data.tar.gz: dd2476bd5f82a387b89353e790661263d1c28b5c65f901ec01d0f50c3efcf1e716904eacab039f2c39fd44c91f97aeb4dd386dc884a3de07029354c8549acd43

data/.rubocop.yml

@@ -10,6 +10,9 @@ AllCops:
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
 
+Metrics/LineLength:
+  Max: 120
+
 # Rubocop and I cannot agree.
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
@@ -17,6 +20,15 @@ Layout/MultilineMethodCallBraceLayout:
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
 Lint/RaiseException:
   Enabled: true
 
@@ -35,9 +47,6 @@ RSpec/AnyInstance:
 RSpec/ExampleLength:
   Max: 15
 
-Metrics/LineLength:
-  Max: 120
-
 RSpec/DescribeClass:
   Enabled: false
 
@@ -59,6 +68,15 @@ 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
@@ -66,6 +84,9 @@ Style/BlockDelimiters:
     - 'let'
     - 'subject'
 
+Style/CaseLikeIf:
+  Enabled: true
+
 Style/Documentation:
   Enabled: false
 
@@ -79,9 +100,15 @@ Style/ExponentialNotation:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/HashAsLastArrayItem:
+  Enabled: true
+
 Style/HashEachMethods:
   Enabled: true
 
+Style/HashLikeCase:
+  Enabled: true
+
 Style/HashTransformKeys:
   Enabled: true
 
@@ -93,6 +120,25 @@ Style/HashSyntax:
   Exclude:
     - 'Rakefile'
 
+# We are not going to optimize by freezing strings.
+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
@@ -108,6 +154,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,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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`
+- Evaluate `_atx` attribute values against a `Time.zone` instance
+
+## [0.3.2] - 2020-07-27
+
+- Return `self` from `DefinitionResolver#configure_current_catalog` to make it chainable
+
+## [0.3.1] - 2020-07-25
+
+- Support DefinitionResolver instance registration
+
 ## [0.3.0] - 2020-07-19
 
 - Introduce the DefinitionResolver abstraction
@@ -42,5 +70,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### New Features
 
 - Avoid all PackManager dependencies
-
-

data/lib/tdc.rb

@@ -19,6 +19,7 @@ require "tdc/with_indifferent_access_decorator"
 
 # Generators
 require "tdc/generators"
+require "tdc/generators/generation_context"
 
 # Current Catalog
 require "tdc/generators/catalog_entries"

data/lib/tdc/definition_resolvers/definition_resolver.rb

@@ -8,6 +8,8 @@ module Tdc
 
       def configure_current_catalog(current_catalog)
         @current_catalog = current_catalog
+
+        self
       end
 
       def resolve(_instance_definition)

data/lib/tdc/generators/catalog_entries.rb

@@ -8,6 +8,16 @@ module Tdc
       def add_catalog_entry(tag, entry)
         send("#{tag}=", entry)
       end
+
+      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

@@ -44,12 +44,15 @@ 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)
 
           # Add a standard _at attribute.
-          instance_definition[k.delete_suffix("x")] = eval(v) # rubocop:disable Security/Eval
+          instance_definition[k.delete_suffix("x")] = atx_context.instance_eval(v)
         end
       end
     end

data/lib/tdc/generators/definition_resolvable.rb

@@ -2,7 +2,7 @@ module Tdc
   module Generators
     #
     # Knows how to resolve attribute values in an instance definition. The attribute value will be replaced
-    # by the result of invoking the specified resolver.
+    # by the result of invoking the registered resolver.
     #
     # The resolve_tag class macro is provided for generators to define tag resolution. The test data definition
     # YAML file has attribute values than contain a catalog entry tag.
@@ -14,18 +14,9 @@ module Tdc
     #
     #   resolve_tag key: :subcomponent, source: "item_master.items"
     #
-    # The resolve_definition class macro is provided for generators to define definition resolution. The test data
-    # definition YAML file has attribute values than contain an arbitrary value that will typically be replaced by
-    # an instance of an object returned by the specified resolver.
-    #
-    # Example:
-    #
-    # Suppose a particular instance definition contained { pallet_number: P0001 } then a generator could resolve
-    # the pallet_number to a pallet instance by defining:
-    #
-    #   resolve_definition :pallet_number, to: :pallet_id, resolver: "TestDataCatalog::Resolvers::PalletNumberResolver"
-    #
-    # The PalletNumberResolver class inherits from Tdc::DefinitionResolvers::DefinitionResolver.
+    # The register_definition_resolver class macro is provided for generators to define and register their own
+    # definition resolvers. The test data  definition YAML file has attribute values than contain an arbitrary
+    # value that will typically be replaced by an instance of an object returned by the specified resolver.
     #
     module DefinitionResolvable
       extend ActiveSupport::Concern
@@ -37,14 +28,12 @@ module Tdc
       end
 
       class_methods do
-        def resolve_definition(key:, to: nil, resolver:)
-          resolver_instance = resolver.constantize.new(key: key, to: to || key)
-
+        def register_definition_resolver(resolver_instance)
           _definition_resolvers << resolver_instance
         end
 
         def resolve_tag(key:, source:)
-          _definition_resolvers << Tdc::DefinitionResolvers::TagResolver.new(key: key, source: source)
+          register_definition_resolver(Tdc::DefinitionResolvers::TagResolver.new(key: key, source: source))
         end
       end
 

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

@@ -6,24 +6,14 @@ module Tdc
     # 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))
+        configure_instance_definition(singular_instance_definition)
 
         run_resolvers_and_generate_instance
       end
 
       private
 
-      def additional_definitions
-        @additional_definitions || {}
-      end
-
       def singular_instance_definition
         all_instance_definitions = instance_definitions
 

data/lib/tdc/version.rb

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

data/tdc.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = "A simple framework for creating a Test Data Catalog"
   spec.homepage = "https://github.com/nulogy/tdc"
+  spec.license = "MIT"
 
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
@@ -31,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.82"
-  spec.add_development_dependency "rubocop-rspec", "~> 1.38"
+  spec.add_development_dependency "rubocop", "~> 0.88"
+  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.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,28 +70,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: '0.88'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: '0.88'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.38'
+        version: '1.42'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.38'
+        version: '1.42'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +137,7 @@ files:
 - 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
@@ -146,7 +147,8 @@ files:
 - lib/tdc/with_indifferent_access_decorator.rb
 - tdc.gemspec
 homepage: https://github.com/nulogy/tdc
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/nulogy/tdc
   changelog_uri: https://github.com/nulogy/tdc/blob/master/CHANGELOG.md