rake_fly 2.10.0.pre.1 → 2.10.0.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f96d069b06b8dffc2e0e406f4a989092232bda81c5bf40e1e390d13c8d6752d0
-  data.tar.gz: 4059e84bdd8c4e39cda00270cacd11ca096a047efdb4eb3bd3fb9b1e009c17f8
+  metadata.gz: ecd38dbc5a32859dbc5c79ed756d0b0d0633616b12ee671955f96c1a6a00ec86
+  data.tar.gz: 4ee91baf475caffce6c7f365646195a462f1573b0fa683f73def43b4215c1a7f
 SHA512:
-  metadata.gz: 4b484d48ea1c3c795313a64daf31c8e8d746a96765041d8f113b01bfa2c0594dd4958cda1a2514e0e9ca4a40e72d8f52be3e691a12d0ce0ddf3f0712b0d251a6
-  data.tar.gz: c99e52be37cfb43d12dfdea01ec3fc6b114b52b1c6b76fca6a27aced3f3a24756a6f5cd5fa1efc8be09689b818683429b3aa79c315eac854b9a7f0f2e0278cca
+  metadata.gz: 1bb952f89dd0119f849ed684afb2b45a907d5d6b79fd39891a25477c925957fc78b133ff7a5e71a362fd0ac9ef17c7e683896b27c1b9e79c49f79d9402d42ffb
+  data.tar.gz: cc8098eb1ab1f5e132e32ea882924b1bcea34fac0e121fccba65a6f38264e1610fadfd56fc7275fe175b9310ed7564c12259fbc39f3afc4ebea59c5c96c8d0c5

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rake_fly.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rake_fly (2.10.0.pre.1)
+    rake_fly (2.10.0.pre.4)
       concourse.rb (>= 0.4)
       rake_dependencies (~> 3.1)
       rake_factory (~> 0.29)
@@ -11,19 +11,20 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     colored2 (3.1.2)
     concourse.rb (0.4.0)
       dry-schema (~> 0.5)
       excon (~> 0.72)
       semantic (~> 1.5)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     docile (1.4.0)
     dry-configurable (0.14.0)
@@ -55,8 +56,8 @@ GEM
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
     excon (0.92.0)
-    fakefs (1.4.1)
-    faker (2.20.0)
+    fakefs (1.8.0)
+    faker (2.23.0)
       i18n (>= 1.8.11, < 2)
     faraday (1.10.0)
       faraday-em_http (~> 1.0)
@@ -84,21 +85,26 @@ GEM
     gem-release (2.2.2)
     hamster (3.0.0)
       concurrent-ruby (~> 1.0)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    jwt (2.3.0)
+    json (2.6.2)
+    jwt (2.5.0)
     lino (3.0.0)
       hamster (~> 3.0)
       open4 (~> 1.3)
     minitar (0.9)
-    minitest (5.15.0)
+    minitest (5.16.2)
     multipart-post (2.1.1)
     octokit (4.22.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    openssl (3.0.0)
+    openssl (3.0.1)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
     public_suffix (4.0.6)
+    rainbow (3.1.1)
     rake (13.0.6)
     rake_circle_ci (0.9.0)
       colored2 (~> 3.1)
@@ -125,6 +131,8 @@ GEM
       colored2 (~> 3.1)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -138,6 +146,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     ruby_fly (0.37.0)
       lino (~> 3.0)
@@ -157,6 +182,7 @@ GEM
     sshkey (2.0.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   ruby
@@ -177,7 +203,10 @@ DEPENDENCIES
   rake_gpg
   rake_ssh
   rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
   simplecov
 
 BUNDLED WITH
-   2.3.9
+   2.3.22

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'rake_circle_ci'
 require 'rake_github'
@@ -5,17 +7,20 @@ require 'rake_ssh'
 require 'rake_gpg'
 require 'securerandom'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-task :default => :spec
-
-RSpec::Core::RakeTask.new(:spec)
+task default: %i[
+  library:fix
+  test:unit
+]
 
 namespace :encryption do
   namespace :passphrase do
+    desc 'Generate encryption passphrase for CI GPG key'
     task :generate do
-      File.open('config/secrets/ci/encryption.passphrase', 'w') do |f|
-        f.write(SecureRandom.base64(36))
-      end
+      FileUtils.mkdir_p('config/secrets/ci/')
+      File.write('config/secrets/ci/encryption.passphrase',
+                 SecureRandom.base64(36))
     end
   end
 end
@@ -23,85 +28,102 @@ end
 namespace :keys do
   namespace :deploy do
     RakeSSH.define_key_tasks(
-        path: 'config/secrets/ci/',
-        comment: 'maintainers@infrablocks.io')
+      path: 'config/secrets/ci/',
+      comment: 'maintainers@infrablocks.io'
+    )
   end
 
   namespace :gpg do
     RakeGPG.define_generate_key_task(
-        output_directory: 'config/secrets/ci',
-        name_prefix: 'gpg',
-        owner_name: 'InfraBlocks Maintainers',
-        owner_email: 'maintainers@infrablocks.io',
-        owner_comment: 'rake_fly CI Key')
+      output_directory: 'config/secrets/ci',
+      name_prefix: 'gpg',
+      owner_name: 'InfraBlocks Maintainers',
+      owner_email: 'maintainers@infrablocks.io',
+      owner_comment: 'rake_fly CI Key'
+    )
   end
 end
 
+RuboCop::RakeTask.new
+
+namespace :library do
+  desc 'Run all checks of the library'
+  task check: [:rubocop]
+
+  desc 'Attempt to automatically fix issues with the library'
+  task fix: [:'rubocop:auto_correct']
+end
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit)
+end
+
 RakeCircleCI.define_project_tasks(
-    namespace: :circle_ci,
-    project_slug: 'github/infrablocks/rake_fly'
+  namespace: :circle_ci,
+  project_slug: 'github/infrablocks/rake_fly'
 ) do |t|
   circle_ci_config =
-      YAML.load_file('config/secrets/circle_ci/config.yaml')
+    YAML.load_file('config/secrets/circle_ci/config.yaml')
 
-  t.api_token = circle_ci_config["circle_ci_api_token"]
+  t.api_token = circle_ci_config['circle_ci_api_token']
   t.environment_variables = {
-      ENCRYPTION_PASSPHRASE:
-          File.read('config/secrets/ci/encryption.passphrase')
-              .chomp
+    ENCRYPTION_PASSPHRASE:
+        File.read('config/secrets/ci/encryption.passphrase')
+            .chomp
   }
   t.checkout_keys = []
   t.ssh_keys = [
-      {
-          hostname: "github.com",
-          private_key: File.read('config/secrets/ci/ssh.private')
-      }
+    {
+      hostname: 'github.com',
+      private_key: File.read('config/secrets/ci/ssh.private')
+    }
   ]
 end
 
 RakeGithub.define_repository_tasks(
-    namespace: :github,
-    repository: 'infrablocks/rake_fly',
+  namespace: :github,
+  repository: 'infrablocks/rake_fly'
 ) do |t, args|
   github_config =
-      YAML.load_file('config/secrets/github/config.yaml')
+    YAML.load_file('config/secrets/github/config.yaml')
 
-  t.access_token = github_config["github_personal_access_token"]
+  t.access_token = github_config['github_personal_access_token']
   t.deploy_keys = [
-      {
-          title: 'CircleCI',
-          public_key: File.read('config/secrets/ci/ssh.public')
-      }
+    {
+      title: 'CircleCI',
+      public_key: File.read('config/secrets/ci/ssh.public')
+    }
   ]
   t.branch_name = args.branch_name
   t.commit_message = args.commit_message
 end
 
 namespace :pipeline do
-  task :prepare => [
-      :'circle_ci:project:follow',
-      :'circle_ci:env_vars:ensure',
-      :'circle_ci:checkout_keys:ensure',
-      :'circle_ci:ssh_keys:ensure',
-      :'github:deploy_keys:ensure'
+  desc 'Prepare CircleCI Pipeline'
+  task prepare: %i[
+    circle_ci:project:follow
+    circle_ci:env_vars:ensure
+    circle_ci:checkout_keys:ensure
+    circle_ci:ssh_keys:ensure
+    github:deploy_keys:ensure
   ]
 end
 
 namespace :version do
-  desc "Bump version for specified type (pre, major, minor, patch)"
+  desc 'Bump version for specified type (pre, major, minor, patch)'
   task :bump, [:type] do |_, args|
     bump_version_for(args.type)
   end
 end
 
-desc "Release gem"
+desc 'Release gem'
 task :release do
-  sh "gem release --tag --push"
+  sh 'gem release --tag --push'
 end
 
 def bump_version_for(version_type)
-  sh "gem bump --version #{version_type} " +
-      "&& bundle install " +
-      "&& export LAST_MESSAGE=\"$(git log -1 --pretty=%B)\" " +
-      "&& git commit -a --amend -m \"${LAST_MESSAGE} [ci skip]\""
+  sh "gem bump --version #{version_type} " \
+     '&& bundle install ' \
+     '&& export LAST_MESSAGE="$(git log -1 --pretty=%B)" ' \
+     '&& git commit -a --amend -m "${LAST_MESSAGE} [ci skip]"'
 end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rake_fly"
+require 'bundler/setup'
+require 'rake_fly'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rake_fly"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/rake_fly/kernel_extensions.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'rake_factory/kernel_extensions'

data/lib/rake_fly/task_sets/authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 
 require_relative '../tasks/authentication/login'
@@ -14,12 +16,15 @@ module RakeFly
       parameter :concourse_url, required: true
       parameter :team, default: 'main'
 
-      parameter :backend, default: RakeFly::Tasks::Authentication::Login::ApiBackend
+      parameter :backend,
+                default: RakeFly::Tasks::Authentication::Login::ApiBackend
       parameter :username
       parameter :password
 
       parameter :home_directory,
-          default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
+                default: RakeFactory::DynamicValue.new { |_|
+                           Dir.home
+                         }
 
       parameter :login_task_name, default: :login
       parameter :ensure_task_name, default: :ensure
@@ -27,13 +32,13 @@ module RakeFly
       parameter :fly_ensure_task_name, default: :'fly:ensure'
 
       task Tasks::Authentication::Login,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.login_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.login_task_name
+           }
       task Tasks::Authentication::Ensure,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.ensure_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.ensure_task_name
+           }
     end
   end
 end

data/lib/rake_fly/task_sets/pipeline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 
 require_relative '../tasks/pipeline/get'
@@ -22,7 +24,9 @@ module RakeFly
       parameter :non_interactive
 
       parameter :home_directory,
-          default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
+                default: RakeFactory::DynamicValue.new { |_|
+                           Dir.home
+                         }
 
       parameter :get_task_name, default: :get
       parameter :set_task_name, default: :set
@@ -33,25 +37,25 @@ module RakeFly
       parameter :fly_ensure_task_name, default: :'fly:ensure'
 
       task Tasks::Pipeline::Get,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.get_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.get_task_name
+           }
       task Tasks::Pipeline::Set,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.set_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.set_task_name
+           }
       task Tasks::Pipeline::Unpause,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.unpause_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.unpause_task_name
+           }
       task Tasks::Pipeline::Push,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.push_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.push_task_name
+           }
       task Tasks::Pipeline::Destroy,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.destroy_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.destroy_task_name
+           }
     end
   end
 end

data/lib/rake_fly/task_sets/project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 
 require_relative '../tasks/authentication/login'
@@ -9,6 +11,7 @@ require_relative '../tasks/pipeline/push'
 
 module RakeFly
   module TaskSets
+    # rubocop:disable Metrics/ClassLength
     class Project < RakeFactory::TaskSet
       prepend RakeFactory::Namespaceable
 
@@ -17,7 +20,8 @@ module RakeFly
       parameter :concourse_url, required: true
       parameter :team, default: 'main'
 
-      parameter :backend, default: RakeFly::Tasks::Authentication::Login::ApiBackend
+      parameter :backend,
+                default: RakeFly::Tasks::Authentication::Login::ApiBackend
       parameter :username
       parameter :password
 
@@ -29,10 +33,12 @@ module RakeFly
       parameter :non_interactive
 
       parameter :target,
-          default: RakeFactory::DynamicValue.new { |t| t.team }
+                default: RakeFactory::DynamicValue.new { |t| t.team }
 
       parameter :home_directory,
-          default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
+                default: RakeFactory::DynamicValue.new { |_|
+                           Dir.home
+                         }
 
       parameter :authentication_namespace, default: :authentication
       parameter :authentication_login_task_name, default: :login
@@ -48,89 +54,93 @@ module RakeFly
       parameter :fly_ensure_task_name, default: :'fly:ensure'
 
       task Tasks::Authentication::Login,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.authentication_login_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.authentication_login_task_name
+           }
       task Tasks::Authentication::Ensure,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.authentication_ensure_task_name
-          },
-          login_task_name: RakeFactory::DynamicValue.new { |ts|
-            ts.authentication_login_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.authentication_ensure_task_name
+           },
+           login_task_name: RakeFactory::DynamicValue.new { |ts|
+             ts.authentication_login_task_name
+           }
 
       task Tasks::Pipeline::Get,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_get_task_name
-          },
-          authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
-            (ts.authentication_namespace.to_s + ":" +
-                ts.authentication_ensure_task_name.to_s)
-                .to_sym
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_get_task_name
+           },
+           authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
+             "#{ts.authentication_namespace}:" \
+             "#{ts.authentication_ensure_task_name}"
+               .to_sym
+           }
       task Tasks::Pipeline::Set,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_set_task_name
-          },
-          authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
-            (ts.authentication_namespace.to_s + ":" +
-                ts.authentication_ensure_task_name.to_s)
-                .to_sym
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_set_task_name
+           },
+           authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
+             "#{ts.authentication_namespace}:" \
+             "#{ts.authentication_ensure_task_name}"
+               .to_sym
+           }
       task Tasks::Pipeline::Unpause,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_unpause_task_name
-          },
-          authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
-            (ts.authentication_namespace.to_s + ":" +
-                ts.authentication_ensure_task_name.to_s)
-                .to_sym
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_unpause_task_name
+           },
+           authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
+             "#{ts.authentication_namespace}:" \
+             "#{ts.authentication_ensure_task_name}"
+               .to_sym
+           }
       task Tasks::Pipeline::Push,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_push_task_name
-          },
-          get_task_name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_get_task_name
-          },
-          set_task_name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_set_task_name
-          },
-          unpause_task_name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_unpause_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_push_task_name
+           },
+           get_task_name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_get_task_name
+           },
+           set_task_name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_set_task_name
+           },
+           unpause_task_name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_unpause_task_name
+           }
       task Tasks::Pipeline::Destroy,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_destroy_task_name
-          },
-          authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
-            (ts.authentication_namespace.to_s + ":" +
-                ts.authentication_ensure_task_name.to_s)
-                .to_sym
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_destroy_task_name
+           },
+           authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
+             "#{ts.authentication_namespace}:" \
+             "#{ts.authentication_ensure_task_name}"
+               .to_sym
+           }
 
       def define_on(application)
         around_define(application) do
           self.class.tasks.each do |task_definition|
-            task_class = task_definition.klass.to_s
-            ns = case task_class
-            when /Pipeline/
-              pipeline_namespace
-            when /Authentication/
-              authentication_namespace
-            else
-              raise StandardError.new(
-                  "Unexpected task definition: #{task_class}.")
-            end
+            namespace = resolve_namespace(task_definition)
 
-            application.in_namespace(ns) do
+            application.in_namespace(namespace) do
               task_definition
-                  .for_task_set(self)
-                  .define_on(application)
+                .for_task_set(self)
+                .define_on(application)
             end
           end
         end
       end
+
+      private
+
+      def resolve_namespace(task_definition)
+        case task_definition.klass.to_s
+        when /Pipeline/ then pipeline_namespace
+        when /Authentication/ then authentication_namespace
+        else
+          raise StandardError,
+                "Unexpected task definition: #{task_definition.klass}."
+        end
+      end
     end
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/rake_fly/task_sets.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'task_sets/authentication'
 require_relative 'task_sets/pipeline'
 require_relative 'task_sets/project'