secret_string 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adc3ac2c2e93e1c310c878c4194525a165c390dccd2d6708186f54bb1147be9a
-  data.tar.gz: d7be0b22cd44ec755337957965a140bb155c811f6223cf5264217ab591e17976
+  metadata.gz: 5f912f9e56675854f647fb6a965c6e3cfac83e999827249cdac00bbe096c3fc8
+  data.tar.gz: dc352220e6220adc7555be9064855990f6171938621634db7eca177bf6ede15f
 SHA512:
-  metadata.gz: 5b4daa15f269466054ac21521c1d5cf4f7912bcdf7d811807046a2c3f69cbca3f398381a0a9d0d205bb8778a2f59cab0ca7bbb518ece5dca243c6d358d298c90
-  data.tar.gz: d922cfba5e22b7098f7ca19501f364a8d912ef17da44d409152d79e7ad0d901a19031bdabd4fc1a2472703f5e4696510b10a4cc47863360eff1fa16547f94ace
+  metadata.gz: 18344af3842f3a6e1198bb29b85165ac8dd72a5b9de990a6c4d690882792b63b8cd29c2440293bbdefc7b3b1980334b0fba3da053f302d708ee1348451a9d4f7
+  data.tar.gz: 20a5236e50e545c04df1e8de38187c92386dde543b76888681d3209fe9a05e46aa2dc38faa24b806523c034e899e250ecac9a7f351c91339f693001393b69f5c

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [v1.1.0](https://github.com/Muriel-Salvan/secret_string/compare/v1.0.1...v1.1.0) (2021-07-07 10:21:42)
+
+### Features
+
+* [[Feature] Add equality and pattern matching facilities between String and SecretString](https://github.com/Muriel-Salvan/secret_string/commit/8bc056e66b21ee2d289e0c14fce43be9a0104434)
+
 # [v1.0.1](https://github.com/Muriel-Salvan/secret_string/compare/v1.0.0...v1.0.1) (2021-06-30 10:46:43)
 
 ### Patches

data/lib/secret_string.rb

@@ -46,13 +46,22 @@ class SecretString
     @silenced_str = silenced_str
   end
 
-  # Delegate the String representations methods to the silenced String by default
   extend Forwardable
+
+  # Delegate the String representations methods to the silenced String
   def_delegators :@silenced_str, *%i[
     inspect
     to_s
   ]
 
+  # Delegate the String identity methods to the unprotected String
+  def_delegators :@str, *%i[
+    ==
+    =~
+    match
+    size
+  ]
+
   # Return the unprotected String
   #
   # Result::

data/lib/secret_string/core_extensions/string.rb

@@ -19,10 +19,24 @@ class SecretString
         # Nothing to do
       end
 
+      # Compare the String with another object
+      #
+      # Parameters::
+      # * *other* (Object): Other object
+      # Result::
+      # * Boolean: Are objects equal?
+      def ==(other)
+        if other.is_a?(SecretString)
+          other == self
+        else
+          super
+        end
+      end
+
     end
 
   end
 
 end
 
-String.include SecretString::CoreExtensions::String
+String.prepend SecretString::CoreExtensions::String

data/lib/secret_string/version.rb

@@ -1,5 +1,5 @@
 class SecretString
 
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 
 end

data/spec/secret_string_test/tests/secret_string_spec.rb

@@ -21,6 +21,22 @@ describe SecretString do
       expect(secret.to_unprotected).not_to eq 'MySecret'
     end
 
+    it 'equals correctly with a string having the same content' do
+      expect(secret).to eq 'MySecret'
+    end
+
+    it 'matches correctly with a string having the same content' do
+      expect(secret).to match(/Secret/)
+    end
+
+    it 'matches correctly using the =~ operator with a string having the same content' do
+      expect(secret =~ /Secret/).not_to be nil
+    end
+
+    it 'reports the correct size' do
+      expect(secret.size).to eq 'MySecret'.size
+    end
+
   end
 
   describe 'erase' do

data/spec/secret_string_test/tests/string_spec.rb

@@ -10,4 +10,9 @@ describe String do
     expect(str).to eq 'MySecret'
   end
 
+  it 'equals the unprotected value of a secret string' do
+    str = 'MySecret'
+    expect(str).to eq SecretString.new('MySecret', silenced_str: 'SilencedString')
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secret_string
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec