structured_changelog 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4db7e3d5f302817c0c4aa3f8ffd0ed1321d920cb
-  data.tar.gz: 22620aa15246bfbfaea108c249de4b75858e7dc8
+  metadata.gz: 664aee7c11b7b9ca26529a0a8b2e008598684c74
+  data.tar.gz: e5178e0f57a8b66084b0ddf231f78b6d32867c09
 SHA512:
-  metadata.gz: 3c91cceda7fc38e3db6a4ce61f7383302495a81a53f253c6d2f25bc014f78e21571d13ab3e28c65246677a142a96c4fd0e7eaa8df3e41ef417d9d7f15e3fbd73
-  data.tar.gz: 0cef48170939af44951045bcce804aa5b243352e5602a0112500138dcf6de82dfcfcf2a1e77feaed88bea9bce627abeed89cbe343bc35881aee5029a61b561b6
+  metadata.gz: 0ca2f2a8cbf4b9f17f62fc49a552e6f861ed338d08017e73291d95cb0196c671f28be902a3b0848468237df5a777f1cf9be6927c8a8bf8c197aa684000fa1651
+  data.tar.gz: 01f883a91e896e01e5d4306f0c1d0e7f5f71daa418bd027c689beda1d43c422a66b7eb2e5d6cea7d95976edd204c912358f5f00fb8fe8482a931529ea99dc13e

data/CHANGELOG.md

@@ -11,6 +11,11 @@
 * require release block lines to be ordered in descending severity
 * disable strict semver version validation before 1.0.0
 
+## RELEASE 0.8.0
+
+* FEATURE: `rake changelog:sync` will update your gem's VERSION constant to your changelog's latest release version. This will let devs stop requiring `structured_changelog` to be installed before they can bundle their projects.
+* FEATURE: `rake changelog:release` will validate the Changelog, sync the Changelog release to `VERSION`, commit the version bump, then proceed with the default `rake release` task.
+
 ## RELEASE 0.7.2
 
 * FIX: fixed version comparison

data/README.md

@@ -1,30 +1,39 @@
 # StructuredChangelog
 
-You have a changelog in your repo, right? Great! Then what do you need with a `VERSION` constant?
+You have a changelog in your repo, right? Great! Then you'll never need to manually update your `VERSION` constant again!
 
-To parse your gem's current version from your changelog, put this in `lib/myproject/version.rb`:
+Add this to your Rakefile:
 
 ```ruby
-require 'structured_changelog'
-
-MyProject::VERSION = StructuredChangeog.new("path/to/CHANGELOG.md").version
+require 'structured_changelog/tasks'
 ```
 
-You can also add this to your Rakefile:
+This will create a `rake changelog:release` task that:
 
-```ruby
-require 'structured_changelog/tasks'
-```
+1. validates your `CHANGELOG.md`
+2. sets your gem's `VERSION` constant to the latest release version specified by your `CHANGELOG.md`
+3. commits that version bump
+4. runs `rake release`
 
-You'll get these other wonderful rake tasks:
+Turns out modifying `rake release` was _way_ more trouble than it was worth, so we had to make a separate task. Sorry folks.
+
+You'll also get these wonderful rake tasks:
 
 ## Wonderful Rake Tasks
 
 To validate your changelog:
 
     $ rake changelog:validate
+    
+To update your gem's `VERSION` constant to the latest release in your Changelog:
+
+    $ rake changelog:sync
+
+To commit your version bump--and only your version bump:
+
+    $ rake changelog:commit
 
-To determine what version you're on:
+To determine the version of the latest release *according to the Changelog*:
 
     $ rake changelog:version
 

data/lib/structured_changelog/tasks/commit.rb

