augmented 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab72b071901020afba04d0c492f1bc6363545a2b
-  data.tar.gz: 529677d1369c9d9125212faa80a6f71cef648e81
+  metadata.gz: c45e4c37723b2e38793bb1476b7be8e8662b8c4a
+  data.tar.gz: c988abdf0493e83cb1b8406af472649fe6f10d00
 SHA512:
-  metadata.gz: 3376e35d3240db0dd12e8dca2ae0798200d8b75fda9b1a6b90d6c6638de1f5d2df8dda2d26ca0763dd8b9e20f24183c9930005f1bf5cdb168a33c2985fc2a65c
-  data.tar.gz: 09f783c3f13bd508fe7d012955ade5c12d7c9dce2e215fa7d065a72669567a06cad27c3478d3a391d55386a8a5a01f334c0ec696d667dd67593a6cf37b6aff0f
+  metadata.gz: 9e87a5bf8e30edfc41f7364f6b5851bccbbe15cbe1d908d4ad7471793ea4129dfb254ae3963257fc0f61c378e6c96be43be480d8d735864e3923f9c28a43e155
+  data.tar.gz: 19b0e83ca99b904f0f69614966649e7e26c70210ca6da3862a21ded599e4e934d249b4d08c36e9c3ec71d3d785d6e3861abf5ca72b3ad5accb4368ca9eb3085c

data/README.md

@@ -2,7 +2,7 @@
 
 `Augmented` is a library with some core-type utility methods that I frequently find myself copying across projects. It uses refinements instead of class modification for maximum control and an easy sleep at night. 
 
-Many of the methods in `Augmented` facilitate a more functional style of programming and cover a few tiny gaps in Ruby's solid functional support.
+Many of the methods in `Augmented` facilitate a more functional style of programming and cover a few tiny gaps in Ruby's solid functional support. See more thoughts on this [blog post](http://blog.brunze.com/2015/using-ruby-refinements-fun-flow/).
 
 ## Installation
 
@@ -27,18 +27,19 @@ using Augmented
 You can load all refinements for just one type:
 
 ```ruby
-using Augmented::Objects
+using Augmented::Enumerators
 using Augmented::Hashes
+using Augmented::Objects
+using Augmented::Procs
 using Augmented::Symbols
-# etc.
 ```
 
 Or you can load just the methods you need:
 
 ```ruby
 using Augmented::Objects::Pickable
-using Augmented::Symbols::Arguable
 using Augmented::Procs::Chainable
+using Augmented::Symbols::Arguable
 # etc.
 ```
 
@@ -49,15 +50,41 @@ using Augmented::Procs::Chainable
 Builds an index of all elements of an enumerator according to the given criterion.
 
 ```ruby
+using Augmented::Enumerators::Indexing
+
 ['a', 'bb', 'ccccc'].to_enum.index_by(&:length)
 # {1=>"a", 2=>"bb", 5=>"ccccc"}
 ```
 
+##### `Hash#map_values`
+
+Returns a new hash with the same keys but transformed values.
+
+```ruby
+using Augmented::Hashes::Mappable
+
+{ aa: 11, bb: 22 }.map_values{ |i| i * 3 }
+# {:aa=>33, :bb=>66}
+```
+
+##### `Hash#map_keys`
+
+Returns a new hash with the same values but transformed keys.
+
+```ruby
+using Augmented::Hashes::Mappable
+
+{ aa: 11, bb: 22 }.map_keys{ |k| k.to_s[0] }
+# {"a"=>11, "b"=>22}
+```
+
 ##### `Hash#polymorph`
 
-Creates an object from an Hash.
+Creates an object from a Hash.
 
 ```ruby
+using Augmented::Hashes::Polymorphable
+
 class Sheep
   def initialize attributes
     @sound = attributes[:sound]
@@ -77,6 +104,8 @@ end
 Recursively applies functions to a tree of hashes.
 
 ```ruby
+using Augmented::Hashes::Transformable
+
 tree = { lorem: 'ipsum', dolor: [ { sit: 10}, { sit: 20 } ] }
 triple =  -> i { i * 3 }
 
@@ -84,11 +113,24 @@ tree.transform({ lorem: :upcase, dolor: { sit: triple } })
 # {:lorem=>"IPSUM", :dolor=>[{:sit=>30}, {:sit=>60}]}
 ```
 
+##### `Object#if`, `Object#else`
+
+Allows you to conditionally return an object, increasing readability in some situations.
+
+```ruby
+using Augmented::Objects::Iffy
+
+Person.new.eat toast.if(toast.buttered?).else(muffin)
+Person.new.eat toast.if(&:buttered?).else(muffin)
+```
+
 ##### `Object#pick`
 
 Calls a bunch of methods on an object and collects the results.
 
 ```ruby
+using Augmented::Objects::Pickable
+
 class MyThing
   def lorem; 'hello'; end
   def ipsum; 'cruel'; end
@@ -104,15 +146,30 @@ MyThing.new.pick :lorem, :dolor
 Appends a bunch of singleton methods to an object.
 
 ```ruby
