gem_comet 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d7a15101d967116039e1422a45b92f8a19586185c72ebb8021fdfd80bb8ac5c
-  data.tar.gz: 92f16b1fd992bf85f78338b3aa9d99f31e45e781cfdcc71fedde71aae5c6c3d6
+  metadata.gz: d4002b63773d5efc2b2c6cb8367b7f4fedc6222f8fc43ccee41eb83497e2deee
+  data.tar.gz: 6319c6d3b7ff584c6c80da5349639778aabdb580807cd2688508e2d3dded71b1
 SHA512:
-  metadata.gz: 45c08cdafd4f92b80e9a8a1cf019f3a82aaead26237bc586edb1febc8c408fe2433e608bc67d7530e2346a8a41c1feefa03cda79782561a8c4f27520a0f076d8
-  data.tar.gz: 1d9bd7f8d16acb80ec7bc3505a76270b0a4d8d09a32ec5326f5f617c9618e0557a586c87b56cefcc3a6e1b6a6f3882083e6efd7cc09aae48bd0474d1df0b7b73
+  metadata.gz: 590973c76a9a238d97550c5ec6b90f441ab8e3499c2fb5f297d6e8b7d5f50d086d2d98b5305cb5e6646fabf8a7467fb00f433dc3f2964dffa6e438f02b005d88
+  data.tar.gz: b3eb0b0b8cab1d370136b82ce34faa0e33a8905fbfc89cf1c9b04ed19663d378670b6c31af88a11d4ce64dad5b3cb6c4b665a01a67fdc6844867f592a10770d1

data/.gem_comet.yml

@@ -1,6 +1,7 @@
-version: 1
+version: 1.1
 
 release:
   base_branch: master
   release_branch: release
   version_file_path: lib/gem_comet/version.rb
