aspera-cli 4.25.6 → 4.26.1

data/lib/aspera/transfer/spec_doc.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require 'aspera/agent/factory'
-require 'aspera/markdown'
-
-module Aspera
-  module Transfer
-    # Generate documentation from Schema, for Transfer Spec, or async Conf spec
-    class SpecDoc
-      class << self
-        # @param formatter      [Cli::Formatter] Formatter to use, methods: markdown_text, tick, check_row
-        # @param include_option [Boolean]        `true` : include CLI options
-        # @param agent_columns  [Boolean]        `true` : include agents columns
-        # @param schema         [Hash]           The JSON spec
-        # @return [Array] a table suitable to display in manual
-        def man_table(formatter, include_option: false, agent_columns: true, schema: Spec::SCHEMA)
-          cols = %i[name type description]
-          cols.insert(-2, *Agent::Factory::ALL.values.map{ |i| i[:short]}.sort) if agent_columns
-          rows = []
-          schema['properties'].each do |name, info|
-            rows.concat(man_table(formatter, include_option: include_option, agent_columns: agent_columns, schema: info).last.map{ |h| h.merge(name: "#{name}.#{h[:name]}")}) if info['type'].eql?('object') && info['properties']
-            rows.concat(man_table(formatter, include_option: include_option, agent_columns: agent_columns, schema: info['items']).last.map{ |h| h.merge(name: "#{name}[].#{h[:name]}")}) if info['type'].eql?('array') && info['items'] && info['items']['properties']
-            # Manual table
-            columns = {
-              name:        name,
-              type:        info['type'],
-              description: []
-            }
-            # Render Markdown formatting and split lines
-            columns[:description] =
-              info['description']
-                .gsub(Markdown::FORMATS){formatter.markdown_text(Regexp.last_match)}
-                .split("\n") if info.key?('description')
-            columns[:description].unshift("DEPRECATED: #{info['x-deprecation']}") if info.key?('x-deprecation')
-            # Add flags for supported agents in doc
-            agents = []
-            Agent::Factory::ALL.each_key do |sym|
-              agents.push(sym) if info['x-agents'].nil? || info['x-agents'].include?(sym.to_s)
-            end
-            Aspera.assert(agents.include?(:direct)){"#{name}: x-cli-option requires agent direct (or nil)"} if info['x-cli-option']
-            if agent_columns
-              Agent::Factory::ALL.each do |sym, names|
-                columns[names[:short]] = formatter.tick(agents.include?(sym))
-              end
-            else
-              columns[:description].push("(#{agents.map{ |i| Agent::Factory::ALL[i][:short].to_s.upcase}.sort.join(', ')})") unless agents.length.eql?(Agent::Factory::ALL.length)
-            end
-            # Only keep lines that are usable in supported agents
-            next false if agents.empty?
-            columns[:description].push("Allowed values: #{info['enum'].map{ |v| formatter.markdown_text("`#{v}`")}.join(', ')}") if info.key?('enum')
-            if include_option
-              envvar_prefix = ''
-              cli_option =
-                if info.key?('x-cli-envvar')
-                  envvar_prefix = 'env:'
-                  info['x-cli-envvar']
-                elsif info['x-cli-switch']
-                  info['x-cli-option']
-                elsif info['x-cli-option']
-                  arg_type = info.key?('enum') ? '{enum}' : "{#{[info['type']].flatten.join('|')}}"
-                  # conversion_tag = info['x-cli-convert']
-                  conversion_tag = info.key?('x-cli-convert') ? 'conversion' : nil
-                  sep = info['x-cli-option'].start_with?('--') ? '=' : ' '
-                  "#{info['x-cli-option']}#{sep}#{"(#{conversion_tag})" if conversion_tag}#{arg_type}"
-                end
-              short = info.key?('x-cli-short') ? "(#{info['x-cli-short']})" : nil
-              columns[:description].push("(#{'special:' if info['x-cli-special']}#{envvar_prefix}#{formatter.markdown_text("`#{cli_option}`")})#{short}") if cli_option
-            end
-            rows.push(formatter.check_row(columns))
-          end
-          [cols, rows.sort_by{ |i| i[:name]}]
-        end
-      end
-    end
-  end
-end