Sha256: e9d58ecbd8e1db5c3e3e6c441b93cbea29920e1574d53cde04bd4c687d01890c

Contents?: true

Size: 1.57 KB

Versions: 40

Compression:

Stored size: 1.57 KB

Contents

module Vedeu

  module Colours

    # Allows the storing of HTML/CSS colours and their respective
    # escape sequences.
    #
    class Repository

      # @!attribute [r] storage
      # @return [Hash<String => String>]
      attr_reader :storage

      # Returns a new instance of Vedeu::Colours::Repository.
      #
      # @return [Vedeu::Colours::Repository]
      def initialize
        @storage = {}
      end

      # Registers a colour with respective escape sequence.
      #
      # @return [String]
      def register(colour, escape_sequence)
        storage.store(colour, escape_sequence)
      end

      # Returns a boolean indicating whether the colour has been
      # sregistered.
      #
      # @param colour [String]
      # @return [Boolean]
      def registered?(colour)
        return false unless colour

        storage.key?(colour)
      end

      # Removes all stored colours.
      #
      # @return [Hash]
      def reset!
        storage.clear
      end

      # Retrieves the escape sequence of a registered colour.
      #
      # @return [String]
      def retrieve(colour)
        storage.fetch(colour, '')
      end

      # Retrieves the escape sequence of a registered colour, or
      # registers the colour with its respective escape sequence.
      #
      # @return [String]
      # @todo Unused - GL 2015-09-26
      def retrieve_or_register(colour, escape_sequence)
        if registered?(colour)
          retrieve(colour)

        else
          register(colour, escape_sequence)

        end
      end

    end # Repository

  end # Colours

end # Vedeu

Version data entries

40 entries across 40 versions & 1 rubygems

Version Path
vedeu-0.6.35 lib/vedeu/colours/repository.rb
vedeu-0.6.34 lib/vedeu/colours/repository.rb
vedeu-0.6.33 lib/vedeu/colours/repository.rb
vedeu-0.6.32 lib/vedeu/colours/repository.rb
vedeu-0.6.31 lib/vedeu/colours/repository.rb
vedeu-0.6.30 lib/vedeu/colours/repository.rb
vedeu-0.6.29 lib/vedeu/colours/repository.rb
vedeu-0.6.28 lib/vedeu/colours/repository.rb
vedeu-0.6.27 lib/vedeu/colours/repository.rb
vedeu-0.6.26 lib/vedeu/colours/repository.rb
vedeu-0.6.25 lib/vedeu/colours/repository.rb
vedeu-0.6.24 lib/vedeu/colours/repository.rb
vedeu-0.6.23 lib/vedeu/colours/repository.rb
vedeu-0.6.22 lib/vedeu/colours/repository.rb
vedeu-0.6.21 lib/vedeu/colours/repository.rb
vedeu-0.6.20 lib/vedeu/colours/repository.rb
vedeu-0.6.19 lib/vedeu/colours/repository.rb
vedeu-0.6.18 lib/vedeu/colours/repository.rb
vedeu-0.6.17 lib/vedeu/colours/repository.rb
vedeu-0.6.16 lib/vedeu/colours/repository.rb