gem_comet 0.3.0 → 0.7.2

data/README.md

@@ -26,6 +26,10 @@ release:
   version_file_path: { Path of the version file. e.g. lib/gem_comet/version.rb }
 ```
 
+## Supported versions
+
+* Ruby 2.7, 3.0
+
 ## Usage
 
 ### Display changelogs

data/gem_comet.gemspec

@@ -22,7 +22,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'pr_comet', '~> 0.3.0'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.add_runtime_dependency 'pr_comet', '~> 0.4.0'
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'type_struct'
 
@@ -34,6 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov', '0.17.1'
   spec.add_development_dependency 'yard'
 end

data/lib/gem_comet.rb

@@ -8,11 +8,18 @@ require 'yaml'
 require 'gem_comet/version'
 require 'gem_comet/service_abstract'
 require 'gem_comet/config'
+require 'gem_comet/git_command'
+require 'gem_comet/bundle_updater'
 require 'gem_comet/version_editor'
+require 'gem_comet/version_history'
 require 'gem_comet/changelog'
+require 'gem_comet/changelog/initializer'
 require 'gem_comet/changelog/editor'
 require 'gem_comet/changelog/generator'
+require 'gem_comet/open_github_pulls_page'
+require 'gem_comet/repository_url'
 require 'gem_comet/release'
-require 'gem_comet/release/update_pr'
-require 'gem_comet/release/release_pr'
+require 'gem_comet/release/create_update_pr'
+require 'gem_comet/release/create_release_pr'
+require 'gem_comet/verify_git_condition'
 require 'gem_comet/cli'

data/lib/gem_comet/bundle_updater.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GemComet
+  # Executes `$ bundle update` command
+  class BundleUpdater < ServiceAbstract
+    def initialize; end
+
+    private
+
+    def call
+      `bundle update`
+    end
+  end
+end

data/lib/gem_comet/changelog.rb

@@ -3,29 +3,19 @@
 module GemComet
   # Generates changelog from git log
   class Changelog < ServiceAbstract
-    # @param from_version [String]
-    #   The beginning of version number to create a changelog.
-    #   Default is specified current version.
-    # @param to_version [String]
-    #   The end of version number to create a changelog.
-    #   Default is specified `HEAD`.
-    # @param append [Boolean]
-    #   Appends execution result to CHANGELOG.md.
-    # @param prepend [Boolean]
-    #   Prepends execution result to CHANGELOG.md.
-    def initialize(from_version: nil, to_version: nil, append: false, prepend: false)
-      @version_editor = VersionEditor.new
+    # @param version [String] The version number to create a changelog.
+    # @param append [Boolean] Appends execution result to CHANGELOG.md.
+    # @param prepend [Boolean] Prepends execution result to CHANGELOG.md.
+    def initialize(version:, append: false, prepend: false)
       @changelog_editor = Changelog::Editor.new
-      @from_version = from_version || version_editor.current_version
-      @to_version = to_version
+      @version = version
       @append = append
       @prepend = prepend
     end
 
     private
 
-    attr_reader :version_editor, :changelog_editor,
-                :from_version, :to_version, :append, :prepend
+    attr_reader :changelog_editor, :version, :append, :prepend
 
     # Displays changelogs. If specified a `append` or `prepend` option, updates
     # CHANGELOG.md with generated changelog.
@@ -44,7 +34,7 @@ module GemComet
     #
     # @return [String] Ganalated changelog
     def changelog
-      @changelog ||= Generator.call(from_version: from_version, to_version: to_version)
+      @changelog ||= Generator.call(version: version)
     end
   end
 end

data/lib/gem_comet/changelog/generator.rb

@@ -4,17 +4,14 @@ module GemComet
   class Changelog
     # Generates changelog from git log
     class Generator < ServiceAbstract
-      attr_reader :from, :to, :new_version
-
-      # @param from_version [String] The beginning of version number to create a changelog
-      # @param to_version [String]
-      #   The end of version number to create a changelog. If ommit this option,
-      #   it's specified `HEAD`.
-      # @param new_version [String] Next version of your gem
-      def initialize(from_version:, to_version: nil, new_version: nil)
-        @from = "v#{from_version}"
-        @to = to_version.nil? ? 'HEAD' : "v#{to_version}"
-        @new_version = new_version || to
+      attr_reader :version, :title, :origin_url
+
+      # @param version [String] The end of version number to create a changelog.
+      # @param title [String] Next version of your gem
+      def initialize(version:, title: nil)
+        @version = version
+        @title = title || version
+        @origin_url = RepositoryUrl.call
       end
 
       private
@@ -24,10 +21,11 @@ module GemComet
       # Returns changelogs as markdown format from current version to HEAD commit.
       #
       # @return [String] Changelogs as markdown format
+      # @raise [RuntimeError] The specified version cannot be found
       def call
         <<~MARKDOWN
 
-          ## #{new_version} (#{Date.today.strftime('%b %d, %Y')})
+          ## #{title} (#{versioning_date})
 
           ### Feature
           ### Bugfix
@@ -38,6 +36,13 @@ module GemComet
         MARKDOWN
       end
 
+      # Returns the versioning date
+      #
+      # @return [String] The versioning date. e.g. "Oct 26, 2019"
+      def versioning_date
+        VersionHistory.new.versioning_date_of(version).strftime('%b %d, %Y')
+      end
+
       # Returns array of changelogs as markdown format.
       #
       # @return [Array<String>] Array of changelogs as markdown format
@@ -45,14 +50,29 @@ module GemComet
         merge_commits.map do |merge_commit|
           next unless merge_commit.match?(MERGE_COMMIT_TITLE)
 
-          pull_request_number = extract_pull_request_number(merge_commit)
-          pull_request_url = get_pull_request_url(pull_request_number)
-          description = extract_description(merge_commit) || extract_branch_name(merge_commit)
+          number = extract_pull_request_number(merge_commit)
+          title = extract_description(merge_commit) || extract_branch_name(merge_commit)
+          author = extract_author_name(merge_commit)
 
-          "* #{description} ([##{pull_request_number}](#{pull_request_url}))"
+          generate_changelog(number, title, author)
         end.compact
       end
 
+      # Generates changelog message as markdown list
+      #
+      # @param number [Integer] The pull request number
+      # @param title [String] The pull request title
+      # @param author [String] The author of the PR
+      # @return [String] Changelog message as markdown list
+      def generate_changelog(number, title, author)
+        [
+          '*',
+          "[##{number}](#{get_pull_request_url(number)})",
+          title,
+          "([@#{author}](https://github.com/#{author}))"
+        ].join(' ')
+      end
+
       # Extracts PR number from merge commit string.
       #
       # @param merge_commit [String] The target string
@@ -87,6 +107,14 @@ module GemComet
         MERGE_COMMIT_TITLE.match(merge_commit).captures.last.chomp.strip
       end
 
+      # Extracts the author of the PR from merge commit string.
+      #
+      # @param merge_commit [String] The target string
+      # @return [String] Author name
+      def extract_author_name(merge_commit)
+        extract_branch_name(merge_commit).split('/').first
+      end
+
       # Parces the merge commit log, which to separate by each commit.
       #
       # @return [Array<String>] Array of git commit log
@@ -98,14 +126,14 @@ module GemComet
       #
       # @return [String] Get only merge commit logs
       def merge_commit_log
-        @merge_commit_log ||= `git log --merges #{from}..#{to}`
+        @merge_commit_log ||= `git log --merges #{prev_version}..#{version}`
       end
 
-      # Returns the git origin URL via git command.
+      # Get a previous version number from the specified version number
       #
-      # @return [String] The origin URL
-      def origin_url
-        @origin_url ||= `git remote get-url --push origin`.sub('.git', '').chomp
+      # @raise [RuntimeError] The specified version cannot be found
+      def prev_version
+        @prev_version ||= VersionHistory.new.previous_version_from(version)
       end
     end
   end

data/lib/gem_comet/changelog/initializer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GemComet
+  class Changelog
+    # Initializes the CHANGELOG.md to append past version change-logs
+    class Initializer < ServiceAbstract
+      def initialize
+        @changelog_editor = Changelog::Editor.new
+        @version_history = VersionHistory.new
+      end
+
+      private
+
+      attr_reader :changelog_editor, :version_history
+
+      def call
+        version_history.versions.each do |version|
+          changelog = Changelog::Generator.call(version: version)
+          changelog_editor.prepend!(content: changelog)
+        end
+      end
+    end
+  end
+end

data/lib/gem_comet/cli.rb

@@ -14,24 +14,26 @@ module GemComet
       template '../../template/.gem_comet.yml.erb', '.gem_comet.yml',
                version: GemComet::Config::CURRENT_VERSION
       template '../../template/CHANGELOG.md.erb', 'CHANGELOG.md'
+      Changelog::Initializer.call
+    rescue StandardError => e
+      puts e.message
     end
 
     desc 'release VERSION', 'Creates update PR and release PR'
     def release(version)
       Release.call(version: version)
+    rescue StandardError => e
+      puts e.message
     end
 
     desc 'changelog', 'Displays changelogs'
-    option :from,
+    option :version,
            type: :string,
-           aliases: :f,
-           desc: 'The beginning of version number to create a changelog. ' \
-                 'Default is specified current version.'
-    option :to,
-           type: :string,
-           aliases: :t,
-           desc: 'The end of version number to create a changelog. ' \
-                 'Default is specified `HEAD`.'
+           aliases: :v,
+           default: 'HEAD',
+           desc: 'The version number to create a changelog. ' \
+                 'Default is specified `HEAD`.',
+           banner: 'v1.2.3'
     option :append,
            type: :boolean,
            aliases: :a,
@@ -44,16 +46,19 @@ module GemComet
            desc: 'Prepends execution result to CHANGELOG.md.'
     def changelog
       puts Changelog.call(
-        from_version: options[:from],
-        to_version: options[:to],
+        version: options[:version],
         append: options[:append],
         prepend: options[:prepend]
       )
+    rescue StandardError => e
+      puts e.message
     end
 
     desc 'versions', 'Displays version numbers of your gem.'
     def versions
-      puts `git tag`
+      puts VersionHistory.new.versions
+    rescue StandardError => e
+      puts e.message
     end
 
     desc 'version', 'Shows current version'

data/lib/gem_comet/git_command.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GemComet
+  # Executes git command
+  class GitCommand
+    def initialize; end
+
+    # Get uncommitted files
+    #
+    # @return [Array<String>] Uncommitted files
+    def uncommitted_files
+      git_status_short.lines.map(&:chomp)
+    end
+
+    # Get current git branch name
+    #
+    # @return [String] The current branch name
+    def current_branch
+      run 'rev-parse', '--abbrev-ref', 'HEAD'
+    end
+
+    def checkout(branch)
+      run 'checkout', branch
+    end
+
+    # Executes `$ git pull`
+    def pull
+      run 'pull'
+    end
+
+    private
+
+    def execute(command)
+      `#{command}`.chomp
+    end
+
+    def run(*subcommands)
+      command = "git #{subcommands.join(' ')}"
+      execute(command)
+    end
+
+    def git_status_short
+      run 'status', '--short'
+    end
+  end
+end

data/lib/gem_comet/open_github_pulls_page.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GemComet
+  # Creates pull requests for gem release and that preparation
+  class OpenGithubPullsPage < ServiceAbstract
+    attr_reader :origin_url
+
+    def initialize
+      @origin_url = RepositoryUrl.call
+    end
+
+    private
+
+    def call
+      `open #{origin_url}/pulls`
+    end
+  end
+end

data/lib/gem_comet/release.rb

@@ -15,8 +15,10 @@ module GemComet
     attr_reader :version, :config
 
     def call
-      UpdatePR.call(update_pr_args)
-      ReleasePR.call(release_pr_args)
+      VerifyGitCondition.call
+      CreateUpdatePR.call(**update_pr_args)
+      CreateReleasePR.call(**release_pr_args)
+      OpenGithubPullsPage.call
     end
 
     def update_pr_args

data/lib/gem_comet/release/{release_pr.rb → create_release_pr.rb}

@@ -3,7 +3,7 @@
 module GemComet
   class Release
     # Creates a pull request for your gem release
-    class ReleasePR < ServiceAbstract
+    class CreateReleasePR < ServiceAbstract
       private
 
       attr_reader :version, :pr_comet
@@ -18,7 +18,20 @@ module GemComet
       end
 
       def create_pull_request
-        pr_comet.create!(title: "Release v#{version}", body: '', validate: false)
+        pr_comet.create!(
+          title: "Release v#{version}",
+          body: pull_request_body,
+          validate: false
+        )
+      end
+
+      def pull_request_body
+        template = File.read(template_file_path)
+        ERB.new(template, trim_mode: '-').result(binding)
+      end
+
+      def template_file_path
+        File.expand_path('../../../template/release_pr.md.erb', __dir__)
       end
     end
   end

data/lib/gem_comet/release/{update_pr.rb → create_update_pr.rb}

@@ -3,17 +3,18 @@
 module GemComet
   class Release
     # Creates a pull request for release preparation
-    class UpdatePR < ServiceAbstract
+    class CreateUpdatePR < ServiceAbstract
       def initialize(version:, base_branch:)
         @version = version
         @pr_comet = PrComet.new(base: base_branch, branch: "update/v#{version}")
         @version_editor = VersionEditor.new
+        @prev_version = version_editor.current_version
         @changelog_editor = Changelog::Editor.new
       end
 
       private
 
-      attr_reader :version, :pr_comet, :version_editor, :changelog_editor
+      attr_reader :version, :prev_version, :pr_comet, :version_editor, :changelog_editor
 
       def call
         update_changelog
@@ -24,10 +25,7 @@ module GemComet
 
       def update_changelog
         pr_comet.commit ':comet: Update CHANGELOG.md' do
-          changelog = Changelog::Generator.call(
-            from_version: version_editor.current_version,
-            new_version: version
-          )
+          changelog = Changelog::Generator.call(version: 'HEAD', title: "v#{version}")
           changelog_editor.prepend!(content: changelog)
         end
       end
@@ -39,11 +37,20 @@ module GemComet
       end
 
       def bundle_update
-        pr_comet.commit(':comet: $ bundle update') { `bundle update` }
+        pr_comet.commit(':comet: $ bundle update') { BundleUpdater.call }
       end
 
       def create_pull_request
-        pr_comet.create!(title: "Update v#{version}", body: '')
+        pr_comet.create!(title: "Update v#{version}", body: pull_request_body)
+      end
+
+      def pull_request_body
+        template = File.read(template_file_path)
+        ERB.new(template, trim_mode: '-').result(binding)
+      end
+
+      def template_file_path
+        File.expand_path('../../../template/update_pr.md.erb', __dir__)
       end
     end
   end