mister_bin 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 625bef48b831c9b258cbfbb1ea2e02e756604d8d09111d0db95aa670fcd5b002
-  data.tar.gz: fdb6c17c82ac45329073c95f9303359625ae76ea243db933d1b63df42833c533
+  metadata.gz: 6a2ff2144e3c182ac75eee0201e1fb2c709d070174b3f1d6d3474b4fc2996f2d
+  data.tar.gz: 342666c56d570caa2c791ebf9e3fb259b35c6a94f5c348c6cec168ef381d8c86
 SHA512:
-  metadata.gz: 7326953c18b22157cb2fc8eadd3d32fe88ba6878e63225fc1e08a0d96417a7a004c52e29fdc2c081c38fc40882b32f350f3c4e8216364d6c4c58d56ff441715b
-  data.tar.gz: e749163878edec4ea78846a6e309713225818016bb337831412c01032b77114539fe2f86aae02df375471a63a1ed0036be616c21c10d361a79dc04ca59ac9163
+  metadata.gz: 276954e4955705da9a9eed20b1fe803cf702603b35141ebc096cee16537b3adf39b6aec29abeaa36ac0b10e084b7cf998ccd067bc9aca90cb50bef21edf91484
+  data.tar.gz: b9ee0f5d12e13da32eef957066071b6bafaba92a9edc59ddd7d6f73a83c1b9e9be9406ae7d9664958ee6037d77710480a46daf923c4be6fb76563bce64363551

data/README.md

@@ -63,6 +63,11 @@ Creating a command line utility with Mister Bin involves at least two files:
 2. One or more subcommand files. These files use the DSL, and will usually be
    placed in your `lib/<your gem>/commands` folder.
 
+WHen executing the commands, you can use only the first letters of the 
+command name. Mister Bin will search for the command that starts with your 
+input, and if it finds one and one only, it will execute it. For example, 
+if you have a `server` command, you can execute it with `yourapp s` if it
+is the only command that starts with an `s`.
 
 
 Creating the Main Executable
@@ -107,9 +112,9 @@ Text to display after the list of commands.
 
 #### `commands`
 
-A hash of `{ 'regex' => ClassName }` to serve as command routes.
+A hash of `{ 'command_name' => ClassName }` to serve as command routes.
 This is equivalent to adding routes later with 
-`runner.route 'regex', to: ClassName`.
+`runner.route 'command_name', to: ClassName`.
 
 
 #### `handler`
@@ -128,7 +133,7 @@ Use the `#route` method as follows:
 
 ```ruby
 runner = MisterBin::Runner.new
-runner.route <regex>, to: <Class Name>
+runner.route <command_name>, to: <Class Name>
 ```
 
 for example:
@@ -137,8 +142,7 @@ for example:
 runner = MisterBin::Runner.new
 runner.route 'dir', to: DirCommand
 runner.route 'greet', to: GreetCommand
-runner.route 'config init', to: ConfigInitializerCommand
-runner.route 'config show', to: ConfigDisplayerCommand
+runner.route 'config', to: ConfigCommand
 ```
 
 If you wish to route all commands to the same class, you can use:
@@ -159,7 +163,7 @@ runner.route_all to: GlobalCommand
 Creating Commands
 --------------------------------------------------
 
-Create command classes by in heriting from `MisterBin::Command`, for example:
+Create command classes by inheriting from `MisterBin::Command`, for example:
 
 ```ruby
 require 'mister_bin'
@@ -169,7 +173,8 @@ class GreetCommand < MisterBin::Command
   usage "app greet [NAME]"
   param "NAME", "The recipient of the greeting"
 
-  def run(args)
+  def run
+    # args hash is available everywhere in the calss
     name = args['NAME'] || 'Luke'
     puts "#{name}... I am your father..."
   end

data/lib/mister_bin/command.rb

@@ -5,6 +5,12 @@ module MisterBin
   class Command
     include Colsole
 
+    attr_reader :args
+
+    def initialize(args)
+      @args = args
+    end
+
     class << self
       def description
         maker.summary || maker.help || ''
@@ -12,9 +18,9 @@ module MisterBin
 
       def execute(argv=[])
         args = Docopt.docopt docopt, version: maker.version, argv: argv
-        instance = new
+        instance = new args
         target = find_target_command instance, args
-        exitcode = instance.send target, args
+        exitcode = instance.send target
         exitcode.is_a?(Numeric) ? exitcode : 0
 
       rescue Docopt::Exit => e

data/lib/mister_bin/runner.rb

@@ -38,7 +38,8 @@ module MisterBin
     private
 
     def execute(argv)
-      command = find_command argv
+      argv = normalize_argv_command argv
+      command = commands[argv[0]]
 
       if command
         command.execute argv
@@ -48,11 +49,12 @@ module MisterBin
       end
     end
 
-    def find_command(argv)
-      argv_line = argv.join ' '
-      candidates = commands.keys.select { |c| argv_line =~ /^#{c}\b/ }
-      candidate = candidates.first
-      candidate ? commands[candidate] : nil
+    def normalize_argv_command(argv)
+      command = argv[0]
+      return argv if commands.has_key? command
+      candidates = commands.keys.select { |key| key =~ /^#{command}/ }
+      argv[0] = candidates.first if candidates.count == 1
+      argv
     end
 
     def show_subs

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2018-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -38,118 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: rspec_fixtures
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: runfile
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: runfile-tasks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description: Easily add command line interface to your gems
 email: db@dannyben.com
 executables: []