immutable_struct_ex 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a0a34457a9487fc3f303f5605d59b4b16e31621f7d3a3fdeb6ea3c2cb3df0bb
-  data.tar.gz: d7e39e8460fac3985e54929ef0ceda6dba990468daaceb666094149a784fbd06
+  metadata.gz: aa4a48dbdce57780e5b5d4070af7cc8c23178bfce3ad7fe7aa7f4ccb5c8c57bd
+  data.tar.gz: '093d4b2a568379b9f3a60c408e8b193c3529b08747a187a0c89740e3b5d18d10'
 SHA512:
-  metadata.gz: 9d2058c398d2083f608ad57b1b54f9c4a0379a95645a36479bdb02007ef0acfe0560d58576c47bc754dad21830876f027329f163f1326dd3139700967c8aaa0d
-  data.tar.gz: c222c628b6b35c8ef5598c644460246b4f015e754bf5d65cdc3b3dc045e56a0a4fcf0efc5224f2c626ea0d8c41c65eefcde462f35b179ecd4954581f4dc28c3d
+  metadata.gz: 0c0ac39ffb5460f9d7a02495758285d2cb6407d985f8bb1c52eff686e5e015bc3a28e5bc33a7a091507cb93a40348eebebe563cc6aaf49d0d65b7e54f6b33c2d
+  data.tar.gz: e3bbb35209074a059fd695aec4da31d60731929633c88e268bb643bdd0fd433530cb3f44bb57377e478a571cfaeae5a87cad0fd44084b2bb94b11270f50c4ac2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.3.0
+* Changes
+  * Update README.md file with the correct gem name.
+
 ### 0.2.3
 * Bug fix
   * Fix bug in specs that failed to add criteria for passing tests (e.g. ".to eq true/false") so tests could not fail.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    immutable_struct_ex (0.2.3)
+    immutable_struct_ex (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -86,4 +86,4 @@ DEPENDENCIES
   simplecov (~> 0.21.2)
 
 BUNDLED WITH
-   2.3.20
+   2.3.22

data/README.md

@@ -8,9 +8,9 @@
 
 [![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
 
-# ImmutableStructEx
+# immutable_struct_ex
 
-_ImmutableStructEx_ is yet another immutable struct. What makes ImmutableStructEx different, is that it allows you to create immutable structs in one step _by default_. In other words, other immutable struct gems force you to first define the struct, then instantiate the struct object; or, define the struct and instantiate the struct object via chaining. For example:
+immutable_struct_ex is yet another immutable struct. What makes immutable_struct_ex different, is that it allows you to create immutable structs in one step _by default_. In other words, other immutable struct gems force you to first define the struct, then instantiate the struct object; or, define the struct and instantiate the struct object via chaining. For example:
 
 ## Other Immutable Structs
 
@@ -24,31 +24,38 @@ some_immutable_struct = SomeImmutableStruct.new(:first, :last, :phone)
                           .new(first: 'John', last: 'Doe', phone: '(201) 230-7281')
 ```
 
-## ImmutableStructEx
-ImmutableStructEx allows you do this in one step:
+## immutable_struct_ex
+immutable_struct_ex allows you to instantiate and initialize the object _in one step:_
 
 ```ruby
 immutable_struct_ex = ImmutableStructEx.new(first: 'John', last: 'Doe', phone: '(201) 230-7281')
+
 immutable_struct_ex.first
 #=> 'John'
+
 immutable_struct_ex[:first]
 #=> 'John'
+
 immutable_struct_ex.last
 #=> 'Doe'
+
 immutable_struct_ex.phone
 #=> '(201) 230-7281'
 ```
 ### Immutable
-Like other immutable structs, ImmutableStructEx also removes methods that change the state of the object:
+Like other immutable structs, immutable_struct_ex also removes methods that change the state of the object, making it _immutable:_
+
 ```ruby
 immutable_struct_ex.first = 'Joe'
 #=> NoMethodError: undefined method `first='...
+
 immutable_struct_ex[:first] = 'Joe'
 #=> NoMethodError: undefined method `[]='...
 ```
 
 ### Blocks
-Also, not unlike other immutable structs, ImmutableStructEx also allows you to pass a block:
+Also, not unlike other immutable structs, immutable_struct_ex also allows you to pass a block:
+
 ```ruby
 # With a block
 immutable_struct_ex = ImmutableStructEx.new(first: 'John', last: 'Doe', phone: '(201) 230-7281') do
@@ -56,14 +63,22 @@ immutable_struct_ex = ImmutableStructEx.new(first: 'John', last: 'Doe', phone: '
     first == 'John'
   end
 end
+
 immutable_struct_ex.john?
 #=> true
 ```
 
 ### Other Examples
+Get creative. Below is an example of an immutable struct that provides _redaction_:
+
 ```ruby
 # Redactable, immutable struct
-user = { username: 'jdoe', password: 'p@55w0rD', ssn: '123-70-9182' }
+user = {
+  username: 'jdoe',
+  password: 'p@55w0rD',
+  ssn: '123-70-9182'
+}
+
 immutable_struct_ex = ImmutableStructEx.new(**user) do
   REDACT = %i(password ssn).freeze
 

data/lib/immutable_struct_ex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImmutableStructEx
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immutable_struct_ex
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2022-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: Creates an immutable struct in one step.