mister_bin 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0acb988ac9e4c15ffe3d81625b51b1e4a9bd6eefbeaa85ecb478b32e8be54c8
-  data.tar.gz: 8518da9a10b5ff5d9934d9045d4364ac5bfd0564be0f773a35830c985a444d40
+  metadata.gz: b8b37499324199dee43edefc92606a2a697ce9dd132c6ef11803a6037e259c23
+  data.tar.gz: 5bd2375c5eea1a0a936cdbde439d8864975bc068ab61ac24a79f6c52ef2987a8
 SHA512:
-  metadata.gz: 7a49296fd401d5adaf920fdbac936ee5c9d59e1bea4fa7b06fec226c19ae64f9ca29bdd3fe460a2ef4eadc28666edbb3dd7f4f90f5348678e7b6911c59bddca2
-  data.tar.gz: 5079f114df50a5bd184f82255b3a2bfff8ab82701d5fb343cd91a8b597c65811d72930cf44edbd9954114248491ff2b88f87d67b0ac038131261ed84dbd5135b
+  metadata.gz: e31a33f9192da8ad523bc29a299bc373d39dcedbc8dc96d39e4a90e748a5e4321189eaea462a1823ee88226f2d22bcebf8fab05cfca5850219ef9d2fb094560b
+  data.tar.gz: 97c81e608bc71af98922ce740792dc0ee0d235a1dca08c18f6383fe9aa87a23d0d09cb620c564ad3066cd848d0918a0c499e1e43075205058b18051cf8bf9f4f

data/README.md

@@ -13,7 +13,9 @@ interfaces for your gem or other Ruby application.
 
 ## Installation
 
-    $ gem install mister_bin
+```
+$ gem install mister_bin
+```
 
 ## Feature Highlights
 
@@ -21,7 +23,8 @@ interfaces for your gem or other Ruby application.
 - Each command is defined with a separate class for maximum testability and 
   scalability.
 - Commands can have subcommands.
-- Designed for gem developers.
+- Commands can have aliases.
+- Designed primarily for gem developers.
 
 ## Examples
 
@@ -122,6 +125,15 @@ runner.route 'greet', to: GreetCommand
 runner.route 'config', to: ConfigCommand
 ```
 
+The first argument to the `route` method can be an array. In this case, the
+first element of the array will be considered the primary command name, and the
+other elements will be considered aliases.
+
+```ruby
+runner = MisterBin::Runner.new
+runner.route %w[dir ls list], to: DirCommand
+```
+
 If you wish to route all commands to the same class, you can use:
 
 ```ruby
@@ -149,7 +161,7 @@ class GreetCommand < MisterBin::Command
   param "NAME", "The recipient of the greeting"
 
   def run
-    # args hash is available everywhere in the calss
+    # args hash is available everywhere in the class
     name = args['NAME'] || 'Luke'
     puts "#{name}... I am your father..."
   end
@@ -241,7 +253,7 @@ terminal.start
 The `MisterBin::Terminal.new` command accepts an optional second argument. If 
 provided, it should be a options hash:
 
-```
+```ruby
 terminal = MisterBin::Terminal.new runner, {
   header: "Welcome",
   autocomplete: %w[--help greet]
@@ -253,7 +265,7 @@ commands that are not handled by your runner. For example, this piece of code
 will capture the `/cd ...` command from the terminal and pass it to your 
 block:
 
-```
+```ruby
 terminal = MisterBin::Terminal.new runner
 terminal.on '/cd' do |args|
   Dir.chdir args[0] if args[0]

data/lib/mister_bin/runner.rb

@@ -1,4 +1,5 @@
 require 'colsole'
+require 'debug'
 
 module MisterBin
   class Runner
@@ -15,7 +16,13 @@ module MisterBin
     end
 
     def route(key, to:)
-      commands[key] = to
+      if key.is_a? Array
+        target = key.shift
+        commands[target] = to
+        key.each { |alias_name| aliases[alias_name] = target }
+      else
+        commands[key] = to
+      end
     end
 
     def route_all(to:)
@@ -36,6 +43,10 @@ module MisterBin
       end
     end
 
+    def aliases
+      @aliases ||= {}
+    end
+
   private
 
     def execute(argv)
@@ -54,11 +65,20 @@ module MisterBin
       command = argv[0]
       return argv if commands.has_key? command
 
-      candidates = commands.keys.grep(/^#{command}/)
-      argv[0] = candidates.first if candidates.count == 1
+      argv[0] = find_target_command argv[0]
       argv
     end
 
+    def find_target_command(input)
+      candidates = commands.keys.grep(/^#{input}/)
+      return candidates.first if candidates.count == 1
+
+      candidates = aliases.keys.grep(/^#{input}/)
+      return aliases[candidates.first] if candidates.count == 1
+
+      input
+    end
+
     def show_version
       puts version
       0

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = '0.7.6'
+  VERSION = '0.8.0'
 end

data/lib/mister_bin.rb

@@ -1,6 +1,6 @@
-require 'mister_bin/command'
-require 'mister_bin/command_meta'
-require 'mister_bin/runner'
-require 'mister_bin/terminal'
-
-require 'byebug' if ENV['BYEBUG']
+module MisterBin
+  autoload :Command, 'mister_bin/command'
+  autoload :CommandMeta, 'mister_bin/command_meta'
+  autoload :Runner, 'mister_bin/runner'
+  autoload :Terminal, 'mister_bin/terminal'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2024-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -67,8 +67,11 @@ homepage: https://github.com/dannyben/mister_bin
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/DannyBen/mister_bin/issues
+  changelog_uri: https://github.com/DannyBen/mister_bin/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/DannyBen/mister_bin
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,15 +79,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: Command line interface for your gems
 test_files: []