immutable_struct_ex 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a93f45b29cdb392b541307fc4d6cf8299cb94b2c70611c65d5837d006be43c
-  data.tar.gz: 7e9239039e3226bd00ca971716b7470d620d11dc1997182cbe8c388af7b36a47
+  metadata.gz: 1a0a34457a9487fc3f303f5605d59b4b16e31621f7d3a3fdeb6ea3c2cb3df0bb
+  data.tar.gz: d7e39e8460fac3985e54929ef0ceda6dba990468daaceb666094149a784fbd06
 SHA512:
-  metadata.gz: 51ad57864c9b892f7c5327bfba585f5e511b5eeb7dd1b707b5a284fa31b3f3b06c5ef14f808adb7e6d1df0ab372e1ca117843eefc9ec6dcd02265e34c7b08574
-  data.tar.gz: caa878e4c999c39efd6f55e605518c92e330aa9f9a407cfaea4c9f33196feb4df29224784433623a70c701280409491ce8182cb2cb97a135a2c6117f94886650
+  metadata.gz: 9d2058c398d2083f608ad57b1b54f9c4a0379a95645a36479bdb02007ef0acfe0560d58576c47bc754dad21830876f027329f163f1326dd3139700967c8aaa0d
+  data.tar.gz: c222c628b6b35c8ef5598c644460246b4f015e754bf5d65cdc3b3dc045e56a0a4fcf0efc5224f2c626ea0d8c41c65eefcde462f35b179ecd4954581f4dc28c3d

data/.gitignore

@@ -13,6 +13,7 @@
 # rspec failure tracking
 .rspec_status
 
+/.vscode/
 *.code-workspace
 
 scratch.rb

data/CHANGELOG.md

@@ -1,6 +1,24 @@
+### 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.
+
+### 0.2.2
+* Changes
+  * Restructure modules under lib/immutable_structure_ex folder.
+  * Make codez to create struct a little cleaner/tighter.
+  * Ignore .vscode folder in .gitignore file.
+  * Update gems and especially rake gem version to squash CVE-2020-8130, see https://github.com/advisories/GHSA-jppv-gw3r-w3q8.
+  * Fix rubocop violations.
+
+### 0.2.1
+* Enhancements
+  * General refactors/cleanup.
+  * Added Immutable module; when extended on a struct, makes it immutable.
+  * Added Comparable module; when extended on a struct, makes it comparable to other structs and hashes.
+
 ### 0.1.1
 * Enhancements
-  * Added this CHANGELOG.md
+  * Added this CHANGELOG.md.
 * Bug fix
   * Equality method #== did not work when comparing objects whose underlying hashes were equal.
   * Added #== method to compare underlying hashes by calling a.to_h == b.to_h.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    immutable_struct_ex (0.1.1)
+    immutable_struct_ex (0.2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -11,6 +11,7 @@ GEM
     coderay (1.1.3)
     diff-lcs (1.5.0)
     docile (1.4.0)
+    json (2.6.2)
     kwalify (0.7.2)
     method_source (1.0.0)
     parallel (1.22.1)
@@ -23,7 +24,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rainbow (3.1.1)
-    rake (10.5.0)
+    rake (13.0.6)
     reek (6.1.1)
       kwalify (~> 0.7.0)
       parser (~> 3.1.0)
@@ -43,13 +44,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.9.1)
+    rubocop (1.35.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.21.0)
@@ -57,9 +59,8 @@ GEM
     rubocop-performance (1.14.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -73,15 +74,15 @@ PLATFORMS
   x86_64-darwin-19
 
 DEPENDENCIES
-  bundler (~> 2.3.0)
+  bundler (~> 2.2, >= 2.2.17)
   immutable_struct_ex!
   pry-byebug (~> 3.9)
-  rake (~> 10.0)
-  reek (~> 6.0, >= 6.0.4)
-  rspec (~> 3.0)
-  rubocop (~> 1.9.1)
-  rubocop-performance (~> 1.11, >= 1.11.3)
-  rubocop-rspec (~> 2.3)
+  rake (~> 13.0, >= 13.0.6)
+  reek (~> 6.1, >= 6.1.1)
+  rspec (>= 3.10)
+  rubocop (~> 1.35)
+  rubocop-performance (~> 1.14, >= 1.14.3)
+  rubocop-rspec (~> 2.12, >= 2.12.1)
   simplecov (~> 0.21.2)
 
 BUNDLED WITH

data/README.md

@@ -1,3 +1,13 @@
+[![GitHub version](http://badge.fury.io/gh/gangelo%2Fimmutable_struct_ex.svg)](https://badge.fury.io/gh/gangelo%2Fimmutable_struct_ex)
+[![Gem Version](https://badge.fury.io/rb/immutable_struct_ex.svg)](https://badge.fury.io/rb/immutable_struct_ex)
+
+[![](http://ruby-gem-downloads-badge.herokuapp.com/immutable_struct_ex?type=total)](http://www.rubydoc.info/gems/immutable_struct_ex/)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/immutable_struct_ex/)
+
+[![Report Issues](https://img.shields.io/badge/report-issues-red.svg)](https://github.com/gangelo/immutable_struct_ex/issues)
+
+[![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
+
 # ImmutableStructEx
 
 _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:
@@ -19,13 +29,13 @@ ImmutableStructEx allows you do this in one step:
 
 ```ruby
 immutable_struct_ex = ImmutableStructEx.new(first: 'John', last: 'Doe', phone: '(201) 230-7281')
-immutable_struct_ex.first   
+immutable_struct_ex.first
 #=> 'John'
 immutable_struct_ex[:first]
 #=> 'John'
-immutable_struct_ex.last    
+immutable_struct_ex.last
 #=> 'Doe'
-immutable_struct_ex.phone   
+immutable_struct_ex.phone
 #=> '(201) 230-7281'
 ```
 ### Immutable
@@ -50,6 +60,39 @@ immutable_struct_ex.john?
 #=> true
 ```
 
+### Other Examples
+```ruby
+# Redactable, immutable struct
+user = { username: 'jdoe', password: 'p@55w0rD', ssn: '123-70-9182' }
+immutable_struct_ex = ImmutableStructEx.new(**user) do
+  REDACT = %i(password ssn).freeze
+
+  def inspect
+    to_s
+  end
+
+  def to_s
+    super.to_s.tap do |string|
+      REDACT.each do |redact|
+        string.gsub!(/( #{Regexp.quote(redact.to_s)}=")(.*?)(")/, '\1[REDACTED]\3')
+      end
+    end
+  end
+
+  def to_h
+    super.to_h.tap do |hash|
+      REDACT.each { |redact| hash[redact] = '[REDACTED]' }
+    end
+  end
+end
+
+immutable_struct_ex.inspect
+#=> "#<struct username=\"jdoe\", password=\"[REDACTED]\", ssn=\"[REDACTED]\">"
+
+immutable_struct_ex.to_h
+#=> {:username=>"jdoe", :password=>"[REDACTED]", :ssn=>"[REDACTED]"}
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/bin/console

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
+require 'pry'
 require 'immutable_struct_ex'
 
 # You can add fixtures and/or initialization code here to make experimenting

data/immutable_struct_ex.gemspec

@@ -32,16 +32,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.17'
   spec.add_development_dependency 'pry-byebug', '~> 3.9'
-  spec.add_development_dependency 'reek', '~> 6.0', '>= 6.0.4'
-  # This verson of rubocop is returning errors.
-  # spec.add_development_dependency 'rubocop', '~> 1.14'
-  spec.add_development_dependency 'rubocop', '~> 1.9.1'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.11', '>= 1.11.3'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.3'
+  spec.add_development_dependency 'reek', '~> 6.1', '>= 6.1.1'
+  spec.add_development_dependency 'rspec', '>= 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.35'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.14', '>= 1.14.3'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.12', '>= 2.12.1'
   spec.add_development_dependency 'simplecov', '~> 0.21.2'
-
-  spec.add_development_dependency 'bundler', '~> 2.3.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
 end

data/lib/immutable_struct_ex/comparable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ImmutableStructEx
+  # Makes a struct comparable with another struct or hash when extended.
+  module Comparable
+    class << self
+      def extended(struct)
+        struct.instance_eval do
+          def ==(other)
+            return false unless other.is_a?(Hash) || other.is_a?(Struct)
+
+            to_h == other.to_h
+          end
+        end
+      end
+    end
+  end
+end

data/lib/immutable_struct_ex/immutable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ImmutableStructEx
+  # Makes a struct immutable when extended.
+  module Immutable
+    class << self
+      def extended(struct)
+        [:[], *struct.members].each do |method|
+          struct.instance_eval do
+            undef :"#{method}="
+          end
+        end
+      end
+    end
+  end
+end

data/lib/immutable_struct_ex/version.rb

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

data/lib/immutable_struct_ex.rb

@@ -1,34 +1,19 @@
 # frozen_string_literal: true
 
 require 'immutable_struct_ex/version'
+require 'immutable_struct_ex/comparable'
+require 'immutable_struct_ex/immutable'
 
 # Defines the methods used to create/manage the ImmutableStructEx struct.
 module ImmutableStructEx
   class << self
     def new(**hash, &block)
-      options_struct = Struct.new(*hash.keys, keyword_init: true, &block)
-      options_struct.new(**hash).tap do |struct|
-        [:[], *struct.members].each do |method|
-          evaluate(struct) do
-            <<~RUBY
-              undef :"#{method}="
-            RUBY
-          end
-        end
-        evaluate(struct) do
-          <<~RUBY
-            def ==(object)
-              return false unless object.respond_to? :to_h
-
-              to_h == object.to_h
-            end
-          RUBY
+      Struct.new(*hash.keys, keyword_init: true, &block).tap do |struct|
+        return struct.new(**hash).tap do |struct_object|
+          struct_object.extend Comparable
+          struct_object.extend Immutable
         end
       end
     end
-
-    def evaluate(struct)
-      struct.instance_eval yield
-    end
   end
 end

metadata

@@ -1,153 +1,171 @@
 --- !ruby/object:Gem::Specification
 name: immutable_struct_ex
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.17
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.17
 - !ruby/object:Gem::Dependency
-  name: reek
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.0.4
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.0.4
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.1
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.11.3
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.11.3
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.35'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.35'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.3
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
 description: Creates an immutable struct in one step.
 email:
 - public.gma@gmail.com
@@ -172,6 +190,8 @@ files:
 - bin/setup
 - immutable_struct_ex.gemspec
 - lib/immutable_struct_ex.rb
+- lib/immutable_struct_ex/comparable.rb
+- lib/immutable_struct_ex/immutable.rb
 - lib/immutable_struct_ex/version.rb
 homepage: https://github.com/gangelo/immutable_struct_ex
 licenses: