ruby_fly 0.38.0.pre.2 → 0.38.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 595a106b324d1d102c4d8d0e4267ba1fdefdd014fc8c1e49c6d5b7df32976d18
-  data.tar.gz: f086df5ec4b0355482eb95d30773b217e0288ddaae92a7f564212b174525d541
+  metadata.gz: 8a923ce7e879b4342da242cfa3dc805bd8aa14fced11105bdb78d749a59e9b37
+  data.tar.gz: cb492bc1bd6aabd920dbfa84cc4eeb3dbee36ff1fc14b254fbcb0e7a879bdcec
 SHA512:
-  metadata.gz: 120b68ce0f25b47b4cbcab6a53db14f3c7d2d06e0dcc43f1654803e14f2188a3808a14e98e476698c120fa045df9e57ebcd1830ecfa05d69817b82e8c54008ce
-  data.tar.gz: d43795d459fb4cc9ef23de3cff44604529983f0c56f16819780997494a4be6d93158f8c6d933bdd19525c53c86d81d430a9ccb5963bafcc71b08a788f412df35
+  metadata.gz: 8298eeee2b9bae869f09da25cb3332f000a82ee736871e667e9fc47653197d1636f60075ada52fd4840fc2b2af607c87c30c89f90d5673d3a429d64cc66b9d51
+  data.tar.gz: ec8a3662cdb182d9364356b25da3e2c0cc65db3719f71e9b8b373633969d9c1fed52c766c2b2f8ed590c5a5d8db587d2fc00a3f4cf353c072603f0ad46c38eff

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_fly (0.38.0.pre.2)
+    ruby_fly (0.38.0.pre.3)
       lino (~> 3.0)
 
 GEM
@@ -14,9 +14,11 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     colored2 (3.1.2)
     concurrent-ruby (1.1.9)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     excon (0.92.0)
     fakefs (1.4.1)
     faker (2.20.0)
@@ -58,7 +60,11 @@ GEM
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      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)
@@ -80,6 +86,8 @@ GEM
       colored2 (~> 3.1)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -93,15 +101,38 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    rubocop (1.27.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     ruby_gpg2 (0.8.0)
       lino (>= 1.5)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     sshkey (2.0.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -117,7 +148,11 @@ DEPENDENCIES
   rake_gpg
   rake_ssh
   rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
   ruby_fly!
+  simplecov
 
 BUNDLED WITH
-   2.3.9
+   2.3.11

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'rake_circle_ci'
 require 'rake_github'
@@ -5,17 +7,26 @@ 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 :directory do
+    desc 'Ensure CI secrets directory exists.'
+    task :ensure do
+      FileUtils.mkdir_p('config/secrets/ci')
+    end
+  end
+
   namespace :passphrase do
-    task :generate do
-      File.open('config/secrets/ci/encryption.passphrase', 'w') do |f|
-        f.write(SecureRandom.base64(36))
-      end
+    desc 'Generate encryption passphrase used by CI.'
+    task generate: ['directory:ensure'] do
+      File.write('config/secrets/ci/encryption.passphrase',
+                 SecureRandom.base64(36))
     end
   end
 end
@@ -23,85 +34,111 @@ 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: 'ruby_fly CI Key')
+      output_directory: 'config/secrets/ci',
+      name_prefix: 'gpg',
+      owner_name: 'InfraBlocks Maintainers',
+      owner_email: 'maintainers@infrablocks.io',
+      owner_comment: 'ruby_fly CI Key'
+    )
   end
 end
 
+namespace :secrets do
+  desc 'Regenerate all generatable secrets.'
+  task regenerate: %w[
+    encryption:passphrase:generate
+    keys:deploy:generate
+    keys:gpg:generate
+  ]
+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/ruby_fly'
+  namespace: :circle_ci,
+  project_slug: 'github/infrablocks/ruby_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/ruby_fly',
+  namespace: :github,
+  repository: 'infrablocks/ruby_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 "ruby_fly"
+require 'bundler/setup'
+require 'ruby_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 "ruby_fly"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/ruby_fly/commands/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 module RubyFly
@@ -13,39 +15,32 @@ module RubyFly
       end
 
       def execute(opts = {})
-        builder = instantiate_builder
-
         do_before(opts)
         do_around(opts) do |new_opts|
-          configure_command(builder, new_opts)
-              .build
-              .execute(
-                  stdin: stdin,
-                  stdout: stdout,
-                  stderr: stderr)
+          configure_command(instantiate_builder, new_opts)
+            .build
+            .execute(stdin: stdin, stdout: stdout, stderr: stderr)
         end
         do_after(opts)
       end
 
       def instantiate_builder
         Lino::CommandLineBuilder
-            .for_command(binary)
-            .with_option_separator('=')
+          .for_command(binary)
+          .with_option_separator('=')
       end
 
-      def do_before(opts)
-      end
+      def do_before(opts); end
 
       def do_around(opts, &block)
         block.call(opts)
       end
 
-      def configure_command(builder, opts)
+      def configure_command(builder, _opts)
         builder
       end
 
-      def do_after(opts)
-      end
+      def do_after(opts); end
     end
   end
-end
+end

data/lib/ruby_fly/commands/destroy_pipeline.rb

@@ -1,41 +1,53 @@
+# frozen_string_literal: true
+
 require 'lino'
 require_relative 'base'
 require_relative 'mixins/environment'
+require_relative 'mixins/required_params'
 
 module RubyFly
   module Commands
     class DestroyPipeline < Base
       include Mixins::Environment
+      include Mixins::RequiredParams
 
       def configure_command(builder, opts)
         builder = super(builder, opts)
+        builder
+          .with_subcommand('destroy-pipeline') do |sub|
+          sub = with_target(sub, opts[:target])
+          sub = with_pipeline(sub, opts[:pipeline])
+          sub = with_team(sub, opts[:team])
+          sub = with_non_interactive(sub, opts[:non_interactive])
+          sub
+        end
+      end
 
-        missing_params = [
-            :target,
-            :pipeline
-        ].select { |param| opts[param].nil? }
+      private
 
-        unless missing_params.empty?
-          description = missing_params.map { |p| "'#{p}'" }.join(', ')
-          raise(
-              ArgumentError,
-              "Error: #{description} required but not provided.")
-        end
+      def required_params
+        %i[target pipeline]
+      end
+
+      def with_target(sub, target)
+        sub.with_option('-t', target)
+      end
+
+      def with_pipeline(sub, pipeline)
+        sub.with_option('-p', pipeline)
+      end
 
-        target = opts[:target]
-        pipeline = opts[:pipeline]
-        non_interactive = opts[:non_interactive]
-        team = opts[:team]
+      def with_team(sub, team)
+        return sub unless team
 
-        builder
-            .with_subcommand('destroy-pipeline') do |sub|
-              sub = sub.with_option('-t', target)
-              sub = sub.with_option('-p', pipeline)
-              sub = sub.with_option('--team', team) if team
-              sub = sub.with_flag('-n') if non_interactive
-              sub
-            end
+        sub.with_option('--team', team)
+      end
+
+      def with_non_interactive(sub, non_interactive)
+        return sub unless non_interactive
+
+        sub.with_flag('-n')
       end
     end
   end
-end
+end

data/lib/ruby_fly/commands/get_pipeline.rb

@@ -1,37 +1,39 @@
+# frozen_string_literal: true
+
 require 'lino'
 require_relative 'base'
 require_relative 'mixins/environment'
+require_relative 'mixins/required_params'
 
 module RubyFly
   module Commands
     class GetPipeline < Base
       include Mixins::Environment
+      include Mixins::RequiredParams
 
       def configure_command(builder, opts)
         builder = super(builder, opts)
+        builder
+          .with_subcommand('get-pipeline') do |sub|
+          sub = with_target(sub, opts[:target])
+          sub = with_pipeline(sub, opts[:pipeline])
+          sub
+        end
+      end
 
-        missing_params = [
-            :target,
-            :pipeline
-        ].select { |param| opts[param].nil? }
+      private
 
-        unless missing_params.empty?
-          description = missing_params.map { |p| "'#{p}'" }.join(', ')
-          raise(
-              ArgumentError,
-              "Error: #{description} required but not provided.")
-        end
+      def required_params
+        %i[target pipeline]
+      end
 
-        target = opts[:target]
-        pipeline = opts[:pipeline]
+      def with_target(sub, target)
+        sub.with_option('-t', target)
+      end
 
-        builder
-            .with_subcommand('get-pipeline') do |sub|
-              sub = sub.with_option('-t', target)
-              sub = sub.with_option('-p', pipeline)
-              sub
-            end
+      def with_pipeline(sub, pipeline)
+        sub.with_option('-p', pipeline)
       end
     end
   end
-end
+end

data/lib/ruby_fly/commands/login.rb

@@ -1,42 +1,62 @@
+# frozen_string_literal: true
+
 require 'lino'
 require_relative 'base'
 require_relative 'mixins/environment'
+require_relative 'mixins/required_params'
 
 module RubyFly
   module Commands
     class Login < Base
       include Mixins::Environment
+      include Mixins::RequiredParams
 
       def configure_command(builder, opts)
         builder = super(builder, opts)
-
-        missing_params = [
-            :target
-        ].select { |param| opts[param].nil? }
-
-        unless missing_params.empty?
-          description = missing_params.map { |p| "'#{p}'" }.join(', ')
-          raise(
-              ArgumentError,
-              "Error: #{description} required but not provided.")
-        end
-
-        target = opts[:target]
-        concourse_url = opts[:concourse_url]
-        username = opts[:username]
-        password = opts[:password]
-        team = opts[:team]
-
         builder
           .with_subcommand('login') do |sub|
-            sub = sub.with_option('-t', target)
-            sub = sub.with_option('-c', concourse_url) if concourse_url
-            sub = sub.with_option('-u', username) if username
-            sub = sub.with_option('-p', password) if password
-            sub = sub.with_option('-n', team) if team
+            sub = with_target(sub, opts[:target])
+            sub = with_concourse_url(sub, opts[:concourse_url])
+            sub = with_username(sub, opts[:username])
+            sub = with_password(sub, opts[:password])
+            sub = with_team(sub, opts[:team])
             sub
           end
       end
+
+      private
+
+      def required_params
+        %i[target]
+      end
+
+      def with_target(builder, target)
+        builder.with_option('-t', target)
+      end
+
+      def with_concourse_url(builder, concourse_url)
+        return builder unless concourse_url
+
+        builder.with_option('-c', concourse_url)
+      end
+
+      def with_username(builder, username)
+        return builder unless username
+
+        builder.with_option('-u', username)
+      end
+
+      def with_password(builder, password)
+        return builder unless password
+
+        builder.with_option('-p', password)
+      end
+
+      def with_team(builder, team)
+        return builder unless team
+
+        builder.with_option('-n', team)
+      end
     end
   end
-end
+end

data/lib/ruby_fly/commands/mixins/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyFly
   module Commands
     module Mixins
@@ -16,14 +18,14 @@ module RubyFly
           builder = super(builder, opts)
           environment = opts[:environment] || @environment
           if environment
-            builder = environment.to_a
-                .inject(builder) do |b, environment_variable|
-              b.with_environment_variable(*environment_variable)
-            end
+            builder =
+              environment.to_a.inject(builder) do |b, environment_variable|
+                b.with_environment_variable(*environment_variable)
+              end
           end
           builder
         end
       end
     end
   end
-end
+end

data/lib/ruby_fly/commands/mixins/required_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RubyFly
+  module Commands
+    module Mixins
+      module RequiredParams
+        def configure_command(builder, opts)
+          assert_required_params(opts)
+          super(builder, opts)
+        end
+
+        def required_params
+          %i[]
+        end
+
+        private
+
+        def missing_params(opts)
+          required_params.select { |param| opts[param].nil? }
+        end
+
+        def assert_required_params(opts)
+          missing_params = missing_params(opts)
+          return if missing_params.empty?
+
+          description = missing_params.map { |p| "'#{p}'" }.join(', ')
+          raise(
+            ArgumentError,
+            "Error: #{description} required but not provided."
+          )
+        end
+      end
+    end
+  end
+end