activerecord-overflow_signalizer 0.1.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/gemfiles/*.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+gemfile:
+  - gemfiles/ar32.gemfile
+  - gemfiles/ar42.gemfile
+  - gemfiles/ar50.gemfile
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.4

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'ar50' do
+  gem 'activerecord', '~> 5.0'
+end
+
+appraise 'ar42' do
+  gem 'activerecord', '~> 4.2'
+end
+
+appraise 'ar32' do
+  gem 'activerecord', '~> 3.2'
+end

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 v.promzelev@fun-box.ru. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-overflow_signalizer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 v.promzelev
+
+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,80 @@
+# ActiveRecord::OverflowSignalizer
+
+One day primary key field will overflow, but if you use this gem, you will know about it before it happened.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-overflow_signalizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-overflow_signalizer
+
+## Usage
+
+Just placed it somewhere in your app:
+```ruby
+ActiveRecord::OverflowSignalizer.new.analyse!
+```
+
+By default it check all models in your application and log if some primary key will overflow soon or overflowed.
+
+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.
+
+Also you can pass some parameters in initializer:
+
++ Specify logger
+```ruby
+ActiveRecord::OverflowSignalizer.new(logger: SomeCoolLogger)
+```
+By default ActiveRecord::Base.logger
+
++ Specify list of models
+```ruby
+ActiveRecord::OverflowSignalizer.new(models: [ModelName])
+```
+By default it retrieve 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.
+```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.
+```ruby
+class MyAwesomeSignalizer
+  def initialize(some_params)
+    @notifier = SomeChatNotifier.new(some_params)
+  end
+
+  def signalize(msg)
+    @notifier.send_msg(msg)
+  end
+end
+
+ActiveRecord::OverflowSignalizer.new(signalizer: MyAwesomeSignalizer.new(some_params))
+```
+By default it use only logging
+
+## Development
+
+For tests you need postgresql connection specified in `spec/database.yml`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/funbox/activerecord-overflow_signalizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-overflow_signalizer.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/overflow_signalizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-overflow_signalizer'
+  spec.version       = ActiveRecord::OverflowSignalizer::VERSION
+  spec.authors       = ['v.promzelev']
+  spec.email         = ['v.promzelev@fun-box.ru']
+
+  spec.summary       = 'Signalize when some primary key overflow soon.'
+  spec.description   = 'Signalize when some primary key overflow soon.'
+  spec.homepage      = 'https://github.com/funbox/activerecord-overflow_signalizer'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # spec.add_runtime_dependency 'activerecord', '~> 3.2'
+  spec.add_runtime_dependency 'pg'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'appraisal', '~> 2.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'pry'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/overflow_signalizer"
+
+# 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/gemfiles/ar32.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2"
+
+gemspec :path => "../"

data/gemfiles/ar42.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2"
+
+gemspec :path => "../"

data/gemfiles/ar50.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0"
+
+gemspec :path => "../"

data/lib/activerecord/overflow_signalizer.rb

@@ -0,0 +1,75 @@
+require 'activerecord/overflow_signalizer/version'
+require 'active_record'
+
+module ActiveRecord
+  class OverflowSignalizer
+    class UnsupportedType < StandardError
+      attr_reader :type
+
+      def initialize(type = nil)
+        @type = type
+      end
+    end
+
+    DAY = 24 * 60 * 60
+    DEFAULT_AVG = 100_000
+
+    MAX_VALUE = {
+      'integer' => 2_147_483_647,
+      'bigint' => 9_223_372_036_854_775_807
+    }.freeze
+
+    def initialize(logger: nil, models: nil, days_count: 60, signalizer: nil)
+      @logger = logger || ActiveRecord::Base.logger
+      @models = models || ActiveRecord::Base.descendants
+      @days_count = days_count
+      @signalizer = signalizer
+    end
+
+    def analyse!
+      @models.group_by(&:table_name).each do |table, models|
+        model = models.first
+        next if model.abstract_class? || model.last.nil?
+        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)
+        end
+      end
+    end
+
+    private
+
+    def overflow_soon?(max, model)
+      if model.columns.select { |c| c.name == 'created_at' }.empty?
+        (max - model.last.id) / DEFAULT_AVG <= @days_count
+      else
+        (max - model.last.id) / avg(model) <= @days_count
+      end
+    end
+
+    def avg(model)
+      now = model.last.created_at
+      week_records = (1..7).map do |t|
+        from = now - DAY * t
+        to = from + DAY
+        model.where(created_at: from..to).count
+      end
+      week_records.reduce(:+) / week_records.keep_if { |v| v > 0 }.size
+    end
+
+    def signalize(table, current_value, max_value)
+      if current_value == max_value
+        msg = "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}"
+      end
+      if @logger && @logger.respond_to?(:warn)
+        @logger.warn(msg)
+      end
+      if @signalizer && @signalizer.respond_to?(:signalize)
+        @signalizer.signalize(msg)
+      end
+    end
+  end
+end

data/lib/activerecord/overflow_signalizer/version.rb

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

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-overflow_signalizer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- v.promzelev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: pry
+  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: Signalize when some primary key overflow soon.
+email:
+- v.promzelev@fun-box.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-overflow_signalizer.gemspec
+- bin/console
+- bin/setup
+- gemfiles/ar32.gemfile
+- gemfiles/ar42.gemfile
+- gemfiles/ar50.gemfile
+- lib/activerecord/overflow_signalizer.rb
+- lib/activerecord/overflow_signalizer/version.rb
+homepage: https://github.com/funbox/activerecord-overflow_signalizer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Signalize when some primary key overflow soon.
+test_files: []