lino 1.10.0.pre.1 → 2.2.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b2d97cd89debbd53f7eae071f39fd98568652e7771957c1e6584ca3756edc76
-  data.tar.gz: d1e6e64522855b0b0ac7dab0f7d309d4bf79a894bac43690fa965dbc94e4ce02
+  metadata.gz: 2d3239ef901d72bbd89e5598f649ee2625db692423799f43ca6f19d5a2c5adc3
+  data.tar.gz: 0af4ae160b6537f103ee8c3e44be99dc340e0a6f197fc4c24e0abb4400caeaac
 SHA512:
-  metadata.gz: 85f9539da48b728c57ff7725650d5a6fb16c41e401b6313a7bc6dfcfa91747617c21f8732e6b516d4b8f3dd28c21fa96a478b6977b431214d03e335dee3e49b0
-  data.tar.gz: 73ec86a9cfbabc102ee71d83c954541724eaf7454731568e9c00d7f50691e0726a39332a696a3df49f05feedfae72281ed1d79ead14929f88a60c4207b5ba26d
+  metadata.gz: c32a2ca3976575b417d6c2aa2f90c187aca4b1de97cddc668a3da9e2e3f01a8b8e5a67d1c2333aa37f108cac3823682e40a11dbbb7a07e558a2c04ce86bdaec7
+  data.tar.gz: 1158933758b878a110f6d956d24484e65a3cd3271c98e39c6f32754f0af2b92beb1d3e2a02950e0b3e604a7db4211960f52c0cb960aa17109b417174db139a10

data/Gemfile.lock

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

data/README.md

@@ -79,7 +79,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
@@ -120,6 +120,18 @@ Lino::CommandLineBuilder.for_command('gcloud')
     .to_s
     
 # => gcloud sql instances set-root-password some-database --password super-secure
+
+# ... or alternatively
+Lino::CommandLineBuilder.for_command('gcloud')
+    .with_subcommands(
+      %w[sql instances set-root-password some-database]
+    ) do |sub|
+      sub.with_option('--password', 'super-secure')
+    end
+    .build
+    .to_s
+    
+# => gcloud sql instances set-root-password some-database --password super-secure
   
 # commands controlled by environment variables
 Lino::CommandLineBuilder.for_command('node')
@@ -130,6 +142,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`
@@ -183,10 +228,25 @@ To install dependencies and run the build, run the pre-commit build:
 ./go
 ```
 
-To run only the specs:
+This runs all unit tests and other checks including coverage and code linting / 
+formatting.
+
+To run only the unit tests, including coverage:
+
+```shell script
+./go test:unit
+```
+
+To attempt to fix any code linting / formatting issues:
+
+```shell script
+./go library:fix
+```
+
+To check for code linting / formatting issues without fixing:
 
 ```shell script
-./go spec
+./go library:check
 ```
 
 You can also run `bin/console` for an interactive prompt that will allow you to 

data/lib/lino/command_line_builder.rb

@@ -4,13 +4,22 @@ require 'hamster'
 require_relative 'utilities'
 require_relative 'command_line'
 require_relative 'subcommand_builder'
-require_relative 'switches'
+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::Switches
+    include Lino::Options
 
     class << self
       def for_command(command)
@@ -22,19 +31,21 @@ module Lino
     def initialize(
       command: nil,
       subcommands: [],
-      switches: [],
+      options: [],
       arguments: [],
       environment_variables: [],
       option_separator: ' ',
-      option_quoting: nil
+      option_quoting: nil,
+      option_placement: :after_command
     )
       @command = command
       @subcommands = Hamster::Vector.new(subcommands)
-      @switches = Hamster::Vector.new(switches)
+      @options = Hamster::Vector.new(options)
       @arguments = Hamster::Vector.new(arguments)
       @environment_variables = Hamster::Vector.new(environment_variables)
       @option_separator = option_separator
       @option_quoting = option_quoting
+      @option_placement = option_placement
     end
     # rubocop:enable Metrics/ParameterLists
 
@@ -48,6 +59,15 @@ module Lino
       )
     end
 
+    def with_subcommands(subcommands, &block)
+      without_block = subcommands[0...-1]
+      with_block = subcommands.last
+
+      without_block
+        .inject(self) { |s, sc| s.with_subcommand(sc) }
+        .with_subcommand(with_block, &block)
+    end
+
     def with_option_separator(option_separator)
       with(option_separator: option_separator)
     end
@@ -56,13 +76,28 @@ 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)
-      with(arguments: add_argument(argument))
+      return self if missing?(argument)
+
+      with(arguments: @arguments.add({ components: [argument] }))
     end
 
     def with_arguments(arguments)
-      arguments.each { |argument| add_argument(argument) }
-      with({})
+      return self if missing?(arguments)
+
+      arguments.inject(self) { |s, argument| s.with_argument(argument) }
     end
 
     def with_environment_variable(environment_variable, value)
@@ -77,30 +112,36 @@ module Lino
     end
 
     def build
-      components = [
-        formatted_environment_variables,
-        @command,
-        formatted_switches,
-        formatted_subcommands,
-        formatted_arguments
-      ]
+      components = formatted_components
+      command_line = SELECTORS[@option_placement]
+                     .inject([]) { |c, key| c << components[key] }
+                     .reject(&:empty?)
+                     .join(' ')
 
-      command_string = components.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(/"/, '\\"')}\""
       end
     end
 
-    def formatted_switches
+    def formatted_options
       map_and_join(
-        @switches,
+        @options,
         &(quote_with(@option_quoting) >> join_with(@option_separator))
       )
     end
@@ -112,7 +153,10 @@ module Lino
     end
 
     def formatted_arguments
-      map_and_join(@arguments, &join_with(' '))
+      map_and_join(
+        @arguments,
+        &join_with(' ')
+      )
     end
 
     def with(**replacements)
@@ -123,19 +167,14 @@ module Lino
       {
         command: @command,
         subcommands: @subcommands,
-        switches: @switches,
+        options: @options,
         arguments: @arguments,
         environment_variables: @environment_variables,
         option_separator: @option_separator,
-        option_quoting: @option_quoting
+        option_quoting: @option_quoting,
+        option_placement: @option_placement
       }
     end
-
-    def add_argument(argument)
-      return @arguments if missing?(argument)
-
-      @arguments = @arguments.add({ components: [argument] })
-    end
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/lino/options.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Lino
+  module Options
+    def with_option(option, value, separator: nil, quoting: nil)
+      return self if missing?(value)
+
+      with(options: @options.add(
+        {
+          components: [option, value],
+          separator: separator,
+          quoting: quoting
+        }
+      ))
+    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)
+      end
+    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

@@ -2,12 +2,12 @@
 
 require 'hamster'
 require_relative 'utilities'
-require_relative 'switches'
+require_relative 'options'
 
 module Lino
   class SubcommandBuilder
     include Lino::Utilities
-    include Lino::Switches
+    include Lino::Options
 
     class <<self
       def for_subcommand(subcommand)
@@ -15,16 +15,16 @@ module Lino
       end
     end
 
-    def initialize(subcommand: nil, switches: [])
+    def initialize(subcommand: nil, options: [])
       @subcommand = subcommand
-      @switches = Hamster::Vector.new(switches)
+      @options = Hamster::Vector.new(options)
     end
 
     def build(option_separator, option_quoting)
       components = [
         @subcommand,
         map_and_join(
-          @switches,
+          @options,
           &(quote_with(option_quoting) >> join_with(option_separator))
         )
       ]
@@ -40,7 +40,7 @@ module Lino
     def state
       {
         subcommand: @subcommand,
-        switches: @switches
+        options: @options
       }
     end
   end

data/lib/lino/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lino
 version: !ruby/object:Gem::Version
-  version: 1.10.0.pre.1
+  version: 2.2.0.pre.2
 platform: ruby
 authors:
 - Toby Clemson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hamster
@@ -224,8 +224,8 @@ files:
 - lib/lino.rb
 - lib/lino/command_line.rb
 - lib/lino/command_line_builder.rb
+- lib/lino/options.rb
 - lib/lino/subcommand_builder.rb
-- lib/lino/switches.rb
 - lib/lino/utilities.rb
 - lib/lino/version.rb
 homepage: https://github.com/infrablocks/lino

data/lib/lino/switches.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Lino
-  module Switches
-    def with_option(switch, value, separator: nil, quoting: nil)
-      with(switches: add_option(switch, value, separator, quoting))
-    end
-
-    def with_repeated_option(switch, values, separator: nil, quoting: nil)
-      values.each do |value|
-        add_option(switch, value, separator, quoting)
-      end
-      with({})
-    end
-
-    def with_flag(flag)
-      with(switches: @switches.add({ components: [flag] }))
-    end
-
-    private
-
-    def add_option(switch, value, separator, quoting)
-      return @switches if missing?(value)
-
-      @switches = @switches.add(
-        {
-          components: [switch, value],
-          separator: separator,
-          quoting: quoting
-        }
-      )
-    end
-  end
-end