foreground 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,13 @@
+guard 'rspec', :version => 2, :cli => '--color' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})           { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')        { "spec" }
+end
+
+guard 'cucumber' do
+  watch(%r{^bin/.+$})                 { 'features' }
+  watch(%r{^lib/.+$})                 { 'features' }
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})    { 'features' }
+  watch(%r{^features/steps/.+$})       { 'features' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Björn Albers
+
+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,48 @@
+# foreground
+
+Control daemonizing background processes with launchd.
+
+## Introduction
+
+Some processes do unspeakable things, which makes it hard for launchd to
+control them:
+
+> A daemon or agent launched by launchd MUST NOT do the following in the process directly launched by launchd:
+>
+>   * Call daemon(3).
+>   * Do the moral equivalent of daemon(3) by calling fork(2) and have the parent process exit(3) or _exit(2).
+>
+> -- [launchd.plist(5)](https://developer.apple.com/library/mac/#documentation/darwin/reference/manpages/man5/launchd.plist.5.html)
+
+This tiny wrapper makes sure, that those processes are properly started
+or stopped on behalf of launchd by mirroring the job's running state.
+
+## Installation
+
+Install it via RubyGems:
+
+    $ gem install foreground
+
+## Usage
+
+Wrap your daemon command inside your launchd.plist:
+
+    foreground --pid_file /tmp/foreground_sample_daemon.pid foreground_sample_daemon
+
+## Limitations
+
+You can't control the daemons stdout, stderr, etc. this way, because the daemon will probably manage this stuff itself.
+
+## Contributing
+
+1. Fork it and `script/bootstrap` your environment (Note: This also
+   performs a hard git reset to restore `bin/foreground_sample_daemon`,
+   which gets overwritten by bundler!)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2012 Björn Albers (MIT License)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty"
+end
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w[--color]
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+task :default => :features

data/features/sample_daemon.feature

@@ -0,0 +1,19 @@
+Feature: Sample daemon
+
+  In order to test foreground properly
+  As an BDD guy
+  I want a sample daemon along with cucumber steps
+
+  Scenario: Run sample daemon
+    When I successfully run `foreground_sample_daemon`
+    Then the sample daemon should run
+    And a file named "/tmp/foreground_sample_daemon.pid" should exist
+
+  Scenario: Run only one sample daemon at once
+    When I successfully run `foreground_sample_daemon`
+    And I successfully run `foreground_sample_daemon`
+    Then the sample daemon should run
+
+  Scenario: Don't mess up the system with running sample daemons
+    Then the sample daemon should not run
+    And a file named "/tmp/foreground_sample_daemon.pid" should not exist

data/features/start_stop.feature

@@ -0,0 +1,12 @@
+Feature: Start and stop
+
+  In order to start and stop a background daemon
+  As a funky user
+  I want foreground to start and stop that background daemon
+
+  Scenario: Start and stop sample daemon
+    When I run the sample daemon via foreground
+    Then the sample daemon should run
+
+    When I kill foreground
+    Then the sample daemon should not run

data/features/steps/sample_daemon_steps.rb

@@ -0,0 +1,44 @@
+def sample_daemons
+  proclist = `/bin/ps -A -o pid,command`
+  proclist.to_a.grep(%r{^\s*\d+\s+ruby\s+.*foreground_sample_daemon$}) { |l| l[/^\s*(\d+)\s+/,1].to_i }
+end
+
+def kill_foreground
+  if @foreground
+    Process.kill(:TERM, @foreground) unless Process.waitpid(@foreground, Process::WNOHANG)
+  end
+end
+
+After do
+  kill_foreground
+  sample_daemons.each { |pid| system("kill #{pid}") }
+end
+
+When /^I run the sample daemon via foreground$/ do
+  @foreground = fork do
+    exec('foreground --pid_file /tmp/foreground_sample_daemon.pid foreground_sample_daemon')
+  end
+end
+
+When /^I kill foreground$/ do
+  kill_foreground
+end
+
+Then /^the sample daemon should run$/ do
+  steps %q{
+    Then 1 sample daemon should run
+  }
+end
+
+Then /^the sample daemon should not run$/ do
+  steps %q{
+    Then 0 sample daemon should run
+  }
+end
+
+Then /^(\d+) sample daemons? should run$/ do |expected|
+  expected = expected.to_i
+  actual = sample_daemons.count
+  actual.should eql(expected),
+    "Expected #{expected} running sample daemon, but got #{actual} instead!"
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'aruba/cucumber'
+
+Before do
+  @aruba_timeout_seconds = 10
+end

data/foreground.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foreground/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'foreground'
+  gem.version       = Foreground::VERSION
+  gem.authors       = ["Bjo\314\210rn Albers"]
+  gem.email         = ['bjoernalbers@googlemail.com']
+  gem.description   = 'Control daemonizing background processes with launchd.'
+  gem.summary       = "#{gem.name}-#{gem.version}"
+  gem.homepage      = 'https://github.com/bjoernalbers/foreground'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/foreground}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'mixlib-cli', '~> 1.2.2'
+
+  gem.add_development_dependency 'aruba', '>= 0.4.11'
+  gem.add_development_dependency 'aruba-doubles', '~> 1.2.1'
+  gem.add_development_dependency 'guard-cucumber', '>= 0.7.5'
+  gem.add_development_dependency 'guard-rspec', '>= 0.5.1'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rb-fsevent', '>= 0.9.0' if RUBY_PLATFORM =~ /darwin/i 
+end

data/lib/foreground.rb

@@ -0,0 +1,8 @@
+require 'shellwords'
+require 'mixlib/cli'
+require 'foreground/version'
+require 'foreground/cli'
+
+module Foreground
+  # Your code goes here... or not.
+end

data/lib/foreground/cli.rb

@@ -0,0 +1,41 @@
+module Foreground
+  class CLI
+    include Mixlib::CLI
+
+    option :pid_file,
+      :short => '-p FILE',
+      :long  => '--pid_file FILE',
+      :description => 'PID file for the daemon',
+      :required => true
+
+    class << self
+      def run(argv=ARGV)
+        new.run(argv)
+      end
+    end
+
+    def run(argv)
+      cmd = parse_options(argv)
+      system(cmd.shelljoin)
+      watch
+    end
+
+    def watch
+      ### <proof_of_concept>
+      #TODO: Unhackify this block of code!
+      STDOUT.sync = true
+      puts "hi, there!"
+      trap(:TERM) do
+        sleep 3 # Give the daemon time to write its PID file.
+        if File.exists?(config[:pid_file])
+          pid = File.read(config[:pid_file]).chomp.to_i
+          Process.kill(:TERM, pid)
+        end
+      end
+      ### </proof_of_concept>
+
+      #TODO: Implement watch feature!
+      loop { sleep 1 }
+    end
+  end
+end

data/lib/foreground/version.rb

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

data/script/bootstrap

@@ -0,0 +1,2 @@
+#!/bin/sh
+sudo gem install bundler && bundle install --path vendor --binstubs && git reset --hard HEAD

data/spec/foreground/cli_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Foreground
+  describe CLI do
+    before do
+      CLI.stub(:system)
+      @argv = ['--pid_file', '/tmp/foreground_sample_daemon.pid', 'foreground_sample_daemon']
+      @cli = CLI.new
+      @cli.stub(:watch) # ...or we'll wait forever.
+    end
+
+    describe '.run' do
+      it 'should run a new instance' do
+        cli = mock('cli')
+        cli.should_receive(:run).with(@argv)
+        CLI.should_receive(:new).and_return(cli)
+        CLI.run(@argv)
+      end
+    end
+
+    describe '#run' do
+      it 'should parse argv' do
+        @cli.should_receive(:parse_options).with(@argv).and_return(@argv)
+        @cli.run(@argv)
+      end
+
+      it 'should run the daemon' do
+        @cli.should_receive(:system).with('foreground_sample_daemon')
+        @cli.run(@argv)
+      end
+
+      it 'should watch the daemon' do
+        @cli.should_receive(:watch)
+        @cli.run(@argv)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'foreground'

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: foreground
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Björn Albers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.11
+- !ruby/object:Gem::Dependency
+  name: aruba-doubles
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Control daemonizing background processes with launchd.
+email:
+- bjoernalbers@googlemail.com
+executables:
+- foreground_sample_daemon
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/foreground_sample_daemon
+- features/sample_daemon.feature
+- features/start_stop.feature
+- features/steps/sample_daemon_steps.rb
+- features/support/env.rb
+- foreground.gemspec
+- lib/foreground.rb
+- lib/foreground/cli.rb
+- lib/foreground/version.rb
+- script/bootstrap
+- spec/foreground/cli_spec.rb
+- spec/foreground/daemon_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bjoernalbers/foreground
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3670891717628661240
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3670891717628661240
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: foreground-0.0.1
+test_files:
+- features/sample_daemon.feature
+- features/start_stop.feature
+- features/steps/sample_daemon_steps.rb
+- features/support/env.rb
+- spec/foreground/cli_spec.rb
+- spec/foreground/daemon_spec.rb
+- spec/spec_helper.rb