circuit_switch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e327f0f981b9690cd6115067a3ede6d399d3ea25fb905da56629c58954b7db4
+  data.tar.gz: 75b1a01d86987a360a0e898180d382d56358efe14f681156ed3d4f60998bdfea
+SHA512:
+  metadata.gz: 403ae1fd2a6e17d2834b07ce745ecf5787342bb6177544ac15c9e53d09d4b1782dbc50311e78519b0298f8a644af2d4b9ff14d4eb976ea90418c0a8c008bd907
+  data.tar.gz: fa0a9770084140cdc794b39b15d60f5694a8f1cc98b8146e3ee0a7a6d7eb9c08117206208f3b019ec39c18ce11bfeaaa158fcd9c2d5e9ee0fa9d37d07f2c9b49

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.byebug_history

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at unright@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in circuit_switch.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 makicamel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,172 @@
+# CircuitSwitch
+
+CircuitSwitch is a gem for 'difficult' application; for example, few tests, too many meta-programming codes, low aggregation classes and few deploys.  
+This switch helps make changes easier and deploy safely.  
+You can deploy and check with a short code like following if the change is good or not, and when a problem is found, you can undo it without releasing it.
+
+```ruby
+if CircuitSwitch.report.open?
+  # new codes
+else
+  # old codes
+end
+```
+
+You can also specify conditions to release testing features.
+
+```ruby
+CircuitSwitch.run(if: -> { current_user.testing_new_feature? }) do
+  # testing feature codes
+end
+```
+
+CircuitSwitch depends on ActiveRecord and ActiveJob.
+
+## Installation
+
+Add this line to your application's Gemfile and run `bundle install`:
+
+```ruby
+gem 'circuit_switch'
+```
+
+Run generator to create initializer and modify `config/initizlizers/circuit_switch.rb`:
+
+```
+rails generate circuit_switch:install
+```
+
+Generate a migration for ActiveRecord.  
+This table saves circuit caller, called count, limit count and so on.
+
+```
+rails generate circuit_switch:migration circuit_switch
+rails db:migrate
+```
+
+## Usage
+
+### `run`
+
+When you want to deploy and undo it if something unexpected happens, use `CircuitSwitch.run`.
+
+```ruby
+CircuitSwitch.run do
+  # experimental codes
+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.  
+`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)
+- `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
+
+To close the circuit at specific date or when called 1000 times, code goes like:
+
+```ruby
+CircuitSwitch.run(close_if: -> { Date.today >= some_day }, limit_count: 1_000) do
+  # testing codes
+end
+```
+
+To run other codes when circuit closes, `run?` is available.
+
+```ruby
+circuit_open = CircuitSwitch.run { ... }.run?
+unless circuit_open
+  # other codes
+end
+```
+
+`CircuitSwitch.run.run?` has syntax sugar. `open` doesn't receive proc.
+
+```ruby
+if CircuitSwitch.open?
+  # new codes
+else
+  # old codes
+end
+```
+
+### `report`
+
+When you just want to report, set your `reporter` to initializer and then call `CircuitSwitch.report`.
+
+```ruby
+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.
+
+- `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
+
+To know about report is executed or not, you can get through `report?`.  
+Of course you can chain `report` and `run` or `open?`.
+
+#### `with_backtrace`
+
+Reporter reports a short message by default like `Watching process is called for 5th. Report until for 10th.`.  
+When your reporting tool knows about it's caller and backtrace, this is enough (e.g. Bugsnag).  
+When your reporting tool just reports plain message (e.g. Slack), you can set `with_backtrace` true to initializer. Then report has a long message with backtrace like:
+
+```
+Watching process is called for 5th. Report until for 10th.
+called_path: /app/services/greetings_service:21 block in validate
+/app/services/greetings_service:20 validate
+/app/services/greetings_service:5 call
+/app/controllers/greetings_controller.rb:93 create
+```
+
+## Task
+
+When find a problem and you want to terminate running or reporting right now, execute a task with it's caller.
+
+```
+rake circuit_switch:terminate_to_run[/app/services/greetings_service:21 block in validate]
+rake circuit_switch:terminate_to_report[/app/services/greetings_service:21 block in validate]
+```
+
+In case of not Rails applications, add following to your Rakefile:
+
+```ruby
+require 'circuit_switch/tasks'
+```
+
+## Reminder for cleaning up codes
+
+Too many circuits make codes messed up. We want to remove circuits after several days, but already have too many TODO things enough to remember them.  
+Let's forget it! Set `due_date_notifier` to initializer and then call `CircuitSwitch::DueDateNotifier` job daily. It will notify the list of currently registered switches.  
+By default, due_date is 10 days after today. To modify, set `due_date` to initializer.
+
+## GUI to manage switches
+
+Under development :)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/makicamel/circuit_switch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/makicamel/circuit_switch/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CircuitSwitch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/makicamel/circuit_switch/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "circuit_switch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circuit_switch.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/circuit_switch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "circuit_switch"
+  spec.version       = CircuitSwitch::VERSION
+  spec.authors       = ["makicamel"]
+  spec.email         = ["unright@gmail.com"]
+
+  spec.summary       = 'Circuit switch with report tools'
+  spec.description   = 'Circuit switch to help changing source code in safety and easy with report tools'
+  spec.homepage      = 'https://github.com/makicamel/circuit_switch'
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/makicamel/circuit_switch'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activejob'
+  spec.add_dependency 'activerecord'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'test-unit-rr'
+end

data/lib/circuit_switch/configuration.rb

@@ -0,0 +1,44 @@
+module CircuitSwitch
+  class Configuration
+    CIRCUIT_SWITCH = 'circuit_switch'.freeze
+
+    attr_accessor :reporter, :due_date_notifier
+    attr_writer :report_paths, :report_if, :due_date, :with_backtrace, :allowed_backtrace_paths, :strip_paths
+
+    def report_paths
+      @report_paths ||= [Rails.root]
+    end
+
+    def silent_paths=(paths)
+      @silent_paths = paths.append(CIRCUIT_SWITCH).uniq
+    end
+
+    def silent_paths
+      @silent_paths ||= [CIRCUIT_SWITCH]
+    end
+
+    def report_if
+      @report_if ||= Rails.env.production?
+    end
+
+    def enable_report?
+      report_if.respond_to?(:call) ? report_if.call : !!report_if
+    end
+
+    def due_date
+      @due_date = Date.today + 10
+    end
+
+    def with_backtrace
+      @with_backtrace ||= false
+    end
+
+    def allowed_backtrace_paths
+      @allowed_backtrace_paths ||= [Dir.pwd]
+    end
+
+    def strip_paths
+      @strip_paths ||= [Dir.pwd]
+    end
+  end
+end

data/lib/circuit_switch/core.rb

@@ -0,0 +1,84 @@
+module CircuitSwitch
+  class Core
+    delegate :config, to: ::CircuitSwitch
+
+    def run(
+      if: true,
+      close_if: false,
+      close_if_reach_limit: true,
+      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
+      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?
+
+      yield
+      RunCountUpdater.perform_later(
+        limit_count: limit_count,
+        called_path: called_path,
+        reported: reported?
+      )
+      @run = true
+      self
+    end
+
+    def report(
+      if: true,
+      stop_report_if: false,
+      stop_report_if_reach_limit: true,
+      limit_count: nil
+    )
+      if config.reporter.nil?
+        raise CircuitSwitchError.new('Set config.reporter.')
+      end
+      if stop_report_if_reach_limit && limit_count == 0
+        raise CircuitSwitchError.new('Can\'t set limit_count to 0 when stop_report_if_reach_limit is true')
+      end
+      return self unless config.enable_report?
+      return self if evaluate(stop_report_if) || !evaluate(binding.local_variable_get(:if))
+      return self if switch.report_is_terminated?
+      return self if stop_report_if_reach_limit && switch.reached_report_limit?(limit_count)
+
+      Reporter.perform_later(
+        limit_count: limit_count,
+        called_path: called_path,
+        run: run?
+      )
+      @reported = true
+      self
+    end
+
+    # @return [Boolean]
+    def run?
+      !!@run
+    end
+
+    # @return [Boolean]
+    def reported?
+      !!@reported
+    end
+
+    private
+
+    def switch
+      @switch ||= CircuitSwitch.find_or_initialize_by(caller: called_path)
+    end
+
+    def called_path
+      @called_path ||= caller
+        .reject { |path| path.match?(/(#{config.silent_paths.join('|')})/) }
+        .detect { |path| path.match?(/(#{config.report_paths.join('|')})/) }
+        &.sub(/(#{config.strip_paths.join('|')})/, '')
+        &.gsub(/[`']/, '') ||
+        "/somewhere/in/library:in #{Date.today}"
+    end
+
+    def evaluate(boolean_or_proc)
+      boolean_or_proc.respond_to?(:call) ? boolean_or_proc.call : boolean_or_proc
+    end
+  end
+end