+  changelog_file_path: CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Change log
+
+## 0.2.0 (Oct 14, 2019)
+
+### Feature
+
+* Auto generate change log ([#22](https://github.com/ryz310/gem_comet/pull/22))
+
+## 0.1.1 (Oct 13, 2019)
+
+### Bugfix
+
+* Fix version number validation ([#16](https://github.com/ryz310/gem_comet/pull/16))
+
+### Misc
+
+* Re-generate .rubocop_todo.yml with RuboCop v0.73.0 ([#3](https://github.com/ryz310/gem_comet/pull/3))
+* Re-generate .rubocop_todo.yml with RuboCop v0.74.0 ([#5](https://github.com/ryz310/gem_comet/pull/5))
+* Re-generate .rubocop_todo.yml with RuboCop v0.75.0 ([#13](https://github.com/ryz310/gem_comet/pull/13))
+* ryz310/dependabot/bundler/rake-tw-13.0 ([#9](https://github.com/ryz310/gem_comet/pull/9))
+* ryz310/dependabot/bundler/rubocop-performance-1.5.0 ([#14](https://github.com/ryz310/gem_comet/pull/14))
+* ryz310/dependabot/bundler/rspec-3.9.0 ([#17](https://github.com/ryz310/gem_comet/pull/17))
+
+## 0.1.0 (Jul 16, 2019)
+
+Initial release :rocket:

data/Gemfile.lock

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

data/README.md

@@ -2,29 +2,49 @@
 
 # GemComet
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gem_comet`. To experiment with that code, run `bin/console` for an interactive prompt.
+The `gem_comet` is a command line tool which to update and release your gem.
+Install as following:
 
-TODO: Delete this and the text above, and describe your gem
+```
+$ gem install 'gem_comet'
+```
 
-## Installation
+Initialize `gem_comet` as following:
 
-Add this line to your application's Gemfile:
+```
+$ gem_comet init
+```
 
-```ruby
-gem 'gem_comet'
+Then, edit the created file: `.gem_comet.yml` as following.
+
+```yaml
+version: 1
+
+release:
+  base_branch: master
+  release_branch: release
+  version_file_path: { Path of the version file. e.g. lib/gem_comet/version.rb }
 ```
 
-And then execute:
+## Usage
+
+### Display changelogs
 
-    $ bundle
+Displays changelogs from last release to HEAD commit.
 
-Or install it yourself as:
+```
+$ gem_comet changelog
+```
 
-    $ gem install gem_comet
+### Release
 
-## Usage
+Creates update PR and release PR.
+
+```
+$ gem_comet release { The version number you want to release. e.g. "1.2.3" }
+```
 
-TODO: Write usage instructions here
+Then, you should check pull requests on your GitHub repository page. You will see two pull requests: "Update v1.2.3" and "Release v1.2.3". First, you should check "Update v1.2.3" and merge. Next, you should check "Release v1.2.3" and merge. The "Release v1.2.3" destination is the release branch. You should set up CI that to deploy the gem automatically.
 
 ## Development
 

data/lib/gem_comet.rb

@@ -2,11 +2,15 @@
 
 require 'thor'
 require 'type_struct'
+require 'type_struct/ext'
 require 'pr_comet'
 require 'yaml'
 require 'gem_comet/version'
 require 'gem_comet/service_abstract'
 require 'gem_comet/config'
+require 'gem_comet/version_editor'
+require 'gem_comet/changelog_editor'
+require 'gem_comet/changelog_generator'
 require 'gem_comet/release'
 require 'gem_comet/release/update_pr'
 require 'gem_comet/release/release_pr'

data/lib/gem_comet/changelog_editor.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GemComet
+  # Edits CHANGELOG.md file of gem
+  class ChangelogEditor
+    HEADER = "# Change log\n"
+
+    attr_reader :changelog_file_path
+
+    def initialize
+      @changelog_file_path = Config.call.release.changelog_file_path
+    end
+
+    # Appends the content to CHANGELOG.md.
+    #
+    # @param content [String] Character string you want to append
+    def append!(content:)
+      return if changelog_file_path.nil?
+
+      changelog_file = File.read(changelog_file_path)
+      position = changelog_file.index(HEADER) + HEADER.length
+      changelog_file.insert(position, content)
+      File.write(changelog_file_path, changelog_file)
+    end
+  end
+end

data/lib/gem_comet/changelog_generator.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module GemComet
+  # Generates changelog from git log
+  class ChangelogGenerator < ServiceAbstract
+    attr_reader :last_label, :new_version
+
+    # @param current_version [String] Current version of your gem
+    # @param new_version [String] Next version of your gem
+    def initialize(current_version:, new_version: nil)
+      @last_label = "v#{current_version}"
+      @new_version = new_version || 'NEW'
+    end
+
+    private
+
+    MERGE_COMMIT_TITLE = /Merge pull request #(\d+) from (.+)/.freeze
+
+    # Returns changelogs as markdown format from current version to HEAD commit.
+    #
+    # @return [String] Changelogs as markdown format
+    def call
+      <<~MARKDOWN
+
+        ## #{new_version} (#{Date.today.strftime('%b %d, %Y')})
+
+        ### Feature
+        ### Bugfix
+        ### Breaking Change
+        ### Misc
+
+        #{changelogs.reverse.join("\n")}
+
+      MARKDOWN
+    end
+
+    # Returns array of changelogs as markdown format.
+    #
+    # @return [Array<String>] Array of changelogs as markdown format
+    def changelogs
+      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)
+
+        "* #{description} ([##{pull_request_number}](#{pull_request_url}))"
+      end.compact
+    end
+
+    # Extracts PR number from merge commit string.
+    #
+    # @param merge_commit [String] The target string
+    # @return [Integer] The pull request number
+    def extract_pull_request_number(merge_commit)
+      MERGE_COMMIT_TITLE.match(merge_commit).captures.first.to_i
+    end
+
+    # Get the PR URL. (e.g. https://github.com/ryz310/gem_comet/pull/1)
+    #
+    # @param pull_request_number [Integer] The target pull request number
+    # @return [String] Returns the URL
+    def get_pull_request_url(pull_request_number)
+      "#{origin_url}/pull/#{pull_request_number}"
+    end
+
+    # Extracts commit desciption from merge commit string.
+    #
+    # @param merge_commit [String] The target string
+    # @return [String] The commit description
+    # @return [nil] Returns `nil` if not exists
+    def extract_description(merge_commit)
+      description = merge_commit.lines.last
+      description&.chomp&.strip unless description.match?(MERGE_COMMIT_TITLE)
+    end
+
+    # Extracts the PR branch name from merge commit string.
+    #
+    # @param merge_commit [String] The target string
+    # @return [String] Branch name
+    def extract_branch_name(merge_commit)
+      MERGE_COMMIT_TITLE.match(merge_commit).captures.last.chomp.strip
+    end
+
+    # Parces the merge commit log, which to separate by each commit.
+    #
+    # @return [Array<String>] Array of git commit log
+    def merge_commits
+      merge_commit_log.split(/^commit \w{40}\n/).reject(&:empty?).map(&:chomp)
+    end
+
+    # Returns only merge commit logs via git command.
+    #
+    # @return [String] Get only merge commit logs
+    def merge_commit_log
+      @merge_commit_log ||= `git log --merges #{last_label}..HEAD`
+    end
+
+    # Returns the git origin URL via git command.
+    #
+    # @return [String] The origin URL
+    def origin_url
+      @origin_url ||= `git remote get-url --push origin`.sub('.git', '').chomp
+    end
+  end
+end

data/lib/gem_comet/cli.rb

@@ -13,6 +13,7 @@ module GemComet
     def init
       template '../../template/.gem_comet.yml.erb', '.gem_comet.yml',
                version: GemComet::Config::CURRENT_VERSION
+      template '../../template/CHANGELOG.md.erb', 'CHANGELOG.md'
     end
 
     desc 'release VERSION', 'Creates update PR and release PR'
@@ -20,6 +21,12 @@ module GemComet
       Release.call(version: version)
     end
 
+    desc 'changelog', 'Displays changelogs from last release to HEAD commit'
+    def changelog
+      version_editor = VersionEditor.new
+      puts ChangelogGenerator.call(current_version: version_editor.current_version)
+    end
+
     desc 'version', 'Shows current version'
     def version
       puts GemComet::VERSION

data/lib/gem_comet/config.rb

@@ -3,32 +3,32 @@
 module GemComet
   # Loads the config file
   class Config < ServiceAbstract
-    CURRENT_VERSION = 1
+    using TypeStruct::Union::Ext
 
-    V1 = TypeStruct.new(
-      version: CURRENT_VERSION,
+    CONFIG_FILE_PATH = '.gem_comet.yml'
+    CURRENT_VERSION = 1.1
+
+    V1_1 = TypeStruct.new(
+      version: 1.0...2.0,
       release: TypeStruct.new(
         base_branch: String,
         release_branch: String,
-        version_file_path: String
+        version_file_path: String,
+        changelog_file_path: String | nil
       )
     )
 
-    private
-
-    attr_reader :file_path
+    def initialize; end
 
-    def initialize(file_path:)
-      @file_path = file_path
-    end
+    private
 
     def call
-      V1.from_hash(YAML.safe_load(File.open(file_path)))
+      V1_1.from_hash(YAML.safe_load(File.open(CONFIG_FILE_PATH)))
     rescue Errno::ENOENT
       raise 'Not initialized. Please run `$ gem_comet init`.'
     rescue TypeStruct::MultiTypeError => e
       puts e.message
-      raise "Unexpected file format. Please check your '#{file_path}'."
+      raise "Unexpected file format. Please check your '#{CONFIG_FILE_PATH}'."
     end
   end
 end

data/lib/gem_comet/release.rb

@@ -3,19 +3,17 @@
 module GemComet
   # Creates pull requests for gem release and that preparation
   class Release < ServiceAbstract
-    CONFIG_FILE_PATH = '.gem_comet.yml'
-
-    private
-
-    attr_reader :version, :config
-
     def initialize(version:)
       verify_version_number(version)
 
       @version = version
-      @config = Config.call(file_path: CONFIG_FILE_PATH)
+      @config = Config.call
     end
 
+    private
+
+    attr_reader :version, :config
+
     def call
       UpdatePR.call(update_pr_args)
       ReleasePR.call(release_pr_args)
@@ -24,8 +22,7 @@ module GemComet
     def update_pr_args
       {
         version: version,
-        base_branch: config.release.base_branch,
-        version_file_path: config.release.version_file_path
+        base_branch: config.release.base_branch
       }
     end
 

data/lib/gem_comet/release/update_pr.rb

@@ -4,30 +4,37 @@ module GemComet
   class Release
     # Creates a pull request for release preparation
     class UpdatePR < ServiceAbstract
-      private
-
-      attr_reader :version, :pr_comet, :version_file_path
-
-      def initialize(version:, base_branch:, version_file_path:)
+      def initialize(version:, base_branch:)
         @version = version
         @pr_comet = PrComet.new(base: base_branch, branch: "update/v#{version}")
-        @version_file_path = version_file_path
+        @version_editor = VersionEditor.new
+        @changelog_editor = ChangelogEditor.new
       end
 
+      private
+
+      attr_reader :version, :pr_comet, :version_editor, :changelog_editor
+
       def call
+        update_changelog
         update_version_file
         bundle_update
         create_pull_request
       end
 
+      def update_changelog
+        pr_comet.commit ':comet: Update CHANGELOG.md' do
+          changelog = ChangelogGenerator.call(
+            current_version: version_editor.current_version,
+            new_version: version
+          )
+          changelog_editor.append!(content: changelog)
+        end
+      end
+
       def update_version_file
         pr_comet.commit ':comet: Update version number' do
-          version_file = File.read(version_file_path)
-          version_file.sub!(
-            /VERSION\s*=\s*(['"])(.+?)(['"])/,
-            "VERSION = \\1#{version}\\3"
-          )
-          File.write(version_file_path, version_file)
+          version_editor.update!(new_version: version)
         end
       end
 

data/lib/gem_comet/service_abstract.rb

@@ -3,6 +3,8 @@
 module GemComet
   # The abstract class for service classes
   class ServiceAbstract
+    private_class_method :new
+
     def self.call(*args)
       new(*args).send(:call)
     end

data/lib/gem_comet/version.rb

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

data/lib/gem_comet/version_editor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GemComet
+  # Edits version file of the gem
+  class VersionEditor
+    attr_reader :version_file_path
+
+    VERSION_NUMBER_PATTERN = /VERSION\s*=\s*(['"])(.+?)(['"])/.freeze
+
+    def initialize
+      @version_file_path = Config.call.release.version_file_path
+    end
+
+    # Reads the current version number of gem
+    #
+    # @return [String] The current version number
+    def current_version
+      version_file = File.read(version_file_path)
+      VERSION_NUMBER_PATTERN.match(version_file).captures[1]
+    end
+
+    # Updates the version number of gem
+    #
+    # @param new_version [String] The next version number
+    def update!(new_version:)
+      version_file = File.read(version_file_path)
+      version_file.sub!(VERSION_NUMBER_PATTERN, "VERSION = \\1#{new_version}\\3")
+      File.write(version_file_path, version_file)
+    end
+  end
+end

data/template/.gem_comet.yml.erb

@@ -9,3 +9,4 @@ release:
   base_branch: master
   release_branch: release
   version_file_path: '{Path of your version file}'
+  changelog_file_path: CHANGELOG.md # optional

data/template/CHANGELOG.md.erb

@@ -0,0 +1 @@
+# Change log

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_comet
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - ryz310
@@ -207,6 +207,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -218,6 +219,8 @@ files:
 - exe/gem_comet
 - gem_comet.gemspec
 - lib/gem_comet.rb
+- lib/gem_comet/changelog_editor.rb
+- lib/gem_comet/changelog_generator.rb
 - lib/gem_comet/cli.rb
 - lib/gem_comet/config.rb
 - lib/gem_comet/release.rb
@@ -225,7 +228,9 @@ files:
 - lib/gem_comet/release/update_pr.rb
 - lib/gem_comet/service_abstract.rb
 - lib/gem_comet/version.rb
+- lib/gem_comet/version_editor.rb
 - template/.gem_comet.yml.erb
+- template/CHANGELOG.md.erb
 homepage: https://github.com/ryz310/gem_comet
 licenses:
 - MIT