rake_git_crypt 0.1.0.pre.17 → 0.1.0.pre.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a748262afe405e1a15bf60aa63e213dbb2a908b7116ebb397243719dffaf138
-  data.tar.gz: 3bd972019c51aec40d6309c616b9ffeb4763384ad06dc405d073a705ba1d9274
+  metadata.gz: '00806c7a05b44e1ad2e1334a438f00ec559232d3b66485deae89253ebc34896a'
+  data.tar.gz: e2cac269d4518283941a25594048053fddc161a1dde2c5e85ac977d796c1bd5b
 SHA512:
-  metadata.gz: 214da466a7dc1e925eb425b43218fc4250328cfef808d645a55a128dc19a0c0632c4393d267cfea407b996dd45b0731cdcad7f4c6a3a8aef2809c140290089ce
-  data.tar.gz: 90d8d68012f680583f37ba842f36176d7a83d3226ec8f088a5d5a85f68a0d47575fc4133b4cf66525a4abbb5fb07a137a24c2cfec253ffc53f3791f7014597ed
+  metadata.gz: 7865300a0cbbeaa6201cc891a67a310bd08816fe0efe65d4e90d19bb0f843ac417ba52ad1abe013ecbe432ae7c3e81afb496a38625b095b729f3b8900bb4c1ee
+  data.tar.gz: abbcdd0e73901e0cf60335f97f2d7042aaa573bb7b7472d3cc3042245e227d3e51431f41971c4d9306742ef87753dd512abe9cb7d2a2ba04cacf535b8f9b57f4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rake_git_crypt (0.1.0.pre.17)
+    rake_git_crypt (0.1.0.pre.18)
       colored2 (~> 3.1)
       rake_factory (= 0.32.0.pre.2)
       ruby_git_crypt (= 0.1.0.pre.2)

data/lib/rake_git_crypt/tasks/add_user.rb

@@ -5,17 +5,21 @@ require 'ruby_git_crypt'
 require 'ruby_gpg2'
 
 require_relative '../home'
+require_relative '../template'
+require_relative '../mixins/support'
 
 module RakeGitCrypt
   module Tasks
     class AddUser < RakeFactory::Task
+      include Mixins::Support
+
       default_name :add_user
       default_description 'Add user to git-crypt.'
 
       parameter :key_name
 
-      parameter :commit, default: false
-      parameter :trusted, default: false
+      parameter :allow_git_crypt_commit, default: false
+      parameter :allow_untrusted_keys, default: false
 
       parameter :gpg_user_id
       parameter :gpg_user_key_path
@@ -23,16 +27,19 @@ module RakeGitCrypt
       parameter :gpg_home_directory
       parameter :gpg_work_directory, default: '/tmp'
 
-      action do
+      parameter :commit_message_template,
+                default: 'Adding git-crypt GPG user with <%= @type %>: ' \
+                         "'<%= @value %>'."
+
+      parameter :commit_task_name
+
+      action do |task, args|
         validate
 
         if gpg_user_id
           log_adding_by_id
           add_gpg_user(gpg_home_directory, gpg_user_id)
-          log_done
-        end
-
-        if gpg_user_key_path
+        elsif gpg_user_key_path
           log_adding_by_key_path
           with_gpg_home_directory do |home_directory|
             result = import_key(home_directory)
@@ -40,8 +47,10 @@ module RakeGitCrypt
             add_gpg_user(home_directory, key_fingerprint,
                          auto_trust: gpg_home_directory.nil?)
           end
-          log_done
         end
+
+        maybe_commit(task, args)
+        log_done
       end
 
       private
@@ -80,13 +89,29 @@ module RakeGitCrypt
           {
             gpg_user_id: gpg_user_id,
             key_name: key_name,
-            no_commit: !commit,
-            trusted: auto_trust || trusted
+            no_commit: !allow_git_crypt_commit,
+            trusted: auto_trust || allow_untrusted_keys
           },
           { environment: git_crypt_environment(gpg_home_directory) }
         )
       end
 
+      def maybe_commit(task, args)
+        return unless commit_task_name
+
+        invoke_task_with_name(
+          task, commit_task_name,
+          [commit_message(task), *args]
+        )
+      end
+
+      def commit_message(task)
+        Template.new(commit_message_template)
+                .render(type: gpg_user_id ? 'ID' : 'key path',
+                        value: gpg_user_id || gpg_user_key_path,
+                        task: task)
+      end
+
       def git_crypt_environment(gpg_home_directory)
         gpg_home_directory ? { GNUPGHOME: gpg_home_directory } : {}
       end

data/lib/rake_git_crypt/tasks/add_users.rb

@@ -16,6 +16,9 @@ module RakeGitCrypt
       parameter :gpg_user_key_paths, default: []
       parameter :gpg_user_ids, default: []
 
