sarif-ruby 0.1.0

data/lib/sarif/rectangle.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Sarif
+  # An area within an image.
+  class Rectangle
+    attr_accessor :top, :left, :bottom, :right, :message, :properties
+
+    def initialize(top: nil, left: nil, bottom: nil, right: nil, message: nil, properties: nil)
+      @top = top
+      @left = left
+      @bottom = bottom
+      @right = right
+      @message = message
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["top"] = @top unless @top.nil?
+      h["left"] = @left unless @left.nil?
+      h["bottom"] = @bottom unless @bottom.nil?
+      h["right"] = @right unless @right.nil?
+      h["message"] = @message&.to_h unless @message.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(
+        top: h["top"],
+        left: h["left"],
+        bottom: h["bottom"],
+        right: h["right"],
+        message: Message.from_hash(h["message"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Rectangle)
+      @top == other.top && @left == other.left && @bottom == other.bottom && @right == other.right && @message == other.message && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@top, @left, @bottom, @right, @message, @properties].hash
+    end
+  end
+end

data/lib/sarif/region.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A region within an artifact where a result was detected.
+  class Region
+    attr_accessor :start_line, :start_column, :end_line, :end_column, :char_offset, :char_length, :byte_offset, :byte_length, :snippet, :message, :source_language, :properties
+
+    def initialize(start_line: nil, start_column: nil, end_line: nil, end_column: nil, char_offset: -1, char_length: nil, byte_offset: -1, byte_length: nil, snippet: nil, message: nil, source_language: nil, properties: nil)
+      @start_line = start_line
+      @start_column = start_column
+      @end_line = end_line
+      @end_column = end_column
+      @char_offset = char_offset
+      @char_length = char_length
+      @byte_offset = byte_offset
+      @byte_length = byte_length
+      @snippet = snippet
+      @message = message
+      @source_language = source_language
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["startLine"] = @start_line unless @start_line.nil?
+      h["startColumn"] = @start_column unless @start_column.nil?
+      h["endLine"] = @end_line unless @end_line.nil?
+      h["endColumn"] = @end_column unless @end_column.nil?
+      h["charOffset"] = @char_offset if @char_offset && @char_offset != -1
+      h["charLength"] = @char_length unless @char_length.nil?
+      h["byteOffset"] = @byte_offset if @byte_offset && @byte_offset != -1
+      h["byteLength"] = @byte_length unless @byte_length.nil?
+      h["snippet"] = @snippet&.to_h unless @snippet.nil?
+      h["message"] = @message&.to_h unless @message.nil?
+      h["sourceLanguage"] = @source_language unless @source_language.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(
+        start_line: h["startLine"],
+        start_column: h["startColumn"],
+        end_line: h["endLine"],
+        end_column: h["endColumn"],
+        char_offset: h["charOffset"] || -1,
+        char_length: h["charLength"],
+        byte_offset: h["byteOffset"] || -1,
+        byte_length: h["byteLength"],
+        snippet: ArtifactContent.from_hash(h["snippet"]),
+        message: Message.from_hash(h["message"]),
+        source_language: h["sourceLanguage"],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Region)
+      @start_line == other.start_line && @start_column == other.start_column && @end_line == other.end_line && @end_column == other.end_column && @char_offset == other.char_offset && @char_length == other.char_length && @byte_offset == other.byte_offset && @byte_length == other.byte_length && @snippet == other.snippet && @message == other.message && @source_language == other.source_language && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@start_line, @start_column, @end_line, @end_column, @char_offset, @char_length, @byte_offset, @byte_length, @snippet, @message, @source_language, @properties].hash
+    end
+  end
+end

data/lib/sarif/replacement.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sarif
+  # The replacement of a single region of an artifact.
+  class Replacement
+    attr_accessor :deleted_region, :inserted_content, :properties
+
+    def initialize(deleted_region:, inserted_content: nil, properties: nil)
+      @deleted_region = deleted_region
+      @inserted_content = inserted_content
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["deletedRegion"] = @deleted_region&.to_h
+      h["insertedContent"] = @inserted_content&.to_h unless @inserted_content.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(
+        deleted_region: Region.from_hash(h["deletedRegion"]),
+        inserted_content: ArtifactContent.from_hash(h["insertedContent"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Replacement)
+      @deleted_region == other.deleted_region && @inserted_content == other.inserted_content && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@deleted_region, @inserted_content, @properties].hash
+    end
+  end
+end

data/lib/sarif/reporting_configuration.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Information about a rule or notification that can be configured at runtime.
+  class ReportingConfiguration
+    attr_accessor :enabled, :level, :rank, :parameters, :properties
+
+    def initialize(enabled: true, level: "warning", rank: -1.0, parameters: nil, properties: nil)
+      @enabled = enabled
+      @level = level
+      @rank = rank
+      @parameters = parameters
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["enabled"] = @enabled unless @enabled
+      h["level"] = @level&.to_s if @level && @level != "warning"
+      h["rank"] = @rank if @rank && @rank != -1
+      h["parameters"] = @parameters unless @parameters.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(
+        enabled: h.key?("enabled") ? h["enabled"] : true,
+        level: h["level"] || "warning",
+        rank: h["rank"] || -1.0,
+        parameters: h["parameters"],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ReportingConfiguration)
+      @enabled == other.enabled && @level == other.level && @rank == other.rank && @parameters == other.parameters && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@enabled, @level, @rank, @parameters, @properties].hash
+    end
+  end
+end

data/lib/sarif/reporting_descriptor.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.
+  class ReportingDescriptor
+    attr_accessor :id, :deprecated_ids, :guid, :deprecated_guids, :name, :deprecated_names, :short_description, :full_description, :message_strings, :default_configuration, :help_uri, :help, :relationships, :properties
+
+    def initialize(id:, deprecated_ids: nil, guid: nil, deprecated_guids: nil, name: nil, deprecated_names: nil, short_description: nil, full_description: nil, message_strings: nil, default_configuration: nil, help_uri: nil, help: nil, relationships: [], properties: nil)
+      @id = id
+      @deprecated_ids = deprecated_ids
+      @guid = guid
+      @deprecated_guids = deprecated_guids
+      @name = name
+      @deprecated_names = deprecated_names
+      @short_description = short_description
+      @full_description = full_description
+      @message_strings = message_strings
+      @default_configuration = default_configuration
+      @help_uri = help_uri
+      @help = help
+      @relationships = relationships
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["id"] = @id
+      h["deprecatedIds"] = @deprecated_ids if @deprecated_ids&.any?
+      h["guid"] = @guid unless @guid.nil?
+      h["deprecatedGuids"] = @deprecated_guids if @deprecated_guids&.any?
+      h["name"] = @name unless @name.nil?
+      h["deprecatedNames"] = @deprecated_names if @deprecated_names&.any?
+      h["shortDescription"] = @short_description&.to_h unless @short_description.nil?
+      h["fullDescription"] = @full_description&.to_h unless @full_description.nil?
+      h["messageStrings"] = @message_strings unless @message_strings.nil?
+      h["defaultConfiguration"] = @default_configuration&.to_h unless @default_configuration.nil?
+      h["helpUri"] = @help_uri unless @help_uri.nil?
+      h["help"] = @help&.to_h unless @help.nil?
+      h["relationships"] = @relationships&.map(&:to_h) if @relationships&.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(
+        id: h["id"],
+        deprecated_ids: h["deprecatedIds"],
+        guid: h["guid"],
+        deprecated_guids: h["deprecatedGuids"],
+        name: h["name"],
+        deprecated_names: h["deprecatedNames"],
+        short_description: MultiformatMessageString.from_hash(h["shortDescription"]),
+        full_description: MultiformatMessageString.from_hash(h["fullDescription"]),
+        message_strings: h["messageStrings"],
+        default_configuration: ReportingConfiguration.from_hash(h["defaultConfiguration"]),
+        help_uri: h["helpUri"],
+        help: MultiformatMessageString.from_hash(h["help"]),
+        relationships: h["relationships"]&.map { |v| ReportingDescriptorRelationship.from_hash(v) } || [],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ReportingDescriptor)
+      @id == other.id && @deprecated_ids == other.deprecated_ids && @guid == other.guid && @deprecated_guids == other.deprecated_guids && @name == other.name && @deprecated_names == other.deprecated_names && @short_description == other.short_description && @full_description == other.full_description && @message_strings == other.message_strings && @default_configuration == other.default_configuration && @help_uri == other.help_uri && @help == other.help && @relationships == other.relationships && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@id, @deprecated_ids, @guid, @deprecated_guids, @name, @deprecated_names, @short_description, @full_description, @message_strings, @default_configuration, @help_uri, @help, @relationships, @properties].hash
+    end
+  end
+end

