structured_changelog 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71d85da1fe01d03fce4a37f8217be7eb23171232
-  data.tar.gz: 7f90cc3e3253bb41b44970789154df852a69937e
+  metadata.gz: 0278b9063784473fbb20ccbf450c0b88df4c5295
+  data.tar.gz: 048479b8e751253f690a60d325ec50c15aba2062
 SHA512:
-  metadata.gz: be77a461dea2b7ed531b1bbac9b34960e3a032761dc92c4c922ac199d6dff34f8b099c93f6b1964d8c87be131a2ef13d7cc748b5664532e180e2010402bf3602
-  data.tar.gz: 0f7cb255f3b8b31d2a975aeea479e207063b337e49065597fb135efa22c1140636ecced8d609443dcf5e70014cf8b7eda3c6b361b76ee51e7ba19a3ff5a0ee3f
+  metadata.gz: cc9651df70ac1ead474b14ece1ebac6f8a612da52dc6c72a68e0844915a27f0799a042473c975b33a9e98dba9af34e5c2235968901215c8e8c36501b73ced105
+  data.tar.gz: baf20d1048c3742f2330ce418e1dc73c07606999ea5f148e6289fb4a64d475d849ccd3351ae14bc3061d094ab1783cc711cba63d6d3bf1f29481e818bc1293ea

data/CHANGELOG.md

@@ -3,10 +3,17 @@
 * validate that each line starts with BREAKING:/FEATURE:/FIX:
 * validate that each release has the appropriate version
 * validate that release numbers increase monotonically
-* have a README
 * support variant versions (rc1, pre, alpha, etc..)
 * centralize the version regex (if possible)
 
+## RELEASE 0.5.0
+
+* FEATURE: a `rake changelog:version` to display the current version
+
+## RELEASE 0.4.1
+
+* FIX: with no query, `rake changelog:notes` outputs the notes of the current version (instead of all versions)
+
 ## RELEASE 0.4.0
 
 * FEATURE: view the release notes for a version (or range of versions) with "rake changelog:notes"

data/README.md

@@ -2,16 +2,12 @@
 
 You have a changelog in your repo, right? Great! Then what do you need with a `VERSION` constant?
 
-To parse your gem's current version right off your changelog, put this in `yourproject.gemspec`:
+To parse your gem's current version from your changelog, put this in `lib/myproject/version.rb`:
 
 ```ruby
 require 'structured_changelog'
 
-Gem::Specification.new do |spec|
-  ...
-  spec.version = StructuredChangeog.new("path/to/CHANGELOG.md").version
-  ...
-end
+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`:
@@ -20,8 +16,32 @@ To add `rake structured_changelog:validate` and make it part of `rake release`,
 require 'structured_changelog/tasks'
 ```
 
+## Shiny Rake Tasks
 
+To validate your changelog:
 
+    $ bundle exec rake changelog:validate
+    
+To view your the release notes of every release:
+
+    $ bundle exec rake changelog:notes
+    $ bundle exec rake changelog:notes[ALL]
+
+for a specific release:
+
+    $ bundle exec rake changelog:notes[1.0.4]
+
+for all releases inclusively after a given release:
+
+    $ bundle exec rake changelog:notes[1.0.4<]
+    
+for all releases inclusively before a given release:
+
+    $ bundle exec rake changelog:notes[<2.0.4]
+
+for all releases inclusively between two releases:
+
+    $ bundle exec rake changelog:notes[1.0.4<2.0.4]
 
 ## Installation
 

data/lib/structured_changelog.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 require 'structured_changelog/release'
 require 'structured_changelog/roadmap'
-require 'structured_changelog/release_comparators'
+require 'structured_changelog/release_filters'
 
 class StructuredChangelog
   attr_reader :path, :releases, :roadmaps
@@ -34,9 +34,9 @@ class StructuredChangelog
   end
 
   def find_releases(query)
-    comparator = ReleaseComparators.comparator_for(query)
-
-    releases.select(&comparator)
+    ReleaseFilters
+      .filter_for(query)
+      .filter_releases(releases)
   end
 
   private

data/lib/structured_changelog/release.rb

@@ -7,7 +7,7 @@ class StructuredChangelog
     end
 
     def initialize(contents)
-      @contents = contents
+      @contents = contents.strip
     end
 
     def validate

data/lib/structured_changelog/release_filters.rb

@@ -0,0 +1,32 @@
+Dir[File.join(File.dirname(__FILE__), "release_filters", "*.rb")].each(&method(:require))
+
+class StructuredChangelog
+  IllegalQuery = Class.new(StandardError)
+
+  module ReleaseFilters
+    def self.filter_for(query)
+      filter_class = filter_class_for_query(query)
+
+      raise IllegalQuery.new(query) unless filter_class
+
+      filter_class.new(query)
+    end
+
+    def self.filter_class_for_query(query)
+      filter_classes.find do |filter_class|
+        filter_class.appropriate_for_query?(query)
+      end
+    end
+
+    def self.filter_classes
+      [
+        MatchesCurrentVersion,
+        MatchesAllVersions,
+        MatchesSingleVersion,
+        MatchesVersionsGreaterThanOrEqualTo,
+        MatchesVersionsLessThanOrEqualTo,
+        MatchesVersionsBetween
+      ]
+    end
+  end
+end

data/lib/structured_changelog/{release_comparators → release_filters}/base.rb

@@ -1,5 +1,5 @@
 class StructuredChangelog
-  module ReleaseComparators
+  module ReleaseFilters
     class Base
       def self.appropriate_for_query?(query)
         !query.match(pattern).nil?
@@ -9,10 +9,6 @@ class StructuredChangelog
         @query = query
       end
 
-      def to_proc
-        method(:call).to_proc
-      end
-
       private
 
       attr_reader :query

data/lib/structured_changelog/release_filters/matches_all_versions.rb

@@ -0,0 +1,15 @@
+require 'structured_changelog/release_filters/base'
+
+class StructuredChangelog
+  module ReleaseFilters
+    class MatchesAllVersions < Base
+      def self.pattern
+        /^all$/
+      end
+
+      def filter_releases(releases)
+        releases
+      end
+    end
+  end
+end

data/lib/structured_changelog/release_filters/matches_current_version.rb

@@ -0,0 +1,15 @@
+require 'structured_changelog/release_filters/base'
+
+class StructuredChangelog
+  module ReleaseFilters
+    class MatchesCurrentVersion < Base
+      def self.pattern
+        /^current$/
+      end
+
+      def filter_releases(releases)
+        [releases.max]
+      end
+    end
+  end
+end

data/lib/structured_changelog/release_filters/matches_single_version.rb

@@ -0,0 +1,17 @@
+require 'structured_changelog/release_filters/base'
+
+class StructuredChangelog
+  module ReleaseFilters
+    class MatchesSingleVersion < Base
+      def self.pattern
+        /^\d+\.\d+\.\d+$/
+      end
+
+      def filter_releases(releases)
+        releases.select do |release|
+          release.version == query
+        end
+      end
+    end
+  end
+end

data/lib/structured_changelog/{release_comparators → release_filters}/matches_versions_between.rb

@@ -1,14 +1,16 @@
-require 'structured_changelog/release_comparators/base'
+require 'structured_changelog/release_filters/base'
 
 class StructuredChangelog
-  module ReleaseComparators
+  module ReleaseFilters
     class MatchesVersionsBetween < Base
       def self.pattern
         /^(?<floor>\d+\.\d+\.\d+)\<(?<ceiling>\d+\.\d+\.\d+)$/
       end
 
-      def call(release)
-        floor < release.version && release.version < ceiling
+      def filter_releases(releases)
+        releases.select do |release|
+          floor <= release.version && release.version <= ceiling
+        end
       end
 
       private

data/lib/structured_changelog/{release_comparators → release_filters}/matches_versions_greater_than_or_equal_to.rb

@@ -1,14 +1,16 @@
-require 'structured_changelog/release_comparators/base'
+require 'structured_changelog/release_filters/base'
 
 class StructuredChangelog
-  module ReleaseComparators
+  module ReleaseFilters
     class MatchesVersionsGreaterThanOrEqualTo < Base
       def self.pattern
         /^(?<version>\d+\.\d+\.\d+)\<$/
       end
 
-      def call(release)
-        version <= release.version
+      def filter_releases(releases)
+        releases.select do |release| 
+          version <= release.version
+        end
       end
 
       private

data/lib/structured_changelog/{release_comparators → release_filters}/matches_versions_less_than_or_equal_to.rb

@@ -1,14 +1,16 @@
-require 'structured_changelog/release_comparators/base'
+require 'structured_changelog/release_filters/base'
 
 class StructuredChangelog
-  module ReleaseComparators
+  module ReleaseFilters
     class MatchesVersionsLessThanOrEqualTo < Base
       def self.pattern
         /^\<(?<version>\d+\.\d+\.\d+)$/
       end
 
-      def call(release)
-        release.version <= version
+      def filter_releases(releases)
+        releases.select do |release| 
+          release.version <= version
+        end
       end
 
       private

data/lib/structured_changelog/roadmap.rb

@@ -9,7 +9,7 @@ class StructuredChangelog
     end
 
     def initialize(contents)
-      @contents = contents
+      @contents = contents.strip
     end
 
     def version

data/lib/structured_changelog/tasks/notes.rb

@@ -2,14 +2,12 @@ require 'structured_changelog'
 
 desc "Display Release Notes for One or Multiple Versions"
 task "changelog:notes", [:query, :path] do |_task, arguments|
-  query = arguments.to_h.fetch(:query) { "ALL" }
+  query = arguments.to_h.fetch(:query) { "current" }
   path  = arguments.to_h.fetch(:path)  { "CHANGELOG.md" }
 
   changelog = StructuredChangelog.new(path)
   releases  = changelog.find_releases(query)
 
-  releases.each do |release|
-    puts release.contents
-  end
+  puts releases.map(&:contents).join("\n\n")
 end
 

data/lib/structured_changelog/tasks/version.rb

@@ -0,0 +1,10 @@
+require 'structured_changelog'
+
+desc 'Display the Current Version'
+task 'changelog:version', [:path] do |_task, arguments|
+  path = arguments.to_h.fetch(:path) { "CHANGELOG.md" }
+
+  changelog = StructuredChangelog.new(path)
+
+  puts changelog.version
+end

data/lib/structured_changelog/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structured_changelog
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-04 00:00:00.000000000 Z
+date: 2016-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,17 +113,19 @@ files:
 - bin/setup
 - lib/structured_changelog.rb
 - lib/structured_changelog/release.rb
-- lib/structured_changelog/release_comparators.rb
-- lib/structured_changelog/release_comparators/base.rb
-- lib/structured_changelog/release_comparators/matches_all_versions.rb
-- lib/structured_changelog/release_comparators/matches_single_version.rb
-- lib/structured_changelog/release_comparators/matches_versions_between.rb
-- lib/structured_changelog/release_comparators/matches_versions_greater_than_or_equal_to.rb
-- lib/structured_changelog/release_comparators/matches_versions_less_than_or_equal_to.rb
+- lib/structured_changelog/release_filters.rb
+- lib/structured_changelog/release_filters/base.rb
+- lib/structured_changelog/release_filters/matches_all_versions.rb
+- lib/structured_changelog/release_filters/matches_current_version.rb
+- lib/structured_changelog/release_filters/matches_single_version.rb
+- 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/roadmap.rb
 - lib/structured_changelog/tasks.rb
 - lib/structured_changelog/tasks/notes.rb
 - lib/structured_changelog/tasks/validate.rb
+- lib/structured_changelog/tasks/version.rb
 - lib/structured_changelog/version.rb
 - structured_changelog.gemspec
 homepage: https://www.github.com/yarmiganosca/structured_changelog

data/lib/structured_changelog/release_comparators.rb

@@ -1,31 +0,0 @@
-Dir[File.join(File.dirname(__FILE__), "release_comparators", "*.rb")].each(&method(:require))
-
-class StructuredChangelog
-  IllegalQuery = Class.new(StandardError)
-
-  module ReleaseComparators
-    def self.comparator_for(query)
-      comparator_class = comparator_class_for_query(query)
-
-      raise IllegalQuery.new(query) unless comparator_class
-
-      comparator_class.new(query)
-    end
-
-    def self.comparator_class_for_query(query)
-      comparator_classes.find do |comparator_class|
-        comparator_class.appropriate_for_query?(query)
-      end
-    end
-
-    def self.comparator_classes
-      [
-        MatchesAllVersions,
-        MatchesSingleVersion,
-        MatchesVersionsGreaterThanOrEqualTo,
-        MatchesVersionsLessThanOrEqualTo,
-        MatchesVersionsBetween
-      ]
-    end
-  end
-end

data/lib/structured_changelog/release_comparators/matches_all_versions.rb

@@ -1,15 +0,0 @@
-require 'structured_changelog/release_comparators/base'
-
-class StructuredChangelog
-  module ReleaseComparators
-    class MatchesAllVersions < Base
-      def self.pattern
-        /^ALL$/
-      end
-
-      def call(release)
-        true
-      end
-    end
-  end
-end

data/lib/structured_changelog/release_comparators/matches_single_version.rb

@@ -1,15 +0,0 @@
-require 'structured_changelog/release_comparators/base'
-
-class StructuredChangelog
-  module ReleaseComparators
-    class MatchesSingleVersion < Base
-      def self.pattern
-        /^\d+\.\d+\.\d+$/
-      end
-
-      def call(release)
-        release.version == query
-      end
-    end
-  end
-end