ruby-optics 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a90f6ad934879e9b5522055637df2dc1386b6931c8c69ab7474f5dd1ba5591
-  data.tar.gz: f165845f3ac79940f54071fa66dcbf673157af38dd69ae0094b89acb1c89326c
+  metadata.gz: 940e5fe97670b6b7f24cc4bc52036f68ae81655746d5c869a572738ee063be36
+  data.tar.gz: 83b101c570650bb94bea1da8bee87031397ff2ad2947beca8cab16a95cce541b
 SHA512:
-  metadata.gz: 70ee1a8f3f1be4e7f4401c937dea535e19e85f7d39d6e54418fb48c6df93c4d81ac1e5bb1748df0ab6c1f033b6550d96b5a9073256643cd30c45d089b825c99b
-  data.tar.gz: 0f9b3bd70954701427f663839c56a1ae00f35f1592efbf07a87bb956c41ae8938fab9f9df9a484531fe8e6b3884d526ddca379151a2d7cd70f41585063fae2b1
+  metadata.gz: ff68227c0e6702687bbe1c2bb7fa47a91fcf6ed96121f0405e846030466b498bdcac482899d4c5563129f82ff64d0c2c4e669355789fc3d5930eb62bab1a2164
+  data.tar.gz: fd2f4c09fa8ad9231f06ebc2b1b2823afd662d94096f95f69f010e962d146dff9bdb537178cff27dcb523d2cd5d7ed6cb604c695855cec29ab738c55edf36084

data/README.md

@@ -2,13 +2,102 @@
 
 Simple library with common functional optics for Ruby.
 
-## Links
-
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.5.1`
+* MRI = `2.5.0`
+
+## Installation
+
+Add this to your Gemfile
+```ruby
+gem 'ruby-optics'
+```
+
+and then run
+
+```
+bundle install
+```
+
+Or install it manually
+
+```
+gem install ruby-optics
+```
+
+## Usage
+
+Lens - is an object which encapsulates getter/setter functionality for immutable data in composable way. 
+Any lens consist of two functions `set` and `get`. `get` describes how can retrieve a value from a whole object, and `set` - how to update this value without mutating the object.
+
+Example for getting/setting value by key from hash:
+```ruby
+def hash_get(key)
+  -> (hash) { hash[key] }
+end
+
+def hash_set(key)
+  -> (new_value, hash) { hash.merge(key => new_value) }
+end
+```
+
+To create lens you need to specify both these functions:
+
+```ruby
+lens = Lens.new(hash_get(:foo), hash_set(:foo))
+```
+
+Then you can use the lens to retrieve, set and modify value by the key in arbitrary hash:
+
+```ruby
+object = { foo: 1, bar: 2 }
+
+lens.get(object)
+=> 2
+
+lens.set(3, object)
+=> { foo: 3, bar: 2 }
+
+lens.modify(object) { |foo| foo * 10 }
+=> { foo: 10, bar: 2 }
+
+object
+=> { foo: 1, bar: 2 }
+```
+
+Note that `set` and `modify` operations don't mutate original value, thus keeping it unchanged.
+
+The real power of lens comes from their compositional properties, which allows to creates lenses that works with arbitrary nested
+objects by composing them from simpler ones.
+
+```ruby
+foo_lens = Lens.new(hash_get(:foo), hash_set(:foo))
+bar_lens = Lens.new(hash_get(:bar), hash_set(:bar))
+
+lens = foo_lens.compose_lens(bar_lens)
+
+object = { foo: { bar: 1 } }
+
+lens.get(object)
+=> 1
+
+lens.set(3, object)
+=> { foo: { bar: 3 } }
+
+lens.modify(object) { |foo| foo * 10 }
+=> { foo: { bar: 10 } }
+
+object
+=> { foo: { bar: 1 } }
+```
+
+The library provides lens constructors for common cases, so you don't need to composes lenses yourself
+```ruby
+lens = Optics.hash_lens(:foo, :bar)
+```
+
 
 ## License
 

data/lib/ruby-optics.rb

@@ -4,5 +4,5 @@ require 'ruby-optics/optics'
 require 'ruby-optics/record/record'
 
 module Optics
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/ruby-optics/record/record.rb

@@ -12,10 +12,11 @@ module Record
       attribute_name = defined_attribute_params[:attribute_name]
       attribute_argument = args_hash[attribute_name]
       if attribute_argument.nil?
-        if defined_attribute_params[:nullable]
+        default_value = defined_attribute_params[:default]
+        if defined_attribute_params[:nullable] || default_value
           instance_variable_set(
             :"@#{attribute_name}",
-            defined_attribute_params[:default]
+            default_value
           )
         else
           raise ArgumentError.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-optics
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniil Bober
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-06 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler