sarif-ruby 0.1.0

data/lib/sarif/invocation.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Sarif
+  # The runtime environment of the analysis tool run.
+  class Invocation
+    attr_accessor :command_line, :arguments, :response_files, :start_time_utc, :end_time_utc, :exit_code, :rule_configuration_overrides, :notification_configuration_overrides, :tool_execution_notifications, :tool_configuration_notifications, :exit_code_description, :exit_signal_name, :exit_signal_number, :process_start_failure_message, :execution_successful, :machine, :account, :process_id, :executable_location, :working_directory, :environment_variables, :stdin, :stdout, :stderr, :stdout_stderr, :properties
+
+    def initialize(command_line: nil, arguments: nil, response_files: nil, start_time_utc: nil, end_time_utc: nil, exit_code: nil, rule_configuration_overrides: [], notification_configuration_overrides: [], tool_execution_notifications: [], tool_configuration_notifications: [], exit_code_description: nil, exit_signal_name: nil, exit_signal_number: nil, process_start_failure_message: nil, execution_successful:, machine: nil, account: nil, process_id: nil, executable_location: nil, working_directory: nil, environment_variables: nil, stdin: nil, stdout: nil, stderr: nil, stdout_stderr: nil, properties: nil)
+      @command_line = command_line
+      @arguments = arguments
+      @response_files = response_files
+      @start_time_utc = start_time_utc
+      @end_time_utc = end_time_utc
+      @exit_code = exit_code
+      @rule_configuration_overrides = rule_configuration_overrides
+      @notification_configuration_overrides = notification_configuration_overrides
+      @tool_execution_notifications = tool_execution_notifications
+      @tool_configuration_notifications = tool_configuration_notifications
+      @exit_code_description = exit_code_description
+      @exit_signal_name = exit_signal_name
+      @exit_signal_number = exit_signal_number
+      @process_start_failure_message = process_start_failure_message
+      @execution_successful = execution_successful
+      @machine = machine
+      @account = account
+      @process_id = process_id
+      @executable_location = executable_location
+      @working_directory = working_directory
+      @environment_variables = environment_variables
+      @stdin = stdin
+      @stdout = stdout
+      @stderr = stderr
+      @stdout_stderr = stdout_stderr
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["commandLine"] = @command_line unless @command_line.nil?
+      h["arguments"] = @arguments if @arguments&.any?
+      h["responseFiles"] = @response_files&.map(&:to_h) if @response_files&.any?
+      h["startTimeUtc"] = @start_time_utc unless @start_time_utc.nil?
+      h["endTimeUtc"] = @end_time_utc unless @end_time_utc.nil?
+      h["exitCode"] = @exit_code unless @exit_code.nil?
+      h["ruleConfigurationOverrides"] = @rule_configuration_overrides&.map(&:to_h) if @rule_configuration_overrides&.any?
+      h["notificationConfigurationOverrides"] = @notification_configuration_overrides&.map(&:to_h) if @notification_configuration_overrides&.any?
+      h["toolExecutionNotifications"] = @tool_execution_notifications&.map(&:to_h) if @tool_execution_notifications&.any?
+      h["toolConfigurationNotifications"] = @tool_configuration_notifications&.map(&:to_h) if @tool_configuration_notifications&.any?
+      h["exitCodeDescription"] = @exit_code_description unless @exit_code_description.nil?
+      h["exitSignalName"] = @exit_signal_name unless @exit_signal_name.nil?
+      h["exitSignalNumber"] = @exit_signal_number unless @exit_signal_number.nil?
+      h["processStartFailureMessage"] = @process_start_failure_message unless @process_start_failure_message.nil?
+      h["executionSuccessful"] = @execution_successful
+      h["machine"] = @machine unless @machine.nil?
+      h["account"] = @account unless @account.nil?
+      h["processId"] = @process_id unless @process_id.nil?
+      h["executableLocation"] = @executable_location&.to_h unless @executable_location.nil?
+      h["workingDirectory"] = @working_directory&.to_h unless @working_directory.nil?
+      h["environmentVariables"] = @environment_variables unless @environment_variables.nil?
+      h["stdin"] = @stdin&.to_h unless @stdin.nil?
+      h["stdout"] = @stdout&.to_h unless @stdout.nil?
+      h["stderr"] = @stderr&.to_h unless @stderr.nil?
+      h["stdoutStderr"] = @stdout_stderr&.to_h unless @stdout_stderr.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(
+        command_line: h["commandLine"],
+        arguments: h["arguments"],
+        response_files: h["responseFiles"]&.map { |v| ArtifactLocation.from_hash(v) },
+        start_time_utc: h["startTimeUtc"],
+        end_time_utc: h["endTimeUtc"],
+        exit_code: h["exitCode"],
+        rule_configuration_overrides: h["ruleConfigurationOverrides"]&.map { |v| ConfigurationOverride.from_hash(v) } || [],
+        notification_configuration_overrides: h["notificationConfigurationOverrides"]&.map { |v| ConfigurationOverride.from_hash(v) } || [],
+        tool_execution_notifications: h["toolExecutionNotifications"]&.map { |v| Notification.from_hash(v) } || [],
+        tool_configuration_notifications: h["toolConfigurationNotifications"]&.map { |v| Notification.from_hash(v) } || [],
+        exit_code_description: h["exitCodeDescription"],
+        exit_signal_name: h["exitSignalName"],
+        exit_signal_number: h["exitSignalNumber"],
+        process_start_failure_message: h["processStartFailureMessage"],
+        execution_successful: h["executionSuccessful"],
+        machine: h["machine"],
+        account: h["account"],
+        process_id: h["processId"],
+        executable_location: ArtifactLocation.from_hash(h["executableLocation"]),
+        working_directory: ArtifactLocation.from_hash(h["workingDirectory"]),
+        environment_variables: h["environmentVariables"],
+        stdin: ArtifactLocation.from_hash(h["stdin"]),
+        stdout: ArtifactLocation.from_hash(h["stdout"]),
+        stderr: ArtifactLocation.from_hash(h["stderr"]),
+        stdout_stderr: ArtifactLocation.from_hash(h["stdoutStderr"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Invocation)
+      @command_line == other.command_line && @arguments == other.arguments && @response_files == other.response_files && @start_time_utc == other.start_time_utc && @end_time_utc == other.end_time_utc && @exit_code == other.exit_code && @rule_configuration_overrides == other.rule_configuration_overrides && @notification_configuration_overrides == other.notification_configuration_overrides && @tool_execution_notifications == other.tool_execution_notifications && @tool_configuration_notifications == other.tool_configuration_notifications && @exit_code_description == other.exit_code_description && @exit_signal_name == other.exit_signal_name && @exit_signal_number == other.exit_signal_number && @process_start_failure_message == other.process_start_failure_message && @execution_successful == other.execution_successful && @machine == other.machine && @account == other.account && @process_id == other.process_id && @executable_location == other.executable_location && @working_directory == other.working_directory && @environment_variables == other.environment_variables && @stdin == other.stdin && @stdout == other.stdout && @stderr == other.stderr && @stdout_stderr == other.stdout_stderr && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@command_line, @arguments, @response_files, @start_time_utc, @end_time_utc, @exit_code, @rule_configuration_overrides, @notification_configuration_overrides, @tool_execution_notifications, @tool_configuration_notifications, @exit_code_description, @exit_signal_name, @exit_signal_number, @process_start_failure_message, @execution_successful, @machine, @account, @process_id, @executable_location, @working_directory, @environment_variables, @stdin, @stdout, @stderr, @stdout_stderr, @properties].hash
+    end
+  end
+end

data/lib/sarif/location.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A location within a programming artifact.
+  class Location
+    attr_accessor :id, :physical_location, :logical_locations, :message, :annotations, :relationships, :properties
+
+    def initialize(id: -1, physical_location: nil, logical_locations: [], message: nil, annotations: [], relationships: [], properties: nil)
+      @id = id
+      @physical_location = physical_location
+      @logical_locations = logical_locations
+      @message = message
+      @annotations = annotations
+      @relationships = relationships
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["id"] = @id if @id && @id != -1
+      h["physicalLocation"] = @physical_location&.to_h unless @physical_location.nil?
+      h["logicalLocations"] = @logical_locations&.map(&:to_h) if @logical_locations&.any?
+      h["message"] = @message&.to_h unless @message.nil?
+      h["annotations"] = @annotations&.map(&:to_h) if @annotations&.any?
+      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"] || -1,
+        physical_location: PhysicalLocation.from_hash(h["physicalLocation"]),
+        logical_locations: h["logicalLocations"]&.map { |v| LogicalLocation.from_hash(v) } || [],
+        message: Message.from_hash(h["message"]),
+        annotations: h["annotations"]&.map { |v| Region.from_hash(v) } || [],
+        relationships: h["relationships"]&.map { |v| LocationRelationship.from_hash(v) } || [],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Location)
+      @id == other.id && @physical_location == other.physical_location && @logical_locations == other.logical_locations && @message == other.message && @annotations == other.annotations && @relationships == other.relationships && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@id, @physical_location, @logical_locations, @message, @annotations, @relationships, @properties].hash
+    end
+  end
+end

data/lib/sarif/location_relationship.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Information about the relation of one location to another.
+  class LocationRelationship
+    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
+      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: 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?(LocationRelationship)
+      @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/log.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Static Analysis Results Format (SARIF) Version 2.1.0 JSON Schema: a standard format for the output of static analysis tools.
+  class Log
+    attr_accessor :schema_uri, :version, :runs, :inline_external_properties, :properties
+
+    def initialize(schema_uri: nil, version:, runs:, inline_external_properties: nil, properties: nil)
+      @schema_uri = schema_uri
+      @version = version
+      @runs = runs
+      @inline_external_properties = inline_external_properties
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["$schema"] = @schema_uri unless @schema_uri.nil?
+      h["version"] = @version&.to_s
+      h["runs"] = @runs&.map(&:to_h)
+      h["inlineExternalProperties"] = @inline_external_properties&.map(&:to_h) if @inline_external_properties&.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(
+        schema_uri: h["$schema"],
+        version: h["version"],
+        runs: h["runs"]&.map { |v| Run.from_hash(v) },
+        inline_external_properties: h["inlineExternalProperties"]&.map { |v| ExternalProperties.from_hash(v) },
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Log)
+      @schema_uri == other.schema_uri && @version == other.version && @runs == other.runs && @inline_external_properties == other.inline_external_properties && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@schema_uri, @version, @runs, @inline_external_properties, @properties].hash
+    end
+  end
+end

data/lib/sarif/logical_location.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A logical location of a construct that produced a result.
+  class LogicalLocation
+    attr_accessor :name, :index, :fully_qualified_name, :decorated_name, :parent_index, :kind, :properties
+
+    def initialize(name: nil, index: -1, fully_qualified_name: nil, decorated_name: nil, parent_index: -1, kind: nil, properties: nil)
+      @name = name
+      @index = index
+      @fully_qualified_name = fully_qualified_name
+      @decorated_name = decorated_name
+      @parent_index = parent_index
+      @kind = kind
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["name"] = @name unless @name.nil?
+      h["index"] = @index if @index && @index != -1
+      h["fullyQualifiedName"] = @fully_qualified_name unless @fully_qualified_name.nil?
+      h["decoratedName"] = @decorated_name unless @decorated_name.nil?
+      h["parentIndex"] = @parent_index if @parent_index && @parent_index != -1
+      h["kind"] = @kind unless @kind.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,
+        fully_qualified_name: h["fullyQualifiedName"],
+        decorated_name: h["decoratedName"],
+        parent_index: h["parentIndex"] || -1,
+        kind: h["kind"],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(LogicalLocation)
+      @name == other.name && @index == other.index && @fully_qualified_name == other.fully_qualified_name && @decorated_name == other.decorated_name && @parent_index == other.parent_index && @kind == other.kind && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@name, @index, @fully_qualified_name, @decorated_name, @parent_index, @kind, @properties].hash
+    end
+  end
+end

data/lib/sarif/message.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Encapsulates a message intended to be read by the end user.
+  class Message
+    attr_accessor :text, :markdown, :id, :arguments, :properties
+
+    def initialize(text: nil, markdown: nil, id: nil, arguments: [], properties: nil)
+      @text = text
+      @markdown = markdown
+      @id = id
+      @arguments = arguments
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["text"] = @text unless @text.nil?
+      h["markdown"] = @markdown unless @markdown.nil?
+      h["id"] = @id unless @id.nil?
+      h["arguments"] = @arguments if @arguments&.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(
+        text: h["text"],
+        markdown: h["markdown"],
+        id: h["id"],
+        arguments: h["arguments"] || [],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Message)
+      @text == other.text && @markdown == other.markdown && @id == other.id && @arguments == other.arguments && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@text, @markdown, @id, @arguments, @properties].hash
+    end
+  end
+end

data/lib/sarif/multiformat_message_string.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A message string or message format string rendered in multiple formats.
+  class MultiformatMessageString
+    attr_accessor :text, :markdown, :properties
+
+    def initialize(text:, markdown: nil, properties: nil)
+      @text = text
+      @markdown = markdown
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["text"] = @text
+      h["markdown"] = @markdown unless @markdown.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(
+        text: h["text"],
+        markdown: h["markdown"],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(MultiformatMessageString)
+      @text == other.text && @markdown == other.markdown && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@text, @markdown, @properties].hash
+    end
+  end
+end

data/lib/sarif/node.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Represents a node in a graph.
+  class Node
+    attr_accessor :id, :label, :location, :children, :properties
+
+    def initialize(id:, label: nil, location: nil, children: [], properties: nil)
+      @id = id
+      @label = label
+      @location = location
+      @children = children
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["id"] = @id
+      h["label"] = @label&.to_h unless @label.nil?
+      h["location"] = @location&.to_h unless @location.nil?
+      h["children"] = @children&.map(&:to_h) if @children&.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"],
+        label: Message.from_hash(h["label"]),
+        location: Location.from_hash(h["location"]),
+        children: h["children"]&.map { |v| Node.from_hash(v) } || [],
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Node)
+      @id == other.id && @label == other.label && @location == other.location && @children == other.children && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@id, @label, @location, @children, @properties].hash
+    end
+  end
+end

data/lib/sarif/notification.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.
+  class Notification
+    attr_accessor :locations, :message, :level, :thread_id, :time_utc, :exception, :descriptor, :associated_rule, :properties
+
+    def initialize(locations: [], message:, level: "warning", thread_id: nil, time_utc: nil, exception: nil, descriptor: nil, associated_rule: nil, properties: nil)
+      @locations = locations
+      @message = message
+      @level = level
+      @thread_id = thread_id
+      @time_utc = time_utc
+      @exception = exception
+      @descriptor = descriptor
+      @associated_rule = associated_rule
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["locations"] = @locations&.map(&:to_h) if @locations&.any?
+      h["message"] = @message&.to_h
+      h["level"] = @level&.to_s if @level && @level != "warning"
+      h["threadId"] = @thread_id unless @thread_id.nil?
+      h["timeUtc"] = @time_utc unless @time_utc.nil?
+      h["exception"] = @exception&.to_h unless @exception.nil?
+      h["descriptor"] = @descriptor&.to_h unless @descriptor.nil?
+      h["associatedRule"] = @associated_rule&.to_h unless @associated_rule.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(
+        locations: h["locations"]&.map { |v| Location.from_hash(v) } || [],
+        message: Message.from_hash(h["message"]),
+        level: h["level"] || "warning",
+        thread_id: h["threadId"],
+        time_utc: h["timeUtc"],
+        exception: Exception.from_hash(h["exception"]),
+        descriptor: ReportingDescriptorReference.from_hash(h["descriptor"]),
+        associated_rule: ReportingDescriptorReference.from_hash(h["associatedRule"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Notification)
+      @locations == other.locations && @message == other.message && @level == other.level && @thread_id == other.thread_id && @time_utc == other.time_utc && @exception == other.exception && @descriptor == other.descriptor && @associated_rule == other.associated_rule && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@locations, @message, @level, @thread_id, @time_utc, @exception, @descriptor, @associated_rule, @properties].hash
+    end
+  end
+end

data/lib/sarif/physical_location.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sarif
+  # A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.
+  class PhysicalLocation
+    attr_accessor :address, :artifact_location, :region, :context_region, :properties
+
+    def initialize(address: nil, artifact_location: nil, region: nil, context_region: nil, properties: nil)
+      @address = address
+      @artifact_location = artifact_location
+      @region = region
+      @context_region = context_region
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["address"] = @address&.to_h unless @address.nil?
+      h["artifactLocation"] = @artifact_location&.to_h unless @artifact_location.nil?
+      h["region"] = @region&.to_h unless @region.nil?
+      h["contextRegion"] = @context_region&.to_h unless @context_region.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(
+        address: Address.from_hash(h["address"]),
+        artifact_location: ArtifactLocation.from_hash(h["artifactLocation"]),
+        region: Region.from_hash(h["region"]),
+        context_region: Region.from_hash(h["contextRegion"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(PhysicalLocation)
+      @address == other.address && @artifact_location == other.artifact_location && @region == other.region && @context_region == other.context_region && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@address, @artifact_location, @region, @context_region, @properties].hash
+    end
+  end
+end

data/lib/sarif/property_bag.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Key/value pairs that provide additional information about the object.
+  class PropertyBag
+    attr_accessor :tags
+
+    def initialize(tags: [])
+      @tags = tags
+    end
+
+    def to_h
+      h = {}
+      h["tags"] = @tags if @tags&.any?
+      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(
+        tags: h["tags"] || []
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(PropertyBag)
+      @tags == other.tags
+    end
+
+    alias eql? ==
+
+    def hash
+      [@tags].hash
+    end
+  end
+end