guard-foreman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8122ce0888dccef83983172378b2ec71791c0157
+  data.tar.gz: 23c67c7a07b7d2d13a3d2c100102ccb781edd0b0
+SHA512:
+  metadata.gz: f6fb2293540ace3c8b172def3f010c16926187b63a479319b22aeeb6c730015a3bea2514169b67a662c5c3d71bdcb063873972aafa33c731cf245d216d2dd702
+  data.tar.gz: 4634fcfe87ec1aafb88d00ac988f167426ec6450a7cac28673a9fbe7226f535bfdbc738fb0b6553e6eadb59e9de889338bc1fb0f70eae4601feaa7379a39dafa

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage/*
+.ruby-version
+*.swp

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Dependencies
+gemspec
+
+gem 'rake'
+gem 'minitest'
+#gem 'coveralls', require: false
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Jonathan Arnett
+
+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,77 @@
+# Guard::Foreman
+
+`Guard::Foreman` automatically restarts Foreman using [Guard] [gu].
+
+[gu]: https://github.com/guard/guard
+
+
+## Installation
+
+**NOTE**: Guard::Foreman is not yet finished! In fact, it's hardly begun. I'll
+update here when I have finished it.
+
+<!--Using Rubygems:-->
+
+<!-- $ gem install guard-foreman -->
+
+<!--Using Bundler, add this to your `Gemfile`, preferably in the `development` group:-->
+
+```ruby
+group :development
+  gem 'guard-foreman'
+end
+```
+
+Add a sample Guard definition to your `Guardfile`:
+
+    $ guard init foreman
+
+
+## Guard General Usage
+
+Please read the [guard usage doc] [gd] in order to find out more about Guard and
+how to use Guards. There is also [a Railscast about Guard] [gc], created by Ryan
+Bates.
+
+
+[gd]: https://github.com/guard/guard/blob/master/README.md
+[gc]: http://railscasts.com/episodes/264-guard
+
+It is recommended that you also install the [ruby-gntp] [gntp] on Mac OS X,
+[libnotify] [ln] on Linux, FreeBSD or Solaris or [rb-notifu] [notifu] in order
+to have graphical notifications.
+
+[gntp]: https://rubygems.org/gems/ruby_gntp
+[ln]: https://rubygems.org/gems/libnotify
+[notifu]: https://rubygems.org/gems/rb-notifu
+
+
+## Guardfile for guard-foreman
+
+```ruby
+guard :foreman, profile: 'Profile.dev'
+```
+
+Available options (Note: mostly stolen directly from the [Foreman documentation]
+ [fd]):
+
+[fd]: http://ddollar.github.io/foreman/
+
+* `:log_file` Specify a location to pipe the Foreman logs into. Defaults to
+  `log/foreman.log`
+* `:concurrency` Specify the number of each process to run. This should be
+  passed in the format `process=num,process=num`
+* `:env` Specify one or more .env files to load
+* `:procfile` Specify an alternate Procfile to load
+* `:port` Specify which port to use as the base for this application. Should be
+  a multiple of 1000.
+* `:root` Specify an alternate application root. This defaults to the directory
+  containing the Procfile.
+
+NOTE: The parent project of Guard::Foreman, [Guard::Unicorn] [gdu], has a
+`:bundler` option available for using `bundle exec`. I have removed this bit of
+functionality as the [Foreman Github page] [fgp] asks users to *not* put
+Foreman in their Gemfiles.
+
+[gdu]: https://github.com/andreimaxim/guard-unicorn
+[fgp]: https://github.com/ddollar/foreman

data/guard-foreman.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "guard-foreman"
+  s.version     = "0.0.1"
+  s.authors     = ["Andrei Maxim", "Jonathan Arnett"]
+  s.licenses    = ['MIT']
+  s.email       = ["jonarnett90@gmail.com"]
+  s.homepage    = "https://github.com/J3RN/guard-foreman"
+  s.summary     = "Guard for Foreman"
+  s.description = "Guard plug-in that allows you to restart Foreman"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'guard', '~> 2.6'
+end

data/lib/guard/foreman.rb

@@ -0,0 +1,105 @@
+require 'guard'
+require 'guard/plugin'
+
+module Guard
+  class Foreman < Plugin
+
+    # Default log location (Rails in mind)
+    DEFAULT_LOG_LOCATION = "log/foreman.log"
+
+    # Initialize a Guard.
+    # @param [Array<Guard::Watcher>] watchers the Guard file watchers
+    # @param [Hash] options the custom Guard options
+    def initialize(options = {})
+      @log_file       = options.fetch(:log_file, DEFAULT_LOG_LOCATION)
+      @concurrency    = options[:concurrency]
+      @env            = options[:env]
+      @procfile       = options[:procfile]
+      @port           = options[:port]
+      @root           = options[:root]
+
+      super
+    end
+
+    # Call once when Guard starts. Please override initialize method to init stuff.
+    # @raise [:task_has_failed] when start has failed
+    def start
+      # Stop if running
+      stop if @pid
+
+      cmd = []
+      cmd << "foreman start"
+      cmd << "-c #{@concurrency}" if @concurrency
+      cmd << "-e #{@env}"         if @env
+      cmd << "-f #{@procfile}"    if @procfile
+      cmd << "-p #{@port}"        if @port
+      cmd << "-d #{@root}"        if @root
+      cmd << "> #{@log_file}"
+
+
+      @pid = ::Process.fork do
+        system "#{cmd.join " "}"
+      end
+
+     info "Foreman started."
+    end
+
+    # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
+    # @raise [:task_has_failed] when stop has failed
+    def stop
+      begin
+        ::Process.kill("QUIT", @pid) if ::Process.getpgid(@pid)
+
+        # foreman won't always shut down right away, so we're waiting for
+        # the getpgid method to raise an Errno::ESRCH that will tell us
+        # the process is not longer active.
+        sleep 1 while ::Process.getpgid(@pid)
+        info "Foreman stopped."
+      rescue Errno::ESRCH
+        # Don't do anything, the process does not exist
+      end
+    end
+
+    # Called when `reload|r|z + enter` is pressed.
+    # This method should be mainly used for "reload" (really!) actions like
+    # reloading passenger/spork/bundler/...
+    # @raise [:task_has_failed] when reload has failed
+    def reload
+      UI.info "Restarting Foreman..."
+      stop
+      start
+    end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all specs/tests/...
+    # @raise [:task_has_failed] when run_all has failed
+    def run_all
+      start
+    end
+
+    # Called on file(s) modifications that the Guard watches.
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    def run_on_changes(paths)
+      reload
+    end
+
+    def run_on_additions(paths)
+      reload
+    end
+
+    def run_on_modifications(paths)
+      reload
+    end
+
+    def run_on_removals(paths)
+      reload
+    end
+
+    private
+
+    def info(msg)
+      UI.info(msg)
+    end
+  end
+end

data/lib/guard/foreman/templates/Guardfile

@@ -0,0 +1,15 @@
+# Usage:
+#     guard :foreman, <options hash>
+#
+# Possible options:
+# * :concurreny - how many of each type of process you would like to run (default is, sensibly, one of each)
+# * :env - one or more .env files to load
+# * :procfile - an alternate Procfile to use (default is Procfile)
+# * :port - an alternate port to use (default is 5000)
+# * :root - an alternate application root
+guard :foreman, procfile: 'Procfile.dev' do
+  # Rails example - Watch controllers, models, helpers, lib, and config files
+  watch( /^app\/(controllers|models|helpers)\/.+\.rb$/ )
+  watch( /^lib\/.+\.rb$/ )
+  watch( /^config\/*/ )
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'minitest/autorun'
+#require 'coveralls'
+#Coveralls.wear!
+
+require 'guard/foreman'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: guard-foreman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrei Maxim
+- Jonathan Arnett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Guard plug-in that allows you to restart Foreman
+email:
+- jonarnett90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- guard-foreman.gemspec
+- lib/guard/foreman.rb
+- lib/guard/foreman/templates/Guardfile
+- test/test_helper.rb
+homepage: https://github.com/J3RN/guard-foreman
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Guard for Foreman
+test_files:
+- test/test_helper.rb
+has_rdoc: