structured_changelog 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b739ec968c42936d856aa3788cf0429a1381f1a4
-  data.tar.gz: 7723700057200b69557b1a8fcfbf6842b3b4d60f
+  metadata.gz: be75d779c18c4c812b6d42568422f7204fbcf7c2
+  data.tar.gz: 109cb7700121b7ca516b81dbbfcd93b8f4efcf7c
 SHA512:
-  metadata.gz: f21e553a2ef385497c4319ac5e5f640c5cadb3e4287e8e21de82e1f71cea7d770ca9afecfc5ed28da237adb0bf79d612f1ae38e1a69fd5f3b3fe24227c385778
-  data.tar.gz: 9c53f76476323d2f51c6fea3eb2562d9109cdf802ebfdb79536b3006dc36e6f4552f4922ba0dbb4c277742d7b2b7533e1fce0b7a97a2325a467fbbf738c1f6b7
+  metadata.gz: eb30d9b5f2bf621ba062a8aa1d70b8eb3f9224bccadf13ac7e08a3a36856c551761f35affec2c653f4b6f16c4b1d5af75fb16cf126ba77be5d14b4e0918178c0
+  data.tar.gz: a18d973aefddb4c97b5dbfb3d7e92b4d5396c59aba1dd8b3fc9694c5dd95da3e94f0cfc0a7d93595f25827e5268683a3786fbbcc3fc018e91e21286929edcb3d

data/CHANGELOG.md

@@ -5,6 +5,11 @@
 * require release block lines to be ordered in descending severity
 * disable strict semver version validation before 1.0.0
 
+## RELEASE 0.11.0
+
+* FEATURE: `changelog:preview` task will output a preview of the release section that `changelog:compile` would add to the changelog
+* ENHANCEMENT: the `changelog:compile` task now shows up in rake -T listings
+
 ## RELEASE 0.10.2
 
 * ENHANCEMENT: release lines can now be embedded in any commit message body

data/README.md

@@ -65,7 +65,7 @@ as usual to actually release your gem.
 
 ## Viewing Release Notes
 
