piotrmurach/tty-table

# frozen_string_literal: true

require_relative "error"
require_relative "renderer/basic"
require_relative "renderer/ascii"
require_relative "renderer/unicode"

module TTY
  class Table
    # A module responsible for selecting tabule data renderer
    #
    # Used internally by {Table} to render table content out.
    #
    # @api private
    module Renderer
      RENDERER_MAPPER = {
        ascii:   TTY::Table::Renderer::ASCII,
        basic:   TTY::Table::Renderer::Basic,
        unicode: TTY::Table::Renderer::Unicode
      }

      # Select renderer class based on string name.
      #
      # The possible values for type are
      #   [:basic, :ascii, :unicode]
      #
      # @param [Symbol] type
      #   the renderer type used for displaying table
      #
      # @return [TTY::Table::Renderer]
      #
      # @api private
      def select(type)
        RENDERER_MAPPER[type || :basic]
      end
      module_function :select

      # Raises an error if provided border class is of wrong type or has invalid
      # implementation
      #
      # @raise [TypeError]
      #   raised when providing wrong class for border
      #
      # @raise [NoImplementationError]
      #   raised when border class does not implement core methods
      #
      # @api public
      def assert_border_class(border_class)
        return unless border_class
        unless border_class <= TTY::Table::Border
          raise TypeError,
                "#{border_class} should inherit from TTY::Table::Border"
        end
        unless border_class.characters
          raise NoImplementationError,
                "#{border_class} should implement def_border"
        end
      end
      module_function :assert_border_class

      # Render a given table and return the string representation.
      #
      # @param [TTY::Table] table
      #   the table to be rendered
      #
      # @param [Hash] options
      #   the options to render the table with
      # @option options [String] :renderer
      #   used to format table output
      #
      # @return [String]
      #
      # @api public
      def render(table, options = {}, &block)
        renderer = select(options[:renderer]).new(table, options)
        yield renderer if block_given?
        renderer.render
      end
      module_function :render

      # Add custom border for the renderer
      #
      # @param [TTY::Table::Border] border_class
      #
      # @param [TTY::Table] table
      #
      # @param [Hash] options
      #
      # @raise [TypeError]
      #   raised if the klass does not inherit from Table::Border
      #
      # @raise [NoImplemntationError]
      #   raise if the klass does not implement def_border
      #
      # @api public
      def render_with(border_class, table, options = {}, &block)
        assert_border_class(border_class)
        options[:border_class] = border_class if border_class
        render(table, options, &block)
      end
      module_function :render_with
    end # Renderer
  end # Table
end # TTY