tdc 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 523892b0a0a870a9b4c5a6abe2b7e0cac37b8dfb51249e50da32fcac29c3e6f6
-  data.tar.gz: 616521e4890e99edf594c8b6778b2f4ee7680e713077ba4cf08811b91d4adf26
+  metadata.gz: 9c04de93f4bf48d68994ce4b8adab06f21ebd2f44e3d47ce6f221400cdc8495d
+  data.tar.gz: 93a7c7a9d9dc4ea4480cc464cf6dc7c6526b6e941a68d74de956572e3fe71864
 SHA512:
-  metadata.gz: e6c1bf80620c67f96f89234a7b578c3a97d42b64a732c1048d489902206f9caa859c998c684f10ac38b87ac67a1cfe11340438708aa391c524381470737265a3
-  data.tar.gz: d1df65063610d080e53cc57f61b64bca1f48111fb99240702547f609c5f8b446b698de6d816b0f4d4e64d7c9813daad466567ee47df759e9fda497f97a8aa6a4
+  metadata.gz: 4986b573ecf8e32558cbfafddba2218a21896f7b01c6197b42bdab1b117cdee729dd3f0cc58fb8907e577223dad3fcd42890a8fedc937e1a9f4280a3be2be224
+  data.tar.gz: 25aad449a81724ff044343015835148683c540ba3080d298841152bca2b5ac79d29557f1b2de17d7e986d1556629c20a542e4360a7ece7c3c6998c3fc5971402

data/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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 ```Singular Generator```.
+
+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

@@ -3,8 +3,10 @@ require "ostruct"
 require "active_support/concern"
 require "active_support/core_ext/hash/indifferent_access"
 
+require "tdc/data_definition"
+require "tdc/data_definition_file_reader"
+require "tdc/fatal_error"
 require "tdc/in_memory_data_definition"
-require "tdc/test_data_definition_reader"
 require "tdc/version"
 require "tdc/with_indifferent_access_decorator"
 
@@ -17,14 +19,6 @@ require "tdc/generators/instance_definition_configurable"
 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
+    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/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/generator_base.rb

@@ -12,11 +12,11 @@ module Tdc
       end
 
       def generate
-        raise Tdc::MissingHookOverrideError
+        raise Tdc::MissingOverrideError
       end
 
       def instance_definitions
-        raise Tdc::MissingHookOverrideError
+        raise Tdc::MissingOverrideError
       end
     end
   end

data/lib/tdc/generators/instance_definition_configurable.rb

@@ -34,7 +34,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
       end
 
       #

data/lib/tdc/generators/singular_generator.rb

@@ -32,7 +32,7 @@ module Tdc
         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, "For the moment we only generate a single model instance"
         end
 
         # Delete the tag so that the models do not need to filter it out.

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_hook_override_error.rb → missing_override_error.rb}

@@ -1,5 +1,5 @@
 module Tdc
-  class MissingHookOverrideError < RuntimeError
+  class MissingOverrideError < Tdc::FatalError
     def initialize
       super("Must be implemented")
     end

data/lib/tdc/version.rb

@@ -1,3 +1,3 @@
 module Tdc
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Alistair McKinnell
@@ -123,8 +123,11 @@ 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/definition_resolvable.rb
@@ -134,15 +137,9 @@ files:
 - 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: []

data/lib/tdc/decorator_error.rb

@@ -1,3 +0,0 @@
-module Tdc
-  DecoratorError = Class.new(RuntimeError)
-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