lino 2.6.0.pre.1 → 2.6.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cdb146f45a3d5a9f7077a61c38653dfed04f3e66620413a45d3a144d1e63b66
-  data.tar.gz: 021f79a56a5d468ef2e45fbfb2368b33d5a3161de4c3b982133f9bc74b9bf2af
+  metadata.gz: c4c737157f6552423f6fbb2a5b4263e4f2a76b543d6f7ea15408988caeca61ff
+  data.tar.gz: 20257769cf4a2807dc6a826e1e22ca5b52ecb1c650f8ed69662f787c013c2b64
 SHA512:
-  metadata.gz: 8e10b2bba92eb41347729fa3657e9c65c8a7c9a4534a4d1c98fb3bf0529eb331d75a57b20928a946854d1a6e2ffdca043105c0df712e4779d156c553545182be
-  data.tar.gz: 311f50b183a778d13ca8eaeae22c9a5de60d94b26ca0a521e28445653044c9d2f2ca3d412b07ed783be7534baa35a827772864bd84c1519f8cef85acf6deab4c
+  metadata.gz: 58d4387c603f527dec478c0ee57ded0af915da0111042ea8a16d10d54050755322ee1f6849fd3b427b783feb4116f6c75fe2ab56c38bcef21d782ed650b99db5
+  data.tar.gz: 11d9561cb8c69833c035da08e04c5afb78ac54a90db6c1c2b1c59c752ebb199b0eb89d613d7ecdb60bb7c70b9d8afcffee3b7b3bfa7d024c3806da58dd89ac71

data/Gemfile.lock

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

data/README.md

@@ -379,6 +379,33 @@ Lino::CommandLineBuilder.for_command('ls')
 # => ls /some/directory -l
 ```
 
+The option placement can be overridden on an option by option basis:
+
+```ruby
+Lino::CommandLineBuilder.for_command('gcloud')
+    .with_options_after_subcommands
+    .with_option('--log-level', 'debug', placement: :after_command)
+    .with_option('--password', 'super-secure')
+    .with_subcommands(%w[sql instances set-root-password])
+    .build
+    .to_s
+
+# => gcloud --log-level debug sql instances set-root-password \ 
+#      --password super-secure
+```
+
+The `:placement` keyword argument accepts placement values of `:after_command`,
+`:after_subcommands` and `:after_arguments`.
+
+> Note: `#with_options` supports placement overriding when the options are
+>       passed as an array of hashes and a `placement` key is included in the
+>       hash.
+
+> Note: `#with_repeated_option` also supports the `placement` named parameter.
+
+> Note: option specific placement take precedence over the global option
+>       placement
+
 #### Appliables
 
 Command and subcommand builders both support passing 'appliables' that are

data/lib/lino/command_line_builder.rb

@@ -10,15 +10,6 @@ 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
@@ -49,6 +40,7 @@ module Lino
       @option_quoting = option_quoting
       @option_placement = option_placement
     end
+
     # rubocop:enable Metrics/ParameterLists
 
     def with_subcommand(subcommand, &block)
@@ -82,16 +74,20 @@ module Lino
       with(option_quoting: character)
     end
 
+    def with_option_placement(option_placement)
+      with(option_placement: option_placement)
+    end
+
     def with_options_after_command
-      with(option_placement: :after_command)
+      with_option_placement(:after_command)
     end
 
     def with_options_after_subcommands
-      with(option_placement: :after_subcommands)
+      with_option_placement(:after_subcommands)
     end
 
     def with_options_after_arguments
-      with(option_placement: :after_arguments)
+      with_option_placement(:after_arguments)
     end
 
     def with_argument(argument)
@@ -130,16 +126,29 @@ module Lino
 
     def build
       components = formatted_components
-      command_line = SELECTORS[@option_placement]
-                     .inject([]) { |c, key| c << components[key] }
-                     .reject(&:empty?)
-                     .join(' ')
+      command_line =
+        component_paths
+        .collect { |path| path.inject(components) { |c, p| c && c[p] } }
+        .reject(&:empty?)
+        .join(' ')
 
       CommandLine.new(command_line)
     end
 
     private
 
+    def component_paths
+      [
+        %i[environment_variables],
+        %i[command],
+        %i[options after_command],
+        %i[subcommands],
+        %i[options after_subcommands],
+        %i[arguments],
+        %i[options after_arguments]
+      ]
+    end
+
     def formatted_components
       {
         environment_variables: formatted_environment_variables,
@@ -156,13 +165,24 @@ module Lino
       end
     end
 
-    def formatted_options
+    def formatted_options_with_placement(placement)
       map_and_join(
-        @options,
+        options_with_placement(placement),
         &(quote_with(@option_quoting) >> join_with(@option_separator))
       )
     end
 
+    def formatted_options
+      %i[
+        after_command
+        after_subcommands
+        after_arguments
+      ].inject({}) do |options, placement|
+        options
+          .merge({ placement => formatted_options_with_placement(placement) })
+      end
+    end
+
     def formatted_subcommands
       map_and_join(@subcommands) do |sub|
         sub.build(@option_separator, @option_quoting)
@@ -176,6 +196,13 @@ module Lino
       )
     end
 
+    def options_with_placement(placement)
+      @options.select { |o| o[:placement] == placement } +
+        if @option_placement == placement
+          @options.select { |o| o[:placement].nil? }
+        end
+    end
+
     def with(**replacements)
       CommandLineBuilder.new(**state.merge(replacements))
     end
@@ -193,5 +220,6 @@ module Lino
       }
     end
   end
+
   # rubocop:enable Metrics/ClassLength
 end

data/lib/lino/options.rb

@@ -6,14 +6,21 @@ module Lino
   module Options
     include Lino::Utilities
 
-    def with_option(option, value, separator: nil, quoting: nil)
+    def with_option(
+      option,
+      value,
+      separator: nil,
+      quoting: nil,
+      placement: nil
+    )
       return self if missing?(value)
 
       with(options: @options.add(
         {
           components: [option, value],
           separator: separator,
-          quoting: quoting
+          quoting: quoting,
+          placement: placement
         }
       ))
     end
@@ -23,17 +30,30 @@ module Lino
 
       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)
+          or_nth(entry, :option, 0),
+          or_nth(entry, :value, 1),
+          separator: or_nil(entry, :separator),
+          quoting: or_nil(entry, :quoting),
+          placement: or_nil(entry, :placement)
         )
       end
     end
 
-    def with_repeated_option(option, values, separator: nil, quoting: nil)
+    def with_repeated_option(
+      option,
+      values,
+      separator: nil,
+      quoting: nil,
+      placement: nil
+    )
       values.inject(self) do |s, value|
-        s.with_option(option, value, separator: separator, quoting: quoting)
+        s.with_option(
+          option,
+          value,
+          separator: separator,
+          quoting: quoting,
+          placement: placement
+        )
       end
     end
 

data/lib/lino/utilities.rb

@@ -41,5 +41,13 @@ module Lino
         components
       end
     end
+
+    def or_nil(enumerable, key)
+      enumerable.include?(key) ? enumerable[key] : nil
+    end
+
+    def or_nth(enumerable, key, index)
+      enumerable.include?(key) ? enumerable[key] : enumerable[index]
+    end
   end
 end

data/lib/lino/version.rb

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

metadata

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