giblish 0.8.2 → 1.0.0.rc2

data/scripts/wserv_development.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+#
+# Starts up a simple web server for local testing of generated documents.
+#
+# A typical dev flow:
+#
+# 1. Create your html docs using giblish
+# 2. If you want to enable text search, copy or symlink the `gibsearch.rb` script
+# from the giblish gem to the correct location under the target tree.
+# 3. Run this script to kick-off a web server that serves your html docs.
+
+require "webrick"
+require "webrick/cgi"
+
+# the root directory for the web server
+web_root = "#{__dir__}/html_docs"
+
+# the port the web server listens to
+port = 8000
+
+puts "Trying to start a WEBrick instance at port #{port} serving files from #{web_root}..."
+server = WEBrick::HTTPServer.new(
+  Port: port,
+  DocumentRoot: File.expand_path(web_root),
+  Logger: WEBrick::Log.new("webrick.log", WEBrick::Log::DEBUG)
+)
+
+puts "WEBrick instance now listening to localhost:#{port}"
+trap "INT" do
+  server.shutdown
+end
+server.start

data/web_apps/cgi_search/gibsearch.rb

@@ -0,0 +1,43 @@
+#!/home/andersr/.rbenv/shims/ruby
+## /usr/bin/env ruby
+# replace the line above with an absolute path to a ruby interpreter
+# if you don't want the system one.
+
+require "cgi"
+begin
+  # used when developping this script
+  require_relative "../gh_giblish/lib/giblish/search/request_manager"
+rescue LoadError
+  # used in deployment
+  require "giblish"
+end
+
+# Provide the mappings of URL paths that apply to the specific deployment
+# setup.
+#
+# The below example maps the URI www.exaple.com/ to the local directory
+# /home/andersr/repos/gendocs on the web server.
+URL_PATH_MAPPINGS = {
+  "/" => __dir__.to_s
+}
+
+# This is run for each CGI request.
+#
+# Exits with 0 for success, 1 for failure
+if __FILE__ == $PROGRAM_NAME
+  $stdout.sync = true
+
+  begin
+    cgi = CGI.new
+
+    # assemble the html response for a given search request
+    print cgi.header
+    print Giblish::RequestManager.new(URL_PATH_MAPPINGS).response(cgi)
+    0
+  rescue => e
+    print e.message
+    print "<br>"
+    print e.backtrace
+    1
+  end
+end

data/web_apps/gh_webhook_trigger/config.ru

@@ -0,0 +1,2 @@
+require "./gh_webhook_trigger"
+run Sinatra::Application

data/web_apps/gh_webhook_trigger/gh_webhook_trigger.rb

@@ -0,0 +1,73 @@
+# This app will trigger a document generation from a 'push' github webhook
+require "sinatra"
+require "json"
+require "pathname"
+require "logger"
+
+begin
+  # used during development/testing
+  require_relative "../../lib/giblish/github_trigger/webhook_manager"
+rescue LoadError
+  # used in production
+  require "giblish"
+end
+
+# setup a specific logger for requests
+accesslog_path = Pathname.new(__dir__).join("log/access.log")
+accesslog_path.dirname.mkpath
+access_logger = ::Logger.new(accesslog_path.to_s)
+
+# instantiate the one-and-only web-hook-manager
+DSTDIR = "/var/www/rillbert_se/html/public/giblish_examples/giblish"
+clone_dir = Dir.mktmpdir
+
+# setup the doc generation once-and-for-all
+doc_generator = Giblish::GenerateFromRefs.new(
+  "https://github.com/rillbert/giblish.git",
+  /main/,
+  clone_dir,
+  "giblish",
+  %W[-l debug -j data/],
+  ".",
+  DSTDIR,
+  access_logger
+)
+
+post "/" do
+  gh_data = JSON.parse(request.body.read, symbolize_names: true)
+  # access_logger.debug { "Calling webhook manager with data: #{gh_data}" }
+  doc_generator.docs_from_gh_webhook(gh_data)
+end
+
+get "/" do
+  ""
+end
+
+# class GenerateDocsFromGitHubHook < Sinatra::Base
+#   ::Logger.class_eval { alias_method :write, :<< }
+
+#   accesslog_path = Pathname.new(__dir__).join("../log/access.log")
+#   accesslog_path.dirname.mkpath
+#   access_logger = ::Logger.new(accesslog_path.to_s)
+
+#   errorlog_path = Pathname.new(__dir__).join("log/error.log")
+#   errorlog_path.dirname.mkpath
+#   error_logger = ::File.new(errorlog_path.to_s, "a+")
+#   error_logger.sync = true
+
+#   configure do
+#     use ::Rack::CommonLogger, access_logger
+#   end
+
+#   before {
+#     env["rack.errors"] = error_logger
+#   }
+
+#   # instantiate the one-and-only web-hook-manager
+#   wm = WebhookManager.new(/svg/, "https://github.com/rillbert/giblish.git", Dir.mktmpdir, "giblish", "docs", dstdir, error_logger)
+
+#   post "/payload" do
+#     gh_data = JSON.parse(request.body.read, symbolized_names: true)
+#     wm.run(gh_data)
+#   end
+# end

data/web_apps/gh_webhook_trigger/public/dummy.txt

@@ -0,0 +1,3 @@
+This file only exists to make git create the 'public' dir in which it resides.
+
+The 'public' dir, in turn, is needed when deploying the app to a passenger instance.

data/web_apps/sinatra_search/config.ru

@@ -0,0 +1,2 @@
+require "./sinatra_search"
+run Sinatra::Application

data/web_apps/sinatra_search/public/dummy.txt

@@ -0,0 +1,3 @@
+This file only exists to make git create the 'public' dir in which it resides.
+
+The 'public' dir, in turn, is needed when deploying the app to a passenger instance.

data/web_apps/sinatra_search/sinatra_search.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require "sinatra"
+begin
+  # used when developping this script
+  require_relative "../gh_giblish/lib/giblish/search/request_manager"
+rescue LoadError
+  # used in deployment
+  require "giblish"
+end
+
+# Provide the mappings of URI paths that apply to the specific deployment
+# setup.
+#
+# The below example maps the URL www.example.com/ to the local directory
+# /var/www/html/mydocs on the web server.
+URL_PATH_MAPPINGS = {
+  "/" => "/var/www/html/mydocs"
+}
+
+# instantiate the one-and-only manager for search requests.
+#
+# It implements caching of search data internally and this will be
+# wasted if a new instance were created for each search request.
+request_mgr = Giblish::RequestManager.new(URL_PATH_MAPPINGS)
+
+get "/gibsearch" do
+  # This call encapsulates the search and returns an html page
+  # with the search result.
+  #
+  # The search parameters of this request can be fetched from
+  # rack's environment.
+  request_mgr.response(request.env["rack.request.query_hash"])
+end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Anders Rillbert
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: oga
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.5
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: warning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +173,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.16
+        version: 2.0.17
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -113,21 +183,21 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.16
+        version: 2.0.17
 - !ruby/object:Gem::Dependency
   name: asciidoctor-diagram
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: asciidoctor-pdf
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +207,7 @@ dependencies:
         version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -147,7 +217,7 @@ dependencies:
         version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.6.2
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -200,71 +270,96 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/unit_tests.yml"
 - ".gitignore"
-- ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
-- Changelog
-- Gemfile
+- Changelog.adoc
 - LICENSE
 - README.adoc
-- Rakefile
-- bin/console
-- bin/setup
-- data/testdocs/malformed/no_header.adoc
-- data/testdocs/toplevel.adoc
-- data/testdocs/wellformed/adorned_purpose.adoc
-- data/testdocs/wellformed/docidtest/docid_1.adoc
-- data/testdocs/wellformed/docidtest/docid_2.adoc
-- data/testdocs/wellformed/simple.adoc
-- data/testdocs/wellformed/source_highlighting/highlight_source.adoc
-- docgen/resources/css/adoc-colony.css
-- docgen/resources/css/giblish.css
-- docgen/resources/fonts/Ubuntu-B.ttf
-- docgen/resources/fonts/Ubuntu-BI.ttf
-- docgen/resources/fonts/Ubuntu-R.ttf
-- docgen/resources/fonts/Ubuntu-RI.ttf
-- docgen/resources/fonts/mplus1p-regular-fallback.ttf
-- docgen/resources/images/giblish_logo.png
-- docgen/resources/images/giblish_logo.svg
-- docgen/resources/themes/giblish.yml
-- docgen/scripts/Jenkinsfile
-- docgen/scripts/gen_adoc_org.sh
-- docgen/scripts/githook_examples/post-update.example
-- docs/README.adoc
-- docs/setup_server.adoc
-- docs/setup_server_assets/Render Documents.png
-- docs/setup_server_assets/View Documents.png
-- docs/setup_server_assets/deploy_with_hooks.graphml
-- docs/setup_server_assets/deploy_with_hooks.svg
-- docs/setup_server_assets/deploy_with_jenkins.graphml
-- docs/setup_server_assets/deploy_with_jenkins.svg
-- docs/setup_server_assets/giblish_deployment.graphml
+- docs/concepts/text_search.adoc
+- docs/concepts/text_search_im/cgi-search_request.puml
+- docs/concepts/text_search_im/cgi-search_request.svg
+- docs/concepts/text_search_im/search_request.puml
+- docs/concepts/text_search_im/search_request.svg
+- docs/howtos/trigger_generation.adoc
+- docs/howtos/trigger_generation_im/Render Documents.png
+- docs/howtos/trigger_generation_im/View Documents.png
+- docs/howtos/trigger_generation_im/deploy_with_hooks.graphml
+- docs/howtos/trigger_generation_im/deploy_with_hooks.svg
+- docs/howtos/trigger_generation_im/deploy_with_jenkins.graphml
+- docs/howtos/trigger_generation_im/deploy_with_jenkins.svg
+- docs/howtos/trigger_generation_im/docgen_github.puml
+- docs/howtos/trigger_generation_im/giblish_deployment.graphml
+- docs/howtos/trigger_generation_im/post-receive-example.sh
+- docs/reference/box_flow_spec.adoc
+- docs/reference/search_spec.adoc
 - exe/giblish
 - giblish.gemspec
