rdoc_link_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b94d42c261eb84ddd04c063fd2adb05dd3a84c0c1a5281540545d540d87e27a2
+  data.tar.gz: c4df711a4faabaae888035a39751cfeb6d1415543e6e7193b4684d1ed540ee39
+SHA512:
+  metadata.gz: 5cf3da9b90b3755982225d76dd2d09362244e52757cfbe525160ec466434b107219ba5163e37e2f929ee3844eae8745623cb5140fe7c43b31d3368832e51674e
+  data.tar.gz: 648016fdcb4e10796a740d06a170b47b43211f460dfddf114973eaa9f0a3612a376fa6df93d1c608f20cd23f44cf6c2904b05b0e2d5727c098335197d38206be

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+pkg

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rdoc_link_checker.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# RDoc Link Checker
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+# 
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task default: :test

data/bin/rdoc_link_checker

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'getoptlong'
+require_relative '../lib/rdoc_link_checker'
+
+options = GetoptLong.new(
+  ['--html_dirpath', '-d', GetoptLong::REQUIRED_ARGUMENT],
+  ['--version', '-v', GetoptLong::NO_ARGUMENT],
+  ['--help', '-h', GetoptLong::NO_ARGUMENT]
+)
+
+message = nil
+case ARGV.size
+when 0
+  message = "Expected one argument; got none."
+when 1
+  # Okay.
+else
+  message = "Expected one argument, not #{ARGV.inspect}."
+end
+raise ArgumentError.new(message) if message
+
+def help
+  puts 'Boo!'
+end
+
+def version
+  puts RDocLinkChecker::VERSION
+end
+
+options.each do |option, argument|
+  case option
+  when '--help'
+    help
+  when '--version'
+    version
+  end
+end
+
+html_dirpath = ARGV[0]
+RDocLinkChecker.new(html_dirpath)

data/lib/rdoc_link_checker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class RDocLinkChecker
+  VERSION = "0.1.0"
+end

data/lib/rdoc_link_checker.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'rdoc_link_checker/version'
+
+class RDocLinkChecker
+
+  def initialize(html_dirpath)
+    puts html_dirpath
+  end
+
+  class Error < StandardError; end
+
+end

data/rdoc_link_checker.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rdoc_link_checker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rdoc_link_checker'
+  spec.version       = RDocLinkChecker::VERSION
+  spec.authors       = ['burdettelamar']
+  spec.email         = ['burdettelamar@yahoo.com']
+  spec.summary       = 'Tool to check links in RDoc-generated HTML files.'
+  spec.homepage      = 'https://github.com/BurdetteLamar/rdoc_link_checker'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  #   spec.metadata['allowed_push_host'] = "http://rubygems.org"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['rdoc_link_checker']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.3.2'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: rdoc_link_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- burdettelamar
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description:
+email:
+- burdettelamar@yahoo.com
+executables:
+- rdoc_link_checker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rdoc_link_checker
+- lib/rdoc_link_checker.rb
+- lib/rdoc_link_checker/version.rb
+- rdoc_link_checker.gemspec
+homepage: https://github.com/BurdetteLamar/rdoc_link_checker
+licenses:
+- MIT
+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: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Tool to check links in RDoc-generated HTML files.
+test_files: []