command_tree 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 669d97d138e5a9b26b34f51561538f6a40e306f3f22682c854f74d8d1a6e76a6
-  data.tar.gz: bdf8eea29094e6ec232bd32b9ed2b5f0b619b851c48b6e1049325c91dd6610a4
+  metadata.gz: 8aed81a9c05e2f2e5610157af9f29faa54e699caddd21f4c5bc6bdf021b9b56a
+  data.tar.gz: 54245dba9ee4085224117ca3891bfcd4f1eda142deae333844fa74787a91ad9f
 SHA512:
-  metadata.gz: b169b9c1795f6d82cf335292a53c624b0ecf8cda0c99582753ef8beee229b43833a569bb4698d6d6c3e05aadf83152ffa25b8bb0727843777d19383dee22e4fb
-  data.tar.gz: b2cc19380bff9655d04e0847624f042781a4359fd548bea49eced3d6e898a485b0313c0f0971630a5e310380b16c391404c7216209b016627ab110d3c6b55513
+  metadata.gz: fa3f0b10340221ed303c805529652ea0ce40d2e4a58b26eaeaea14afc03c372c271fe217eb56cc55507bfc44183265a984f237a212bf8f36520b3eb3279840a0
+  data.tar.gz: f48773a682ce667a3a285eade3cd75b10112acf6922016aa4cc8c0a05261be56c4006d0ea942962bfdcb4856ca87f27fbac5e84fcef98ee55b9cafcacc56bb79

data/Gemfile.lock

@@ -1,24 +1,23 @@
 PATH
   remote: .
   specs:
-    command_tree (0.1.1)
-      colorize (~> 0.8)
+    command_tree (0.2.0)
+      colorize
 
 GEM
   remote: https://rubygems.org/
   specs:
     colorize (0.8.1)
-    minitest (5.11.3)
-    rake (10.5.0)
+    minitest (5.14.1)
+    rake (13.0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
   command_tree!
-  minitest (~> 5.0)
-  rake (~> 10.0)
+  minitest
+  rake
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

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/command_tree.gemspec

@@ -21,9 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "colorize", "~> 0.8"
+  spec.add_dependency "colorize"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

data/lib/command_tree/command.rb

@@ -0,0 +1,33 @@
+module CommandTree
+  # A command class
+  class Command
+    attr_reader :name, :desc, :prefix, :block
+
+    def initialize(prefix, name, options = {}, &block)
+      @prefix = prefix
+      @name = name
+      @desc = options[:desc]
+      @block = block
+    end
+
+    def execute
+      print_banner
+      block.call
+    end
+
+    private
+
+    def print_banner
+      puts pretty_name if name
+      puts pretty_description if desc
+    end
+
+    def pretty_name
+      name.light_magenta.bold if name
+    end
+
+    def pretty_description
+      desc.to_s.light_black if desc
+    end
+  end
+end

data/lib/command_tree/group.rb

@@ -0,0 +1,31 @@
+module CommandTree
+  # A group of commands
+  class Group
+    attr_reader :name, :desc, :prefix
+
+    def initialize(prefix, name, options = {})
+      @prefix = prefix
+      @name = name
+      @desc = options[:desc]
+    end
+
+    def execute
+      print_banner
+    end
+
+    private
+
+    def print_banner
+      puts pretty_name if name
+      puts pretty_description if desc
+    end
+
+    def pretty_name
+      name.light_magenta.bold if name
+    end
+
+    def pretty_description
+      desc.to_s.light_black if desc
+    end
+  end
+end

data/lib/command_tree/text_menu.rb

@@ -0,0 +1,55 @@
+require 'colorize'
+require 'colorized_string'
+
+module CommandTree
+  # responsible for showing the menu in terminal
+  class TextMenu
+    def initialize(item_width)
+      @item_width = item_width
+      @items = []
+    end
+
+    def render
+      _, screen_width = IO.console.winsize
+      items_per_row = screen_width / item_width
+
+      names = items.dup.map! { |item| item_name(item) }
+      descs = items.dup.map! { |item| item_desc(item) }
+
+      until names.empty?
+        puts names.shift(items_per_row).join
+        row_descs = descs.shift(items_per_row).join
+        puts row_descs unless row_descs.strip.empty?
+      end
+    end
+
+    def add(item)
+      items << item
+    end
+
+    private
+
+    attr_reader :items, :item_width
+
+    def  item_name(item)
+      prefix = item.prefix
+      arrow = ' → '
+
+      name_width = item_width - prefix.length - arrow.length
+      name =  (item.is_a?(Group) ? '+' : '') + item.name
+      name = name.ljust(name_width)
+
+      colored_name = item.is_a?(Group) ? name.light_magenta.bold : name.cyan
+
+      (prefix.green + arrow.light_black + colored_name)
+    end
+
+    def item_desc(item)
+      desc = item.desc.to_s
+      return desc.ljust(item_width) if desc.strip.empty?
+
+      return (desc[0...item_width - 3] + '...').light_black if desc.length >= item_width
+      return desc.ljust(item_width).light_black
+    end
+  end
+end

data/lib/command_tree/tree.rb

@@ -1,47 +1,78 @@
 require 'io/console'
-require 'colorize'
-require 'colorized_string'
+
+require_relative 'group'
+require_relative 'command'
+require_relative 'text_menu'
 
 module CommandTree
+  # A tree of commands and associated keys for every node
   class Tree
     def initialize
-      @calls = { '' => {} }
+      @calls = { '' => nil }
     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)
