From a6499d11b54cb0aee8244ecc248161d8840b85b5 Mon Sep 17 00:00:00 2001 From: Ryan Davis Date: Mon, 2 Oct 2023 10:33:41 -0800 Subject: [PATCH] Get back to 100% doco coverage. [git-p4: depot-paths = "//src/hoe/dev/": change = 13935] --- lib/hoe.rb | 6 +++--- lib/hoe/compiler.rb | 4 ++++ lib/hoe/debug.rb | 6 +++--- lib/hoe/gemcutter.rb | 3 +++ lib/hoe/package.rb | 2 +- lib/hoe/publish.rb | 2 +- lib/hoe/rake.rb | 4 ++-- lib/hoe/rdoc.rb | 4 ++-- 8 files changed, 19 insertions(+), 12 deletions(-) diff --git a/lib/hoe.rb b/lib/hoe.rb index ec55dbc..45bc4e9 100644 --- a/lib/hoe.rb +++ b/lib/hoe.rb @@ -909,7 +909,7 @@ def validate_fields end end - def skip_intuit_values? + def skip_intuit_values? # :nodoc: %w[summary description homepage].all? { |field| send field } end @@ -933,7 +933,7 @@ def with_config yield config, rc end - def maybe_load_yaml path + def maybe_load_yaml path # :nodoc: if File.exist? path then if YAML.respond_to? :safe_load_file then YAML.safe_load_file path, permitted_classes: [Regexp, Symbol] @@ -946,7 +946,7 @@ def maybe_load_yaml path end end -class File +class File # :nodoc: # Like File::read, but strips out a BOM marker if it exists. def self.read_utf path r19 = "<3".respond_to? :encoding diff --git a/lib/hoe/compiler.rb b/lib/hoe/compiler.rb index 8736bb6..cb940b5 100644 --- a/lib/hoe/compiler.rb +++ b/lib/hoe/compiler.rb @@ -37,6 +37,10 @@ def activate_compiler_deps warn "Couldn't load rake-compiler. Skipping. Run `rake newb` to fix." end + ## + # Declare a compiler extension, expecting ext/NAME/extconf.rb to + # exist. + def extension name @extensions ||= [] @extensions << name diff --git a/lib/hoe/debug.rb b/lib/hoe/debug.rb index 7f36233..8a4fdbe 100644 --- a/lib/hoe/debug.rb +++ b/lib/hoe/debug.rb @@ -97,10 +97,10 @@ def check_manifest end end -class Gem::Specification < Gem::BasicSpecification - alias old_ruby_code ruby_code +class Gem::Specification < Gem::BasicSpecification # :nodoc: + alias old_ruby_code ruby_code # :nodoc: - def ruby_code(obj) + def ruby_code(obj) # :nodoc: old_ruby_code obj rescue Gem::Exception => e case e.message diff --git a/lib/hoe/gemcutter.rb b/lib/hoe/gemcutter.rb index 851d11c..e00a8c3 100644 --- a/lib/hoe/gemcutter.rb +++ b/lib/hoe/gemcutter.rb @@ -12,6 +12,9 @@ module Hoe::Gemcutter Hoe::DEFAULT_CONFIG["otp_command"] = false + ## + # Push gems to server. + def gem_push gems with_config do |config, _| otp_command = config["otp_command"] diff --git a/lib/hoe/package.rb b/lib/hoe/package.rb index 1f1461d..462b0a0 100644 --- a/lib/hoe/package.rb +++ b/lib/hoe/package.rb @@ -4,7 +4,7 @@ # rake/gempackagetask will go away some day warn "It has happened... rubygems/package_task is gone!" require "rake/gempackagetask" - Gem::PackageTask = Rake::GemPackageTask + Gem::PackageTask = Rake::GemPackageTask # :nodoc: end ## diff --git a/lib/hoe/publish.rb b/lib/hoe/publish.rb index c5f34a8..cc2fe4b 100644 --- a/lib/hoe/publish.rb +++ b/lib/hoe/publish.rb @@ -301,7 +301,7 @@ class ::Rake::SshDirPublisher # :nodoc: attr_reader :host, :remote_dir, :local_dir end -class String +class String # :nodoc: ## # Very basic munge from rdoc to markdown format. diff --git a/lib/hoe/rake.rb b/lib/hoe/rake.rb index 8cc5744..a5a0e1c 100644 --- a/lib/hoe/rake.rb +++ b/lib/hoe/rake.rb @@ -1,5 +1,5 @@ module Rake - class Task + class Task # :nodoc: # Used to name the source of a given task attr_accessor :plugin # :stopdoc: @@ -29,7 +29,7 @@ def clear_comments # :nodoc: end end - module TaskManager + module TaskManager # :nodoc: ## # This gives us access to the tasks already defined in rake. def all_tasks diff --git a/lib/hoe/rdoc.rb b/lib/hoe/rdoc.rb index 9d91310..6e9dac7 100644 --- a/lib/hoe/rdoc.rb +++ b/lib/hoe/rdoc.rb @@ -2,12 +2,12 @@ # RDoc plugin for hoe. Switches default text files to rdoc. module Hoe::Rdoc - def initialize_rdoc + def initialize_rdoc # :nodoc: self.readme_file = self.readme_file.sub(/\.txt$/, ".rdoc") self.history_file = self.history_file.sub(/\.txt$/, ".rdoc") end - def define_rdoc_tasks + def define_rdoc_tasks # :nodoc: # do nothing end end