growing_queue_condition 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dba41234a841850840821da4468b563ae833fd1c
+  data.tar.gz: 76d2500a4aebebfe74dcd04298e1ef388bb6b75a
+SHA512:
+  metadata.gz: aa60b44babaf27aacaf53dae8a30546238581b2b0c4ee41393861392dfa47a37a842e18362cf98e086c533633b9f4c43153f2dfc284de025bcf4b01bb83e4d43
+  data.tar.gz: 89fa6dde4e3fd8d1f315fa43297b3f687db4b7c820b132909177924b3188fa0681470bcf85c8bd9146fa6af7a6707f4ab70b3dc149f4c1f6835b3912b660cabe

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle/
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage/
+doc/
+lib/bundler/man
+pkg/
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+vendor/
+.rspec

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'god'
+
+group :development, :test do
+  gem 'debugger'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-spork'
+  gem 'spork'
+  gem 'rspec'
+  gem 'simplecov'
+end

data/Guardfile

@@ -0,0 +1,35 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+
+
+guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'test' }, :rspec_env => { 'RAILS_ENV' => 'test' } do
+  watch('config/application.rb')
+  watch('config/environment.rb')
+  watch('config/environments/test.rb')
+  watch(%r{^config/initializers/.+\.rb$})
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+  watch('test/test_helper.rb') { :test_unit }
+  watch(%r{features/support/}) { :cucumber }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bryan
+
+MIT License
+
+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,61 @@
+# GrowingQueueCondition [![Build Status](https://travis-ci.org/rubyisbeautiful/growing_queue_condition.png)](https://travis-ci.org/rubyisbeautiful/growing_queue_condition)[![Code Climate](https://codeclimate.com/github/rubyisbeautiful/growing_queue_condition.png)](https://codeclimate.com/github/rubyisbeautiful/growing_queue_condition)
+
+This is a God::Condition for god [http://godrb.com/] to alert on a queue that is growing.  The principal use case is
+for a background processors, such as DelayedJob, Resque, ActiveMQ, etc...
+but could be for any growing queue/table/data store.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'growing_queue_condition'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install growing_queue_condition
+
+## Usage
+
+The gem requires a class that responds to an instance method queue_size.  The class must be accessible to god.
+
+### Example
+
+``my_class.rb``
+{code}
+class MyClass
+
+def <<*self
+
+  def queue_size
+    # code returning an int or int-able value
+  end
+
+end
+{code}
+
+``god_config.rb``
+{code}
+require 'growing_queue_condition'
+
+restart.condition(:growing_queue) do |c|
+    c.times     = [3,5]
+    c.interval  = 30.seconds
+    c.obj       = MyClass.new
+end
+
+{code}
+
+The example will call the instantiated MyClass instance method queue_size at least 4 times.  If the size is larger or
+the same each time, the condition will fail.  See 'Examples' for possible usages.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/mysql_example.rb

@@ -0,0 +1,24 @@
+class DjExample
+
+  attr_accessor :user
+  attr_accessor :pass
+  attr_accessor :host
+  attr_accessor :db
+  attr_accessor :table
+
+
+  def initialize(opts={})
+    @user = opts[:user]
+    @pass = opts[:pass]
+    @host = opts[:host]
+    @db = opts[:db]
+    @table = opts[:table]
+  end
+
+
+  # this is a pretty lame example that uses command line mysql client instead of mysql2
+  def queue_size
+    `mysql -u #{user} -p'#{pass}' -h #{host} --silent --skip-column-names #{db} --execute 'select count(*) from #{table}'`
+  end
+
+end

data/growing_queue_condition.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'growing_queue_condition/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'growing_queue_condition'
+  spec.version       = GrowingQueueCondition::VERSION
+  spec.authors       = ['rubyisbeautiful']
+  spec.email         = ['bcptaylor@gmail.com']
+  spec.description   = %q{a God::Condition for the god gem, which will alert on a neglected queue using any object/method}
+  spec.summary       = %q{a God::Condition for the god gem, which will alert on a neglected queue}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_runtime_dependency 'god'
+end

data/lib/growing_queue_condition.rb

@@ -0,0 +1,9 @@
+# god has this flag to prevent bundler from unnecessarily loading all of god
+$load_god = true
+
+require 'god'
+require 'growing_queue_condition/version'
+require 'growing_queue_condition/base'
+
+module GrowingQueueCondition
+end

data/lib/growing_queue_condition/base.rb

@@ -0,0 +1,95 @@
+module God
+  module Conditions
+    # Condition Symbol :growing_queue
+    # Type: Poll
+    #
+    # Trigger when a queue is growing
+    #
+    # Parameters
+    # Required
+    #   +obj+ is an instance of a queue interface class
+    # Optional
+    #   +method+ is the method to call, it defaults to queue_size
+    #
+    # Examples
+    #
+    # Trigger if the queue has grown 3 out of the last 5 checks
+    #
+    # restart.condition(:growing_queue) do |c|
+    #   c.times     = [3,5]
+    #   c.interval  = 30.seconds
+    #   c.obj       = MyClass.new
+    # end
+    class GrowingQueue < PollCondition
+      attr_accessor :times, :obj, :meth
+
+
+      def initialize
+        super
+        self.times ||= [2, 3]
+        self.meth ||= :queue_size
+      end
+
+
+      def prepare
+        if self.times.kind_of? Integer
+          self.times = [self.times, self.times]
+        end
+
+        @timeline = Timeline.new(self.times[1])
+      end
+
+
+      def reset
+        @timeline.clear
+      end
+
+
+      def valid?
+        valid = true
+        valid &= complain("Attribute 'obj' must be specified", self) if self.obj.nil?
+        valid
+      end
+
+
+      def test
+        failing = false
+        count = obj.call(meth)
+        num_of_fails = times[0]
+        num_of_tests = times[1]
+
+        @timeline.push count.to_i
+
+        history = "[#{@timeline.join(', ')}]"
+
+        if @timeline.length < num_of_tests
+          self.info = 'not enough info'
+          return false
+        end
+
+        ary = @timeline.dup.flatten
+        fails = []
+
+        (num_of_fails == num_of_tests ? num_of_fails-1 : num_of_fails).times do
+          if ary[-1] == 0
+            fails << false
+          else
+            fails << (ary[-1] >= ary[-2])
+          end
+          ary.shift
+        end
+
+        bad, good = fails.partition { |f| TrueClass === f }
+        failing = bad.length >= num_of_fails
+
+        if failing
+          self.info = "count increasing: (#{bad.length} fails #{history}"
+          return true
+        else
+          self.info = "count ok: #{history}"
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/growing_queue_condition/version.rb

@@ -0,0 +1,3 @@
+module GrowingQueueCondition
+  VERSION = '0.0.1'
+end

data/spec/growing_queue_condition_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+def setup_test(condition, max_size, ary)
+  ary.reverse!
+
+  t = God::Timeline.new(max_size)
+  begin
+    t.push ary.pop
+  end until ary.empty?
+
+  condition.instance_variable_set('@timeline', t)
+end
+
+
+describe God::Conditions::GrowingQueue do
+
+  before :each do
+    # don't care about logging and don't want to see it on STDOUT
+    God.log_file = '/dev/null'
+  end
+
+
+  context 'initialize' do
+
+    before :each do
+      subject.stub(:obj).and_return double.as_null_object
+    end
+
+    it 'should set a default method' do
+      subject.meth.should == :queue_size
+    end
+  end
+
+
+  context 'valid' do
+
+    it 'should be false if obj is not set' do
+      subject.stub(:watch).and_return(double(name: 'foo').as_null_object)
+      subject.valid?.should be_false
+    end
+  end
+
+
+  context 'test' do
+
+    context 'sanity check on setup_test' do
+
+      it 'should return a properly setup object' do
+        setup_test(subject, 3, [1,2,3])
+
+        t = subject.instance_variable_get('@timeline')
+        t[0].should == 1
+        t[1].should == 2
+        t[2].should == 3
+      end
+
+    end
+
+
+    context 'when times is 3,5' do
+
+      let(:subject){ God::Conditions::GrowingQueue.new }
+
+      before :each do
+        subject.times = [3,5]
+      end
+
+      it 'should be false with results 0,0 pushing 0 (not growing)' do
+        obj = double
+        obj.should_receive(:call).with(:queue_size).and_return 0
+
+        subject.obj = obj
+        setup_test(subject, 5, [0,0])
+
+        subject.test.should be_false
+      end
+
+      it 'should be false with results 1,2 pushing 3 (not enough info)' do
+        obj = double
+        obj.should_receive(:call).with(:queue_size).and_return 3
+
+        subject.obj = obj
+        setup_test(subject, 5, [1,2])
+
+        subject.test.should be_false
+      end
+
+      it 'should be true with results 1,2,3,4 pushing 5 (growing)' do
+        obj = double
+        obj.should_receive(:call).with(:queue_size).and_return 5
+
+        subject.obj = obj
+        setup_test(subject, 5, [1,2,3,4])
+
+        subject.test.should be_true
+      end
+
+      it 'should be false with results 1,2,3,4 pushing 3 (not growing)' do
+        obj = double
+        obj.should_receive(:call).with(:queue_size).and_return 3
+
+        subject.obj = obj
+        setup_test(subject, 5, [1,2,3,4])
+
+        subject.test.should be_false
+      end
+
+      it 'should be true with results 1,1,1,1 pushing 1 (not shrinking)' do
+        obj = double
+        obj.should_receive(:call).with(:queue_size).and_return 1
+
+        subject.obj = obj
+        setup_test(subject, 5, [1,1,1,1])
+
+        subject.test.should be_true
+      end
+
+      it 'should be true with results 1,2,1,2 pushing 2 (3 of 5 fails)' do
+        obj = double
+        obj.should_receive(:call).with(:queue_size).and_return 2
+
+        subject.obj = obj
+        setup_test(subject, 5, [1,2,1,2])
+
+        subject.test.should be_true
+      end
+
+      it 'should be false with results 1,2,1,2 pushing 1 (2 of 5 fails)' do
+        obj = double
+        obj.should_receive(:call).with(:queue_size).and_return 1
+
+        subject.obj = obj
+        setup_test(subject, 5, [1,2,1,2])
+
+        subject.test.should be_false
+      end
+
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rspec'
+require 'spork'
+#require 'spork/ext/ruby-debug'
+
+Spork.prefork do
+  require_relative '../lib/growing_queue_condition'
+  RSpec.configure do |config|
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+    config.run_all_when_everything_filtered = true
+    config.filter_run :focus
+
+    # Run specs in random order to surface order dependencies. If you find an
+    # order dependency and want to debug it, you can fix the order by providing
+    # the seed, which is printed after each run.
+    #     --seed 1234
+    config.order = 'random'
+  end
+end
+
+Spork.each_run do
+
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: growing_queue_condition
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- rubyisbeautiful
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: god
+  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'
+description: a God::Condition for the god gem, which will alert on a neglected queue
+  using any object/method
+email:
+- bcptaylor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/mysql_example.rb
+- growing_queue_condition.gemspec
+- lib/growing_queue_condition.rb
+- lib/growing_queue_condition/base.rb
+- lib/growing_queue_condition/version.rb
+- spec/growing_queue_condition_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: a God::Condition for the god gem, which will alert on a neglected queue
+test_files:
+- spec/growing_queue_condition_spec.rb
+- spec/spec_helper.rb
+has_rdoc: