tdc 0.4.2 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83b4405ab9ec996fbab35d7228931e03d5bf18966df916b631d36d6aecca4393
-  data.tar.gz: 942728ff3d354bb5dc516c777606766b798ae218b4fd85ec4823cfad7e9d1875
+  metadata.gz: a605f44cef27e72e80f13f582363886ca57b61238bec36ff2f3367c2c0cd4973
+  data.tar.gz: a61883e606e164fa260f02c3b2588a352600b54b6c0fc9e8b0ae9fc7df6d3970
 SHA512:
-  metadata.gz: 1a783d54d2a3af00fcd0d8366b1a55190503fda3350308179f5eb778f2fab6f3601b7c6eded92bd27a123a39303160ffa19381902228e8e11ab5f4213deda20c
-  data.tar.gz: 5cc30405e4369c739e5a77370bf663d0813a2a72e2bdbaa7791bd8c1f966c5337c477689c4f968b82d20ee41bc3d22f94baa0731fb0d38948f6001137d4f56c6
+  metadata.gz: 2f2d9ac1591cf59bbc6c4bc2c128f5a891cef41c5399b480215f4644dae499f24a8f68bc4e3aef729e66d4f99aee978b4be523d82d58e5757b536bec19ae973e
+  data.tar.gz: 5b69a6c7393477eab60ffea42f8c0764ab1a289fb791c952e3f56f7ad6e9e368f9dfbc9229b82cddb431f6bd5fe637a9fa99dbc3428eb52f75940a0984004a47

data/.rubocop.yml

@@ -15,9 +15,16 @@ Layout/LineLength:
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
 
-Metrics/BlockLength:
+# Revisit. Seems a little harsh.
+Lint/MissingSuper:
   Enabled: false
 
+Metrics/BlockLength:
+  Exclude:
+    - 'tdc.gemspec'
+    - '**/*_shared_example.rb'
+    - '**/*_spec.rb'
+
 Naming/MemoizedInstanceVariableName:
   EnforcedStyleForLeadingUnderscores: required
 

data/CHANGELOG.md

@@ -6,8 +6,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.6] - 2020-09-26
+
+- Better error message when a tag cannot be resolved
+
+Note: version `0.4.5` was yanked from RubyGems.
+
+## [0.4.4.1] - 2020-09-12
+
+- Avoid registering the same class of interpreter a second time
+
+## [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

data/Gemfile

@@ -2,6 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in tdc.gemspec
 gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/Rakefile

@@ -1,8 +1,17 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
+require "rubycritic/rake_task"
 
-RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+RubyCritic::RakeTask.new do |task|
+  files = FileList["**/*.rb"]
+  files.exclude("**/*_spec.rb")
+  files.exclude("**/*_shared_example.rb")
+
+  task.paths = files
+end
 
 task :default => [:rubocop, :spec]

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
@@ -26,15 +24,23 @@ module Tdc
         # Use the tag to source an object from the current catalog.
         sourced_object = catalog_entry.send(tag)
 
-        unless sourced_object
-          message = "Could not find a tag reference for '#{key}' in the catalog entries provided."
-
-          raise Tdc::FatalError, message
-        end
+        unresolvable_tag(tag, catalog_entry) unless sourced_object
 
         # Replace the tag value with the sourced object.
         instance_definition[key] = sourced_object
       end
+
+      private
+
+      def unresolvable_tag(tag, catalog_entry)
+        source_tags = catalog_entry.entries.sort.map { |entry| "'#{entry}'" }.to_sentence
+
+        raise Tdc::FatalError, <<~MESSAGE
+          Could not resolve key '#{key}' from source '#{source}'.
+
+          Attempted to resolve tag '#{tag}' from these tags: #{source_tags}
+        MESSAGE
+      end
     end
   end
 end

data/lib/tdc/extended_attributes/interpreter_registry.rb

@@ -14,6 +14,10 @@ module Tdc
         @interpreters = []
       end
 
+      def clear
+        @interpreters = []
+      end
+
       def interpreters
         @interpreters.empty? ? [default_interpreter] : @interpreters
       end
@@ -23,6 +27,9 @@ module Tdc
           Cannot register an interpreter unless it inherits from Tdc::ExtendedAttributes::InterpreterBase
         MSG
 
+        # Avoid registering the same class of interpreter a second time.
+        return if @interpreters.map(&:class).include?(interpreter.class)
+
         @interpreters << interpreter
       end
 

data/lib/tdc/fatal_error.rb

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

data/lib/tdc/generators/catalog_entries.rb

@@ -13,6 +13,10 @@ module Tdc
         to_h.empty?
       end
 
+      def entries
+        to_h.keys
+      end
+
       def first
         to_h.first&.second
       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)
+      def respond_to_missing?(method, include_all = false)
+        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.2"
+  VERSION = "0.4.6"
 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

data/tdc.gemspec

@@ -33,6 +33,8 @@ 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.89"
+  spec.add_development_dependency "rubocop-performance", "~> 1.8"
   spec.add_development_dependency "rubocop-rspec", "~> 1.42"
+  spec.add_development_dependency "rubycritic", "~> 4.5"
   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.4.2
+  version: 0.4.6
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-22 00:00:00.000000000 Z
+date: 2020-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -78,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.89'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +106,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.42'
+- !ruby/object:Gem::Dependency
+  name: rubycritic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +175,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: