Extract Serializer and Deserializer

gems/gitlab-backup-cli/lib/gitlab/backup/cli.rb

@@ -8,6 +8,7 @@ module Cli
       autoload :Commands, 'gitlab/backup/cli/commands'
       autoload :Dependencies, 'gitlab/backup/cli/dependencies'
       autoload :BackupMetadata, 'gitlab/backup/cli/backup_metadata'
+      autoload :Metadata, 'gitlab/backup/cli/metadata'
       autoload :Output, 'gitlab/backup/cli/output'
       autoload :Runner, 'gitlab/backup/cli/runner'
       autoload :SourceContext, 'gitlab/backup/cli/source_context'

gems/gitlab-backup-cli/lib/gitlab/backup/cli/backup_metadata.rb

@@ -5,9 +5,6 @@ module Backup
     module Cli
       # Backup Metadata includes information about the Backup
       class BackupMetadata
-        extend Utils::MetadataSerialization
-        include Utils::MetadataSerialization
-
         # Metadata version number should always increase when:
         # - field is added
         # - field is removed
@@ -88,11 +85,12 @@ def self.load!(basepath)
 
           json_file = basepath.join(METADATA_FILENAME)
           json = JSON.parse(File.read(json_file), JSON_PARSE_OPTIONS)
+          deserializer = Gitlab::Backup::Cli::Metadata::Deserializer
 
           parsed_fields = {}
           METADATA_SCHEMA.each do |key, data_type|
             stored_value = json[key]
-            parsed_value = parse_value(type: data_type, value: stored_value)
+            parsed_value = deserializer.parse_value(type: data_type, value: stored_value)
             parsed_fields[key] = parsed_value
           end
 
@@ -107,10 +105,12 @@ def self.load!(basepath)
 
         # Expose the information that will be part of the Metadata JSON file
         def to_hash
+          serializer = Gitlab::Backup::Cli::Metadata::Serializer
+
           METADATA_SCHEMA.each_with_object({}) do |(key, type), hash|
             # fetch attribute value dynamically
             value = public_send(key)
-            serialized_value = serialize_value(type: type, value: value)
+            serialized_value = serializer.serialize_value(type: type, value: value)
             hash[key] = serialized_value
           end
         end

gems/gitlab-backup-cli/lib/gitlab/backup/cli/metadata.rb

+# frozen_string_literal: true
+
+module Gitlab
+  module Backup
+    module Cli
+      module Metadata
+        autoload :Serializer, 'gitlab/backup/cli/metadata/serializer'
+        autoload :Deserializer, 'gitlab/backup/cli/metadata/deserializer'
+      end
+    end
+  end
+end

gems/gitlab-backup-cli/lib/gitlab/backup/cli/metadata/deserializer.rb

+# frozen_string_literal: true
+
+module Gitlab
+  module Backup
+    module Cli
+      module Metadata
+        module Deserializer
+          extend self
+
+          # Given a JSON primitive +value+ loaded from a file, cast it to the
+          # expected class as specified by +type+
+          #
+          # @param [Symbol] type
+          # @param [Object] value
+          # @return [Object] the parsed and converted value
+          def parse_value(type:, value:)
+            return value if value.nil?
+
+            case type
+            when :string then parse_string(value)
+            when :time then parse_time(value)
+            when :integer then parse_integer(value)
+            else
+              raise NameError, "Unknown data type key #{type.inspect} provided when parsing backup metadata"
+            end
+          end
+
+          # @param [Object] value
+          def parse_string(value)
+            value.to_s
+          end
+
+          def parse_time(value)
+            return value if value.is_a?(Time) || value.nil?
+
+            Time.parse(value.to_s)
+          end
+
+          def parse_integer(value)
+            return value if value.is_a?(Integer) || value.nil?
+
+            value.to_s.to_i
+          end
+        end
+      end
+    end
+  end
+end

gems/gitlab-backup-cli/lib/gitlab/backup/cli/utils/metadata_serialization.rb → gems/gitlab-backup-cli/lib/gitlab/backup/cli/metadata/serializer.rb

@@ -3,28 +3,10 @@
 module Gitlab
   module Backup
     module Cli
-      module Utils
+      module Metadata
         # Defines value parsing and formatting routines for backup metadata JSON
-        module MetadataSerialization
-          module_function
-
-          # Given a JSON primitive +value+ loaded from a file, cast it to the
-          # expected class as specified by +type+
-          #
-          # @param [Symbol] type
-          # @param [Object] value
-          # @return [Object] the parsed and converted value
-          def parse_value(type:, value:)
-            return value if value.nil?
-
-            case type
-            when :string then parse_string(value)
-            when :time then parse_time(value)
-            when :integer then parse_integer(value)
-            else
-              fail NameError, "Unknown data type key #{type.inspect} provided when parsing backup metadata"
-            end
-          end
+        module Serializer
+          extend self
 
           # Given a metadata value, prepare and format the value as a
           # JSON primitive type before serializing
@@ -40,28 +22,13 @@ def serialize_value(type:, value:)
             when :time then serialize_time(value)
             when :integer then serialize_integer(value)
             else
-              fail NameError, "Unknown data type key #{type.inspect} provided when serializing backup metadata"
+              raise NameError, "Unknown data type key #{type.inspect} provided when serializing backup metadata"
             end
           end
 
-          def parse_string(value)
-            return value if value.nil?
-            value.to_s
-          end
-
-          def parse_time(value)
-            return value if value.is_a?(Time) || value.nil?
-            Time.parse(value.to_s)
-          end
-
-          def parse_integer(value)
-            return value if value.is_a?(Integer) || value.nil?
-
-            value.to_s.to_i
-          end
-
           def serialize_integer(value)
             return value if value.nil?
+
             value.to_i
           end
 
@@ -70,9 +37,10 @@ def serialize_string(value)
           end
 
           def serialize_time(value)
+            raise ArgumentError unless value.is_a?(Time)
+
             # ensures string values and nil are properly cast to Time objects
-            time = parse_time(value)
-            time&.iso8601
+            value.iso8601
           end
         end
       end