xf 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 834016d61fb0ca6d052c441bd9ca2a864e859ae3573fd94a85a6b35d90741169
-  data.tar.gz: 364f4a15f6cfb7495a201a4093105f0dc3796fbe0f5f3faa403b541ce56eade0
+  metadata.gz: ca75c5042852e2391ad547df17f005f23987bfd780512d5d4e3d3f9d963bf972
+  data.tar.gz: 28cf81f1673af0b96ba1d2e469a181c68539105a45cdaf99970716290c62f22d
 SHA512:
-  metadata.gz: 199dd67f1f1bfc4f607c11e9f5c4c1cf25ec69844d265320ea610932055e3d859c2a52d294262581de26e3613657e8de5034fede1dd57bf053423513268061d4
-  data.tar.gz: b929b55e0789431a0362238c6405dc06372fabe29a2e53ae5f61f649e76dc77197f0c0a73282e07b7e519e8e3185642980792f9e903f66e2e9fc22726ec8d753
+  metadata.gz: 851f5270c4cd9815bfdf96b0c56ef338b21f0e176990a8e67f3a63c1f50f63d71571c1bb2270bddb3c989a4f48985f968f102e80819b25a7de5d31844afc34ed
+  data.tar.gz: d00cab86f2bd53031e2d7e19cdb0b7eac9185519430a0e600abeb6e021b9a721cf7a777c868122716ebe6397caf2f8d374bb19c0770b593bd02f00f4cee57ebc

data/README.md

@@ -26,7 +26,7 @@
 
 ## Features
 
-For the moment, compose:
+**Compose**
 
 ```ruby
 %w(1 2 3 4).map(&Xf.compose(:to_i, :succ))
@@ -34,6 +34,56 @@ For the moment, compose:
 
 If it looks like a Proc, or can be convinced to become one, it will work there.
 
+**Scopes**
+
+A Scope is a play on a [concept from Haskell called a Lense](http://hackage.haskell.org/package/lens-tutorial-1.0.3/docs/Control-Lens-Tutorial.html).
+
+The idea is to be able to define a path to a transformation and either get or
+set against it as a first class function. Well, easier shown than explained.
+
+To start with we can do a few gets:
+
+```ruby
+people = [{name: "Robert", age: 22}, {name: "Roberta", age: 22}, {name: "Foo", age: 42}, {name: "Bar", age: 18}]
+
+people.map(&Xf.scope(:age).get)
+# => [22, 22, 42, 18]
+```
+
+Let's try setting a value:
+
+```ruby
+people = [{name: "Robert", age: 22}, {name: "Roberta", age: 22}, {name: "Foo", age: 42}, {name: "Bar", age: 18}]
+
+older_people = people.map(&Xf.scope(:age) { |age| age + 1 })
+
+older_people = people.map(&Xf.scope(:age).set { |age| age + 1 })
+# => [{:name=>"Robert", :age=>23}, {:name=>"Roberta", :age=>23}, {:name=>"Foo", :age=>43}, {:name=>"Bar", :age=>19}]
+
+people
+# => [{:name=>"Robert", :age=>22}, {:name=>"Roberta", :age=>22}, {:name=>"Foo", :age=>42}, {:name=>"Bar", :age=>18}]
+
+# set! will mutate, for those tough ground in issues:
+
+older_people = people.map(&Xf.scope(:age).set! { |age| age + 1 })
+# => [{:name=>"Robert", :age=>23}, {:name=>"Roberta", :age=>23}, {:name=>"Foo", :age=>43}, {:name=>"Bar", :age=>19}]
+
+people
+# => [{:name=>"Robert", :age=>23}, {:name=>"Roberta", :age=>23}, {:name=>"Foo", :age=>43}, {:name=>"Bar", :age=>19}]
+```
+
+It works much the same as `Hash#dig` in that you can pass multiple comma-seperated values as a deeper path:
+
+```
+Xf.scope(:children, 0, :name).get.call({name: 'Foo', children: [{name: 'Bar'}]})
+# => "Bar"
+
+Xf.scope(:children, 0, :name).set('Baz').call({name: 'Foo', children: [{name: 'Bar'}]})
+# => {:name=>"Foo", :children=>[{:name=>"Baz"}]}
+```
+
+That means array indexes work too, and on both `get` and `set` methods!
+
 ## Screencasts
 
 ## Requirements

data/lib/xf/identity.rb

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

data/lib/xf/public_api.rb

@@ -20,8 +20,21 @@ module Xf
 
     alias_method :c, :compose
 
+    # Creates a Scope.
+    #
+    # @see Xf::Scope
+    #
+    # @note
+    #   See the README for more instructions on usage. Will likely propogate
+    #   more examples here and into the specs later.
+    #
+    # @param *path [Array[Any]] Hash#dig accessible segments
+    #
+    # @return [Xf::Scope]
     def scope(*path)
       Scope.new(path)
     end
+
+    alias_method :s, :scope
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brandon Weaver