activerecord-overflow_signalizer 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ede4a07b9ede07b3890201238b00ca9672ad29b
-  data.tar.gz: 40f9de6c873f70b82b76ff4b0bcace62d0617f6e
+  metadata.gz: c78090d0511bef9b0dde4bd9806e69d46de9dfd7
+  data.tar.gz: 80ff96314dcf36dda7275149eff74840ef4653ac
 SHA512:
-  metadata.gz: 6454229cc6a4a9c67e5366a02be8dd06c0c8bbd64cb31ea6a0c5e6b221d184253955e52e98399f4eab56ec9f77d26b11359387279425ef66197274b2f4d54133
-  data.tar.gz: adeab12a104c11059bce4d10a249d667c7a1ff61f0db471dc4862f11b02e57a76dcc557e9f756e9e23636624669a58a67ad7191a2f6e12a0c70b9bff5224d03b
+  metadata.gz: 0afb0998fb161bd0f060bd8cc92f8d3e82b9cb73997169b97fe7f4129b15628c8e877af8ffc1dc80c0e51095913dcea52b691e4eb52513bf123eb935e510b17d
+  data.tar.gz: e7ed9f015e87d1d0e678bd9d5f070de49d4a8dfd34bee422f8ff0cfb880c5e4a61750132652b8467119910c3b4044a1534637989d76ce6230e403367adf263ff

data/.travis.yml

@@ -4,6 +4,11 @@ gemfile:
   - gemfiles/ar32.gemfile
   - gemfiles/ar42.gemfile
   - gemfiles/ar50.gemfile
+  - gemfiles/ar51.gemfile
 rvm:
   - 2.3.1
+addons:
+    postgresql: '9.4'
+before_script:
+  - psql -U postgres -c 'CREATE DATABASE overflow_analyzer_test'
 before_install: gem install bundler -v 1.14.4

data/Appraisals

@@ -1,5 +1,9 @@
+appraise 'ar51' do
+  gem 'activerecord', '~> 5.1'
+end
+
 appraise 'ar50' do
-  gem 'activerecord', '~> 5.0'
+  gem 'activerecord', '5.0'
 end
 
 appraise 'ar42' do

data/README.md

@@ -1,6 +1,7 @@
 # ActiveRecord::OverflowSignalizer
+[![Build Status](https://travis-ci.org/funbox/activerecord-overflow_signalizer.svg?branch=master)](https://travis-ci.org/funbox/activerecord-overflow_signalizer)
 
-One day primary key field will overflow, but if you use this gem, you will know about it before it happened.
+One day primary key field will overflow, but if you use this gem, you will know about it before it happens.
 
 ## Installation
 
@@ -20,17 +21,18 @@ Or install it yourself as:
 
 ## Usage
 
-Just placed it somewhere in your app:
+Just place it somewhere in your app:
 ```ruby
-ActiveRecord::OverflowSignalizer.new.analyse!
+ActiveRecord::OverflowSignalizer.new.analyse
 ```
 
-By default it check all models in your application and log if some primary key will overflow soon or overflowed.
+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 placed it in some job and perform it by [clockwork](https://github.com/adamwiggins/clockwork)
-or just run it when app started in separated thread.
+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.
 
-Also you can pass some parameters in initializer:
+Also you can pass some parameters to the initializer:
 
 + Specify logger
 ```ruby
@@ -42,15 +44,15 @@ By default ActiveRecord::Base.logger
 ```ruby
 ActiveRecord::OverflowSignalizer.new(models: [ModelName])
 ```
-By default it retrieve all descendants of ActiveRecord::Base
+By default it retrieves all descendants of ActiveRecord::Base
 
-+ Specify count of days. Gem start notify you if some primary key will overflow over the next numbers of days.
++ Specify count of days. Gem starts to notify you if some primary key will overflow over the next number of days.
 ```ruby
 ActiveRecord::OverflowSignalizer.new(days_count: 360)
 ```
 60 days by default
 
-+ You can use own signalizer for sending notification to e-mail, slack, hipchat, etc.
++ You can use your own signalizer for notification sending to e-mail, slack, hipchat, etc.
 ```ruby
 class MyAwesomeSignalizer
   def initialize(some_params)
@@ -64,11 +66,11 @@ end
 
 ActiveRecord::OverflowSignalizer.new(signalizer: MyAwesomeSignalizer.new(some_params))
 ```
-By default it use only logging
+By default it uses only logging
 
 ## Development
 
-For tests you need postgresql connection specified in `spec/database.yml`.
+For tests you need a postgresql connection specified in `spec/database.yml`.
 
 ## Contributing
 

data/lib/activerecord/overflow_signalizer.rb

@@ -3,6 +3,8 @@ require 'active_record'
 
 module ActiveRecord
   class OverflowSignalizer
+    class Overflow < StandardError; end
+
     class UnsupportedType < StandardError
       attr_reader :type
 
@@ -33,11 +35,17 @@ module ActiveRecord
         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 @@ module ActiveRecord
       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

data/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-overflow_signalizer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - v.promzelev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg