doc-server 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac93e957d56ac323cb0e4d4ce7257ddc0b8b4c6f75a194f1bffefea97bd25cc4
+  data.tar.gz: 7b989ee4a5b4627c94f06fd2903908c3543b524ecfd13b5759fa24c3479ae9d5
+SHA512:
+  metadata.gz: ed294656bf719e0f5f9f0cbf0ee69c169bde681dabacc32c0bc5a9b5335bc39b9899f19580cf84406c0fc8c99e91a1cf114c16631a5884bfd79fde43a538b314
+  data.tar.gz: a24cf13e68d9cb42f7e1b4d83e5609e9414fe35779050103241f76cc150451f31a73a5d466baff0521519cfeb05223b60068cc966dbaadb52a953e8c5d8df43e

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+gem "test-unit"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Daniel Heath
+
+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,30 @@
+# doc-server
+
+doc-server provides gem rdoc, filtered to only the gems installed by your gemfile.
+
+It's inspired by https://github.com/rubygems/rubygems-server and the now-defunct `godoc -http`.
+
+##  Installation & usage
+
+```
+echo "gem 'doc-server'" >> Gemfile
+bundle
+bundle exec doc-server
+```
+
+This will create a directory (default='rdoc') to store the per-bundle documentation.
+
+Whenever you install or update gems, delete this directory, and restart doc-server.
+
+## Configuration
+
+DOCSERVER_OUTPUT_PATH: Where to store the per-bundle documentation. Default is "rdoc".
+DOCSERVER_PORT: Which port to listen on. Default is 8088.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/danielheath/doc-server.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/bin/doc-server

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rdoc/rdoc'
+
+outpath = ENV.fetch('DOCSERVER_OUTPUT_PATH', 'rdoc')
+port = ENV.fetch("DOCSERVER_PORT", "8088").to_i
+port = 8088 if port <= 0
+
+if ! Dir.exist?(outpath)
+  Dir.mkdir(outpath)
+  File.write("#{outpath}/created.rid", '')
+  options = RDoc::Options.new
+  options.setup_generator "darkfish"
+  options.op_dir = outpath
+
+  options.files = $LOAD_PATH.map {|p| Dir.glob("#{p}/**/*.rb")}.flatten
+  rdoc = RDoc::RDoc.new
+  rdoc.document options
+end
+
+require 'webrick'
+
+s = WEBrick::HTTPServer.new(:Port => port, :DocumentRoot => outpath)
+trap('INT') { s.shutdown }
+s.start

data/doc-server.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "doc-server"
+  spec.version = "0.0.1"
+  spec.authors = ["Daniel Heath"]
+  spec.email = ["daniel@heath.cc"]
+
+  spec.summary = "Serves documentation for installed gems locally on HTTP, with full text search"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/danielheath/doc-server"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "bin"
+  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.add_dependency "webrick"
+  spec.add_dependency "rack"
+  spec.add_dependency "parser"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: doc-server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Heath
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+- !ruby/object:Gem::Dependency
+  name: parser
+  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: Serves documentation for installed gems locally on HTTP, with full text
+  search
+email:
+- daniel@heath.cc
+executables:
+- doc-server
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/doc-server
+- doc-server.gemspec
+- lib/doc-server.rb
+homepage: https://github.com/danielheath/doc-server
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/danielheath/doc-server
+  source_code_uri: https://github.com/danielheath/doc-server
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Serves documentation for installed gems locally on HTTP, with full text search
+test_files: []