run_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d84a1c4bfcaaa5ae2eabae3c2533340e731e138b
+  data.tar.gz: 4a3330e8ffb7b73bebce4ddddaf450e6fe1635fe
+SHA512:
+  metadata.gz: 3c6c91d717434d64170d2f6191336c43f539270d0b548474c14bdf0a9b80f2a57a70395f64d467d6d843c7d3547ed0799a7dc3506cd72bd828581b172783184c
+  data.tar.gz: 5e1e9c03b335bde5df919fe943ea97f46f111af946896e43e7e425eed249485201a5a3a6607c526886a7b902ba943aaacf611bed4945cc7078c97649d8ec8f12

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'log4r'
+
+gem 'rubocop', group: :development
+gem 'rspec', group: :development

data/Gemfile.lock

@@ -0,0 +1,41 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    diff-lcs (1.2.5)
+    log4r (1.1.10)
+    parser (2.2.0.pre.5)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rubocop (0.26.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.4, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.6.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  log4r
+  rspec
+  rubocop

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 byplayer and takayoshi kohayakawa
+
+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.rdoc

@@ -0,0 +1,3 @@
+This is library to check duplicate running
+
+This program is provided under MIT license.

data/Rakefile

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+require 'rdoc'
+require 'rake'
+require 'rdoc/task'
+require 'rubygems/package_task'
+require 'bundler/setup'
+
+lib = File.expand_path(File.join('..', 'lib/'), __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+require 'run_checker/version'
+
+begin
+  require 'rspec/core/rake_task'
+rescue LoadError
+  puts 'no rspec'
+else
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.ruby_opts = '-w'
+  end
+
+  task default: :spec
+end
+
+begin
+  require 'rubocop/rake_task'
+rescue LoadError
+  puts 'no rubocop'
+else
+  RuboCop::RakeTask.new
+end
+
+Rake::RDocTask.new do |rdoc|
+  begin
+    version = File.read('VERSION').chomp
+  rescue
+    version = '0.0.0'
+    puts "No version is set in file VERSION.  Set by default to #{version}"
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "run_checker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+
+  rdoc.options += [
+    '-H', '-a', '-t', '-d',
+    '-f', 'darkfish',  # This is the important bit
+  ]
+end
+
+# gem task
+gemspec = Gem::Specification.new do |s|
+  s.name = 'run_checker'
+  s.version = RunChecker::VERSION::STRING
+  s.authors = ['byplayer']
+  s.date = '2014-10-07'
+  s.description = 'The duplicated running checker to support batch process'
+  s.email = ['byplayer100@gmail.com']
+  s.licenses = 'MIT license'
+  s.extra_rdoc_files = [
+    'README.rdoc'
+  ]
+  s.files = FileList[
+    '[A-Z]*',
+    'bin/**/*',
+    'lib/**/*.rb',
+    'test/**/*.rb',
+    'doc/**/*',
+    'spec/**/*.rb',
+  ]
+  s.homepage = 'https://github.com/byplayer/run_checker'
+  s.rdoc_options = ['--charset=UTF-8', '--line-numbers', '--inline-source',
+                    '--main', 'README.rdoc', '-c UTF-8']
+  s.require_paths = ['lib']
+  s.rubyforge_project = 'run_checker'
+  s.rubygems_version = '0.1.0'
+  s.summary = 'The duplicated running checker'
+  s.test_files = Dir.glob('spec/**/*')
+
+  s.add_dependency('log4r', '~> 0')
+end
+
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.gem_spec = gemspec
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/run_checker/run_checker.rb

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+require 'log4r'
+require 'English'
+
+# This is class to check duplicated run
+class RunChecker
+  # [lock_path]
+  #   lock file path
+  # [logger]
+  #   logger instance, it is expected a instance of Logger in Log4r.
+  #   If you don't set logger or you set nil for this param,
+  #   log information will be put to stdout via StdoutOutputter.
+  def initialize(lock_path, logger = nil)
+    @lock_path = lock_path
+    @logger = logger
+
+    return if @logger
+
+    formatter = Log4r::PatternFormatter.new(pattern: '%d [%l]:%p: %M',
+                                            date_format: '%Y.%m.%d %H:%M:%S')
+    outputter = Log4r::StdoutOutputter.new('RunCheckerOutPutter',
+                                           formatter: formatter)
+    @logger = Log4r::Logger.new('RunChecker')
+    @logger.add(outputter)
+  end
+
+  # lock
+  # [return]
+  #   If this method returns true, other process didn't run.
+  #   If this method returns false, other process runs.
+  def lock
+    if File.exist? @lock_path
+      pid = 0
+      File.open(@lock_path, 'r') do |f|
+        pid = f.read.chomp!.to_i
+      end
+
+      if exist_process(pid)
+        @logger.info("other process is running: pid(#{pid})")
+        return false
+      else
+        @logger.warn("process was finished pid(#{pid}), " +
+                      'cleanup lock file and start new process')
+        File.delete(@lock_path)
+      end
+    end
+
+    File.open(@lock_path, 'w') do |f|
+      locked = f.flock(File::LOCK_EX | File::LOCK_NB)
+      if locked
+        f.puts $PROCESS_ID
+        return true
+      else
+        @logger.error("lock failed -> pid: #{$PID}")
+        return false
+      end
+    end
+  end
+
+  def cleanup
+    return unless File.exist? @lock_path
+
+    pid = 0
+    File.open(@lock_path, 'r') do |f|
+      pid = f.read.chomp!.to_i
+    end
+
+    if pid == $PROCESS_ID
+      File.delete(@lock_path)
+    else
+      @logger.info('lock file was created by other process')
+    end
+  end
+
+  private
+
+  def exist_process(pid)
+    Process.getpgid(pid)
+    return true
+  rescue => ex
+    @logger.info("check process error pid(#{pid}): #{ex}\n" +
+                  ex.backtrace.join("\n  "))
+    return false
+  end
+end

data/lib/run_checker/version.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+class RunChecker
+  # version information module
+  module VERSION
+    STRING =
+      File.open(
+        File.join(
+                  File.dirname(__FILE__), '..', '..', 'VERSION'), 'r') do |f|
+        f.gets.chomp
+      end
+
+    if STRING =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)/
+      MAJOR = Regexp.last_match(1).to_i
+      MINOR = Regexp.last_match(2).to_i
+      TINY  = Regexp.last_match(3).to_i
+    end
+  end
+end

data/lib/run_checker.rb

@@ -0,0 +1,2 @@
+require_relative File.join('run_checker', 'version')
+require_relative File.join('run_checker', 'run_checker')

data/spec/run_checker/run_checker_spec.rb

@@ -0,0 +1,50 @@
+describe RunChecker do
+  before(:each) do
+    @lock_file_path =
+      File.expand_path(File.join('..', 'test.lock'),
+                       File.dirname(__FILE__))
+    @run_checker = RunChecker.new(@lock_file_path)
+  end
+
+  after(:each) do
+    File.delete(@lock_file_path) if File.exist?(@lock_file_path)
+  end
+
+  it { expect(@run_checker.lock).to eq(true) }
+
+  it do
+    File.open(@lock_file_path, 'w') do |f|
+      f.puts 1
+    end
+
+    expect(@run_checker.lock).to eq(false)
+  end
+
+  it 'dead process' do
+    File.open(@lock_file_path, 'w') do |f|
+      f.puts 999_999_999
+    end
+
+    expect(@run_checker.lock).to eq(true)
+  end
+
+  it do
+    File.open(@lock_file_path, 'w') do |f|
+      f.puts $PROCESS_ID
+    end
+
+    @run_checker.cleanup
+
+    expect(File.exist?(@lock_file_path)).to eq(false)
+  end
+
+  it do
+    File.open(@lock_file_path, 'w') do |f|
+      f.puts 999_999_999
+    end
+
+    @run_checker.cleanup
+
+    expect(File.exist?(@lock_file_path)).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+$LOAD_PATH.unshift(File.expand_path(File.join('..', 'lib')),
+                   File.dirname(__FILE__))
+require 'run_checker'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will
+# cause this file to always be loaded, without a need to explicitly r
+# equire it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually
+# need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # These two settings work together to allow you to limit a spec run
+  #   # to individual examples or groups you care about by tagging them with
+  #   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  #   # get run.
+  #   config.filter_run :focus
+  #   config.run_all_when_everything_filtered = true
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended.
+  #   # For more details, see:
+  #   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # 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
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same
+  #   # `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: run_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- byplayer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  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: The duplicated running checker to support batch process
+email:
+- byplayer100@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/run_checker.rb
+- lib/run_checker/run_checker.rb
+- lib/run_checker/version.rb
+- spec/run_checker/run_checker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/byplayer/run_checker
+licenses:
+- MIT license
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+- "--line-numbers"
+- "--inline-source"
+- "--main"
+- README.rdoc
+- "-c UTF-8"
+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: run_checker
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: The duplicated running checker
+test_files:
+- spec/run_checker/run_checker_spec.rb
+- spec/spec_helper.rb