hammer_cli_experimental 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce65cc720807a281e46c4040d26602640d3387fa
+  data.tar.gz: b58b3bb257e583f7f75e455c4e8a38c83d9e4944
+SHA512:
+  metadata.gz: d2e54f0104b094effe7a5b540722f747231448cef746b77b4a102adf249cf8fd541a9b772562b99a4bc877f9892a996a6c21d7851d10fe8bde03da7f69d2b716
+  data.tar.gz: b8ed54a79984674b8574285f5194a5a5c1c46c1708fe07c5d5443cfbe8cc0d9e57bca5a35070f3416cf0b828683c35aed77df7a07ff0be0ab3d194fd8e00ccbc

data/README.md

@@ -0,0 +1,83 @@
+# Experimental features for Hammer CLI
+
+A hammer-cli plugin that contains features not mature enough to be merged into the core.
+
+If you have a prototype of a feature which is either not completely stable or you're not sure if it's interesting for users and worth finishing, this is the right place to keep such code. The repository is open for innovative ideas. The only rule is that it must be possible to turn the feature off in the configuration.
+
+
+## Current features
+
+### Config command
+
+A command for printing current hammer configuration. It can print config values split by the file it comes from or the final config mix.
+
+```
+$ hammer config -h
+Usage:
+    hammer config [OPTIONS]
+
+Options:
+ --paths                       Show only used paths
+ --show                        List final configuration
+ --show-by-path                List configurations from each of used files
+ -h, --help                    print help
+```
+
+You can turn it on by following setting:
+```yaml
+  # Enable config command
+  :enable_config_command: true
+```
+
+### Fuzzy matching of subcommands
+
+Enables using shortened versions of subcommend names as long as it matches only one subcommand.
+Eg. `hammer org list`.
+
+It also adds aliases of the most common commands:
+```
+index -> list
+show -> info
+destroy -> delete
+```
+
+You can turn it on by following setting:
+```yaml
+  # Enable fuzzy matching of subcommands
+  :enable_fuzzy_subcommands: true
+```
+
+### Enable full-help command
+
+Adds a command for printing help for all hammer commands. It supports either plaintext or markdown format.
+
+```
+$ hammer full-help -h
+Usage:
+    hammer full-help [OPTIONS]
+
+Options:
+ --md                          Format output in markdown
+ -h, --help                    print help
+
+```
+
+You can turn it on by following setting:
+```yaml
+  # Enable full-help command
+  :enable_full_help_command: true
+```
+
+### Condensed help
+
+Squeeze options that reference the same resource with different identifiers, eg. `--organization[-id|-label]`. Highly experimental.
+
+You can turn it on by following setting:
+```yaml
+  # Enable condensed help, highly experimental
+  :enable_help: true
+```
+
+## License
+
+This project is licensed under the GPLv3+.

data/config/experimental.yml

@@ -0,0 +1,15 @@
+:experimental:
+  # Enable/disable foreman commands
+  :enable_module: true
+
+  # Enable condensed help, highly experimental
+  :enable_help: false
+
+  # Enable config command
+  :enable_config_command: false
+
+  # Enable fuzzy matching of subcommands
+  :enable_fuzzy_subcommands: false
+
+  # Enable full-help command
+  :enable_full_help_command: false

data/lib/hammer_cli_experimental.rb

@@ -0,0 +1,9 @@
+require 'hammer_cli'
+
+module HammerCLIExperimental
+
+  require 'hammer_cli_experimental/help' if HammerCLI::Settings.get(:experimental, :enable_help)
+  require 'hammer_cli_experimental/config' if HammerCLI::Settings.get(:experimental, :enable_config_command)
+  require 'hammer_cli_experimental/subcommands' if HammerCLI::Settings.get(:experimental, :enable_fuzzy_subcommands)
+  require 'hammer_cli_experimental/full_help' if HammerCLI::Settings.get(:experimental, :enable_full_help_command)
+end

data/lib/hammer_cli_experimental/config.rb

@@ -0,0 +1,36 @@
+require 'hammer_cli/abstract'
+
+module HammerCLIExperimental
+  class ConfigCommand < HammerCLI::AbstractCommand
+
+    option '--paths', :flag, _("Show only used paths")
+    option '--show', :flag, _("List final configuration")
+    option '--show-by-path', :flag, _("List configurations from each of used files")
+
+    def validate_options
+      validator.one_of(:option_paths, :option_show, :option_show_by_path).required
+    end
+
+    def execute
+      if option_paths?
+        puts settings.path_history
+      elsif option_show?
+        puts settings.settings.to_yaml
+      elsif option_show_by_path?
+        settings.path_history.each do |cfg_file|
+          puts cfg_file
+          puts YAML::load(File.open(cfg_file)).to_yaml
+          puts
+        end
+      end
+      HammerCLI::EX_OK
+    end
+
+    protected
+    def settings
+      HammerCLI::Settings
+    end
+  end
+
+  HammerCLI::MainCommand.subcommand "config", _("Print current hammer config"), HammerCLIExperimental::ConfigCommand
+end

data/lib/hammer_cli_experimental/full_help.rb

@@ -0,0 +1,85 @@
+require 'hammer_cli/abstract'
+
+module HammerCLIExperimental
+  class FullHelpCommand < HammerCLI::AbstractCommand
+    option "--md", :flag, _("Format output in markdown")
+
+    def execute
+      @adapter = option_md? ? MDAdapter.new : TxtAdapter.new
+      print_heading
+      print_help
+      HammerCLI::EX_OK
+    end
+
+    private
+
+    def print_heading
+      @adapter.print_heading('Hammer CLI help')
+      @adapter.print_toc(HammerCLI::MainCommand)
+    end
+
+    def print_help(name='hammer', command=HammerCLI::MainCommand, desc='')
+      @adapter.print_command(name, desc, command.new(name).help)
+
+      command.recognised_subcommands.each do |sub_cmd|
+        print_help(@adapter.command_name(name, sub_cmd.names.first), sub_cmd.subcommand_class, sub_cmd.description)
+      end
+    end
+
+    class MDAdapter
+      def command_name(parent, command_name)
+        "#{parent} #{command_name}"
+      end
+
+      def print_command(name, description, help)
+        print_heading(name, name.split.length)
+        puts description
+        puts
+        puts "```"
+        puts help
+        puts "```"
+        puts
+      end
+
+      def print_toc(cmd)
+        names = cmd.recognised_subcommands.collect do |sub_cmd|
+          sub_cmd.names[0]
+        end
+        names.sort.each do |name|
+          puts "- [%s](#hammer-%s)" % [name, name.gsub(' ', '-')]
+        end
+        puts
+      end
+
+      def print_heading(text, level=1)
+        puts '#'*level + ' ' + text
+      end
+    end
+
+
+    class TxtAdapter
+      def command_name(parent, command_name)
+        "#{parent} > #{command_name}"
+      end
+
+      def print_command(name, description, help)
+        print_heading(name, 2)
+        puts description
+        puts
+        puts help
+        puts
+      end
+
+      def print_toc(cmd)
+      end
+
+      def print_heading(text, level=1)
+        ch = (level > 1) ? '-' : '='
+        puts text
+        puts ch * text.length
+      end
+    end
+  end
+
+  HammerCLI::MainCommand.subcommand "full-help", _("Print help for all hammer commands"), HammerCLIExperimental::FullHelpCommand
+end

data/lib/hammer_cli_experimental/help.rb

