Class: BitClust::Subcommands::StatichtmlCommand

# File 'lib/bitclust/subcommands/statichtml_command.rb', line 106

def initialize
  if Object.const_defined?(:Encoding)
    begin
      verbose, $VERBOSE = $VERBOSE, false
      Encoding.default_external = 'utf-8'
    ensure
      $VERBOSE = verbose
    end
  end
  super
  @verbose = true
  @catalogdir = nil
  @templatedir = srcdir_root + "data/bitclust/template.offline"
  @themedir = srcdir_root + "theme/default"
  @suffix = ".html"
  @gtm_tracking_id = nil
  @meta_robots_content = ["noindex"]
  @stop_on_syntax_error = true
  @eol_warning = false
  @run_ruby_wasm = nil
  @sitemap_baseurl = nil
  @sitemap_paths = []
  @parser.banner = "Usage: #{File.basename($0, '.*')} statichtml [options]"
  @parser.on('-o', '--outputdir=PATH', 'Output directory') do |path|
    begin
      @outputdir = Pathname.new(path).realpath
    rescue Errno::ENOENT
      FileUtils.mkdir_p(path, :verbose => @verbose)
      retry
    end
  end
  @parser.on('--catalog=PATH', 'Catalog directory') do |path|
    @catalogdir = Pathname.new(path).realpath
  end
  @parser.on('--templatedir=PATH', 'Template directory') do |path|
    @templatedir = Pathname.new(path).realpath
  end
  @parser.on('--themedir=PATH', 'Theme directory') do |path|
    @themedir = Pathname.new(path).realpath
  end
  @parser.on('--suffix=SUFFIX', 'Suffix for each (X)HTML file [.html]') do |suffix|
    @suffix = suffix
  end
  @parser.on('--fs-casesensitive', 'Filesystem is case-sensitive') do
    @fs_casesensitive = true
  end
  @parser.on('--canonical-base-url=URL', 'Canonical base URL') do |url|
    @canonical_base_url = url
  end
  @parser.on('--edit-base-url=URL', 'Edit base URL') do |url|
    @edit_base_url = url
  end
  @parser.on('--tracking-id=ID', 'Google Tag Manager Tracking ID') do |id|
    @gtm_tracking_id = id
  end
  @parser.on('--meta-robots-content=VALUE1,VALUE2,...', Array, 'HTML <meta> element: <meta name="robots" content="VALUE1,VALUE2..."') do |values|
    @meta_robots_content = values
  end
  @parser.on('--[no-]eol-warning', 'Show a warning banner that this Ruby version is no longer maintained') do |boolean|
    @eol_warning = boolean
  end
  @parser.on('--run-ruby-wasm=WASM_URL', 'Add a RUN button to Ruby sample code, executing it in-browser with the given ruby.wasm') do |url|
    @run_ruby_wasm = url
  end
  @parser.on('--sitemap-baseurl=URL', 'Generate sitemap.xml under the output directory, with <loc> built from this base URL (e.g. https://docs.ruby-lang.org/ja/3.4/). Omit to skip sitemap.xml generation (default)') do |url|
    @sitemap_baseurl = url
  end
  @parser.on('--no-stop-on-syntax-error', 'Do not stop on syntax error') do |boolean|
    @stop_on_syntax_error = boolean
  end
  @parser.on('--[no-]quiet', 'Be quiet') do |quiet|
    @verbose = !quiet
  end
end

Instance Method Details

#exec(argv, options) ⇒ `Object`

# File 'lib/bitclust/subcommands/statichtml_command.rb', line 181

def exec(argv, options)
  create_manager_config

  prefix = options[:prefix]
  db = MethodDatabase.new(prefix.to_s)
  fdb = FunctionDatabase.new(prefix.to_s)
  manager = ScreenManager.new(@manager_config)

  db.transaction do
    methods = {} #: Hash[String, Array[MethodEntry]]
    db.methods.each_with_index do |entry, i|
      next if entry.undefined?

      entry.names.each do |name|
        method_name = entry.klass.name + entry.typemark + name
        (methods[method_name] ||= []) << entry
      end
    end

    entries = db.docs + db.libraries.sort + db.classes.sort
    create_html_entries("entries", entries, manager, db)
    create_html_methods("methods", methods, manager, db)
  end

  fdb.transaction do
    create_html_entries("capi", fdb.functions, manager, fdb)
  end

  @urlmapper.bitclust_html_base = '..'
  library_index_path = @outputdir + "library/#{html_filename("index", @suffix)}"
  create_file(library_index_path,
              manager.library_index_screen(db.libraries.sort, {:database => db}).body,
              :verbose => @verbose)
  record_sitemap_path(library_index_path)
  class_index_path = @outputdir + "class/#{html_filename("index", @suffix)}"
  create_file(class_index_path,
              manager.class_index_screen(db.classes.sort, {:database => db}).body,
              :verbose => @verbose)
  record_sitemap_path(class_index_path)
  function_index_path = @outputdir + "function/#{html_filename("index", @suffix)}"
  create_file(function_index_path,
              manager.function_index_screen(fdb.functions.sort, { :database => fdb }).body,
              :verbose => @verbose)
  record_sitemap_path(function_index_path)
  create_index_html(@outputdir)
  create_search_index(@outputdir, db, fdb)
  if baseurl = @sitemap_baseurl
    create_sitemap(@outputdir, baseurl)
  end
  FileUtils.cp(@manager_config[:themedir] + @manager_config[:css_url],
               @outputdir.to_s, :verbose => @verbose, :preserve => true)
  FileUtils.cp(@manager_config[:themedir] + "syntax-highlight.css",
               @outputdir.to_s, :verbose => @verbose, :preserve => true)
  FileUtils.cp(@manager_config[:themedir] + "script.js",
               @outputdir.to_s, :verbose => @verbose, :preserve => true)
  copy_run_ruby_wasm_script if @run_ruby_wasm
  FileUtils.cp(@manager_config[:themedir] + @manager_config[:favicon_url],
               @outputdir.to_s, :verbose => @verbose, :preserve => true)
  Dir.mktmpdir do |tmpdir|
    FileUtils.cp_r(@manager_config[:themedir] + 'images', tmpdir,
                   :verbose => @verbose, :preserve => true)
    Dir.glob(File.join(tmpdir, 'images', '/**/.svn')).each do |d|
      FileUtils.rm_r(d, :verbose => @verbose)
    end
    FileUtils.cp_r(File.join(tmpdir, 'images'), @outputdir.to_s,
                   :verbose => @verbose, :preserve => true)
  end
end

Class: BitClust::Subcommands::StatichtmlCommand

Defined Under Namespace

Constant Summary

Constants included from NameUtils

Instance Method Summary collapse

Methods included from NameUtils

Methods inherited from BitClust::Subcommand

Constructor Details

#initialize ⇒ StatichtmlCommand

Instance Method Details

#exec(argv, options) ⇒ Object

#initialize ⇒ `StatichtmlCommand`

#exec(argv, options) ⇒ `Object`