safe and unsafe method analyse

Author: v.promzelev

README.md

@@ -23,10 +23,11 @@ Or install it yourself as:
 
 Just place it somewhere in your app:
 ```ruby
-ActiveRecord::OverflowSignalizer.new.analyse!
+ActiveRecord::OverflowSignalizer.new.analyse
 ```
 
 By default it checks all models in your application and logs if some primary key will overflow soon or overflowed.
+Also you can use unsafe method `#analyse!`, so it will raise error.
 
 You can place it in some job and perform it by [clockwork](https://github.com/adamwiggins/clockwork)
 or just run it when app starts in a separate thread.

lib/activerecord/overflow_signalizer.rb

@@ -3,6 +3,8 @@
 
 module ActiveRecord
   class OverflowSignalizer
+    class Overflow < StandardError; end
+
     class UnsupportedType < StandardError
       attr_reader :type
 
@@ -33,11 +35,17 @@ def analyse!
         pk = model.columns.select { |c| c.name == model.primary_key }.first
         max = MAX_VALUE.fetch(pk.sql_type) { |type| raise UnsupportedType, type }
         if overflow_soon?(max, model)
-          signalize(table, model.last.public_send(pk.name), max)
+          raise Overflow, overflow_message(table, model.last.public_send(pk.name), max)
         end
       end
     end
 
+    def analyse
+      analyse!
+    rescue Overflow => e
+      signalize(e.message)
+    end
+
     private
 
     def overflow_soon?(max, model)
@@ -58,12 +66,15 @@ def avg(model)
       week_records.reduce(:+) / week_records.keep_if { |v| v > 0 }.size
     end
 
-    def signalize(table, current_value, max_value)
+    def overflow_message(table, current_value, max_value)
       if current_value == max_value
-        msg = "Primary key in table #{table} overflowed! #{current_value} from #{max_value}"
+        "Primary key in table #{table} overflowed! #{current_value} from #{max_value}"
       else
-        msg = "Primary key in table #{table} will overflow soon! #{current_value} from #{max_value}"
+        "Primary key in table #{table} will overflow soon! #{current_value} from #{max_value}"
       end
+    end
+
+    def signalize(msg)
       if @logger && @logger.respond_to?(:warn)
         @logger.warn(msg)
       end

lib/activerecord/overflow_signalizer/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   class OverflowSignalizer
-    VERSION = '0.1.1'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

spec/activerecord/overflow_signalizer_spec.rb

@@ -6,6 +6,69 @@
   end
 
   describe '#analyse!' do
+    context 'raise exception' do
+      subject { described_class.new(models: [TestIntModel], days_count: 10) }
+
+      context 'empty table' do
+        it { expect { subject.analyse! }.not_to raise_error }
+      end
+
+      context 'not empty table' do
+        let(:max_int) { 2_147_483_647 }
+        let(:day) { 24 * 60 * 60 }
+        let(:today) { Time.now }
+
+        context 'overflow far' do
+          before do
+            (1..7).each do |t|
+              TestIntModel.create!(created_at: today - day * t, updated_at: today - day * t)
+            end
+          end
+
+          after do
+            TestIntModel.connection.execute(%Q{ALTER SEQUENCE "int_test_id_seq" RESTART WITH 1;})
+            TestIntModel.destroy_all
+          end
+
+          it { expect { subject.analyse! }.not_to raise_error }
+        end
+
+        context 'overflow soon' do
+          before do
+            TestIntModel.connection.execute(%Q{ALTER SEQUENCE "int_test_id_seq" RESTART WITH #{max_int - 16};})
+            (1..7).each do |t|
+              TestIntModel.create!(created_at: today - day * t, updated_at: today - day * t)
+            end
+          end
+
+          after do
+            TestIntModel.connection.execute(%Q{ALTER SEQUENCE "int_test_id_seq" RESTART WITH 1;})
+            TestIntModel.destroy_all
+          end
+
+          it { expect { subject.analyse! }.to raise_error(described_class::Overflow) }
+        end
+
+        context 'overflowed' do
+          before do
+            TestIntModel.connection.execute(%Q{ALTER SEQUENCE "int_test_id_seq" RESTART WITH #{max_int - 6};})
+            (1..7).each do |t|
+              TestIntModel.create!(created_at: today - day * t, updated_at: today - day * t)
+            end
+          end
+
+          after do
+            TestIntModel.connection.execute(%Q{ALTER SEQUENCE "int_test_id_seq" RESTART WITH 1;})
+            TestIntModel.destroy_all
+          end
+
+          it { expect { subject.analyse! }.to raise_error(described_class::Overflow) }
+        end
+      end
+    end
+  end
+
+  describe '#analyse' do
     context 'signalize to logger' do
       let!(:logger) { double(:logger, warn: true) }
 
@@ -14,7 +77,7 @@
       context 'empty table' do
         it 'doesnt log anything' do
           expect(logger).not_to receive(:warn)
-          subject.analyse!
+          subject.analyse
         end
       end
 
@@ -37,7 +100,7 @@
 
           it 'doesnt log anything' do
             expect(logger).not_to receive(:warn)
-            subject.analyse!
+            subject.analyse
           end
         end
 
@@ -57,7 +120,7 @@
           it 'log about owerflow' do
             expect(logger).to receive(:warn)
               .with("Primary key in table #{TestIntModel.table_name} will overflow soon! #{TestIntModel.last.id} from #{max_int}")
-            subject.analyse!
+            subject.analyse
           end
         end
 
@@ -77,7 +140,7 @@
           it 'log about owerflow' do
             expect(logger).to receive(:warn)
               .with("Primary key in table #{TestIntModel.table_name} overflowed! #{TestIntModel.last.id} from #{max_int}")
-            subject.analyse!
+            subject.analyse
           end
         end
       end
@@ -91,7 +154,7 @@
       context 'empty table' do
         it 'doesnt log anything' do
           expect(signalizer).not_to receive(:signalize)
-          subject.analyse!
+          subject.analyse
         end
       end
 
@@ -114,7 +177,7 @@
 
           it 'doesnt log anything' do
             expect(signalizer).not_to receive(:signalize)
-            subject.analyse!
+            subject.analyse
           end
         end
 
@@ -134,7 +197,7 @@
           it 'log about owerflow' do
             expect(signalizer).to receive(:signalize)
               .with("Primary key in table #{TestIntModel.table_name} will overflow soon! #{TestIntModel.last.id} from #{max_int}")
-            subject.analyse!
+            subject.analyse
           end
         end
 
@@ -154,7 +217,7 @@
           it 'log about owerflow' do
             expect(signalizer).to receive(:signalize)
               .with("Primary key in table #{TestIntModel.table_name} overflowed! #{TestIntModel.last.id} from #{max_int}")
-            subject.analyse!
+            subject.analyse
           end
         end
       end