Class: GitHubChangelogGenerator::Parser

Inherits:
Object
  • Object
show all
Defined in:
lib/github_changelog_generator/parser.rb

Class Method Summary collapse

Class Method Details

.parse_optionsObject



8
9
10
11
12
13
14
15
16
17
18
19
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/github_changelog_generator/parser.rb', line 8

def self.parse_options
  options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* ', :author => true, :pull_request_labels => nil, :filter_issues_by_milestone => true, :compare_link => true}

  parser = OptionParser.new { |opts|
    opts.banner = 'Usage: changelog_generator [options]'
    opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
      options[:user] = last
    end
    opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
      options[:project] = last
    end
    opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new') do |last|
      options[:token] = last
    end
    opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
      options[:format] = last
    end
    opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
      options[:output] = last
    end
    opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
      options[:verbose] = v
    end
    opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
      options[:issues] = v
    end
    opts.on('--[no-]issues-without-labels', 'Include closed issues without any labels to changelog. Default is true') do |v|
      options[:add_issues_wo_labels] = v
    end
    opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
      options[:pulls] = v
    end
    opts.on('--[no-]filter-issues-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
      options[:filter_issues_by_milestone] = last
    end
    opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
      options[:last] = author
    end
    opts.on('--[no-]compare-link', 'Include compare link between older version and newer version. Default is true') do |v|
      options[:compare_link] = v
    end
    opts.on('--labels  x,y,z', Array, 'Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
      options[:labels] = list
    end
    opts.on('--labels-pr x,y,z', Array, 'Only pull requests with specified labels will be included to changelog. Default is nil') do |list|
      options[:pull_request_labels] = list
    end
    opts.on('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
      options[:github_site] = last
    end
    opts.on('--github-api [URL]', 'The enterprise endpoint to use for your Github API.') do |last|
      options[:github_endpoint] = last
    end
    opts.on('-v', '--version', 'Print version number') do |v|
      puts "Version: #{GitHubChangelogGenerator::VERSION}"
      exit
    end
    opts.on('-h', '--help', 'Displays Help') do
      puts opts
      exit
    end
  }

  parser.parse!

  if ARGV[0] && !ARGV[1]
    github_site = options[:github_site] ? options[:github_site] : 'github.com'
    # this match should parse https://github.com/skywinder/Github-Changelog-Generator and skywinder/Github-Changelog-Generator to user and name
    match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])

    if match[2].nil?
      exit
    else
      options[:user] = match[1]
      options[:project]= match[2]
    end
  end

  if !options[:user] && !options[:project]
    remote = `git remote -vv`.split("\n")
    match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)?(?:\.git).*/.match(remote[0])

    if match && match[1] && match[2]
      puts "Detected user:#{match[1]}, project:#{match[2]}"
      options[:user], options[:project] = match[1], match[2]
    end
  end


  if !options[:user] || !options[:project]
    puts parser.banner
    exit
  end

  if ARGV[1]
    options[:tag1] = ARGV[0]
    options[:tag2] = ARGV[1]
  end

  options
end