nutella 0.1.1 → 0.2

data/Rakefile

@@ -14,4 +14,5 @@ YARD::Rake::YardocTask.new do |doc|
 end
 task doc: :yard
 
+task dist: :build
 task default: :spec

data/lib/nutella/core_ext/hash.rb

@@ -0,0 +1,42 @@
+class Hash
+  # Grab the given keys out of a hash.
+  #
+  # @example Selects two keys out of a hash
+  #   { a: 1, b: 2, c: 3, d: 4 }.slice :a, :c  # => { a: 1, c: 3 }
+  #
+  # @example Limits 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))def slice(*keys)
+  #
+  # @example Splats an array of keys before passing to the #search method above
+  #   valid_keys = [:mass, :velocity, :time]
+  #   search(options.slice(*valid_keys))
+  #
+  # @param [*Object] keys the keys to slice out of the hash
+  # @return [Hash] the key/value pairs that exist in *keys
+  def slice(*keys)
+    select { |k, v| keys.include? k }
+  end
+  alias_method :grab, :slice
+
+  # Acts on the hash as described in Hash#slice, but modifies the hash in
+  # place.
+  #
+  # @example Demonstrates the action and its return value
+  #   test = { a: 1, b: 2, c: 3, d: 4 }
+  #   test.slice! :a, :c  # => { b: 2, d: 4 }
+  #   test                # => { a: 1, c: 3 }
+  #
+  # @param [*Object] keys the keys to slice out of the hash
+  # @return [Hash] the removed key/value pairs
+  def slice!(*keys)
+    replace((original = self.dup).slice *keys)
+    original.reject { |k, v| keys.include? k }
+  end
+  # #grab! doesn't sound quite semantically correct, but keeping it for the
+  # sake of being consistent with #slice/#grab.
+  alias_method :grab!, :slice!
+end

data/lib/nutella/version.rb

@@ -1,4 +1,4 @@
 module Nutella
   # The current version of Nutella.
-  VERSION = "0.1.1"
+  VERSION = "0.2"
 end

data/spec/nutella/core_ext/hash_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+require "nutella/core_ext/hash"
+
+describe Hash do
+  describe "aliases" do
+    test_alias Hash, :slice, :grab
+    test_alias Hash, :slice!, :grab!
+  end
+
+  describe "#grab" do
+    hash = {}
+
+    before { hash = { a: 1, b: 2, c: 3, d: 4 } }
+
+    it "should select the given items from a hash" do
+      hash.slice(:a, :c).should == { a: 1, c: 3 }
+    end
+
+    it "should skip items that do not exist in the hash" do
+      hash.slice(:a, :d, :f).should == { a: 1, d: 4 }
+    end
+
+    it "should not modify in place" do
+      start = hash
+      hash.slice :a, :b
+      hash.should == start
+    end
+  end
+
+  describe "#grab!" do
+    hash = {}
+
+    before { hash = { a: 1, b: 2, c: 3, d: 4 } }
+
+    it "should modify in place" do
+      hash.slice! :a, :c
+      hash.should == { a: 1, c: 3 }
+    end
+
+    it "should return the removed pairs" do
+      hash.slice!(:a, :c).should == { b: 2, d: 4 }
+    end
+
+    it "should ignore pairs that did not affect the hash" do
+      hash.slice!(:a, :c, :g).should == { b: 2, d: 4 }
+      hash.should == { a: 1, c: 3 }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nutella
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-28 00:00:00.000000000 Z
+date: 2012-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,8 +100,10 @@ files:
 - lib/nutella.rb
 - lib/nutella/version.rb
 - lib/nutella/core_ext/string.rb
+- lib/nutella/core_ext/hash.rb
 - lib/nutella/core_ext/enumerable.rb
 - lib/nutella/core_ext.rb
+- spec/nutella/core_ext/hash_spec.rb
 - spec/nutella/core_ext/enumerable_spec.rb
 - spec/nutella/core_ext/string_spec.rb
 - spec/spec_helper.rb
@@ -131,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2447363496143350435
+      hash: 1979489363505298404
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -139,6 +141,7 @@ signing_key:
 specification_version: 3
 summary: Spread some Nutella on Ruby to sweeten up its functionality.
 test_files:
+- spec/nutella/core_ext/hash_spec.rb
 - spec/nutella/core_ext/enumerable_spec.rb
 - spec/nutella/core_ext/string_spec.rb
 - spec/spec_helper.rb