data/lib/circuit_switch/notification.rb

@@ -0,0 +1,19 @@
+require 'circuit_switch/stacktrace_modifier'
+
+module CircuitSwitch
+  class CircuitSwitchError < RuntimeError
+  end
+
+  class CircuitSwitchNotification < RuntimeError
+  end
+
+  class CalledNotification < CircuitSwitchNotification
+    def to_message(called_path:)
+      if ::CircuitSwitch.config.with_backtrace
+        "#{message}\ncalled_path: #{called_path}\n#{StacktraceModifier.call(backtrace: backtrace)}"
+      else
+        message
+      end
+    end
+  end
+end

data/lib/circuit_switch/orm/active_record/circuit_switch.rb

@@ -0,0 +1,47 @@
+module CircuitSwitch
+  class CircuitSwitch < ::ActiveRecord::Base
+    def assign(run_limit_count: nil, report_limit_count: nil)
+      self.run_limit_count = run_limit_count if run_limit_count
+      self.report_limit_count = report_limit_count if report_limit_count
+      self
+    end
+
+    def reached_run_limit?(new_value)
+      if new_value
+        run_count >= new_value
+      else
+        run_count >= run_limit_count
+      end
+    end
+
+    def reached_report_limit?(new_value)
+      if new_value
+        report_count >= new_value
+      else
+        report_count >= report_limit_count
+      end
+    end
+
+    def increment_run_count
+      with_writable { update!(run_count: run_count + 1) }
+    end
+
+    def increment_report_count
+      with_writable { update!(report_count: report_count + 1) }
+    end
+
+    def message
+      "Watching process is called for #{report_count}th. Report until for #{report_limit_count}th."
+    end
+
+    private
+
+    def with_writable
+      if self.class.const_defined?(:ApplicationRecord) && ApplicationRecord.respond_to?(:with_writable)
+        ApplicationRecord.with_writable { yield }
+      else
+        yield
+      end
+    end
+  end
+end

data/lib/circuit_switch/railtie.rb

@@ -0,0 +1,7 @@
+module CircuitSwitch
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'circuit_switch/tasks/circuit_switch.rake'
+    end
+  end
+end

data/lib/circuit_switch/stacktrace_modifier.rb

@@ -0,0 +1,16 @@
+require 'circuit_switch/configuration.rb'
+
+module CircuitSwitch
+  class StacktraceModifier
+    class << self
+      delegate :config, to: ::CircuitSwitch
+
+      def call(backtrace:)
+        backtrace
+          .select { |path| path.match?(/(#{config.allowed_backtrace_paths.join('|')})/) }
+          .map { |path| path.sub(/(#{config.strip_paths.join('|')})/, '') }
+          .join("\n")
+      end
+    end
+  end
+end

data/lib/circuit_switch/tasks/circuit_switch.rake

@@ -0,0 +1,40 @@
+namespace :circuit_switch do
+  desc 'Update run_is_terminated to true to close circuit'
+  task :terminate_to_run, ['caller'] => :environment do |_, arg|
+    called_path = arg[:caller]
+    puts "Start to update run_is_terminated of circuit_switch for '#{called_path}' to true."
+    sleep(3)
+
+    switch = CircuitSwitch::CircuitSwitch.find_by!(caller: called_path)
+    puts "circuit_switch is found. id: #{switch.id}."
+
+    switch.update(run_is_terminated: true)
+    puts "Updated run_is_terminated of circuit_switch for '#{called_path}' to true."
+  end
+
+  desc 'Update report_is_terminated to true to stop reporting'
+  task :terminate_to_report, ['caller'] => :environment do |_, arg|
+    called_path = arg[:caller]
+    puts "Start to update report_is_terminated of circuit_switch for '#{called_path}' to true."
+    sleep(3)
+
+    switch = CircuitSwitch::CircuitSwitch.find_by!(caller: called_path)
+    puts "circuit_switch is found. id: #{switch.id}."
+
+    switch.update(report_is_terminated: true)
+    puts "Updated report_is_terminated of circuit_switch for '#{called_path}' to true."
+  end
+
+  desc 'Delete switch'
+  task :delete_switch, ['caller'] => :environment do |_, arg|
+    called_path = arg[:caller]
+    puts "Start to delete circuit_switch for '#{called_path}'."
+    sleep(3)
+
+    switch = CircuitSwitch::CircuitSwitch.find_by!(caller: called_path)
+    puts "circuit_switch is found. id: #{switch.id}."
+
+    switch.destroy!
+    puts "Successfully deleted circuit_switch for '#{called_path}'."
+  end
+end

data/lib/circuit_switch/tasks.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].each do |task|
+  load task
+end

data/lib/circuit_switch/version.rb

@@ -0,0 +1,3 @@
+module CircuitSwitch
+  VERSION = "0.1.0"
+end

data/lib/circuit_switch/workers/due_date_notifier.rb

@@ -0,0 +1,22 @@
+require 'date'
+
+module CircuitSwitch
+  class DueDateNotifier < ::ActiveJob::Base
+    delegate :config, to: ::CircuitSwitch
+
+    def perform
+      raise CircuitSwitchError.new('Set config.due_date_notifier.') unless config.due_date_notifier
+
+      circuit_switches = CircuitSwitch.where('due_date <= ?', Date.today).order(id: :asc)
+      if circuit_switches.present?
+        message = "Due date has come! Let's consider about removing switches and cleaning up code! :)\n" +
+          circuit_switches.map { |switch|  "id: #{switch.id}, caller: '#{switch.caller}' , created_at: #{switch.created_at}" }.join("\n")
+        config.due_date_notifier.call(message)
+      else
+        switches_count = CircuitSwitch.all.size
+        message = switches_count.zero? ? 'There is no switch!' : "#{switches_count} switches are waiting for their due_date."
+        config.due_date_notifier.call(message)
+      end
+    end
+  end
+end

data/lib/circuit_switch/workers/reporter.rb

@@ -0,0 +1,21 @@
+module CircuitSwitch
+  class Reporter < ::ActiveJob::Base
+    delegate :config, to: ::CircuitSwitch
+
+    def perform(limit_count:, called_path:, run:)
+      circuit_switch =
+      if run
+        # Wait for RunCountUpdater saves circuit_switch
+        sleep(3)
+        CircuitSwitch.find_by!(caller: called_path)
+      else
+        CircuitSwitch.find_or_initialize_by(caller: called_path)
+      end
+      circuit_switch.due_date ||= config.due_date
+      circuit_switch.assign(report_limit_count: limit_count).increment_report_count
+      raise CalledNotification.new(circuit_switch.message)
+    rescue CalledNotification => notification
+      config.reporter.call(notification.to_message(called_path: called_path))
+    end
+  end
+end

data/lib/circuit_switch/workers/run_count_updater.rb

@@ -0,0 +1,18 @@
+module CircuitSwitch
+  class RunCountUpdater < ::ActiveJob::Base
+    delegate :config, to: ::CircuitSwitch
+
+    def perform(limit_count:, called_path:, reported:)
+      circuit_switch =
+        if reported
+          # Wait for Reporter saves circuit_switch
+          sleep(3)
+          CircuitSwitch.find_by!(caller: called_path)
+        else
+          CircuitSwitch.find_or_initialize_by(caller: called_path)
+        end
+      circuit_switch.due_date ||= config.due_date
+      circuit_switch.assign(run_limit_count: limit_count).increment_run_count
+    end
+  end
+end

data/lib/circuit_switch.rb

@@ -0,0 +1,80 @@
+require "circuit_switch/configuration.rb"
+require "circuit_switch/core"
+require "circuit_switch/notification"
+require "circuit_switch/orm/active_record/circuit_switch"
+require "circuit_switch/railtie" if defined?(Rails::Railtie)
+require "circuit_switch/version"
+require "circuit_switch/workers/due_date_notifier"
+require "circuit_switch/workers/reporter"
+require "circuit_switch/workers/run_count_updater"
+
+module CircuitSwitch
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    # @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 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,
+      limit_count: nil,
+      &block
+    )
+      Core.new.run(
+        if: binding.local_variable_get(:if),
+        close_if: close_if,
+        close_if_reach_limit: close_if_reach_limit,
+        limit_count: limit_count,
+        &block
+      )
+    end
+
+    # @param if [Boolean, Proc] Report when `if` is truthy (default: true)
+    # @param stop_report_if [Boolean, Proc] Report when `close_if` is falsy (default: false)
+    # @param stop_report_if_reach_limit [Boolean] Stop reporting when reported count reaches limit (default: true)
+    # @param limit_count [Integer] Limit count. Use `report_limit_count` default value if it's nil
+    #   Can't be set 0 when `stop_report_if_reach_limit` is true (default: nil)
+    def report(
+      if: true,
+      stop_report_if: false,
+      stop_report_if_reach_limit: true,
+      limit_count: nil
+    )
+      if block_given?
+        raise ArgumentError.new('CircuitSwitch.report doesn\'t receive block. Use CircuitSwitch.run if you want to pass block.')
+      end
+
+      Core.new.report(
+        if: binding.local_variable_get(:if),
+        stop_report_if: stop_report_if,
+        stop_report_if_reach_limit: stop_report_if_reach_limit,
+        limit_count: limit_count
+      )
+    end
+
+    # Syntax sugar for `CircuitSwitch.run`
+    # @param if [Boolean, Proc] `CircuitSwitch.run` is runnable when `if` is truthy (default: true)
+    # @param limit_count [Integer] Limit count. Use `run_limit_count` default value if it's nil. Can't be set 0 (default: nil)
+    def open?(if: true, limit_count: nil)
+      if block_given?
+        raise ArgumentError.new('CircuitSwitch.open doesn\'t receive block. Use CircuitSwitch.run if you want to pass block.')
+      end
+
+      Core.new.run(
+        if: binding.local_variable_get(:if),
+        limit_count: limit_count
+      ) {}.run?
+    end
+  end
+end

data/lib/generators/circuit_switch/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CircuitSwitch
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+    source_root File.expand_path('templates', __dir__)
+    desc 'Installs CircuitSwitch.'
+
+    def install
+      template 'initializer.rb', 'config/initializers/circuit_switch.rb'
+    end
+  end
+end

data/lib/generators/circuit_switch/migration_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/active_record'
+
+module CircuitSwitch
+  class MigrationGenerator < ActiveRecord::Generators::Base
+    desc 'Create a migration to manage circuit switches state'
+    source_root File.expand_path('templates', __dir__)
+
+    def generate_migration
+      migration_template 'migration.rb.erb', 'db/migrate/create_circuit_switches.rb', migration_version: migration_version
+    end
+
+    def migration_version
+      if ActiveRecord::VERSION::MAJOR >= 5
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+CircuitSwitch.configure do |config|
+  # Specify proc to call your report tool: like;
+  # config.reporter = -> (message) { Bugsnag.notify(message) }
+  config.reporter = nil
+
+  # Condition to report
+  # config.report_if = Rails.env.production?
+
+  # Allowed paths to report
+  # CircuitSwitch recognizes logic as unique that first match with these paths.
+  # Allowed all paths when set `[]`.
+  # config.report_paths = [Rails.root]
+
+  # Excluded paths to report
+  # config.silent_paths =  [CIRCUIT_SWITCH]
+
+  # Notifier to notify circuit_switch's due_date come and it's time to clean code!
+  # Specify proc to call your report tool: like;
+  # config.due_date_notifier = -> (message) { Slack::Web::Client.new.chat_postMessage(channel: '#your_channel', text: message) }
+  # config.due_date_notifier = nil
+
+  # Date for due_date_notifier
+  # config.due_date = Date.today + 10
+
+  # Option to contain error backtrace for report
+  # You don't need backtrace when you report to some bug report tool.
+  # You may be want backtrace when report to plain feed; e.g. Slack or email.
+  # config.with_backtrace = false
+
+  # Allowd backtrace paths to report
+  # Specify with `with_backtrace` option.
+  # Allowed all paths when set `[]`.
+  # config.allowed_backtrace_paths = [Dir.pwd]
+
+  # Omit path prefix in caller and backtrace for readability
+  # config.strip_paths = [Dir.pwd]
+end

data/lib/generators/circuit_switch/templates/migration.rb.erb

@@ -0,0 +1,15 @@
+class CreateCircuitSwitches < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :circuit_switches do |t|
+      t.string :caller, null: false
+      t.integer :run_count, default: 0, null: false
+      t.integer :run_limit_count, default: 10, null: false
+      t.boolean :run_is_terminated, default: false, null: false
+      t.integer :report_count, default: 0, null: false
+      t.integer :report_limit_count, default: 10, null: false
+      t.boolean :report_is_terminated, default: false, null: false
+      t.date :due_date, null: false
+      t.timestamps
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: circuit_switch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- makicamel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Circuit switch to help changing source code in safety and easy with report
+  tools
+email:
+- unright@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circuit_switch.gemspec
+- lib/circuit_switch.rb
+- lib/circuit_switch/configuration.rb
+- lib/circuit_switch/core.rb
+- lib/circuit_switch/notification.rb
+- lib/circuit_switch/orm/active_record/circuit_switch.rb
+- lib/circuit_switch/railtie.rb
+- lib/circuit_switch/stacktrace_modifier.rb
+- lib/circuit_switch/tasks.rb
+- lib/circuit_switch/tasks/circuit_switch.rake
+- lib/circuit_switch/version.rb
+- lib/circuit_switch/workers/due_date_notifier.rb
+- lib/circuit_switch/workers/reporter.rb
+- lib/circuit_switch/workers/run_count_updater.rb
+- lib/generators/circuit_switch/install_generator.rb
+- lib/generators/circuit_switch/migration_generator.rb
+- lib/generators/circuit_switch/templates/initializer.rb
+- lib/generators/circuit_switch/templates/migration.rb.erb
+homepage: https://github.com/makicamel/circuit_switch
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/makicamel/circuit_switch
+  source_code_uri: https://github.com/makicamel/circuit_switch
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Circuit switch with report tools
+test_files: []