tdc 0.3.1 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46a2a39e062ccd48c5634a1c0f2fb07e5705268ceb930bb0dc4b41127683406b
-  data.tar.gz: 9ea9e2f9ddf8bb1696151426ab584a734544ed51c9dac67d2e153293707b522b
+  metadata.gz: afd309b8d6f641f50856a6ab71c6557dceba91c43e97c6d23a54f526cc954570
+  data.tar.gz: c730e903a12d47f4a8dc452a212ae9f38f75a4d2b61a74dd72237e69f0005d47
 SHA512:
-  metadata.gz: 15cab57dccd6be42ab9f1de3782db7df1f29c33f20196aa40ba4b7cfaf36fe4a30a84ee7d8b0b4f38dbccf6afd24b6580b21fe1c9a6afa2d78eae8852eac889c
-  data.tar.gz: e7182a480f845f3e196354c2d170df24f9a762f57db3993c9ca8e266425d01637960f588ae938484a9731e99d7b5bc9f71b1921773b6d3450f02d681515d89fd
+  metadata.gz: f699b62e54e48f3b42bb06215a8e783ca15797265292e988f70f4cbc82191aa55174ccfbcdf1bb50b58ccb1323716272d7d958283b49eac45dbb1c948208f616
+  data.tar.gz: 7496da7a34c508a1b132a5232f1c061eded18b8b5057192728be98b3faae095b3c3e1dd377b2563fde95f897861bcedb932bf867c8f20c4e3f09621af18cf52d

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
@@ -26,7 +29,6 @@ Lint/DuplicateElsifCondition:
 Lint/MixedRegexpCaptureTypes:
   Enabled: true
 
-
 Lint/RaiseException:
   Enabled: true
 
@@ -45,9 +47,6 @@ RSpec/AnyInstance:
 RSpec/ExampleLength:
   Max: 15
 
-Metrics/LineLength:
-  Max: 120
-
 RSpec/DescribeClass:
   Enabled: false
 
@@ -121,6 +120,10 @@ Style/HashSyntax:
   Exclude:
     - 'Rakefile'
 
+# We are not going to optimize by freezing strings.
+Style/MutableConstant:
+  Enabled: false
+
 Style/RedundantAssignment:
   Enabled: true
 
@@ -151,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,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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`
+- 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
@@ -46,5 +76,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,7 @@ require "tdc/with_indifferent_access_decorator"
 
 # Generators
 require "tdc/generators"
+require "tdc/generators/generation_context"
 
 # Current Catalog
 require "tdc/generators/catalog_entries"
@@ -30,7 +31,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/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/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/version.rb

@@ -1,3 +1,3 @@
 module Tdc
-  VERSION = "0.3.1"
+  VERSION = "0.3.6"
 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")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.6
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -137,8 +137,8 @@ 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
 - lib/tdc/in_memory_data_definition.rb
 - lib/tdc/missing_override_error.rb
@@ -146,7 +146,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

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