Class: Gitlab::GithubImport::Representation::Issue

Inherits:
Object
  • Object
show all
Includes:
ExposeAttribute, ToHash
Defined in:
lib/gitlab/github_import/representation/issue.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ExposeAttribute

#[]

Methods included from ToHash

#convert_value_for_to_hash, #to_hash

Constructor Details

#initialize(attributes) ⇒ Issue

attributes - A hash containing the raw issue details. The keys of this

Hash (and any nested hashes) must be symbols.


59
60
61
# File 'lib/gitlab/github_import/representation/issue.rb', line 59

def initialize(attributes)
  @attributes = attributes
end

Instance Attribute Details

#attributesObject (readonly)

Returns the value of attribute attributes.



10
11
12
# File 'lib/gitlab/github_import/representation/issue.rb', line 10

def attributes
  @attributes
end

Class Method Details

.from_api_response(issue, additional_data = {}) ⇒ Object

Builds an issue from a GitHub API response.

issue - An instance of ‘Hash` containing the issue

details.


20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/gitlab/github_import/representation/issue.rb', line 20

def self.from_api_response(issue, additional_data = {})
  user =
    if issue[:user]
      Representation::User.from_api_response(issue[:user])
    end

  hash = {
    iid: issue[:number],
    title: issue[:title],
    description: issue[:body],
    milestone_number: issue.dig(:milestone, :number),
    state: issue[:state] == 'open' ? :opened : :closed,
    assignees: issue[:assignees].map do |u|
      Representation::User.from_api_response(u)
    end,
    label_names: issue[:labels].map { _1[:name] },
    author: user,
    created_at: issue[:created_at],
    updated_at: issue[:updated_at],
    pull_request: issue[:pull_request] ? true : false,
    work_item_type_id: additional_data[:work_item_type_id]
  }

  new(hash)
end

.from_json_hash(raw_hash) ⇒ Object

Builds a new issue using a Hash that was built from a JSON payload.



47
48
49
50
51
52
53
54
55
# File 'lib/gitlab/github_import/representation/issue.rb', line 47

def self.from_json_hash(raw_hash)
  hash = Representation.symbolize_hash(raw_hash)

  hash[:state] = hash[:state].to_sym
  hash[:assignees].map! { |u| Representation::User.from_json_hash(u) }
  hash[:author] &&= Representation::User.from_json_hash(hash[:author])

  new(hash)
end

Instance Method Details

#github_identifiersObject



79
80
81
82
83
84
85
# File 'lib/gitlab/github_import/representation/issue.rb', line 79

def github_identifiers
  {
    iid: iid,
    issuable_type: issuable_type,
    title: title
  }
end

#issuable_typeObject



75
76
77
# File 'lib/gitlab/github_import/representation/issue.rb', line 75

def issuable_type
  pull_request? ? 'MergeRequest' : 'Issue'
end

#labels?Boolean

Returns:

  • (Boolean)


67
68
69
# File 'lib/gitlab/github_import/representation/issue.rb', line 67

def labels?
  label_names && label_names.any?
end

#pull_request?Boolean

Returns:

  • (Boolean)


71
72
73
# File 'lib/gitlab/github_import/representation/issue.rb', line 71

def pull_request?
  attributes[:pull_request]
end

#truncated_titleObject



63
64
65
# File 'lib/gitlab/github_import/representation/issue.rb', line 63

def truncated_title
  title.truncate(255)
end