lino 1.9.0 → 1.10.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c5b311ecc9ed33d7222eec9275914b3840b78eb8a50adc6cceede54a7583e72
-  data.tar.gz: 82d9b820187201cddb543cb120ba288cd00d6605dcf1dc29939e4f566cdb1cac
+  metadata.gz: 6b2d97cd89debbd53f7eae071f39fd98568652e7771957c1e6584ca3756edc76
+  data.tar.gz: d1e6e64522855b0b0ac7dab0f7d309d4bf79a894bac43690fa965dbc94e4ce02
 SHA512:
-  metadata.gz: a88c15ab1e68b60a9e4c2ff7fc8201a50955789fd9b608b484d1ed70036ebe71d65727d5af7f306e496b797f73c84e195347c9960eaf549d412dd27075f9ac5d
-  data.tar.gz: 775f44d3d5966a0befd993345e48f60474f0867ef42f51865e66361750b1ada4325c137524d49ce64d002a2042f211fe92511bb464d1b355aacaa6b727ef5ee3
+  metadata.gz: 85f9539da48b728c57ff7725650d5a6fb16c41e401b6313a7bc6dfcfa91747617c21f8732e6b516d4b8f3dd28c21fa96a478b6977b431214d03e335dee3e49b0
+  data.tar.gz: 73ec86a9cfbabc102ee71d83c954541724eaf7454731568e9c00d7f50691e0726a39332a696a3df49f05feedfae72281ed1d79ead14929f88a60c4207b5ba26d

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lino (1.9.0)
+    lino (1.10.0.pre.1)
       hamster (~> 3.0)
       open4 (~> 1.3)
 
@@ -16,6 +16,7 @@ GEM
       zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     colored2 (3.1.2)
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
@@ -37,7 +38,11 @@ GEM
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
     public_suffix (4.0.6)
+    rainbow (3.0.0)
     rake (13.0.3)
     rake_circle_ci (0.9.0)
       colored2 (~> 3.1)
@@ -59,6 +64,8 @@ GEM
       colored2 (~> 3.1)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -72,6 +79,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
+    rubocop (1.12.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.2)
     ruby_gpg2 (0.6.0)
       lino (>= 1.5)
@@ -87,6 +111,7 @@ GEM
     sshkey (2.0.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -102,6 +127,9 @@ DEPENDENCIES
   rake_gpg (~> 0.12)
   rake_ssh (~> 0.4)
   rspec (~> 3.9)
+  rubocop (~> 1.12)
+  rubocop-rake (~> 0.5)
+  rubocop-rspec (~> 2.2)
   simplecov (~> 0.16)
 
 BUNDLED WITH

data/README.md

@@ -183,7 +183,7 @@ To install dependencies and run the build, run the pre-commit build:
 ./go
 ```
 
-Tou can also run only the specs:
+To run only the specs:
 
 ```shell script
 ./go spec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'rake_circle_ci'
 require 'rake_github'
@@ -5,10 +7,12 @@ 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
@@ -23,83 +27,99 @@ 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: 'lino CI Key')
+      output_directory: 'config/secrets/ci',
+      name_prefix: 'gpg',
+      owner_name: 'InfraBlocks Maintainers',
+      owner_email: 'maintainers@infrablocks.io',
+      owner_comment: 'lino 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/lino'
+  namespace: :circle_ci,
+  project_slug: 'github/infrablocks/lino'
 ) 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/lino',
+  namespace: :github,
+  repository: 'infrablocks/lino'
 ) do |t|
   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')
+    }
   ]
 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'
+  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,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'lino'

data/lib/lino.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino/version'
 require 'lino/command_line'
 require 'lino/command_line_builder'

data/lib/lino/command_line.rb

@@ -1,24 +1,28 @@
+# frozen_string_literal: true
+
 require 'open4'
 
 module Lino
   class CommandLine
-    def initialize command_line
+    def initialize(command_line)
       @command_line = command_line
     end
 
     def execute(
-        stdin: '',
-        stdout: STDOUT,
-        stderr: STDERR)
-      Open4::spawn(
-          @command_line,
-          stdin: stdin,
-          stdout: stdout,
-          stderr: stderr)
+      stdin: '',
+      stdout: $stdout,
+      stderr: $stderr
+    )
+      Open4.spawn(
+        @command_line,
+        stdin: stdin,
+        stdout: stdout,
+        stderr: stderr
+      )
     end
 
     def to_s
       @command_line
     end
   end
-end
+end

data/lib/lino/command_line_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'hamster'
 require_relative 'utilities'
 require_relative 'command_line'
@@ -5,16 +7,18 @@ require_relative 'subcommand_builder'
 require_relative 'switches'
 
 module Lino
+  # rubocop:disable Metrics/ClassLength
   class CommandLineBuilder
     include Lino::Utilities
     include Lino::Switches
 
-    class <<self
+    class << self
       def for_command(command)
         CommandLineBuilder.new(command: command)
       end
     end
 
+    # rubocop:disable Metrics/ParameterLists
     def initialize(
       command: nil,
       subcommands: [],
@@ -32,6 +36,7 @@ module Lino
       @option_separator = option_separator
       @option_quoting = option_quoting
     end
+    # rubocop:enable Metrics/ParameterLists
 
     def with_subcommand(subcommand, &block)
       with(
@@ -61,23 +66,23 @@ module Lino
     end
 
     def with_environment_variable(environment_variable, value)
-      with(environment_variables: @environment_variables.add([environment_variable, value]))
+      with(
+        environment_variables:
+          @environment_variables.add(
+            [
+              environment_variable, value
+            ]
+          )
+      )
     end
 
     def build
       components = [
-        map_and_join(@environment_variables) do |var|
-          "#{var[0]}=\"#{var[1].to_s.gsub(/"/, '\\"')}\""
-        end,
+        formatted_environment_variables,
         @command,
-        map_and_join(
-          @switches,
-          &(quote_with(@option_quoting) >> join_with(@option_separator))
-        ),
-        map_and_join(@subcommands) do |sub|
-          sub.build(@option_separator, @option_quoting)
-        end,
-        map_and_join(@arguments, &join_with(' '))
+        formatted_switches,
+        formatted_subcommands,
+        formatted_arguments
       ]
 
       command_string = components.reject(&:empty?).join(' ')
@@ -87,6 +92,29 @@ module Lino
 
     private
 
+    def formatted_environment_variables
+      map_and_join(@environment_variables) do |var|
+        "#{var[0]}=\"#{var[1].to_s.gsub(/"/, '\\"')}\""
+      end
+    end
+
+    def formatted_switches
+      map_and_join(
+        @switches,
+        &(quote_with(@option_quoting) >> join_with(@option_separator))
+      )
+    end
+
+    def formatted_subcommands
+      map_and_join(@subcommands) do |sub|
+        sub.build(@option_separator, @option_quoting)
+      end
+    end
+
+    def formatted_arguments
+      map_and_join(@arguments, &join_with(' '))
+    end
+
     def with(**replacements)
       CommandLineBuilder.new(**state.merge(replacements))
     end
@@ -109,4 +137,5 @@ module Lino
       @arguments = @arguments.add({ components: [argument] })
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/lino/subcommand_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'hamster'
 require_relative 'utilities'
 require_relative 'switches'

data/lib/lino/switches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lino
   module Switches
     def with_option(switch, value, separator: nil, quoting: nil)

data/lib/lino/utilities.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pp'
 
 module Lino
@@ -14,20 +16,30 @@ module Lino
 
     def quote_with(global_character)
       lambda do |item|
-        character = item[:quoting] || global_character
-        components = item[:components]
-        switch = components[0]
-        value = components[1]
-
         item.merge(
-            components: (components.count > 1) ?
-                [switch, "#{character}#{value}#{character}"] :
-                components)
+          components: resolve_components(item, global_character)
+        )
       end
     end
 
     def missing?(value)
       value.nil? || (value.respond_to?(:empty?) && value.empty?)
     end
+
+    private
+
+    def resolve_components(item, global_character)
+      components = item[:components]
+      switch = components[0]
+
+      if components.count > 1
+        character = item[:quoting] || global_character
+        value = components[1]
+
+        [switch, "#{character}#{value}#{character}"]
+      else
+        components
+      end
+    end
   end
-end
+end

data/lib/lino/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lino
-  VERSION = '1.9.0'
+  VERSION = '1.10.0.pre.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lino
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0.pre.1
 platform: ruby
 authors:
 - Toby Clemson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hamster
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,33 +109,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: rake_ssh
+  name: rake_gpg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
-  name: rake_gpg
+  name: rake_ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -137,19 +151,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: gem-release
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -201,9 +243,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.1
 signing_key: