structured_changelog 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fac43fa564020667e2d18424ad4024610716f9d
-  data.tar.gz: 54c20df05a343f68973c7eb5e3ac2d4f13f0b50d
+  metadata.gz: 71d85da1fe01d03fce4a37f8217be7eb23171232
+  data.tar.gz: 7f90cc3e3253bb41b44970789154df852a69937e
 SHA512:
-  metadata.gz: 18be88ce8212caa08706eeba86971b346a04bcd933061a2b3b1fd0004f41e76cccb8cb53b597068fd942d7314ada658e3b46c22ea8ffcb0f330a07892c2c788e
-  data.tar.gz: 4ff2164d4a4289d481baa7994a6056b5de418969d8c26956856a3eac25af4a20c07bc53a80e6f157e97b89475e95b9447ab7b240b68c60218a8512e7cc94239f
+  metadata.gz: be77a461dea2b7ed531b1bbac9b34960e3a032761dc92c4c922ac199d6dff34f8b099c93f6b1964d8c87be131a2ef13d7cc748b5664532e180e2010402bf3602
+  data.tar.gz: 0f7cb255f3b8b31d2a975aeea479e207063b337e49065597fb135efa22c1140636ecced8d609443dcf5e70014cf8b7eda3c6b361b76ee51e7ba19a3ff5a0ee3f

data/CHANGELOG.md

@@ -1,16 +1,24 @@
-## ROADMAP 0.4.0
+## ROADMAP 1.0.0
 
-* FEATURE validation requires BREAKING/FEATURE/FIX prefixes for each line
+* 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.4.0
+
+* FEATURE: view the release notes for a version (or range of versions) with "rake changelog:notes"
 
 ## RELEASE 0.3.0
 
-* FEATURE include a rake task
-* FEATURE rake task includes color output
+* FEATURE: include a changelog:validate task
 
 ## RELEASE 0.2.0
 
-* FEATURE handle ROADMAP blocks
+* FEATURE: handle ROADMAP blocks
 
 ## RELEASE 0.1.0
 
-* FEATURE handle RELEASE blocks
+* FEATURE: handle RELEASE blocks

data/README.md

@@ -1,8 +1,27 @@
 # StructuredChangelog
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/structured_changelog`. To experiment with that code, run `bin/console` for an interactive prompt.
+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`:
+
+```ruby
+require 'structured_changelog'
+
+Gem::Specification.new do |spec|
+  ...
+  spec.version = StructuredChangeog.new("path/to/CHANGELOG.md").version
+  ...
+end
+```
+
+To add `rake structured_changelog:validate` and make it part of `rake release`, add this to your `Rakefile`:
+
+```ruby
+require 'structured_changelog/tasks'
+```
+
+
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,10 +39,6 @@ Or install it yourself as:
 
     $ gem install structured_changelog
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -32,5 +47,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/structured_changelog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/yarmiganosca/structured_changelog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require 'structured_changelog/task'
+require 'structured_changelog/tasks'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/structured_changelog.rb

@@ -1,6 +1,7 @@
 require 'pathname'
 require 'structured_changelog/release'
 require 'structured_changelog/roadmap'
+require 'structured_changelog/release_comparators'
 
 class StructuredChangelog
   attr_reader :path, :releases, :roadmaps
@@ -32,6 +33,12 @@ class StructuredChangelog
     notifications.empty?
   end
 
+  def find_releases(query)
+    comparator = ReleaseComparators.comparator_for(query)
+
+    releases.select(&comparator)
+  end
+
   private
 
   def latest_release

data/lib/structured_changelog/release.rb

@@ -1,5 +1,7 @@
 class StructuredChangelog
   class Release
+    attr_reader :contents
+
     def self.pattern
       /^## RELEASE (?<version>\d+\.\d+\.\d+)$/
     end
@@ -23,9 +25,5 @@ class StructuredChangelog
     def <=>(release)
       version <=> release.version
     end
-
-    private
-
-    attr_reader :contents
   end
 end

data/lib/structured_changelog/release_comparators.rb

@@ -0,0 +1,31 @@
+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/base.rb

@@ -0,0 +1,21 @@
+class StructuredChangelog
+  module ReleaseComparators
+    class Base
+      def self.appropriate_for_query?(query)
+        !query.match(pattern).nil?
+      end
+
+      def initialize(query)
+        @query = query
+      end
+
+      def to_proc
+        method(:call).to_proc
+      end
+
+      private
+
+      attr_reader :query
+    end
+  end
+end

data/lib/structured_changelog/release_comparators/matches_all_versions.rb

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,15 @@
+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

data/lib/structured_changelog/release_comparators/matches_versions_between.rb

@@ -0,0 +1,25 @@
+require 'structured_changelog/release_comparators/base'
+
+class StructuredChangelog
+  module ReleaseComparators
+    class MatchesVersionsBetween < Base
+      def self.pattern
+        /^(?<floor>\d+\.\d+\.\d+)\<(?<ceiling>\d+\.\d+\.\d+)$/
+      end
+
+      def call(release)
+        floor < release.version && release.version < ceiling
+      end
+
+      private
+
+      def floor
+        query.match(self.class.pattern)[:floor]
+      end
+
+      def ceiling
+        query.match(self.class.pattern)[:ceiling]
+      end
+    end
+  end
+end

data/lib/structured_changelog/release_comparators/matches_versions_greater_than_or_equal_to.rb

@@ -0,0 +1,21 @@
+require 'structured_changelog/release_comparators/base'
+
+class StructuredChangelog
+  module ReleaseComparators
+    class MatchesVersionsGreaterThanOrEqualTo < Base
+      def self.pattern
+        /^(?<version>\d+\.\d+\.\d+)\<$/
+      end
+
+      def call(release)
+        version <= release.version
+      end
+
+      private
+
+      def version
+        query.match(self.class.pattern)[:version]
+      end
+    end
+  end
+end

data/lib/structured_changelog/release_comparators/matches_versions_less_than_or_equal_to.rb

@@ -0,0 +1,21 @@
+require 'structured_changelog/release_comparators/base'
+
+class StructuredChangelog
+  module ReleaseComparators
+    class MatchesVersionsLessThanOrEqualTo < Base
+      def self.pattern
+        /^\<(?<version>\d+\.\d+\.\d+)$/
+      end
+
+      def call(release)
+        release.version <= version
+      end
+
+      private
+
+      def version
+        query.match(self.class.pattern)[:version]
+      end
+    end
+  end
+end

data/lib/structured_changelog/tasks.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'tasks', '*.rb')].each(&method(:require))

data/lib/structured_changelog/tasks/notes.rb

@@ -0,0 +1,15 @@
+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" }
+  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
+end
+

data/lib/structured_changelog/{task.rb → tasks/validate.rb}

@@ -2,14 +2,14 @@ require 'bundler/gem_tasks'
 require 'structured_changelog'
 
 desc 'Validate your Structured Changelog'
-task 'structured_changelog:validate', [:path] do |_task, arguments|
+task 'changelog:validate', [:path] do |_task, arguments|
   path = arguments.to_h.fetch(:path) { "CHANGELOG.md" }
 
   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(['structured_changelog:validate'])
+  guard_clean_task.enhance(['changelog:validate'])
 elsif (release_task = Rake::Task['release'])
-  release_task.enhance(['structured_changelog:validate'])
+  release_task.enhance(['changelog:validate'])
 end

data/lib/structured_changelog/version.rb

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

data/structured_changelog.gemspec

@@ -1,16 +1,16 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'structured_changelog'
+require 'structured_changelog/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "structured_changelog"
-  spec.version       = StructuredChangelog.new("CHANGELOG.md").version
+  spec.version       = StructuredChangelog::VERSION
   spec.authors       = ["Chris Hoffman"]
   spec.email         = ["yarmiganosca@gmail.com"]
 
-  spec.summary       = %q{A useful changelog for a change}
-  spec.description   = "Psychological manipulation designed to get programmers to right changelogs."
+  spec.summary       = %q{A useful changelog, for a change.}
+  spec.description   = "Version your gem through your changelog, not a VERSION constant."
   spec.homepage      = "https://www.github.com/yarmiganosca/structured_changelog"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structured_changelog
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2016-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Psychological manipulation designed to get programmers to right changelogs.
+description: Version your gem through your changelog, not a VERSION constant.
 email:
 - yarmiganosca@gmail.com
 executables: []
@@ -113,8 +113,18 @@ 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/roadmap.rb
-- lib/structured_changelog/task.rb
+- lib/structured_changelog/tasks.rb
+- lib/structured_changelog/tasks/notes.rb
+- lib/structured_changelog/tasks/validate.rb
+- lib/structured_changelog/version.rb
 - structured_changelog.gemspec
 homepage: https://www.github.com/yarmiganosca/structured_changelog
 licenses: []
@@ -135,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
-summary: A useful changelog for a change
+summary: A useful changelog, for a change.
 test_files: []