tdc 0.1.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 523892b0a0a870a9b4c5a6abe2b7e0cac37b8dfb51249e50da32fcac29c3e6f6
-  data.tar.gz: 616521e4890e99edf594c8b6778b2f4ee7680e713077ba4cf08811b91d4adf26
+  metadata.gz: ea6a4c15535d29f9f7ab47c6ec12f4c20cc59f588543b19869324f5901097c24
+  data.tar.gz: c5d57e1578f9550a725f20f6ef396bd2bb3d5791773929afd9c6605d8686f2b3
 SHA512:
-  metadata.gz: e6c1bf80620c67f96f89234a7b578c3a97d42b64a732c1048d489902206f9caa859c998c684f10ac38b87ac67a1cfe11340438708aa391c524381470737265a3
-  data.tar.gz: d1df65063610d080e53cc57f61b64bca1f48111fb99240702547f609c5f8b446b698de6d816b0f4d4e64d7c9813daad466567ee47df759e9fda497f97a8aa6a4
+  metadata.gz: 7829e509a7c5ef3c7db2b947ee109af96a442c662ccb15e0f5ab50a04e70f91eef039944b65a4b6dfcf9eae232e249146062067c79a2ca955cff2027b0aee649
+  data.tar.gz: 20eefb49010d15905073f5f823bdc171cc428e5c2ef1217d61ec17210d4426f4dd7de4312c56167cd4b67b37d43c2049b3cfc90b0a8b51f4577eb5c884b94841

data/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.rspec

@@ -1,3 +1,3 @@
 --format documentation
 --color
---require spec_helper
+--require tdc_spec_helper

data/.rubocop.yml

@@ -64,10 +64,14 @@ Style/BlockDelimiters:
   EnforcedStyle: line_count_based
   BracesRequiredMethods:
     - 'let'
+    - 'subject'
 
 Style/Documentation:
   Enabled: false
 
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
 Style/ExponentialNotation:
   Enabled: true
 

data/CHANGELOG.md

@@ -6,6 +6,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.4] - 2020-07-19
+
+- Improve Tdc::MissingOverrideError diagnostics
+
+## [0.2.3] - 2020-05-21
+
+- Update the diagram in the README
+
+## [0.2.2] - 2020-05-20
+
+- Adding specs
+
+## [0.2.1] - 2020-05-19
+
+- Adding specs
+
+## [0.2.0] - 2020-05-19
+
+#### Breaking Changes
+
+- Renamed TestDataDefinitionReader to DataDefinitionFileReader
+- All errors inherit from Tdc::FatalError
+
 ## [0.1.2] - 2020-05-18
 
 - Complete the extraction from PackManager

data/README.md

@@ -1,2 +1,13 @@
-# TDC: Test Data Catalog
+# TDC: Test Data Catalog Generation
 
+![TDC Framelet](/images/Tdc.png)
+
+**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.
+
+During generation the test data catalog will be represented by ```CatalogEntries``` that are populated by reading from ```YAML``` files with a ```DataDefinitionReader``` or provided directly by an ```InMemoryDataDefinition```.
+
+**Data Definition DSL**
+
+```DefinitionResolvable``` and ```DefinitionSourcable``` provide a DSL that you may use in your generators to work more easily with a ```DataDefinition```.

data/lib/tdc.rb

@@ -1,30 +1,38 @@
 require "ostruct"
+require "yaml"
 
+require "active_support"
 require "active_support/concern"
-require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext"
 
-require "tdc/in_memory_data_definition"
-require "tdc/test_data_definition_reader"
 require "tdc/version"
+
+# Errors
+require "tdc/fatal_error"
+require "tdc/missing_override_error"
+
+# Data Definition Hierarchy
+require "tdc/data_definition"
+require "tdc/data_definition_file_reader"
+require "tdc/in_memory_data_definition"
 require "tdc/with_indifferent_access_decorator"
 
+# Generators
 require "tdc/generators"
+
+# Current Catalog
 require "tdc/generators/catalog_entries"
+
+# Concerns
 require "tdc/generators/definition_resolvable"
 require "tdc/generators/definition_sourcable"
+
+# Generator Hierarchy
 require "tdc/generators/generator_base"
-require "tdc/generators/instance_definition_configurable"
+require "tdc/generators/configurable_generator"
 require "tdc/generators/singular_generator"
 require "tdc/generators/standard_generator"
 
-require "tdc/decorator_error"
-require "tdc/missing_hook_override_error"
-require "tdc/missing_path_elements_error"
-require "tdc/missing_test_data_definition_error"
-require "tdc/non_singular_instance_error"
-require "tdc/unresolvable_tag_error"
-require "tdc/yaml_load_error"
-
 #
 # A framework for building a Test Data Catalog
 #

data/lib/tdc/data_definition.rb

@@ -0,0 +1,14 @@
+module Tdc
+  #
+  # Knows how to read data definitions from the specified path elements.
+  #
+  class DataDefinition
+    def read(*_path_elements)
+      raise MissingOverrideError, "Implement the 'read' method"
+    end
+
+    def with_indifferent_access
+      self.extend(Tdc::WithIndifferentAccessDecorator) # rubocop:disable Style/RedundantSelf
+    end
+  end
+end

data/lib/tdc/{test_data_definition_reader.rb → data_definition_file_reader.rb}

@@ -1,8 +1,8 @@
 module Tdc
   #
-  # Knows how to read test data definitions from YAML files.
+  # Knows how to read data definitions from YAML files.
   #
-  class TestDataDefinitionReader
+  class DataDefinitionFileReader < Tdc::DataDefinition
     EMPTY_DEFINITIONS = []
 
     def initialize(catalog_root_directory)
@@ -13,10 +13,6 @@ module Tdc
       data_definition_from(definitions_file(path_elements))
     end
 
-    def with_indifferent_access
-      self.extend(Tdc::WithIndifferentAccessDecorator) # rubocop:disable Style/RedundantSelf
-    end
-
     private
 
     def definitions_file(path_elements)
@@ -38,7 +34,7 @@ module Tdc
     def load_yaml(definitions_file)
       YAML.load(expand_erb(definitions_file)) # rubocop:disable Security/YAMLLoad
     rescue => e
-      raise Tdc::YamlLoadError, <<~MSG
+      raise Tdc::FatalError, <<~MSG
         Unable to load YAML from #{definitions_file}
         Cause: #{e.message}"
       MSG
@@ -51,7 +47,7 @@ module Tdc
     def missing_data_definition(definitions_file)
       return EMPTY_DEFINITIONS if ENV.key?("TDC_IGNORE_MISSING_TEST_DATA_DEFINITION_ERROR")
 
-      raise MissingTestDataDefinitionError, definitions_file
+      raise Tdc::FatalError, "Missing test definitions file: '#{definitions_file}'"
     end
   end
 end

data/lib/tdc/fatal_error.rb

@@ -0,0 +1,7 @@
+module Tdc
+  class FatalError < RuntimeError
+    def initialize(msg = nil)
+      super
+    end
+  end
+end

data/lib/tdc/generators/{instance_definition_configurable.rb → configurable_generator.rb}

@@ -5,23 +5,12 @@ module Tdc
     #
     # Shared implementation between the StandardGenerator and the SingularGenerator abstract classes.
     #
-    module InstanceDefinitionConfigurable
-      extend ActiveSupport::Concern
+    class ConfigurableGenerator < Tdc::Generators::GeneratorBase
+      include Tdc::Generators::DefinitionSourcable
 
-      included do
-        include Tdc::Generators::DefinitionSourcable
+      attr_reader :instance_definition
 
-        attr_reader :instance_definition
-
-        source_definition_from :instance_definition
-      end
-
-      private
-
-      def configure_instance_definition(instance_definition)
-        @instance_definition = instance_definition
-        configure_definition_source(instance_definition)
-      end
+      source_definition_from :instance_definition
 
       def run_resolvers_and_generate_instance
         run_atx_resolvers(instance_definition)
@@ -34,7 +23,7 @@ module Tdc
       # Hook method: subclasses are expected to define how to generate a model instance.
       #
       def generate_instance
-        raise Tdc::MissingHookOverrideError
+        raise Tdc::MissingOverrideError, "Implement the 'generate_instance' method"
       end
 
       #
@@ -44,6 +33,14 @@ module Tdc
         # Do nothing
       end
 
+      private
+
+      def configure_instance_definition(instance_definition)
+        @instance_definition = instance_definition
+
+        configure_definition_source(instance_definition)
+      end
+
       def run_atx_resolvers(instance_definition)
         atx_definitions = instance_definition.select { |k, _v| /_atx$/ =~ k }
 

data/lib/tdc/generators/definition_resolvable.rb

@@ -51,7 +51,7 @@ module Tdc
         unless sourced_object
           message = "Could not find a tag reference for '#{key}' in the catalog entries provided."
 
-          raise Tdc::UnresolvableTagError, message
+          raise Tdc::FatalError, message
         end
 
         # Replace the tag value with the sourced object.

data/lib/tdc/generators/definition_sourcable.rb

@@ -35,13 +35,13 @@ module Tdc
       def method_missing(method, *args)
         key = transform_method_to_definition_source_key(method)
 
-        definition_source.key?(key) ? definition_source.fetch(key) : super
+        definition_source&.key?(key) ? definition_source.fetch(key) : super
       end
 
       def respond_to_missing?(method, include_all = false)
         key = transform_method_to_definition_source_key(method)
 
-        definition_source.key?(key) ? true : super
+        definition_source&.key?(key) ? true : super
       end
 
       def transform_method_to_definition_source_key(method)

data/lib/tdc/generators/generator_base.rb

@@ -12,11 +12,11 @@ module Tdc
       end
 
       def generate
-        raise Tdc::MissingHookOverrideError
+        raise Tdc::MissingOverrideError, "Implement the 'generate' method"
       end
 
       def instance_definitions
-        raise Tdc::MissingHookOverrideError
+        raise Tdc::MissingOverrideError, "Implement the 'instance_definitions' method"
       end
     end
   end

data/lib/tdc/generators/singular_generator.rb

@@ -5,15 +5,7 @@ module Tdc
     #
     # See also StandardGenerator.
     #
-    class SingularGenerator < Tdc::Generators::GeneratorBase
-      include Tdc::Generators::InstanceDefinitionConfigurable
-
-      def initialize(data_definition, current_catalog)
-        super
-
-        @additional_definitions = {}
-      end
-
+    class SingularGenerator < Tdc::Generators::ConfigurableGenerator
       def with_definition(additional_definitions)
         @additional_definitions = additional_definitions.stringify_keys.reject { |_, v| v == :missing_definition }
 
@@ -21,18 +13,22 @@ module Tdc
       end
 
       def generate
-        configure_instance_definition(singular_instance_definition.merge(@additional_definitions))
+        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::NonSingularInstanceError, "For the moment we only generate a single model instance"
+          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.

data/lib/tdc/generators/standard_generator.rb

@@ -5,9 +5,7 @@ module Tdc
     #
     # See also SingularGenerator.
     #
-    class StandardGenerator < Tdc::Generators::GeneratorBase
-      include Tdc::Generators::InstanceDefinitionConfigurable
-
+    class StandardGenerator < Tdc::Generators::ConfigurableGenerator
       def generate
         CatalogEntries.new.tap do |catalog_entries|
           instance_definitions.each do |instance_definition|

data/lib/tdc/in_memory_data_definition.rb

@@ -1,24 +1,20 @@
 module Tdc
   #
-  # Knows how to read test data definitions from an in-memory representation.
+  # Knows how to read data definitions from an in-memory representation.
   #
-  class InMemoryDataDefinition
+  class InMemoryDataDefinition < Tdc::DataDefinition
     def initialize(path_elements_data = {})
       @store = path_elements_data
     end
 
-    def store(path_elements, data)
-      @store[path_elements] = data
-    end
-
     def read(*path_elements)
       @store.fetch(path_elements) do
-        raise MissingPathElementsError, "The path did not have any data associated with it: #{path_elements.inspect}"
+        raise Tdc::FatalError, "The path did not have any data associated with it: #{path_elements.inspect}"
       end
     end
 
-    def with_indifferent_access
-      self.extend(Tdc::WithIndifferentAccessDecorator) # rubocop:disable Style/RedundantSelf
+    def store(path_elements, data)
+      @store[path_elements] = data
     end
   end
 end

data/lib/tdc/missing_override_error.rb

@@ -0,0 +1,3 @@
+module Tdc
+  MissingOverrideError = Class.new(Tdc::FatalError)
+end

data/lib/tdc/version.rb

@@ -1,3 +1,3 @@
 module Tdc
-  VERSION = "0.1.2"
+  VERSION = "0.2.4"
 end

data/lib/tdc/with_indifferent_access_decorator.rb

@@ -7,7 +7,7 @@ module Tdc
     def read(*path_elements)
       definitions = super
 
-      raise DecoratorError, "Use 'with_indifferent_access' only for an Array" unless definitions.is_a?(Array)
+      raise Tdc::FatalError, "Use 'with_indifferent_access' only for an Array" unless definitions.is_a?(Array)
 
       definitions.map do |definition|
         definition.is_a?(Hash) ? ActiveSupport::HashWithIndifferentAccess.new(definition) : definition

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,6 +113,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -123,26 +124,23 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- images/Tdc.png
 - lib/tdc.rb
-- lib/tdc/decorator_error.rb
+- lib/tdc/data_definition.rb
+- lib/tdc/data_definition_file_reader.rb
+- lib/tdc/fatal_error.rb
 - lib/tdc/generators.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/generator_base.rb
-- lib/tdc/generators/instance_definition_configurable.rb
 - lib/tdc/generators/singular_generator.rb
 - lib/tdc/generators/standard_generator.rb
 - lib/tdc/in_memory_data_definition.rb
-- lib/tdc/missing_hook_override_error.rb
-- lib/tdc/missing_path_elements_error.rb
-- lib/tdc/missing_test_data_definition_error.rb
-- lib/tdc/non_singular_instance_error.rb
-- lib/tdc/test_data_definition_reader.rb
-- lib/tdc/unresolvable_tag_error.rb
+- lib/tdc/missing_override_error.rb
 - lib/tdc/version.rb
 - lib/tdc/with_indifferent_access_decorator.rb
-- lib/tdc/yaml_load_error.rb
 - tdc.gemspec
 homepage: https://github.com/nulogy/tdc
 licenses: []
@@ -166,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A simple framework for creating a Test Data Catalog

data/lib/tdc/decorator_error.rb

@@ -1,3 +0,0 @@
-module Tdc
-  DecoratorError = Class.new(RuntimeError)
-end

data/lib/tdc/missing_hook_override_error.rb

@@ -1,7 +0,0 @@
-module Tdc
-  class MissingHookOverrideError < RuntimeError
-    def initialize
-      super("Must be implemented")
-    end
-  end
-end

data/lib/tdc/missing_path_elements_error.rb

@@ -1,3 +0,0 @@
-module Tdc
-  MissingPathElementsError = Class.new(RuntimeError)
-end

data/lib/tdc/missing_test_data_definition_error.rb

@@ -1,3 +0,0 @@
-module Tdc
-  MissingTestDataDefinitionError = Class.new(RuntimeError)
-end

data/lib/tdc/non_singular_instance_error.rb

@@ -1,3 +0,0 @@
-module Tdc
-  NonSingularInstanceError = Class.new(RuntimeError)
-end

data/lib/tdc/unresolvable_tag_error.rb

@@ -1,3 +0,0 @@
-module Tdc
-  UnresolvableTagError = Class.new(RuntimeError)
-end

data/lib/tdc/yaml_load_error.rb

@@ -1,3 +0,0 @@
-module Tdc
-  YamlLoadError = Class.new(RuntimeError)
-end