+      parameter(:commit_message_template,
+                default: 'Adding users to git-crypt.')
+
       parameter(
         :add_user_by_id_task_name,
         default: :add_user_by_id
@@ -24,17 +27,17 @@ module RakeGitCrypt
         :add_user_by_key_path_task_name,
         default: :add_user_by_key_path
       )
+      parameter(:commit_task_name)
 
-      action do |t, args|
+      action do |task, args|
         ensure_users_provided
-        ensure_tasks_present(t)
+        ensure_tasks_present(task)
 
-        add_users_by_key_paths(t, args)
-        add_users_by_ids(t, args)
+        add_users_by_key_paths(task, args)
+        add_users_by_ids(task, args)
+        maybe_commit(task, args)
       end
 
-      private
-
       def gpg_user_key_paths
         parameter = self.class.parameter_set.find(:gpg_user_key_paths)
         key_paths = parameter.get(self)
@@ -44,6 +47,8 @@ module RakeGitCrypt
         resolve_key_paths(key_paths)
       end
 
+      private
+
       def resolve_key_paths(paths)
         paths.inject([]) do |acc, key_path|
           [*acc, *resolve_key_path(key_path)]
@@ -155,7 +160,22 @@ module RakeGitCrypt
           'must be provided.'
         )
       end
+
+      def maybe_commit(task, args)
+        return unless commit_task_name
+
+        invoke_task_with_name(
+          task, commit_task_name,
+          [commit_message(task), *args]
+        )
+      end
+
+      def commit_message(task)
+        Template.new(commit_message_template)
+                .render(task: task)
+      end
     end
+
     # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/rake_git_crypt/tasks/install.rb

@@ -13,13 +13,18 @@ module RakeGitCrypt
       default_name :install
       default_description 'Install git-crypt.'
 
+      parameter(:commit_message_template,
+                default: 'Installing git-crypt.')
+
       parameter(:init_task_name, default: :init)
       parameter(:add_users_task_name, default: :add_users)
+      parameter(:commit_task_name)
 
       action do |task, args|
         puts('Installing git-crypt...')
         init_git_crypt(task, args)
         add_users_to_git_crypt(task, args)
+        maybe_commit(task, args)
       end
 
       private
@@ -31,6 +36,20 @@ module RakeGitCrypt
       def add_users_to_git_crypt(task, args)
         invoke_task_with_name(task, add_users_task_name, args)
       end
+
+      def maybe_commit(task, args)
+        return unless commit_task_name
+
+        invoke_task_with_name(
+          task, commit_task_name,
+          [commit_message(task), *args]
+        )
+      end
+
+      def commit_message(task)
+        Template.new(commit_message_template)
+                .render(task: task)
+      end
     end
   end
 end

data/lib/rake_git_crypt/tasks/uninstall.rb

@@ -13,14 +13,19 @@ module RakeGitCrypt
       default_name :uninstall
       default_description 'Uninstall git-crypt.'
 
+      parameter(:commit_message_template,
+                default: 'Uninstalling git-crypt.')
+
       parameter(:lock_task_name, default: :lock)
       parameter(:delete_secrets_task_name)
+      parameter(:commit_task_name)
 
       action do |task, args|
         puts('Uninstalling git-crypt...')
         lock_git_crypt(task, args)
         delete_git_crypt_directories
         maybe_delete_secrets(task, args)
+        maybe_commit(task, args)
       end
 
       private
@@ -39,6 +44,20 @@ module RakeGitCrypt
 
         invoke_task_with_name(task, delete_secrets_task_name, args)
       end
+
+      def maybe_commit(task, args)
+        return unless commit_task_name
+
+        invoke_task_with_name(
+          task, commit_task_name,
+          [commit_message(task), *args]
+        )
+      end
+
+      def commit_message(task)
+        Template.new(commit_message_template)
+                .render(task: task)
+      end
     end
   end
 end

data/lib/rake_git_crypt/template.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module RakeGitCrypt
+  class Template
+    def self.from_file(path)
+      new(File.read(path))
+    end
+
+    def initialize(contents)
+      @contents = contents
+    end
+
+    def render(parameters = {})
+      context = Object.new
+      parameters.each do |key, value|
+        context.instance_variable_set("@#{key}", value)
+      end
+      context_binding = context.instance_eval { binding }
+      ERB.new(@contents).result(context_binding)
+    end
+  end
+end

data/lib/rake_git_crypt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RakeGitCrypt
-  VERSION = '0.1.0.pre.17'
+  VERSION = '0.1.0.pre.18'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake_git_crypt
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.17
+  version: 0.1.0.pre.18
 platform: ruby
 authors:
 - InfraBlocks Maintainers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -93,6 +93,7 @@ files:
 - lib/rake_git_crypt/tasks/lock.rb
 - lib/rake_git_crypt/tasks/uninstall.rb
 - lib/rake_git_crypt/tasks/unlock.rb
+- lib/rake_git_crypt/template.rb
 - lib/rake_git_crypt/version.rb
 - rake_git_crypt.gemspec
 homepage: https://github.com/infrablocks/rake_git_crypt