github_changes 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4538692d38079992fb83cdd6298a6eb3ec957bf8
-  data.tar.gz: d5c164b8b758c30849ff72f1bce55762f996dbb5
+  metadata.gz: 75ac8bcd7b3ee239aebce82f31481cc00a72efcd
+  data.tar.gz: 2b1540aeead7cf03802d5799243f4660b82df3d8
 SHA512:
-  metadata.gz: 83622b430339bf958ee60d1f1c91e655ec6ce3545ac408f2ee33999492fc047fe5e6ef4dd2870c401faed086993c6ed56e330878b09ef7c635d80a2fcffe8eca
-  data.tar.gz: 19eb80202cbc5805beeb04b1123fb56c97a50a3bd9d5ee094e8a29cfc7ecf6ccfd3db157beff608322025edb0d8900012d84d70c05b2334a4cb543886247774f
+  metadata.gz: fc177035d2ebfa2983711dde40650a77556482cfbfab681cf09f437ddb28b78d92a4aa41df8255e9c7805e3ac57002082d14367dfe5e754a60c005976c599899
+  data.tar.gz: 5ae84bb820bd71bd89c85071b2b0f5687051014f119a6d183a9299ea1368df94c402642bc288704c2bb8179bfa0aa26d89a4d223a64adcf1ffda581c6d0331ad

data/lib/changelog_generator/cli.rb

@@ -30,8 +30,9 @@ module ChangelogGenerator
     method_option :label_filter, :aliases => "-l", :type => :string
     method_option :include_pr_links, :type => :boolean
     method_option :include_issue_links, :type => :boolean
+    method_option :formatting_style, :aliases => "-s", :type => :string, :default => "slack"
     def generate()
-      generator = Generator.new(options[:user], options[:repo], options[:from_ref], options[:to_ref], options[:label_filter], options.include_pr_links?, options.include_issue_links?)
+      generator = Generator.new(options[:user], options[:repo], options[:from_ref], options[:to_ref], options[:label_filter], options.include_pr_links?, options.include_issue_links?, options[:formatting_style])
       begin
         output = generator.description + "\n\n"
         output << generator.changelog
@@ -44,4 +45,4 @@ module ChangelogGenerator
       end
     end
   end
-end
+end

data/lib/changelog_generator/generator.rb

@@ -2,6 +2,7 @@ require 'github_api'
 require 'chronic'
 require 'changelog_generator/pull_request'
 require 'changelog_generator/issue'
+require 'changelog_generator/text_formatter'
 
 module ChangelogGenerator
   class Generator
@@ -12,8 +13,9 @@ module ChangelogGenerator
     attr_accessor :label_filter
     attr_accessor :include_pr_links
     attr_accessor :include_issue_links
+    attr_accessor :formatting
 
-    def initialize(user, repo, from_ref, to_ref, label_filter = nil, include_pr_links = false, include_issue_links = false)
+    def initialize(user, repo, from_ref, to_ref, label_filter = nil, include_pr_links = false, include_issue_links = false, formatting = "slack")
       self.user = user
       self.repo_name = repo
       self.from_ref = from_ref
@@ -21,6 +23,7 @@ module ChangelogGenerator
       self.label_filter = label_filter
       self.include_pr_links = include_pr_links
       self.include_issue_links = include_issue_links
+      self.formatting = TextFormatter.text_formatter(formatting)
     end
 
     def description
@@ -39,7 +42,7 @@ module ChangelogGenerator
 
     def generate_changelog(user, repo, start_ref, end_ref, label_filter = nil)
       unless check_github_response() { github.repos.get(user, repo) }
-        abort "Unable to access repo `#{user}/#{repo}`. Please ensure correct spelling. If this repo is private you must ensure to configure me with a suitable GitHub oath token."
+        abort "Unable to access repo `#{user}/#{repo}`. Please ensure correct spelling. If this repo is private you must ensure to configure me with a suitable GitHub oauth token."
       end
 
       start_sha, start_time, end_sha = parse_references(start_ref, end_ref)
@@ -49,6 +52,7 @@ module ChangelogGenerator
 
       pulls = pull_nums.map { |p| github.pull_requests.get(user, repo, p) }
       pulls = pulls.map { |p| PullRequest.from_github_pr(p) }
+      pulls.reverse!
       # puts JSON.pretty_generate(pulls.first.body.to_hash)
 
       pulls.each do |pull|
@@ -59,19 +63,19 @@ module ChangelogGenerator
       end
 
       string = pulls.reduce("") do |memo, pull|
-        memo << "<https://github.com/#{user}/#{repo}/pull/#{pull.number}|#{pull.number}> " if include_pr_links
+        memo << pull.link_text(user, repo, self.formatting) if include_pr_links
         memo << pull.changelog_text
 
         if include_issue_links
           pull.issues.each do |issue|
-            memo << " <https://github.com/#{user}/#{repo}/issues/#{issue.number}|#{issue.number}>"
+            memo << issue.link_text(user, repo, self.formatting)
           end
         end
 
         memo << "\n"
       end
 
-      string << "\n\n"
+      string << "\n"
 
       commits = pulls.map { |p| p.head_sha[0..7] }
       connected_issue_nums = pulls.map(&:issues).flatten.map(&:number)
@@ -79,13 +83,52 @@ module ChangelogGenerator
       show_issues = show_prs && (connected_issue_nums.count > 0)
       show_both = show_prs && show_issues && (commits.count + connected_issue_nums.count <= 20)
 
-      string << "<https://github.com/#{user}/#{repo}/pulls?q=is%3Apr+#{commits.join("+")}|PRs>" if show_prs
-      string << " | <https://github.com/#{user}/#{repo}/issues?q=is%3Aissue+#{connected_issue_nums.join("+")}|Issues>" if show_issues
-      string << " | <https://github.com/#{user}/#{repo}/issues?q=#{commits.join("+")}+#{connected_issue_nums.join("+")}|Both>" if show_both
+      link_summaries = Array.new
+      if show_prs
+        link_summaries.push(summary_link(user, repo, commits, connected_issue_nums, :pr))
+      end
+      if show_issues
+        link_summaries.push(summary_link(user, repo, commits, connected_issue_nums, :issue))
+      end
+      if show_both
+        link_summaries.push(summary_link(user, repo, commits, connected_issue_nums, :both))
+      end
+
+      string << link_summaries.join(" | ")
 
       string
     end
 
+    # Generates a github search query link for PRs, issues, or both, formatted
+    # for the style which this generator was initialized with
+    # Params:
+    # +user+:: The username of the repo owner
+    # +repo+:: The name of the github repository
+    # +commits+:: The collection of commits hashes for relevant PRs
+    # +connected_issue_nums+:: The collection of issue numbers
+    # +link_type+:: The type of link we want (eg. PRs, issues, or both)
+    def summary_link(user, repo, commits, connected_issue_nums, link_type)
+      link_title = ""
+      path = ""
+      if link_type == :pr
+        link_title = "PRs"
+        path = "pulls?q=is%3Apr+#{commits.join("+")}"
+      elsif link_type == :issue
+        link_title = "Issues"
+        path = "issues?q=is%3Aissue+#{connected_issue_nums.join("+")}"
+      elsif link_type == :both
+        link_title = "Both"
+        path = "issues?q=#{commits.join("+")}+#{connected_issue_nums.join("+")}"
+      end
+
+      if self.formatting == :slack
+        return "<https://github.com/#{user}/#{repo}/#{path}|#{link_title}>"
+      elsif self.formatting == :markdown
+        return "[#{link_title}](https://github.com/#{user}/#{repo}/#{path})"
+      end
+      return ""
+    end
+
     def github
       @github ||= Github.new({ oauth_token: ENV['GITHUB_TOKEN'] })
     end

data/lib/changelog_generator/issue.rb

@@ -16,5 +16,18 @@ module ChangelogGenerator
       end
     end
 
+    # Generates a link snippet for this issue with desired text formatting
+    # Params:
+    # +user+:: The username of the repo owner
+    # +repo+:: The name of the github repository
+    # +formatting_style+:: The text formatting style symbol
+    def link_text(user, repo, formatting_style)
+      if formatting_style == :slack
+        return " <https://github.com/#{user}/#{repo}/issues/#{self.number}|##{self.number}>"
+      elsif formatting_style == :markdown
+        return " [##{self.number}](https://github.com/#{user}/#{repo}/issues/#{self.number})"
+      end
+      return ""
+    end
   end
 end

data/lib/changelog_generator/pull_request.rb

@@ -25,6 +25,20 @@ module ChangelogGenerator
       end
     end
 
+    # Generates a link snippet for this PR with desired text formatting
+    # Params:
+    # +user+:: The username of the repo owner
+    # +repo+:: The name of the github repository
+    # +formatting_style+:: The text formatting style symbol
+    def link_text(user, repo, formatting_style)
+      if formatting_style == :slack
+        return "<https://github.com/#{user}/#{repo}/pull/#{self.number}|##{self.number}> " 
+      elsif formatting_style == :markdown
+        return "[##{self.number}](https://github.com/#{user}/#{repo}/pull/#{self.number}) "
+      end
+      return ""
+    end
+
     private
 
     def self.changelog_from_pr(pr)

data/lib/changelog_generator/text_formatter.rb

@@ -0,0 +1,17 @@
+module ChangelogGenerator
+  class TextFormatter
+    # Determines the type of text formatting wanted from the provided parameter
+    # string for formatting
+    # Params:
+    # +string+:: The string representation of the text formatting desired
+    def self.text_formatter(string)
+      if string.casecmp("slack") == 0
+        return :slack
+      elsif string.casecmp("markdown") == 0 or string.casecmp("md") == 0 or string.casecmp("mkd") == 0 or string.casecmp("mdown") == 0
+        return :markdown
+      else
+        abort "Invalid formatting style provided. Available formatting options are: Slack, or Markdown"
+      end
+    end
+  end
+end

data/lib/changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module ChangelogGenerator
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_changes
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Cody Rayment
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-03 00:00:00.000000000 Z
+date: 2016-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -117,6 +117,7 @@ files:
 - lib/changelog_generator/generator.rb
 - lib/changelog_generator/issue.rb
 - lib/changelog_generator/pull_request.rb
+- lib/changelog_generator/text_formatter.rb
 - lib/changelog_generator/version.rb
 homepage: 
 licenses: []
@@ -137,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Generate Release Notes