dracula 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 105767f9511af2b406e866d652c810d6b9a3e734
-  data.tar.gz: e1c88ed8c217c5458732e53da8e8a15bc1fefd8b
+  metadata.gz: fe10f1e79a3051535e035ed137b1c942074d57c2
+  data.tar.gz: 95c3e7dde4bcce0352411762a6d4d52daa1f213a
 SHA512:
-  metadata.gz: 53bfea42517a3343f1139fa6d4b36e8cf629c26aca1248fa4979a8e176dadd88399eaf49426ccc5c51202eab6a340f8d5058d6641fba804d4a46efb78bbd9ed5
-  data.tar.gz: 5ac02d97b818751fbdc2e592e0350aa1ff05b5ccac8075e6ad47dc75e457ceec65b5d031a19faeb003a8b92a022294ca18a88cbf2d7d094dbb17c13aa67fc10d
+  metadata.gz: 6daca3596bef3115a8749c3e868de3cb0b33b3d3ab851bbbcf395d2463a13ce11f3e3051fd14ee3b33a3a6aeb1cb11e03e52ecc1b63363eac7e231b5d52442b6
+  data.tar.gz: 86ff8358a768d0718580645af64705cae2f40153a011517a4b20de66babb26f6ca8e852541545bd408c1929c1725ca554e3bf397c67d776b5542cf5a7b3bb72a

data/README.md

@@ -19,7 +19,7 @@ app calendar:events:list
 app calendar:events:add
 ```
 
-For help, you can always invoke:
+For help, you can run:
 
 ``` txt
 app help <command-name>
@@ -208,6 +208,85 @@ $ cli greetings:bye
 Bye!
 ```
 
+## Generating JSON structure from your interface
+
+Dracula allows you to generate documentation based on the interface you have
+defined in your code. The output is a hash.
+
+An example output generated from the [example CLI interface](spec/example_cli.rb)
+is the following:
+
+``` ruby
+CLI.docs
+
+=>
+
+{
+  :name => "",
+
+  :commands => [
+    {
+      :name => "login",
+      :desc => "Log in to the cli",
+      :long_desc => "Log in to the app from the command line.\n",
+      :shell => "git login --username USERNAME --password PASSWORD",
+      :options => [
+        { :name => "username", :required => true,  :type => "string",  :alias => "u", :default => nil },
+        { :name => "password", :required => true,  :type => "string",  :alias => "p", :default => nil },
+        { :name => "verbose",  :required => false, :type => "boolean", :alias => "v", :default => false }
+      ]
+    }
+  ],
+
+  :namespaces => [
+    :name => "teams",
+
+    :commands => [
+      {
+        :name => "list",
+        :long_desc => "",
+        :desc => "List teams in an organization",
+        :shell => "git teams:list ORG",
+        :options => []
+      },
+      {
+        :name => "info",
+        :long_desc => "",
+        :desc => "Show info for a team",
+        :shell => "git teams:info TEAM",
+        :options => []
+      }
+    ],
+
+    :namespaces => [
+      :name => "projects",
+
+      :commands => [
+        {
+          :name => "add",
+          :long_desc => "",
+          :desc => "Add a project to the team",
+          :shell => "git teams:projects:add TEAM PROJECT",
+          :options => []
+        },
+        {
+          :name => "list",
+          :desc => "List projects in a team",
+          :long_desc => "",
+          :shell => "git teams:projects:list TEAM",
+          :options => []
+        }
+      ],
+
+      :namespaces => []
+    ]
+  ]
+}
+```
+
+The output should be suitable for generating markdown or html documentation for
+your CLI.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then,
@@ -232,3 +311,4 @@ of conduct.
 
 The gem is available as open source under the terms of
 the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/dracula.rb

@@ -8,6 +8,7 @@ class Dracula
   require "dracula/command_help"
   require "dracula/namespace"
   require "dracula/namespace_help"
+  require "dracula/structure"
 
   class << self
     def program_name(name = nil)
@@ -41,6 +42,10 @@ class Dracula
       end
     end
 
+    def structure
+      Dracula::Structure.new(namespace).generate
+    end
+
     def namespace
       @namespace ||= Dracula::Namespace.new(self)
     end

data/lib/dracula/command.rb

@@ -30,6 +30,10 @@ class Dracula
       desc.name
     end
 
+    def description
+      desc.description
+    end
+
     def arguments
       @klass.instance_method(@method_name).parameters.select { |p| p[0] == :req }.map { |p| p[1].to_s.upcase }
     end

data/lib/dracula/structure.rb

@@ -0,0 +1,54 @@
+class Dracula
+  class Structure
+
+    attr_reader :namespace
+
+    def initialize(namespace)
+      @namespace = namespace
+    end
+
+    def generate
+      {
+        :name => namespace.name.to_s,
+        :commands => @namespace.commands.map { |cmd| command_docs(cmd) },
+        :namespaces => @namespace.subcommands.map { |sc| Dracula::Structure.new(sc).generate }
+      }
+    end
+
+    private
+
+    def command_docs(command)
+      {
+        :name => command.name,
+        :desc => command.description,
+        :long_desc => command.long_desc.to_s,
+        :shell => command_shell(command),
+        :options => command.options.map do |option|
+          {
+            :name => option.name.to_s,
+            :required => option.required?,
+            :type => option.type.to_s,
+            :alias => option.alias_name,
+            :default => option.default_value
+          }
+        end
+      }
+    end
+
+    # shows how to calll the command from the shell
+    def command_shell(command)
+      args = command.arguments.join(" ")
+      options = command.options.select(&:required?).map(&:long_name_banner).join(" ")
+
+      elements = [
+        Dracula.program_name,
+        command.full_name,
+        args,
+        options
+      ]
+
+      elements.select { |element| element != "" }.join(" ")
+    end
+
+  end
+end

data/lib/dracula/version.rb

@@ -1,3 +1,3 @@
 class Dracula
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dracula
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Igor Šarčević
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-05 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ files:
 - lib/dracula/flag.rb
 - lib/dracula/namespace.rb
 - lib/dracula/namespace_help.rb
+- lib/dracula/structure.rb
 - lib/dracula/ui.rb
 - lib/dracula/version.rb
 homepage: https://github.com/renderedtext/dracula