lino 1.10.0.pre.2 → 2.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6ad4b0f5639831eb11ab6878d387be88e20c910e4d9c74101f7db6541086e31
-  data.tar.gz: 79e65ded113a76a7a2d8c44c39ef171f890561004a61ffac43f4f918348e8349
+  metadata.gz: b1ed8a59b3a9171234c636171f9b7304637067db63ff130c04c14a780418f28c
+  data.tar.gz: 927e637996bab9611c2233e92b1ab5b0869a5de36847dce88086880fd1022d71
 SHA512:
-  metadata.gz: bc12bc01a910dddbc53d71650d01ed78caaf7372b4e864c6419ed7cf64bc68f87df3dea55970581dbe86055c9feb10e6b1ef7d0e571e3d2eab32b0f8b712ca7f
-  data.tar.gz: 5f4d632f1a87320d55ef9ccd318d71e8c189faf1121dac84f9746502650922a5c20c714ff5a5a4711cb4b797fbbf70134a3f1c1fc027f8f9d760069a8b3d363f
+  metadata.gz: 357901083b289bbf18a2c3f7425ae01967d950c0329b6c793dd214fe2b265bea8f69d40886cd58d169bac03dcff1eb7337ad6a909788da0370836065fa51b9da
+  data.tar.gz: 53a7a833e0725f4f9597dc05afa7213a67790b5c77d0f76bacbbda403a82464dc4a187fc8265999db6dd4e47e4f05deb257370c97734a0356f81ebcf451bb67b

data/Gemfile.lock

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

data/README.md

@@ -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')
@@ -183,10 +195,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,13 @@ 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
     include Lino::Utilities
-    include Lino::Switches
+    include Lino::Options
 
     class << self
       def for_command(command)
@@ -22,7 +22,7 @@ module Lino
     def initialize(
       command: nil,
       subcommands: [],
-      switches: [],
+      options: [],
       arguments: [],
       environment_variables: [],
       option_separator: ' ',
@@ -30,7 +30,7 @@ module Lino
     )
       @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
@@ -48,6 +48,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
@@ -57,12 +66,13 @@ module Lino
     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({})
+      arguments.inject(self) { |s, argument| s.with_argument(argument) }
     end
 
     def with_environment_variable(environment_variable, value)
@@ -80,7 +90,7 @@ module Lino
       components = [
         formatted_environment_variables,
         @command,
-        formatted_switches,
+        formatted_options,
         formatted_subcommands,
         formatted_arguments
       ]
@@ -98,9 +108,9 @@ module Lino
       end
     end
 
-    def formatted_switches
+    def formatted_options
       map_and_join(
-        @switches,
+        @options,
         &(quote_with(@option_quoting) >> join_with(@option_separator))
       )
     end
@@ -112,7 +122,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 +136,13 @@ module Lino
       {
         command: @command,
         subcommands: @subcommands,
-        switches: @switches,
+        options: @options,
         arguments: @arguments,
         environment_variables: @environment_variables,
         option_separator: @option_separator,
         option_quoting: @option_quoting
       }
     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,27 @@
+# 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)
+      with(options: @options.add({ components: [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.2'
+  VERSION = '2.0.0.pre.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lino
 version: !ruby/object:Gem::Version
-  version: 1.10.0.pre.2
+  version: 2.0.0.pre.1
 platform: ruby
 authors:
 - Toby Clemson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-04-04 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