lino 2.0.0.pre.1 → 2.2.0.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1ed8a59b3a9171234c636171f9b7304637067db63ff130c04c14a780418f28c
-  data.tar.gz: 927e637996bab9611c2233e92b1ab5b0869a5de36847dce88086880fd1022d71
+  metadata.gz: 027d718112a95bd94fcd6f88a2f387de6d60abc41a131112a226e9e21b14b0be
+  data.tar.gz: ad1156f5456e249bf30ca814a3b6e55342ad62ff0c7b70ceb923e16992df56ce
 SHA512:
-  metadata.gz: 357901083b289bbf18a2c3f7425ae01967d950c0329b6c793dd214fe2b265bea8f69d40886cd58d169bac03dcff1eb7337ad6a909788da0370836065fa51b9da
-  data.tar.gz: 53a7a833e0725f4f9597dc05afa7213a67790b5c77d0f76bacbbda403a82464dc4a187fc8265999db6dd4e47e4f05deb257370c97734a0356f81ebcf451bb67b
+  metadata.gz: 20e8f1c420a38574a3ab77b262cb7935afa64ec0db1ada92de14552adb5f845c330e2ddeb92a267c9037f682be0cc7ee170b78e40949a371011aeaa1644a194b
+  data.tar.gz: 296b6b3b2f14aeb52a96e7c9458d1a84180764118ae94de38ab041d70ea7428088195a49d7b5f7e0daab1946d50cf8269d5faf4f24dcf50b1db79b2134efa1df

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lino (2.0.0.pre.1)
+    lino (2.2.0.pre.4)
       hamster (~> 3.0)
       open4 (~> 1.3)
 

data/README.md

@@ -62,6 +62,30 @@ Lino::CommandLineBuilder.for_command('gpg')
 
 # => gpg --recipient tobyclemson@gmail.com --sign ./doc.txt
 
+# ... or alternatively
+Lino::CommandLineBuilder.for_command('gpg')
+    .with_options({
+      '--recipient' => 'tobyclemson@gmail.com',
+      '--sign' => './doc.txt'
+    })
+    .build
+    .to_s
+
+# => gpg --recipient tobyclemson@gmail.com --sign ./doc.txt
+
+# ... or alternatively
+Lino::CommandLineBuilder.for_command('gpg')
+    .with_options(
+      [
+        { option: '--recipient', value: 'tobyclemson@gmail.com' },
+        { option: '--sign', value: './doc.txt' }
+      ]
+    )
+    .build
+    .to_s
+
+# => gpg --recipient tobyclemson@gmail.com --sign ./doc.txt
+
 # commands with an option repeated multiple times
 Lino::CommandLineBuilder.for_command('example.sh')
     .with_repeated_option('--opt', ['file1.txt', nil, '', 'file2.txt'])
@@ -79,7 +103,7 @@ Lino::CommandLineBuilder.for_command('diff')
 
 # => diff ./file1.txt ./file2.txt
 
-# commands with an array of arguments
+# ... or alternatively
 Lino::CommandLineBuilder.for_command('diff')
     .with_arguments(['./file1.txt', nil, '', './file2.txt'])
     .build
@@ -142,6 +166,39 @@ Lino::CommandLineBuilder.for_command('node')
     .to_s
     
 # => PORT=3030 LOG_LEVEL=debug node ./server.js
+
+# note: by default, options are placed after the command, before all subcommands
+#       and arguments
+
+# this can be expressed explicitly
+Lino::CommandLineBuilder.for_command('gcloud')
+    .with_options_after_command
+    .with_option('--password', 'super-secure')
+    .with_subcommands(%w[sql instances set-root-password some-database])
+    .build
+    .to_s
+
+# => gcloud --password super-secure sql instances set-root-password some-database
+
+# options can also come after subcommands
+Lino::CommandLineBuilder.for_command('gcloud')
+    .with_options_after_subcommands
+    .with_option('--password', 'super-secure')
+    .with_subcommands(%w[sql instances set-root-password some-database])
+    .build
+    .to_s
+
+# => gcloud sql instances set-root-password some-database --password super-secure
+
+# options can also come after arguments, although usages of this are rare
+Lino::CommandLineBuilder.for_command('ls')
+    .with_options_after_arguments
+    .with_flag('-l')
+    .with_argument('/some/directory')
+    .build
+    .to_s
+
+# => ls /some/directory -l
 ```
 
 ### `Lino::CommandLine`

data/Rakefile

@@ -16,6 +16,7 @@ task default: %i[
 
 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))
@@ -96,6 +97,7 @@ RakeGithub.define_repository_tasks(
 end
 
 namespace :pipeline do
+  desc 'Prepare CircleCI Pipeline'
   task prepare: %i[
     circle_ci:project:follow
     circle_ci:env_vars:ensure

data/lib/lino/command_line_builder.rb

@@ -9,6 +9,15 @@ require_relative 'options'
 module Lino
   # rubocop:disable Metrics/ClassLength
   class CommandLineBuilder
+    SELECTORS = {
+      after_command:
+        %i[environment_variables command options subcommands arguments],
+      after_subcommands:
+        %i[environment_variables command subcommands options arguments],
+      after_arguments:
+        %i[environment_variables command subcommands arguments options]
+    }.freeze
+
     include Lino::Utilities
     include Lino::Options
 
@@ -26,7 +35,8 @@ module Lino
       arguments: [],
       environment_variables: [],
       option_separator: ' ',
-      option_quoting: nil
+      option_quoting: nil,
+      option_placement: :after_command
     )
       @command = command
       @subcommands = Hamster::Vector.new(subcommands)
@@ -35,6 +45,7 @@ module Lino
       @environment_variables = Hamster::Vector.new(environment_variables)
       @option_separator = option_separator
       @option_quoting = option_quoting
+      @option_placement = option_placement
     end
     # rubocop:enable Metrics/ParameterLists
 
@@ -65,6 +76,18 @@ module Lino
       with(option_quoting: character)
     end
 
+    def with_options_after_command
+      with(option_placement: :after_command)
+    end
+
+    def with_options_after_subcommands
+      with(option_placement: :after_subcommands)
+    end
+
+    def with_options_after_arguments
+      with(option_placement: :after_arguments)
+    end
+
     def with_argument(argument)
       return self if missing?(argument)
 
@@ -72,6 +95,8 @@ module Lino
     end
 
     def with_arguments(arguments)
+      return self if missing?(arguments)
+
       arguments.inject(self) { |s, argument| s.with_argument(argument) }
     end
 
@@ -87,21 +112,27 @@ module Lino
     end
 
     def build
-      components = [
-        formatted_environment_variables,
-        @command,
-        formatted_options,
-        formatted_subcommands,
-        formatted_arguments
-      ]
-
-      command_string = components.reject(&:empty?).join(' ')
+      components = formatted_components
+      command_line = SELECTORS[@option_placement]
+                     .inject([]) { |c, key| c << components[key] }
+                     .reject(&:empty?)
+                     .join(' ')
 
-      CommandLine.new(command_string)
+      CommandLine.new(command_line)
     end
 
     private
 
+    def formatted_components
+      {
+        environment_variables: formatted_environment_variables,
+        command: @command,
+        options: formatted_options,
+        subcommands: formatted_subcommands,
+        arguments: formatted_arguments
+      }
+    end
+
     def formatted_environment_variables
       map_and_join(@environment_variables) do |var|
         "#{var[0]}=\"#{var[1].to_s.gsub(/"/, '\\"')}\""
@@ -140,7 +171,8 @@ module Lino
         arguments: @arguments,
         environment_variables: @environment_variables,
         option_separator: @option_separator,
-        option_quoting: @option_quoting
+        option_quoting: @option_quoting,
+        option_placement: @option_placement
       }
     end
   end

data/lib/lino/options.rb

@@ -14,6 +14,19 @@ module Lino
       ))
     end
 
+    def with_options(options)
+      return self if missing?(options)
+
+      options.entries.inject(self) do |s, entry|
+        s.with_option(
+          entry.include?(:option) ? entry[:option] : entry[0],
+          entry.include?(:value) ? entry[:value] : entry[1],
+          separator: (entry.include?(:separator) ? entry[:separator] : nil),
+          quoting: (entry.include?(:quoting) ? entry[:quoting] : nil)
+        )
+      end
+    end
+
     def with_repeated_option(option, values, separator: nil, quoting: nil)
       values.inject(self) do |s, value|
         s.with_option(option, value, separator: separator, quoting: quoting)
@@ -21,7 +34,15 @@ module Lino
     end
 
     def with_flag(flag)
+      return self if missing?(flag)
+
       with(options: @options.add({ components: [flag] }))
     end
+
+    def with_flags(flags)
+      return self if missing?(flags)
+
+      flags.inject(self) { |s, flag| s.with_flag(flag) }
+    end
   end
 end

data/lib/lino/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lino
-  VERSION = '2.0.0.pre.1'
+  VERSION = '2.2.0.pre.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lino
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.1
+  version: 2.2.0.pre.4
 platform: ruby
 authors:
 - Toby Clemson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-04 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hamster