- Add support for nested configuration

Author: DannyBen

completely.gemspec

@@ -16,8 +16,8 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 3.0'
 
-  s.add_runtime_dependency 'colsole', '>= 0.8.1', '< 2'
-  s.add_runtime_dependency 'mister_bin', '~> 0.7'
+  s.add_dependency 'colsole', '>= 0.8.1', '< 2'
+  s.add_dependency 'mister_bin', '~> 0.7'
 
   s.metadata = {
     'bug_tracker_uri'       => 'https://github.com/DannyBen/completely/issues',

lib/completely.rb

@@ -1,4 +1,5 @@
 require 'completely/exceptions'
+require 'completely/config'
 require 'completely/pattern'
 require 'completely/completions'
 require 'completely/tester'

lib/completely/completions.rb

@@ -7,23 +7,20 @@ class Completions
 
     class << self
       def load(config_path, function_name: nil)
-        begin
-          data = YAML.load_file config_path, aliases: true
-        rescue ArgumentError
-          # :nocov:
-          data = YAML.load_file config_path
-          # :nocov:
-        end
-
-        new data, function_name: function_name
+        config = Config.load config_path
+        new config, function_name: function_name
       end
     end
 
     def initialize(config, function_name: nil)
-      @config = config
+      @config = config.is_a?(Config) ? config : Config.new(config)
       @function_name = function_name
     end
 
+    def flat_config
+      @flat_config ||= config.flat_config
+    end
+
     def patterns
       @patterns ||= patterns!
     end
@@ -54,7 +51,7 @@ def tester
   private
 
     def patterns!
-      result = config.map do |text, completions|
+      result = flat_config.map do |text, completions|
         Pattern.new text, completions, pattern_function_name
       end
 
@@ -70,7 +67,7 @@ def template
     end
 
     def command
-      @command ||= config.keys.first.split.first
+      @command ||= flat_config.keys.first.split.first
     end
 
     def function_name

lib/completely/config.rb

@@ -0,0 +1,69 @@
+module Completely
+  class Config
+    attr_reader :config
+
+    class << self
+      def load(config_path)
+        begin
+          config = YAML.load_file config_path, aliases: true
+        rescue ArgumentError
+          # :nocov:
+          config = YAML.load_file config_path
+          # :nocov:
+        end
+
+        new config
+      end
+    end
+
+    def initialize(config)
+      @config = config
+    end
+
+    def flat_config
+      result = {}
+
+      config.each do |root_key, root_list|
+        result.merge! process_key(root_key, root_list)
+      end
+
+      result
+    end
+
+  private
+
+    def process_key(prefix, list)
+      result = {}
+      result[prefix] = collect_immediate_children list
+      result.merge! process_nested_items(prefix, list)
+      result
+    end
+
+    def collect_immediate_children(list)
+      list.map do |item|
+        x = item.is_a?(Hash) ? item.keys.first : item
+        x.gsub(/^[*+]/, '')
+      end
+    end
+
+    def process_nested_items(prefix, list)
+      result = {}
+
+      list.each do |item|
+        next unless item.is_a? Hash
+
+        nested_prefix = generate_nested_prefix(prefix, item)
+        nested_list = item.values.first
+        result.merge!(process_key(nested_prefix, nested_list))
+      end
+
+      result
+    end
+
+    def generate_nested_prefix(prefix, item)
+      appended_prefix = item.keys.first.gsub(/^\+/, '*')
+      appended_prefix = " #{appended_prefix}" unless appended_prefix.start_with? '*'
+      "#{prefix}#{appended_prefix}"
+    end
+  end
+end

spec/approvals/config/flat_config

@@ -0,0 +1,19 @@
+---
+git:
+- "--help"
+- "--version"
+- init
+- checkout
+git init:
+- "--help"
+- "--bare"
+git checkout:
+- "--help"
+- "--branch"
+- "-b"
+git checkout*--branch:
+- dev
+- master
+git checkout*-b:
+- dev
+- master

spec/completely/config_spec.rb

@@ -0,0 +1,12 @@
+describe Config do
+  subject { described_class.load path }
+
+  let(:path) { "spec/fixtures/#{file}.yaml" }
+  let(:file) { 'nested' }
+
+  describe '#flat_config' do
+    it 'returns a flat pattern => completions hash' do
+      expect(subject.flat_config.to_yaml).to match_approval('config/flat_config')
+    end
+  end
+end

spec/fixtures/nested.yaml

@@ -0,0 +1,13 @@
+git:
+- --help
+- --version
+- init:
+  - --help
+  - --bare
+- checkout:
+  - --help
+  # + prefix is a wildcard (can also use "*--branches" instead, but in quotes)
+  - +--branch: &branches
+    - dev
+    - master
+  - +-b: *branches