Contents

module Vedeu

  # Repository for storing and retrieving defined interfaces.
  #
  # @api private
  module Interfaces

    extend self

    # Stores the interface attributes defined by the API.
    #
    # @param attributes [Hash]
    # @return [Hash|FalseClass]
    def add(attributes)
      return false if attributes[:name].empty?

      storage.store(attributes[:name], attributes)
    end

    # Return the whole repository.
    #
    # @return [Hash]
    def all
      storage
    end

    # Find an interface by name and return the attributes used to define it.
    #
    # @param name [String]
    # @return [Hash]
    def find(name)
      storage.fetch(name) do
        fail InterfaceNotFound,
          "Interface was not found with this name: #{name.to_s}."
      end
    end

    # Returns a collection of the names of all the registered interfaces.
    #
    # @return [Array]
    def registered
      storage.keys
    end

    # Returns a boolean indicating whether the named interface is registered.
    #
    # @return [TrueClass|FalseClass]
    def registered?(name)
      storage.key?(name)
    end

    # Reset the interfaces repository; removing all registered interfaces.
    # This will delete the interfaces themselves, and the client application
    # will need to either redefine interfaces before using them, or restart.
    #
    # @return [Hash]
    def reset
      @_storage = in_memory
    end

    private

    # @api private
    # @return [Hash]
    def storage
      @_storage ||= in_memory
    end

    # @api private
    # @return [Hash]
    def in_memory
      {}
    end

  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
vedeu-0.2.0	lib/vedeu/repositories/interfaces.rb