immutable_struct_ex 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a0a34457a9487fc3f303f5605d59b4b16e31621f7d3a3fdeb6ea3c2cb3df0bb
-  data.tar.gz: d7e39e8460fac3985e54929ef0ceda6dba990468daaceb666094149a784fbd06
+  metadata.gz: 2fce441affccae142eb67911aaecfdf0886a6ea60aa505bb7ee404217ec178d3
+  data.tar.gz: b39016ae4dcf0c28c4381d391cb5597f835497b92551459a54ffb3d79331138d
 SHA512:
-  metadata.gz: 9d2058c398d2083f608ad57b1b54f9c4a0379a95645a36479bdb02007ef0acfe0560d58576c47bc754dad21830876f027329f163f1326dd3139700967c8aaa0d
-  data.tar.gz: c222c628b6b35c8ef5598c644460246b4f015e754bf5d65cdc3b3dc045e56a0a4fcf0efc5224f2c626ea0d8c41c65eefcde462f35b179ecd4954581f4dc28c3d
+  metadata.gz: 411878a19d161a2784424180a7de70e1f4fdda4d6a115ae3e4af2f54fd0781bf345ea1a51977e0707e1d8a2579bbcd30208ddb782a225679ecbb517cec86e68b
+  data.tar.gz: fa0f13ecb0161bf674a24b272a4254c6a957e7b12df10d87adde9127b9b2542b0da4858e8392ba1fe91ab4ddcaecff8ada10e9e50bf5a6eb40626d9659987957

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 1.0.0
+* Changes (not really a breaking change, but just wanted to bump to 1.0.0)
+  * Limit required ruby version to ~> 3.0.
+  * Update ruby gems.
+
+### 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 (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,50 +17,50 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
+      pry (>= 0.13, < 0.15)
     rainbow (3.1.1)
     rake (13.0.6)
     reek (6.1.1)
       kwalify (~> 0.7.0)
       parser (~> 3.1.0)
       rainbow (>= 2.0, < 4.0)
-    regexp_parser (2.5.0)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.35.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.14.3)
+    rubocop-performance (1.15.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.12.1)
-      rubocop (~> 1.31)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -68,7 +68,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   x86_64-darwin-19
@@ -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/immutable_struct_ex.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Creates an immutable struct in one step.'
   spec.homepage      = 'https://github.com/gangelo/immutable_struct_ex'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 3.0.1'
+  spec.required_ruby_version = Gem::Requirement.new("~> 3.0")
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.

data/lib/immutable_struct_ex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImmutableStructEx
-  VERSION = '0.2.3'
+  VERSION = '1.0.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: 1.0.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -203,16 +203,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 3.0.1
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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.