revision 1.6.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2eb61c791c5f9c8e8261578dcaa580aca1a7f8a02c683c0e649f1ed34403ac39
-  data.tar.gz: 70262dc4433fd6c894a74b100c81142836dd059a9f5264688eff7a0286137a3e
+  metadata.gz: e319fb6dc51ae708782296c793f658547dd4a1e1f1df19e4fb2d3787213a22b8
+  data.tar.gz: 9645d927126073825302fe097c719c6294af2a9ee97f4a72058040039f2beb00
 SHA512:
-  metadata.gz: d3fa4cd59ec2193032cd8a414445c3ba642496bbd36952595dae0c16c52ebd0b36804eec7f5dbc55804f3020d43ac9b69894a7ac38ebfa04dd71b21f1588a991
-  data.tar.gz: aa4f7e424425b1b22f80fac69f2b6d885cb63eb02ce4f080047528b5796a7482b0fef19ecae72192dce7b780593b87ff7c35ca0b7eed64a340761cf44d9b7dc2
+  metadata.gz: 57bffb27f36a0a282c9555157402309069dceaabb403a2be7ae3bcacf4c17319b7a3646414087575e89bd1928876266282be9ca9aa89cf697e58d7d80b121dc8
+  data.tar.gz: '094cd008804acc63b1f9732df488f59b5bed2e703928073c7b331c089854f00277317404eb127871ff01a67d58547153c311a9c7c5bb7520c51b9a4f0e1c6bcc'

data/.envrc

@@ -0,0 +1,2 @@
+use flake
+layout ruby

data/.gitignore

@@ -15,3 +15,4 @@ README.html
 *.zip
 test-output
 *.md5
+.direnv

data/README.org

@@ -198,9 +198,9 @@ The lines beginning with '#' are explanatory comments
         - :src: pkg/revision-<VER>.gem
           :dest: revision-<VER>.gem
         # ':dest:' defaults to the string specified for ':src:' if not specified explicitly
-        # md5sums are generated by default for each artefact -- the ':md5:' option allows this to be disabled per-artefact
+        # sha512 checksums are generated by default for each artefact -- the ':chk:' option allows this to be disabled per-artefact
         - :src: README.org
-          :md5: false
+          :chk: false
 #+END_SRC
 
 **** TODO (or at least consider) add support for overridable defaults

data/flake.lock

@@ -0,0 +1,27 @@
+{
+  "nodes": {
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1699343069,
+        "narHash": "sha256-s7BBhyLA6MI6FuJgs4F/SgpntHBzz40/qV0xLPW6A1Q=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "ec750fd01963ab6b20ee1f0cb488754e8036d89d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "nixpkgs": "nixpkgs"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

data/flake.nix

@@ -0,0 +1,20 @@
+{
+  description = "A Nix-flake-based Ruby development environment";
+
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+
+  outputs = { self, nixpkgs }:
+    let
+      supportedSystems = [ "x86_64-linux" "aarch64-linux" "x86_64-darwin" "aarch64-darwin" ];
+      forEachSupportedSystem = f: nixpkgs.lib.genAttrs supportedSystems (system: f {
+        pkgs = import nixpkgs { inherit system; };
+      });
+    in
+    {
+      devShells = forEachSupportedSystem ({ pkgs }: {
+        default = pkgs.mkShell {
+          packages = with pkgs; [ ruby_3_2 ];
+        };
+      });
+    };
+}

data/lib/revision/{md5.rb → checksum.rb}

@@ -1,34 +1,38 @@
 require 'digest'
 
-class Revision::MD5
+class Revision::Checksum
 
   READ_CHUNK_KB = 1024
   FILENAME_EXTENSION = "md5"
 
+  MD5 = {name: "md5", generator: Digest::MD5}
+  SHA512 = {name: "sha512", generator: Digest::SHA512}
+
   attr_reader :root, :filename
 
-  def self.from_file(filepath, filename: nil)
+  def self.from_file(filepath, filename: nil, type: SHA512)
     raise "File #{filepath} not found" unless File.exist?(filepath)
     filename ||= File.basename(filepath)
     root = File.dirname(filepath)
     stream = File.open(filepath, 'rb')
-    new(stream, filename, root: root)
+    new(stream, filename, root: root, type: type)
   end
 
-  def initialize(ioreader, filename, root: nil)
+  def initialize(ioreader, filename, root: nil, type: SHA512)
     root ||= Dir.getwd
     @reader = ioreader
     @root = root
     @filename = filename
+    @impl = type
   end
 
   def calc
-    md5 = Digest::MD5.new
+    checksum = @impl[:generator].new
     bytes_per_chunk = READ_CHUNK_KB*1024
     while chunk = @reader.read(bytes_per_chunk)
-      md5 << chunk
+      checksum << chunk
     end
-    md5.hexdigest
+    checksum.hexdigest
   end
 
   def to_s
@@ -37,12 +41,12 @@ class Revision::MD5
     EOT
   end
 
-  def md5filename
-    "#{@filename}.#{FILENAME_EXTENSION}"
+  def chkfilename
+    "#{@filename}.#{@impl[:name]}"
   end
 
   def write(filepath: nil)
-    filepath ||= File.join(@root, md5filename)
+    filepath ||= File.join(@root, chkfilename)
     filename = File.basename(filepath)
     File.open(filepath, "w") { |f| f.write "#{calc} #{filename}" }
     filepath

data/lib/revision/cli.rb

@@ -4,7 +4,7 @@ require_relative 'releasable'
 require_relative 'info'
 require_relative 'errors'
 require_relative 'version'
-require_relative 'md5'
+require_relative 'checksum'
 
 module Revision
   class CLI < Thor
@@ -111,13 +111,28 @@ module Revision
     def md5
       r = select_one
       files = options[:file].nil? ?
-                r.artefacts.select { |a| a[:md5]==true }.map { |a| a[:src] } :
+                r.artefacts.select { |a| a[:chk]==true }.map { |a| a[:src] } :
                 [options[:file]]
       raise "No files specified" unless files.length
-      puts "Calculating md5sum for files #{files}"
+      puts "Calculating checksum for files #{files}"
       for f in files
-        md5sum = Revision::MD5.from_file(f)
-        puts "#{md5sum}"
+        checksum = Revision::Checksum.from_file(f, type: Revision::Checksum::MD5)
+        puts "#{checksum}"
+      end
+    end
+
+    desc 'chk', 'Compute sha512 checksums for current build artefacts'
+    method_option :file, :aliases => "-f", :type => :string, :default => nil ,:desc => "File to checksum (defaults to build artefacts defined in yaml)"
+    def chk
+      r = select_one
+      files = options[:file].nil? ?
+                r.artefacts.select { |a| a[:chk]==true }.map { |a| a[:src] } :
+                [options[:file]]
+      raise "No files specified" unless files.length
+      puts "Calculating checksum for files #{files}"
+      for f in files
+        checksum = Revision::Checksum.from_file(f, type: Revision::Checksum::SHA512)
+        puts "#{checksum}"
       end
     end
 

data/lib/revision/releasable.rb

@@ -69,7 +69,7 @@ module Revision
       @build_def = config[:build] ? config[:build] : { environment: { variables: {}}, steps: config[:build_steps]}
       @artefacts = config[:artefacts] || []
       @artefacts.each { |a| a[:dest] ||= File.basename(a[:src]) } unless @artefacts.nil? || @artefacts.empty?
-      # @artefacts.each { |a| a[:md5] = true if a[:md5].nil? } unless @artefacts.nil? || @artefacts.empty?
+      # @artefacts.each { |a| a[:chk] = true if a[:chk].nil? } unless @artefacts.nil? || @artefacts.empty?
       @config = config
     end
 
@@ -194,10 +194,12 @@ module Revision
 
     def normalise_artefact(a)
       src_norm = interp_rev(a[:src])
+      # the :chk key replaced a legacy :md5 key -- support old syntax
+      chk_unified = a[:chk].nil? ? a[:md5] : a[:chk]
       a_norm = {
         src: src_norm,
         dest: a[:dest].nil? ? File.basename(src_norm) : interp_rev(a[:dest]),
-        md5: a[:md5].nil? ? true : a[:md5]
+        chk: chk_unified.nil? ? true : chk_unified
       }
       if Gem.win_platform? && !a_norm[:src].end_with?('.exe') && File.exist?(File.join(@root, a_norm[:src] + '.exe'))
         puts "... windows platform -- appending '.exe' ('#{a_norm[:src]}' -> '#{a_norm[:src]}.exe')"
@@ -222,27 +224,27 @@ module Revision
         zip_entries.each.with_index(1) do |a, idx|
           puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: <= #{a[:src]}"
           zipfile.add(a[:dest], a[:src])
-          if a[:md5]
-            md5name = "#{a[:dest]}.md5"
-            puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: embedding md5sum (#{md5name})"
-            zipfile.get_output_stream(md5name) { |os| os.write("#{MD5.from_file(a[:src])}")}
+          if a[:chk]
+            chkfile = Checksum.from_file(a[:src])
+            puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: embedding checksum (#{chkfile.chkfilename})"
+            zipfile.get_output_stream(chkfile.chkfilename) { |os| os.write("#{chkfile}")}
           else
-            puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: no md5sum required"
+            puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: no checksum required"
           end
         end
         puts "... embedding revision history as #{changelog_name} "
         zipfile.get_output_stream(changelog_name) { |os| output_changelog(os)}
       end
-      archive_md5 = MD5.from_file(archive_name)
-      puts "... generating archive md5sum as #{archive_md5.md5filename} "
-      archive_md5.write
+      archive_checksum = Checksum.from_file(archive_name)
+      puts "... generating archive checksum as #{archive_checksum.chkfilename} "
+      archive_checksum.write
 
       if @config.dig(:archive)
         archive_root = File.expand_path(@config[:archive])
         puts "... moving #{archive_name} to #{archive_root}"
         FileUtils.mkdir_p(archive_root)
         FileUtils.mv(archive_name, archive_root)
-        FileUtils.mv(archive_md5.md5filename, archive_root)
+        FileUtils.mv(archive_checksum.chkfilename, archive_root)
       end
     end
 
@@ -283,7 +285,7 @@ module Revision
           end
           puts "... deploying '#{src}' -> '#{dest}'"
           FileUtils.cp_r(src,dest)
-          puts "... writing md5sum for '#{dest}' to '#{MD5.from_file(dest).write}'" if a[:md5]
+          puts "... writing checksum for '#{dest}' to '#{Checksum.from_file(dest).write}'" if a[:chk]
         end
         File.open(File.join(destination,changelog_name),'w') { |f| output_changelog(f)}
 

data/lib/revision/version.rb

@@ -1,15 +1,18 @@
 # Defines the revision ID for the revision gem
 module Revision
-  VERSION = "1.6.1".freeze
+  VERSION = "2.0.0".freeze
 end
 
 # <BEGIN CHANGELOG>
 #
+# Version 2.0.0 (10 Nov 2023)
+# - new(checksum): Now using SHA512 rather than MD5 checksums
+#
 # Version 1.6.1 (31 Aug 2022)
 # - Fixed logging error preventing windows exe creation
 #
 # Version 1.6.0 (01 Dec 2021)
-# - New feature: Automated MD5sum generation during 'archive' and 'deploy' tasks
+# - New feature: Automated checksum generation during 'archive' and 'deploy' tasks
 #
 # Version 1.5.3 (26 Oct 2021)
 # - Multiple deployment destinations bugfix -- only last destination was being used.

data/releasables.yaml

@@ -8,13 +8,13 @@
       - mkdir -p test-output/2
       - bundle exec rake install
     #Define 3 build artefacts as test cases for 'deploy' and 'archive' tasks
-    #Expect MD5 file to be generated by default for first entry (where not specified explicitly)
+    #Expect checksum file to be generated by default for first entry (where not specified explicitly)
     :artefacts:
       - :src: pkg/revision-<VER>.gem
       - :src: README.org
-        :md5: false
+        :chk: false
       - :src: Rakefile
-        :md5: true
+        :chk: true
     #Define two deployment destinations to verify multiple deployments work as intended
     :deploy:
       - :dest: ./test-output

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revision
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Cormac Cannon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -187,6 +187,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -197,11 +198,13 @@ files:
 - bin/console
 - bin/setup
 - exe/revision
+- flake.lock
+- flake.nix
 - lib/revision.rb
+- lib/revision/checksum.rb
 - lib/revision/cli.rb
 - lib/revision/errors.rb
 - lib/revision/info.rb
-- lib/revision/md5.rb
 - lib/revision/releasable.rb
 - lib/revision/string_case.rb
 - lib/revision/version.rb
@@ -227,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Language-agnostic revision management tool