xf 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9df7279d149753a1c1a73ad78abf38d217ad745adcf914a3c561fb776b1f116a
-  data.tar.gz: 709dad6362cf6792ae3d7051f563940161a6dfd666074f156760712f53c8eec2
+  metadata.gz: 834016d61fb0ca6d052c441bd9ca2a864e859ae3573fd94a85a6b35d90741169
+  data.tar.gz: 364f4a15f6cfb7495a201a4093105f0dc3796fbe0f5f3faa403b541ce56eade0
 SHA512:
-  metadata.gz: 74261ad1e8b45bae2bfa7a65e349619270f0e57920c3517c02387dfa849dca81a4f5249aef1baf0b365335b03d3c93cceb227fdc59cf8a5afecea6a30ef202bd
-  data.tar.gz: d8b33f75ecf8b681593058e9d19f6f453b35bb0723169f3fabf2848b7b953276de459b0eaeeee50d0dad19c94b8bbfbcc3aafb3cb1779ed062e2fc00e0b3179c
+  metadata.gz: 199dd67f1f1bfc4f607c11e9f5c4c1cf25ec69844d265320ea610932055e3d859c2a52d294262581de26e3613657e8de5034fede1dd57bf053423513268061d4
+  data.tar.gz: b929b55e0789431a0362238c6405dc06372fabe29a2e53ae5f61f649e76dc77197f0c0a73282e07b7e519e8e3185642980792f9e903f66e2e9fc22726ec8d753

data/lib/xf/identity.rb

@@ -12,7 +12,7 @@ module Xf
     end
 
     def self.version
-      "0.0.1"
+      "0.0.2"
     end
 
     def self.version_label

data/lib/xf/public_api.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'xf/scope'
+
 module Xf
   module PublicApi
     # Composes a list of functions, or items that respond to `to_proc`, into
@@ -17,5 +19,9 @@ module Xf
     end
 
     alias_method :c, :compose
+
+    def scope(*path)
+      Scope.new(path)
+    end
   end
 end

data/lib/xf/scope.rb

@@ -0,0 +1,81 @@
+module Xf
+  # A play on Lenses in Ruby, though not quite as powerful they can be
+  # useful for getting and setting deep values on collections.
+  #
+  # @author baweaver
+  # @since 0.0.2
+  #
+  class Scope
+    # Creates a Scope
+    # @param paths [Array[Any]] Paths to follow to reach the desired value
+    #
+    # @return [Xf::Scope]
+    def initialize(paths)
+      @paths = paths
+    end
+
+    # Gets a value from a Hash
+    #
+    # @return [type] [description]
+    def get
+      method(:get_value)
+    end
+
+    # Sets a value in a Hash
+    #
+    # @param value = nil [Any]
+    #   Value to set at the target
+    #
+    # @param &fn [Proc]
+    #   Block to yield target value to. Returned value will be set as the new
+    #   value at the target.
+    #
+    # @return [Proc[Hash] -> Hash]
+    #   New Hash with transformation applied
+    def set(value = nil, &fn)
+      Proc.new { |hash| set_value(hash, value, &fn) }
+    end
+
+    # Mutates a value in a Hash
+    #
+    # @see #set
+    #
+    # @note
+    #   This method does the same thing as `#set`, except that it mutates the
+    #   target value instead of creating a clone first.
+    #
+    def set!(value = nil, &fn)
+      Proc.new { |hash| set_value!(hash, value, &fn) }
+    end
+
+    # Private API - Methods below here are subject to change, please don't use
+    # them directly.
+
+    private def get_value(hash)
+      hash.dig(*@paths)
+    end
+
+    private def set_value(hash, value = nil, &fn)
+      set_value!(deep_clone(hash), value, &fn)
+    end
+
+    private def set_value!(hash, value = nil, &fn)
+      lead_in    = @paths[0..-2]
+      target_key = @paths[-1]
+
+      dive = lead_in.reduce(hash) { |h, s| h[s] }
+
+      new_value = block_given? ?
+        yield(dive[target_key]) :
+        value
+
+      dive[target_key] = new_value
+
+      hash
+    end
+
+    private def deep_clone(hash)
+      Marshal.load(Marshal.dump(hash))
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brandon Weaver
@@ -178,6 +178,7 @@ files:
 - lib/xf.rb
 - lib/xf/identity.rb
 - lib/xf/public_api.rb
+- lib/xf/scope.rb
 homepage: https://www.github.com/baweaver/xf
 licenses:
 - MIT