circuit_switch 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a00a04ad121a8f40a84f78a55e769aaa8f3fc185ac58fab51ddff11a0678e28
-  data.tar.gz: '06189169b6959b97e8a33617f2d9e054f9acf3d55bce2833b39a5f6567a061c6'
+  metadata.gz: f1e87399b178858a0b41fce787342117deab9d4a1a29c7d9262d742be2633641
+  data.tar.gz: fdf0d9ec8723b02fea239de819f60e98b24de9904d034a40f549bcf90d895f26
 SHA512:
-  metadata.gz: b63203a04cb3a37e4c6ac265eb8283fdde5b5cb5990c4234bb57876d72c5c26e48ade13907373046dc9f4b8f943f8c6a34e8c6957bceae9ba3857ca087c9c033
-  data.tar.gz: ff59240799e6841334eaffcaa76706cd78268804f8dc263da2c57dfd2bdc480264768ba614fb4102186fa483750ff36eb7c2c0bcc87eb6836f70c0025bcd0361
+  metadata.gz: 075c7f6dfeef30c3e0faecadf30969dfa6cd1f8fd2b5e4e6f5934f0e15913ec98f4f6b8a3cf9c414a17e7b920d17ee22a01abcea18c9cf8af4bfc510562c8aba
+  data.tar.gz: 6df8910491782a75b873952c26e0ac5ebdb27aadcf93727fc044e1b5dd0eeb6bfcfceac04c30417b8f86b6ac1d0e6515b342dd8d0616fc0dc9f78f680816a232

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.4.0
+
+### Breaking Changes
+
+* Be able to choice to notify `CircuitSwitch::CalledNotification` or `String`.  
+Improve `config/initializers/circuit_switch.rb` like following.
+
+```diff
+CircuitSwitch.configure do |config|
+-  config.reporter = ->(message) { Bugsnag.notify(message) }
++  config.reporter = ->(message, error) { Bugsnag.notify(error) }
+```
+
 ## 0.3.0
 
 ### Breaking Changes

data/README.md

@@ -56,24 +56,30 @@ CircuitSwitch.run do
 end
 ```
 
-`run` calls received proc, and when conditions are met, closes it's circuit.  
-To switch circuit opening and closing, some conditions can be set. By default, the circuit is always opened.  
-You can also set `limit_count` to close circuit when reached the specified count. Default limit_count is 10. To change this default value, modify `circuit_switches.run_limit_count` default value in the migration file.  
-`run` receives optional arguments.
-
-- `key`: [String] Named key to find switch instead of caller  
-  If no key passed, use caller.
-- `if`: [Boolean, Proc] Call proc when `if` is truthy (default: true)
-- `close_if`: [Boolean, Proc] Call proc when `close_if` is falsy (default: false)
-- `close_if_reach_limit`: [Boolean] Stop calling proc when run count reaches limit (default: false)
-- `limit_count`: [Integer] Limit count. Use `run_limit_count` default value if it's nil (default: nil)  
-  Can't be set 0 when `close_if_reach_limit` is true
-- `initially_closed`: [Boolean] Create switch with terminated mode (default: false)
-
-To close the circuit at specific date or when called 1000 times, code goes like:
+`run` basically calls the received proc. But when a condition is met, it closes the circuit and does not evaluate the proc.  
+To switch circuit opening and closing, a set of options can be set. Without options, the circuit is always open.  
+You can set `close_if_reach_limit: true` so that the circuit is only open for 10 invocations. The constant 10 comes from the table definition we have arbitrarily chosen. In case you need a larger number, specify it in the `limit_count` option in combination with `close_if_reach_limit: true`, or alter default constraint on `circuit_switches.run_limit_count`.
+
+- `key`: [String] The identifier to find record by. If `key` has not been passed, `circuit_switches.caller` is chosen as an alternative.
+- `if`: [Boolean, Proc] Calls proc when the value of `if` is evaluated truthy (default: true)
+- `close_if`: [Boolean, Proc] Calls proc when the value of `close_if` is evaluated falsy (default: false)
+- `close_if_reach_limit`: [Boolean] Stops calling proc when `circuit_switches.run_count` has reached `circuit_switches.run_limit_count` (default: false)
+- `limit_count`: [Integer] Mutates `circuit_switches.run_limit_count` whose value defined in schema is 10 by default. (default: nil)  
+  Can't be set to 0 when `close_if_reach_limit` is true. This option is only relevant when `close_if_reach_limit` is set to true.
+- `initially_closed`: [Boolean] Creates switch with terminated mode (default: false)
+
+To close the circuit at a specific date, code goes like:
+
+```ruby
+CircuitSwitch.run(close_if: -> { Date.today >= some_day }) do
+  # testing codes
+end
+```
+
+Or when the code of concern has been called 1000 times:
 
 ```ruby
