tdc 0.3.2 → 0.3.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d440b515dda7b3c95c5ddabd279894b4bd6c93ac81a17c47fe0191d25fb72391
-  data.tar.gz: 6878b050a7fc779362fe8b7f3d95e1e0337742e060df42899827a2743290a174
+  metadata.gz: 4a9bab09cb1cb215daa94f3e53b950fd09f1baa059a3c6c8cddf47abd3fd95a7
+  data.tar.gz: 2bfccac38422fc897d0c2208e0d5853f0a4adf13074c9da93262476d09007cf1
 SHA512:
-  metadata.gz: 9a54735b2c05f8cbacee18ba4ea5721a0ebeb2be1c8dca6020384ff6088255333f1e2ff1ec708f9446036c851bb55c3b2ad23e528c7c5e79ca5199272bd1e625
-  data.tar.gz: 487e92c5064480bfe3f2a00a98b1e3e427d15ba3d53619b8e2f96275d7279a1f1b74cbf4c867060f466fbfdc018b9d8d15f85700e6f1b0dbca861c0eaf92fad0
+  metadata.gz: 41e0866b7801d672791f6ea28d6878072f009aa31281d06889a2782c38464d79e2e2f3fd175d45cc9dbe9867491e07811fc58d1dffa0c1a1cd3c37d15f77c004
+  data.tar.gz: 63588b60c890b674dd4541e10b848f97108d7244f63cce86fcbb26f7daf5b25689791f436fa10aa3545604cfdbca1422d1c61cf90d4cff7804ec726b1c50aec0

data/.rubocop.yml

@@ -2,37 +2,19 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  NewCops: enable
+  TargetRubyVersion: 2.6
 
   Exclude:
     - 'bin/**/*'
 
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
+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
 
@@ -45,9 +27,6 @@ RSpec/AnyInstance:
 RSpec/ExampleLength:
   Max: 15
 
-Metrics/LineLength:
-  Max: 120
-
 RSpec/DescribeClass:
   Enabled: false
 
@@ -69,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
@@ -85,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:
@@ -151,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,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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`
+- 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
@@ -50,5 +80,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,16 @@
+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 initialize
+        @context = Time.zone
+      end
+    end
+  end
+end

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

@@ -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
 
@@ -49,9 +47,13 @@ module Tdc
           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
+
+      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.2"
+  VERSION = "0.3.6.1"
 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.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.2
+  version: 0.3.6.1
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-08-10 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
@@ -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

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