xf 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62d3af5779614c09634b6f1e53a0507832f1cddc051693f8ccda36fd29cf1862
-  data.tar.gz: 357c3a4807a9e5edb5d82c02ed06be8acd25d7e8e5e3224caeb8d67c2a4ad27d
+  metadata.gz: 7b22d8834efc5ccf08dbe6de45136a10b852a88028ba851c74e7f0156fbc451d
+  data.tar.gz: de850927d2c583eed59712be6a9d9c7e5b8f00ef43cb2091938a4138b877f905
 SHA512:
-  metadata.gz: c76a5dea28717e733bb1938000fe5efaff5ceb8178f6b46b66d86916bcc1217274cafc05cd6bca3cc0f1986b60f1f93524c18dee29748ad8deea1c74a22ebe35
-  data.tar.gz: 44657cd1c09fbd8e624ebcaf807dfc1c705b4434d8bc51084ff735a59b677eb7cc5785188fa7788b6d5d79f7673a3e3b75151b2334cabf765825c954dc89426c
+  metadata.gz: 9067391391eae8e1501fd9cc760865d659bc78624ab6e3c4f671790a1a6ffce05e11396ffaf547eb73006a0a6b71b1507a999ef5130d8824d3230b5add00d463
+  data.tar.gz: d6b465abbf9480e19b5c206071a49a9f127cc8e9c8dd737a5a72329c989f42653a9d6755355f333f58a4cb1d545de9c0ccc36dc472d6198f7e13f963d5705be5

data/README.md

@@ -6,6 +6,18 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/905faea654f9e0a1f811/test_coverage)](https://codeclimate.com/github/baweaver/xf/test_coverage)
 [![Build Status](https://travis-ci.org/baweaver/xf.svg?branch=master)](https://travis-ci.org/baweaver/xf)
 
+![Xf Lemur logo](img/xf_logo.png)
+
+Xf - Short for Xform or Transform Functions meant to manipulate
+Enumerables, namely deep Hashes.
+
+## Articles
+
+### How it was made
+
+* [Xf Part One - Scopes](https://medium.com/@baweaver/on-dealing-with-deep-hashes-in-ruby-xf-part-one-scopes-f63447d59ee1)
+* [Xf Part Two - Traces](https://medium.com/@baweaver/on-dealing-with-deep-hashes-in-ruby-xf-part-two-traces-23b52546a753)
+
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
 ## Table of Contents

data/lib/xf/identity.rb

@@ -12,7 +12,7 @@ module Xf
     end
 
     def self.version
-      "0.1.0"
+      "0.1.1"
     end
 
     def self.version_label

data/lib/xf/public_api.rb

@@ -133,6 +133,10 @@ module Xf
       }
     end
 
+    def slice(*keys)
+      Proc.new { |hash| hash.slice(*keys) }
+    end
+
     # Solely meant as a tap addendum
     #
     # @return [Proc[Any] -> nil]

data/lib/xf/scope.rb

@@ -17,8 +17,8 @@ module Xf
     # Gets a value from a Hash
     #
     # @return [type] [description]
-    def get
-      method(:get_value)
+    def get(&fn)
+      Proc.new { |hash| get_value(hash, &fn) }
     end
 
     # Sets a value in a Hash
@@ -54,8 +54,10 @@ module Xf
     # @param hash [Hash] Hash to get value from
     #
     # @return [Any]
-    def get_value(hash)
-      hash.dig(*@paths)
+    def get_value(hash, &fn)
+      value = hash.dig(*@paths)
+
+      block_given? ? fn[value] : value
     end
 
     # Sets a value at the bottom of a path without mutating the original.

data/lib/xf/trace.rb

@@ -20,14 +20,24 @@ module Xf
       @trace_path = trace_path
     end
 
-    def get
-      Proc.new { |target| get_value(target) }
+    # Gets a value from a Hash
+    #
+    # @param &fn [Proc]
+    #   Block to yield the hash, key, and value from any matching element
+    #   into. Used to transform returned values upon retrieval
+    #
+    # @return [Proc[Hash] -> Array]
+    #   Array containing matching values, optionally transformed
+    def get(&fn)
+      Proc.new { |target| get_value(target, &fn) }
     end
 
-    def get_value(hash)
+    def get_value(hash, &fn)
       retrieved_values = []
 
-      recursing_dive(hash) { |h, k, v| retrieved_values.push(v) }
+      recursing_dive(hash) { |h, k, v|
+        retrieved_values.push(block_given? ? fn[h, k, v] : v)
+      }
 
       retrieved_values
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Brandon Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2018-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemsmith