immutable_struct_ex 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a93f45b29cdb392b541307fc4d6cf8299cb94b2c70611c65d5837d006be43c
-  data.tar.gz: 7e9239039e3226bd00ca971716b7470d620d11dc1997182cbe8c388af7b36a47
+  metadata.gz: 0ffcdbe2613240712bb17679f5399a1caa3253c264cf0c9c10a678a4caa4a3f7
+  data.tar.gz: 29ff8adba1c95169aa7552fb0f4eff84345c5f602ef2f9f1f79d1e2323bc2e37
 SHA512:
-  metadata.gz: 51ad57864c9b892f7c5327bfba585f5e511b5eeb7dd1b707b5a284fa31b3f3b06c5ef14f808adb7e6d1df0ab372e1ca117843eefc9ec6dcd02265e34c7b08574
-  data.tar.gz: caa878e4c999c39efd6f55e605518c92e330aa9f9a407cfaea4c9f33196feb4df29224784433623a70c701280409491ce8182cb2cb97a135a2c6117f94886650
+  metadata.gz: be076b0ffa994a1ad8a5b351017cf4e7b1f82d2b67dc1b582d80cc96e2c2465ae1c381a957b8868751de2699ba5f9eec60336dc9b9d5f679061d7189ef2335fd
+  data.tar.gz: 19bbbbd8d226a8808546e89897060166bd7c74a8fa10a40ce1e1f0289a08e9b0b72fa99830f473d918ccb872446f782a014f86124cb9fc8f32487f13a56e87e3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    immutable_struct_ex (0.1.1)
+    immutable_struct_ex (0.2.1)
 
 GEM
   remote: https://rubygems.org/

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/lib/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.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.1'
 end

data/lib/immutable_struct_ex.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'immutable_struct_ex/version'
+require 'comparable'
+require 'immutable'
 
 # Defines the methods used to create/manage the ImmutableStructEx struct.
 module ImmutableStructEx
@@ -8,27 +10,9 @@ module ImmutableStructEx
     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
-        end
+        struct.extend Comparable
+        struct.extend Immutable
       end
     end
-
-    def evaluate(struct)
-      struct.instance_eval yield
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immutable_struct_ex
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -171,6 +171,8 @@ files:
 - bin/console
 - bin/setup
 - immutable_struct_ex.gemspec
+- lib/comparable.rb
+- lib/immutable.rb
 - lib/immutable_struct_ex.rb
 - lib/immutable_struct_ex/version.rb
 homepage: https://github.com/gangelo/immutable_struct_ex