faulty 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54ef7d6bc1b23815e02563c80e4c17fef2735812a8c424882e8283996506edcc
-  data.tar.gz: c4c2d074b118f3077a3cddb862fddc5c3ace18c62a206e4523cfb830b7b6e35b
+  metadata.gz: ae75506209beb5e9490a5f2a939519060340e22022c0f0d0be07bbd8c32bd34a
+  data.tar.gz: d08fbe083462251ac184ed0578dda3dcfdab624e48cef270662ed04bab0b337b
 SHA512:
-  metadata.gz: 75fa840ff865e39e381894bdce59ab13f67ac001cbae57696360692c495b8d0ca2f643261a7a4ea083fdb1964d8e14ad0237815f90e9b436d17eff04a0abe0f5
-  data.tar.gz: dfcaede2d29e34bd466a21ad5037ddaeebfaa947bb44f09ef9c64b34ac0f207dd2a8e4d038067b47ce3ac76ccbba744721dc1fb4337854e7e9af0df739798169
+  metadata.gz: 182af6be2df0089e41be78ceed0d3b866f9b6db43f2423fe1c4bd788b196c76fa206055f9ca07b558676afad7a3544c39c0215990a43fe2b8bdec593ea259d95
+  data.tar.gz: cf3726daff78ed12b39313aab5188c53a804ac68e9e0810faf1abf4e5d11e96c85168b46b4b814334bad5d922e6188c8a9b6ed5f0b499961c3e33fde434bb5c0

data/.github/workflows/ci.yml

@@ -47,6 +47,9 @@ jobs:
           MYSQL_USER: root
           MYSQL_PASSWORD: root
       - name: Run codacy-coverage-reporter
+        env:
+          CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+        if: matrix.ruby == '2.7' && env.CODACY_PROJECT_TOKEN
         uses: codacy/codacy-coverage-reporter-action@master
         with:
           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Release v0.8.6
+
+* Define an inspect method that represent circuit #50 JuanitoFatas
+
 ## Release v0.8.5
 
 * Fix yard warnings #49 justinhoward
@@ -5,6 +9,16 @@
 * Add granular errors for Elasticsearch patch #48 justinhoward
 * Return status conditionally for Storage::Interface#entry #45 justinhoward
 
+### Deprecations
+
+* Storage::Interface#entry should now accept an additional parameter
+  `status`. If given, the method must return the updated status,
+  otherwise if status is `nil` #entry may return nil. Previously #entry
+  always returned a history array.
+* The error_module option is deprecated. Patches should use the error_mapper
+  option instead. The option will be removed in 0.9
+
+
 ## Release v0.8.4
 
 * Add Elasticsearch client patch #44 justinhoward

data/lib/faulty/circuit.rb

@@ -172,6 +172,21 @@ class Faulty
       end
     end
 
+    # @return [String] Text representation of the circuit
+    def inspect
+      interested_opts = %i[
+        cache_expires_in
+        cache_refreshes_after
+        cache_refresh_jitter
+        cool_down evaluation_window
+        rate_threshold
+        sample_threshold
+        errors exclude
+      ]
+      options_text = options.each_pair.map { |k, v| "#{k}: #{v}" if interested_opts.include?(k) }.compact.join(', ')
+      %(#<#{self.class.name} name: #{name}, state: #{status.state}, options: { #{options_text} }>)
+    end
+
     # @param name [String] The name of the circuit
     # @param options [Hash] Attributes for {Options}
     # @yield [Options] For setting options in a block

data/lib/faulty/version.rb

@@ -3,6 +3,6 @@
 class Faulty
   # The current Faulty version
   def self.version
-    Gem::Version.new('0.8.5')
+    Gem::Version.new('0.8.6')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby