releasinator 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfcb0c0860fd15ef1e4ece2155302b634699dcc2
-  data.tar.gz: 8aa056a5a1f092e7ac2fafb183b73061bce4e666
+  metadata.gz: 514f2117423fc276d733afa1e3ada8409d294c3f
+  data.tar.gz: 518e7c826e1ecb8588fddaed5c21de54709d96d3
 SHA512:
-  metadata.gz: 6e519b13c6301ede333d82afa4d2a3216cb785000802c1e1b7b3cecdd20f63183d4de46fc34bd4c980b20846555b6bd158f5e1b420d7130083d361c14f00965a
-  data.tar.gz: efb92b51475f46d51892ea3598af803827fea3555131fcff533ad2387efc6cd7455fa96c90541c199121f6fce103f6de68985f9b7f8a65f8a7f4606273c4f3a6
+  metadata.gz: 110da6dcf745e7d20133ae31ba19c6ed6f984bc6447325bb0e00ac8a1331d25220a46f40875950df6967e70b63f98c0b13dad82806f7e91ecd5ea3b156e25392
+  data.tar.gz: 025592dcb88660d3270e0b9aa4dafd97d1b54b7acef72a7e3fa06ac47659b2d4eda94a08a940c01c6935019b69d8183fc20820d81ce2752a324770d99e3bc9f2

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 Releasinator release notes
 ==========================
 
+0.6.0
+-----
+* Validate all bulleted items in `CHANGELOG.md` end in punctuation.
+* Add new task, `validate:eof_newlines` which validates text files matching a few known extensions end in a newline character.  The validation adds the newline character if not present.
+* Validate files are in git with the proper name, case sensitive.  Previously, the releasinator would allow files detected by the filesystem.  Since Macs are case in-sensitive, incorrect cases for expected filenames were allowed.
+
 0.5.0
 -----
 * The releasinator is now Open Source!

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    releasinator (0.5.0)
+    releasinator (0.6.0)
       colorize (~> 0.7)
       configatron (~> 4.5)
       json (~> 1.8)