+      path = path.to_s
+      name = name.to_s
+      prefix = path[-1]
+
       insure_path(path, name, options)
-      calls[path] = { name: name, options: options, block: block } if block_given?
+      return unless block_given?
+
+      calls[path] = Command.new(prefix, name, options, &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 unless command
+
+        calls["#{prefix}#{key}"] = command
+      end
+    end
+
+    protected
 
     attr_accessor :calls
 
+    private
+
     def insure_path(path, name, options = {})
       return if path.empty?
 
       insure_path(path[0...-1], name, options)
-      calls[path] = { name: name, options: options } unless calls[path]
+      calls[path] = Group.new(path[-1], name, options) unless calls[path]
     end
 
     def execute_path(path)
       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.sort!
-
-      puts "#{node[:name]}:".light_magenta.bold if node.key?(:name)
-
-      description = node.dig(:options, :desc)
-      puts description.to_s.light_black if description
-
-      node[:block].call if node.key?(:block)
+      node.execute if node
 
+      children = get_children(path)
       return if children.empty?
 
       print_children(children)
@@ -49,34 +80,21 @@ module CommandTree
       execute_path(path + choice)
     end
 
+    def get_children(path)
+      calls.keys.select do |key|
+        key.start_with?(path) && key.length == (path.length + 1)
+      end.sort
+    end
+
     def print_children(children)
-      table_content = []
+      menu = TextMenu.new(40)
 
       children.each do |child|
-        child_node = calls[child]
-
-        output = child[-1].green
-        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
-
-        table_content << output
+        menu.add calls[child]
       end
 
-      table(table_content, 40)
+      menu.render
       print "\n"
     end
-
-    def table(items, item_width)
-      _, screen_width = IO.console.winsize
-      items_per_row = screen_width / item_width
-      items_dup = items.dup
-
-      puts items_dup.shift(items_per_row).join until items_dup.empty?
-    end
   end
 end

data/lib/command_tree/version.rb

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

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: command_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Emad Elsaid
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2020-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 description: Builds trees of commands for the terminal, each node is either a group
   of commands or the command itself, every node is associated with a character to
   access it.
@@ -86,13 +72,16 @@ files:
 - bin/setup
 - command_tree.gemspec
 - lib/command_tree.rb
+- lib/command_tree/command.rb
+- lib/command_tree/group.rb
+- lib/command_tree/text_menu.rb
 - lib/command_tree/tree.rb
 - lib/command_tree/version.rb
 homepage: https://www.github.com/emad-elsaid/command_tree
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,9 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Command trees for the terminal
 test_files: []