pid_file_block 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b693b3fb17f115a6f52aeb7da5bf4ae85e33fc1ca73ad0da80706662eea145eb
+  data.tar.gz: 4247223843e8731087e4a01d3426cb8a26f87fe4897c302561fffc29e4e5e4d7
+SHA512:
+  metadata.gz: fe77e37bff0d4b65182db0dbafa0d8744adc94d0baca392ed32a675bc4dfe1cc5631cbe8147a05370b73c0ea5044a5981bf33ae6ee141235530188986de9b818
+  data.tar.gz: 997dd255185343fd9a40a58a00bfb0d6a7e96cc71291ed112fca4efac3a9d042700ca58db9e16debd64eae4a954d8f3769291c2e0664eb287c7e5c2c29dc00cf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*~

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pid_file_block.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alexander Kharitonov
+
+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,103 @@
+# PidFileBlock
+
+PidFileBlock - gem for easy use pid-files. The gem automatically creates and deletes pid-file for application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pid_file_block'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pid_file_block
+
+## Usage
+
+### Simple example
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'pid_file_block'
+
+pid_file_block = PidFileBlock.new(piddir: '/run', pidfile: 'example.pid')
+begin
+  pid_file_block.open do
+    # Put your code here
+  end
+rescue PidFileBlock::ProcessExistsError
+  # Another process running. Exit with error.
+  exit 1
+end
+```
+
+### With signal handlers
+
+In previous example pid-file will not be deleted after the program termination with command kill or Ctrl-C. You may define your signal handlers and use the release method in them:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'pid_file_block'
+
+$pid_file_block = nil
+
+def do_exit
+  $pid_file_block.release if $pid_file_block
+  exit 0
+end
+
+old_term = Signal.trap('TERM') do
+  do_exit
+end
+old_int = Signal.trap('INT') do
+  do_exit
+end
+
+$pid_file_block = PidFileBlock.new(piddir: '/run', pidfile: 'example.run')
+begin
+  $pid_file_block.open do
+    # Put your code here
+  end
+rescue PidFileBlock::ProcessExistsError
+  # Another process running. Exit with error.
+  exit 1
+end
+```
+
+Another way - use the PidFileBlock::Application
+
+### PidFileBlock::Application
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'pid_file_block'
+require 'pid_file_block/application'
+
+class MyApp < PidFileBlock::Application
+
+  def self.run_application
+    # Put your code here
+  end
+
+end
+
+MyApp.run(piddir: '/run', pidfile: 'example.pid')
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/askh/pid_file_block.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pid_file_block"
+
+# 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/lib/pid_file_block/application.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'pid_file_block'
+
+class PidFileBlock
+  
+  class Application
+
+    def self.run_application
+    end
+    
+    def self.do_exit(pid_file_block, exit_code)
+      pid_file_block.release if pid_file_block
+      exit exit_code
+    end
+
+    def self.run(piddir:,
+                 pidfile:,
+                 exit_code_normal: 0,
+                 exit_code_process_exists_error: 1,
+                 exit_code_interrupt: 2)
+      pid_file_block = nil
+      old_term = Signal.trap('TERM') do
+        do_exit(pid_file_block, exit_code_interrupt)
+      end
+      old_int = Signal.trap('INT') do
+        do_exit(pid_file_block, exit_code_interrupt)
+      end
+      pid_file_block = PidFileBlock.new(piddir: piddir, pidfile: pidfile)
+      begin
+        pid_file_block.open do
+          run_application
+        end
+      rescue PidFileBlock::ProcessExistsError
+        STDERR.puts "Error: process exists (see pid in file #{pid_file_block.pid_file_full_name})."
+        exit exit_code_process_exists_error
+      end
+      exit exit_code_normal
+    end
+    
+  end
+  
+end
+

data/lib/pid_file_block/process_exists_error.rb

@@ -0,0 +1,4 @@
+class PidFileBlock
+  class ProcessExistsError < RuntimeError
+  end
+end

data/lib/pid_file_block/version.rb

@@ -0,0 +1,5 @@
+class PidFileBlock
+  module Version
+    VERSION = "0.1.1".freeze
+  end
+end

data/lib/pid_file_block.rb

@@ -0,0 +1,95 @@
+require 'pid_file_block/version'
+require 'pid_file_block/process_exists_error'
+
+class PidFileBlock
+
+  attr_reader :pid_file_full_name
+
+  def initialize(piddir: '/run', pidfile:)
+    pidfile ||= File.basename($0, '.*')
+    @pid_file_full_name = File.join(piddir, pidfile)
+  end
+  
+  def open
+    loop do
+      begin
+        File.open(@pid_file_full_name, 'r') do |f|
+          f.flock(File::LOCK_EX)
+          if process_running?(f)
+            # f.flock(File::LOCK_UN)
+            raise PidFileBlock::ProcessExistsError
+          end
+          unlink_pid_file_if_exists
+        end
+      rescue Errno::ENOENT
+      end
+      begin
+        File.open(@pid_file_full_name,
+                  File::Constants::RDWR|File::Constants::CREAT|File::Constants::EXCL) do |f|
+          f.flock(File::LOCK_EX)
+          if process_running?(f)
+            # f.flock(File::LOCK_UN)
+            raise PidFileBlock::ProcessExistsError
+          end
+          write_pid(f)
+          # f.flock(File::LOCK_UN)
+        end
+        break
+      rescue Errno::EEXIST
+      end
+    end
+    yield
+    unlink_pid_file_if_exists
+  end
+
+  def release
+    our_pid = $$
+    File.open(@pid_file_full_name, 'r') do |f|
+      f.flock(File::LOCK_EX)
+      file_pid_str = f.read
+      begin
+        file_pid = Integer(file_pid_str)
+      rescue ArgumentError
+        return false
+      end      
+      if file_pid == our_pid
+        unlink_pid_file_if_exists
+        return true
+      else
+        return false
+      end
+    end
+  end
+
+  private
+
+  def unlink_pid_file_if_exists
+    begin
+      File.unlink(@pid_file_full_name)
+    rescue Errno::ENOENT
+    end
+  end
+  
+  def process_running?(file_handle)
+    file_handle.seek(0)
+    pid_str = file_handle.read
+    begin
+      pid = Integer(pid_str)
+      if Process.getpgid(pid)
+        return true
+      end
+    rescue Errno::ESRCH
+      return false
+    rescue ArgumentError
+      return false
+    end
+    raise 'Program Logic Error'
+  end
+
+  def write_pid(file_handle)
+    pid = $$
+    file_handle.truncate(0)
+    file_handle.write(pid)
+  end
+
+end

data/pid_file_block.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pid_file_block/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pid_file_block"
+  spec.version       = PidFileBlock::Version::VERSION
+  spec.authors       = ["Alexander Kharitonov"]
+  spec.email         = ["askh@askh.ru"]
+
+  spec.summary       = %q{gem for easy use pid-file.}
+  spec.description   = %q{gem for automatic checking, creation and deletion pid-file of an application.}
+  spec.homepage      = "https://github.com/askh/pid_file_block"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: pid_file_block
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexander Kharitonov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: gem for automatic checking, creation and deletion pid-file of an application.
+email:
+- askh@askh.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pid_file_block.rb
+- lib/pid_file_block/application.rb
+- lib/pid_file_block/process_exists_error.rb
+- lib/pid_file_block/version.rb
+- pid_file_block.gemspec
+homepage: https://github.com/askh/pid_file_block
+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.7.6
+signing_key: 
+specification_version: 4
+summary: gem for easy use pid-file.
+test_files: []