-- lib/giblish-search.cgi
 - lib/giblish.rb
+- lib/giblish/adocsrc_providers.rb
 - lib/giblish/application.rb
-- lib/giblish/buildgraph.rb
-- lib/giblish/buildindex.rb
 - lib/giblish/cmdline.rb
-- lib/giblish/core.rb
-- lib/giblish/docconverter.rb
-- lib/giblish/docid.rb
-- lib/giblish/docinfo.rb
-- lib/giblish/gititf.rb
-- lib/giblish/indexheadings.rb
+- lib/giblish/config_utils.rb
+- lib/giblish/configurator.rb
+- lib/giblish/conversion_info.rb
+- lib/giblish/docattr_providers.rb
+- lib/giblish/docid/docid.rb
+- lib/giblish/github_trigger/webhook_manager.rb
+- lib/giblish/gitrepos/checkoutmanager.rb
+- lib/giblish/gitrepos/gititf.rb
+- lib/giblish/gitrepos/gitsummary.erb
+- lib/giblish/gitrepos/gitsummaryprovider.rb
+- lib/giblish/gitrepos/history_pb.rb
+- lib/giblish/indexbuilders/d3treegraph.rb
+- lib/giblish/indexbuilders/depgraphbuilder.rb
+- lib/giblish/indexbuilders/dotdigraphadoc.rb
+- lib/giblish/indexbuilders/standard_index.erb
+- lib/giblish/indexbuilders/subtree_indices.rb
+- lib/giblish/indexbuilders/templates/circles.html.erb
+- lib/giblish/indexbuilders/templates/flame.html.erb
+- lib/giblish/indexbuilders/templates/tree.html.erb
+- lib/giblish/indexbuilders/templates/treemap.html.erb
+- lib/giblish/indexbuilders/verbatimtree.rb
 - lib/giblish/pathtree.rb
+- lib/giblish/resourcepaths.rb
+- lib/giblish/search/expand_adoc.rb
+- lib/giblish/search/headingindexer.rb
+- lib/giblish/search/request_manager.rb
+- lib/giblish/search/searchquery.rb
+- lib/giblish/search/textsearcher.rb
+- lib/giblish/subtreeinfobuilder.rb
+- lib/giblish/treeconverter.rb
 - lib/giblish/utils.rb
 - lib/giblish/version.rb
-- scripts/hooks/post-receive
-- scripts/publish_html.sh
+- scripts/hooks/post-receive.example
+- scripts/hooks/post-update.example
+- scripts/resources/css/adoc-colony.css
+- scripts/resources/css/giblish-serif.css
 - scripts/resources/css/giblish.css
+- scripts/resources/fonts/Ubuntu-B.ttf
+- scripts/resources/fonts/Ubuntu-BI.ttf
+- scripts/resources/fonts/Ubuntu-R.ttf
+- scripts/resources/fonts/Ubuntu-RI.ttf
+- scripts/resources/fonts/mplus1p-regular-fallback.ttf
+- scripts/resources/images/giblish_logo.png
+- scripts/resources/images/giblish_logo.svg
+- scripts/resources/themes/giblish.yml
+- scripts/wserv_development.rb
+- web_apps/cgi_search/gibsearch.rb
+- web_apps/gh_webhook_trigger/config.ru
+- web_apps/gh_webhook_trigger/gh_webhook_trigger.rb
+- web_apps/gh_webhook_trigger/public/dummy.txt
+- web_apps/sinatra_search/config.ru
+- web_apps/sinatra_search/public/dummy.txt
+- web_apps/sinatra_search/sinatra_search.rb
+- web_apps/sinatra_search/tmp/restart.txt
 homepage: https://github.com/rillbert/giblish
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/rillbert/giblish/issues
+  source_code_uri: https://github.com/rillbert/giblish
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -272,15 +367,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: A tool for publishing asciidoc docs stored in git repos
 test_files: []

data/.rubocop.yml

@@ -1,7 +0,0 @@
-
-AllCops:
-  TargetRubyVersion: 2.7
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-  Enabled: true

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
- - ruby

data/Changelog

@@ -1,16 +0,0 @@
-= giblish changelog
-
-== v0.7.0
-
- * *Breaking change* include the entire path in the -i and -j options
- * *Breaking change* change the meaning of the -w flag (and rename the long form to --web-path)
-   and add the -mp flag.
-   This was done as a means to remove the hard-coded arguments to the search box html so that one
-   can generate html docs to a destination that is not the same as the one where they are deployed
-   on a web server.
- * take the idprefix and idseparator into account when indexing sections for text search
- * Add the font awesome css as link to search box and use the magnifying glass icon
- * update README file
- * handle the case where a 'index.adoc' file exists by making the basename configurable using the
-   '--index-basename' flag.
- * update the dependencies to the latest asciidoctor-pdf release

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in giblish.gemspec
-gemspec

data/README.adoc

@@ -1 +0,0 @@
-./docs/README.adoc