revision 1.1.8 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3468f9abbbf29f495889d79516418d7c34bb656a
-  data.tar.gz: c006ab6ee5fda1595435c063d9c46db21e0a2860
+SHA256:
+  metadata.gz: d2d84d1534e531c997a760126339a1ef9e7971b2aac9d147fc1b59894e18ac48
+  data.tar.gz: 7f2f9c98c10b454cc4e719fec0414e83fcd127d5ede7f111708ab8cf2c23cd6a
 SHA512:
-  metadata.gz: c1b33a1fcb7dc75f77b1f702d71314b20e70c8fa5645b325397d16008890f9f91c2b1960627adc6d9561dee3a422752ee47b82a17308c2102998fb8853955b25
-  data.tar.gz: a77d3ab85ad9354eaca164df18a3d31ea1cd534aea6d8b15042378d9f6867f3904264637f361d2c545c8e46c92404c44e85ff0914403aeba34cdef3712c6b0e8
+  metadata.gz: b8351cbc09d81a425683be3d7ca049daf1cf0576310ed396812675ac1adb8b6e525bfdcb168b90e5b259d5e5d0bd90ebe7c8c79e1bd41a16f77083abbfe0a0a6
+  data.tar.gz: 5249761e6c2ec29ab1887688c96bdded06d298140c9919020f80fd7a19928824840888b0ad9ac8002b08bbe52b768736eac9232d765813eb99807d7c437f24fa

data/lib/revision/cli.rb

@@ -17,9 +17,9 @@ module Revision
           @releasables = Releasable.from_folder(wd)
           break
         rescue Errors::NoDefinition
-          break if wd == File.expand_path('..',wd)
+          break if wd == File.expand_path('..', wd)
           puts "No releasable found in #{wd}, trying parent..."
-          wd = File.expand_path('..',wd)
+          wd = File.expand_path('..', wd)
           next
         end
       end
@@ -27,46 +27,63 @@ module Revision
       @id = options[:id] || @releasables.keys[0]
     end
 
-    desc "info", 'Display info for all defined releasables'
+    desc 'info', 'Display info for all defined releasables'
     def info
       puts "Found #{@releasables.values.length} releasables"
       puts ''
-      puts @releasables.values.map {|r| r.to_s}.join("\n\n")
+      puts @releasables.values.map(&:to_s).join("\n\n")
       puts ''
       puts "Default releasable ID: #{@id}"
     end
 
-    desc "patch", "Increment patch revision index"
+    desc 'patch', 'Increment patch revision index'
     def patch
       do_increment('patch')
     end
 
-    desc "minor", "Increment minor revision index"
+    desc 'minor', 'Increment minor revision index'
     def minor
       do_increment('minor')
     end
 
-    desc "major", "Increment major revision index"
+    desc 'major', 'Increment major revision index'
     def major
       do_increment('major')
     end
 
-    desc "archive", "Archive releasables"
+    desc 'build', 'Build releasable(s)'
+    method_option :skip, :aliases => "-s", :type => :numeric, :default => 0, :desc => "Skip the specified number of build steps"
+    def build
+      selected = options[:id].nil? ? @releasables.values : [@releasables[options[:id]]]
+      puts "Building #{selected.length} releasable(s)..."
+      # selected.each(&:build)
+      selected.each { |r| r.build(options[:skip])}
+    end
+
+    desc 'archive', 'Archive releasables'
     def archive
       selected = options[:id].nil? ? @releasables.values : [@releasables[options[:id]]]
       puts "Archiving #{selected.length} releasables..."
       selected.each do |r|
-        r.build
         r.archive
       end
     end
 
-    desc "changelog", "Display change log on stdout"
+    desc 'package', 'Build and archive releasables'
+    def package
+      selected = options[:id].nil? ? @releasables.values : [@releasables[options[:id]]]
+      puts "Building and archiving #{selected.length} releasables..."
+      selected.each do |r|
+        r.package
+      end
+    end
+
+    desc 'changelog', 'Display change log on stdout'
     def changelog
       select_one.output_changelog($stdout)
     end
 
-    desc "tag", "Commit the current revision to a local git repo and add a version tag"
+    desc 'tag', 'Commit the current revision to a local git repo and add a version tag'
     def tag
       select_one.tag
     end
@@ -83,10 +100,13 @@ module Revision
       increment_method = "#{type}_increment!"
       say "Incrementing #{r.revision} to #{r.revision.public_send(increment_method)}"
       options[:dryrun] ? r.revision.write_to_file : r.revision.write!
-      say ""
+      say ''
       say "The automatic commit / tag step assumes you're only checking in changes to existing files"
       say "You can answer 'n' at the prompt and use 'revision tag' to generate a commit with the latest changelog entry and an associated tag after manually adding any new files to the repo"
       say ""
+      if ask("Rebuild and archive any releasables (Y/n)?").upcase!='N'
+        r.package
+      end
       if ask("Commit changes to existing files and add a Git tag (y/N)?").upcase=='Y'
         r.tag
         if ask("Push changes/tag to origin (Y/n)?").upcase=='N' || !r.push

data/lib/revision/info.rb

