foobara-sh-cli-connector 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66e8c8336729e6c840ee38fec2f6b8d96237f078e1974c0fc2a38193307a1d29
-  data.tar.gz: d2a0652b6e70a782d46dc49dc5843cb30881465471db652d3f9a0f08be98139e
+  metadata.gz: 2f22467bcc6729b5fe45c66f49dee0083f2cf4a3533b37b9bf1dc564a343f095
+  data.tar.gz: 9d4ecbbe05569aa8dd40602dbd1a5d160042e6261637b64a040c3df07634fabb
 SHA512:
-  metadata.gz: 22f34b1310e54975cc3839e27bf3993ca51f49248a2cff8d204ad410348bd1b668de63fedfdc7c443a7b4c36374fdb96e335a8416a88737289a95060c389afef
-  data.tar.gz: 7bad46487ed10907757345ba223a236724d0a073937d04b2831ecb3d7185d9b449f3fe761ac8b3b75e6b657fe70af81f64e564afdf397146d5888254258c5c55
+  metadata.gz: 135ef5e0da0f1014d053f770b207e9c3232814dd2c5a2de17dee23596ac1be9cd0cda36fa3919d6f540c399e45fac3bd4c247a0ed0cb4b14d89e8ee076f56148
+  data.tar.gz: 9dea6d6ede72f50e6477ef1ced1dbdbe48ee42d75935ff1eb48659bc2c73bd67635f249cf97ff0a72198d2b60904b7f56ef46e35de5dfdea7247e18038bfadb3

data/README.md

@@ -1,48 +1,122 @@
 # Foobara::ShCliConnector
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library
-into a gem. Put your Ruby code in the file `lib/foobara/sh_cli_connector`. To experiment with that code,
-run `bin/console` for an interactive prompt.
+A command connector for Foobara that exposes commands via a shell command-line interface (CLI). This connector parses command-line arguments and routes them to Foobara commands, making it easy to build CLI tools from your Foobara commands.
+
+<!-- TOC -->
+* [Foobara::ShCliConnector](#foobarashcliconnector)
+  * [Installation](#installation)
+  * [Usage](#usage)
+    * [Connecting multiple commands in a CLI script](#connecting-multiple-commands-in-a-cli-script)
+    * [Single Command Mode](#single-command-mode)
+  * [Development](#development)
+  * [Contributing](#contributing)
+    * [Reporting bugs or requesting features](#reporting-bugs-or-requesting-features)
+    * [Contributing code](#contributing-code)
+  * [License](#license)
+<!-- TOC -->
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it
-to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with
-instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Typical stuff: add `gem "foobara-sh-cli-connector"` to your Gemfile or .gemspec file. Or even just
+`gem install foobara-sh-cli-connector` if that's your jam.
 
-Install the gem and add to the application's Gemfile by executing:
+## Usage
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+### Connecting multiple commands in a CLI script
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```ruby
+require "foobara/sh_cli_connector"
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+class Greet < Foobara::Command
+  inputs do
+    who :string, default: "World"
+  end
+  result :string
 
-## Usage
+  def execute
+    build_greeting
 
-TODO: Write usage instructions here
+    greeting
+  end
 
-## Development
+  attr_accessor :greeting
+
+  def build_greeting = self.greeting = "Hello, #{who}!"
+end
+
+connector = Foobara::CommandConnectors::ShCliConnector.new
+connector.connect(Greet)
+connector.run
+```
+
+Then run your CLI script:
+
+```
+$ ./cli_demo.rb
+Usage: cli_demo.rb [GLOBAL_OPTIONS] [ACTION] [COMMAND_OR_TYPE] [COMMAND_INPUTS]
+
+Available actions:
+
+  run, help, describe, manifest
+
+Default action: run
+
+Available commands:
+
+ Greet
+$ ./cli_demo.rb help Greet
+Usage: cli_demo.rb [GLOBAL_OPTIONS] Greet [COMMAND_INPUTS]
 
+Command inputs:
+
+ -w, --who WHO                    Default: World
+
+$ ./cli_demo.rb Greet
+Hello, World!
+$ ./cli_demo.rb Greet -w Fumiko
+Hello, Fumiko!
 ```
-bundle config set local.foobara ../foobara
-bundle config set disable_local_branch_check true
+
+### Single Command Mode
+
+If you want to make a CLI script that only exposes one command, you can use single command mode:
+
+```ruby
+connector = Foobara::CommandConnectors::ShCliConnector.new(single_command_mode: Greet)
+connector.run
 ```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
-also run `bin/console` for an interactive prompt that will allow you to experiment.
+Now you can run this without specifying the command name:
+
+```
+$ ./greet-cli --help
+Usage: greet-cli [INPUTS]
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
-version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
-push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Inputs:
+
+ -w, --who WHO                    Default: World
+$ ./greet-cli --who Barbara
+Hello, Barbara!
+```
+
+## Development
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/foobara-sh_cli_connector.
+I would love help with this and other Foobara gems! Feel free to hit me up at miles@foobara.org if you
+think helping out would be fun or interesting! I have tasks for all experience levels and am often free
+to pair on Foobara stuff.
+
+### Reporting bugs or requesting features
+
+Bug reports and feature requests can be made as github issues at https://github.com/foobara/sh-cli-connector
+
+### Contributing code
+
+You should be able to fork the repo, clone it locally, run `bundle` and then `rake` to run
+the test suite and linter. Make your changes and push them up and open a PR! If you need any help please reach out and we're happy to help!
 
 ## License
 
-This project is licensed under your choice of the Apache-2.0 license or the MIT license.
-See [LICENSE.txt](LICENSE-MIT.txt) for more info about licensing.
+foobara-sh-cli-connector is licensed under your choice of the Apache-2.0 license or the MIT license.
+See [LICENSE.txt](LICENSE.txt) for more info about licensing.

data/src/sh_cli_connector/inputs_parser/option/flag.rb

@@ -53,6 +53,10 @@ module Foobara
             def array?
               false
             end
+
+            def show_default?
+              false
+            end
           end
         end
       end

data/src/sh_cli_connector/inputs_parser/option/off_flag.rb

@@ -11,8 +11,21 @@ module Foobara
             end
 
             def _long_option_name(prefixed_name)
-              "no-#{Util.kebab_case(prefixed_name)}"
+              "skip-#{Util.kebab_case(prefixed_name)}"
             end
+
+            # rubocop:disable Naming/PredicateMethod
+            def cast_value(value)
+              unless value == true
+                # Ruby's Optparser handles --no- but not --skip- prefixes. So we are implementing it ourselves.
+                # :nocov:
+                raise "This shouldn't happen. Please debug this!"
+                # :nocov:
+              end
+
+              false
+            end
+            # rubocop:enable Naming/PredicateMethod
           end
         end
       end

data/src/sh_cli_connector/inputs_parser/option/on_flag.rb

@@ -4,6 +4,17 @@ module Foobara
       class InputsParser
         class Option
           class OnFlag < Flag
+            # rubocop:disable Naming/PredicateMethod
+            def cast_value(value)
+              unless value == true
+                # :nocov:
+                raise "This shouldn't happen. Please debug this!"
+                # :nocov:
+              end
+
+              true
+            end
+            # rubocop:enable Naming/PredicateMethod
           end
         end
       end

data/src/sh_cli_connector/inputs_parser/option.rb

@@ -57,6 +57,14 @@ module Foobara
             # args << attributes_type.declaration_data[:one_of] if attributes_type.declaration_data.key?(:one_of)
           end
 
+          def cast_value(value)
+            if array?
+              [value]
+            else
+              value
+            end
+          end
+
           def _non_colliding_path(full_paths)
             1.upto(full_path.length - 1) do |size|
               candidate_path = _truncated_path(full_path, size)
@@ -150,6 +158,10 @@ module Foobara
             !default.nil?
           end
 
+          def show_default?
+            true
+          end
+
           def primitive?
             attribute_type.primitive?
           end
@@ -174,7 +186,7 @@ module Foobara
               end
             end
 
-            if has_default?
+            if has_default? && show_default?
               displayable_str = to_bash_str(default)
               desc << "Default: #{displayable_str}"
             end

data/src/sh_cli_connector/inputs_parser/option_set.rb

@@ -36,11 +36,11 @@ module Foobara
                   h = h[key] ||= {}
                 end
 
+                value = option.cast_value(value)
+                h[option.attribute_name] = value
+
                 result_source.current_array = if option.array?
-                                                h[option.attribute_name] = [value]
-                                              else
-                                                h[option.attribute_name] = value
-                                                nil
+                                                value
                                               end
               end
             end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-sh-cli-connector
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Miles Georgi