gem_comet 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5518bdb07a7f391789dd4a92dfab7da680516d056043f53f89cc90b6369bf2c
-  data.tar.gz: bd74b2883f594bf6a8f8ef8d16f7e5b6523e51e99b78c2204ad7d59d13715746
+  metadata.gz: b13645ee861e799d64559a1d4b41de38fe7e11061073387bece2f18c9f6d595f
+  data.tar.gz: 7d83a76d83b2812cb74afbcc7dd406d0980a6ad000caa9901395e0f8e9671ad2
 SHA512:
-  metadata.gz: 04115a41944981972f6ff88c7ec3d91facd4125ed05376b65341f94251910568a00bfc5d6b7aa968ffc2a47088adb8d41e0d9a230681e346999ea0e4402d5151
-  data.tar.gz: a654c0dc19960e482c4db8a049a35df9a741440b6806a361aabce616bc1eb212df794b41f55436c38ce2ada34a11f86f1bcb6d9a36d9439041377266f1ac4fcd
+  metadata.gz: 57d0c128ffe107140aafb153bd8ec3e858bd7643fbd878348bb3f7e0531163e60da7884f1e56116f948523b85d8f4d530ebee3a4e079528db82e4f700ea5c8d9
+  data.tar.gz: 59dd23a66be1ac4fec13fd6fb2d2c7f92edbeae79ce7d02ae4e31e465e10c92babfe25e2bff52380188fc4adf1cd8bba2a8c9bcac14a7eb5ba3eb9f56ab86520

data/.rubocop.yml

@@ -16,7 +16,7 @@ Metrics/LineLength:
   Max: 100
 
 RSpec/MultipleExpectations:
-  Max: 4
+  Max: 6
 
 RSpec/NestedGroups:
   Max: 4

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change log
 
+## v0.4.0 (Oct 27, 2019)
+
+### Feature
+
+* Modify to display gem versions sorted by tagged date ([#32](https://github.com/ryz310/gem_comet/pull/32))
+* Add the legend to creating pull requests ([#33](https://github.com/ryz310/gem_comet/pull/33))
+* Open the GitHub pull request page at release ([#36](https://github.com/ryz310/gem_comet/pull/36))
+
+### Bugfix
+
+* Fix broken links included by the modified change log ([#34](https://github.com/ryz310/gem_comet/pull/34))
+
+### Breaking Change
+
+* Changelog initializer ([#35](https://github.com/ryz310/gem_comet/pull/35))
+    * The `$ gem_comet changelog` command options has changed:
+        * Before:
+            * `$ gem_comet changelog --from=0.1.0 --to=0.1.1`
+        * After:
+            * `$ gem_comet changelog --version=v0.1.1`
+
 ## 0.3.0 (Oct 19, 2019)
 
 ### Feature

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gem_comet (0.3.0)
+    gem_comet (0.4.0)
       pr_comet (~> 0.3.0)
       thor
       type_struct

data/lib/gem_comet.rb

@@ -8,11 +8,20 @@ require 'yaml'
 require 'gem_comet/version'
 require 'gem_comet/service_abstract'
 require 'gem_comet/config'
+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/cli'
+
+module GemComet
+  LEGEND = 'Generated by [gem_comet](https://github.com/ryz310/gem_comet)'
+end

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
@@ -98,14 +103,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/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

@@ -17,6 +17,7 @@ module GemComet
     def call
       UpdatePR.call(update_pr_args)
       ReleasePR.call(release_pr_args)
+      OpenGithubPullsPage.call
     end
 
     def update_pr_args

data/lib/gem_comet/release/release_pr.rb

@@ -18,7 +18,7 @@ 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: LEGEND, validate: false)
       end
     end
   end

data/lib/gem_comet/release/update_pr.rb

@@ -24,10 +24,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 +36,11 @@ 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: LEGEND)
       end
     end
   end

data/lib/gem_comet/repository_url.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GemComet
+  # Gets the repository URL on the GitHub
+  class RepositoryUrl < ServiceAbstract
+    def initialize; end
+
+    private
+
+    # Returns the git origin URL via git command.
+    #
+    # @return [String] The origin URL
+    def call
+      if git_remote_command =~ /git@github.com:(.+).git/
+        "https://github.com/#{Regexp.last_match(1)}"
+      else
+        git_remote_command.sub('.git', '').chomp
+      end
+    end
+
+    def git_remote_command
+      @git_remote_command ||= `git remote get-url --push origin`
+    end
+  end
+end

data/lib/gem_comet/service_abstract.rb

@@ -9,12 +9,12 @@ module GemComet
       new(*args).send(:call)
     end
 
-    private
-
     def initialize(_args)
       raise "Please implement #{self.class}##{__method__}"
     end
 
+    private
+
     def call
       raise "Please implement #{self.class}##{__method__}"
     end

data/lib/gem_comet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GemComet
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/gem_comet/version_history.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module GemComet
+  # Reads versions by `git tag` command
+  class VersionHistory
+    # Gets all version numbers
+    #
+    # @return [Array<String>] An array of version numbers
+    def versions
+      array_of_version_and_date.map(&:first).push('HEAD')
+    end
+
+    # Gets a previous version number from the specified version number
+    #
+    # @param version [String] Any version number
+    # @return [String] A previous version number
+    # @raise [RuntimeError] The specified version cannot be found
+    def previous_version_from(version)
+      index = find_version_index(version)
+      return nil if index.zero?
+
+      versions.at(index - 1)
+    end
+
+    # Gets the verioning date of the version number
+    #
+    # @param version [String] Any version number
+    # @return [Date] The verioning date
+    # @raise [RuntimeError] The specified version cannot be found
+    def versioning_date_of(version)
+      return Date.today if version == 'HEAD'
+
+      index = find_version_index(version)
+      Date.parse(array_of_version_and_date[index].last)
+    end
+
+    private
+
+    # Processes `git tag` command result
+    #
+    # @return [Array<Array<String>>] An array of versions and date
+    #   e.g. [['v0.1.0', '2019-07-15'], ['v0.2.0', '2019-10-14']]
+    def array_of_version_and_date
+      @array_of_version_and_date ||= git_tag_list.lines.map(&:chomp).map(&:split).sort_by(&:last)
+    end
+
+    # Finds an index of the specified version number
+    #
+    # @param version [String] Any version number
+    # @return [Integer] The index of the specified version number
+    # @raise [RuntimeError] The specified version cannot be found
+    def find_version_index(version)
+      index = versions.index(version)
+      raise 'The specified version cannot be found' if index.nil?
+
+      index
+    end
+
+    # Executes `git tag` command
+    #
+    # @return [String] Output result
+    def git_tag_list
+      `git tag --list 'v*' --format='%(tag) %(taggerdate:short)'`
+    end
+  end
+end

data/template/.gem_comet.yml.erb

@@ -1,7 +1,10 @@
 # [Usage]
 #
 # $ gem install gem_comet
+# $ gem_comet init
 # $ gem_comet release {version number, like as "1.2.3"}
+# $ gem_comet changelog
+# $ gem_comet versions
 
 version: <%= config[:version] %>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_comet
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2019-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pr_comet
@@ -219,17 +219,22 @@ files:
 - exe/gem_comet
 - gem_comet.gemspec
 - lib/gem_comet.rb
+- lib/gem_comet/bundle_updater.rb
 - lib/gem_comet/changelog.rb
 - lib/gem_comet/changelog/editor.rb
 - lib/gem_comet/changelog/generator.rb
+- lib/gem_comet/changelog/initializer.rb
 - lib/gem_comet/cli.rb
 - lib/gem_comet/config.rb
+- lib/gem_comet/open_github_pulls_page.rb
 - lib/gem_comet/release.rb
 - lib/gem_comet/release/release_pr.rb
 - lib/gem_comet/release/update_pr.rb
+- lib/gem_comet/repository_url.rb
 - lib/gem_comet/service_abstract.rb
 - lib/gem_comet/version.rb
 - lib/gem_comet/version_editor.rb
+- lib/gem_comet/version_history.rb
 - template/.gem_comet.yml.erb
 - template/CHANGELOG.md.erb
 homepage: https://github.com/ryz310/gem_comet