-To view the release notes of the current release:`
+To view the release notes of the current release:
 
     $ rake changelog:notes
     $ rake changelog:notes[current]

data/lib/structured_changelog/release_preview.rb

@@ -0,0 +1,50 @@
+require 'structured_changelog/core_ext/string'
+require 'structured_changelog/core_ext/gem'
+
+class StructuredChangelog
+  class ReleasePreview
+    def initialize(changelog:, repo:)
+      @changelog = changelog
+      @repo      = repo
+    end
+
+    def to_s
+      "## RELEASE #{new_version}\n\n#{release_notes}"
+    end
+
+    def empty?
+      release_notes.empty?
+    end
+
+    private
+
+    attr_reader :changelog, :repo
+
+    def release_notes
+      @release_notes ||= repo.log.between("v#{current_version}").
+        map(&:message).
+        flat_map { |message| message.split("\n") }.
+        grep(/^\*\ (BREAKING|FEATURE|ENHANCEMENT|FIX|DEPRECATION)\:/).
+        map(&:strip).
+        join("\n")
+    end
+
+    def current_version
+      @current_version ||= changelog.version
+    end
+
+    def new_version
+      @new_version ||= if release_notes.match?(/^*\ BREAKING:/)
+                         current_version.bump_major
+                       elsif release_notes.match?(/^*\ FEATURE:/)
+                         current_version.bump_minor
+                       elsif release_notes.match?(/^*\ FIX:/)
+                         current_version.bump_patch
+                       elsif release_notes.match?(/^*\ ENHANCEMENT:/)
+                         current_version.bump_patch
+                       elsif release_notes.match?(/^*\ DEPRECATION:/)
+                         current_version.bump_patch
+                       end
+    end
+  end
+end

data/lib/structured_changelog/roadmap.rb

@@ -31,7 +31,7 @@ class StructuredChangelog
         end
       end
 
-      Gem::Version.new(nil)
+      Gem::Version.new("")
     end
 
     private

data/lib/structured_changelog/tasks/compile.rb

@@ -1,41 +1,26 @@
-require 'structured_changelog'
-require 'structured_changelog/core_ext/string'
-require 'structured_changelog/core_ext/gem'
 require 'git'
 
+require 'structured_changelog'
+require 'structured_changelog/release_preview'
+
+desc "Pull all release lines from git commits since the last release and insert them into a release section in the changelog"
 task "changelog:compile", [:repo_path, :changelog_path] do |_task, arguments|
   repo_path      = arguments.to_h.fetch(:repo_path)      { Pathname.pwd }
   changelog_path = arguments.to_h.fetch(:changelog_path) { Pathname.pwd/"CHANGELOG.md" }
 
-  current_version = StructuredChangelog.new(changelog_path).version
+  changelog = StructuredChangelog.new(changelog_path)
 
-  repo = Git.open(repo_path)
-
-  release_notes = repo.log.between("v#{current_version}").
-    map(&:message).
-    flat_map { |message| message.split("\n") }.
-    grep(/^\*\ (BREAKING|FEATURE|ENHANCEMENT|FIX|DEPRECATION)\:/).
-    map(&:strip).
-    join("\n")
-
-  abort("No release notes since the last release") if release_notes.empty?
+  release_preview = StructuredChangelog::ReleasePreview.new(
+    changelog: changelog,
+    repo:      Git.open(repo_path),
+  )
 
-  new_version = if release_notes.match?(/^*\ BREAKING:/)
-                  current_version.bump_major
-                elsif release_notes.match?(/^*\ FEATURE:/)
-                  current_version.bump_minor
-                elsif release_notes.match?(/^*\ FIX:/)
-                  current_version.bump_patch
-                elsif release_notes.match?(/^*\ ENHANCEMENT:/)
-                  current_version.bump_patch
-                elsif release_notes.match?(/^*\ DEPRECATION:/)
-                  current_version.bump_patch
-                end
+  abort("No release notes since the last release") if release_preview.empty?
 
   changelog_path.write(
     changelog_path.read.sub(
-      /^##\ RELEASE\ #{current_version}/,
-      "## RELEASE #{new_version}\n\n#{release_notes}\n\n## RELEASE #{current_version}"
+      /^##\ RELEASE\ #{changelog.version}/,
+      "#{release_preview}\n\n## RELEASE #{changelog.version}"
     )
   )
 end

data/lib/structured_changelog/tasks/preview.rb

@@ -0,0 +1,21 @@
+require 'git'
+
+require 'structured_changelog'
+require 'structured_changelog/release_preview'
+
+desc "View the release section changelog:compile would insert into the changelog without actually doing so"
+task 'changelog:preview', [:repo_path, :changelog_path] do |_task, arguments|
+  repo_path      = arguments.to_h.fetch(:repo_path)      { Pathname.pwd }
+  changelog_path = arguments.to_h.fetch(:changelog_path) { Pathname.pwd/"CHANGELOG.md" }
+
+  changelog = StructuredChangelog.new(changelog_path)
+
+  release_preview = StructuredChangelog::ReleasePreview.new(
+    changelog: changelog,
+    repo:      Git.open(repo_path),
+  )
+
+  abort("No release notes since the last release") if release_preview.empty?
+
+  puts release_preview.to_s
+end

data/lib/structured_changelog/version.rb

@@ -1,3 +1,3 @@
 class StructuredChangelog
-  VERSION = "0.10.2"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structured_changelog
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,12 +137,14 @@ files:
 - lib/structured_changelog/release_filters/matches_versions_between.rb
 - lib/structured_changelog/release_filters/matches_versions_greater_than_or_equal_to.rb
 - lib/structured_changelog/release_filters/matches_versions_less_than_or_equal_to.rb
+- lib/structured_changelog/release_preview.rb
 - lib/structured_changelog/roadmap.rb
 - lib/structured_changelog/tasks.rb
 - lib/structured_changelog/tasks/commit.rb
 - lib/structured_changelog/tasks/compile.rb
 - lib/structured_changelog/tasks/notes.rb
 - lib/structured_changelog/tasks/prep.rb
+- lib/structured_changelog/tasks/preview.rb
 - lib/structured_changelog/tasks/recent.rb
 - lib/structured_changelog/tasks/release.rb
 - lib/structured_changelog/tasks/sync.rb
@@ -170,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: A useful changelog, for a change.