circuit_switch 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4cdb8d820d7ecce566ca391ad90990a2df09007d23ab3c223dbac66a3fcaa93
-  data.tar.gz: adb2a3ab38f303dd610f10a964014cbe75f0c752f5f6cd24ebf3c03319329c96
+  metadata.gz: d036ceb2748b3432749f5a03d83d324b59d1acb340bb7d64cbe3ef86f5531c4f
+  data.tar.gz: 32b8e3dbe02c1eaf8e25b40ab26f97036ecf33402bf974e6b71cb989db8c3178
 SHA512:
-  metadata.gz: 25f3265010930a67234ab82ad2aac34915460c12fd2f85789961c93f32e459ef8af0516bac47160b390564056aad9d51f3d75dbf36103294eae72962944f3b77
-  data.tar.gz: bd0195acf137e1aba67081a1c0bef74a58cb8594cc4e2960eb899c88c5dfad84f0759761fce7aaab45a4b0ea860fc86057dbbda6c6490b03f5581f5a28219284
+  metadata.gz: fa10c7a2196b37619dc94605efca82c8b3ce5b3182063004911f8aa28bef44f711e945adc73f38857e85a40a6f005b1139a7fac990e76e39a45080e481a93c3f
+  data.tar.gz: 3619df1cd293ba93f271ca536bcb55f4152a20810e52fb7aba16cd44e11b6bd081645bc1804f4f01c47a49c056a1793e840de5715f4c54126b4bdda8887f1d0c

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0, head, truffleruby]
+        exclude:
+          - os: windows-latest
+            ruby: head
+          - os: windows-latest
+            ruby: truffleruby
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: |
+        bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.0
+
+### Breaking Changes
+
+* Modify default value of `CircuitSwitch.run` argument `close_if_reach_limit` from true to false.
+
 ## 0.1.2
 
 * Modify `CircuitSwitch.open?` recieves same arguments as `CircuitSwtich.run`

data/README.md

@@ -57,12 +57,13 @@ 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 closed when reached the specified count. The default count is 10. To change this default value, modify `circuit_switches.run_limit_count` default value in the migration file.  
+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.
 
 - `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: true)
+- `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
 
@@ -83,7 +84,7 @@ unless circuit_open
 end
 ```
 
-`CircuitSwitch.run.run?` has syntax sugar. `open` doesn't receive proc.
+`CircuitSwitch.run.run?` has syntax sugar. `open?` doesn't receive proc.
 
 ```ruby
 if CircuitSwitch.open?

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/circuit_switch/core.rb

@@ -5,13 +5,17 @@ module CircuitSwitch
     def run(
       if: true,
       close_if: false,
-      close_if_reach_limit: true,
+      close_if_reach_limit: nil,
       limit_count: nil,
       &block
     )
       if close_if_reach_limit && limit_count == 0
         raise CircuitSwitchError.new('Can\'t set limit_count to 0 when close_if_reach_limit is true')
       end
+      if close_if_reach_limit.nil?
+        Logger.new($stdout).warn('Default value for close_if_reach_limit is modified from true to false at ver 0.2.0.')
+        close_if_reach_limit = false
+      end
       return self if evaluate(close_if) || !evaluate(binding.local_variable_get(:if))
       return self if close_if_reach_limit && switch.reached_run_limit?(limit_count)
       return self if switch.run_is_terminated?
@@ -70,8 +74,8 @@ module CircuitSwitch
 
     def called_path
       @called_path ||= caller
-        .reject { |path| path.match?(/(#{config.silent_paths.join('|')})/) }
-        .detect { |path| path.match?(/(#{config.report_paths.join('|')})/) }
+        .reject { |path| /(#{config.silent_paths.join('|')})/.match?(path) }
+        .detect { |path| /(#{config.report_paths.join('|')})/.match?(path) }
         &.sub(/(#{config.strip_paths.join('|')})/, '')
         &.gsub(/[`']/, '') ||
         "/somewhere/in/library:in #{Date.today}"

data/lib/circuit_switch/stacktrace_modifier.rb

@@ -7,7 +7,7 @@ module CircuitSwitch
 
       def call(backtrace:)
         backtrace
-          .select { |path| path.match?(/(#{config.allowed_backtrace_paths.join('|')})/) }
+          .select { |path| /(#{config.allowed_backtrace_paths.join('|')})/.match?(path) }
           .map { |path| path.sub(/(#{config.strip_paths.join('|')})/, '') }
           .join("\n")
       end

data/lib/circuit_switch/version.rb

@@ -1,3 +1,3 @@
 module CircuitSwitch
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/circuit_switch.rb

@@ -20,14 +20,14 @@ module CircuitSwitch
 
     # @param if [Boolean, Proc] Call proc when `if` is truthy (default: true)
     # @param close_if [Boolean, Proc] Call proc when `close_if` is falsy (default: false)
-    # @param close_if_reach_limit [Boolean] Stop calling proc when run count reaches limit (default: true)
+    # @param close_if_reach_limit [Boolean] Stop calling proc when run count reaches limit (default: false)
     # @param limit_count [Integer] Limit count. Use `run_limit_count` default value if it's nil
     #   Can't be set 0 when `close_if_reach_limit` is true (default: nil)
     # @param [Proc] block
     def run(
       if: true,
       close_if: false,
-      close_if_reach_limit: true,
+      close_if_reach_limit: nil,
       limit_count: nil,
       &block
     )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuit_switch
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - makicamel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-10 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -102,6 +102,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md