sarif-ruby 0.1.0

data/lib/sarif/special_locations.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Defines locations of special significance to SARIF consumers.
+  class SpecialLocations
+    attr_accessor :display_base, :properties
+
+    def initialize(display_base: nil, properties: nil)
+      @display_base = display_base
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["displayBase"] = @display_base&.to_h unless @display_base.nil?
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        display_base: ArtifactLocation.from_hash(h["displayBase"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(SpecialLocations)
+      @display_base == other.display_base && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@display_base, @properties].hash
+    end
+  end
+end

data/lib/sarif/stack.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A call stack that is relevant to a result.
+  class Stack
+    attr_accessor :message, :frames, :properties
+
+    def initialize(message: nil, frames:, properties: nil)
+      @message = message
+      @frames = frames
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["message"] = @message&.to_h unless @message.nil?
+      h["frames"] = @frames&.map(&:to_h)
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        message: Message.from_hash(h["message"]),
+        frames: h["frames"]&.map { |v| StackFrame.from_hash(v) },
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Stack)
+      @message == other.message && @frames == other.frames && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@message, @frames, @properties].hash
+    end
+  end
+end

data/lib/sarif/stack_frame.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A function call within a stack trace.
+  class StackFrame
+    attr_accessor :location, :module_name, :thread_id, :parameters, :properties
+
+    def initialize(location: nil, module_name: nil, thread_id: nil, parameters: [], properties: nil)
+      @location = location
+      @module_name = module_name
+      @thread_id = thread_id
+      @parameters = parameters
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["location"] = @location&.to_h unless @location.nil?
+      h["module"] = @module_name unless @module_name.nil?
+      h["threadId"] = @thread_id unless @thread_id.nil?
+      h["parameters"] = @parameters if @parameters&.any?
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        location: Location.from_hash(h["location"]),
+        module_name: h["module"],
+        thread_id: h["threadId"],
+        parameters: h["parameters"] || [],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(StackFrame)
+      @location == other.location && @module_name == other.module_name && @thread_id == other.thread_id && @parameters == other.parameters && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@location, @module_name, @thread_id, @parameters, @properties].hash
+    end
+  end
+end

data/lib/sarif/suppression.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A suppression that is relevant to a result.
+  class Suppression
+    attr_accessor :guid, :kind, :status, :justification, :location, :properties
+
+    def initialize(guid: nil, kind:, status: nil, justification: nil, location: nil, properties: nil)
+      @guid = guid
+      @kind = kind
+      @status = status
+      @justification = justification
+      @location = location
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["guid"] = @guid unless @guid.nil?
+      h["kind"] = @kind&.to_s
+      h["status"] = @status&.to_s unless @status.nil?
+      h["justification"] = @justification unless @justification.nil?
+      h["location"] = @location&.to_h unless @location.nil?
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        guid: h["guid"],
+        kind: h["kind"],
+        status: h["status"],
+        justification: h["justification"],
+        location: Location.from_hash(h["location"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Suppression)
+      @guid == other.guid && @kind == other.kind && @status == other.status && @justification == other.justification && @location == other.location && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@guid, @kind, @status, @justification, @location, @properties].hash
+    end
+  end
+end

data/lib/sarif/thread_flow.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.
+  class ThreadFlow
+    attr_accessor :id, :message, :initial_state, :immutable_state, :locations, :properties
+
+    def initialize(id: nil, message: nil, initial_state: nil, immutable_state: nil, locations:, properties: nil)
+      @id = id
+      @message = message
+      @initial_state = initial_state
+      @immutable_state = immutable_state
+      @locations = locations
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["id"] = @id unless @id.nil?
+      h["message"] = @message&.to_h unless @message.nil?
+      h["initialState"] = @initial_state unless @initial_state.nil?
+      h["immutableState"] = @immutable_state unless @immutable_state.nil?
+      h["locations"] = @locations&.map(&:to_h)
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        id: h["id"],
+        message: Message.from_hash(h["message"]),
+        initial_state: h["initialState"],
+        immutable_state: h["immutableState"],
+        locations: h["locations"]&.map { |v| ThreadFlowLocation.from_hash(v) },
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ThreadFlow)
+      @id == other.id && @message == other.message && @initial_state == other.initial_state && @immutable_state == other.immutable_state && @locations == other.locations && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@id, @message, @initial_state, @immutable_state, @locations, @properties].hash
+    end
+  end
+end

data/lib/sarif/thread_flow_location.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A location visited by an analysis tool while simulating or monitoring the execution of a program.
+  class ThreadFlowLocation
+    attr_accessor :index, :location, :stack, :kinds, :taxa, :module_name, :state, :nesting_level, :execution_order, :execution_time_utc, :importance, :web_request, :web_response, :properties
+
+    def initialize(index: -1, location: nil, stack: nil, kinds: [], taxa: [], module_name: nil, state: nil, nesting_level: nil, execution_order: -1, execution_time_utc: nil, importance: "important", web_request: nil, web_response: nil, properties: nil)
+      @index = index
+      @location = location
+      @stack = stack
+      @kinds = kinds
+      @taxa = taxa
+      @module_name = module_name
+      @state = state
+      @nesting_level = nesting_level
+      @execution_order = execution_order
+      @execution_time_utc = execution_time_utc
+      @importance = importance
+      @web_request = web_request
+      @web_response = web_response
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["index"] = @index if @index && @index != -1
+      h["location"] = @location&.to_h unless @location.nil?
+      h["stack"] = @stack&.to_h unless @stack.nil?
+      h["kinds"] = @kinds if @kinds&.any?
+      h["taxa"] = @taxa&.map(&:to_h) if @taxa&.any?
+      h["module"] = @module_name unless @module_name.nil?
+      h["state"] = @state unless @state.nil?
+      h["nestingLevel"] = @nesting_level unless @nesting_level.nil?
+      h["executionOrder"] = @execution_order if @execution_order && @execution_order != -1
+      h["executionTimeUtc"] = @execution_time_utc unless @execution_time_utc.nil?
+      h["importance"] = @importance&.to_s if @importance && @importance != "important"
+      h["webRequest"] = @web_request&.to_h unless @web_request.nil?
+      h["webResponse"] = @web_response&.to_h unless @web_response.nil?
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        index: h["index"] || -1,
+        location: Location.from_hash(h["location"]),
+        stack: Stack.from_hash(h["stack"]),
+        kinds: h["kinds"] || [],
+        taxa: h["taxa"]&.map { |v| ReportingDescriptorReference.from_hash(v) } || [],
+        module_name: h["module"],
+        state: h["state"],
+        nesting_level: h["nestingLevel"],
+        execution_order: h["executionOrder"] || -1,
+        execution_time_utc: h["executionTimeUtc"],
+        importance: h["importance"] || "important",
+        web_request: WebRequest.from_hash(h["webRequest"]),
+        web_response: WebResponse.from_hash(h["webResponse"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ThreadFlowLocation)
+      @index == other.index && @location == other.location && @stack == other.stack && @kinds == other.kinds && @taxa == other.taxa && @module_name == other.module_name && @state == other.state && @nesting_level == other.nesting_level && @execution_order == other.execution_order && @execution_time_utc == other.execution_time_utc && @importance == other.importance && @web_request == other.web_request && @web_response == other.web_response && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@index, @location, @stack, @kinds, @taxa, @module_name, @state, @nesting_level, @execution_order, @execution_time_utc, @importance, @web_request, @web_response, @properties].hash
+    end
+  end
+end

data/lib/sarif/tool.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sarif
+  # The analysis tool that was run.
+  class Tool
+    attr_accessor :driver, :extensions, :properties
+
+    def initialize(driver:, extensions: [], properties: nil)
+      @driver = driver
+      @extensions = extensions
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["driver"] = @driver&.to_h
+      h["extensions"] = @extensions&.map(&:to_h) if @extensions&.any?
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        driver: ToolComponent.from_hash(h["driver"]),
+        extensions: h["extensions"]&.map { |v| ToolComponent.from_hash(v) } || [],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Tool)
+      @driver == other.driver && @extensions == other.extensions && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@driver, @extensions, @properties].hash
+    end
+  end
+end

data/lib/sarif/tool_component.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A component, such as a plug-in or the driver, of the analysis tool that was run.
+  class ToolComponent
+    attr_accessor :guid, :name, :organization, :product, :product_suite, :short_description, :full_description, :full_name, :version, :semantic_version, :dotted_quad_file_version, :release_date_utc, :download_uri, :information_uri, :global_message_strings, :notifications, :rules, :taxa, :locations, :language, :contents, :is_comprehensive, :localized_data_semantic_version, :minimum_required_localized_data_semantic_version, :associated_component, :translation_metadata, :supported_taxonomies, :properties
+
+    def initialize(guid: nil, name:, organization: nil, product: nil, product_suite: nil, short_description: nil, full_description: nil, full_name: nil, version: nil, semantic_version: nil, dotted_quad_file_version: nil, release_date_utc: nil, download_uri: nil, information_uri: nil, global_message_strings: nil, notifications: [], rules: [], taxa: [], locations: [], language: "en-US", contents: ["localizedData", "nonLocalizedData"], is_comprehensive: false, localized_data_semantic_version: nil, minimum_required_localized_data_semantic_version: nil, associated_component: nil, translation_metadata: nil, supported_taxonomies: [], properties: nil)
+      @guid = guid
+      @name = name
+      @organization = organization
+      @product = product
+      @product_suite = product_suite
+      @short_description = short_description
+      @full_description = full_description
+      @full_name = full_name
+      @version = version
+      @semantic_version = semantic_version
+      @dotted_quad_file_version = dotted_quad_file_version
+      @release_date_utc = release_date_utc
+      @download_uri = download_uri
+      @information_uri = information_uri
+      @global_message_strings = global_message_strings
+      @notifications = notifications
+      @rules = rules
+      @taxa = taxa
+      @locations = locations
+      @language = language
+      @contents = contents
+      @is_comprehensive = is_comprehensive
+      @localized_data_semantic_version = localized_data_semantic_version
+      @minimum_required_localized_data_semantic_version = minimum_required_localized_data_semantic_version
+      @associated_component = associated_component
+      @translation_metadata = translation_metadata
+      @supported_taxonomies = supported_taxonomies
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["guid"] = @guid unless @guid.nil?
+      h["name"] = @name
+      h["organization"] = @organization unless @organization.nil?
+      h["product"] = @product unless @product.nil?
+      h["productSuite"] = @product_suite unless @product_suite.nil?
+      h["shortDescription"] = @short_description&.to_h unless @short_description.nil?
+      h["fullDescription"] = @full_description&.to_h unless @full_description.nil?
+      h["fullName"] = @full_name unless @full_name.nil?
+      h["version"] = @version unless @version.nil?
+      h["semanticVersion"] = @semantic_version unless @semantic_version.nil?
+      h["dottedQuadFileVersion"] = @dotted_quad_file_version unless @dotted_quad_file_version.nil?
+      h["releaseDateUtc"] = @release_date_utc unless @release_date_utc.nil?
+      h["downloadUri"] = @download_uri unless @download_uri.nil?
+      h["informationUri"] = @information_uri unless @information_uri.nil?
+      h["globalMessageStrings"] = @global_message_strings unless @global_message_strings.nil?
+      h["notifications"] = @notifications&.map(&:to_h) if @notifications&.any?
+      h["rules"] = @rules&.map(&:to_h) if @rules&.any?
+      h["taxa"] = @taxa&.map(&:to_h) if @taxa&.any?
+      h["locations"] = @locations&.map(&:to_h) if @locations&.any?
+      h["language"] = @language if @language && @language != "en-US"
+      h["contents"] = @contents&.map(&:to_s) if @contents&.any?
+      h["isComprehensive"] = @is_comprehensive if @is_comprehensive
+      h["localizedDataSemanticVersion"] = @localized_data_semantic_version unless @localized_data_semantic_version.nil?
+      h["minimumRequiredLocalizedDataSemanticVersion"] = @minimum_required_localized_data_semantic_version unless @minimum_required_localized_data_semantic_version.nil?
+      h["associatedComponent"] = @associated_component&.to_h unless @associated_component.nil?
+      h["translationMetadata"] = @translation_metadata&.to_h unless @translation_metadata.nil?
+      h["supportedTaxonomies"] = @supported_taxonomies&.map(&:to_h) if @supported_taxonomies&.any?
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        guid: h["guid"],
+        name: h["name"],
+        organization: h["organization"],
+        product: h["product"],
+        product_suite: h["productSuite"],
+        short_description: MultiformatMessageString.from_hash(h["shortDescription"]),
+        full_description: MultiformatMessageString.from_hash(h["fullDescription"]),
+        full_name: h["fullName"],
+        version: h["version"],
+        semantic_version: h["semanticVersion"],
+        dotted_quad_file_version: h["dottedQuadFileVersion"],
+        release_date_utc: h["releaseDateUtc"],
+        download_uri: h["downloadUri"],
+        information_uri: h["informationUri"],
+        global_message_strings: h["globalMessageStrings"],
+        notifications: h["notifications"]&.map { |v| ReportingDescriptor.from_hash(v) } || [],
+        rules: h["rules"]&.map { |v| ReportingDescriptor.from_hash(v) } || [],
+        taxa: h["taxa"]&.map { |v| ReportingDescriptor.from_hash(v) } || [],
+        locations: h["locations"]&.map { |v| ArtifactLocation.from_hash(v) } || [],
+        language: h["language"] || "en-US",
+        contents: h.key?("contents") ? h["contents"] : ["localizedData", "nonLocalizedData"],
+        is_comprehensive: h.key?("isComprehensive") ? h["isComprehensive"] : false,
+        localized_data_semantic_version: h["localizedDataSemanticVersion"],
+        minimum_required_localized_data_semantic_version: h["minimumRequiredLocalizedDataSemanticVersion"],
+        associated_component: ToolComponentReference.from_hash(h["associatedComponent"]),
+        translation_metadata: TranslationMetadata.from_hash(h["translationMetadata"]),
+        supported_taxonomies: h["supportedTaxonomies"]&.map { |v| ToolComponentReference.from_hash(v) } || [],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ToolComponent)
+      @guid == other.guid && @name == other.name && @organization == other.organization && @product == other.product && @product_suite == other.product_suite && @short_description == other.short_description && @full_description == other.full_description && @full_name == other.full_name && @version == other.version && @semantic_version == other.semantic_version && @dotted_quad_file_version == other.dotted_quad_file_version && @release_date_utc == other.release_date_utc && @download_uri == other.download_uri && @information_uri == other.information_uri && @global_message_strings == other.global_message_strings && @notifications == other.notifications && @rules == other.rules && @taxa == other.taxa && @locations == other.locations && @language == other.language && @contents == other.contents && @is_comprehensive == other.is_comprehensive && @localized_data_semantic_version == other.localized_data_semantic_version && @minimum_required_localized_data_semantic_version == other.minimum_required_localized_data_semantic_version && @associated_component == other.associated_component && @translation_metadata == other.translation_metadata && @supported_taxonomies == other.supported_taxonomies && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@guid, @name, @organization, @product, @product_suite, @short_description, @full_description, @full_name, @version, @semantic_version, @dotted_quad_file_version, @release_date_utc, @download_uri, @information_uri, @global_message_strings, @notifications, @rules, @taxa, @locations, @language, @contents, @is_comprehensive, @localized_data_semantic_version, @minimum_required_localized_data_semantic_version, @associated_component, @translation_metadata, @supported_taxonomies, @properties].hash
+    end
+  end
+end

data/lib/sarif/tool_component_reference.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Identifies a particular toolComponent object, either the driver or an extension.
+  class ToolComponentReference
+    attr_accessor :name, :index, :guid, :properties
+
+    def initialize(name: nil, index: -1, guid: nil, properties: nil)
+      @name = name
+      @index = index
+      @guid = guid
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["name"] = @name unless @name.nil?
+      h["index"] = @index if @index && @index != -1
+      h["guid"] = @guid unless @guid.nil?
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        name: h["name"],
+        index: h["index"] || -1,
+        guid: h["guid"],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ToolComponentReference)
+      @name == other.name && @index == other.index && @guid == other.guid && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@name, @index, @guid, @properties].hash
+    end
+  end
+end

data/lib/sarif/translation_metadata.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Provides additional metadata related to translation.
+  class TranslationMetadata
+    attr_accessor :name, :full_name, :short_description, :full_description, :download_uri, :information_uri, :properties
+
+    def initialize(name:, full_name: nil, short_description: nil, full_description: nil, download_uri: nil, information_uri: nil, properties: nil)
+      @name = name
+      @full_name = full_name
+      @short_description = short_description
+      @full_description = full_description
+      @download_uri = download_uri
+      @information_uri = information_uri
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["name"] = @name
+      h["fullName"] = @full_name unless @full_name.nil?
+      h["shortDescription"] = @short_description&.to_h unless @short_description.nil?
+      h["fullDescription"] = @full_description&.to_h unless @full_description.nil?
+      h["downloadUri"] = @download_uri unless @download_uri.nil?
+      h["informationUri"] = @information_uri unless @information_uri.nil?
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        name: h["name"],
+        full_name: h["fullName"],
+        short_description: MultiformatMessageString.from_hash(h["shortDescription"]),
+        full_description: MultiformatMessageString.from_hash(h["fullDescription"]),
+        download_uri: h["downloadUri"],
+        information_uri: h["informationUri"],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(TranslationMetadata)
+      @name == other.name && @full_name == other.full_name && @short_description == other.short_description && @full_description == other.full_description && @download_uri == other.download_uri && @information_uri == other.information_uri && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@name, @full_name, @short_description, @full_description, @download_uri, @information_uri, @properties].hash
+    end
+  end
+end

data/lib/sarif/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sarif
+  VERSION = "0.1.0"
+end

data/lib/sarif/version_control_details.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Specifies the information necessary to retrieve a desired revision from a version control system.
+  class VersionControlDetails
+    attr_accessor :repository_uri, :revision_id, :branch, :revision_tag, :as_of_time_utc, :mapped_to, :properties
+
+    def initialize(repository_uri:, revision_id: nil, branch: nil, revision_tag: nil, as_of_time_utc: nil, mapped_to: nil, properties: nil)
+      @repository_uri = repository_uri
+      @revision_id = revision_id
+      @branch = branch
+      @revision_tag = revision_tag
+      @as_of_time_utc = as_of_time_utc
+      @mapped_to = mapped_to
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["repositoryUri"] = @repository_uri
+      h["revisionId"] = @revision_id unless @revision_id.nil?
+      h["branch"] = @branch unless @branch.nil?
+      h["revisionTag"] = @revision_tag unless @revision_tag.nil?
+      h["asOfTimeUtc"] = @as_of_time_utc unless @as_of_time_utc.nil?
+      h["mappedTo"] = @mapped_to&.to_h unless @mapped_to.nil?
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        repository_uri: h["repositoryUri"],
+        revision_id: h["revisionId"],
+        branch: h["branch"],
+        revision_tag: h["revisionTag"],
+        as_of_time_utc: h["asOfTimeUtc"],
+        mapped_to: ArtifactLocation.from_hash(h["mappedTo"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(VersionControlDetails)
+      @repository_uri == other.repository_uri && @revision_id == other.revision_id && @branch == other.branch && @revision_tag == other.revision_tag && @as_of_time_utc == other.as_of_time_utc && @mapped_to == other.mapped_to && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@repository_uri, @revision_id, @branch, @revision_tag, @as_of_time_utc, @mapped_to, @properties].hash
+    end
+  end
+end