Contents

module Compo
  # A simple implementation of a branch, whose children are stored in an Hash
  #
  # An HashBranch is a composite object that may be moved into other composite
  # objects.  It stores its children as an Hash, and the ID of each child is
  # its hash key.  Inserting and removing items into the HashBranch will not
  # change the IDs of other items, but inserting with an existing key will
  # remove the previous occupant.
  #
  # This is an extension of HashComposite to include the Movable and
  # ParentTracker mixins.
  class HashBranch < HashComposite
    include Movable
    include ParentTracker
    include UrlReferenceable

    # Initialises the HashBranch
    #
    # The HashBranch is created with no children, no parent, and no ID.
    #
    # @api  public
    # @example  Creates a new HashBranch.
    #   branch = HashBranch.new
    def initialize
      super()
      remove_parent
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
compo-0.2.0	lib/compo/hash_branch.rb
compo-0.1.5	lib/compo/hash_branch.rb
compo-0.1.4	lib/compo/hash_branch.rb