tdc 0.3.8 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2887adedbcb323e7d03e75b65538c2afc1edbe5f4ea84c0555e50dda77bc1305
-  data.tar.gz: a8be475b6e7edcd72ab2047cab59a198e984b921d4893ca5bac25ef0476540ea
+  metadata.gz: 8f5936018f214ecc5b2c99c96aaeaa02b01b1376ba09266202b82662dc3f0cce
+  data.tar.gz: f2572c85877de786307abe6ad4b3e7720cc9d3acd02398523f4d779e0dbbdf57
 SHA512:
-  metadata.gz: f1aaaf060b8e5b85ab96487279471521b9a04738a63cf360473905a6834d08bfc3bd3ddef01c5b2e571736b87177b74a21ee5cba24860e56bcdb206e208e3962
-  data.tar.gz: dc9cd3002213b1b5c2f6d95f09b986249c30fe239a28e788f06462d00f496b02a3cbc707d5236bd987d44ea435e9b516adbb777f480cce24a0ca22a06b59fe52
+  metadata.gz: 85846a6e8b1d30f3ed7eaeb893f4cc9cc3982723789c47bae6673fa91b65e54f7f0c4de8d05cd0f2989a2165ebb952b4311cabd22e0f38aabcea337bb39e158e
+  data.tar.gz: b05b075225180aa3711691d3ac6000cc9f9a2508fb11b82a6e01dd864092e42624e0b8bb157b4a03c139629a87711b4a083ad83f3e42eb1da78edd26a26b57aa

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,34 @@ 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
+
+- Collapse `ConfigurableGenerator` into `StandardGenerator`
+
 ## [0.3.8] - 2020-08-11
 
 #### New Features

data/lib/tdc.rb

@@ -39,7 +39,6 @@ require "tdc/generators/definition_sourcable"
 
 # Generator Hierarchy
 require "tdc/generators/generator_base"
-require "tdc/generators/configurable_generator"
 require "tdc/generators/standard_generator"
 
 #

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

@@ -33,20 +33,30 @@ 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 definition?(method)
+          definition_source.fetch(method.to_s.gsub(/_definition$/, ""))
+        elsif 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)
-
-        definition_source&.key?(key) ? true : super
+        definition?(method) || definition_optional?(method) ? true : super
       end
 
       def transform_method_to_definition_source_key(method)
         method.to_s.gsub(/_definition$/, "")
       end
+
+      def definition?(method)
+        method.to_s.end_with?("_definition")
+      end
+
+      def optional_definition?(method)
+        method.to_s.end_with?("_definition_optional")
+      end
     end
   end
 end

data/lib/tdc/generators/standard_generator.rb

@@ -1,11 +1,15 @@
 module Tdc
   module Generators
     #
-    # Abstract class for defining generators that define a collection of model instances.
+    # Knows how to provide a configurable instance definition.
     #
-    # See also SingularGenerator.
-    #
-    class StandardGenerator < Tdc::Generators::ConfigurableGenerator
+    class StandardGenerator < Tdc::Generators::GeneratorBase
+      include Tdc::Generators::DefinitionSourcable
+
+      attr_reader :instance_definition
+
+      source_definition_from :instance_definition
+
       def generate
         CatalogEntries.new.tap do |catalog_entries|
           instance_definitions.each do |instance_definition|
@@ -21,6 +25,43 @@ module Tdc
           end
         end
       end
+
+      def run_resolvers_and_generate_instance
+        run_extended_attribute_interpreters(instance_definition)
+        run_definition_resolvers(instance_definition)
+
+        generate_instance
+      end
+
+      #
+      # Hook method: subclasses are expected to define how to generate a model instance.
+      #
+      def generate_instance
+        raise Tdc::MissingOverrideError, "Implement the 'generate_instance' method"
+      end
+
+      #
+      # Hook method: subclasses may include the DefinitionResolvable concern to override.
+      #
+      def run_definition_resolvers(_instance_definition)
+        # Do nothing
+      end
+
+      private
+
+      def configure_instance_definition(instance_definition)
+        @instance_definition = instance_definition
+
+        configure_definition_source(instance_definition)
+      end
+
+      def run_extended_attribute_interpreters(instance_definition)
+        interpreters.each { |interpreter| interpreter.interpret(instance_definition) }
+      end
+
+      def interpreters
+        Tdc::ExtendedAttributes::InterpreterRegistry.instance.interpreters
+      end
     end
   end
 end

data/lib/tdc/version.rb

@@ -1,3 +1,3 @@
 module Tdc
-  VERSION = "0.3.8"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdc
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.3
 platform: ruby
 authors:
 - Alistair McKinnell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -138,7 +138,6 @@ files:
 - 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/generation_context.rb

data/lib/tdc/generators/configurable_generator.rb

@@ -1,51 +0,0 @@
-module Tdc
-  module Generators
-    #
-    # Knows how to provide a configurable instance definition.
-    #
-    class ConfigurableGenerator < Tdc::Generators::GeneratorBase
-      include Tdc::Generators::DefinitionSourcable
-
-      attr_reader :instance_definition
-
-      source_definition_from :instance_definition
-
-      def run_resolvers_and_generate_instance
-        run_extended_attribute_interpreters(instance_definition)
-        run_definition_resolvers(instance_definition)
-
-        generate_instance
-      end
-
-      #
-      # Hook method: subclasses are expected to define how to generate a model instance.
-      #
-      def generate_instance
-        raise Tdc::MissingOverrideError, "Implement the 'generate_instance' method"
-      end
-
-      #
-      # Hook method: subclasses may include the DefinitionResolvable concern to override.
-      #
-      def run_definition_resolvers(_instance_definition)
-        # Do nothing
-      end
-
-      private
-
-      def configure_instance_definition(instance_definition)
-        @instance_definition = instance_definition
-
-        configure_definition_source(instance_definition)
-      end
-
-      def run_extended_attribute_interpreters(instance_definition)
-        interpreters.each { |interpreter| interpreter.interpret(instance_definition) }
-      end
-
-      def interpreters
-        Tdc::ExtendedAttributes::InterpreterRegistry.instance.interpreters
-      end
-    end
-  end
-end