lino 2.5.0 → 3.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9abe77247b0e441d73bb60678b26fca6e7ea020a95d2e50996243bfeaf7105b3
-  data.tar.gz: 7f92a36e4804f0ed8388813881d399ca3dd852b3b2091575ee6b4ebbd34b3ae5
+  metadata.gz: 814ba4c3b5790b29c0bed0ea964441d6f382b7bd6430ae69c5d45871a38065b7
+  data.tar.gz: 815e2d108e1d79f02ce5d0b6e315193d753322f097de7da6cc65d21a84ca63ef
 SHA512:
-  metadata.gz: e7a6eeec352e08b48c1134b9e33273268475ecc14a1bfa466f235f7034d5f59348e4739fed6bda0629faeae799bd09b2cce7a955b15cb9dc0bfdeff728ef8d58
-  data.tar.gz: 1618d41e38eda052a9f87f1c4cd190a74de598f53ad1c1d0df0a8861d886401bce8f4dce637822b92b9398c2b31e4eebe88bdd711a07e3dc24de4bb4400812d5
+  metadata.gz: ae965325ec2dc8fb05611c498da286b816997de2ab0e7730d4b9a8507150308e3aacd43c71880251c98aa3c31b00215e186a9b11a34a45ee1042a857f4f65925
+  data.tar.gz: db20e12bb7e81337519ad34d07342e9136993b364ffe4d14063eec04d145e085c034e1b607cdb622dc3d469e05402aba97cb88690d8b92c06cf26abb417f5521

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    lino (2.5.0)
+    lino (3.0.0.pre.1)
       hamster (~> 3.0)
       open4 (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.0)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -18,28 +18,32 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     colored2 (3.1.2)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    docile (1.3.4)
-    excon (0.78.1)
-    faraday (1.3.0)
+    docile (1.3.5)
+    excon (0.81.0)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    faraday-net_http (1.0.0)
-    gem-release (2.2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    gem-release (2.2.1)
     hamster (3.0.0)
       concurrent-ruby (~> 1.0)
-    i18n (1.8.6)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.2)
+    minitest (5.14.4)
     multipart-post (2.1.1)
-    octokit (4.20.0)
+    octokit (4.21.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.0.0)
@@ -49,23 +53,23 @@ GEM
       excon (~> 0.72)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
-    rake_factory (0.27.0)
+    rake_factory (0.29.0)
       activesupport (>= 4)
       rake (~> 13.0)
-    rake_github (0.5.0)
+    rake_github (0.7.0)
       colored2 (~> 3.1)
       octokit (~> 4.16)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
-    rake_gpg (0.12.0)
+    rake_gpg (0.14.0)
       rake_factory (>= 0.23, < 1)
       ruby_gpg2 (>= 0.6, < 1)
-    rake_ssh (0.4.0)
+    rake_ssh (0.6.0)
       colored2 (~> 3.1)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -75,11 +79,11 @@ GEM
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.12.0)
+    rspec-support (3.10.2)
+    rubocop (1.13.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -92,17 +96,17 @@ GEM
       parser (>= 2.7.1.5)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (2.2.0)
+    rubocop-rspec (2.3.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.2)
-    ruby_gpg2 (0.6.0)
+    ruby2_keywords (0.0.4)
+    ruby_gpg2 (0.8.0)
       lino (>= 1.5)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
-    simplecov (0.20.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
@@ -133,4 +137,4 @@ DEPENDENCIES
   simplecov (~> 0.16)
 
 BUNDLED WITH
-   2.2.16
+   2.2.17

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/appliables.rb

@@ -7,13 +7,13 @@ module Lino
     include Lino::Utilities
 
     def with_appliable(appliable)
-      return self if missing?(appliable)
+      return self if nil?(appliable)
 
       appliable.apply(self)
     end
 
     def with_appliables(appliables)
-      return self if missing?(appliables)
+      return self if nil_or_empty?(appliables)
 
       appliables.inject(self) do |s, appliable|
         s.with_appliable(appliable)

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,10 +40,11 @@ module Lino
       @option_quoting = option_quoting
       @option_placement = option_placement
     end
+
     # rubocop:enable Metrics/ParameterLists
 
     def with_subcommand(subcommand, &block)
-      return self if missing?(subcommand)
+      return self if nil?(subcommand)
 
       with(
         subcommands: @subcommands.add(
@@ -64,7 +56,7 @@ module Lino
     end
 
     def with_subcommands(subcommands, &block)
-      return self if missing?(subcommands)
+      return self if nil_or_empty?(subcommands)
 
       without_block = subcommands[0...-1]
       with_block = subcommands.last
@@ -82,26 +74,30 @@ 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)
-      return self if missing?(argument)
+      return self if nil?(argument)
 
       with(arguments: @arguments.add({ components: [argument] }))
     end
 
     def with_arguments(arguments)
-      return self if missing?(arguments)
+      return self if nil_or_empty?(arguments)
 
       arguments.inject(self) { |s, argument| s.with_argument(argument) }
     end
@@ -118,7 +114,7 @@ module Lino
     end
 
     def with_environment_variables(environment_variables)
-      return self if missing?(environment_variables)
+      return self if nil_or_empty?(environment_variables)
 
       environment_variables.entries.inject(self) do |s, var|
         s.with_environment_variable(
@@ -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,45 +6,65 @@ module Lino
   module Options
     include Lino::Utilities
 
-    def with_option(option, value, separator: nil, quoting: nil)
-      return self if missing?(value)
+    def with_option(
+      option,
+      value,
+      separator: nil,
+      quoting: nil,
+      placement: nil
+    )
+      return self if nil?(value)
 
       with(options: @options.add(
         {
           components: [option, value],
           separator: separator,
-          quoting: quoting
+          quoting: quoting,
+          placement: placement
         }
       ))
     end
 
     def with_options(options)
-      return self if missing?(options)
+      return self if nil_or_empty?(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)
+          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
 
     def with_flag(flag)
-      return self if missing?(flag)
+      return self if nil?(flag)
 
       with(options: @options.add({ components: [flag] }))
     end
 
     def with_flags(flags)
-      return self if missing?(flags)
+      return self if nil_or_empty?(flags)
 
       flags.inject(self) { |s, flag| s.with_flag(flag) }
     end

data/lib/lino/utilities.rb

@@ -22,8 +22,16 @@ module Lino
       end
     end
 
-    def missing?(value)
-      value.nil? || (value.respond_to?(:empty?) && value.empty?)
+    def nil?(value)
+      value.nil?
+    end
+
+    def empty?(value)
+      value.respond_to?(:empty?) && value.empty?
+    end
+
+    def nil_or_empty?(value)
+      nil?(value) || empty?(value)
     end
 
     private
@@ -41,5 +49,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.5.0'
+  VERSION = '3.0.0.pre.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lino
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.0.pre.1
 platform: ruby
 authors:
 - Toby Clemson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hamster
@@ -244,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: