Sha256: 769471984db8df2f471f096667918865816a295ad989c6358660d78235fe2ed2

Contents?: true

Size: 1.89 KB

Versions: 9

Compression:

Stored size: 1.89 KB

Contents

class Evil::Client
  #
  # @abstract
  # Container that carries schema of operation/scope along with its settings
  # and methods to build sub-scope/operation or perform the current operation.
  #
  class Container
    Names.clean(self) # Remove unnecessary methods from the instance

    # Loads concrete implementations of the abstract container
    require_relative "container/scope"
    require_relative "container/operation"

    # The schema containing info about sub-scopes and operations of the scope
    # @return [Evil::Client::Container::ScopeDefinition]
    attr_reader :schema

    # The settings current scope is initialized with
    # @return [Evil::Client::Settings]
    attr_reader :settings

    # The client of the [#schema]
    # @return [Class]
    def client
      schema.client
    end

    # The name of the current schema
    # @return [String]
    def name
      schema.to_s
    end

    # Options assigned to the [#settings]
    #
    # These are opts given to the [#initializer],
    # processed (via defaults, coercion, renaming) by a constructor of settings.
    #
    # @return [Hash<Symbol, Object>]
    def options
      settings.options
    end

    # The human-friendly representation of the scope instance
    #
    # @example
    #   '#<MyClient.scopes[:users] @version=1>'
    #
    # @return [String]
    def to_s
      "#<#{name} #{options.map { |key, val| "@#{key}=#{val}" }.join(', ')}>"
    end
    alias_method :to_str,  :to_s
    alias_method :inspect, :to_s

    # (Re)sets current logger
    #
    # @param  [Logger, nil] logger
    # @return [Logger, nil]
    #
    def logger=(logger)
      settings.logger = logger
    end

    # Current logger
    #
    # @return [Logger, nil]
    #
    def logger
      settings.logger
    end

    private

    def initialize(schema, logger = nil, **opts)
      @schema   = schema
      @settings = schema.settings.new(logger, opts)
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
evil-client-3.0.4 lib/evil/client/container.rb
evil-client-3.0.3 lib/evil/client/container.rb
evil-client-3.0.2 lib/evil/client/container.rb
evil-client-3.0.1 lib/evil/client/container.rb
evil-client-3.0.0 lib/evil/client/container.rb
evil-client-2.1.1 lib/evil/client/container.rb
evil-client-2.1.0 lib/evil/client/container.rb
evil-client-2.0.0 lib/evil/client/container.rb
evil-client-1.1.0 lib/evil/client/container.rb