tdc 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a574acff7829e69b0f0921e3057ed00ccbf149aa6bc23e77585de0c4372183af
-  data.tar.gz: b8242f2461ab9eab727e3aca43de8b7ad4f31b45435ce67a4e8cd868893263d4
+  metadata.gz: 9afbee316bed8c63956e2a3f1626e376101940ecbb83e45fc6f7dd699d626df4
+  data.tar.gz: c4f164c51b6421490d157cbf4761ad4d9e634af72a6a52a6bce0443cfd4b32a9
 SHA512:
-  metadata.gz: 5bfe223f7dbbe91f3b92e0d6582d0964a5a1f309190a3f787dde1c6c7132678f2c3f1d0c0faf442231a6c1462ee43941dd1b03460dd0d5f5135612998df0a59b
-  data.tar.gz: 056c5002c9fbc2cd94ec5a9de9a06d229a271867a915a486abc316c245499ae8c3f069ef8a1bfb14c10d895b9e2af3b5a5035b8af086c5d3187a3bf7592829a5
+  metadata.gz: fd3f18ae6079f57dce2faa700c27ec64c86f266eb54820a2952beeeefcf3d4e8bcb0a785e69b02b222bcfa29f56ad5484c888dcea3d8d74e58610435ac4273e0
+  data.tar.gz: 219c4136fc7dc4717e9c83849d7318cbe05751b661dd9d95bbbaa2cc5a621188a44b13b7e2624c9c80c4126e34ced7274673dabe0af6e62488977cefa26e29ac

data/.rubocop.yml

@@ -15,12 +15,20 @@ Layout/LineLength:
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
 
+# Revisit. Seems a little harsh.
+Lint/MissingSuper:
+  Enabled: false
+
 Metrics/BlockLength:
   Enabled: false
 
 Naming/MemoizedInstanceVariableName:
   EnforcedStyleForLeadingUnderscores: required
 
+Naming/VariableNumber:
+  Enabled: true
+  EnforcedStyle: snake_case
+
 RSpec/AnyInstance:
   Enabled: false
 

data/CHANGELOG.md

@@ -6,6 +6,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.4] - 2020-08-25
+
+#### Breaking Changes
+
+- Enable ERB expansion of the YAML source with a `.yam.erb` filename suffix. 
+
+## [0.4.3] - 2020-08-25
+
+#### New Features
+
+- Support optional definitions 
+
+## [0.4.2] - 2020-08-22
+
+#### Breaking Changes
+
+- Extended attributes use `_xa` suffix
+
+## [0.4.1] - 2020-08-22
+
+- Add the `first` method to `CatalogEntries`
+
 ## [0.4.0] - 2020-08-14
 
 #### New Features

data/lib/tdc.rb

@@ -41,6 +41,14 @@ require "tdc/generators/definition_sourcable"
 require "tdc/generators/generator_base"
 require "tdc/generators/standard_generator"
 
+# YAML Readers
+require "tdc/yaml_readers"
+require "tdc/yaml_readers/null_yaml_reader"
+require "tdc/yaml_readers/yaml_reader_base"
+require "tdc/yaml_readers/yaml_reader"
+require "tdc/yaml_readers/yaml_reader_with_expansion"
+require "tdc/yaml_readers/yaml_reader_factory"
+
 #
 # A framework for building a Test Data Catalog
 #

data/lib/tdc/data_definition_file_reader.rb

@@ -6,44 +6,13 @@ module Tdc
     EMPTY_DEFINITIONS = []
 
     def initialize(catalog_root_directory)
-      super()
-
       @catalog_root_directory = catalog_root_directory
     end
 
     def read(*path_elements)
-      data_definition_from(definitions_file(path_elements))
-    end
-
-    private
-
-    def definitions_file(path_elements)
-      fully_qualified_path_elements = [@catalog_root_directory].concat(path_elements.map(&:to_s))
-
-      fully_qualified_path_elements.last.concat(".yml")
-
-      File.join(*fully_qualified_path_elements)
-    end
-
-    def data_definition_from(definitions_file)
-      if File.exist?(definitions_file)
-        load_yaml(definitions_file) || EMPTY_DEFINITIONS
-      else
-        EMPTY_DEFINITIONS
-      end
-    end
-
-    def load_yaml(definitions_file)
-      YAML.load(expand_erb(definitions_file)) # rubocop:disable Security/YAMLLoad
-    rescue => e
-      raise Tdc::FatalError, <<~MSG
-        Unable to load YAML from #{definitions_file}
-        Cause: #{e.message}"
-      MSG
-    end
+      reader = Tdc::YamlReaders::YamlReaderFactory.new(@catalog_root_directory, path_elements).create
 
-    def expand_erb(definitions_file)
-      ERB.new(File.read(definitions_file)).result
+      reader.data_definitions
     end
   end
 end

data/lib/tdc/definition_resolvers/tag_resolver.rb

@@ -8,8 +8,6 @@ module Tdc
       attr_reader :key, :source
 
       def initialize(key:, source:)
-        super()
-
         @key = key
         @source = source
       end

data/lib/tdc/extended_attributes/default_interpreter.rb

