tdc 0.3.9 → 0.4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40158a1118d92cb453c0197da1eea7850c19ba2bba98306806bf920f167d16b8
-  data.tar.gz: '09f31030294fadabb38f88c6976d56774670b636ec43bb2ae4d62a96ad234087'
+  metadata.gz: f01cdb5f72c9481d031888d6c1729d6ba6976c79184807dfeb4213fa3205ee99
+  data.tar.gz: 64ef598c74252a48925ad77c9f779df6c7a45957bb8b2cf641122981c9cfcc30
 SHA512:
-  metadata.gz: 40758219403185741dbc04f645f5f7d19a07ff004514cf5c5d9c7a4312085d4918d8d2694204c643bcb97f808c8c958b002b7c2e684748d8d1621e1b9f49f182
-  data.tar.gz: 41777ff45589fc3de09026e86e0e26220cd863a95861fd866a337f53b23ec0211f4d4ced7d0feac6cabbf563175f6b6234888b441c80d30bd848bad2f42cef16
+  metadata.gz: d093ea28c783c4a5b62c951c815cfb915c7ae7cf13ec2e97cb6ddaceedb09b968b6bb6bf9d80723d8146edac1c7bb6c562d59dec957d074cd67f985a0ce4c79f
+  data.tar.gz: c99360136e1857226fef356850499c8aa4bfbe5762c808ab115e4ca40bf4a8f9b097d06dc7c277e0b50e77e9655a2056dc544ca733552238c6de3b203b391c37

data/.rubocop.yml

@@ -21,6 +21,10 @@ Metrics/BlockLength:
 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.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
+
+- Drop requirement that an empty test data definition file must be provided 
+
 ## [0.3.9] - 2020-08-12
 
 #### Breaking Changes

data/lib/tdc/data_definition_file_reader.rb

@@ -29,7 +29,7 @@ module Tdc
       if File.exist?(definitions_file)
         load_yaml(definitions_file) || EMPTY_DEFINITIONS
       else
-        missing_data_definition(definitions_file)
+        EMPTY_DEFINITIONS
       end
     end
 
@@ -45,11 +45,5 @@ module Tdc
     def expand_erb(definitions_file)
       ERB.new(File.read(definitions_file)).result
     end
-
-    def missing_data_definition(definitions_file)
-      return EMPTY_DEFINITIONS if ENV.key?("TDC_IGNORE_MISSING_TEST_DATA_DEFINITION_ERROR")
-
-      raise Tdc::FatalError, "Missing test definitions file: '#{definitions_file}'"
-    end
   end
 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/version.rb

@@ -1,3 +1,3 @@
 module Tdc
-  VERSION = "0.3.9"
+  VERSION = "0.4.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.3.1
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport