Class: AgentsSkillVault::SyncResult

Inherits:
Data
  • Object
show all
Defined in:
lib/agents_skill_vault/sync_result.rb

Overview

Immutable result object representing the outcome of a sync operation.

Uses Ruby 3.2+ Data.define for a clean, immutable value object.

Examples:

Successful sync with changes

result = SyncResult.new(success: true, changes: true)
result.success?  # => true
result.changes?  # => true

Failed sync

result = SyncResult.new(success: false, error: "Network error")
result.success?  # => false
result.error     # => "Network error"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success:, changes: false, error: nil) ⇒ SyncResult

Creates a new SyncResult with sensible defaults.

Parameters:

  • success (Boolean) —

    Whether the sync succeeded

  • changes (Boolean) (defaults to: false) —

    Whether changes occurred (default: false)

  • error (String, nil) (defaults to: nil) —

    Error message if failed (default: nil)



34
35
36
 
# File 'lib/agents_skill_vault/sync_result.rb', line 34

def initialize(success:, changes: false, error: nil)
  super
end

Instance Attribute Details

#changes ⇒ Object (readonly)

Returns the value of attribute changes

Returns:

  • (Object) —

    the current value of changes



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/agents_skill_vault/sync_result.rb', line 27

SyncResult = Data.define(:success, :changes, :error) do
  # Creates a new SyncResult with sensible defaults.
  #
  # @param success [Boolean] Whether the sync succeeded
  # @param changes [Boolean] Whether changes occurred (default: false)
  # @param error [String, nil] Error message if failed (default: nil)
  #
  def initialize(success:, changes: false, error: nil)
    super
  end

  # @return [Boolean] Whether the sync operation succeeded
  def success? = success

  # @return [Boolean] Whether the sync resulted in changes
  def changes? = changes
end

#error ⇒ Object (readonly)

Returns the value of attribute error

Returns:

  • (Object) —

    the current value of error



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/agents_skill_vault/sync_result.rb', line 27

SyncResult = Data.define(:success, :changes, :error) do
  # Creates a new SyncResult with sensible defaults.
  #
  # @param success [Boolean] Whether the sync succeeded
  # @param changes [Boolean] Whether changes occurred (default: false)
  # @param error [String, nil] Error message if failed (default: nil)
  #
  def initialize(success:, changes: false, error: nil)
    super
  end

  # @return [Boolean] Whether the sync operation succeeded
  def success? = success

  # @return [Boolean] Whether the sync resulted in changes
  def changes? = changes
end

#success ⇒ Object (readonly)

Returns the value of attribute success

Returns:

  • (Object) —

    the current value of success



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/agents_skill_vault/sync_result.rb', line 27

SyncResult = Data.define(:success, :changes, :error) do
  # Creates a new SyncResult with sensible defaults.
  #
  # @param success [Boolean] Whether the sync succeeded
  # @param changes [Boolean] Whether changes occurred (default: false)
  # @param error [String, nil] Error message if failed (default: nil)
  #
  def initialize(success:, changes: false, error: nil)
    super
  end

  # @return [Boolean] Whether the sync operation succeeded
  def success? = success

  # @return [Boolean] Whether the sync resulted in changes
  def changes? = changes
end

Instance Method Details

#changes? ⇒ Boolean

Returns Whether the sync resulted in changes.

Returns:

  • (Boolean) —

    Whether the sync resulted in changes



42
 
# File 'lib/agents_skill_vault/sync_result.rb', line 42

def changes? = changes

#success? ⇒ Boolean

Returns Whether the sync operation succeeded.

Returns:

  • (Boolean) —

    Whether the sync operation succeeded



39
 
# File 'lib/agents_skill_vault/sync_result.rb', line 39

def success? = success