protoboard 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c81cf53f96503f2eb2e797e9e7034abe3f1fde97
-  data.tar.gz: d394dde7965c0a5334cbe7dc2ce1fa5ee1f656f0
+SHA256:
+  metadata.gz: 26c6de613a9f52598427a885b88f3633bafbbbd9687ef8f6195245e18861dc28
+  data.tar.gz: f5d1a0a55487c21fe5a8c5f12c0b80ef5cac20c086ae3387bf570151a0086730
 SHA512:
-  metadata.gz: e4e889e92fa0a9f0e255bb30b25a965d244b05987d4edad86f2f0906f2258704c1892b81a2b325e44f9088febe06b365dfdc293bdd34ff53150cc550b233b01c
-  data.tar.gz: 31095568cddf438c81fd6b5794674874eed45e870fe2647154bbbfa75cc04307ba7fefdab85e4609c2c1d8e19df45dc5c6ecbdf4ce51ded17cbbe5489220f47a
+  metadata.gz: 3214c6f8b365ea31d311d8f81a2aeea9109969e630d2287bf848b1cd06299202ec389ff0adec6e63e61280c6be66d7bfd18b98cf040b845ba90b2e5667043820
+  data.tar.gz: d4558604304fa9456c060852719e77f84137931e659d63943ac85e8be14673d7cfac7111b45964e63944fdda49d90711fa99d9e830264cbb0baf2e68d76c3066

data/README.md

@@ -66,7 +66,7 @@ end
 Also if you want to add more than one method in the same class and customize the circuit name:
 
 ```ruby
-class Foo4
+class MyFooService
   include Protoboard::CircuitBreaker
 
   register_circuits({ some_method: 'my_custom_name', other_method: 'my_other_custom_name' },
@@ -81,6 +81,30 @@ class Foo4
 end
 ```
 
+And you can add singleton methods to be wrapped by a circuit:
+
+```ruby
+class MyFooService
+  include Protoboard::CircuitBreaker
+
+  register_circuits [:some_method, :some_singleton_method],
+    singleton_methods: [:some_singleton_method],
+    options: {
+      service: 'my_cool_service',
+      open_after: 2,
+      cool_off_after: 3
+    }
+
+  def self.some_singleton_method
+    # Something that can break
+  end
+
+  def some_method
+    # Something that can break
+  end
+end
+```
+
 ### Callbacks
 
 Any callback should receive one argument that it will be an instance of `CircuitExecution` class, that object will respond to the following methods:

data/lib/protoboard/circuit.rb

@@ -20,8 +20,13 @@ module Protoboard
       @fallback = options[:fallback]
       @on_before = options.fetch(:on_before, [])
       @on_after = options.fetch(:on_after, [])
+      @singleton_method = options.fetch(:singleton_method, false)
     rescue KeyError => error
       raise ArgumentError, "Missing required arguments: #{error.message}"
     end
+
+    def singleton_method?
+      @singleton_method
+    end
   end
 end

data/lib/protoboard/circuit_breaker.rb

@@ -28,7 +28,7 @@ module Protoboard
       #   ====
       #
       # * +fallback+ - A callable object with code to be executed as an alternative plan if the code of the circuit fails
-      def register_circuits(circuit_methods, on_before: [], on_after: [], options:, fallback: nil)
+      def register_circuits(circuit_methods, on_before: [], on_after: [], options:, fallback: nil, singleton_methods: [])
         Protoboard::Helpers::VALIDATE_CALLBACKS.call(on_before)
         Protoboard::Helpers::VALIDATE_CALLBACKS.call(on_after)
 
@@ -39,7 +39,8 @@ module Protoboard
             fallback: fallback,
             on_before: on_before,
             on_after: on_after
-          )
+          ),
+          singleton_methods
         )
 
         circuits.each do |circuit|
@@ -47,7 +48,10 @@ module Protoboard
         end
 
         proxy_module = Protoboard::CircuitBreaker.create_circuit_proxy(circuits, name)
-        prepend proxy_module
+
+        prepend proxy_module::InstanceMethods
+
+        singleton_class.prepend proxy_module::ClassMethods
       end
     end
 
@@ -84,7 +88,7 @@ module Protoboard
 
       ##
       # Creates a new +circuit+.
-      def create_circuits(circuit_methods,class_name, options)
+      def create_circuits(circuit_methods,class_name, options, singleton_methods)
         circuit_hash = case circuit_methods
                        when Array
                          circuit_methods.reduce({}) do |memo, value|
@@ -95,8 +99,14 @@ module Protoboard
                        else
                          raise ArgumentError, 'Invalid input for circuit methods'
                        end
+
         circuit_hash.map do |circuit_method, circuit_name|
-          Circuit.new({ name: circuit_name, method_name: circuit_method }.merge(options))
+          Circuit.new({
+            name: circuit_name,
+            method_name: circuit_method,
+            singleton_method: singleton_methods.include?(circuit_method.to_sym)
+          }
+          .merge(options))
         end
       end
 

data/lib/protoboard/circuit_proxy_factory.rb

@@ -12,14 +12,32 @@ module Protoboard
         module_name = infer_module_name(class_name, circuits.map(&:method_name))
         proxy_module = Module.new
 
-        proxy_module.instance_exec do
+        # Encapsulates instance methods in a module to be used later
+        instance_methods = Module.new do
           circuits.each do |circuit|
-            define_method(circuit.method_name) do |*args|
-              Protoboard.config.adapter.run_circuit(circuit) { super(*args) }
+            unless circuit.singleton_method?
+              define_method(circuit.method_name) do |*args|
+                Protoboard.config.adapter.run_circuit(circuit) { super(*args) }
+              end
             end
           end
         end
 
+        proxy_module.const_set('InstanceMethods', instance_methods)
+
+        # Encapsulates singleton methods in a module to be used later
+        class_methods = Module.new do
+          circuits.each do |circuit|
+            if circuit.singleton_method?
+              define_method(circuit.method_name) do |*args|
+                Protoboard.config.adapter.run_circuit(circuit) { super(*args) }
+              end
+            end
+          end
+        end
+
+        proxy_module.const_set('ClassMethods', class_methods)
+
         Protoboard.const_set(module_name, proxy_module)
       end
 

data/lib/protoboard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Protoboard
-  VERSION = '0.1.5'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protoboard
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Carlos Atkinson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2018-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Protoboard abstracts the way you use Circuit Breaker allowing you to easily