gem_comet 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4002b63773d5efc2b2c6cb8367b7f4fedc6222f8fc43ccee41eb83497e2deee
-  data.tar.gz: 6319c6d3b7ff584c6c80da5349639778aabdb580807cd2688508e2d3dded71b1
+  metadata.gz: d5518bdb07a7f391789dd4a92dfab7da680516d056043f53f89cc90b6369bf2c
+  data.tar.gz: bd74b2883f594bf6a8f8ef8d16f7e5b6523e51e99b78c2204ad7d59d13715746
 SHA512:
-  metadata.gz: 590973c76a9a238d97550c5ec6b90f441ab8e3499c2fb5f297d6e8b7d5f50d086d2d98b5305cb5e6646fabf8a7467fb00f433dc3f2964dffa6e438f02b005d88
-  data.tar.gz: b3eb0b0b8cab1d370136b82ce34faa0e33a8905fbfc89cf1c9b04ed19663d378670b6c31af88a11d4ce64dad5b3cb6c4b665a01a67fdc6844867f592a10770d1
+  metadata.gz: 04115a41944981972f6ff88c7ec3d91facd4125ed05376b65341f94251910568a00bfc5d6b7aa968ffc2a47088adb8d41e0d9a230681e346999ea0e4402d5151
+  data.tar.gz: a654c0dc19960e482c4db8a049a35df9a741440b6806a361aabce616bc1eb212df794b41f55436c38ce2ada34a11f86f1bcb6d9a36d9439041377266f1ac4fcd

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-09-30 23:30:48 +0000 using RuboCop version 0.75.0.
+# on 2019-10-14 23:40:22 +0000 using RuboCop version 0.75.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+## 0.3.0 (Oct 19, 2019)
+
+### Feature
+
+* Enhance the feature of changelog command ([#27](https://github.com/ryz310/gem_comet/pull/27))
+
+### Misc
+
+* Re-generate .rubocop_todo.yml with RuboCop v0.75.1 ([#25](https://github.com/ryz310/gem_comet/pull/25))
+
 ## 0.2.0 (Oct 14, 2019)
 
 ### Feature

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gem_comet (0.2.0)
+    gem_comet (0.3.0)
       pr_comet (~> 0.3.0)
       thor
       type_struct
@@ -54,7 +54,7 @@ GEM
     rspec-support (3.9.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.75.0)
+    rubocop (0.75.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)

data/lib/gem_comet/changelog/editor.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module GemComet
+  class Changelog
+    # Edits CHANGELOG.md file of gem
+    class Editor
+      HEADER = "# Change log\n"
+
+      attr_reader :changelog_file_path
+
+      def initialize
+        @changelog_file_path = Config.call.release.changelog_file_path
+      end
+
+      # Prepends the content to CHANGELOG.md.
+      #
+      # @param content [String] Character string you want to prepend
+      def prepend!(content:)
+        return if changelog_file_path.nil?
+
+        modify_changelog do |changelog_file|
+          position = changelog_file.index(HEADER) + HEADER.length
+          changelog_file.insert(position, content)
+        end
+      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?
+
+        modify_changelog do |changelog_file|
+          changelog_file.concat(content)
+        end
+      end
+
+      private
+
+      def modify_changelog
+        changelog_file = File.read(changelog_file_path)
+        yield(changelog_file)
+        File.write(changelog_file_path, changelog_file)
+      end
+    end
+  end
+end

data/lib/gem_comet/changelog/generator.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+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
+      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 #{from}..#{to}`
+      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
+end

data/lib/gem_comet/changelog.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+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
+      @changelog_editor = Changelog::Editor.new
+      @from_version = from_version || version_editor.current_version
+      @to_version = to_version
+      @append = append
+      @prepend = prepend
+    end
+
+    private
+
+    attr_reader :version_editor, :changelog_editor,
+                :from_version, :to_version, :append, :prepend
+
+    # Displays changelogs. If specified a `append` or `prepend` option, updates
+    # CHANGELOG.md with generated changelog.
+    #
+    # @return [String] Ganalated changelog
+    def call
+      if append
+        changelog_editor.append!(content: changelog)
+      elsif prepend
+        changelog_editor.prepend!(content: changelog)
+      end
+      changelog
+    end
+
+    # Generate a changelog. The result is memoized.
+    #
+    # @return [String] Ganalated changelog
+    def changelog
+      @changelog ||= Generator.call(from_version: from_version, to_version: to_version)
+    end
+  end
+end

data/lib/gem_comet/cli.rb

@@ -21,10 +21,39 @@ module GemComet
       Release.call(version: version)
     end
 
-    desc 'changelog', 'Displays changelogs from last release to HEAD commit'
+    desc 'changelog', 'Displays changelogs'
+    option :from,
+           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`.'
+    option :append,
+           type: :boolean,
+           aliases: :a,
+           default: false,
+           desc: 'Appends execution result to CHANGELOG.md.'
+    option :prepend,
+           type: :boolean,
+           aliases: :p,
+           default: false,
+           desc: 'Prepends execution result to CHANGELOG.md.'
     def changelog
-      version_editor = VersionEditor.new
-      puts ChangelogGenerator.call(current_version: version_editor.current_version)
+      puts Changelog.call(
+        from_version: options[:from],
+        to_version: options[:to],
+        append: options[:append],
+        prepend: options[:prepend]
+      )
+    end
+
+    desc 'versions', 'Displays version numbers of your gem.'
+    def versions
+      puts `git tag`
     end
 
     desc 'version', 'Shows current version'

data/lib/gem_comet/release/update_pr.rb

@@ -8,7 +8,7 @@ module GemComet
         @version = version
         @pr_comet = PrComet.new(base: base_branch, branch: "update/v#{version}")
         @version_editor = VersionEditor.new
-        @changelog_editor = ChangelogEditor.new
+        @changelog_editor = Changelog::Editor.new
       end
 
       private
@@ -24,11 +24,11 @@ module GemComet
 
       def update_changelog
         pr_comet.commit ':comet: Update CHANGELOG.md' do
-          changelog = ChangelogGenerator.call(
-            current_version: version_editor.current_version,
+          changelog = Changelog::Generator.call(
+            from_version: version_editor.current_version,
             new_version: version
           )
-          changelog_editor.append!(content: changelog)
+          changelog_editor.prepend!(content: changelog)
         end
       end
 

data/lib/gem_comet/version.rb

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

data/lib/gem_comet.rb

@@ -9,8 +9,9 @@ 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/changelog'
+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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_comet
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-13 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pr_comet
@@ -219,8 +219,9 @@ 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/changelog.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

data/lib/gem_comet/changelog_editor.rb

@@ -1,26 +0,0 @@
-# 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

@@ -1,107 +0,0 @@
-# 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