@@ -13,7 +13,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.4.0)
-    colorize (0.7.7)
+    colorize (0.8.0)
     configatron (4.5.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
@@ -45,4 +45,4 @@ DEPENDENCIES
   test-unit (~> 3.1)
 
 BUNDLED WITH
-   1.11.2
+   1.12.5

data/README.md

@@ -34,6 +34,7 @@ release
 
 --> validate:all
     --> validate:paths
+    --> validate:eof_newlines
     --> validate:git_version
     --> validate:gitignore
     --> validate:submodules
@@ -122,9 +123,11 @@ The releasinator enforces certain conventions.  If a filename closely matches th
 
 ## Behind the Scenes
 
-#### Validations
+#### Validations (in no particular order)
 
+1. ✓ Validate releasinator version.
 1. ✓ Validate git version.
+1. ✓ Validate text files end in newline characters.
 1. ✓ Validate git's cleanliness (no untracked, unstaged, or uncommitted files).
 1. ✓ Validate current git branch is up to date with the latest version on server.
 1. ✓ Validate current git branch is `master` (if no git flow), or `develop` or `release/<Release number>` if using git flow.

data/lib/downstream.rb

@@ -154,10 +154,14 @@ module Releasinator
               if downstream_repo.options.has_key? :new_branch_name
                 new_branch_name = get_new_branch_name(downstream_repo.options[:new_branch_name], @current_release.version)
                 CommandProcessor.command("git push -u origin #{new_branch_name}")
+                # TODO - check that the branch exists
+                CommandProcessor.command("sleep 5")
                 Publisher.new(@releasinator_config).publish_pull_request(downstream_repo.url, @current_release, @releasinator_config[:product_name], downstream_repo.branch, new_branch_name)
               else
                 GitUtil.push_branch("master")
                 GitUtil.push_tag(@current_release.version)
+                # TODO - check that the tag exists
+                CommandProcessor.command("sleep 5")
                 Publisher.new(@releasinator_config).publish(downstream_repo.url, @current_release) unless ! downstream_repo.release_to_github
               end
             end

data/lib/git_util.rb

@@ -14,6 +14,22 @@ module Releasinator
       CommandProcessor.command("git fetch origin --prune --recurse-submodules -j9")
     end
 
+    def self.exist?(path)
+      current_branch = get_current_branch()
+      # grep is case sensitive, which is what we want.  Piped to cat so the grep error code is ignored.
+      "" != CommandProcessor.command("git ls-tree --name-only -r #{current_branch} | grep ^#{path}$ | cat")
+    end
+
+    def self.all_files()
+      current_branch = get_current_branch()
+      CommandProcessor.command("git ls-tree --name-only -r #{current_branch}")
+    end
+
+    def self.move(old_path, new_path)
+      puts "Renaming #{old_path} to #{new_path}".yellow
+      CommandProcessor.command("git mv -f #{old_path} #{new_path}")
+    end
+
     def self.push_branch(branch_name)
       checkout(branch_name)
       fetch()

data/lib/printer.rb

@@ -12,7 +12,7 @@ module Releasinator
 
     def self.check_proceed(warning_msg, abort_msg)
       puts "#{warning_msg}  Continue?  (Y/n)".yellow
-      if 'n' == STDIN.gets.strip
+      if 'n' == $stdin.gets.strip
         self.fail(abort_msg)
         abort()
       end

data/lib/releasinator/version.rb

@@ -1,3 +1,3 @@
 module Releasinator
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/tasks/releasinator.rake

@@ -34,7 +34,12 @@ namespace :validate do
     @downstream.freeze
   end
 
-  desc "validate that git is the correct version"
+  desc "validate important text files end in a newline character"
+  task :eof_newlines => :config do
+    @validator.validate_eof_newlines
+  end
+
+  desc "validate releasinator is up to date"
   task :releasinator_version => :config do
     @validator.validate_releasinator_version
   end
@@ -50,7 +55,7 @@ namespace :validate do
     @validator.validate_git_version
   end
 
-  desc "validate that git reports no untracked, unstaged, or uncommitted changes"
+  desc "validate git reports no untracked, unstaged, or uncommitted changes"
   task :git => :config do
     @validator.validate_clean_git
   end
@@ -124,6 +129,7 @@ namespace :validate do
   task :all =>
     [
       :paths,
+      :eof_newlines,
       :git_version,
       :gitignore,
       :submodules,

data/lib/validator.rb

@@ -31,6 +31,19 @@ module Releasinator
       end
     end
 
+    def validate_eof_newlines
+      all_git_files = GitUtil.all_files.split
+      text_file_extensions = [".md", ".txt", ".gitignore", "Gemfile", "Gemfile.lock", "LICENSE", "Rakefile", ".rb"]
+
+      important_git_text_files = all_git_files.select{ 
+        |filename| text_file_extensions.any? { |extension| filename.end_with?(extension) }
+      }
+
+      important_git_text_files.each do |filename|
+        CommandProcessor.command("tail -c1 #{filename} | read -r _ || echo >> #{filename}")
+      end
+    end
+
     def validate_in_path(executable)
       if "" == CommandProcessor.command("which #{executable} | cat")
         Printer.fail(executable.bold + " not found on path.")
@@ -54,9 +67,9 @@ module Releasinator
       end
     end
 
-    def validate_changelog(downstream_dir)
+    def validate_changelog(search_ignore_path=nil)
       validate_base_dir
-      validate_exist(@releasinator_config.base_dir, "CHANGELOG.md", downstream_dir, ["release_notes.md"])
+      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)
@@ -179,29 +192,29 @@ module Releasinator
       abort()
     end
 
-    def validate_exist(dir, expected_file_name, downstream_dir, alternate_names=[])
+    def validate_exist(dir, expected_file_name, search_ignore_path=nil, alternate_names=[])
       if !File.exist? dir
         Printer.fail("Directory #{dir} not found.")
         abort()
       end
       
       Dir.chdir(dir) do
-        if !File.exist?(expected_file_name)
+        if !GitUtil.exist?(expected_file_name)
           puts "#{dir}/#{expected_file_name} not found. Searching for similar files.".yellow
         
           # search for files that are somewhat similar to the file being searched, ignoring case
           filename_prefix = expected_file_name[0,5]
-          similar_files = CommandProcessor.command("find . -type f -not -path \"./#{downstream_dir}/*\" -iname '#{filename_prefix}*'| sed 's|./||'").strip
+          similar_files = CommandProcessor.command("find . -type f -not -path \"./#{search_ignore_path}/*\" -iname '#{filename_prefix}*'| sed 's|./||'").strip
           num_similar_files = similar_files.split.count
           puts similar_files
           if num_similar_files == 1
-            Printer.check_proceed("Found a single similar file: #{similar_files}.  Do you want to rename this to the expected #{expected_file_name}?","Please place #{dir}/#{expected_file_name}")
+            Printer.check_proceed("Found a single similar file: #{similar_files}.  Do you want to rename this to the expected #{expected_file_name}?","Please commit #{dir}/#{expected_file_name}")
             rename_file(similar_files, expected_file_name)
           elsif num_similar_files > 1
             Printer.fail("Found more than 1 file similar to #{expected_file_name}.  Please rename one, and optionally remove the others to not confuse users.")
             abort()
           elsif !rename_alternate_name(expected_file_name, alternate_names)
-            Printer.fail("Please place #{dir}/#{expected_file_name}.") 
+            Printer.fail("Please commit #{dir}/#{expected_file_name}.")
             abort()
           end
         end
@@ -352,8 +365,7 @@ module Releasinator
     def rename_file(old_name, new_name)
       is_git_already_clean = GitUtil.is_clean_git?
 
-      puts "Renaming #{old_name} to expected filename: #{new_name}".yellow
-      CommandProcessor.command("mv #{old_name} #{new_name}")
+      GitUtil.move(old_name, new_name)
       # fix any references to file in readme
       replace_string("README.md", "(#{old_name})", "(#{new_name})")
       if is_git_already_clean

data/lib/validator_changelog.rb

@@ -94,8 +94,24 @@ module Releasinator
 
       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.")
+            abort()
+          end
+        end
+      }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: releasinator
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - PayPal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler