cli-topic 0.9.9 → 0.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8986b30d5ff457c34632c6090c833f0228a273e5
-  data.tar.gz: 68ac8e7964bcc6c24026d614afe078e42124a458
+  metadata.gz: 9dd7bf15db7efd2aaa6f731dc05a2da91ad99531
+  data.tar.gz: 30f0feebf43a90dd6c6a5e1d479b31c67d428e41
 SHA512:
-  metadata.gz: 9d3b6cc8cc6565da5f9f31ce70ea2bba33753e3df607178146e1fa4e6c8f94c843c2feba589266bdaea1132699b3ab99efe214a737d4779fba769496616bc9b0
-  data.tar.gz: fb092adc4defb68231ea68cebabafac9cb0206e3010d55b921ef2fe8a4a408f223c474c78150fa9fda656d2e817dd7c3872b4f0c6b93681cd75ff7be3a30ecfd
+  metadata.gz: 3cfdfdbe05f0f6ae712cb49fe21067d0575400c35b376aadc634ff66b2e32d5bfeefbcf1481e4cbf61ca3f1a1394b44bc56f5b57a11fb6e450653e38c44227f5
+  data.tar.gz: 5df8e9e83e3607f051caa62fc08defcdf5b8e0b2ad890b47c60a7a283327c33f4b3309fef33fe40e41290312755b87e84db93fd6f63e64c9b4a26a991f3aca6c

data/lib/clitopic/command/base.rb

@@ -9,7 +9,7 @@ module Clitopic
       class << self
         include Clitopic::Parser::OptParser
         attr_accessor :name, :banner, :description, :hidden, :short_description
-        attr_accessor :arguments, :options
+        attr_accessor :arguments, :options, :inherited_options
 
         def cmd_options
           @cmd_options ||= []
@@ -19,6 +19,10 @@ module Clitopic
           @banner ||= "Usage: #{Clitopic.name} #{self.fullname} [options]"
         end
 
+        def inherited_options(*cmds)
+          @inherited_options ||= cmds
+        end
+
         def short_description
           if @short_description.nil?
             if description
@@ -98,22 +102,25 @@ module Clitopic
               cmd_defaults = defaults["commands"][self.name]
             end
           else
+
             if defaults.has_key?("topics") && defaults["topics"].has_key?(self.topic.name)
               cmd_defaults = defaults['topics'][self.topic.name][self.name]
               topic_opts = defaults['topics'][self.topic.name]['topic_options']
+              load_options(topic_opts)
+              if !cmd_defaults.nil?
+                load_options(cmd_defaults["options"])
+                if cmd_defaults["args"] && !arguments
+                  @arguments += Array(cmd_defaults["args"])
+                end
+              end
+              self.inherited_options.each do |cmd|
+                if defaults["topics"].has_key?(self.topic.name)
+                  cmd_opts = defaults['topics'][self.topic.name][cmd.to_s]
+                  load_options(cmd_opts["options"]) if !cmd_opts.nil?
+                end
+              end
             end
           end
-
-          load_options(topic_opts)
-
-          if cmd_defaults.nil?
-            return
-          end
-
-          load_options(cmd_defaults["options"])
-          if cmd_defaults["args"] && !arguments
-            @arguments += Array(cmd_defaults["args"])
-          end
         end
 
         def topic(arg=nil)

data/lib/clitopic/command/clito.rb

@@ -35,6 +35,9 @@ module Clitopic
       class << self
         def cmd_opts(cmd, opts)
           if cmd.cmd_options.size > 0 && (!cmd.hidden || options[:hidden])
+            cmd_comment = "#{cmd.name}$comment"
+            opts[cmd_comment] = {}
+            opts = opts[cmd_comment]
             opts[cmd.name] = {"options" => {}, "args" =>  []}
             cmd.cmd_options.each do |opt|
               opts[cmd.name]["options"][opt[:name].to_s] = opt[:default]
@@ -60,14 +63,16 @@ module Clitopic
           opts['topics'] = {}
           Clitopic::Topics.topics.each do |topic_name, topic|
             if (!topic.hidden || options[:hidden])