@@ -0,0 +1,29 @@
+require 'structured_changelog'
+require 'git'
+
+desc 'Commit changes to the Changelog & version files as necessary'
+task 'changelog:commit', [:repo_path, :changelog_path, :version_path] do |_task, arguments|
+  repo_path      = arguments.to_h.fetch(:repo_path)      { Pathname.pwd }
+  changelog_path = arguments.to_h.fetch(:changelog_path) { "CHANGELOG.md" }
+  version_path   = arguments.to_h.fetch(:version_path)   { "lib/#{Pathname.pwd.basename}/version.rb"}
+
+  changelog = StructuredChangelog.new(changelog_path)
+  repo      = Git.open(repo_path)
+
+  if repo.status.deleted.any?
+    abort "Please commit all file deletions before bumping the version."
+  end
+
+  if repo.status.added.any?
+    abort "Please commit all new files before bumping the version."
+  end
+
+  if repo.status.changed.keys.sort != [changelog_path, version_path].sort
+    abort "Please commit all files that aren't #{changelog_path} or #{version_path} before bumping the version."
+  end
+
+  repo.add([changelog_path, version_path])
+  repo.commit("Version bump to #{changelog.version}")
+
+  puts "Commited 'Version bumped to #{changelog.version}'"
+end

data/lib/structured_changelog/tasks/release.rb

@@ -0,0 +1,15 @@
+desc "Validates your Changelog, updates your VERSION constant, commits that, then releases your gem."
+task 'changelog:release', [:repo_path, :changelog_path, :version_path] do |_task, arguments|
+  Rake::Task['changelog:validate'].execute(arguments)
+  Rake::Task['changelog:sync'].execute(arguments)
+  Rake::Task['changelog:commit'].execute(arguments)
+
+  # Merely requiring `bundler/gem_tasks` instantiates & caches a gemspec. At this point in this code,
+  # it's already set and attached to the `Bundler::GemHelper` module. In fact, it's there before this
+  # file is laoded at all. This means that our changes to the filesystem won't change the version bundler
+  # thinks our gem is. We could instantiate another gemspec and attach it, or we could try modifying the
+  # gemspec in situ, but both would be extremely brittle. What we do instead, is start another process,
+  # and because that process doesn't have the state ours does already, our changes to the filesystem will
+  # be picked up, and we'll actually cut a release of the new version.
+  exec('rake release')
+end

data/lib/structured_changelog/tasks/sync.rb

@@ -0,0 +1,15 @@
+require 'structured_changelog'
+require 'structured_changelog/version_pattern'
+
+desc "Set the gem's VERSION constant to be the changelog's version"
+task 'changelog:sync', [:changelog_path, :version_path] do |_task, arguments|
+  changelog_path = arguments.to_h.fetch(:changelog_path) { "CHANGELOG.md" }
+  version_path   = arguments.to_h.fetch(:version_path)   { "lib/#{Pathname.pwd.basename}/version.rb"}
+
+  changelog    = StructuredChangelog.new(changelog_path)
+  version_file = Pathname.new(version_path)
+
+  version_file.write(version_file.read.gsub(StructuredChangelog::VersionPattern, changelog.version.to_s))
+
+  puts "Updated gem version to #{changelog.version}"
+end

data/lib/structured_changelog/version.rb

@@ -1,3 +1,3 @@
-require 'structured_changelog'
-
-StructuredChangelog::VERSION = StructuredChangelog.new("CHANGELOG.md").version
+class StructuredChangelog
+  VERSION = "0.8.0"
+end

data/lib/structured_changelog/version_pattern.rb

@@ -1,3 +1,3 @@
 class StructuredChangelog
-  VersionPattern = /(?<version>\d+\.\d+\.\d+\S*)/
+  VersionPattern = /(?<version>\d+\.\d+\.\d+[^\s\"\']*)/
 end

data/structured_changelog.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "fantaskspec"
+
+  spec.add_dependency 'git'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structured_changelog
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Version your gem through your changelog, not a VERSION constant.
 email:
 - yarmiganosca@gmail.com
@@ -123,8 +137,11 @@ files:
 - lib/structured_changelog/release_filters/matches_versions_less_than_or_equal_to.rb
 - lib/structured_changelog/roadmap.rb
 - lib/structured_changelog/tasks.rb
+- lib/structured_changelog/tasks/commit.rb
 - lib/structured_changelog/tasks/notes.rb
 - lib/structured_changelog/tasks/recent.rb
+- lib/structured_changelog/tasks/release.rb
+- lib/structured_changelog/tasks/sync.rb
 - lib/structured_changelog/tasks/validate.rb
 - lib/structured_changelog/tasks/version.rb
 - lib/structured_changelog/version.rb