command_tree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15fb161d51f86da4d50b5c0748051e91373d0258a3c8459e124e238dd79b3cd8
+  data.tar.gz: 97f50232b6db9de2aeebaf01681911ab67570b98fe6a54953eaa982c7e83b9ef
+SHA512:
+  metadata.gz: d7462dc4a273fdf456e879b9320a54222a204c9192efec5ae294a0113a6fb9cec96fb94b3fe8c472bf6676996f317c682181146609cbb419457dba4322706fbe
+  data.tar.gz: d2ed71c2a8b8f587d1fc5d623386a6773e80f370f0207bcd334fb11aa615b7fd7723aac67c5e87d4e1ab62c0e5f490f1ede8d79804d6f9c50590cb0d6a4aaecf

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in command_tree.gemspec
+gemspec

data/Gemfile.lock

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emad Elsaid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# CommandTree
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'command_tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install command_tree
+
+## Usage
+
+You start by creating a new tree
+
+```ruby
+t = CommandTree::Tree.new
+```
+
+Then you can register a command category (a node that contains commands)
+
+```ruby
+t.register 'a', 'Applications' # associate the character 'a' to a category called 'applications'
+```
+
+Then register commands inside that prefix
+```ruby
+t.register 'ag','Google Chrome' do
+  system 'google-chrome-stable'
+end
+```
+the previous block will be assigned to 'g' inside 'a' which is the application's prefix, so you can execute it with 'ag' when you run that tree in terminal.
+
+To run the tree call `#show`
+```ruby
+t.show
+```
+
+it will print the toplevel categories and commands and wait for you to press a character to execute the command or print sub commands of a category node.
+
+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.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/emad-elsaid/command_tree.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "command_tree"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/command_tree.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "command_tree/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "command_tree"
+  spec.version       = CommandTree::VERSION
+  spec.authors       = ["Emad Elsaid"]
+  spec.email         = ["emad.elsaid@blacklane.com"]
+
+  spec.summary       = %q{Command trees for the terminal}
+  spec.description   = %q{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.}
+  spec.homepage      = "https://www.github.com/emad-elsaid/command_tree"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "colorize", "~> 0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/command_tree/tree.rb

@@ -0,0 +1,80 @@
+require 'io/console'
+require 'colorize'
+require 'colorized_string'
+
+module CommandTree
+  class Tree
+    def initialize
+      @calls = { '' => {} }
+    end
+
+    def register(path, name, &block)
+      insure_path(path, name)
+      calls[path] = { name: name, block: block } if block_given?
+    end
+
+    def show
+      execute_path('')
+    end
+
+    private
+
+    attr_accessor :calls
+
+    def insure_path(path, name)
+      return if path.empty?
+
+      insure_path(path[0...-1], name)
+      calls[path] = { name: name } 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) }
+
+      node[:block].call if node.key?(:block)
+
+      return if children.empty?
+
+      puts "#{node[:name]}:".light_magenta.bold if node.key?(:name)
+
+      print_children(children)
+
+      choice = STDIN.getch
+      execute_path(path + choice)
+    end
+
+    def print_children(children)
+      table_content = []
+
+      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
+      end
+
+      table(table_content, 40)
+      print "\n\n"
+    end
+
+    def table(items, item_width)
+      _, width = IO.console.winsize
+      items_per_row = width / item_width
+      items.each_with_index do |item, index|
+        print item
+        print "\n" if ((index + 1) % items_per_row).zero? && index > 0
+      end
+    end
+  end
+end

data/lib/command_tree/version.rb

@@ -0,0 +1,3 @@
+module CommandTree
+  VERSION = "0.1.0"
+end

data/lib/command_tree.rb

@@ -0,0 +1,5 @@
+require "command_tree/version"
+require "command_tree/tree"
+
+module CommandTree
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: command_tree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emad Elsaid
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-21 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'
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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.
+email:
+- emad.elsaid@blacklane.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- command_tree.gemspec
+- lib/command_tree.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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Command trees for the terminal
+test_files: []