@@ -71,7 +71,7 @@ class Revision::Info
     text.gsub!(@regex) { |match| "#{$~[:prefix]}#{@major}#{$~[:sep1]}#{@minor}#{$~[:sep2]}#{@patch}#{$~[:postfix]}" }
 
     #Insert start/end tags if not present
-    text += new_changelog unless text.match(CHANGELOG_START)
+    text += new_changelog_placeholder unless text.match(CHANGELOG_START)
 
     text.gsub!(CHANGELOG_START) { |match| [match, format_changelog_entry(entry)].join("\n") }
 

data/lib/revision/releasable.rb

@@ -59,7 +59,7 @@ module Revision
       @root = Pathname.new(root).realpath
       @id = config[:id] || File.basename(@root)
       @revision = Info.new(File.join(@root,config[:revision][:src]), regex: config[:revision][:regex], comment_prefix: config[:revision][:comment_prefix])
-      @build_steps = config[:build_steps]
+      @build_def = config[:build] ? config[:build] : { environment: { variables: {}}, steps: config[:build_steps]}
       @artefacts = config[:artefacts]
       @artefacts.each { |a| a[:dest] ||= a[:src] }
     end
@@ -68,21 +68,45 @@ module Revision
       <<~EOT
       #{@id} v#{@revision} @ #{@root}
 
+        Build environment:
+        #{@build_def[:environment]}
+
         Build pipeline:
-        - #{@build_steps.join("\n  - ")}
+        - #{@build_def[:steps].join("\n  - ")}
 
         Build artefacts:
         #{artefacts.map{ |a| "- #{a[:src]}\n    => #{a[:dest]}" }.join("\n")}
+
       EOT
     end
 
-    def build
-      puts "Executing #{@build_steps.length} build steps..."
+    def build(skip_steps = 0)
+      if @build_def.dig(:environment, :variables)
+        @build_def[:environment][:variables].each do |key, value|
+          if(key.match?('PATH'))
+            if Gem.win_platform?
+              value.gsub!(':', ';')
+              value.gsub!('/', '\\')
+            else
+              value.gsub!(':', ';')
+              value.gsub!('\\', '/')
+            end
+            # value.gsub!('/',Gem.win_platform? ? '\' : '/')
+            # value.gsub!('\',Gem.win_platform? ? '\' : '/')
+            value.gsub!('~', Dir.home)
+          end
+          puts "Setting environment variable '#{key}' to '#{value}'"
+          ENV[key] = value
+        end
+      end
+      steps = @build_def[:steps][skip_steps..-1]
+      puts "Executing #{steps.length} of #{@build_def[:steps].length} build steps..."
       Dir.chdir(@root) do
-        @build_steps.each_with_index do |step, index|
-          puts "... (#{index+1}/#{@build_steps.length}) #{step}"
+        steps.each_with_index do |step, index|
+          step_index = index+1+skip_steps
+          puts "... (#{step_index}/#{@build_def[:steps].length}) #{step}"
           system(step)
-          puts "WARNING: build step #{index}: #{step} exit status #{$?.exitstatus}" unless $?.exitstatus.zero?
+          puts "WARNING: build step #{step_index}: #{step} exit status #{$?.exitstatus}" unless $?.exitstatus.zero?
         end
       end
     end
@@ -133,6 +157,11 @@ module Revision
         @artefacts.each_with_index do |a, index|
           src = a[:src].gsub(REVISION_PLACEHOLDER, @revision.to_s)
           dest = a[:dest].gsub(REVISION_PLACEHOLDER, @revision.to_s)
+          if Gem.win_platform? && !src.end_with?('.exe') && File.exist?(File.join(@root, src + '.exe'))
+            puts "... packing on windows -- appending '.exe'"
+            src += '.exe'
+            dest += '.exe' unless dest.end_with?('.exe')
+          end
           puts "... (#{index+1}/#{@artefacts.length}) #{src} => #{dest}"
           zipfile.add(dest, File.join(@root, src))
         end
@@ -141,6 +170,11 @@ module Revision
       end
     end
 
+    def package
+      build
+      archive
+    end
+
     def output_changelog(output_stream)
       output_stream.puts "Revision history for #{@id} version #{@revision}"
       output_stream.puts ""

data/lib/revision/version.rb

@@ -1,10 +1,23 @@
 # Defines the revision ID for the revision gem
 module Revision
-  VERSION = "1.1.8"
+  VERSION = "1.2.0"
 end
 
 # <BEGIN CHANGELOG>
 # 
+# Version 1.2.0 (06 Mar 2018)
+# - Build definition improvements (and new yaml structure)
+# - Added platform-agnostic environment variable definition (handles '~' replacement and :/; path separators)
+# - Added platform-agnostic packaging of binaries (i.e. appending .exe for windows when archiving)
+# 
+# Version 1.1.10 (16 Feb 2018)
+# - Modified 'archive' command to just archive existing artefact -- i.e. skip build phase
+# - Added 'package' command that builds AND archives
+# 
+# Version 1.1.9 (16 Feb 2018)
+# - Fixed bug when adding first changelog entry to file without existing placeholders
+# - Added standalone build command
+# 
 # Version 1.1.8 (15 Dec 2017)
 # - Added .yardopts to build documentation
 # 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revision
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.2.0
 platform: ruby
 authors:
 - Cormac Cannon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2018-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Language-agnostic revision management tool