super_docopt 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474289f2c16f5a9c803217ab32273e9e98cf926c600c34564ced2eed2eb827ea
-  data.tar.gz: 62f74ba90e03a7d247696515a6ef8f221155a6f149c53f0c8aa7de687778444e
+  metadata.gz: b208dfe9dafa0e901eb87a96fa96a76c188fef825503cb5be5a8cb0965157e87
+  data.tar.gz: d4ea792a397b4e149ec38399af01a1120ebaf016f3a360cb658f7026a207b13b
 SHA512:
-  metadata.gz: fe882885ec596994f74ff2b2f1eb5137524c46348ce29ef9f2ee38005c03e7f624b351d4bd58341ecbf9be11d8d3c3fffc61bc730aaaf53de6973b5fc6cbcade
-  data.tar.gz: ed0777d6c669a0194baa20ac26bb3e2ea4fd450346e997ca30e70b1a8da8472a6340af4c1bfaec776b693eacbac3a63abfbd0ed4e8e2b3a51260fc378d7f1480
+  metadata.gz: cd9c66bda7521ae87d621e5134bd3ed1b0d2545fddc9baf46b98ea2f646b392f5645e9cf7da8980d2b1350dc9643b17d5e29639e128c23fb7b5a20433de89dc9
+  data.tar.gz: fbf6f682020997cdf125f516977521c2f73071903e5e109cb4167385ac771bf250882a637b197c27f66ce4c4b7ef56c0383c67b3d226e8d8429825c9c478726b

data/README.md

@@ -1,2 +1,61 @@
 Super Docopt
 ==================================================
+
+[![Gem](https://img.shields.io/gem/v/super_docopt.svg?style=flat-square)](https://rubygems.org/gems/super_docopt)
+[![Build](https://img.shields.io/travis/DannyBen/super_docopt.svg?style=flat-square)](https://travis-ci.org/DannyBen/super_docopt)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/DannyBen/super_docopt.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/super_docopt)
+[![Issues](https://img.shields.io/codeclimate/issues/github/DannyBen/super_docopt.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/super_docopt)
+
+---
+
+Create command line utilities with ease.
+*Super Docopt* is an extension that provides syntactic sugar to [Docopt][1]
+
+---
+
+Install
+--------------------------------------------------
+
+    $ gem install runfile
+
+
+Example
+--------------------------------------------------
+
+```ruby
+# my_command_line.rb
+require 'super_docopt'
+
+class MyCommandLine < SuperDocopt::Base
+  version '1.0.0'
+  docopt 'docopt.txt'
+  subcommands ['download', 'upload']
+
+  def download(args)
+    puts "#download called with #{args}"
+  end
+
+  def upload(args)
+    puts "#upload called"
+  end
+end
+```
+
+```plain
+# docopt.txt
+My Command Line
+
+Usage:
+  mock download [--force]
+  mock upload
+  mock (-h|--help|--version)
+```
+
+Usage
+--------------------------------------------------
+
+Soon
+
+---
+
+[1]: http://docopt.org/

data/lib/super_docopt/base.rb

@@ -5,8 +5,7 @@ module SuperDocopt
   class Base
     include Singleton
 
-    VERSION = '0.0.1'
-
+    attr_reader :args
     attr_accessor :version, :docopt, :subcommands
 
     def self.execute(argv=[])
@@ -24,12 +23,12 @@ module SuperDocopt
     def self.subcommands(list)
       instance.subcommands = list
     end
-    
+
     def execute_cli(argv=[])
       doc = File.read docopt
       begin
-        args = Docopt::docopt(doc, argv: argv, version: version)
-        handle_subcommand args
+        @args = Docopt::docopt(doc, argv: argv, version: version)
+        handle_subcommand
       rescue Docopt::Exit => e
         puts e.message
       end
@@ -37,27 +36,40 @@ module SuperDocopt
 
     private
 
-    def handle_subcommand(args)
+    def handle_subcommand
       subcommands.each do |subcommand|
-        command = subcommand.to_s
-        method  = subcommand.to_s
+        input, method = translate_subcommand subcommand
+        return execute_subcommand input, method if args[input] 
+      end
+    end
 
-        if subcommand.is_a? Hash
-          command = subcommand.keys.first.to_s
-          method = subcommand.values.first.to_s
-        end
+    def execute_subcommand(input, method)
+      raise NotImplementedError, 
+        "Please implement ##{method}" unless respond_to? method
 
-        command = command.gsub '_', '-'
-        method  = method.gsub  '-', '_'
+      before_execute
+      send method
+      after_execute
+    end
 
-        if args[command]
-          raise NotImplementedError, 
-            "Please implement ##{method}" unless respond_to? method
+    def translate_subcommand(subcommand)
+      input  = subcommand.to_s
+      method = subcommand.to_s
 
-          send method, args
-          return
-        end
+      if subcommand.is_a? Hash
+        input  = subcommand.keys.first.to_s
+        method = subcommand.values.first.to_s
       end
+
+      input  = input.gsub '_', '-'
+      method = method.gsub  '-', '_'
+
+      [input, method]
     end
+
+    # Overridable Hooks
+
+    def before_execute; end
+    def after_execute; end
   end
 end

data/lib/super_docopt/version.rb

@@ -1,3 +1,3 @@
 module SuperDocopt
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_docopt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-09 00:00:00.000000000 Z
+date: 2018-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-description: Create command line applications with docopt
+description: Extension to docopt for defining command line utilities with ease
 email: db@dannyben.com
 executables: []
 extensions: []
@@ -155,5 +155,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Docopt extension for easy command line applications
+summary: docopt-based command line utility builder
 test_files: []