doberman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5acc2f3a8906a894e18baa3b6cf0b30116b3abe
+  data.tar.gz: 27a84df52fe8ab3234c003bcd897f1bed8aeda89
+SHA512:
+  metadata.gz: 0fc049b31d2523ece233026b60a851269dbb1d20f1be5f5ad156721f1b81dec02a37aa8ca48aad8e913049b2e226919163879b347260921c4a28ae3857d12e62
+  data.tar.gz: e9e5936011a153a1f5432bb7fea6662b292823a217d9c772a5461cb92fa43af01a00547085a44d8309bab8541b219517aac58f160e464bf30707d8675614984a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--profile
+--tty

data/.ruby-gemset

@@ -0,0 +1 @@
+midi_lyrics

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doberman.gemspec
+gemspec
+
+group :test do
+  gem 'simplecov', :require => false
+  gem 'coveralls', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mateus Del Bianco
+
+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,62 @@
+# Doberman
+
+Doberman is your favorite watchdog timer. It makes sure your code is still alive, barking out loud if there's silence for too long.
+
+[![Build Status](https://travis-ci.org/mateusdelbianco/doberman.png)](https://travis-ci.org/mateusdelbianco/doberman)
+[![Code Climate](https://codeclimate.com/github/mateusdelbianco/doberman.png)](https://codeclimate.com/github/mateusdelbianco/doberman)
+[![Coverage Status](https://coveralls.io/repos/mateusdelbianco/doberman/badge.png?branch=master)](https://coveralls.io/r/mateusdelbianco/doberman?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doberman'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doberman
+
+## Usage
+
+```ruby
+begin
+  watchdog = Doberman::WatchDog.new(:timeout => 3)
+  watchdog.start
+  sleep 2
+  watchdog.ping
+  sleep 2
+  watchdog.ping
+  sleep 2
+  watchdog.stop
+  puts "yay! no barking!"
+rescue Doberman::WatchDog::Timeout => e
+  puts "woof woof!"
+end
+# => yay! no barking!
+```
+
+```ruby
+begin
+  watchdog = Doberman::WatchDog.new(:timeout => 3)
+  watchdog.start
+  watchdog.ping
+  sleep 4
+  watchdog.stop
+  puts "yay! no barking!"
+rescue Doberman::WatchDog::Timeout => e
+  puts "woof woof!"
+end
+# => woof woof!
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/mateusdelbianco/doberman/fork )
+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/doberman.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doberman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doberman"
+  spec.version       = Doberman::VERSION
+  spec.authors       = ["Mateus Del Bianco"]
+  spec.email         = ["mateus@delbianco.net.br"]
+  spec.summary       = %q{Doberman is your favorite watchdog timer.}
+  spec.description   = %q{Doberman makes sure your code is still alive, barking out loud if there's silence for too long.}
+  spec.homepage      = "https://github.com/mateusdelbianco/doberman"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "debugger"
+end

data/lib/doberman.rb

@@ -0,0 +1,63 @@
+require "doberman/version"
+
+module Doberman
+  class WatchDog
+    class Timeout < StandardError; end
+
+    attr_reader :error_message, :timeout
+
+    def initialize(options = {})
+      @error_message = options[:error_message] || "WatchDog timeout reached"
+      @timeout = options[:timeout] || 60
+      @resolution = options[:resolution] || 0.1
+      @current = Thread.current
+    end
+
+    def start
+      if @watchdog.nil?
+        reset_ttl
+        create_thread
+      end
+    end
+
+    def ping
+      if @watchdog.nil?
+        start
+      else
+        @reset = true
+      end
+    end
+
+    def stop
+      kill_thread
+    end
+
+    private
+
+    def create_thread
+      @watchdog = Thread.new do
+        while @ttl > 0
+          sleep @resolution
+          if @reset
+            reset_ttl
+          else
+            @ttl -= @resolution
+          end
+        end
+        @current.raise Timeout.new(@error_message)
+      end
+    end
+
+    def reset_ttl
+      @ttl = timeout.to_f
+      @reset = false
+    end
+
+    def kill_thread
+      unless @watchdog.nil?
+        @watchdog.kill
+        @watchdog = nil
+      end
+    end
+  end
+end

data/lib/doberman/version.rb

@@ -0,0 +1,3 @@
+module Doberman
+  VERSION = "0.0.1"
+end

data/spec/doberman_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Doberman::WatchDog do
+  describe "#initialize" do
+    it "should set a custom error_message" do
+      w = Doberman::WatchDog.new(:error_message => "custom_error_message")
+      expect(w.error_message).to eq("custom_error_message")
+    end
+
+    it "should set a custom timeout" do
+      w = Doberman::WatchDog.new(:timeout => 1234)
+      expect(w.timeout).to eq(1234)
+    end
+  end
+
+  describe "using the watchdog" do
+    context "protection against bad users" do
+      before :each do
+        @watchdog = Doberman::WatchDog.new
+      end
+
+      after :each do
+        @watchdog.stop
+      end
+
+      it "should not raise error if stop is used without start" do
+        expect { @watchdog.stop }.not_to raise_error
+      end
+
+      it "should not raise error if stop is used after start" do
+        @watchdog.start
+        expect { @watchdog.stop }.not_to raise_error
+      end
+
+      it "should not raise error if start is used twice" do
+        @watchdog.start
+        expect { @watchdog.start }.not_to raise_error
+      end
+
+      it "should not raise error if start is used after stop" do
+        @watchdog.start
+        @watchdog.stop
+        expect { @watchdog.start }.not_to raise_error
+      end
+
+      it "should not raise error if ping is used without start" do
+        expect { @watchdog.ping }.not_to raise_error
+      end
+
+      it "should start watchdog if ping is used without start" do
+        expect(@watchdog).to receive(:start)
+        @watchdog.ping
+      end
+
+      it "should not raise error if ping is used after start" do
+        @watchdog.start
+        expect { @watchdog.ping }.not_to raise_error
+      end
+    end
+
+    context "using the watchdog" do
+      it "should raise error if timeout is reached" do
+        w = Doberman::WatchDog.new(:timeout => 0.1)
+        w.start
+        w.ping
+        expect { sleep 0.4 }.to raise_error(Doberman::WatchDog::Timeout)
+        w.stop
+      end
+
+      it "should not raise error if timeout is not reached" do
+        w = Doberman::WatchDog.new(:timeout => 1)
+        w.start
+        w.ping
+        expect { sleep 0.4 }.not_to raise_error
+        w.stop
+      end
+
+      it "should not raise error if timeout is reached but ping is used" do
+        w = Doberman::WatchDog.new(:timeout => 0.5)
+        w.start
+        w.ping
+        expect do
+          3.times do
+            sleep 0.3
+            w.ping
+          end
+        end.not_to raise_error
+        w.stop
+      end
+
+      it "should not raise error if timeout is reached after stop" do
+        w = Doberman::WatchDog.new(:timeout => 0.1)
+        w.start
+        w.ping
+        w.stop
+        expect { sleep 0.4 }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "simplecov"
+require "coveralls"
+
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    Coveralls::SimpleCov::Formatter.new.format(result)
+  end
+end
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+SimpleCov.start do
+  add_filter "spec"
+end
+
+require "doberman"
+
+RSpec.configure do |config|
+  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

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: doberman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mateus Del Bianco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rspec
+  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: debugger
+  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: Doberman makes sure your code is still alive, barking out loud if there's
+  silence for too long.
+email:
+- mateus@delbianco.net.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doberman.gemspec
+- lib/doberman.rb
+- lib/doberman/version.rb
+- spec/doberman_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mateusdelbianco/doberman
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Doberman is your favorite watchdog timer.
+test_files:
+- spec/doberman_spec.rb
+- spec/spec_helper.rb