gonzedge/rambling-trie

# frozen_string_literal: true

%w(
  comparable compressible compressor configuration container enumerable inspectable invalid_operation
  readers serializers stringifyable nodes version
).each do |file|
  require File.join('rambling', 'trie', file)
end

# General namespace for all Rambling gems.
module Rambling
  # Entry point for +rambling-trie+ API.
  module Trie
    class << self
      # Creates a new +Rambling::Trie+. Entry point for the +rambling-trie+ API.
      # @param [String, nil] filepath the file to load the words from.
      # @param [Readers::Reader, nil] reader the file parser to get each word.
      # @return [Container] the trie just created.
      # @yield [Container] the trie just created.
      # @see Rambling::Trie::Readers Readers.
      def create filepath = nil, reader = nil
        root = root_builder.call

        Rambling::Trie::Container.new root, compressor do |container|
          # noinspection RubyMismatchedArgumentType
          if filepath
            reader ||= readers.resolve filepath
            # noinspection RubyMismatchedArgumentType,RubyNilAnalysis
            reader.each_word filepath do |word|
              container << word
            end
          end

          yield container if block_given?
        end
      end

      # Loads an existing trie from disk into memory. By default, it will
      # deduce the correct way to deserialize based on the file extension.
      # Available formats are +yml+, +marshal+, and +zip+ versions of all the
      # previous formats. You can also define your own.
      # @param [String] filepath the file to load the words from.
      # @param [Serializer, nil] serializer the object responsible of loading the trie from disk.
      # @return [Container] the trie just loaded.
      # @yield [Container] the trie just loaded.
      # @see Rambling::Trie::Serializers Serializers.
      # @note Use of #   {https://ruby-doc.org/core-2.7.0/Marshal.html#method-c-load Marshal.load} is generally
      #   discouraged. Only use the +.marshal+ format with trusted input.
      def load filepath, serializer = nil
        serializer ||= serializers.resolve filepath
        root = serializer.load filepath
        Rambling::Trie::Container.new root, compressor do |container|
          yield container if block_given?
        end
      end

      # Dumps an existing trie from memory into disk. By default, it will
      # deduce the correct way to serialize based on the file extension.
      # Available formats are +yml+, +marshal+, and +zip+ versions of all the
      # previous formats. You can also define your own.
      # @param [Container] trie the trie to dump into disk.
      # @param [String] filepath the file to dump to serialized trie into.
      # @param [Serializers::Serializer, nil] serializer the object responsible for trie serialization.
      # @return [void]
      # @see Serializers Serializers.
      def dump trie, filepath, serializer = nil
        serializer ||= serializers.resolve filepath
        # noinspection RubyNilAnalysis
        serializer.dump trie.root, filepath
      end

      # Provides configuration properties for the +Rambling::Trie+ gem.
      # @return [Configuration::Properties] the configured properties of the gem.
      # @yield [Configuration::Properties] the configured properties of the gem.
      def config
        yield properties if block_given?
        properties
      end

      private

      def properties
        @properties ||= Rambling::Trie::Configuration::Properties.new
      end

      def readers
        properties.readers
      end

      def serializers
        properties.serializers
      end

      def compressor
        properties.compressor
      end

      def root_builder
        properties.root_builder
      end
    end
  end
end