lino 2.1.0 → 2.2.0.pre.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e889c057a237dfb1af77b0adbb0f661ef0cf37193341a6bddd8add27a64f12eb
-  data.tar.gz: 121d2e75f308626b29b1ac306f959583bd6cc9b18df0fb57b15d993f90f08dd5
+  metadata.gz: 729c96dd84a7a44337298eb3de557d061565d5f4defc5bd2077431e20f0917cc
+  data.tar.gz: 03c7697d78175ad6e2135540d2babeee039a9cdfd77cbcd789137db66561aa80
 SHA512:
-  metadata.gz: 9f1319025180174dbce34687d0cbad930551e2ffad455da8b86ac31f47ba874aef4d012d3f4db23e1dd9de07f15e44a732bf4b937cd95cc1f559b18564fcea4d
-  data.tar.gz: 8a57fca71f15442bbef99be911bc6284f4e2f87c22425bdf996c09fb8c30429116c2bf3b27d6dca8f91e679f7240b9d1251048273f92c04ddb80c41de2c04b8e
+  metadata.gz: 95af24c97c8d11bdbcdd44be3f78a72e0474fa8665f3bf3b67546caf34f6e93c7ba971b94df2efc8ae9a9b6f3e831a17c1dd04e07416fd54d48d9dd5ffed12e3
+  data.tar.gz: 151036608c99015ea9494e6ec17b21cb0055e6616d34669ca54009fe7b033b72de5323a240972763d512395ed3374a4d2134865f9ff89db535b5f5ca5bd9ae01

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lino (2.1.0)
+    lino (2.2.0.pre.5)
       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/appliables.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'utilities'
+
+module Lino
+  module Appliables
+    include Lino::Utilities
+
+    def with_appliable(appliable)
+      return self if missing?(appliable)
+
+      appliable.apply(self)
+    end
+
+    def with_appliables(appliables)
+      return self if missing?(appliables)
+
+      appliables.inject(self) do |s, appliable|
+        s.with_appliable(appliable)
+      end
+    end
+  end
+end

data/lib/lino/command_line_builder.rb

@@ -5,12 +5,23 @@ require_relative 'utilities'
 require_relative 'command_line'
 require_relative 'subcommand_builder'
 require_relative 'options'
+require_relative 'appliables'
 
 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
+    include Lino::Appliables
 
     class << self
       def for_command(command)
@@ -26,7 +37,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 +47,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 +78,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 +97,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 +114,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 +173,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

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require_relative 'utilities'
+
 module Lino
   module Options
+    include Lino::Utilities
+
     def with_option(option, value, separator: nil, quoting: nil)
       return self if missing?(value)
 
@@ -14,6 +18,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 +38,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/subcommand_builder.rb

@@ -3,11 +3,13 @@
 require 'hamster'
 require_relative 'utilities'
 require_relative 'options'
+require_relative 'appliables'
 
 module Lino
   class SubcommandBuilder
     include Lino::Utilities
     include Lino::Options
+    include Lino::Appliables
 
     class <<self
       def for_subcommand(subcommand)

data/lib/lino/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lino
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0.pre.5
 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
@@ -222,6 +222,7 @@ files:
 - bin/console
 - bin/setup
 - lib/lino.rb
+- lib/lino/appliables.rb
 - lib/lino/command_line.rb
 - lib/lino/command_line_builder.rb
 - lib/lino/options.rb
@@ -243,9 +244,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: