releasinator 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99035e7fd8c9c4f656989abf3691c485f9e68bd8
-  data.tar.gz: 6a473481db9b7a4f66195c70f398e0fbc0b6cc01
+  metadata.gz: 7c50b2ca2d8e7f05c2cfdcfb7e6277e88dbe9566
+  data.tar.gz: bff4e52e4c64da30a0100041af927320366b2263
 SHA512:
-  metadata.gz: cc52ac52529e6437ffae30a61db4395eb2485e81d8d2e9825ea204decb16624dd03f2b5f71697232387639950c5694686417649f2a96bc258fd6cc7f544d2789
-  data.tar.gz: 1383396a3df9378566522756524e3913f736ab582ebdb40382a4219da2c6298921fe61cbf70e298ee12751faa98b81d311cca8aa933bab341dbc694c10526f4a
+  metadata.gz: e59589a4510ae9d20c6c484c852b3d43968ff90c9eae075942ed7d11da245fce889f78208382ac649a6304cd76f74bddb9d62eb7eb4021fa312b2773d66dbd95
+  data.tar.gz: c7e3f660cf30e2d6d5db862a87dfe46f8027b40befd2a51869c8f1d1b4dcb8ecd694659b7425e9a1168999bd78c4b06873b0453a881bc3bcfa08542fa1646c28

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Releasinator release notes
 ==========================
 
+0.6.2
+-----
+* Re-enable bullet punctuation detection, now handling multi-line comments correctly!
+* Add new utility task, `import:changelog` for creating a changelog from a GitHub repo using the contents of existing GitHub releases.
+
 0.6.1
 -----
 * Improve some error messages.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    releasinator (0.6.1)
+    releasinator (0.6.2)
       colorize (~> 0.7)
       configatron (~> 4.5)
       json (~> 1.8)

data/README.md

@@ -74,6 +74,8 @@ release
     --> docs:package
     --> docs:push
 
+import:changelog (utility that creates a CHANGELOG.md.tmp from existing GitHub releases)
+
 ```
 
 ### Config
@@ -115,11 +117,12 @@ This will 'append' the task `validate:changelog`, running the code block after t
 The releasinator enforces certain conventions.  If a filename closely matches the convention, it is renamed and automatically committed.  The conventions are documented below:
 
 1. `README.md`
-2. `LICENSE`: See [here](http://stackoverflow.com/questions/5678462/should-i-provide-a-license-txt-or-copying-txt-file-in-my-project) for a relevant StackOverflow post on this discussion.  This project has chosen to exclude the `.txt` extension to match other popular projects, and GitHub defaults.
-3. `CONTRIBUTING.md`: See [a relevant GitHub blog post](https://github.com/blog/1184-contributing-guidelines) for relevant information.  This project has chosen to include the `.md` extension, as these files can get a bit unwieldy without formatting.
+2. `LICENSE`: See [here](http://stackoverflow.com/questions/5678462/should-i-provide-a-license-txt-or-copying-txt-file-in-my-project) for a relevant StackOverflow post on this discussion.  The authors of this project have chosen to exclude the `.txt` extension to match other popular projects, and GitHub defaults.
+3. `CONTRIBUTING.md`: See [a relevant GitHub blog post](https://github.com/blog/1184-contributing-guidelines) for relevant information.  The authors of this project have have chosen to include the `.md` extension, as these files can get a bit unwieldy without formatting.
 4. `CHANGELOG.md` - This file is the source of truth for the releasinator.  The file should be organized with the most recent release on top, and formatted correctly.  The latest release is the one used when the releasinator executes, so it is a precondition that the `CHANGELOG.md` has been edited and committed **prior to releasing**.
   1. Releases either are contained within an Alt-H2 (`------`) or `##H2` format.  Any other format will be rejected.
   2. Each release MUST start with the release version, and may contain any following text, such as the date, and/or any release summary.
+5. `.gitignore` and `.DS_store`: While this file is Mac-specific, many repos contain this entry in their `.gitignore` files because it's quite common for developers to not have their global `.gitignore` configured correctly. Therefore, the authors of this project have made the decision to force this entry in all `.gitignores`, as a gesture of goodwill to all these new git users.
 
 ## Behind the Scenes
 

data/lib/changelog/importer.rb

@@ -0,0 +1,43 @@
+require_relative '../git_util'
+require_relative '../command_processor'
+
+
+module Releasinator
+  module Changelog
+    class Importer
+      def initialize(releasinator_config)
+        @releasinator_config = releasinator_config
+      end
+
+      def import(repo_url)
+        # create tempfile 
+        File.open('CHANGELOG.md.tmp', 'w') do |f|
+          title_string = "#{@releasinator_config[:product_name]} release notes"
+          f.puts title_string
+
+          # print ====== with the length of the previous line for prettiness
+          title_string.length.times { f.print "=" }
+          f.puts
+
+          # read releases
+          github_repo = GitHubRepo.new(repo_url)
+
+          begin
+            github_releases = github_repo.client.releases "#{github_repo.org}/#{github_repo.repo}"
+            github_releases.each do |github_release|
+              puts github_release.inspect if @releasinator_config[:trace]
+              f.puts
+              f.puts github_release.name
+              f.puts "-----"
+              f.puts github_release.body
+            end
+          rescue => error
+            f.puts "<could not read releases from github>"
+            Printer.fail(error.inspect)
+            abort()
+          end
+        end
+      end
+    end
+  end
+end

data/lib/changelog/validator.rb

@@ -0,0 +1,152 @@
+require 'colorize'
+require 'Vandamme'
+require 'semantic'
+require_relative "../current_release"
+require_relative '../printer'
+
+module Releasinator
+  module Changelog
+    class Validator
+      RELEASE_REGEX = /\d+\.\d+\.\d+/
+
+      def initialize(releasinator_config)
+        @releasinator_config = releasinator_config
+      end
+
+      # assume changelog_hash is not empty
+      def validate_semver(changelog_hash)
+        latest_release, latest_release_changelog = changelog_hash.first
+        # extract prefix from first release to use on all subsequent releases
+        latest_release_prefix = latest_release.partition(RELEASE_REGEX)[0]
+
+        newer_version = nil
+        changelog_hash.each do |key,value|
+          prefix, version, suffix = key.partition(RELEASE_REGEX)
+          puts "Checking version with prefix:'#{prefix}', version:'#{version}', suffix:'#{suffix}'." if @releasinator_config[:verbose]
+          if prefix != latest_release_prefix
+            Printer.fail("version #{key} does not start with extracted prefix '#{latest_release_prefix}'.")
+            abort()
+          end
+          older_version = Semantic::Version.new version
+
+          if nil != newer_version
+            version_comp = newer_version <=> older_version
+            if version_comp < 0
+              Printer.fail("Semver releases out of order: #{older_version} should be smaller than #{newer_version}")
+              abort()
+            elsif version_comp == 0
+              # this case cannot be found with Vandamme library because 2 versions in a row get overwritten in the underlying hash
+              if suffix.empty?
+                Printer.fail("2 semver releases in a row without a suffix (like -beta, -rc1, etc...) is not allowed.")
+                abort()
+              end
+            else
+              error_suffix = "version increment error - comparing #{newer_version} to #{older_version} does not pass semver validation."
+              # validate the next sequence in semver
+              if newer_version.major == older_version.major
+                if newer_version.minor == older_version.minor
+                  check_semver_criteria(newer_version.patch == older_version.patch + 1, "patch #{error_suffix}")
+                else
+                  check_semver_criteria(newer_version.minor == older_version.minor + 1 && newer_version.patch == 0, "minor #{error_suffix}")
+                end
+              else
+                check_semver_criteria(newer_version.major == older_version.major + 1 && newer_version.minor == 0 && newer_version.patch == 0, "major #{error_suffix}")
+              end
+            end
+          end
+          newer_version = older_version
+        end
+      end
+
+      def check_semver_criteria(condition, message)
+        if !condition
+          Printer.fail(message)
+          abort()
+        end
+      end
+
+      def validate_changelog_contents(changelog_contents)
+        version_header_regexes = [
+          ## h2 using --- separator.  Example:
+          #  1.0.0
+          #  -----
+          #  First release!
+          '(^#{RELEASE_REGEX}).*\n----.*',
+
+          # h1/h2 header retrieved from https://github.com/tech-angels/vandamme/#format and modified to skip headers with dots in the name
+          '^#{0,3} ?([\w\d\.-]+\.[\d\.-]+[a-zA-Z0-9])(?: \W (\w+ \d{1,2}(?:st|nd|rd|th)?,\s\d{4}|\d{4}-\d{2}-\d{2}|\w+))?\n?[=-]*'
+        ]
+
+        changelog_hash = nil
+        version_header_regexes.each do |version_header_regex|
+          parser = Vandamme::Parser.new(changelog: changelog_contents, version_header_exp: version_header_regex, format: 'markdown')
+          changelog_hash = parser.parse
+
+          break if !changelog_hash.empty?
+        end
+        
+        if changelog_hash.empty?
+          Printer.fail("Unable to find any releases in the CHANGELOG.md.  Please check that your formatting is correct.")
+          abort()
+        end
+        
+        Printer.success("Found " + changelog_hash.count.to_s.bold + " release(s) in CHANGELOG.md.")
+
+        validate_semver(changelog_hash)
+
+        changelog_hash.each { |release, changelog| 
+          validate_single_changelog_entry(changelog)
+        }
+
+        latest_release, latest_release_changelog = changelog_hash.first
+        CurrentRelease.new(latest_release, latest_release_changelog)
+      end
+
+      def validate_single_changelog_entry(entry)
+        previous_line_in_progress = nil
+
+        lines = entry.chomp.split(/\r?\n/)
+        lines.each{ |line|
+
+          if starts_with_bullet? line
+            if previous_line_in_progress
+              Printer.fail("'#{previous_line_in_progress}' is invalid.  Bulleted points should end in punctuation.")
+              abort()
+            elsif ends_with_punctuation? line
+              # self-contained line is a-ok, and the usual use-case
+              previous_line_in_progress = nil
+            else
+              # line starts with bullet, but did not end with punctuation
+              previous_line_in_progress = line
+            end
+          elsif previous_line_in_progress
+            # does not start with bullet, and is continuing from previous line
+            if ends_with_punctuation? line
+              # multi-line ending with punctuation is ok!
+              previous_line_in_progress = nil
+            else
+              # middle of multi-line - neither starts with bullet, nor ends with punctuation.
+              previous_line_in_progress = line
+            end
+          else
+            # don't care about empty or code lines interspersed in a changelog entry
+          end
+        }
+
+        # the last line may not be clean.  Handle it.
+        if previous_line_in_progress
+          Printer.fail("'#{previous_line_in_progress}' is invalid.  Bulleted points should end in punctuation.")
+          abort()
+        end
+      end
+
+      def starts_with_bullet?(line)
+        line.match /^\s*\*\s+.*$/
+      end
+
+      def ends_with_punctuation?(line)
+        line.match /.*[\!,\?:\.]$/
+      end
+    end
+  end
+end

data/lib/releasinator/version.rb

@@ -1,3 +1,3 @@
 module Releasinator
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/lib/tasks/releasinator.rake

@@ -11,6 +11,7 @@ require_relative '../downstream'
 require_relative '../downstream_repo'
 require_relative '../publisher'
 require_relative '../validator'
+require_relative '../changelog/importer.rb'
 
 include Releasinator
 
@@ -154,6 +155,13 @@ task :release => [:"validate:all",:"local:build",:"pm:all",:"downstream:all",:"l
   Printer.success("Done releasing.")
 end
 
+namespace :import do
+  desc "import a changelog from release notes contained within GitHub releases"
+  task :changelog => [:config] do
+    Changelog::Importer.new(@releasinator_config).import(GitUtil.repo_url)
+  end
+end
+
 namespace :local do
   desc "ask user whether to proceed with release"
   task :confirm => [:config, :"validate:changelog"] do

data/lib/validator.rb

@@ -6,7 +6,7 @@ require_relative 'command_processor'
 require_relative 'downstream_repo'
 require_relative 'github_repo'
 require_relative 'printer'
-require_relative 'validator_changelog'
+require_relative 'changelog/validator'
 require_relative 'releasinator/version'
 
 TEXT_FILE_EXTENSIONS = [
@@ -108,7 +108,7 @@ module Releasinator
       validate_exist(@releasinator_config.base_dir, "CHANGELOG.md", search_ignore_path, ["release_notes.md"])
 
       changelog_contents = get_changelog_contents
-      ValidatorChangelog.new(@releasinator_config).validate_changelog_contents(changelog_contents)
+      Changelog::Validator.new(@releasinator_config).validate_changelog_contents(changelog_contents)
     end
 
     def validate_is_type(obj, type)

data/lib/validator_changelog.rb

@@ -1,116 +1 @@
-require 'colorize'
-require 'Vandamme'
-require 'semantic'
-require_relative "current_release"
-require_relative 'printer'
 
-module Releasinator
-  class ValidatorChangelog
-
-    RELEASE_REGEX = /\d+\.\d+\.\d+/
-
-    def initialize(releasinator_config)
-      @releasinator_config = releasinator_config
-    end
-
-    # assume changelog_hash is not empty
-    def validate_semver(changelog_hash)
-      latest_release, latest_release_changelog = changelog_hash.first
-      # extract prefix from first release to use on all subsequent releases
-      latest_release_prefix = latest_release.partition(RELEASE_REGEX)[0]
-
-      newer_version = nil
-      changelog_hash.each do |key,value|
-        prefix, version, suffix = key.partition(RELEASE_REGEX)
-        puts "Checking version with prefix:'#{prefix}', version:'#{version}', suffix:'#{suffix}'." if @releasinator_config[:verbose]
-        if prefix != latest_release_prefix
-          Printer.fail("version #{key} does not start with extracted prefix '#{latest_release_prefix}'.")
-          abort()
-        end
-        older_version = Semantic::Version.new version
-
-        if nil != newer_version
-          version_comp = newer_version <=> older_version
-          if version_comp < 0
-            Printer.fail("Semver releases out of order: #{older_version} should be smaller than #{newer_version}")
-            abort()
-          elsif version_comp == 0
-            # this case cannot be found with Vandamme library because 2 versions in a row get overwritten in the underlying hash
-            if suffix.empty?
-              Printer.fail("2 semver releases in a row without a suffix (like -beta, -rc1, etc...) is not allowed.")
-              abort()
-            end
-          else
-            error_suffix = "version increment error - comparing #{newer_version} to #{older_version} does not pass semver validation."
-            # validate the next sequence in semver
-            if newer_version.major == older_version.major
-              if newer_version.minor == older_version.minor
-                check_semver_criteria(newer_version.patch == older_version.patch + 1, "patch #{error_suffix}")
-              else
-                check_semver_criteria(newer_version.minor == older_version.minor + 1 && newer_version.patch == 0, "minor #{error_suffix}")
-              end
-            else
-              check_semver_criteria(newer_version.major == older_version.major + 1 && newer_version.minor == 0 && newer_version.patch == 0, "major #{error_suffix}")
-            end
-          end
-        end
-        newer_version = older_version
-      end
-    end
-
-    def check_semver_criteria(condition, message)
-      if !condition
-        Printer.fail(message)
-        abort()
-      end
-    end
-
-    def validate_changelog_contents(changelog_contents)
-      version_header_regexes = [
-        ## h2 using --- separator.  Example:
-        #  1.0.0
-        #  -----
-        #  First release!
-        '(^#{RELEASE_REGEX}).*\n----.*',
-
-        # h1/h2 header retrieved from https://github.com/tech-angels/vandamme/#format and modified to skip headers with dots in the name
-        '^#{0,3} ?([\w\d\.-]+\.[\d\.-]+[a-zA-Z0-9])(?: \W (\w+ \d{1,2}(?:st|nd|rd|th)?,\s\d{4}|\d{4}-\d{2}-\d{2}|\w+))?\n?[=-]*'
-      ]
-
-      changelog_hash = nil
-      version_header_regexes.each do |version_header_regex|
-        parser = Vandamme::Parser.new(changelog: changelog_contents, version_header_exp: version_header_regex, format: 'markdown')
-        changelog_hash = parser.parse
-
-        break if !changelog_hash.empty?
-      end
-      
-      if changelog_hash.empty?
-        Printer.fail("Unable to find any releases in the CHANGELOG.md.  Please check that your formatting is correct.")
-        abort()
-      end
-      
-      Printer.success("Found " + changelog_hash.count.to_s.bold + " release(s) in CHANGELOG.md.")
-
-      validate_semver(changelog_hash)
-
-      changelog_hash.each { |release, changelog| 
-        validate_single_changelog_entry(changelog)
-      }
-
-      latest_release, latest_release_changelog = changelog_hash.first
-      CurrentRelease.new(latest_release, latest_release_changelog)
-    end
-
-    def validate_single_changelog_entry(entry)
-      lines = entry.split(/\r?\n/)
-      lines.each{ |line| 
-        if line.match /^\s*\*\s+.*$/ # regex matches bulleted points
-          if !line.match /^\s*\*\s+.*[\!,\?:\.]$/ # regex matches bullet points with punctuation
-            Printer.fail("'#{line}' is invalid.  Bulleted points should end in punctuation.")
-          end
-        end
-      }
-    end
-  end
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: releasinator
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - PayPal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,6 +153,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/changelog/importer.rb
+- lib/changelog/validator.rb
 - lib/command_processor.rb
 - lib/config_hash.rb
 - lib/copy_file.rb