command_tree 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 669d97d138e5a9b26b34f51561538f6a40e306f3f22682c854f74d8d1a6e76a6
-  data.tar.gz: bdf8eea29094e6ec232bd32b9ed2b5f0b619b851c48b6e1049325c91dd6610a4
+  metadata.gz: 176b3e5d77f912e73b5c72557c96fbb1582eed07f3c533ee6837770fbc6de53f
+  data.tar.gz: eab685983241b03ef1f6e49b034a98ec9aa70c57c62c8d5235002d448bc9f254
 SHA512:
-  metadata.gz: b169b9c1795f6d82cf335292a53c624b0ecf8cda0c99582753ef8beee229b43833a569bb4698d6d6c3e05aadf83152ffa25b8bb0727843777d19383dee22e4fb
-  data.tar.gz: b2cc19380bff9655d04e0847624f042781a4359fd548bea49eced3d6e898a485b0313c0f0971630a5e310380b16c391404c7216209b016627ab110d3c6b55513
+  metadata.gz: 637cfb3d7ee3570fb0f39ef9f447f4880729bb3053c9816c3e4514c4e6df8000f14179688ff4a44f3a6c72c5ca9ea23b722fbaecec9a097e2f9bf769e0b50d8c
+  data.tar.gz: cf69dbace893ff6d3537e26cc681df533260d6473aca76817a1ddbd8d3b444bbf1cbfb370db4863d6ea9e38b94a7d13d3622717157b7c938f1499d1701ee9684

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    command_tree (0.1.1)
+    command_tree (0.1.2)
       colorize (~> 0.8)
 
 GEM

data/README.md

@@ -29,7 +29,7 @@ You start by creating a new tree
 t = CommandTree::Tree.new
 ```
 
-Then you can register a command category (a node that contains commands)
+Then you register a command category (a node that contains a group of commands)
 
 ```ruby
 t.register 'a', 'Applications' # associate the character 'a' to a category called 'applications'
@@ -52,6 +52,19 @@ it will print the toplevel categories and commands and wait for you to press a c
 
 when the tree reachs a leaf it'll exit, if a command is the leaf it will execute it and exit the tree giving your code the control again.
 
+
+There is another way to define a group of commands in a nested way using `Tree#group` method as follows
+
+```ruby
+t = CommandTree::Tree.new
+t.group 'a', 'Applications' do |g|
+  g.register 'g','Google Chrome' do
+    system 'google-chrome-stable'
+  end
+end
+t.show
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/command_tree/tree.rb

@@ -3,24 +3,56 @@ require 'colorize'
 require 'colorized_string'
 
 module CommandTree
+  # A tree of commands and associated keys for every node
   class Tree
     def initialize
       @calls = { '' => {} }
     end
 
+    # register a `path` to a `name` with a block of code if
+    # you wish it to be a command, the following `options` are
+    # supported:
+    # desc: a description of the item, as a help text for the user
     def register(path, name, options = {}, &block)
       insure_path(path, name, options)
-      calls[path] = { name: name, options: options, block: block } if block_given?
+      return unless block_given?
+
+      calls[path] = { name: name, options: options, block: block }
+    end
+
+    # define a group of commands (subtree)
+    # the method will create a subtree and pass it to
+    # the given block of code if you passed a block
+    # otherwise it works in a similar way to register
+    def group(prefix, name, options = {})
+      subtree = self.class.new
+      yield(subtree) if block_given?
+
+      merge(subtree, prefix, name, options)
     end
 
+    # Start the tree, prints the first level and walk
+    # the user through the tree with keystroks
     def show
       execute_path('')
     end
 
-    private
+    # merge a subtree with a prefix and a name
+    def merge(subtree, prefix, name, options = {})
+      register(prefix, name, options)
+      subtree.calls.each do |key, command|
+        next if key.empty?
+
+        calls["#{prefix}#{key}"] = command
+      end
+    end
+
+    protected
 
     attr_accessor :calls
 
+    private
+
     def insure_path(path, name, options = {})
       return if path.empty?
 
@@ -32,7 +64,9 @@ module CommandTree
       return puts "#{path} couldn't be found..." unless calls.key?(path)
 
       node = calls[path]
-      children = calls.keys.select { |key| key.start_with?(path) && key.length == (path.length + 1) }
+      children = calls.keys.select do |key|
+        key.start_with?(path) && key.length == (path.length + 1)
+      end
       children.sort!
 
       puts "#{node[:name]}:".light_magenta.bold if node.key?(:name)
@@ -59,10 +93,10 @@ module CommandTree
         output << ' → '.light_black
 
         output << if child_node.key?(:block)
-          " #{child_node[:name].ljust(40)}".cyan
-        else
-          "+#{child_node[:name].ljust(40)}".light_magenta.bold
-        end
+                    " #{child_node[:name].ljust(40)}".cyan
+                  else
+                    "+#{child_node[:name].ljust(40)}".light_magenta.bold
+                  end
 
         table_content << output
       end

data/lib/command_tree/version.rb

@@ -1,3 +1,3 @@
 module CommandTree
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Emad Elsaid