commit 8797e02a2ca6f7ed04d9e96953187207bfbd6b7f
parent 923bc5cad0b3c0bd51fb3a57999bfd6d8b94e15a
Author: Daniel Barlow <dan@telent.net>
Date: Thu, 12 Aug 2021 21:06:11 +0100
add a CLI class that works with optional parameters
* this is not incorporated in moss.rb yet, this commit is a savepoint
* still need to add usage guidance for implementing "help" command
Diffstat:
| A | .rspec | | | 1 | + |
| A | spec/cli_spec.rb | | | 108 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | spec/spec_helper.rb | | | 105 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
3 files changed, 214 insertions(+), 0 deletions(-)
diff --git a/.rspec b/.rspec
@@ -0,0 +1 @@
+--require spec_helper
diff --git a/spec/cli_spec.rb b/spec/cli_spec.rb
@@ -0,0 +1,108 @@
+require "moss"
+
+class CLI1
+ class << self
+ @@commands = {}
+ def command(command_name, &blk)
+ define_method command_name, &blk
+ @@commands[command_name] = { }
+ end
+ end
+
+ def parse_arguments(argv)
+ name = argv.first.to_sym
+ args = argv.drop(1)
+ raise NoMethodError unless @@commands.key?(name)
+ arg_signature = method(name).parameters
+
+ return [ name, [] ] if arg_signature.empty?
+
+ flags = argv.reduce({}) {|m, flag|
+ matchdata = flag.match(/\A--(\w+)(?:=(.+))?/)
+ if matchdata
+ key, val = matchdata.captures
+ key ?
+ m.merge(key.to_sym => val ? val : :key_present) :
+ m
+ else
+ m
+ end
+ }
+
+ payload = arg_signature.reduce({}) { |m, (type, name)|
+ case type
+ when :rest
+ args
+ when :keyreq
+ m.merge(name => args.shift)
+ when :key
+ m
+ end
+ }
+ [ name,
+ payload.respond_to?(:merge) ? flags.merge(payload) : payload ]
+ end
+
+ def dispatch(argv)
+ name, payload = parse_arguments(argv)
+ self.public_send(name, *payload)
+ end
+
+end
+
+cli = CLI1.new
+class <<cli
+ command :greet do |firstname:, lastname:|
+ #
+ end
+ command :hang do |tight: false|
+ #
+ end
+ command :encrypt do |file:, signed: false|
+ #
+ end
+ command :mail do |rcpt:, subject: "text/plain"|
+ end
+ command :git do |*command|
+ end
+ command :help do
+ end
+end
+
+
+RSpec.describe CLI1 do
+ describe "dispatching" do
+
+ it "parses positional parameters" do
+ expect(cli.parse_arguments %w(greet ringo starr)).
+ to eq [:greet, {firstname: "ringo",
+ lastname: "starr"}]
+ end
+
+ it "parses valueless flags" do
+ expect(cli.parse_arguments %w(hang --tight)).
+ to match([:hang, have_key(:tight)])
+ expect(cli.parse_arguments %w(hang)).
+ to match([:hang, {}])
+ expect(cli.parse_arguments %w(encrypt foo.txt --signed)).
+ to match([:encrypt, { file: "foo.txt", signed: anything }])
+ expect(cli.parse_arguments %w(encrypt foo.txt)).
+ to match([:encrypt, { file: "foo.txt" }])
+ end
+
+ it "parses flags with values" do
+ expect(cli.parse_arguments ["mail", "dan", "--subject=hello dan"]).
+ to match([:mail, { rcpt: "dan", subject: "hello dan" }])
+ end
+
+ it "parses rest parameters" do
+ expect(cli.parse_arguments ["git", "init", "--bare", "-mmain"]).
+ to match([:git, ["init", "--bare", "-mmain"]])
+ end
+
+ it "parses when no parameters" do
+ expect(cli.parse_arguments %w(help)).
+ to match([:help, []])
+ end
+ end
+end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -0,0 +1,105 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+ # rspec-expectations config goes here. You can use an alternate
+ # assertion/expectation library such as wrong or the stdlib/minitest
+ # assertions if you prefer.
+ config.expect_with :rspec do |expectations|
+ # This option will default to `true` in RSpec 4. It makes the `description`
+ # and `failure_message` of custom matchers include text for helper methods
+ # defined using `chain`, e.g.:
+ # be_bigger_than(2).and_smaller_than(4).description
+ # # => "be bigger than 2 and smaller than 4"
+ # ...rather than:
+ # # => "be bigger than 2"
+ expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+ end
+
+ # rspec-mocks config goes here. You can use an alternate test double
+ # library (such as bogus or mocha) by changing the `mock_with` option here.
+ config.mock_with :rspec do |mocks|
+ # Prevents you from mocking or stubbing a method that does not exist on
+ # a real object. This is generally recommended, and will default to
+ # `true` in RSpec 4.
+ mocks.verify_partial_doubles = true
+ end
+
+ # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+ # have no way to turn it off -- the option exists only for backwards
+ # compatibility in RSpec 3). It causes shared context metadata to be
+ # inherited by the metadata hash of host groups and examples, rather than
+ # triggering implicit auto-inclusion in groups with matching metadata.
+ config.shared_context_metadata_behavior = :apply_to_host_groups
+
+ config.disable_monkey_patching!
+ config.warnings = true
+ config.order = :random
+ Kernel.srand config.seed
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+ # This allows you to limit a spec run to individual examples or groups
+ # you care about by tagging them with `:focus` metadata. When nothing
+ # is tagged with `:focus`, all examples get run. RSpec also provides
+ # aliases for `it`, `describe`, and `context` that include `:focus`
+ # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+ config.filter_run_when_matching :focus
+
+ # Allows RSpec to persist some state between runs in order to support
+ # the `--only-failures` and `--next-failure` CLI options. We recommend
+ # you configure your source control system to ignore this file.
+ config.example_status_persistence_file_path = "spec/examples.txt"
+
+ # Limits the available syntax to the non-monkey patched syntax that is
+ # recommended. For more details, see:
+ # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+ # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+ # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+ config.disable_monkey_patching!
+
+ # This setting enables warnings. It's recommended, but in some cases may
+ # be too noisy due to issues in dependencies.
+ config.warnings = true
+
+ # Many RSpec users commonly either run the entire suite or an individual
+ # file, and it's useful to allow more verbose output when running an
+ # individual spec file.
+ if config.files_to_run.one?
+ # Use the documentation formatter for detailed output,
+ # unless a formatter has already been configured
+ # (e.g. via a command-line flag).
+ config.default_formatter = "doc"
+ end
+
+ # Print the 10 slowest examples and example groups at the
+ # end of the spec run, to help surface which specs are running
+ # particularly slow.
+ config.profile_examples = 10
+
+ # Run specs in random order to surface order dependencies. If you find an
+ # order dependency and want to debug it, you can fix the order by providing
+ # the seed, which is printed after each run.
+ # --seed 1234
+ config.order = :random
+
+ # Seed global randomization in this process using the `--seed` CLI option.
+ # Setting this allows you to use `--seed` to deterministically reproduce
+ # test failures related to randomization by passing the same `--seed` value
+ # as the one that triggered the failure.
+ Kernel.srand config.seed
+=end
+end
