rake_pid 0.0.1

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

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 kenshin54
+
+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 @@
+# RakePid
+
+RakePid is use to write a pid file when you run a rask task, and auto delete pid file when task is end or abort. It was useful when you need to monitor your rake task with [monit](http://mmonit.com/monit/) or [god](http://godrb.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rake_pid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rake_pid
+
+## Usage
+
+### Configure the directory
+
+If no directory be configured, RakePid would write pid file to current directory.
+
+```ruby
+  RakePid.configure do
+    path 'tmp/pids'
+  end
+```
+
+### Write rake task
+
+```ruby
+  task :hello do |task|
+    with_pid(task) do
+      puts "world"
+    end
+  end
+```
+
+### Override pid file name
+
+You can override pid file name by set PIDFILE
+
+```bash
+  rake hello PIDFILE=foo.pid
+```
+
+### Your can force delete pid file if something is going wrong by set FORCE to true
+
+```bash
+  rake hello FORCE=true
+```
+
+## 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,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+task :default => :test

data/example/rakefile

@@ -0,0 +1,8 @@
+require 'rake-pid'
+
+task :hello do |t|
+  with_pid(t) do
+    puts "world"
+    sleep(5)
+  end
+end

data/lib/rake_pid.rb

@@ -0,0 +1,15 @@
+require "rake_pid/version"
+require 'rake_pid/core'
+
+module RakePid
+
+  class TaskMissingError < StandardError; end
+  class FileAlreadyExistError < StandardError; end
+
+  def self.configure(&block)
+    Configuration.class_eval(&block)
+  end
+
+end
+
+self.extend RakePid::Core

data/lib/rake_pid/configuration.rb

@@ -0,0 +1,10 @@
+module RakePid
+
+  class Configuration
+
+    def self.path(path = nil)
+      @path = path || @path || './'
+    end
+
+  end
+end

data/lib/rake_pid/core.rb

@@ -0,0 +1,34 @@
+require 'rake_pid/configuration'
+
+module RakePid
+
+  module Core
+
+    def with_pid(task)
+      if task.nil? || !task.respond_to?(:name)
+        raise TaskMissingError.new("You need to pass the task object to with_pid.")
+      end
+
+      pid_file_name = ENV['PIDFILE'] ? ENV['PIDFILE'] : "#{task.name.gsub(':', '-')}.pid"
+      pid_file = File.join(Configuration.path, pid_file_name)
+
+      if File.exists?(pid_file)
+        if ENV['FORCE'] == 'true'
+          File.delete(pid_file) 
+        else
+          raise FileAlreadyExistError.new("The pid file '#{pid_file}' already exist, delete it and run task again.")
+        end
+      end
+
+      File.open(pid_file, 'w') { |f| f << Process.pid }
+      at_exit do 
+        File.delete(pid_file) if File.exists?(pid_file)
+      end
+
+      yield
+      
+      pid_file_name
+    end
+
+  end
+end

data/lib/rake_pid/version.rb

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

data/rake_pid.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake_pid/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rake_pid"
+  gem.version       = RakePid::VERSION
+  gem.authors       = ["kenshin54"]
+  gem.email         = ["himurakenshin54@gmail.com"]
+  gem.description   = %q{Manage pid file when run a rake task}
+  gem.summary       = %q{Manage pid file when run a rake task}
+  gem.homepage      = "http://github.com/kenshin54/rake_pid"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake',      '~> 0.9.2'
+  gem.add_development_dependency 'bundler',   '~> 1.1'
+  gem.add_development_dependency 'minitest',  '~> 3.3.0'
+  gem.add_development_dependency 'mocha',     '~> 0.13.1'
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+require 'minitest/spec'
+require 'minitest/pride'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require 'rake_pid'

data/test/unit/core_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+describe RakePid::Core do
+  before(:each) do
+    @obj = Object.new
+    @obj.extend RakePid::Core
+    MyTask = Struct.new(:name) unless Kernel.const_defined?(:MyTask)
+    @task = MyTask.new('foo')
+    File.delete('./foo.pid') if File.exists?('./foo.pid')
+  end
+  
+  it "should raise TaskMissingError when the argument is nil" do
+    proc { @obj.with_pid(nil) }.must_raise RakePid::TaskMissingError
+  end
+
+  it "should raise TaskMissingError when the argument didn't respond to :name" do
+    proc { @obj.with_pid(Object.new) }.must_raise RakePid::TaskMissingError
+  end
+
+  it "pid file name should same as task name" do
+    @obj.with_pid(@task) {}.must_equal 'foo.pid'
+  end
+
+  it "should override pid file name when PIDFILE environment variable has been seted" do
+    ENV['PIDFILE'] = 'bar.pid'
+    @obj.with_pid(@task) {}.must_equal 'bar.pid'
+    ENV['PIDFILE'] = nil
+  end
+
+  it "should raise FileAlreadyExistError when pid file already exist" do
+    FileUtils.touch './foo.pid'
+    at_exit do
+      File.delete('./foo.pid') if File.exists?('./foo.pid')
+    end
+    proc { @obj.with_pid(@task) {} }.must_raise RakePid::FileAlreadyExistError
+  end
+
+  it "should delete pid file when FORCE environment variable has been set to true even pid file already exist" do
+    FileUtils.touch './foo.pid'
+    at_exit do
+      File.delete('./foo.pid') if File.exists?('./foo.pid')
+    end
+    ENV['FORCE'] = 'true'
+    File.expects(:delete).with('./foo.pid')
+    @obj.with_pid(@task) {}
+    ENV['FORCE'] = nil 
+  end
+
+  it "should create pid file and delete pid file when task is end" do
+    File.expects(:open).with('./foo.pid', 'w')
+    @obj.with_pid(@task) {}
+    File.exists?('./foo.pid').must_equal false
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rake_pid
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- kenshin54
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    none: false
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    none: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    none: false
+  prerelease: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    none: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+    none: false
+  prerelease: false
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+    none: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+    none: false
+  prerelease: false
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+    none: false
+  type: :development
+description: Manage pid file when run a rake task
+email:
+- himurakenshin54@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/rakefile
+- lib/rake_pid.rb
+- lib/rake_pid/configuration.rb
+- lib/rake_pid/core.rb
+- lib/rake_pid/version.rb
+- rake_pid.gemspec
+- test/test_helper.rb
+- test/unit/core_test.rb
+homepage: http://github.com/kenshin54/rake_pid
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4094812768928479822
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4094812768928479822
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Manage pid file when run a rake task
+test_files:
+- test/test_helper.rb
+- test/unit/core_test.rb