@@ -0,0 +1,143 @@
+require 'colorize'
+
+module HammerCLIExperimental
+
+  class CondensedBuilder < HammerCLI::Help::Builder
+
+    def default_label_indent
+      29
+    end
+
+    def add_list(heading, items)
+      if is_option_list?(items)
+        add_option_list(heading, items)
+      else
+        super
+      end
+    end
+
+    def add_option_list(heading, items)
+      collect_squeezable_names(items)
+
+      items = squeeze_option_flags(items)
+      items.sort! do |a, b|
+        a[0] <=> b[0]
+      end
+
+      puts
+      heading(heading)
+
+      label_width = default_label_indent
+      items.each do |item|
+        label, description = item
+        label_width = label.size if label.size > label_width
+      end
+
+      items.each do |item|
+        label, description = item
+        description.each_line do |line|
+          puts " %-#{label_width}s %s" % [label, line]
+          label = ''
+        end
+      end
+    end
+
+    private
+
+    STATIC_RESOURCES = [
+      'owner',
+      'puppet_class'
+    ]
+
+    def collect_squeezable_names(items)
+      @squeezable_names = items.map do |i|
+        i.referenced_resource if i.respond_to? :referenced_resource
+      end.compact
+      @squeezable_names += STATIC_RESOURCES
+      @squeezable_names = @squeezable_names.uniq
+    end
+
+    attr_reader :squeezable_names
+
+    def squeeze_option_flags(items)
+      help_items = []
+      squeezable_names.each do |resource_name|
+        selected = select_options_for_resource(resource_name, items)
+        next if selected.empty?
+        items -= selected
+        help_items += squeezed_help(selected)
+      end
+      help_items += items.map do |i|
+        [i.help[0], i.help[1].capitalize] if !is_squeezable?(i)
+      end.compact
+      help_items
+    end
+
+    def select_options_for_resource(resource_name, options)
+      result = options.select { |opt| opt.respond_to?(:referenced_resource) && (opt.referenced_resource == resource_name) }
+      if result.count <= 1
+        result = options.select { |opt| opt.switches[0].start_with?("--#{resource_name.gsub('_', '-')}") }
+        result.each { |opt| opt.referenced_resource = resource_name }
+      end
+      result
+    end
+
+    def squeezed_help(options)
+      prefix = common_prefix(options.map { |opt| opt.switches[0] })
+      if prefix == '--'
+        # return help for the original options when there's no common prefix
+        return options.map { |opt| [opt.help[0], opt.help[1]] }
+      end
+
+      appendix_items = options.map do |opt|
+        opt.switches[0][prefix.length, opt.switches[0].length]
+      end
+      appendix_items = appendix_items.select { |i| !i.empty? }
+
+      if !appendix_items.empty?
+        appendix = ('[' + appendix_items.join('|') + ']').yellow
+        # length of colors gets calculated wrong, we need padding to workaround the problem
+        padding = ' ' * 14
+      end
+
+      resource_name = options[0].referenced_resource
+      if options.find{|opt| opt.type.end_with?('_IDS')}
+        resource_name = ApipieBindings::Inflector.pluralize(resource_name)
+      end
+
+      # TODO: translate the description
+      type = resource_name.upcase
+      desc = resource_name.gsub('_', ' ').capitalize
+
+      [["#{prefix}#{appendix} #{type}", "#{padding}#{desc}"]]
+    end
+
+    def common_prefix(items)
+      shortest_length = items.map(&:length).min
+      i = 0
+      while (i < shortest_length) && chars_equal(i, items)
+        i += 1
+      end
+      items[0][0, i]
+    end
+
+    def chars_equal(index, items)
+      items.map {|i| i[index] }.uniq.length == 1
+    end
+
+    def is_squeezable?(item)
+      item.respond_to?(:referenced_resource) && item.referenced_resource
+    end
+
+    def is_option_list?(items)
+      (items.size > 0) && (items[0].is_a?(Clamp::Option::Definition))
+    end
+  end
+end
+
+
+class HammerCLI::AbstractCommand
+  def help
+    self.class.help(invocation_path, HammerCLIExperimental::CondensedBuilder.new(context[:is_tty?]))
+  end
+end

data/lib/hammer_cli_experimental/subcommands.rb

@@ -0,0 +1,29 @@
+require 'hammer_cli/abstract'
+
+module HammerCLIExperimental
+  module Subcommands
+    def find_subcommand(name)
+      subcommand = super
+      if subcommand.nil?
+        case name
+        when 'index'
+          name = 'list'
+        when 'show'
+          name = 'info'
+        when 'destroy'
+          name = 'delete'
+        end
+        find_subcommand_starting_with(name)
+      else
+        subcommand
+      end
+    end
+
+    def find_subcommand_starting_with(name)
+      subcommands = recognised_subcommands.select { |sc| sc.names.any? { |n| n.start_with?(name) } }
+      subcommands[0] if subcommands.length == 1
+    end
+  end
+end
+
+HammerCLI::AbstractCommand.extend(HammerCLIExperimental::Subcommands)

data/lib/hammer_cli_experimental/version.rb

@@ -0,0 +1,5 @@
+module HammerCLIExperimental
+  def self.version
+    @version ||= Gem::Version.new '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: hammer_cli_experimental
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomáš Strachota
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hammer_cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Experimental extensions for Hammer CLI
+
+'
+email: tstracho@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- config/experimental.yml
+- lib/hammer_cli_experimental.rb
+- lib/hammer_cli_experimental/config.rb
+- lib/hammer_cli_experimental/full_help.rb
+- lib/hammer_cli_experimental/help.rb
+- lib/hammer_cli_experimental/subcommands.rb
+- lib/hammer_cli_experimental/version.rb
+homepage: http://github.com/tstrachota/hammer-cli-experimental
+licenses:
+- GPL v3+
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Experimental extensions for Hammer CLI
+test_files: []