Sha256: 1201b7420ce395bc24822922cb9b7441ccde5a67d2bfe6d9a9deb659c4ee33a8

Contents?: true

Size: 1.58 KB

Versions: 58

Compression:

Stored size: 1.58 KB

Contents

class Hash
  # Slices a hash to include only the given keys. Returns a hash containing 
  # the given keys.
  # 
  #   { a: 1, b: 2, c: 3, d: 4 }.slice(:a, :b)
  #   # => {:a=>1, :b=>2}
  # 
  # This is useful for limiting an options hash to valid keys before 
  # passing to a method:
  #
  #   def search(criteria = {})
  #     criteria.assert_valid_keys(:mass, :velocity, :time)
  #   end
  #
  #   search(options.slice(:mass, :velocity, :time))
  #
  # If you have an array of keys you want to limit to, you should splat them:
  #
  #   valid_keys = [:mass, :velocity, :time]
  #   search(options.slice(*valid_keys))
  def slice(*keys)
    keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
    keys.each_with_object(self.class.new) { |k, hash| hash[k] = self[k] if has_key?(k) }
  end

  # Replaces the hash with only the given keys.
  # Returns a hash containing the removed key/value pairs.
  #
  #   { a: 1, b: 2, c: 3, d: 4 }.slice!(:a, :b)
  #   # => {:c=>3, :d=>4}
  def slice!(*keys)
    keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
    omit = slice(*self.keys - keys)
    hash = slice(*keys)
    hash.default      = default
    hash.default_proc = default_proc if default_proc
    replace(hash)
    omit
  end

  # Removes and returns the key/value pairs matching the given keys.
  #
  #   { a: 1, b: 2, c: 3, d: 4 }.extract!(:a, :b) # => {:a=>1, :b=>2}
  #   { a: 1, b: 2 }.extract!(:a, :x)             # => {:a=>1}
  def extract!(*keys)
    keys.each_with_object(self.class.new) { |key, result| result[key] = delete(key) if has_key?(key) }
  end
end

Version data entries

58 entries across 56 versions & 9 rubygems

Version Path
files.com-1.0.55 docs/vendor/bundle/ruby/2.5.0/gems/activesupport-5.0.7.1/lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.7.2 lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.7.1 lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.7 lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.6 lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.6.rc1 lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.5 lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.5.rc2 lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.5.rc1 lib/active_support/core_ext/hash/slice.rb
tdiary-5.0.5 vendor/bundle/gems/activesupport-5.0.2/lib/active_support/core_ext/hash/slice.rb
tdiary-5.0.5 vendor/bundle/gems/tdiary-5.0.4/vendor/bundle/gems/activesupport-5.0.2/lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.4 lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.4.rc1 lib/active_support/core_ext/hash/slice.rb
activesupport-5.0.3 lib/active_support/core_ext/hash/slice.rb
enju_leaf-1.2.1 vendor/bundle/ruby/2.3/gems/activesupport-5.0.2/lib/active_support/core_ext/hash/slice.rb
lazy_record-0.2.1 vendor/bundle/gems/activesupport-5.0.2/lib/active_support/core_ext/hash/slice.rb
lazy_record-0.2.0 vendor/bundle/gems/activesupport-5.0.2/lib/active_support/core_ext/hash/slice.rb
lazy_record-0.1.9 vendor/bundle/gems/activesupport-5.0.2/lib/active_support/core_ext/hash/slice.rb
lazy_record-0.1.8 vendor/bundle/gems/activesupport-5.0.2/lib/active_support/core_ext/hash/slice.rb
lazy_record-0.1.7 vendor/bundle/gems/activesupport-5.0.2/lib/active_support/core_ext/hash/slice.rb