super_docopt 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474289f2c16f5a9c803217ab32273e9e98cf926c600c34564ced2eed2eb827ea
-  data.tar.gz: 62f74ba90e03a7d247696515a6ef8f221155a6f149c53f0c8aa7de687778444e
+  metadata.gz: 556c14534c6e62e2a508387a141ca629048a543bc8b2a16bdba47880a63d0fd4
+  data.tar.gz: c832a020c2cf4c527fdbac014c8c249f6849d728afa7f15b90ee0490c201d449
 SHA512:
-  metadata.gz: fe882885ec596994f74ff2b2f1eb5137524c46348ce29ef9f2ee38005c03e7f624b351d4bd58341ecbf9be11d8d3c3fffc61bc730aaaf53de6973b5fc6cbcade
-  data.tar.gz: ed0777d6c669a0194baa20ac26bb3e2ea4fd450346e997ca30e70b1a8da8472a6340af4c1bfaec776b693eacbac3a63abfbd0ed4e8e2b3a51260fc378d7f1480
+  metadata.gz: 5d634beb5b71cc725979b80e7d314864e1625b4984dd5edabfe7b74ad0406c53aef1751db5fd83cb95825348f5127871c714bef9518d1342aa6a6aff6a80ccf7
+  data.tar.gz: bed43e205b8d88a9c74cfc22abbbe9ae9f27ceb15b818f4fd1c49b7e43dc7fdd34ef8a3837f7b562585f7949bfa86812b2c11d245143e9cde5582628825e7cf3

data/README.md

@@ -1,2 +1,59 @@
 Super Docopt
 ==================================================
+
+[![Gem Version](https://badge.fury.io/rb/super_docopt.svg)](https://badge.fury.io/rb/super_docopt)
+[![Build Status](https://github.com/DannyBen/super_docopt/workflows/Test/badge.svg)](https://github.com/DannyBen/super_docopt/actions?query=workflow%3ATest)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2ca07d88e6f7b0b57e82/maintainability)](https://codeclimate.com/github/DannyBen/super_docopt/maintainability)
+
+---
+
+Create command line utilities with ease.
+*Super Docopt* is an extension that provides syntactic sugar to [Docopt][1]
+
+---
+
+Install
+--------------------------------------------------
+
+    $ gem install super_docopt
+
+
+Getting Started
+--------------------------------------------------
+
+```ruby
+# my_command_line.rb
+require 'super_docopt'
+
+class MyCommandLine < SuperDocopt::Base
+  version '1.0.0'
+  docopt 'docopt.txt'
+  subcommands ['download', 'upload']
+
+  def download
+    puts "#download called with #{args}"
+  end
+
+  def upload
+    puts "#upload called"
+  end
+end
+
+MyCommandLine.execute ARGV
+```
+
+```plain
+# docopt.txt
+My Command Line
+
+Usage:
+  mock download [--force]
+  mock upload
+  mock (-h|--help|--version)
+```
+
+See the [examples](/examples) folder for more examples.
+
+---
+
+[1]: http://docopt.org/

data/lib/super_docopt/base.rb

@@ -1,15 +1,14 @@
 require 'singleton'
-require 'docopt'
+require 'docopt_ng'
 
 module SuperDocopt
   class Base
     include Singleton
 
-    VERSION = '0.0.1'
-
+    attr_reader :args
     attr_accessor :version, :docopt, :subcommands
 
-    def self.execute(argv=[])
+    def self.execute(argv = [])
       instance.execute_cli argv
     end
 
@@ -24,40 +23,52 @@ module SuperDocopt
     def self.subcommands(list)
       instance.subcommands = list
     end
-    
-    def execute_cli(argv=[])
+
+    def execute_cli(argv = [])
       doc = File.read docopt
       begin
-        args = Docopt::docopt(doc, argv: argv, version: version)
-        handle_subcommand args
-      rescue Docopt::Exit => e
+        @args = DocoptNG.docopt(doc, argv: argv, version: version)
+        handle_subcommand
+      rescue DocoptNG::Exit => e
         puts e.message
       end
     end
 
-    private
+  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 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(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.tr '_', '-'
+      method = method.tr  '-', '_'
+
+      [input, method]
     end
+
+    # Overridable Hooks
+
+    def before_execute; end
+    def after_execute; end
   end
-end
+end

data/lib/super_docopt/version.rb

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

metadata

@@ -1,128 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: super_docopt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-09 00:00:00.000000000 Z
+date: 2023-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: docopt
+  name: docopt_ng
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-- !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: 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: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-- !ruby/object:Gem::Dependency
-  name: require_all
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-description: Create command line applications with docopt
+        version: '0.7'
+description: Extension to docopt for defining command line utilities with ease
 email: db@dannyben.com
 executables: []
 extensions: []
@@ -135,7 +37,8 @@ files:
 homepage: https://github.com/DannyBen/super_docopt
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -144,16 +47,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
-summary: Docopt extension for easy command line applications
+summary: docopt-based command line utility builder
 test_files: []