structured_changelog 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0278b9063784473fbb20ccbf450c0b88df4c5295
-  data.tar.gz: 048479b8e751253f690a60d325ec50c15aba2062
+  metadata.gz: d62c6e49c9b39e054dcf91503691a586b8a29215
+  data.tar.gz: 06ef5d163ed5f36450182dd266dc211371e01c24
 SHA512:
-  metadata.gz: cc9651df70ac1ead474b14ece1ebac6f8a612da52dc6c72a68e0844915a27f0799a042473c975b33a9e98dba9af34e5c2235968901215c8e8c36501b73ced105
-  data.tar.gz: baf20d1048c3742f2330ce418e1dc73c07606999ea5f148e6289fb4a64d475d849ccd3351ae14bc3061d094ab1783cc711cba63d6d3bf1f29481e818bc1293ea
+  metadata.gz: ca72358aaabf311f18b8f6e24dead1bb049f4b0dfe235186965c9c1e679ed4cae8bf3cde16f8a1fba8141eb4ea94684d631cf12b8447de36ca63b8197237b46a
+  data.tar.gz: 127e75076921602f0225b2693b72fb873250569b301a2408571302f44c72bb0a40f72a0acc164dfb1ac0ea4e05083d40d6675b0a7c469afd88caca9c5b39fe4f

data/CHANGELOG.md

@@ -1,10 +1,21 @@
+## ROADMAP 1.1.0
+
+* investigate partial parsing of a file if parsing slows down *too much* on large changelogs
+
 ## ROADMAP 1.0.0
 
+* consider moving from BREAKING/FEATURE/FIX to MAJOR/MINOR/PATCH
 * validate that each line starts with BREAKING:/FEATURE:/FIX:
 * validate that each release has the appropriate version
 * validate that release numbers increase monotonically
-* support variant versions (rc1, pre, alpha, etc..)
 * 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.6.0
+
+* FEATURE: variant versions (rc1, pre, alpha, etc..) are supported
+* FEATURE: non-numbered roadmap versions (for un-released but immediate work) are now supported
 
 ## RELEASE 0.5.0
 

data/README.md

@@ -10,38 +10,50 @@ require 'structured_changelog'
 MyProject::VERSION = StructuredChangeog.new("path/to/CHANGELOG.md").version
 ```
 
-To add `rake structured_changelog:validate` and make it part of `rake release`, add this to your `Rakefile`:
+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`:
 
 ```ruby
 require 'structured_changelog/tasks'
 ```
 
-## Shiny Rake 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:
+
+## Wonderful Rake Tasks
 
 To validate your changelog:
 
-    $ bundle exec rake changelog:validate
+    $ rake changelog:validate
+
+To determine what version you're on:
+
+    $ rake changelog:version
+
+To view the release notes of the current release:
+
+    $ rake changelog:notes
+    $ rake changelog:notes[current]
     
-To view your the release notes of every release:
+To view the release notes of every release:
 
-    $ bundle exec rake changelog:notes
-    $ bundle exec rake changelog:notes[ALL]
+    $ rake changelog:notes[all]
 
 for a specific release:
 
-    $ bundle exec rake changelog:notes[1.0.4]
+    $ rake changelog:notes[1.0.4]
 
 for all releases inclusively after a given release:
 
-    $ bundle exec rake changelog:notes[1.0.4<]
-    
+    $ rake changelog:notes[1.0.4<]
+
 for all releases inclusively before a given release:
 
-    $ bundle exec rake changelog:notes[<2.0.4]
+    $ rake changelog:notes[<2.0.4]
 
 for all releases inclusively between two releases:
 
-    $ bundle exec rake changelog:notes[1.0.4<2.0.4]
+    $ rake changelog:notes[1.0.4<2.0.4]
 
 ## Installation
 

data/lib/structured_changelog/release.rb

@@ -2,8 +2,12 @@ class StructuredChangelog
   class Release
     attr_reader :contents
 
+    def self.start_with?(line)
+      line =~ pattern
+    end
+
     def self.pattern
-      /^## RELEASE (?<version>\d+\.\d+\.\d+)$/
+      /^## RELEASE (?<version>\S+)$/
     end
 
     def initialize(contents)

data/lib/structured_changelog/roadmap.rb

@@ -1,7 +1,15 @@
 class StructuredChangelog
   class Roadmap
-    def self.pattern
-      /^## ROADMAP (?<version>\d+\.\d+\.\d+)$/
+    def self.start_with?(line)
+      patterns.any? { |pattern| line =~ pattern }
+    end
+
+    def self.patterns
+      [
+        /^## ROADMAP (?<version>\S+)$/,
+        /^## ROADMAP/,
+        /^## NEXT RELEASE/,
+      ]
     end
 
     def <=>(roadmap)
@@ -13,7 +21,13 @@ class StructuredChangelog
     end
 
     def version
-      contents.match(self.class.pattern)[:version]
+      self.class.patterns.each do |pattern|
+        match = contents.match(pattern)
+
+        return match[:version] if match && match.names.include?('version')
+      end
+
+      nil
     end
 
     private

data/lib/structured_changelog.rb

@@ -49,11 +49,11 @@ class StructuredChangelog
     capture = []
 
     [*path.readlines, :EOF].each do |line|
-      if line == :EOF || line =~ Roadmap.pattern || line =~ Release.pattern
-        if capture.first =~ Roadmap.pattern
+      if line == :EOF || Roadmap.start_with?(line) || Release.start_with?(line)
+        if Roadmap.start_with?(capture.first)
           roadmaps << Roadmap.new(capture.join)
           capture = []
-        elsif capture.first =~ Release.pattern
+        elsif Release.start_with?(capture.first)
           releases << Release.new(capture.join)
           capture = []
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structured_changelog
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-06 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler