structured_changelog 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dc0955b9d3778a3aee7b311988b678f99ebac61
-  data.tar.gz: 1a14c160348f75794c29542fd72acb2478715d9a
+  metadata.gz: d179945efda81f57f447465b6ef868a8d8fb4c99
+  data.tar.gz: 6870615bbad1bf31b59d3ec8081df87415b344d1
 SHA512:
-  metadata.gz: 6ba050c8aa47957bc20126a9c8ac1c1a799ec3efa5eb40c0b94738598f329182ba82a9b6f05eb169e03ec7daeaecc0d1e6e80d089c4b527edc6292f7306fe7a6
-  data.tar.gz: 51378226b8f268054ef67dd196a29f39914f64d5b18dbbe43bbacd7631b423caf42d20831eb4cee16dbb3247857c0a3cd2a383de4c450ce44f2690d9a7c59be2
+  metadata.gz: 6fe02b7fbf1fe89edbe137c1f9ee9debf0536c4de9806223aa59321b01cd7565b06b37ba1e5a221d29beb7ed5e58d18861a6809c2ca25d589f5ce4b6fd51bc74
+  data.tar.gz: 8080b55e01dd378ffce14af3835aef6634635c5020eada121ddbc74bb77b7e1c03d5eb2462f0ab4d0dbb84cca09a38f09f8af556b0c7447b9c5f941863c9f51f

data/CHANGELOG.md

@@ -8,10 +8,14 @@
 * validate that each line starts with BREAKING:/FEATURE:/FIX:
 * validate that each release has the appropriate version
 * validate that release numbers increase monotonically
-* centralize the version regex (if possible)
 * require release block lines to be ordered in descending severity
 * disable strict semver version validation before 1.0.0
 
+## RELEASE 0.7.1
+
+* FIX: stopped trying to hijack gem tasks, as that led to errors in downstream projects
+* FIX: added missing require
+
 ## RELEASE 0.7.0
 
 * FEATURE: rake changelog:recent displays the N most recent release sections

data/README.md

@@ -10,15 +10,13 @@ require 'structured_changelog'
 MyProject::VERSION = StructuredChangeog.new("path/to/CHANGELOG.md").version
 ```
 
-If you use `rake release` to release new code, & want changelog validation to be a part of that release task, you can add this to your `Rakefile`:
+You can also add this to your Rakefile:
 
 ```ruby
 require 'structured_changelog/tasks'
 ```
 
-(This will execute code that injects the `changelog:validate` task into the list of tasks `rake release` runs before performing a release.)
-
-You'll also get these other wonderful rake tasks:
+You'll get these other wonderful rake tasks:
 
 ## Wonderful Rake Tasks
 
@@ -45,15 +43,23 @@ for a specific release:
 
 for all releases inclusively after a given release:
 
-    $ rake changelog:notes[1.0.4<]
+    $ rake changelog:notes[1.0.4 <]
 
 for all releases inclusively before a given release:
 
-    $ rake changelog:notes[<2.0.4]
+    $ rake changelog:notes[< 2.0.4]
 
 for all releases inclusively between two releases:
 
-    $ rake changelog:notes[1.0.4<2.0.4]
+    $ rake changelog:notes[1.0.4 < 2.0.4]
+
+To view the last 3 releases:
+
+    $ rake changelog:recent
+
+To view the last N releases:
+
+    $ rake changelog:recent[N]
 
 ## Installation
 

data/lib/structured_changelog/release.rb

@@ -1,3 +1,5 @@
+require 'structured_changelog/version_pattern'
+
 class StructuredChangelog
   class Release
     attr_reader :contents
@@ -7,7 +9,7 @@ class StructuredChangelog
     end
 
     def self.pattern
-      /^## RELEASE (?<version>\d+\.\d+\.\d+\S*)$/
+      /^## RELEASE #{VersionPattern}$/
     end
 
     def initialize(contents)

data/lib/structured_changelog/release_filters/matches_single_version.rb

@@ -1,10 +1,11 @@
 require 'structured_changelog/release_filters/base'
+require 'structured_changelog/version_pattern'
 
 class StructuredChangelog
   module ReleaseFilters
     class MatchesSingleVersion < Base
       def self.pattern
-        /^\d+\.\d+\.\d+\S*$/
+        /^#{VersionPattern}$/
       end
 
       def filter_releases(releases)

data/lib/structured_changelog/release_filters/matches_versions_between.rb

@@ -1,10 +1,11 @@
 require 'structured_changelog/release_filters/base'
+require 'structured_changelog/version_pattern'
 
 class StructuredChangelog
   module ReleaseFilters
     class MatchesVersionsBetween < Base
       def self.pattern
-        /^(?<floor>\d+\.\d+\.\d+\S*)\ \<\ (?<ceiling>\d+\.\d+\.\d+\S*)$/
+        /^(?<floor>#{VersionPattern})\ \<\ (?<ceiling>#{VersionPattern})$/
       end
 
       def filter_releases(releases)

data/lib/structured_changelog/release_filters/matches_versions_greater_than_or_equal_to.rb

@@ -1,10 +1,11 @@
 require 'structured_changelog/release_filters/base'
+require 'structured_changelog/version_pattern'
 
 class StructuredChangelog
   module ReleaseFilters
     class MatchesVersionsGreaterThanOrEqualTo < Base
       def self.pattern
-        /^(?<version>\d+\.\d+\.\d+\S*)\ \<$/
+        /^#{VersionPattern}\ \<$/
       end
 
       def filter_releases(releases)

data/lib/structured_changelog/release_filters/matches_versions_less_than_or_equal_to.rb

@@ -1,10 +1,11 @@
 require 'structured_changelog/release_filters/base'
+require 'structured_changelog/version_pattern'
 
 class StructuredChangelog
   module ReleaseFilters
     class MatchesVersionsLessThanOrEqualTo < Base
       def self.pattern
-        /^\<\ (?<version>\d+\.\d+\.\d+\S*)$/
+        /^\<\ #{VersionPattern}$/
       end
 
       def filter_releases(releases)

data/lib/structured_changelog/release_filters.rb

@@ -1,7 +1,7 @@
 Dir[File.join(File.dirname(__FILE__), "release_filters", "*.rb")].each(&method(:require))
 
 class StructuredChangelog
-  IllegalQuery = Class.new(StandardError)
+  class IllegalQuery < StandardError; end
 
   module ReleaseFilters
     def self.filter_for(query)

data/lib/structured_changelog/roadmap.rb

@@ -1,3 +1,5 @@
+require 'structured_changelog/version_pattern'
+
 class StructuredChangelog
   class Roadmap
     def self.start_with?(line)
@@ -6,7 +8,7 @@ class StructuredChangelog
 
     def self.patterns
       [
-        /^## ROADMAP (?<version>\d+\.\d+\.\d+\S*)$/,
+        /^## ROADMAP #{VersionPattern}$/,
         /^## ROADMAP/,
         /^## NEXT RELEASE/,
       ]

data/lib/structured_changelog/tasks/validate.rb

@@ -1,4 +1,4 @@
-require 'bundler/gem_tasks'
+# require 'bundler/gem_tasks'
 require 'structured_changelog'
 
 desc 'Validate your Structured Changelog'
@@ -8,8 +8,8 @@ task 'changelog:validate', [:path] do |_task, arguments|
   puts "\e[32mValid #{path}\e[0m" if StructuredChangelog.new(path).validate
 end
 
-if (guard_clean_task = Rake::Task['release:guard_clean'])
-  guard_clean_task.enhance(['changelog:validate'])
-elsif (release_task = Rake::Task['release'])
-  release_task.enhance(['changelog:validate'])
-end
+# if (guard_clean_task = Rake::Task['release:guard_clean'])
+#   guard_clean_task.enhance(['changelog:validate'])
+# elsif (release_task = Rake::Task['release'])
+#   release_task.enhance(['changelog:validate'])
+# end

data/lib/structured_changelog/version_pattern.rb

@@ -0,0 +1,3 @@
+class StructuredChangelog
+  VersionPattern = /(?<version>\d+\.\d+\.\d+\S*)/
+end

data/lib/structured_changelog.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'set'
 require 'structured_changelog/release'
 require 'structured_changelog/roadmap'
 require 'structured_changelog/release_filters'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structured_changelog
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,7 @@ files:
 - lib/structured_changelog/tasks/validate.rb
 - lib/structured_changelog/tasks/version.rb
 - lib/structured_changelog/version.rb
+- lib/structured_changelog/version_pattern.rb
 - structured_changelog.gemspec
 homepage: https://www.github.com/yarmiganosca/structured_changelog
 licenses: []