github_changelog_generator 1.4.1 → 1.5.0

data/lib/github_changelog_generator/generator/generator_tags.rb

@@ -0,0 +1,70 @@
+module GitHubChangelogGenerator
+  class Generator
+    # fetch, filter tags, fetch dates and sort them in time order
+    def fetch_and_filter_tags
+      @all_tags = get_filtered_tags(@fetcher.get_all_tags)
+      fetch_tags_dates
+      sort_tags_by_date
+    end
+
+    # Sort all tags by date
+    def sort_tags_by_date
+      puts "Sorting tags..." if @options[:verbose]
+      @all_tags.sort_by! { |x| @fetcher.get_time_of_tag(x) }.reverse!
+    end
+
+    # Detect link, name and time for specified tag.
+    #
+    # @param [Hash] newer_tag newer tag. Can be nil, if it's Unreleased section.
+    # @return [Array] link, name and time of the tag
+    def detect_link_tag_time(newer_tag)
+      # if tag is nil - set current time
+      newer_tag_time = newer_tag.nil? ? Time.new : @fetcher.get_time_of_tag(newer_tag)
+
+      # if it's future release tag - set this value
+      if newer_tag.nil? && @options[:future_release]
+        newer_tag_name = @options[:future_release]
+        newer_tag_link = @options[:future_release]
+      else
+        # put unreleased label if there is no name for the tag
+        newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
+        newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
+      end
+      [newer_tag_link, newer_tag_name, newer_tag_time]
+    end
+
+    # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
+    #
+    # @return [Array]
+    def get_filtered_tags(all_tags)
+      filtered_tags = filter_between_tags(all_tags)
+      filter_excluded_tags(filtered_tags)
+    end
+
+    def filter_between_tags(all_tags)
+      filtered_tags = all_tags
+      if @options[:between_tags]
+        @options[:between_tags].each do |tag|
+          unless all_tags.include? tag
+            puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
+          end
+        end
+        filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag }
+      end
+      filtered_tags
+    end
+
+    def filter_excluded_tags(all_tags)
+      filtered_tags = all_tags
+      if @options[:exclude_tags]
+        @options[:exclude_tags].each do |tag|
+          unless all_tags.include? tag
+            puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
+          end
+        end
+        filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag }
+      end
+      filtered_tags
+    end
+  end
+end

data/lib/github_changelog_generator/parser.rb

@@ -5,34 +5,32 @@ require_relative "version"
 
 module GitHubChangelogGenerator
   class Parser
+    # parse options with optparse
     def self.parse_options
-      options = {
-        tag1: nil,
-        tag2: nil,
-        dateformat: "%Y-%m-%d",
-        output: "CHANGELOG.md",
-        issues: true,
-        add_issues_wo_labels: true,
-        add_pr_wo_labels: true,
-        pulls: true,
-        filter_issues_by_milestone: true,
-        author: true,
-        unreleased: true,
-        unreleased_label: "Unreleased",
-        compare_link: true,
-        include_labels: %w(bug enhancement),
-        exclude_labels: %w(duplicate question invalid wontfix),
-        max_issues: nil,
-        simple_list: false,
-        verbose: true,
+      options = get_default_options
 
-        merge_prefix: "**Merged pull requests:**",
-        issue_prefix: "**Closed issues:**",
-        bug_prefix: "**Fixed bugs:**",
-        enhancement_prefix: "**Implemented enhancements:**",
-        branch: "origin"
-      }
+      parser = setup_parser(options)
+
+      parser.parse!
+
+      detect_user_and_project(options)
+
+      if !options[:user] || !options[:project]
+        puts parser.banner
+        exit
+      end
+
+      if options[:verbose]
+        puts "Performing task with options:"
+        pp options
+        puts ""
+      end
+
+      options
+    end
 
+    # setup parsing options
+    def self.setup_parser(options)
       parser = OptionParser.new do |opts|
         opts.banner = "Usage: github_changelog_generator [options]"
         opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
@@ -45,7 +43,7 @@ module GitHubChangelogGenerator
           options[:token] = last
         end
         opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
-          options[:dateformat] = last
+          options[:date_format] = last
         end
         opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
           options[:output] = last
@@ -86,6 +84,12 @@ module GitHubChangelogGenerator
         opts.on("--exclude-labels  x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
           options[:exclude_labels] = list
         end
+        opts.on("--between-tags  x,y,z", Array, "Change log will be filled only between specified tags") do |list|
+          options[:between_tags] = list
+        end
+        opts.on("--exclude-tags  x,y,z", Array, "Change log will be exclude specified tags") do |list|
+          options[:exclude_tags] = list
+        end
         opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
           options[:max_issues] = max
         end
@@ -113,79 +117,120 @@ module GitHubChangelogGenerator
           exit
         end
       end
+      parser
+    end
 
-      parser.parse!
+    # just get default options
+    def self.get_default_options
+      options = {
+        tag1: nil,
+        tag2: nil,
+        date_format: "%Y-%m-%d",
+        output: "CHANGELOG.md",
+        issues: true,
+        add_issues_wo_labels: true,
+        add_pr_wo_labels: true,
+        pulls: true,
+        filter_issues_by_milestone: true,
+        author: true,
+        unreleased: true,
+        unreleased_label: "Unreleased",
+        compare_link: true,
+        include_labels: %w(bug enhancement),
+        exclude_labels: %w(duplicate question invalid wontfix),
+        max_issues: nil,
+        simple_list: false,
+        verbose: true,
+        merge_prefix: "**Merged pull requests:**",
+        issue_prefix: "**Closed issues:**",
+        bug_prefix: "**Fixed bugs:**",
+        enhancement_prefix: "**Implemented enhancements:**",
+        git_remote: "origin"
+      }
 
-      detect_user_and_project(options)
+      options
+    end
 
+    # Detects user and project from git
+    def self.detect_user_and_project(options)
+      options[:user], options[:project] = user_project_from_option(ARGV[0], ARGV[1], options[:github_site])
       if !options[:user] || !options[:project]
-        puts parser.banner
-        exit
-      end
-
-      if ARGV[1]
-        options[:tag1] = ARGV[0]
-        options[:tag2] = ARGV[1]
-      end
-
-      if options[:verbose]
-        puts "Performing task with options:"
-        pp options
-        puts ""
+        if ENV["RUBYLIB"] =~ /ruby-debug-ide/
+          options[:user] = "skywinder"
+          options[:project] = "changelog_test"
+        else
+          remote = `git config --get remote.#{options[:git_remote]}.url`
+          options[:user], options[:project] = user_project_from_remote(remote)
+        end
       end
-
-      options
     end
 
-    def self.detect_user_and_project(options)
-      if ARGV[0] && !ARGV[1]
-        github_site = options[:github_site] ? options[:github_site] : "github.com"
+    # Try to find user and project name from git remote output
+    #
+    # @param [String] output of git remote command
+    # @return [Array] user and project
+    def self.user_project_from_option(arg0, arg1, github_site = nil)
+      user = nil
+      project = nil
+      github_site ||= "github.com"
+      if arg0 && !arg1
         # this match should parse  strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
-        match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
+        puts arg0
+        match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
 
         begin
           param = match[2].nil?
         rescue
-          puts "Can't detect user and name from first parameter: '#{ARGV[0]}' -> exit'"
+          puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
           exit
         end
         if param
           exit
         else
-          options[:user] = match[1]
-          options[:project] = match[2]
+          user = match[1]
+          project = match[2]
         end
-
       end
+      [user, project]
+    end
 
-      if !options[:user] && !options[:project]
-        if ENV["RUBYLIB"] =~ /ruby-debug-ide/
-          options[:user] = "skywinder"
-          options[:project] = "changelog_test"
-        else
-          remote = `git config --get remote.#{options[:branch]}.url`
-          # try to find repo in format:
-          # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
-          # git@github.com:skywinder/Github-Changelog-Generator.git
-          match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/.match(remote)
-
-          if match && match[1] && match[2]
-            puts "Detected user:#{match[1]}, project:#{match[2]}"
-            options[:user] = match[1]
-            options[:project] = match[2]
-          else
-            # try to find repo in format:
-            # origin	https://github.com/skywinder/ChangelogMerger (fetch)
-            # https://github.com/skywinder/ChangelogMerger
-            match = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/.match(remote)
-            if match && match[1] && match[2]
-              puts "Detected user:#{match[1]}, project:#{match[2]}"
-              options[:user] = match[1]
-              options[:project] = match[2]
-            end
-          end
+    # Try to find user and project name from git remote output
+    #
+    # @param [String] output of git remote command
+    # @return [Array] user and project
+    def self.user_project_from_remote(remote)
+      # try to find repo in format:
+      # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
+      # git@github.com:skywinder/Github-Changelog-Generator.git
+      regex1 = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/
+
+      # try to find repo in format:
+      # origin	https://github.com/skywinder/ChangelogMerger (fetch)
+      # https://github.com/skywinder/ChangelogMerger
+      regex2 = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/
+
+      remote_structures = [regex1, regex2]
+
+      user = nil
+      project = nil
+      remote_structures.each do |regex|
+        matches = Regexp.new(regex).match(remote)
+
+        if matches && matches[1] && matches[2]
+          puts "Detected user:#{matches[1]}, project:#{matches[2]}"
+          user = matches[1]
+          project = matches[2]
         end
+
+        break unless matches.nil?
       end
+
+      [user, project]
     end
   end
+
+  if __FILE__ == $PROGRAM_NAME
+    remote = "invalid reference to project"
+    p user_project_from_option(ARGV[0], ARGV[1], remote)
+  end
 end

data/lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/spec/unit/generator/generator_tags_spec.rb

@@ -0,0 +1,69 @@
+describe GitHubChangelogGenerator::Generator do
+  describe "#filter_between_tags" do
+    context "when between_tags nil" do
+      before do
+        @generator = GitHubChangelogGenerator::Generator.new(between_tags: nil)
+      end
+
+      subject do
+        @generator.get_filtered_tags(%w(1 2 3))
+      end
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(%w(1 2 3)) }
+    end
+    context "when between_tags same as input array" do
+      before do
+        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3))
+      end
+      subject do
+        @generator.get_filtered_tags(%w(1 2 3))
+      end
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(%w(1 2 3)) }
+    end
+
+    context "when between_tags filled with correct values" do
+      before do
+        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
+      end
+      subject do
+        @generator.get_filtered_tags(%w(1 2 3))
+      end
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(%w(1 2)) }
+    end
+
+    context "when between_tags filled with invalid values" do
+      before do
+        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 q w))
+      end
+
+      subject do
+        @generator.get_filtered_tags(%w(1 2 3))
+      end
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(%w(1)) }
+    end
+  end
+
+  describe "#get_filtered_tags" do
+    subject { generator.get_filtered_tags(%w(1 2 3 4 5)) }
+    # before { generator.get_filtered_tags(%w(1 2 3 4 5)) }
+
+    context "with excluded and between tags" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3), exclude_tags: %w(2)) }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(%w(1 3)) }
+    end
+  end
+
+  describe "#filter_excluded_tags" do
+    subject { generator.filter_excluded_tags(%w(1 2 3)) }
+
+    context "with valid excluded tags" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(%w(1 2)) }
+    end
+  end
+end

data/spec/unit/parser_spec.rb

@@ -0,0 +1,60 @@
+describe GitHubChangelogGenerator::Parser do
+  describe ".user_project_from_remote" do
+    context "when remote is 1" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin  https://github.com/skywinder/ActionSheetPicker-3.0 (fetch)") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when remote is 2" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when remote is 3" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when remote is 4" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin git@github.com:skywinder/ActionSheetPicker-3.0.git (fetch)") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when remote is invalid" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("some invalid text") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array([nil, nil]) }
+    end
+  end
+  describe ".user_project_from_option" do
+    # context "when option is invalid" do
+    #   it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
+    # end
+
+    context "when option is valid" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when option nil" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil) }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array([nil, nil]) }
+    end
+    context "when site is nil" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when site is valid" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, "https://codeclimate.com") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when second arg is not nil" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", nil) }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array([nil, nil]) }
+    end
+  end
+end