@@ -1,29 +1,45 @@
 module Tdc
   module ExtendedAttributes
+    #
+    # Know how on interpret extended attributes.
+    #
+    # Note: extended attribute keys are expected to be strings rather than symbols.
+    #
     class DefaultInterpreter < Tdc::ExtendedAttributes::InterpreterBase
       def interpret(instance_definition)
         extended_attribute_definitions = keep_extended_attributes(instance_definition)
 
-        extended_attribute_definitions.each do |k, v|
-          # Remove the original extended attribute.
-          instance_definition.delete(k)
+        extended_attribute_definitions.each do |extended_attribute_key, extended_attribute_value|
+          # Remove the extended attribute.
+          instance_definition.delete(extended_attribute_key)
 
-          # Add a standard attribute.
-          instance_definition[convert_to_standard_attribute(k)] = extended_attribute_context.instance_eval(v)
+          # Add the extended attribute back as a standard attribute.
+          instance_definition[convert_to_standard_attribute(extended_attribute_key)] =
+            extended_attribute_context.instance_eval(extended_attribute_value)
         end
       end
 
       concerning :HookMethods do
-        def convert_to_standard_attribute(k) # rubocop:disable Naming/MethodParameterName
-          k.delete_suffix("x")
-        end
-
         def extended_attribute_context
           Time.zone
         end
+      end
+
+      private
+
+      EXTENDED_ATTRIBUTE_SUFFIX = "_xa"
+
+      def convert_to_standard_attribute(extended_attribute_key)
+        extended_attribute_key.delete_suffix(EXTENDED_ATTRIBUTE_SUFFIX)
+      end
+
+      def extended_attribute?(extended_attribute_key)
+        extended_attribute_key.end_with?(EXTENDED_ATTRIBUTE_SUFFIX)
+      end
 
-        def keep_extended_attributes(instance_definition)
-          instance_definition.select { |k, _v| /_(at|date|on)x$/ =~ k }
+      def keep_extended_attributes(instance_definition)
+        instance_definition.select do |extended_attribute_key, _|
+          extended_attribute?(extended_attribute_key)
         end
       end
     end

data/lib/tdc/extended_attributes/interpreter_registry.rb

@@ -15,18 +15,22 @@ module Tdc
       end
 
       def interpreters
-        @interpreters << Tdc::ExtendedAttributes::DefaultInterpreter.new if @interpreters.empty?
-
-        @interpreters
+        @interpreters.empty? ? [default_interpreter] : @interpreters
       end
 
       def register_interpreter(interpreter)
-        raise Tdc::FatalError, <<~MSG unless interpreter.is_a?(Tdc::ExtendedAttributes::InterpreterBase)
+        raise Tdc::FatalError, <<~MSG.chomp unless interpreter.is_a?(Tdc::ExtendedAttributes::InterpreterBase)
           Cannot register an interpreter unless it inherits from Tdc::ExtendedAttributes::InterpreterBase
         MSG
 
         @interpreters << interpreter
       end
+
+      private
+
+      def default_interpreter
+        @_default_interpreter ||= Tdc::ExtendedAttributes::DefaultInterpreter.new
+      end
     end
   end
 end

data/lib/tdc/generators/catalog_entries.rb

@@ -13,10 +13,14 @@ module Tdc
         to_h.empty?
       end
 
+      def first
+        to_h.first&.second
+      end
+
       def single_entry
         raise Tdc::FatalError, "There is more than one entry" if to_h.many?
 
-        to_h.first.second
+        first
       end
     end
   end

data/lib/tdc/generators/definition_sourcable.rb

@@ -3,7 +3,10 @@ module Tdc
     #
     # Creates ghost methods for use in generators.
     #
-    # All ghost methods are named 'key'_definition where 'key' is a key into the instance_definition hash.
+    # All ghost methods are named 'key'_definition or 'key'_definition_optional where 'key' is
+    # a key into the instance_definition hash.
+    #
+    # Choose optional if the key may not be present in the instance_definition.
     #
     # Example:
     #
@@ -11,6 +14,7 @@ module Tdc
     # ghost methods could be used to refer to the value associated with those keys:
     #
     #  line_definition
+    #  line_definition_optional
     #  replenishment_parameters_definition
     #
     module DefinitionSourcable
@@ -33,19 +37,25 @@ module Tdc
       private
 
       def method_missing(method, *args)
-        key = transform_method_to_definition_source_key(method)
-
-        definition_source&.key?(key) ? definition_source.fetch(key) : super
+        if ghost_definition?(method)
+          definition_source.fetch(method.to_s.gsub(/_definition$/, ""))
+        elsif ghost_optional_definition?(method)
+          definition_source[method.to_s.gsub(/_definition_optional$/, "")]
+        else
+          super
+        end
       end
 
       def respond_to_missing?(method, include_all = false) # rubocop:disable Style/OptionalBooleanParameter
-        key = transform_method_to_definition_source_key(method)
+        ghost_definition?(method) || ghost_optional_definition?(method) ? true : super
+      end
 
-        definition_source&.key?(key) ? true : super
+      def ghost_definition?(method)
+        method.to_s.end_with?("_definition")
       end
 
-      def transform_method_to_definition_source_key(method)
-        method.to_s.gsub(/_definition$/, "")
+      def ghost_optional_definition?(method)
+        method.to_s.end_with?("_definition_optional")
       end
     end
   end

data/lib/tdc/in_memory_data_definition.rb

@@ -4,8 +4,6 @@ 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.4.0"
+  VERSION = "0.4.4"
 end

data/lib/tdc/yaml_readers.rb

@@ -0,0 +1,7 @@
+module Tdc
+  #
+  # Namespace to host YAML readers.
+  #
+  module YamlReaders
+  end
+end

data/lib/tdc/yaml_readers/null_yaml_reader.rb

@@ -0,0 +1,12 @@
+module Tdc
+  module YamlReaders
+    #
+    # When we can't find a YAML source.
+    #
+    class NullYamlReader
+      def data_definitions
+        []
+      end
+    end
+  end
+end

data/lib/tdc/yaml_readers/yaml_reader.rb

@@ -0,0 +1,16 @@
+module Tdc
+  module YamlReaders
+    #
+    # YAML source is a YAML file.
+    #
+    class YamlReader < Tdc::YamlReaders::YamlReaderBase
+      def file_extension
+        ".yml"
+      end
+
+      def source_string
+        File.read(definitions_file)
+      end
+    end
+  end
+end

data/lib/tdc/yaml_readers/yaml_reader_base.rb

@@ -0,0 +1,52 @@
+module Tdc
+  module YamlReaders
+    #
+    # YAML source.
+    #
+    class YamlReaderBase
+      def initialize(catalog_root_directory, path_elements)
+        @catalog_root_directory = catalog_root_directory
+        @path_elements = path_elements
+      end
+
+      def applies?
+        File.exist?(definitions_file)
+      end
+
+      def data_definitions
+        definitions_source
+      end
+
+      def definitions_source
+        source_string.empty? ? [] : YAML.load(source_string) # rubocop:disable Security/YAMLLoad
+      rescue => e
+        raise Tdc::FatalError, <<~MSG
+          Unable to load YAML from #{definitions_file}
+          Cause: #{e.message}"
+        MSG
+      end
+
+      concerning :HookMethods do
+        def file_extension
+          raise MissingOverrideError, "Implement the 'file_extension' method"
+        end
+
+        def source_string
+          raise MissingOverrideError, "Implement the 'source_string' method"
+        end
+      end
+
+      private
+
+      def definitions_file
+        @_definitions_file ||= begin
+          fully_qualified_path_elements = [@catalog_root_directory].concat(@path_elements.map(&:to_s))
+
+          fully_qualified_path_elements.last.concat(file_extension)
+
+          File.join(*fully_qualified_path_elements)
+        end
+      end
+    end
+  end
+end

data/lib/tdc/yaml_readers/yaml_reader_factory.rb

@@ -0,0 +1,38 @@
+module Tdc
+  module YamlReaders
+    #
+    # Knows how to create the appropriate YAML reader.
+    #
+    class YamlReaderFactory
+      def initialize(catalog_root_directory, path_elements)
+        @catalog_root_directory = catalog_root_directory
+        @path_elements = path_elements
+      end
+
+      def create
+        if yaml_reader_with_expansion.applies?
+          yaml_reader_with_expansion
+        elsif yaml_reader.applies?
+          yaml_reader
+        else
+          null_reader
+        end
+      end
+
+      private
+
+      def yaml_reader_with_expansion
+        @_yaml_reader_with_expansion ||=
+          Tdc::YamlReaders::YamlReaderWithExpansion.new(@catalog_root_directory, @path_elements)
+      end
+
+      def null_reader
+        @_null_reader ||= Tdc::YamlReaders::NullYamlReader.new
+      end
+
+      def yaml_reader
+        @_yaml_reader ||= Tdc::YamlReaders::YamlReader.new(@catalog_root_directory, @path_elements)
+      end
+    end
+  end
+end

data/lib/tdc/yaml_readers/yaml_reader_with_expansion.rb

@@ -0,0 +1,16 @@
+module Tdc
+  module YamlReaders
+    #
+    # YAML source is a YAML file that undergoes ERB expansion.
+    #
+    class YamlReaderWithExpansion < Tdc::YamlReaders::YamlReaderBase
+      def file_extension
+        ".yml.erb"
+      end
+
+      def source_string
+        ERB.new(File.read(definitions_file)).result
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.4
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -147,6 +147,12 @@ files:
 - lib/tdc/missing_override_error.rb
 - lib/tdc/version.rb
 - lib/tdc/with_indifferent_access_decorator.rb
+- lib/tdc/yaml_readers.rb
+- lib/tdc/yaml_readers/null_yaml_reader.rb
+- lib/tdc/yaml_readers/yaml_reader.rb
+- lib/tdc/yaml_readers/yaml_reader_base.rb
+- lib/tdc/yaml_readers/yaml_reader_factory.rb
+- lib/tdc/yaml_readers/yaml_reader_with_expansion.rb
 - tdc.gemspec
 homepage: https://github.com/nulogy/tdc
 licenses: