Parse and pass unknown options to Roger's inner machinery

Author: Flurin Egger

doc/cli.md

@@ -52,4 +52,15 @@ All commands accept these options.
 Options:
   -v, [--verbose]  # Set's verbose output
   -h, [--help]  # Help
-```
+```
+
+## Custom options
+
+All processors/middleware/etc. can use custom options. Roger will parse any leftover option that starts with `--` and sets it in the `project.options` hash. It even supports setting nested keys by using `:` as a separator. This means that `--release:rsync:disable=true` will become: `{release: { rsync: { disable: true}}}` in the options hash.
+
+### Parsing
+The commandline parser will work with flags in the following formats:
+
+* `--key` will just set the flag to `true`
+* `--key=value` and `--key value` will set the key `:key` to `"value"`
+* `--key=true` and `--key=false` will convert to boolean `true` and `false`

lib/roger/cli.rb

@@ -96,14 +96,76 @@ def version
 
     protected
 
-    # TODO: handle options
     def initialize_project
       if (Pathname.new(options[:path]) + "../partials").exist?
         puts "[ERROR]: Don't use the \"html\" path, use the project base path instead"
         exit(1)
       end
 
-      Project.new(options[:path], { shell: shell }.update(options))
+      project_options = { shell: shell }
+      project_options.update(parse_generic_options(args)[0])
+      project_options.update(options)
+
+      Project.new(options[:path], project_options)
+    end
+
+    # Very simplified method to parse CLI options
+    # only works with options starting with --
+    # Will also make nested options by using ":" so
+    # --a:b:c=yes will become {a: {b: {c: "yes"}}}
+    def parse_generic_options(args)
+      a = args.dup
+      arguments = []
+      options = {}
+
+      until a.empty?
+        arg = a.shift
+        case arg
+        when /\A--.+=/
+          _, option, value = arg.match(/\A--(.+)=(.+)\Z/).to_a
+          update_options(option, value, options)
+        when /\A--.+/
+          if a[0].nil? || a[0].to_s.start_with?("--")
+            # Current option is a boolean
+            update_options(arg, true, options)
+          else
+            # Take value from next
+            update_options(arg, a.shift, options)
+          end
+        else
+          arguments << arg
+        end
+      end
+
+      [options, arguments]
+    end
+
+    # Will update the passed options array by splitting
+    # the composite_key by ":" and applying the keys nested
+    def update_options(composite_key, value, options)
+      nesting = options
+      keys = composite_key.sub(/\A--/, "").split(":")
+      keys.each_with_index do |key, i|
+        key = key.to_sym
+        if i < keys.length - 1
+          nesting[key] ||= {}
+          nesting = nesting[key]
+        else
+          nesting[key] = parse_possible_boolean(value)
+        end
+      end
+      options
+    end
+
+    def parse_possible_boolean(value)
+      case value
+      when "true"
+        true
+      when "false"
+        false
+      else
+        value
+      end
     end
   end
 end

test/unit/cli/cli_base_test.rb

@@ -1,9 +1,32 @@
 require "test_helper"
 require "./lib/roger/cli"
 
+module Roger
+  # Just a noop command class for testing
+  class CliNoop < Cli::Command
+  end
+
+  # Open existing Cli::Base to add Noop method.
+  class Cli::Base < Thor
+    register(
+      CliNoop,
+      "noop",
+      "noop",
+      "noop"
+    )
+    tasks["noop"].options = Cli::Serve.class_options
+  end
+end
+
 module Roger
   # Test for roger base commands
   class CliBaseTest < ::Test::Unit::TestCase
+    include TestCli
+
+    def teardown
+      Cli::Base.project = nil
+    end
+
     def test_has_test_command
       assert_includes Cli::Base.tasks.keys, "test"
     end
@@ -23,5 +46,49 @@ def test_has_generate_command
     def test_has_version_command
       assert_includes Cli::Base.tasks.keys, "version"
     end
+
+    # Option passing
+
+    def test_pass_options_to_project
+      run_command(%w(noop --path=henk))
+      assert_equal "henk", Cli::Base.project.options[:path]
+    end
+
+    def test_pass_roger_options_to_project
+      run_command(%w(noop --some_option=henk))
+      assert_equal "henk", Cli::Base.project.options[:some_option]
+    end
+
+    def test_pass_multiple_roger_options_to_project
+      run_command(%w(noop --option1=henk --option2=henk))
+      assert_equal "henk", Cli::Base.project.options[:option1]
+      assert_equal "henk", Cli::Base.project.options[:option2]
+    end
+
+    def test_pass_roger_options_without_equal_to_project
+      run_command(%w(noop --option1 henk --option2 pino))
+      assert_equal "henk", Cli::Base.project.options[:option1]
+      assert_equal "pino", Cli::Base.project.options[:option2]
+    end
+
+    def test_pass_roger_nested_options_to_project
+      run_command(%w(noop --level0:level1=henk))
+      assert_equal "henk", Cli::Base.project.options[:level0][:level1]
+    end
+
+    def test_pass_boolean_roger_options_to_project
+      run_command(%w(noop --istrue))
+      assert_equal true, Cli::Base.project.options[:istrue]
+    end
+
+    def test_pass_boolean_literal_true_roger_options_to_project
+      run_command(%w(noop --istrue=true))
+      assert_equal true, Cli::Base.project.options[:istrue]
+    end
+
+    def test_pass_boolean_literal_false_roger_options_to_project
+      run_command(%w(noop --isfalse=false))
+      assert_equal false, Cli::Base.project.options[:isfalse]
+    end
   end
 end