-              opts['topics'][topic_name] = {}
-              opts['topics'][topic_name]["topic_options"] = {} if topic.topic_options.size > 0
+              topic_comment = "#{topic_name}$comment"
+              opts['topics'][topic_comment] = {}
+              opts['topics'][topic_comment][topic_name] = {}
+              opts['topics'][topic_comment][topic_name]["topic_options"] = {} if topic.topic_options.size > 0
               topic.topic_options.each do |opt|
-                opts['topics'][topic_name]["topic_options"][opt[:name].to_s] = opt[:default]
+                opts['topics'][topic_comment][topic_name]["topic_options"][opt[:name].to_s] = opt[:default]
               end
               if topic.commands.size > 0
                 topic.commands.each do |c, cmd|
-                  cmd_opts(cmd, opts['topics'][topic_name])
+                  cmd_opts(cmd, opts['topics'][topic_comment][topic_name])
                 end
               end
             end
@@ -82,12 +87,37 @@ module Clitopic
             end
           end
           puts "write: #{file}"
+          yaml = opts.to_yaml
+
+          Clitopic::Topics.topics.each do |topic_name, topic|
+            yaml = yaml.gsub("#{topic_name}$comment:", topic_comment(topic))
+            if topic.commands.size > 0
+              topic.commands.each do |c, cmd|
+                yaml = yaml.gsub("#{c}$comment:", cmd_comment(cmd))
+              end
+            end
+
+          end
+
           File.open(file, 'wb') do  |file|
-            file.write(opts.to_yaml)
+            file.write(yaml)
           end
           return opts
         end
 
+        def topic_comment(topic)
+          "\n    # Topic: #{topic.name}\n" +
+          "    # #{topic.description.gsub("\n", "\n    # ")}"
+        end
+
+        def cmd_comment(cmd)
+          "\n        # #{cmd.fullname}\n" +
+          "        # #{cmd.short_description}"
+        end
+
+        def opt_comment(opt)
+          "# "
+        end
         def call
           puts @options
           if @arguments.size == 0

data/lib/clitopic/command/help.rb

@@ -8,18 +8,6 @@ module Clitopic
   end
 
   module Command
-    class Help2 < Clitopic::Command::Base
-      register name: 'help2',
-      description: "Display helps",
-      banner: "Display helps",
-      topic: "help"
-
-      option :all, "--all", "Display all topics with all commands"
-      option :topics, "--topics", "Display all availables topics"
-      option :topic, "--topic=TOPIC", "Display availables commands for the TOPIC"
-      option :with_hidden, "--with-hidden", "Include hidden commands/topics"
-    end
-
     class Help < Clitopic::Command::Base
       register name: 'index',
       banner: "Usage: #{Clitopic.name} help [COMMAND]",

data/lib/clitopic/helpers.rb

@@ -438,6 +438,7 @@ module Clitopic
     end
 
     def find_default_file
+      file = nil
       Clitopic.default_files.each do |f|
         if File.exist?(f)
           file = f

data/lib/clitopic/parser/option_parser.rb

@@ -30,14 +30,23 @@ module Clitopic
           parser.base.long.delete('version')
           process_options(parser, self.cmd_options)
 
-          if !self.topic.nil? && self.topic.topic_options.size > 0
-            parser.separator ""
-            parser.separator "Topic options:"
-            process_options(parser, self.topic.topic_options)
+          if !self.topic.nil?
+            self.inherited_options.each do |cmd|
+              cmd = self.topic.commands[cmd.to_s]
+              parser.separator ""
+              parser.separator "'#{cmd.fullname}' inherited options"
+              process_options(parser, cmd.cmd_options)
+            end
+
+            if self.topic.topic_options.size > 0
+              parser.separator ""
+              parser.separator "Topic options"
+              process_options(parser, self.topic.topic_options)
+            end
           end
 
           parser.separator ""
-          parser.separator "Common options:"
+          parser.separator "Common options"
           process_options(parser, Clitopic::Commands.global_options)
 
           # No argument, shows at tail.  This will print an options summary.

data/lib/clitopic/version.rb

@@ -1,3 +1,3 @@
 module Clitopic
-  VERSION = '0.9.9'
+  VERSION = '0.9.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli-topic
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 0.9.10
 platform: ruby
 authors:
 - Antoine Legrand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec