Class: Docsmith::Events::Event

Inherits:
Struct
  • Object
show all
Defined in:
lib/docsmith/events/event.rb

Overview

Immutable payload for all Docsmith events. Fields on every event: record, document, version, author. Extra fields by event:

version_restored → from_version
version_tagged   → tag_name
comment_added/orphaned → comment  (Phase 3)
branch_created/merged  → branch   (Phase 4)

Instance Attribute Summary collapse

Instance Attribute Details

#author ⇒ Object

Returns the value of attribute author

Returns:

  • (Object) —

    the current value of author



12
13
14
 
# File 'lib/docsmith/events/event.rb', line 12

def author
  @author
end

#branch ⇒ Object

Returns the value of attribute branch

Returns:

  • (Object) —

    the current value of branch



12
13
14
 
# File 'lib/docsmith/events/event.rb', line 12

def branch
  @branch
end

#comment ⇒ Object

Returns the value of attribute comment

Returns:

  • (Object) —

    the current value of comment



12
13
14
 
# File 'lib/docsmith/events/event.rb', line 12

def comment
  @comment
end

#conflicts ⇒ Object

Returns the value of attribute conflicts

Returns:

  • (Object) —

    the current value of conflicts



12
13
14
 
# File 'lib/docsmith/events/event.rb', line 12

def conflicts
  @conflicts
end

#document ⇒ Object

Returns the value of attribute document

Returns:

  • (Object) —

    the current value of document



12
13
14
 
# File 'lib/docsmith/events/event.rb', line 12

def document
  @document
end

#from_version ⇒ Object

Returns the value of attribute from_version

Returns:

  • (Object) —

    the current value of from_version



12
13
14
 
# File 'lib/docsmith/events/event.rb', line 12

def from_version
  @from_version
end

#merge_result ⇒ Object

Returns the value of attribute merge_result

Returns:

  • (Object) —

    the current value of merge_result



12
13
14
 
# File 'lib/docsmith/events/event.rb', line 12

def merge_result
  @merge_result
end

#record ⇒ Object

Returns the value of attribute record

Returns:

  • (Object) —

    the current value of record



12
13
14
 
# File 'lib/docsmith/events/event.rb', line 12

def record
  @record
end

#tag_name ⇒ Object

Returns the value of attribute tag_name

Returns:

  • (Object) —

    the current value of tag_name



12
13
14
 
# File 'lib/docsmith/events/event.rb', line 12

def tag_name
  @tag_name
end

#version ⇒ Object

Returns the value of attribute version

Returns:

  • (Object) —

    the current value of version



12
13
14
 
# File 'lib/docsmith/events/event.rb', line 12

def version
  @version
end