ruby_gpg2 0.9.0.pre.4 → 0.9.0.pre.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1759342b199d0e3001c3350feb47c8df3c930f01eec4f4633688346a33f3921d
-  data.tar.gz: 19b9fe9ce72f4bb9eaf88ebcaff279a1dac937c7fbd1fdacb8890d3eef8e6d7a
+  metadata.gz: 2531cddbc871f900657cd40fbc035ea101500582bea37de304c5bfd47ede4867
+  data.tar.gz: e6786466c2de24986cab0a5ea22c3d14de60b994398f5e3fd8cb9c9578c6d140
 SHA512:
-  metadata.gz: bcaa1aca6ba8994e3f1a4a8e36f7732eba47b88cc24251e267350c84ffda0ecfa835e0bacdca451cf797dda0bd131d77890f55fea87d8c2df71621cc17aaf368
-  data.tar.gz: 8ee8d3fcff5b066fc865789fa31853f93a70facd6576dc6137933f3e8f391fc39192a02de37b5cc1299a606bfb2e4084fa29eb8e369636a7043bbecb9e57900e
+  metadata.gz: 2cfb2c57af9082de8c5eb3a45c33c63da764ab77e4163819a58ae209c809030b5a61ad108d4ab33a7d14d2d7bda33d0ea67696c558f968f83f56fb2f323c3be7
+  data.tar.gz: 4897050c6975b5ba2944ef8df26ba9d4f2a25c8759f7a481d69af40c41bbf121ffbd1376a85f9dcb7534530de12d00665826b617bf7db20d7e89831ce61fd244

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_gpg2 (0.9.0.pre.4)
+    ruby_gpg2 (0.9.0.pre.7)
       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)
     faraday (1.10.0)
       faraday-em_http (~> 1.0)
@@ -55,7 +57,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)
@@ -77,6 +83,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)
@@ -90,13 +98,36 @@ 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)
     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
@@ -112,7 +143,11 @@ DEPENDENCIES
   rake_gpg
   rake_ssh
   rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
   ruby_gpg2!
+  simplecov
 
 BUNDLED WITH
-   2.3.9
+   2.3.11

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 InfraBlocks
+Copyright (c) 2022 InfraBlocks Maintainers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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_gpg2 CI Key')
+      output_directory: 'config/secrets/ci',
+      name_prefix: 'gpg',
+      owner_name: 'InfraBlocks Maintainers',
+      owner_email: 'maintainers@infrablocks.io',
+      owner_comment: 'ruby_gpg2 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_gpg2'
+  namespace: :circle_ci,
+  project_slug: 'github/infrablocks/ruby_gpg2'
 ) 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_gpg2',
+  namespace: :github,
+  repository: 'infrablocks/ruby_gpg2'
 ) 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_gpg2"
+require 'bundler/setup'
+require 'ruby_gpg2'
 
 # 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_gpg2"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/ruby_gpg2/colon_output.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './colon_record'
 require_relative './key'
 
@@ -5,9 +7,9 @@ module RubyGPG2
   class ColonOutput
     def self.parse(records)
       new(records
-          .strip
-          .split("\n")
-          .collect { |record| ColonRecord.parse(record) })
+            .strip
+            .split("\n")
+            .collect { |record| ColonRecord.parse(record) })
     end
 
     def initialize(records)
@@ -16,12 +18,12 @@ module RubyGPG2
 
     def secret_keys
       group_by_type(:secret_key)
-          .map { |record_group| extract_key(:secret, record_group) }
+        .map { |record_group| extract_key(:secret, record_group) }
     end
 
     def public_keys
       group_by_type(:public_key)
-          .map { |record_group| extract_key(:public, record_group) }
+        .map { |record_group| extract_key(:public, record_group) }
     end
 
     def ==(other)
@@ -38,9 +40,9 @@ module RubyGPG2
 
     def indices_by_type(type)
       @records
-          .each_with_index
-          .collect { |record, index| record.type == type ? index : nil }
-          .compact
+        .each_with_index
+        .collect { |record, index| record.type == type ? index : nil }
+        .compact
     end
 
     def group_by_type(type)
@@ -55,44 +57,61 @@ module RubyGPG2
     end
 
     def extract_key(type, record_group)
-      records_in_group = record_group.count
       key_record = record_group[0]
+      fingerprint = extract_fingerprint(record_group)
+      user_ids = extract_user_ids(record_group)
+
+      make_key(type, key_record, fingerprint, user_ids)
+    end
+
+    def extract_user_ids(record_group)
+      user_id_records =
+        record_group
+        .drop_while { |r| !r.user_id_record? }
+        .take_while(&:user_id_record?)
+      user_id_records.map(&method(:make_user_id))
+    end
 
+    def extract_fingerprint(record_group)
+      records_in_group = record_group.count
       fingerprint_record =
-          (records_in_group > 1 && record_group[1].fingerprint_record?) ?
-              record_group[1] :
-              nil
-      fingerprint = fingerprint_record&.fingerprint
-
-      user_id_records = record_group
-          .drop_while { |r| !r.user_id_record? }
-          .take_while { |r| r.user_id_record? }
-      user_ids = user_id_records.map do |record|
-        UserID.new(
-            name: record.user_name,
-            comment: record.user_comment,
-            email: record.user_email,
-            validity: record.validity,
-            creation_date: record.creation_date,
-            expiration_date: record.expiration_date,
-            hash: record.user_id_hash,
-            origin: record.origin)
-      end
+        if records_in_group > 1 && record_group[1].fingerprint_record?
+          record_group[1]
+        end
+      fingerprint_record&.fingerprint
+    end
+
+    def make_user_id(record)
+      UserID.new(
+        name: record.user_name,
+        comment: record.user_comment,
+        email: record.user_email,
+        validity: record.validity,
+        creation_date: record.creation_date,
+        expiration_date: record.expiration_date,
+        hash: record.user_id_hash,
+        origin: record.origin
+      )
+    end
 
+    # rubocop:disable Metrics/MethodLength
+    def make_key(type, key_record, fingerprint, user_ids)
       Key.new(
-          type: type,
-          validity: key_record.validity,
-          length: key_record.key_length,
-          algorithm: key_record.key_algorithm,
-          id: key_record.key_id,
-          creation_date: key_record.creation_date,
-          owner_trust: key_record.owner_trust,
-          capabilities: key_record.key_capabilities,
-          serial_number: key_record.serial_number,
-          compliance_modes: key_record.compliance_modes,
-          origin: key_record.origin,
-          fingerprint: fingerprint,
-          user_ids: user_ids)
+        type: type,
+        validity: key_record.validity,
+        length: key_record.key_length,
+        algorithm: key_record.key_algorithm,
+        id: key_record.key_id,
+        creation_date: key_record.creation_date,
+        owner_trust: key_record.owner_trust,
+        capabilities: key_record.key_capabilities,
+        serial_number: key_record.serial_number,
+        compliance_modes: key_record.compliance_modes,
+        origin: key_record.origin,
+        fingerprint: fingerprint,
+        user_ids: user_ids
+      )
     end
+    # rubocop:enable Metrics/MethodLength
   end
-end
+end