Class: PlanMyStuff::CommentMetadata

Inherits:
BaseMetadata show all
Defined in:
lib/plan_my_stuff/comment_metadata.rb

Constant Summary collapse

LEGACY_URL_REGEXES = 
[
  %r{\Ahttps://raw\.githubusercontent\.com/(?<owner>[^/\s]+)/(?<repo>[^/\s]+)/(?<sha>[^/\s]+)/(?<path>.+)\z},
  %r{\Ahttps://github\.com/(?<owner>[^/\s]+)/(?<repo>[^/\s]+)/blob/(?<sha>[^/\s]+)/(?<path>.+)\z},
].freeze
LEGACY_ATTACHMENT_DEPRECATION_MESSAGE = 
'PlanMyStuff: legacy attachment metadata shape {filename, url} detected. It will continue to parse ' \
'until 1.0.0, at which point legacy detection will be removed. New writes use the structured ' \
'{filename, owner, repo, sha, path} shape introduced in #70; existing entries migrate on their ' \
'next write.'

Constants inherited from BaseMetadata

BaseMetadata::SCHEMA_VERSION

Instance Attribute Summary collapse

Attributes inherited from BaseMetadata

#app_name, #created_by, #custom_fields, #gem_version, #rails_env, #schema_version, #visibility

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseMetadata

#internal?, #public?, #to_json, #validate_custom_fields!

Constructor Details

#initialize ⇒ CommentMetadata

Returns a new instance of CommentMetadata.



63
64
65
66
67
 
# File 'lib/plan_my_stuff/comment_metadata.rb', line 63

def initialize
  super
  @issue_body = false
  @attachments = []
end

Instance Attribute Details

#attachments ⇒ Array<PlanMyStuff::Attachment>

Returns consuming-app attachment records associated with this comment.

Returns:



19
20
21
 
# File 'lib/plan_my_stuff/comment_metadata.rb', line 19

def attachments
  @attachments
end

#issue_body ⇒ Boolean

Returns true if this comment holds the issue’s body content.

Returns:

  • (Boolean) —

    true if this comment holds the issue’s body content



17
18
19
 
# File 'lib/plan_my_stuff/comment_metadata.rb', line 17

def issue_body
  @issue_body
end

Class Method Details

.build(user:, visibility: 'internal', custom_fields: {}, issue_body: false, attachments: []) ⇒ CommentMetadata

Builds a new CommentMetadata for comment creation, auto-filling gem defaults

Parameters:

  • user (Object, Integer) —

    user object or user_id

  • visibility (String) (defaults to: 'internal') —

    “public” or “internal”

  • custom_fields (Hash) (defaults to: {}) —

    app-defined field values

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

    whether this comment holds the issue body

  • attachments (Array<Hash, PlanMyStuff::Attachment>) (defaults to: []) —

    consuming-app attachment records

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/plan_my_stuff/comment_metadata.rb', line 47

def build(user:, visibility: 'internal', custom_fields: {}, issue_body: false, attachments: [])
  metadata = new
  apply_common_build(
    metadata,
    user: user,
    visibility: visibility,
    custom_fields_data: custom_fields,
    custom_fields_schema: PlanMyStuff.configuration.custom_fields_for(:comment),
  )
  metadata.issue_body = issue_body
  metadata.attachments = attachments

  metadata
end

.from_hash(hash) ⇒ CommentMetadata

Builds a CommentMetadata from a parsed hash (e.g. from MetadataParser)

Parameters:

  • hash (Hash)

Returns:



28
29
30
31
32
33
34
35
 
# File 'lib/plan_my_stuff/comment_metadata.rb', line 28

def from_hash(hash)
  metadata = new
  apply_common_from_hash(metadata, hash, PlanMyStuff.configuration.custom_fields_for(:comment))
  metadata.issue_body = hash[:issue_body] || false
  metadata.attachments = hash[:attachments]

  metadata
end

Instance Method Details

#issue_body? ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/plan_my_stuff/comment_metadata.rb', line 81

def issue_body?
  issue_body == true
end

#to_h ⇒ Hash

Returns:

  • (Hash) 


86
87
88
89
90
91
 
# File 'lib/plan_my_stuff/comment_metadata.rb', line 86

def to_h
  super.merge(
    issue_body: issue_body,
    attachments: attachments.map(&:to_h),
  )
end