nexus.ruby.nexus-ruby-tools.4.0.0.source-code.ice_nine.rb Maven / Gradle / Ivy

Go to download
# encoding: utf-8

require 'ice_nine/support/recursion_guard'

require 'ice_nine/freezer'
require 'ice_nine/freezer/object'
require 'ice_nine/freezer/no_freeze'
require 'ice_nine/freezer/array'

require 'ice_nine/freezer/false_class'
require 'ice_nine/freezer/hash'
require 'ice_nine/freezer/hash/state'
require 'ice_nine/freezer/nil_class'
require 'ice_nine/freezer/module'
require 'ice_nine/freezer/numeric'
require 'ice_nine/freezer/range'
require 'ice_nine/freezer/rubinius'
require 'ice_nine/freezer/struct'
require 'ice_nine/freezer/symbol'
require 'ice_nine/freezer/true_class'

require 'ice_nine/version'

# Base IceNine module
module IceNine

  # Deep Freeze an object
  #
  # @example
  #   object = IceNine.deep_freeze(object)
  #
  # @param [Object] object
  #
  # @return [Object]
  #
  # @api public
  def self.deep_freeze(object)
    Freezer.deep_freeze(object)
  end

  # Deep Freeze an object
  #
  # This method uses a faster algorithm that will assume objects that are
  # `frozen?` do not need to be frozen deeply. Use this method when `object`
  # contains no shallowly frozen objects that need deep freezing.
  #
  # @example
  #   IceNine.deep_freeze!(['a', 'b']).map(&:frozen?) # [true, true]
  #
  # @example
  #   IceNine.deep_freeze!(['a', 'b'].freeze).map(&:frozen?) # [false, false]
  #
  # @param [Object] object
  #
  # @return [Object]
  #
  # @api public
  def self.deep_freeze!(object)
    Freezer.deep_freeze!(object)
  end

end # IceNine