sarif-ruby 0.1.0

data/lib/sarif/run.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Describes a single run of an analysis tool, and contains the reported output of that run.
+  class Run
+    attr_accessor :tool, :invocations, :conversion, :language, :version_control_provenance, :original_uri_base_ids, :artifacts, :logical_locations, :graphs, :results, :automation_details, :run_aggregates, :baseline_guid, :redaction_tokens, :default_encoding, :default_source_language, :newline_sequences, :column_kind, :external_property_file_references, :thread_flow_locations, :taxonomies, :addresses, :translations, :policies, :web_requests, :web_responses, :special_locations, :properties
+
+    def initialize(tool:, invocations: [], conversion: nil, language: "en-US", version_control_provenance: [], original_uri_base_ids: nil, artifacts: nil, logical_locations: [], graphs: [], results: nil, automation_details: nil, run_aggregates: [], baseline_guid: nil, redaction_tokens: [], default_encoding: nil, default_source_language: nil, newline_sequences: ["\r\n", "\n"], column_kind: nil, external_property_file_references: nil, thread_flow_locations: [], taxonomies: [], addresses: [], translations: [], policies: [], web_requests: [], web_responses: [], special_locations: nil, properties: nil)
+      @tool = tool
+      @invocations = invocations
+      @conversion = conversion
+      @language = language
+      @version_control_provenance = version_control_provenance
+      @original_uri_base_ids = original_uri_base_ids
+      @artifacts = artifacts
+      @logical_locations = logical_locations
+      @graphs = graphs
+      @results = results
+      @automation_details = automation_details
+      @run_aggregates = run_aggregates
+      @baseline_guid = baseline_guid
+      @redaction_tokens = redaction_tokens
+      @default_encoding = default_encoding
+      @default_source_language = default_source_language
+      @newline_sequences = newline_sequences
+      @column_kind = column_kind
+      @external_property_file_references = external_property_file_references
+      @thread_flow_locations = thread_flow_locations
+      @taxonomies = taxonomies
+      @addresses = addresses
+      @translations = translations
+      @policies = policies
+      @web_requests = web_requests
+      @web_responses = web_responses
+      @special_locations = special_locations
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["tool"] = @tool&.to_h
+      h["invocations"] = @invocations&.map(&:to_h) if @invocations&.any?
+      h["conversion"] = @conversion&.to_h unless @conversion.nil?
+      h["language"] = @language if @language && @language != "en-US"
+      h["versionControlProvenance"] = @version_control_provenance&.map(&:to_h) if @version_control_provenance&.any?
+      h["originalUriBaseIds"] = @original_uri_base_ids unless @original_uri_base_ids.nil?
+      h["artifacts"] = @artifacts&.map(&:to_h) if @artifacts&.any?
+      h["logicalLocations"] = @logical_locations&.map(&:to_h) if @logical_locations&.any?
+      h["graphs"] = @graphs&.map(&:to_h) if @graphs&.any?
+      h["results"] = @results&.map(&:to_h) if @results&.any?
+      h["automationDetails"] = @automation_details&.to_h unless @automation_details.nil?
+      h["runAggregates"] = @run_aggregates&.map(&:to_h) if @run_aggregates&.any?
+      h["baselineGuid"] = @baseline_guid unless @baseline_guid.nil?
+      h["redactionTokens"] = @redaction_tokens if @redaction_tokens&.any?
+      h["defaultEncoding"] = @default_encoding unless @default_encoding.nil?
+      h["defaultSourceLanguage"] = @default_source_language unless @default_source_language.nil?
+      h["newlineSequences"] = @newline_sequences if @newline_sequences&.any?
+      h["columnKind"] = @column_kind&.to_s unless @column_kind.nil?
+      h["externalPropertyFileReferences"] = @external_property_file_references&.to_h unless @external_property_file_references.nil?
+      h["threadFlowLocations"] = @thread_flow_locations&.map(&:to_h) if @thread_flow_locations&.any?
+      h["taxonomies"] = @taxonomies&.map(&:to_h) if @taxonomies&.any?
+      h["addresses"] = @addresses&.map(&:to_h) if @addresses&.any?
+      h["translations"] = @translations&.map(&:to_h) if @translations&.any?
+      h["policies"] = @policies&.map(&:to_h) if @policies&.any?
+      h["webRequests"] = @web_requests&.map(&:to_h) if @web_requests&.any?
+      h["webResponses"] = @web_responses&.map(&:to_h) if @web_responses&.any?
+      h["specialLocations"] = @special_locations&.to_h unless @special_locations.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(
+        tool: Tool.from_hash(h["tool"]),
+        invocations: h["invocations"]&.map { |v| Invocation.from_hash(v) } || [],
+        conversion: Conversion.from_hash(h["conversion"]),
+        language: h["language"] || "en-US",
+        version_control_provenance: h["versionControlProvenance"]&.map { |v| VersionControlDetails.from_hash(v) } || [],
+        original_uri_base_ids: h["originalUriBaseIds"],
+        artifacts: h["artifacts"]&.map { |v| Artifact.from_hash(v) },
+        logical_locations: h["logicalLocations"]&.map { |v| LogicalLocation.from_hash(v) } || [],
+        graphs: h["graphs"]&.map { |v| Graph.from_hash(v) } || [],
+        results: h["results"]&.map { |v| Result.from_hash(v) },
+        automation_details: RunAutomationDetails.from_hash(h["automationDetails"]),
+        run_aggregates: h["runAggregates"]&.map { |v| RunAutomationDetails.from_hash(v) } || [],
+        baseline_guid: h["baselineGuid"],
+        redaction_tokens: h["redactionTokens"] || [],
+        default_encoding: h["defaultEncoding"],
+        default_source_language: h["defaultSourceLanguage"],
+        newline_sequences: h.key?("newlineSequences") ? h["newlineSequences"] : ["\r\n", "\n"],
+        column_kind: h["columnKind"],
+        external_property_file_references: ExternalPropertyFileReferences.from_hash(h["externalPropertyFileReferences"]),
+        thread_flow_locations: h["threadFlowLocations"]&.map { |v| ThreadFlowLocation.from_hash(v) } || [],
+        taxonomies: h["taxonomies"]&.map { |v| ToolComponent.from_hash(v) } || [],
+        addresses: h["addresses"]&.map { |v| Address.from_hash(v) } || [],
+        translations: h["translations"]&.map { |v| ToolComponent.from_hash(v) } || [],
+        policies: h["policies"]&.map { |v| ToolComponent.from_hash(v) } || [],
+        web_requests: h["webRequests"]&.map { |v| WebRequest.from_hash(v) } || [],
+        web_responses: h["webResponses"]&.map { |v| WebResponse.from_hash(v) } || [],
+        special_locations: SpecialLocations.from_hash(h["specialLocations"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Run)
+      @tool == other.tool && @invocations == other.invocations && @conversion == other.conversion && @language == other.language && @version_control_provenance == other.version_control_provenance && @original_uri_base_ids == other.original_uri_base_ids && @artifacts == other.artifacts && @logical_locations == other.logical_locations && @graphs == other.graphs && @results == other.results && @automation_details == other.automation_details && @run_aggregates == other.run_aggregates && @baseline_guid == other.baseline_guid && @redaction_tokens == other.redaction_tokens && @default_encoding == other.default_encoding && @default_source_language == other.default_source_language && @newline_sequences == other.newline_sequences && @column_kind == other.column_kind && @external_property_file_references == other.external_property_file_references && @thread_flow_locations == other.thread_flow_locations && @taxonomies == other.taxonomies && @addresses == other.addresses && @translations == other.translations && @policies == other.policies && @web_requests == other.web_requests && @web_responses == other.web_responses && @special_locations == other.special_locations && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@tool, @invocations, @conversion, @language, @version_control_provenance, @original_uri_base_ids, @artifacts, @logical_locations, @graphs, @results, @automation_details, @run_aggregates, @baseline_guid, @redaction_tokens, @default_encoding, @default_source_language, @newline_sequences, @column_kind, @external_property_file_references, @thread_flow_locations, @taxonomies, @addresses, @translations, @policies, @web_requests, @web_responses, @special_locations, @properties].hash
+    end
+  end
+end

data/lib/sarif/run_automation_details.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Information that describes a run's identity and role within an engineering system process.
+  class RunAutomationDetails
+    attr_accessor :description, :id, :guid, :correlation_guid, :properties
+
+    def initialize(description: nil, id: nil, guid: nil, correlation_guid: nil, properties: nil)
+      @description = description
+      @id = id
+      @guid = guid
+      @correlation_guid = correlation_guid
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["description"] = @description&.to_h unless @description.nil?
+      h["id"] = @id unless @id.nil?
+      h["guid"] = @guid unless @guid.nil?
+      h["correlationGuid"] = @correlation_guid unless @correlation_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(
+        description: Message.from_hash(h["description"]),
+        id: h["id"],
+        guid: h["guid"],
+        correlation_guid: h["correlationGuid"],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(RunAutomationDetails)
+      @description == other.description && @id == other.id && @guid == other.guid && @correlation_guid == other.correlation_guid && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@description, @id, @guid, @correlation_guid, @properties].hash
+    end
+  end
+end