-CircuitSwitch.run(close_if: -> { Date.today >= some_day }, limit_count: 1_000) do
+CircuitSwitch.run(close_if_reach_limit: true, limit_count: 1_000) do
   # testing codes
 end
 ```
@@ -105,17 +111,15 @@ When you just want to report, set your `reporter` to initializer and then call `
 CircuitSwitch.report(if: some_condition)
 ```
 
-`report` just reports the line of code is called. It doesn't receive proc. It's useful for refactoring or removing dead codes.  
-Same as `run`, some conditions can be set. By default, reporting is stopped when reached the specified count. The default count is 10. To change this default value, modify `circuit_switches.report_limit_count` default value in the migration file.  
-`report` receives optional arguments.
+`report` just reports which line of code is called. It doesn't receive proc. It's useful for refactoring or removing dead codes.  
+Same as `run`, a set of options can be set. By default, this method does not send reports more than 10 times. The constant 10 comes from the table definition we have arbitrarily chosen. In case you need a larger number, specify it in the `limit_count` option, or alter default constraint on `circuit_switches.report_limit_count`.
 
-- `key`: [String] Named key to find switch instead of caller  
-  If no key passed, use caller.
-- `if`: [Boolean, Proc] Report when `if` is truthy (default: true)
-- `stop_report_if`: [Boolean, Proc] Report when `close_if` is falsy (default: false)
-- `stop_report_if_reach_limit`: [Boolean] Stop reporting when reported count reaches limit (default: true)
-- `limit_count`: [Integer] Limit count. Use `report_limit_count` default value if it's nil (default: nil)  
-  Can't be set 0 when `stop_report_if_reach_limit` is true
+- `key`: [String] The identifier to find record by. If `key` has not been passed, `circuit_switches.caller` is chosen as an alternative.
+- `if`: [Boolean, Proc] Reports when the value of `if` is evaluated truthy (default: true)
+- `stop_report_if`: [Boolean, Proc] Reports when the value of `stop_report_if` is evaluated falsy (default: false)
+- `stop_report_if_reach_limit`: [Boolean] Stops reporting when `circuit_switches.report_count` has reached `circuit_switches.report_limit_count` (default: true)
+- `limit_count`: [Integer] Mutates `circuit_switches.report_limit_count` whose value defined in schema is 10 by default. (default: nil)  
+  Can't be set to 0 when `stop_report_if_reach_limit` is true.
 
 To know about report is executed or not, you can get through `report?`.  
 Of course you can chain `report` and `run` or `open?`.

data/lib/circuit_switch/core.rb

@@ -40,6 +40,9 @@ module CircuitSwitch
       if config.reporter.nil?
         raise CircuitSwitchError.new('Set config.reporter.')
       end
+      if config.reporter.arity == 1
+        Logger.new($stdout).info('config.reporter now receives 2 arguments. Improve your `config/initialzers/circuit_switch.rb`.')
+      end
       if stop_report_if_reach_limit && report_limit_count == 0
         raise CircuitSwitchError.new('Can\'t set limit_count to 0 when stop_report_if_reach_limit is true')
       end

data/lib/circuit_switch/version.rb

@@ -1,3 +1,3 @@
 module CircuitSwitch
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/circuit_switch/workers/reporter.rb

@@ -27,7 +27,11 @@ module CircuitSwitch
         sleep(2)
         retry
       rescue CalledNotification => notification
-        config.reporter.call(notification.to_message(called_path: called_path))
+        if config.reporter.arity == 1
+          config.reporter.call(notification.to_message(called_path: called_path))
+        else
+          config.reporter.call(notification.to_message(called_path: called_path), notification)
+        end
       end
     end
   end

data/lib/generators/circuit_switch/templates/initializer.rb

@@ -2,7 +2,8 @@
 
 CircuitSwitch.configure do |config|
   # Specify proc to call your report tool: like;
-  # config.reporter = -> (message) { Bugsnag.notify(message) }
+  # config.reporter = -> (message, error) { Bugsnag.notify(error) }
+  # config.reporter = -> (message, error) { Sentry::Rails.capture_message(message) }
   config.reporter = nil
 
   # Condition to report

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuit_switch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - makicamel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-03 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob