hash-polyfill 0.1.20170629

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d867362eafcd7f18aaca64f5681913c05c914422
+  data.tar.gz: 39f2ae9706458974ef5918019b01b1c929987548
+SHA512:
+  metadata.gz: 7e0ab771ba9e87ac863daeba2ee849323e444a5fbdf3b98fd1e80a57c8488d23562aa1345c09ff1e895da2d36d8f294389985cbbe4fc47b62c7848f5dbda29fe
+  data.tar.gz: 9463ed9777a5b319239b839222cf9f265ea4e37070e3897a135bfa78932ea61552191ad5f618374b387b324bb55194a811d513f3adbc76b0108175581df1243e

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -0,0 +1,18 @@
+Implements some `Hash` methods which ruby will undoubtedly add in the future, possibly with different names.
+
+## Usage
+
+```ruby
+a = {a: 1, b: 2, c: 3, d: 4}
+
+a.select_values(&even?) # => {b: 2, d: 4}
+a.reject_values(&even?) # => {a: 1, c: 3}
+a.transform_values{|v| v * 10} # => {a: 10, b: 20, c: 30, d: 40}
+
+b = {a: 1, b: 2, c: nil, d: false}
+b.compact # => {a: 1, b: 2, d: false}
+```
+
+The gem only adds the methods if they don't already exist. In particular if you're using ruby 2.4, `Hash#transform_values` is already provided.
+
+There are also `!` versions of all these methods.

data/Rakefile

@@ -0,0 +1,23 @@
+task "default" => "spec"
+task "test" => "spec"
+
+desc "Run tests"
+task "spec" do
+  system "rspec"
+end
+
+desc "Clean up"
+task "clean" do
+  system "trash hash-polyfill-*.gem"
+end
+
+desc "Build gem"
+task "gem:build" do
+  system "gem build hash-polyfill.gemspec"
+end
+
+desc "Upload gem"
+task "gem:push" => "gem:build" do
+  gem_file = Dir["hash-polyfill-*.gem"][-1] or raise "No gem found"
+  system "gem", "push", gem_file
+end

data/lib/hash-polyfill.rb

@@ -0,0 +1,58 @@
+class Hash
+  def compact
+    reject do |key, value|
+      value.nil?
+    end
+  end unless method_defined? :compact
+
+  def compact!
+    reject! do |key, value|
+      value.nil?
+    end
+  end unless method_defined? :compact!
+
+  def select_values
+    return enum_for(:select_values) unless block_given?
+    select do |key, value|
+      yield(value)
+    end
+  end unless method_defined? :select_values
+
+  def select_values!
+    return enum_for(:select_values!) unless block_given?
+    select! do |key, value|
+      yield(value)
+    end
+  end unless method_defined? :select_values!
+
+  def reject_values
+    return enum_for(:reject_values) unless block_given?
+    reject do |key, value|
+      yield(value)
+    end
+  end unless method_defined? :reject_values
+
+  def reject_values!
+    return enum_for(:reject_values!) unless block_given?
+    reject! do |key, value|
+      yield(value)
+    end
+  end unless method_defined? :reject_values!
+
+  def transform_values
+    return enum_for(:transform_values) unless block_given?
+    result = {}
+    each do |key, value|
+      result[key] = yield(value)
+    end
+    result
+  end unless method_defined? :transform_values
+
+  def transform_values!
+    return enum_for(:transform_values!) unless block_given?
+    each do |key, value|
+      self[key] = yield(value)
+    end
+    self
+  end unless method_defined? :transform_values!
+end

data/spec/hash_polyfill_spec.rb

@@ -0,0 +1,116 @@
+describe "Hash polyfill" do
+  it "compact" do
+    a = {x: true, y: nil, z: false}
+    b = a.compact
+    expect(a).to eq({x: true, y: nil, z: false})
+    expect(b).to eq({x: true, z: false})
+  end
+
+  it "compact!" do
+    a = {x: true, y: nil, z: false}
+    expect(a.compact!).to eq(a)
+    expect(a.compact!).to eq(nil)
+    expect(a).to eq({x: true, z: false})
+  end
+
+  it "select_values - with block" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    b = a.select_values(&:even?)
+    c = a.select_values(&:odd?)
+    expect(a).to eq({a: 2, b: 3, c: 4, d: 5})
+    expect(b).to eq({a: 2, c: 4})
+    expect(c).to eq({b: 3, d: 5})
+  end
+
+  it "select_values! - with block" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    expect(a.select_values!(&:even?)).to eq(a)
+    expect(a.select_values!(&:even?)).to eq(nil)
+    expect(a).to eq({a: 2, c: 4})
+  end
+
+  it "reject_values - with block" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    b = a.reject_values(&:even?)
+    c = a.reject_values(&:odd?)
+    expect(a).to eq({a: 2, b: 3, c: 4, d: 5})
+    expect(b).to eq({b: 3, d: 5})
+    expect(c).to eq({a: 2, c: 4})
+  end
+
+  it "reject_values! - with block" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    expect(a.reject_values!(&:even?)).to eq(a)
+    expect(a.reject_values!(&:even?)).to eq(nil)
+    expect(a).to eq({b: 3, d: 5})
+  end
+
+  # Doing anything more than .with_index or .each with them is going to be confusing
+  it "select_values - no block yields Enumerator" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    expect(a.select_values).to be_instance_of(Enumerator)
+    b = a.select_values.each(&:even?)
+    expect(a).to eq({a: 2, b: 3, c: 4, d: 5})
+    expect(b).to eq({a: 2, c: 4})
+    b = a.select_values.map(&:even?)
+    expect(b).to eq([true, false, true, false])
+  end
+
+  it "select_values! - no block yields Enumerator" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    expect(a.select_values!).to be_instance_of(Enumerator)
+    b = a.select_values!.each(&:even?)
+    expect(a).to eq({a: 2, c: 4})
+    expect(b).to eq(a)
+  end
+
+  it "reject_values - no block yields Enumerator" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    expect(a.reject_values).to be_instance_of(Enumerator)
+    b = a.reject_values.each(&:even?)
+    expect(a).to eq({a: 2, b: 3, c: 4, d: 5})
+    expect(b).to eq({b: 3, d: 5})
+    b = a.reject_values.map(&:even?)
+    expect(b).to eq([true, false, true, false])
+  end
+
+  it "reject_values! - no block yields Enumerator" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    expect(a.reject_values!).to be_instance_of(Enumerator)
+    b = a.reject_values!.each(&:even?)
+    expect(a).to eq({b: 3, d: 5})
+    expect(b).to eq(a)
+  end
+
+  # Ruby 2.4 polyfill
+  # map! always returns self, which is different from select!/reject! which return self or nil
+  it "transform_values - with block" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    b = a.transform_values(&:next)
+    expect(a).to eq({a: 2, b: 3, c: 4, d: 5})
+    expect(b).to eq({a: 3, b: 4, c: 5, d: 6})
+  end
+
+  it "transform_values! - with block" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    expect(a.transform_values!(&:next)).to eq(a)
+    expect(a.transform_values!(&:itself)).to eq(a)
+    expect(a).to eq({a: 3, b: 4, c: 5, d: 6})
+  end
+
+  it "transform_values - no block yields Enumerator" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    expect(a.transform_values).to be_instance_of(Enumerator)
+    b = a.transform_values.each(&:next)
+    expect(a).to eq({a: 2, b: 3, c: 4, d: 5})
+    expect(b).to eq({a: 3, b: 4, c: 5, d: 6})
+  end
+
+  it "transform_values! - no block yields Enumerator" do
+    a = {a: 2, b: 3, c: 4, d: 5}
+    expect(a.transform_values!).to be_instance_of(Enumerator)
+    expect(a.transform_values!.each(&:next)).to eq(a)
+    expect(a.transform_values!.each(&:itself)).to eq(a)
+    expect(a).to eq({a: 3, b: 4, c: 5, d: 6})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require_relative "../lib/hash-polyfill"
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: hash-polyfill
+version: !ruby/object:Gem::Version
+  version: 0.1.20170629
+platform: ruby
+authors:
+- Tomasz Wegrzanowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Hash#transform_values from 2.4 and well as Hash convenience methods from
+  the future
+email: Tomasz.Wegrzanowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- lib/hash-polyfill.rb
+- spec/hash_polyfill_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/taw/hash-zip
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Polyfill for Hash methods ruby will get in the future
+test_files: []