mister_bin 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 544ea89862e3731beab20f7a6e180109377fbf4ee428dc87577f4315d9d4656e
-  data.tar.gz: b911335298d0939f37fd7c515c573f15f5b4a84b07935fa04bdce34427cb3bd3
+  metadata.gz: 6192a0143be968a6388eb8b0fe1947ab5fd804db1d27fcf4a1b111b609f949ec
+  data.tar.gz: 93a3970de6124eb6694a41c5a7bfa3f21011330971a49f796f133bf7723b721a
 SHA512:
-  metadata.gz: 9ada4970fd1a7a1de6ad509e537e97fe8a2544d6c1594205d0921e18988ce6a536d9c3e6833fd2817b1951efeb1808b4bd5484734860a8dcf3807bfd259df050
-  data.tar.gz: 4df60533f5e1935911e9827f742978583256841be72667da39b79586e58ba1ad8cdc87adce4e529ea0f626b70f44bef04d1b9fb3f82f40d0fe8a7691a0193f17
+  metadata.gz: a51dafe658b91c3995dac0e27cc4227151feb3386fe2505bd83d1a3bb5709ac521c892e241c9f3ec80962c96898924c97ad70143611f53b10bc2539ce38ad2bd
+  data.tar.gz: 7c95a181e368e35140594dbe483e3be8aa96bc2a282f678e79463459ca2d3ab40e7967f84ebbd9b2f2e57905b0d5ca0da628a1fe4cab981cebe1f1b68a916954

data/README.md

@@ -8,7 +8,7 @@ Mister Bin
 
 ---
 
-A command line framework for adding command line utilities to your gems.
+A command line framework for adding command line interface to your gems.
 
 ---
 
@@ -49,7 +49,7 @@ Design Goals
 Examples
 --------------------------------------------------
 
-See the [example](/example) folder for several example use cases.
+See the [examples](/examples) folder for several example use cases.
 
 
 
@@ -61,7 +61,7 @@ Creating a command line utility with Mister Bin involves at least two files:
 1. The main "bin" file. This is the actual executable, and if you are 
    developing a gem, this will be in the `bin` directory of your folder.
 2. One or more subcommand files. These files use the DSL, and will usually be
-   placed in your `lib/<your gem>/commands folder.
+   placed in your `lib/<your gem>/commands` folder.
 
 
 
@@ -206,6 +206,10 @@ usage "app ls --all"
 usage "app ls [--all]"
 usage "app new NAME"
 
+# Describe any subcommands
+command "ls", "Show list of files"
+command "new", "Pretend to create a new application"
+
 # Describe any flags
 option "--all", "Also show hidden files"
 option "-f --force", "Force delete"

data/lib/mister_bin/command.rb

@@ -42,6 +42,10 @@ module MisterBin
         maker.options << [flags, text]
       end
 
+      def command(name, text)
+        maker.commands << [name, text]
+      end
+
       def param(param, text)
         maker.params << [param, text]
       end

data/lib/mister_bin/docopt_maker.rb

@@ -7,7 +7,7 @@ module MisterBin
   class DocoptMaker
     include Colsole
 
-    attr_reader :usages, :options, :examples, :params, :env_vars
+    attr_reader :usages, :options, :examples, :params, :commands, :env_vars
     attr_accessor :summary, :help, :version
 
     def initialize
@@ -17,13 +17,14 @@ module MisterBin
       @usages   = []
       @options  = []
       @params   = []
+      @commands = []
       @examples = []
       @env_vars = []
     end
 
     def docopt
-      [summary_string, help_string, usage_string, options_string, 
-        params_string, env_string, examples_string].compact.join "\n"
+      [summary_string, help_string, usage_string, commands_string,
+        options_string, params_string, env_string, examples_string].compact.join "\n"
     end
 
     private
@@ -72,6 +73,11 @@ module MisterBin
       key_value_block 'Environment Variables:', env_vars
     end
 
+    def commands_string
+      return nil if commands.empty?
+      key_value_block 'Commands:', commands
+    end
+
     def examples_string
       return nil if examples.empty?
 

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-07 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -150,21 +150,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-description: Build pluggable and modular command line tools with subcommands
+description: Easily add command line interface to your gems
 email: db@dannyben.com
 executables: []
 extensions: []
@@ -199,5 +185,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Modular command line framefowk
+summary: Command line interface for your gems
 test_files: []