giblish 0.8.2 → 1.0.0.rc2

data/lib/giblish/core.rb

@@ -1,451 +0,0 @@
-require "find"
-require "fileutils"
-require "logger"
-require "pathname"
-
-require_relative "buildindex"
-require_relative "docconverter"
-require_relative "docid"
-require_relative "indexheadings"
-require_relative "docinfo"
-require_relative "buildgraph"
-
-module Giblish
-  # Parse a directory tree and convert all asciidoc files matching the
-  # supplied critera to the supplied format
-  class FileTreeConverter
-    attr_reader :converter
-
-    # Required options:
-    #  srcDirRoot
-    #  dstDirRoot
-    #  resourceDir
-    def initialize(options)
-      @options = options.dup
-
-      @paths = Giblish::PathManager.new(
-        @options[:srcDirRoot],
-        @options[:dstDirRoot],
-        @options[:resourceDir],
-        @options[:makeSearchable]
-      )
-
-      # set the path to the search data that will be sent to the cgi search script
-      deploy_search_path = if @options[:makeSearchable]
-                             if @options[:searchAssetsDeploy].nil?
-                               @paths.search_assets_abs
-                             else
-                               Pathname.new(@options[:searchAssetsDeploy]).join("search_assets")
-                             end
-                           end
-
-      @deploy_info = Giblish::DeploymentPaths.new(
-        @options[:webPath],
-        deploy_search_path
-      )
-      @processed_docs = []
-      @converter = converter_factory
-    end
-
-    # convert all adoc files
-    # return true if all conversions went ok, false if at least one
-    # failed
-    def convert
-      # collect all doc ids and enable replacement of known doc ids with
-      # valid references to adoc files
-      manage_doc_ids if @options[:resolveDocid]
-
-      # register add-on for handling searchability
-      manage_searchability(@options) if @options[:makeSearchable]
-
-      # traverse the src file tree and convert all files deemed as
-      # adoc files
-      conv_error = false
-      if @paths.src_root_abs.directory?
-        Find.find(@paths.src_root_abs) do |path|
-          p = Pathname.new(path)
-          begin
-            to_asciidoc(p) if adocfile? p
-          rescue StandardError => e
-            str = String.new("Error when converting file "\
-                             "#{path}: #{e.message}\nBacktrace:\n")
-            e.backtrace.each { |l| str << "   #{l}\n" }
-            Giblog.logger.error { str }
-            conv_error = true
-          end
-        end
-      end
-
-      # create necessary search assets if needed
-      create_search_assets if @options[:makeSearchable]
-
-      # build index and other fancy stuff if not suppressed
-      unless @options[:suppressBuildRef]
-        # build a dependency graph (only if we resolve docids...)
-        dep_graph_exist = @options[:resolveDocid] && build_graph_page
-
-        # build a reference index
-        build_index_page(dep_graph_exist)
-      end
-      conv_error
-    end
-
-    protected
-
-    def build_graph_page
-      begin
-        adoc_logger = Giblish::AsciidoctorLogger.new Logger::Severity::WARN
-        gb = graph_builder_factory
-        errors = @converter.convert_str(
-          gb.source(make_searchable: @options[:makeSearchable]),
-          @paths.dst_root_abs,
-          "graph",
-          logger: adoc_logger
-        )
-        gb.cleanup
-        !errors
-      rescue StandardError => e
-        Giblog.logger.warn { e.message }
-        Giblog.logger.warn { "The dependency graph will not be generated !!" }
-      end
-      false
-    end
-
-    def build_index_page(dep_graph_exist)
-      # build a reference index
-      adoc_logger = Giblish::AsciidoctorLogger.new Logger::Severity::WARN
-      ib = index_factory
-      @converter.convert_str(
-        ib.source(
-          dep_graph_exists: dep_graph_exist,
-          make_searchable: @options[:makeSearchable]
-        ),
-        @paths.dst_root_abs,
-        @options[:indexBaseName],
-        logger: adoc_logger
-      )
-
-      # clean up cached files and adoc resources
-      GC.start
-    end
-
-    # get the correct index builder type depending on supplied
-    # user options
-    def index_factory
-      raise "Internal logic error!" if @options[:suppressBuildRef]
-
-      SimpleIndexBuilder.new(@processed_docs, @converter, @paths, @deploy_info,
-                             @options[:resolveDocid])
-    end
-
-    def graph_builder_factory
-      Giblish::GraphBuilderGraphviz.new @processed_docs, @paths, @deploy_info,
-                                        @converter.converter_options
-    end
-
-    # get the correct converter type
-    def converter_factory
-      case @options[:format]
-      when "html"
-        HtmlConverter.new @paths, @deploy_info, @options
-      when "pdf"
-        PdfConverter.new @paths, @deploy_info, @options
-      else
-        raise ArgumentError, "Unknown conversion format: #{@options[:format]}"
-      end
-    end
-
-    # creates a DocInfo instance, fills it with basic info and
-    # returns the filled in instance so that derived implementations can
-    # add more data
-    def add_doc(adoc, adoc_stderr)
-      Giblog.logger.debug do
-        "Adding adoc: #{adoc} Asciidoctor stderr: #{adoc_stderr}"
-      end
-      Giblog.logger.debug { "Doc attributes: #{adoc.attributes}" }
-
-      info = DocInfo.new(adoc: adoc, dst_root_abs: @paths.dst_root_abs, adoc_stderr: adoc_stderr)
-      @processed_docs << info
-      info
-    end
-
-    def add_doc_fail(filepath, exception)
-      info = DocInfo.new
-
-      # the only info we have is the source file name
-      info.converted = false
-      info.src_file = filepath.to_s
-      info.error_msg = exception.message
-
-      @processed_docs << info
-      info
-    end
-
-    private
-
-    # convert a single adoc doc to whatever the user wants
-    def to_asciidoc(filepath)
-      adoc_logger = Giblish::AsciidoctorLogger.new Logger::Severity::WARN
-      adoc = @converter.convert(filepath, logger: adoc_logger)
-
-      add_doc(adoc, adoc_logger.user_info_str.string)
-    rescue StandardError => e
-      add_doc_fail(filepath, e)
-      raise
-    end
-
-    # predicate that decides if a path is a asciidoc file or not
-    def adocfile?(path)
-      fs = path.to_s
-      unless @options[:excludeRegexp].nil?
-        # exclude file if user wishes
-        er = Regexp.new @options[:excludeRegexp]
-        return false unless er.match(fs).nil?
-      end
-
-      # only include files matching the include regexp
-      ir = Regexp.new @options[:includeRegexp]
-      !ir.match(fs).nil?
-    end
-
-    def manage_searchability(opts)
-      # register the extension
-      Giblish.register_index_heading_extension
-
-      # make sure we start from a clean slate
-      IndexHeadings.clear_index
-
-      # propagate user-given id attributes to the indexing class
-      # if there are any
-      attr = opts[:attributes]
-      return if attr.nil?
-
-      IndexHeadings.id_elements[:id_prefix] = attr["idprefix"] if attr.key?("idprefix")
-      IndexHeadings.id_elements[:id_separator] = attr["idseparator"] if attr.key?("idseparator")
-    end
-
-    # top_dir
-    # |- web_assets
-    # |- branch_1_top_dir
-    # |     |- index.html
-    # |     |- file1.html
-    # |     |- dir_1
-    # |     |   |- file2.html
-    # |- search_assets
-    # |     |- branch_1
-    # |           |- heading_index.json
-    # |           |- file1.adoc
-    # |           |- dir_1
-    # |           |   |- file2.html
-    # |           |- ...
-    # |     |- branch_2
-    # |           | ...
-    # |- branch_2_top_dir
-    # | ...
-    def create_search_assets
-      # get the proper dir for the search assets
-      assets_dir = @paths.search_assets_abs
-
-      # store the JSON file
-      IndexHeadings.serialize assets_dir, @paths.src_root_abs
-
-      # traverse the src file tree and copy all published adoc files
-      # to the search_assets dir
-      return unless @paths.src_root_abs.directory?
-
-      Find.find(@paths.src_root_abs) do |path|
-        p = Pathname.new(path)
-        next unless adocfile? p
-
-        dst_dir = assets_dir.join(@paths.reldir_from_src_root(p))
-        FileUtils.mkdir_p(dst_dir)
-        FileUtils.cp(p.to_s, dst_dir)
-      end
-    end
-
-    # Register the asciidoctor extension that handles doc ids and traverse
-    # the source tree to collect all :docid: attributes found in document
-    # headers.
-    def manage_doc_ids
-      # Register the docid preprocessor hook
-      Giblish.register_docid_extension
-
-      # Make sure that no prior docid's are hangning around
-      DocidCollector.clear_cache
-      DocidCollector.clear_deps
-      idc = DocidCollector.new
-
-      # traverse the src file tree and collect ids from all
-      # .adoc or .ADOC files
-      if @paths.src_root_abs.directory?
-        Find.find(@paths.src_root_abs) do |path|
-          p = Pathname.new(path)
-          idc.parse_file(p) if adocfile? p
-        end
-      end
-      idc
-    end
-  end
-
-  # Converts all adoc files within a git repo
-  class GitRepoConverter < FileTreeConverter
-    def initialize(options)
-      super(options)
-      # cache the top of the tree since we need to redefine the
-      # paths per branch/tag later on.
-      @master_paths = @paths.dup
-      @master_deployment_info = @deploy_info.dup
-      @git_repo_root = options[:gitRepoRoot]
-      @git_repo = init_git_repo @git_repo_root, options[:localRepoOnly]
-      @user_branches = select_user_branches(options[:gitBranchRegexp])
-      @user_tags = select_user_tags(options[:gitTagRegexp])
-    end
-
-    # Convert the docs from each branch/tag and add info to the
-    # summary page.
-    # return true if all conversions went ok, false if at least one
-    # failed
-    def convert
-      conv_error = false
-      (@user_branches + @user_tags).each do |co|
-        has_error = convert_one_checkout(co)
-        if has_error == true
-          conv_error = true
-        end
-      rescue
-        conv_error = true
-        next
-      end
-
-      # Render the summary page
-      index_builder = GitSummaryIndexBuilder.new @git_repo,
-                                                 @user_branches,
-                                                 @user_tags
-
-      conv_error ||= @converter.convert_str(
-        index_builder.source,
-        @master_paths.dst_root_abs,
-        "index"
-      )
-
-      # clean up
-      GC.start
-
-      conv_error
-    end
-
-    protected
-
-    def index_factory
-      GitRepoIndexBuilder.new(@processed_docs, @converter, @paths, @deploy_info,
-                              @options[:resolveDocid], @options[:gitRepoRoot])
-    end
-
-    def graph_builder_factory
-      Giblish::GitGraphBuilderGraphviz.new @processed_docs, @paths, @deploy_info,
-                                           @converter.converter_options, @git_repo
-    end
-
-    def add_doc(adoc, adoc_stderr)
-      info = super(adoc, adoc_stderr)
-
-      # Redefine the srcFile to mean the relative path to the git repo root
-      src_file = Pathname.new(info.src_file).relative_path_from(@git_repo_root).to_s
-      # Get the commit history of the doc
-      # (use a homegrown git log to get 'follow' flag)
-      gi = Giblish::GitItf.new(@git_repo_root)
-      gi.file_log(src_file).each do |i|
-        h = DocInfo::DocHistory.new
-        h.date = i["date"]
-        h.message = i["message"]
-        h.author = i["author"]
-        info.history << h
-      end
-    end
-
-    private
-
-    def init_git_repo(git_repo_root, local_only)
-      # Sanity check git repo root
-      git_repo_root || raise(ArgumentError("No git repo root dir given"))
-
-      # Connect to the git repo
-      begin
-        git_repo = Git.open(git_repo_root)
-      rescue StandardError => e
-        raise "Could not find a git repo at #{git_repo_root} !"\
-            "\n\n(#{e.message})"
-      end
-
-      # fetch all remote refs if ok with user
-      begin
-        git_repo.fetch unless local_only
-      rescue StandardError => e
-        raise "Could not fetch from origin"\
-            "(do you need '--local-only'?)!\n\n(#{e.message})"
-      end
-      git_repo
-    end
-
-    # Get the branches/tags the user wants to parse
-    def select_user_branches(checkout_regexp)
-      return [] unless @options[:gitBranchRegexp]
-
-      regexp = Regexp.new checkout_regexp
-      user_checkouts = @git_repo.branches.remote.select do |b|
-        # match branches but remove eventual HEAD -> ... entry
-        regexp.match b.name unless b.name =~ /^HEAD/
-      end
-      Giblog.logger.debug { "selected git branches: #{user_checkouts}" }
-      user_checkouts
-    end
-
-    def select_user_tags(tag_regexp)
-      return [] unless tag_regexp
-
-      regexp = Regexp.new @options[:gitTagRegexp]
-      @git_repo.tags.select do |t|
-        regexp.match t.name
-      end
-    end
-
-    # convert all docs from one particular git commit
-    # returns true if at least one doc failed to convert
-    # and false if everything went ok.
-    def convert_one_checkout(checkout)
-      # determine if we are called with a tag or a branch
-      is_tag = (checkout.respond_to?(:tag?) && checkout.tag?)
-
-      Giblog.logger.info { "Checking out #{checkout.name}" }
-      @git_repo.checkout checkout.name
-
-      unless is_tag
-        # if this is a branch, make sure it is up-to-date
-        Giblog.logger.info { "Merging with origin/#{checkout.name}" }
-        @git_repo.merge "origin/#{checkout.name}"
-      end
-
-      # assign a checkout-unique dst-dir
-      dir_name = checkout.name.tr("/", "_") << "/"
-
-      # Update needed base class members before converting a new checkout
-      @processed_docs = []
-      @paths.dst_root_abs = @master_paths.dst_root_abs.realpath.join(dir_name)
-
-      if @options[:makeSearchable] && !@master_deployment_info.search_assets_path.nil?
-        @paths.search_assets_abs = @master_paths.search_assets_abs.join(dir_name)
-        @deploy_info.search_assets_path = @master_deployment_info.search_assets_path.join(dir_name)
-        Giblog.logger.info { "will store search data in #{@paths.search_assets_abs}" }
-      end
-
-      # Parse and convert docs using given args
-      Giblog.logger.info { "Convert docs into dir #{@paths.dst_root_abs}" }
-      # parent_convert
-      begin
-        FileTreeConverter.instance_method(:convert).bind_call(self)
-      rescue => e
-        raise "convert_one_checkout has a failure with #{co}!\n\n(#{e.message})"
-      end
-    end
-  end
-end