data/lib/sarif/reporting_descriptor_reference.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Information about how to locate a relevant reporting descriptor.
+  class ReportingDescriptorReference
+    attr_accessor :id, :index, :guid, :tool_component, :properties
+
+    def initialize(id: nil, index: -1, guid: nil, tool_component: nil, properties: nil)
+      @id = id
+      @index = index
+      @guid = guid
+      @tool_component = tool_component
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["id"] = @id unless @id.nil?
+      h["index"] = @index if @index && @index != -1
+      h["guid"] = @guid unless @guid.nil?
+      h["toolComponent"] = @tool_component&.to_h unless @tool_component.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(
+        id: h["id"],
+        index: h["index"] || -1,
+        guid: h["guid"],
+        tool_component: ToolComponentReference.from_hash(h["toolComponent"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ReportingDescriptorReference)
+      @id == other.id && @index == other.index && @guid == other.guid && @tool_component == other.tool_component && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@id, @index, @guid, @tool_component, @properties].hash
+    end
+  end
+end

data/lib/sarif/reporting_descriptor_relationship.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Information about the relation of one reporting descriptor to another.
+  class ReportingDescriptorRelationship
+    attr_accessor :target, :kinds, :description, :properties
+
+    def initialize(target:, kinds: ["relevant"], description: nil, properties: nil)
+      @target = target
+      @kinds = kinds
+      @description = description
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["target"] = @target&.to_h
+      h["kinds"] = @kinds if @kinds&.any?
+      h["description"] = @description&.to_h unless @description.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(
+        target: ReportingDescriptorReference.from_hash(h["target"]),
+        kinds: h.key?("kinds") ? h["kinds"] : ["relevant"],
+        description: Message.from_hash(h["description"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ReportingDescriptorRelationship)
+      @target == other.target && @kinds == other.kinds && @description == other.description && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@target, @kinds, @description, @properties].hash
+    end
+  end
+end

data/lib/sarif/result.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A result produced by an analysis tool.
+  class Result
+    attr_accessor :rule_id, :rule_index, :rule, :kind, :level, :message, :analysis_target, :locations, :guid, :correlation_guid, :occurrence_count, :partial_fingerprints, :fingerprints, :stacks, :code_flows, :graphs, :graph_traversals, :related_locations, :suppressions, :baseline_state, :rank, :attachments, :hosted_viewer_uri, :work_item_uris, :provenance, :fixes, :taxa, :web_request, :web_response, :properties
+
+    def initialize(rule_id: nil, rule_index: -1, rule: nil, kind: "fail", level: "warning", message:, analysis_target: nil, locations: [], guid: nil, correlation_guid: nil, occurrence_count: nil, partial_fingerprints: nil, fingerprints: nil, stacks: [], code_flows: [], graphs: [], graph_traversals: [], related_locations: [], suppressions: nil, baseline_state: nil, rank: -1.0, attachments: [], hosted_viewer_uri: nil, work_item_uris: nil, provenance: nil, fixes: [], taxa: [], web_request: nil, web_response: nil, properties: nil)
+      @rule_id = rule_id
+      @rule_index = rule_index
+      @rule = rule
+      @kind = kind
+      @level = level
+      @message = message
+      @analysis_target = analysis_target
+      @locations = locations
+      @guid = guid
+      @correlation_guid = correlation_guid
+      @occurrence_count = occurrence_count
+      @partial_fingerprints = partial_fingerprints
+      @fingerprints = fingerprints
+      @stacks = stacks
+      @code_flows = code_flows
+      @graphs = graphs
+      @graph_traversals = graph_traversals
+      @related_locations = related_locations
+      @suppressions = suppressions
+      @baseline_state = baseline_state
+      @rank = rank
+      @attachments = attachments
+      @hosted_viewer_uri = hosted_viewer_uri
+      @work_item_uris = work_item_uris
+      @provenance = provenance
+      @fixes = fixes
+      @taxa = taxa
+      @web_request = web_request
+      @web_response = web_response
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["ruleId"] = @rule_id unless @rule_id.nil?
+      h["ruleIndex"] = @rule_index if @rule_index && @rule_index != -1
+      h["rule"] = @rule&.to_h unless @rule.nil?
+      h["kind"] = @kind&.to_s if @kind && @kind != "fail"
+      h["level"] = @level&.to_s if @level && @level != "warning"
+      h["message"] = @message&.to_h
+      h["analysisTarget"] = @analysis_target&.to_h unless @analysis_target.nil?
+      h["locations"] = @locations&.map(&:to_h) if @locations&.any?
+      h["guid"] = @guid unless @guid.nil?
+      h["correlationGuid"] = @correlation_guid unless @correlation_guid.nil?
+      h["occurrenceCount"] = @occurrence_count unless @occurrence_count.nil?
+      h["partialFingerprints"] = @partial_fingerprints unless @partial_fingerprints.nil?
+      h["fingerprints"] = @fingerprints unless @fingerprints.nil?
+      h["stacks"] = @stacks&.map(&:to_h) if @stacks&.any?
+      h["codeFlows"] = @code_flows&.map(&:to_h) if @code_flows&.any?
+      h["graphs"] = @graphs&.map(&:to_h) if @graphs&.any?
+      h["graphTraversals"] = @graph_traversals&.map(&:to_h) if @graph_traversals&.any?
+      h["relatedLocations"] = @related_locations&.map(&:to_h) if @related_locations&.any?
+      h["suppressions"] = @suppressions&.map(&:to_h) if @suppressions&.any?
+      h["baselineState"] = @baseline_state&.to_s unless @baseline_state.nil?
+      h["rank"] = @rank if @rank && @rank != -1
+      h["attachments"] = @attachments&.map(&:to_h) if @attachments&.any?
+      h["hostedViewerUri"] = @hosted_viewer_uri unless @hosted_viewer_uri.nil?
+      h["workItemUris"] = @work_item_uris if @work_item_uris&.any?
+      h["provenance"] = @provenance&.to_h unless @provenance.nil?
+      h["fixes"] = @fixes&.map(&:to_h) if @fixes&.any?
+      h["taxa"] = @taxa&.map(&:to_h) if @taxa&.any?
+      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(
+        rule_id: h["ruleId"],
+        rule_index: h["ruleIndex"] || -1,
+        rule: ReportingDescriptorReference.from_hash(h["rule"]),
+        kind: h["kind"] || "fail",
+        level: h["level"] || "warning",
+        message: Message.from_hash(h["message"]),
+        analysis_target: ArtifactLocation.from_hash(h["analysisTarget"]),
+        locations: h["locations"]&.map { |v| Location.from_hash(v) } || [],
+        guid: h["guid"],
+        correlation_guid: h["correlationGuid"],
+        occurrence_count: h["occurrenceCount"],
+        partial_fingerprints: h["partialFingerprints"],
+        fingerprints: h["fingerprints"],
+        stacks: h["stacks"]&.map { |v| Stack.from_hash(v) } || [],
+        code_flows: h["codeFlows"]&.map { |v| CodeFlow.from_hash(v) } || [],
+        graphs: h["graphs"]&.map { |v| Graph.from_hash(v) } || [],
+        graph_traversals: h["graphTraversals"]&.map { |v| GraphTraversal.from_hash(v) } || [],
+        related_locations: h["relatedLocations"]&.map { |v| Location.from_hash(v) } || [],
+        suppressions: h["suppressions"]&.map { |v| Suppression.from_hash(v) },
+        baseline_state: h["baselineState"],
+        rank: h["rank"] || -1.0,
+        attachments: h["attachments"]&.map { |v| Attachment.from_hash(v) } || [],
+        hosted_viewer_uri: h["hostedViewerUri"],
+        work_item_uris: h["workItemUris"],
+        provenance: ResultProvenance.from_hash(h["provenance"]),
+        fixes: h["fixes"]&.map { |v| Fix.from_hash(v) } || [],
+        taxa: h["taxa"]&.map { |v| ReportingDescriptorReference.from_hash(v) } || [],
+        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?(Result)
+      @rule_id == other.rule_id && @rule_index == other.rule_index && @rule == other.rule && @kind == other.kind && @level == other.level && @message == other.message && @analysis_target == other.analysis_target && @locations == other.locations && @guid == other.guid && @correlation_guid == other.correlation_guid && @occurrence_count == other.occurrence_count && @partial_fingerprints == other.partial_fingerprints && @fingerprints == other.fingerprints && @stacks == other.stacks && @code_flows == other.code_flows && @graphs == other.graphs && @graph_traversals == other.graph_traversals && @related_locations == other.related_locations && @suppressions == other.suppressions && @baseline_state == other.baseline_state && @rank == other.rank && @attachments == other.attachments && @hosted_viewer_uri == other.hosted_viewer_uri && @work_item_uris == other.work_item_uris && @provenance == other.provenance && @fixes == other.fixes && @taxa == other.taxa && @web_request == other.web_request && @web_response == other.web_response && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@rule_id, @rule_index, @rule, @kind, @level, @message, @analysis_target, @locations, @guid, @correlation_guid, @occurrence_count, @partial_fingerprints, @fingerprints, @stacks, @code_flows, @graphs, @graph_traversals, @related_locations, @suppressions, @baseline_state, @rank, @attachments, @hosted_viewer_uri, @work_item_uris, @provenance, @fixes, @taxa, @web_request, @web_response, @properties].hash
+    end
+  end
+end

data/lib/sarif/result_provenance.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Contains information about how and when a result was detected.
+  class ResultProvenance
+    attr_accessor :first_detection_time_utc, :last_detection_time_utc, :first_detection_run_guid, :last_detection_run_guid, :invocation_index, :conversion_sources, :properties
+
+    def initialize(first_detection_time_utc: nil, last_detection_time_utc: nil, first_detection_run_guid: nil, last_detection_run_guid: nil, invocation_index: -1, conversion_sources: [], properties: nil)
+      @first_detection_time_utc = first_detection_time_utc
+      @last_detection_time_utc = last_detection_time_utc
+      @first_detection_run_guid = first_detection_run_guid
+      @last_detection_run_guid = last_detection_run_guid
+      @invocation_index = invocation_index
+      @conversion_sources = conversion_sources
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["firstDetectionTimeUtc"] = @first_detection_time_utc unless @first_detection_time_utc.nil?
+      h["lastDetectionTimeUtc"] = @last_detection_time_utc unless @last_detection_time_utc.nil?
+      h["firstDetectionRunGuid"] = @first_detection_run_guid unless @first_detection_run_guid.nil?
+      h["lastDetectionRunGuid"] = @last_detection_run_guid unless @last_detection_run_guid.nil?
+      h["invocationIndex"] = @invocation_index if @invocation_index && @invocation_index != -1
+      h["conversionSources"] = @conversion_sources&.map(&:to_h) if @conversion_sources&.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(
+        first_detection_time_utc: h["firstDetectionTimeUtc"],
+        last_detection_time_utc: h["lastDetectionTimeUtc"],
+        first_detection_run_guid: h["firstDetectionRunGuid"],
+        last_detection_run_guid: h["lastDetectionRunGuid"],
+        invocation_index: h["invocationIndex"] || -1,
+        conversion_sources: h["conversionSources"]&.map { |v| PhysicalLocation.from_hash(v) } || [],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ResultProvenance)
+      @first_detection_time_utc == other.first_detection_time_utc && @last_detection_time_utc == other.last_detection_time_utc && @first_detection_run_guid == other.first_detection_run_guid && @last_detection_run_guid == other.last_detection_run_guid && @invocation_index == other.invocation_index && @conversion_sources == other.conversion_sources && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@first_detection_time_utc, @last_detection_time_utc, @first_detection_run_guid, @last_detection_run_guid, @invocation_index, @conversion_sources, @properties].hash
+    end
+  end
+end