<commit_before>#
# Author:: <NAME> (<<EMAIL>>)
# Copyright:: Copyright (c) 2011 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

class Chef
  class Knife
    class Help < Chef::Knife

      banner "knife help [list|TOPIC]"

      def run
        if name_args.empty?
          ui.info "Usage: knife SUBCOMMAND (options)"
          ui.msg ""
          # This command is atypical, the user is likely not interested in usage of
          # this command, but knife in general. So hack the banner.
          opt_parser.banner = "General Knife Options:"
          ui.msg opt_parser.to_s
          ui.msg ""
          ui.info "For further help:"
          ui.info(<<-MOAR_HELP)
  knife help list             list help topics
  knife help knife            show general knife help
  knife help TOPIC            display the manual for TOPIC
  knife SUBCOMMAND --help     show the options for a command
MOAR_HELP
          exit 1
        else
          @query = name_args.join('-')
        end



        case @query
        when 'topics', 'list'
          print_help_topics
          exit 1
        when 'intro', 'knife'
          @topic = 'knife'
        else
          @topic = find_manpages_for_query(@query)
        end

        manpage_path = available_manpages_by_basename[@topic]
        exec "man #{manpage_path}"
      end

      def help_topics
        available_manpages_by_basename.keys.map {|c| c.sub(/^knife\-/, '')}.sort
      end

      def print_help_topics
        ui.info "Available help topics are: "
        help_topics.each do |topic|
          ui.msg "  #{topic}"
        end
      end

      def find_manpages_for_query(query)
        possibilities = available_manpages_by_basename.keys.select do |manpage|
          ::File.fnmatch("knife-#{query}*", manpage) || ::File.fnmatch("#{query}*", manpage)
        end
        if possibilities.empty?
          ui.error "No help found for '#{query}'"
          ui.msg ""
          print_help_topics
          exit 1
        elsif possibilities.size == 1
          possibilities.first
        else
          ui.info "Multiple help topics match your query. Pick one:"
          ui.highline.choose(*possibilities)
        end
      end

      def available_manpages_by_basename
        @available_manpages_by_basename ||= begin
          available_manpages = Dir[File.expand_path("../distro/common/man/man1/*1", CHEF_ROOT)]
          available_manpages.inject({}) do |map, manpath|
            map[::File.basename(manpath, '.1')] = manpath
            map
          end
        end
      end

    end
  end
end<commit_msg>CHEF-2316: Also search for knife man pages in FHS directories, and gziped there.<commit_after>#
# Author:: <NAME> (<<EMAIL>>)
# Copyright:: Copyright (c) 2011 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

class Chef
  class Knife
    class Help < Chef::Knife

      banner "knife help [list|TOPIC]"

      def run
        if name_args.empty?
          ui.info "Usage: knife SUBCOMMAND (options)"
          ui.msg ""
          # This command is atypical, the user is likely not interested in usage of
          # this command, but knife in general. So hack the banner.
          opt_parser.banner = "General Knife Options:"
          ui.msg opt_parser.to_s
          ui.msg ""
          ui.info "For further help:"
          ui.info(<<-MOAR_HELP)
  knife help list             list help topics
  knife help knife            show general knife help
  knife help TOPIC            display the manual for TOPIC
  knife SUBCOMMAND --help     show the options for a command
MOAR_HELP
          exit 1
        else
          @query = name_args.join('-')
        end



        case @query
        when 'topics', 'list'
          print_help_topics
          exit 1
        when 'intro', 'knife'
          @topic = 'knife'
        else
          @topic = find_manpages_for_query(@query)
        end

        manpage_path = available_manpages_by_basename[@topic]
        exec "man #{manpage_path}"
      end

      def help_topics
        available_manpages_by_basename.keys.map {|c| c.sub(/^knife\-/, '')}.sort
      end

      def print_help_topics
        ui.info "Available help topics are: "
        help_topics.each do |topic|
          ui.msg "  #{topic}"
        end
      end

      def find_manpages_for_query(query)
        possibilities = available_manpages_by_basename.keys.select do |manpage|
          ::File.fnmatch("knife-#{query}*", manpage) || ::File.fnmatch("#{query}*", manpage)
        end
        if possibilities.empty?
          ui.error "No help found for '#{query}'"
          ui.msg ""
          print_help_topics
          exit 1
        elsif possibilities.size == 1
          possibilities.first
        else
          ui.info "Multiple help topics match your query. Pick one:"
          ui.highline.choose(*possibilities)
        end
      end

      def available_manpages_by_basename
        @available_manpages_by_basename ||= begin
          available_manpages = Dir[File.expand_path("../distro/common/man/man1/knife-*1", CHEF_ROOT), "/usr/share/man/man1/knife-*{.1,.1.gz}"]
          available_manpages.inject({}) do |map, manpath|
            map[::File.basename(manpath).gsub(/.1.*/, '')] = manpath
            map
          end
        end
      end

    end
  end
end
{'fraction_non_alphanumeric': 0.09243302522324925, 'fraction_numerical': 0.006423311922293592, 'mean_word_length': 2.1386430678466075, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5495559', 'n_tokens_mistral': 1890, 'n_tokens_neox': 1846, 'n_words': 593}