+using Augmented::Objects::Tackable
+
 Object.new.tack(id: 11, greet: -> { puts "hello I'm #{id}" }).greet
 # hello I'm 11
 ```
 
+##### `Object#tap_if`, `Object#tap_unless`
+
+Like [`tap`](http://ruby-doc.org/core-2.2.3/Object.html#method-i-tap) but only executes the block according to the condition.
+
+```ruby
+using Augmented::Objects::Tappable
+
+toast.tap_if(toast.warm?){ |toast| toast.butter }.eat
+toast.tap_if(:warm?.to_proc){ |toast| toast.butter }.eat
+```
+
 ##### `Object#thru`
 
 Applies a function to an object and returns the result.
 
 ```ruby
+using Augmented::Objects::Thru
+
 filter_words = -> s { s.gsub(/bad/, '').squeeze(' ').strip }
 
 'BAD WORDS, BAD WORDS'.downcase.thru(&filter_words).capitalize
@@ -124,6 +181,8 @@ filter_words = -> s { s.gsub(/bad/, '').squeeze(' ').strip }
 Chains several procs together so they execute from left to right.
 
 ```ruby
+using Augmented::Procs::Chainable
+
 sub_two = -> i { i - 2 }
 triple = -> i { i * 3 }
 add_twenty = -> i { i + 20 }
@@ -137,6 +196,8 @@ add_twenty = -> i { i + 20 }
 Like [`Symbol#to_proc`](http://ruby-doc.org/core-2.3.0/Symbol.html#method-i-to_proc) but allows you to pass some arguments along.
 
 ```ruby
+using Augmented::Symbols::Arguable
+
 class Eleven
   def add_many *others
     11 + others.reduce(0, :+)
@@ -152,6 +213,8 @@ end
 Creates functions that compare an object's attribute.
 
 ```ruby
+using Augmented::Symbols::Comparing
+
 class User
   def initialize name
     @name = name

data/lib/augmented/hashes/mappable.rb

@@ -0,0 +1,17 @@
+module Augmented
+  module Hashes
+    module Mappable
+      refine Hash do
+
+        def map_values
+          self.each_with_object({}){ |(key, value), result| result[key] = yield value, key, self }
+        end
+
+        def map_keys
+          self.each_with_object({}){ |(key, value), result| result[yield key, value, self] = value }
+        end
+
+      end
+    end
+  end
+end

data/lib/augmented/hashes.rb

@@ -1,8 +1,10 @@
+require 'augmented/hashes/mappable'
 require 'augmented/hashes/polymorphable'
 require 'augmented/hashes/transformable'
 
 module Augmented
   module Hashes
+    include Mappable
     include Polymorphable
     include Transformable
   end

data/lib/augmented/objects/iffy.rb

@@ -0,0 +1,34 @@
+module Augmented
+  module Objects
+    module Iffy
+      refine Object do
+
+        def if condition = self
+          self if (block_given? ? yield(self) : condition)
+        end
+
+        def else *_
+          self
+        end
+
+      end
+
+      refine NilClass do
+
+        def else alternative
+          alternative
+        end
+
+      end
+
+      refine FalseClass do
+
+        def else alternative
+          alternative
+        end
+
+      end
+
+    end
+  end
+end

data/lib/augmented/objects/tappable.rb

@@ -0,0 +1,19 @@
+module Augmented
+  module Objects
+    module Tappable
+      refine Object do
+
+        def tap_if condition, &block
+          do_tap = condition.respond_to?(:call) ? condition.call(self) : condition
+          do_tap ? self.tap(&block) : self
+        end
+
+        def tap_unless condition, &block
+          skip_tap = condition.respond_to?(:call) ? condition.call(self) : condition
+          skip_tap ? self : self.tap(&block)
+        end
+
+      end
+    end
+  end
+end

data/lib/augmented/objects.rb

@@ -1,11 +1,15 @@
+require 'augmented/objects/iffy'
 require 'augmented/objects/pickable'
 require 'augmented/objects/tackable'
+require 'augmented/objects/tappable'
 require 'augmented/objects/thru'
 
 module Augmented
   module Objects
+    include Iffy
     include Pickable
     include Tackable
+    include Tappable
     include Thru
   end
 end

data/lib/augmented/procs/chainable.rb

@@ -4,7 +4,7 @@ module Augmented
       refine Proc do
 
         def | other
-          -> (*args) { other.to_proc.call self.call(*args) }
+          -> *args { other.to_proc.call self.call(*args) }
         end
 
       end

data/lib/augmented/version.rb

@@ -1,3 +1,3 @@
 module Augmented
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/augmented/hashes/mappable_test.rb

@@ -0,0 +1,37 @@
+require 'minitest/autorun'
+require 'augmented/hashes/mappable'
+
+describe Augmented::Hashes::Mappable do
+  using Augmented::Hashes::Mappable
+
+  describe '#map_values' do
+
+    it 'returns a new hash with the same keys but transformed values' do
+      { aa: 11, bb: 22 }.map_values{ |i| i * 3 }.must_equal({ aa: 33, bb: 66 })
+    end
+
+    it 'also provides the key and hash to the tranformer function as additional arguments' do
+      hash = { aa: 11, bb: 22 }
+      result = hash.map_values{ |i, key, h| [key, h.object_id] }
+
+      result.values.must_equal [[:aa, hash.object_id], [:bb, hash.object_id]]
+    end
+
+  end
+
+  describe '#map_keys' do
+
+    it 'returns a new hash with the same values but transformed keys' do
+      { aa: 11, bb: 22 }.map_keys{ |k| k.to_s[0] }.must_equal({ 'a' => 11, 'b' => 22 })
+    end
+
+    it 'also provides the value and hash to the tranformer function as additional arguments' do
+      hash = { aa: 11, bb: 22 }
+      result = hash.map_keys{ |k, value, h| [value, h.object_id] }
+
+      result.keys.must_equal [[11, hash.object_id], [22, hash.object_id]]
+    end
+
+  end
+
+end

data/test/augmented/objects/iffy_test.rb

@@ -0,0 +1,47 @@
+require 'minitest/autorun'
+require 'augmented/objects/iffy'
+
+describe Augmented::Objects::Iffy do
+  using Augmented::Objects::Iffy
+
+  describe '#if' do
+
+    it 'returns the object if the condition evaluates to truish' do
+      subject = 'abc'
+      condition = -> subj { subj.length == 3 }
+
+      subject.if(true).must_be_same_as subject
+      subject.if(Object.new).must_be_same_as subject
+      subject.if(&condition).must_be_same_as subject
+    end
+
+    it 'returns nil if the condition evaluates to falsy' do
+      subject = 'abc'
+      condition = -> subj { subj.length == 0 }
+
+      subject.if(false).must_be_same_as nil
+      subject.if(nil).must_be_same_as nil
+      subject.if(&condition).must_be_same_as nil
+    end
+
+  end
+
+  describe '#else' do
+
+    it 'returns the alternative if the object is falsy' do
+      alternative = Object.new
+
+      false.else(alternative).must_be_same_as alternative
+      nil.else(alternative).must_be_same_as alternative
+    end
+
+    it 'returns the object if the object is truish' do
+      subject = Object.new
+
+      true.else(123).must_be_same_as true
+      subject.else(123).must_be_same_as subject
+    end
+
+  end
+
+end

data/test/augmented/objects/pickable_test.rb

@@ -7,7 +7,7 @@ describe Augmented::Objects::Pickable do
 
   describe '#pick' do
 
-    it 'returns an hash with the results of invoking the list of picks in the target' do
+    it 'returns a hash with the results of invoking the list of picks in the target' do
       target = OpenStruct.new aaa: 111, bbb: 222, ccc: 333
 
       target.pick(:aaa, :ccc).must_equal({ aaa: 111, ccc: 333 })

data/test/augmented/objects/tappable_test.rb

@@ -0,0 +1,141 @@
+require 'minitest/autorun'
+require 'augmented/objects/tappable'
+
+describe Augmented::Objects::Tappable do
+  using Augmented::Objects::Tappable
+
+  describe '#tap_if' do
+
+    it 'executes block if condition is truish' do
+      subject = 'abc'
+      test = nil
+
+      subject.tap_if(true) { |subj| test = subj.upcase }
+
+      test.must_equal 'ABC'
+
+      subject.tap_if(Object.new) { |subj| test = subj.reverse }
+
+      test.must_equal 'cba'
+    end
+
+    it 'does not execute block if condition is falsy' do
+      subject = 'abc'
+      test = nil
+
+      subject.tap_if(false) { |subj| test = subj.upcase }
+
+      test.must_equal nil
+
+      subject.tap_if(nil) { |subj| test = subj.upcase }
+
+      test.must_equal nil
+    end
+
+    it 'executes block if condition evaluates to truish' do
+      subject = 'abc'
+      test = nil
+      condition_1 = -> subj { subj.length == 3 }
+      condition_2 = -> subj { subj.length }
+
+      subject.tap_if(condition_1) { |subj| test = subj.upcase }
+
+      test.must_equal 'ABC'
+
+      subject.tap_if(condition_2) { |subj| test = subj.reverse }
+
+      test.must_equal 'cba'
+    end
+
+    it 'does not execute block if condition evaluates to falsy' do
+      subject = 'abc'
+      test = nil
+      condition_1 = -> subj { subj.length == 0 }
+      condition_2 = -> subj { nil }
+
+      subject.tap_if(condition_1) { |subj| test = subj.upcase }
+
+      test.must_equal nil
+
+      subject.tap_if(condition_2) { |subj| test = subj.upcase }
+
+      test.must_equal nil
+    end
+
+    it 'always returns the object' do
+      subject = 'abc'
+
+      subject.tap_if(true){}.must_be_same_as subject
+      subject.tap_if(false){}.must_be_same_as subject
+    end
+
+  end
+
+  describe '#tap_unless' do
+
+    it 'executes block if condition is falsy' do
+      subject = 'abc'
+      test = nil
+
+      subject.tap_unless(false) { |subj| test = subj.upcase }
+
+      test.must_equal 'ABC'
+
+      subject.tap_unless(nil) { |subj| test = subj.reverse }
+
+      test.must_equal 'cba'
+    end
+
+    it 'does not execute block if condition is truish' do
+      subject = 'abc'
+      test = nil
+
+      subject.tap_unless(true) { |subj| test = subj.upcase }
+
+      test.must_equal nil
+
+      subject.tap_unless(Object.new) { |subj| test = subj.upcase }
+
+      test.must_equal nil
+    end
+
+    it 'executes block if condition evaluates to falsy' do
+      subject = 'abc'
+      test = nil
+      condition_1 = -> subj { subj.length == 0 }
+      condition_2 = -> subj { nil }
+
+      subject.tap_unless(condition_1) { |subj| test = subj.upcase }
+
+      test.must_equal 'ABC'
+
+      subject.tap_unless(condition_2) { |subj| test = subj.reverse }
+
+      test.must_equal 'cba'
+    end
+
+    it 'does not execute block if condition evaluates to truish' do
+      subject = 'abc'
+      test = nil
+      condition_1 = -> subj { subj.length == 3 }
+      condition_2 = -> subj { subj.length }
+
+      subject.tap_unless(condition_1) { |subj| test = subj.upcase }
+
+      test.must_equal nil
+
+      subject.tap_unless(condition_2) { |subj| test = subj.upcase }
+
+      test.must_equal nil
+    end
+
+    it 'always returns the object' do
+      subject = 'abc'
+
+      subject.tap_unless(true){}.must_be_same_as subject
+      subject.tap_unless(false){}.must_be_same_as subject
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: augmented
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - bruno
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-04 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,11 +56,14 @@ files:
 - lib/augmented/enumerators.rb
 - lib/augmented/enumerators/indexing.rb
 - lib/augmented/hashes.rb
+- lib/augmented/hashes/mappable.rb
 - lib/augmented/hashes/polymorphable.rb
 - lib/augmented/hashes/transformable.rb
 - lib/augmented/objects.rb
+- lib/augmented/objects/iffy.rb
 - lib/augmented/objects/pickable.rb
 - lib/augmented/objects/tackable.rb
+- lib/augmented/objects/tappable.rb
 - lib/augmented/objects/thru.rb
 - lib/augmented/procs.rb
 - lib/augmented/procs/chainable.rb
@@ -69,10 +72,13 @@ files:
 - lib/augmented/symbols/comparing.rb
 - lib/augmented/version.rb
 - test/augmented/enumerators/indexing_test.rb
+- test/augmented/hashes/mappable_test.rb
 - test/augmented/hashes/polymorphable_test.rb
 - test/augmented/hashes/transformable_test.rb
+- test/augmented/objects/iffy_test.rb
 - test/augmented/objects/pickable_test.rb
 - test/augmented/objects/tackable_test.rb
+- test/augmented/objects/tappable_test.rb
 - test/augmented/objects/thru_test.rb
 - test/augmented/procs/chainable_test.rb
 - test/augmented/symbols/arguable_test.rb
@@ -103,10 +109,13 @@ specification_version: 4
 summary: Useful extra methods for some Ruby core types.
 test_files:
 - test/augmented/enumerators/indexing_test.rb
+- test/augmented/hashes/mappable_test.rb
 - test/augmented/hashes/polymorphable_test.rb
 - test/augmented/hashes/transformable_test.rb
+- test/augmented/objects/iffy_test.rb
 - test/augmented/objects/pickable_test.rb
 - test/augmented/objects/tackable_test.rb
+- test/augmented/objects/tappable_test.rb
 - test/augmented/objects/thru_test.rb
 - test/augmented/procs/chainable_test.rb
 - test/augmented/symbols/arguable_test.rb