guard-rails 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67204488cf9dc70a5f92d1f1cca1ff87b0936a2c
-  data.tar.gz: d3375c351092f169bc3a3a57e67f670ef91367e4
+  metadata.gz: badcb2d7fa378fb0f9fc7bc4a4922642f6d1b24b
+  data.tar.gz: 80d9c099b2b8b7824cf3bfa186f4dd1960f9e9d1
 SHA512:
-  metadata.gz: 965491b5a14754d3ca52255568edd514970979a3c08c5309a3c748c0c2fcd067c733a29396ef231b19159709e95f61878bb2be54b2cb81ccec4282cc3575b8af
-  data.tar.gz: 09845a32d24d05b0aa25905453489888d6bdab523bd90b0d76b6afc430004e7f1f411767a66d9de373a17c5d477cc5e7dec77e4da6b2567a5d1e75b8a5b35450
+  metadata.gz: 364a7e4234fa9efae4af2dcb8319dc2ea712db73d46e0b1492e4486c0b536f04979bb92cc8f2e0a8583bae0640f2a7ce67e64fc69ef36574037c04519a17bc34
+  data.tar.gz: 84c3dde82a373dd602a5aeead8a8f4f45debbcaf0ae5cbd404e0ea7b3aa13b5632642246856bed09d7ab9ca19a3ac5b178b517ef0bf1d86e57de8b191b2b1436

data/.gitignore

@@ -6,3 +6,5 @@
 .bundle/
 pkg/*
 tmp/
+coverage/
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    guard-rails (0.6.0)
+    guard-rails (0.6.1)
       guard (~> 2.0)
 
 GEM
@@ -9,16 +9,16 @@ GEM
   specs:
     celluloid (0.16.0)
       timers (~> 4.0.0)
-    codeclimate-test-reporter (0.4.0)
+    codeclimate-test-reporter (0.4.1)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    fakefs (0.5.3)
-    ffi (1.9.3)
-    ffi (1.9.3-java)
+    fakefs (0.6.0)
+    ffi (1.9.6)
+    ffi (1.9.6-java)
     formatador (0.2.5)
-    guard (2.6.1)
+    guard (2.7.0)
       formatador (>= 0.2.4)
       listen (~> 2.7)
       lumberjack (~> 1.0)
@@ -32,9 +32,9 @@ GEM
       rspec (>= 2.14, < 4.0)
     hitimes (1.2.2)
     hitimes (1.2.2-java)
-    libnotify (0.8.3)
+    libnotify (0.8.4)
       ffi (>= 1.0.11)
-    listen (2.7.9)
+    listen (2.7.11)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
@@ -59,23 +59,23 @@ GEM
       rspec-core (~> 3.1.0)
       rspec-expectations (~> 3.1.0)
       rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.2)
+    rspec-core (3.1.7)
       rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.0)
+    rspec-expectations (3.1.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.0)
+    rspec-mocks (3.1.3)
       rspec-support (~> 3.1.0)
-    rspec-support (3.1.0)
-    simplecov (0.9.0)
+    rspec-support (3.1.2)
+    simplecov (0.9.1)
       docile (~> 1.1.0)
-      multi_json
+      multi_json (~> 1.0)
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
     slop (3.6.0)
     spoon (0.0.4)
       ffi
-    terminal-notifier-guard (1.5.3)
+    terminal-notifier-guard (1.6.1)
     thor (0.19.1)
     timers (4.0.1)
       hitimes

data/README.md

@@ -75,6 +75,7 @@ And I will be there as your call.
 * Sidney Burks
 * Paul Schyska
 * Adam Michel
+* Cezary Baginski
 * Nathan Broadbent
 * Tim Preston
 * killphi

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.1

data/lib/guard/rails.rb

@@ -1,10 +1,11 @@
 require 'guard'
 require 'guard/plugin'
-require 'guard/rails/runner'
 require 'rbconfig'
 
 module Guard
   class Rails < Plugin
+    require 'guard/rails/runner'
+
     # Use gem `version` to support versioning
     # is_versioned
 
@@ -29,7 +30,7 @@ module Guard
       super
       @options = DEFAULT_OPTIONS.merge(options)
 
-      @runner = RailsRunner.new(@options)
+      @runner = Runner.new(@options)
     end
 
     def start

data/lib/guard/rails/runner.rb

@@ -1,173 +1,186 @@
 require 'fileutils'
 
 module Guard
-  class RailsRunner
-    MAX_WAIT_COUNT = 10
+  class Rails
+    class Runner
+      MAX_WAIT_COUNT = 10
 
-    attr_reader :options
+      attr_reader :options
 
-    def initialize(options)
-      @options = options
-      @root = options[:root] ? File.expand_path(options[:root]) : Dir.pwd
-    end
+      def initialize(options)
+        @options = options
+        @root = options[:root] ? File.expand_path(options[:root]) : Dir.pwd
+      end
 
-    def start
-      kill_unmanaged_pid! if options[:force_run]
-      run_rails_command!
-      wait_for_pid
-    end
+      def start
+        kill_unmanaged_pid! if options[:force_run]
+        run_rails_command!
+        wait_for_pid
+      end
 
-    def stop
-      if has_pid?
-        pid = File.read(pid_file).strip.to_i
-        sig_sent = kill_process("INT", pid)
-        wait_for_no_pid if sig_sent
+      def stop
+        return unless has_pid?
 
-        # If you lost your pid_file, you are already died.
-        kill_process("KILL", pid)
+        if (pid = read_pid)
+          sig_sent = kill_process("INT", pid)
+          wait_for_no_pid if sig_sent
+
+          # If you lost your pid_file, you are already died.
+          kill_process("KILL", pid)
+        end
         remove_pid_file_and_wait_for_no_pid
       end
-    end
 
-    def restart
-      stop
-      start
-    end
-
-    def build_command
-      command = build_cli_command if options[:CLI]
-      command ||= build_zeus_command if options[:zeus]
-      command ||= build_rails_command
-      "sh -c 'cd \"#{@root}\" && #{command} &'"
-    end
+      def restart
+        stop
+        start
+      end
 
-    def environment
-      rails_env = if options[:zeus]
-                    nil
-                  else
-                    options[:environment]
-                  end
+      def build_command
+        command = build_cli_command if options[:CLI]
+        command ||= build_zeus_command if options[:zeus]
+        command ||= build_rails_command
+        "sh -c 'cd \"#{@root}\" && #{command} &'"
+      end
 
-      { "RAILS_ENV" => rails_env }
-    end
+      def environment
+        rails_env = if options[:zeus]
+                      nil
+                    else
+                      options[:environment]
+                    end
 
-    def pid_file
-      File.expand_path(options[:pid_file] || File.join(@root, "tmp/pids/#{options[:environment]}.pid"))
-    end
+        { "RAILS_ENV" => rails_env }
+      end
 
-    def pid
-      has_pid? ? File.read(pid_file).to_i : nil
-    end
+      def pid_file
+        @pid_file ||= File.expand_path(options[:pid_file] || File.join(@root, "tmp/pids/#{options[:environment]}.pid"))
+      end
 
-    def sleep_time
-      options[:timeout].to_f / MAX_WAIT_COUNT.to_f
-    end
+      def pid
+        has_pid? ? read_pid : nil
+      end
 
-    private
+      def sleep_time
+        options[:timeout].to_f / MAX_WAIT_COUNT.to_f
+      end
 
-    # command builders
-    def build_options
-      rails_options = [
-        options[:daemon] ? '-d' : nil,
-        options[:debugger] ? '-u' : nil,
-        '-e', options[:environment],
-        '--pid', "\"#{pid_file}\"",
-        '-p', options[:port],
-        options[:server],
-      ]
+      private
 
-      rails_options.join(' ')
-    end
+      # command builders
+      def build_options
+        rails_options = [
+          options[:daemon] ? '-d' : nil,
+          options[:debugger] ? '-u' : nil,
+          '-e', options[:environment],
+          '--pid', "\"#{pid_file}\"",
+          '-p', options[:port],
+          options[:server],
+        ]
 
-    def build_cli_command
-      "#{options[:CLI]} --pid \"#{pid_file}\""
-    end
+        rails_options.join(' ')
+      end
 
-    def build_zeus_command
-      zeus_options = [
-        options[:zeus_plan] || 'server',
-      ]
-      "zeus #{zeus_options.join(' ')} #{build_options}"
-    end
+      def build_cli_command
+        "#{options[:CLI]} --pid \"#{pid_file}\""
+      end
 
-    def build_rails_command
-      "rails server #{build_options}"
-    end
+      def build_zeus_command
+        zeus_options = [
+          options[:zeus_plan] || 'server',
+        ]
+        "zeus #{zeus_options.join(' ')} #{build_options}"
+      end
 
-    def without_bundler_env
-      if defined?(::Bundler)
-        ::Bundler.with_clean_env { yield }
-      else
-        yield
+      def build_rails_command
+        "rails server #{build_options}"
       end
-    end
 
-    def run_rails_command!
-      if options[:CLI] || options[:zeus]
-        without_bundler_env { system(environment, build_command) }
-      else
-        system(environment, build_command)
+      def without_bundler_env
+        if defined?(::Bundler)
+          ::Bundler.with_clean_env { yield }
+        else
+          yield
+        end
       end
-    end
 
-    def has_pid?
-      File.file?(pid_file)
-    end
+      def run_rails_command!
+        if options[:CLI] || options[:zeus]
+          without_bundler_env { system(environment, build_command) }
+        else
+          system(environment, build_command)
+        end
+      end
 
-    def wait_for_pid_action
-      sleep sleep_time
-    end
+      def has_pid?
+        File.file?(pid_file)
+      end
 
-    def kill_unmanaged_pid!
-      if pid = unmanaged_pid
-        kill_process("KILL", pid)
-        remove_pid_file_and_wait_for_no_pid
+      def wait_for_pid_action
+        sleep sleep_time
       end
-    end
 
-    def unmanaged_pid
-      file_list = `lsof -n -i TCP:#{options[:port]}`
-      file_list.each_line { |line|
-        if line["*:#{options[:port]} "]
-          return line.split("\s")[1]
+      def kill_unmanaged_pid!
+        if pid = unmanaged_pid
+          kill_process("KILL", pid)
+          remove_pid_file_and_wait_for_no_pid
         end
-      }
-      nil
-    end
+      end
+
+      def unmanaged_pid
+        file_list = `lsof -n -i TCP:#{options[:port]}`
+        file_list.each_line { |line|
+          if line["*:#{options[:port]} "]
+            return line.split("\s")[1].to_i
+          end
+        }
+        nil
+      end
 
-    private
+      private
 
-    def wait_for_pid
-      wait_for_pid_loop { has_pid? }
-    end
+      def wait_for_pid
+        wait_for_pid_loop { has_pid? }
+      end
 
-    def wait_for_no_pid
-      wait_for_pid_loop { !has_pid? }
-    end
+      def wait_for_no_pid
+        wait_for_pid_loop { !has_pid? }
+      end
 
-    def remove_pid_file_and_wait_for_no_pid
-      wait_for_pid_loop do
-        FileUtils.rm pid_file, :force => true
-        !has_pid?
+      def remove_pid_file_and_wait_for_no_pid
+        wait_for_pid_loop do
+          FileUtils.rm pid_file, :force => true
+          !has_pid?
+        end
       end
-    end
 
-    def wait_for_pid_loop
-      count = 0
-      while !yield && count < MAX_WAIT_COUNT
-        wait_for_pid_action
-        count += 1
+      def wait_for_pid_loop
+        count = 0
+        while !yield && count < MAX_WAIT_COUNT
+          wait_for_pid_action
+          count += 1
+        end
+        !(count == MAX_WAIT_COUNT)
+      end
+
+      def kill_process(signal, pid)
+        begin
+          Process.kill(signal, pid)
+          true
+        rescue Errno::EPERM
+          UI.info "[Guard::Rails::Error] Don't have permission to KILL!"
+          false
+        rescue Errno::EINVAL, ArgumentError, Errno::ESRCH, RangeError
+          false
+        end
       end
-      !(count == MAX_WAIT_COUNT)
-    end
 
-    def kill_process(signal, pid)
-      begin
-        Process.kill(signal, pid)
-        true
-      rescue Errno::EINVAL, Errno::ESRCH, RangeError
-        false
+      def read_pid
+        Integer(File.read(pid_file))
+      rescue ArgumentError
+        nil
       end
+
     end
   end
 end

data/spec/lib/guard/rails/runner_spec.rb

@@ -1,9 +1,8 @@
 require 'spec_helper'
-require 'guard/rails/runner'
 require 'fakefs/spec_helpers'
 
-describe Guard::RailsRunner do
-  let(:runner) { Guard::RailsRunner.new(options) }
+describe Guard::Rails::Runner do
+  let(:runner) { Guard::Rails::Runner.new(options) }
   let(:environment) { 'development' }
   let(:port) { 3000 }
 
@@ -207,7 +206,7 @@ describe Guard::RailsRunner do
       end
     end
 
-    context 'when guard-rails is outside of bundler' do
+    context 'when guard-rails is inside of bundler' do
       before do
         ENV['BUNDLE_GEMFILE'] = 'Gemfile'
       end
@@ -231,6 +230,12 @@ describe Guard::RailsRunner do
     context 'when guard-rails is outside of bundler' do
       before do
         ENV['BUNDLE_GEMFILE'] = nil
+        BundlerClass = Bundler
+        Object.send(:remove_const, :Bundler)
+      end
+      after do
+        Bundler = BundlerClass
+        Object.send(:remove_const, :BundlerClass)
       end
 
       context 'with default env' do
@@ -288,7 +293,7 @@ describe Guard::RailsRunner do
       before do
         pid_stub.returns(false)
         kill_expectation.never
-        mock(runner).wait_for_pid_action.times(Guard::RailsRunner::MAX_WAIT_COUNT)
+        mock(runner).wait_for_pid_action.times(Guard::Rails::Runner::MAX_WAIT_COUNT)
       end
 
       it "doesn't start" do
@@ -297,12 +302,132 @@ describe Guard::RailsRunner do
     end
   end
 
+  describe '#stop' do
+    include FakeFS::SpecHelpers
+
+    it 'stops' do
+      expect(runner.stop)
+    end
+
+    context 'when pid exists' do
+      let(:pid) { 12345 }
+
+      before do
+        FileUtils.mkdir_p File.split(runner.pid_file).first
+        File.open(runner.pid_file, 'w') { |f| f.print pid }
+      end
+
+      it 'removes the pid file' do
+        runner.stop
+        expect(File.exists?(runner.pid_file)).to be false
+      end
+
+      it 'kills the process with INT' do
+        mock(runner).kill_process.with("INT", pid).returns { true }
+        mock(runner).kill_process.with("KILL", pid).once
+        runner.stop
+      end
+
+      it 'kills the process with KILL when INT not work' do
+        mock(runner).kill_process.with("INT", pid).returns { false }
+        mock(runner).kill_process.with("KILL", pid).once
+        runner.stop
+      end
+    end
+
+    context "when pid file doesn't exist" do
+      it 'does nothing' do
+        runner.stop
+        mock(runner).kill_process.never
+      end
+    end
+
+    context "when pid file is empty" do
+      before do
+        FileUtils.mkdir_p File.split(runner.pid_file).first
+        File.open(runner.pid_file, 'w') { |f| f.print "" }
+      end
+
+      it 'does nothing' do
+        mock(runner).kill_process.never
+        runner.stop
+      end
+
+      it 'removes the pid file' do
+        runner.stop
+        expect(File.exists?(runner.pid_file)).to be false
+      end
+
+    end
+  end
+
+  describe '#restart' do
+    it 'calls stop and start' do
+      mock(runner).stop.once
+      mock(runner).start.once
+      runner.restart
+    end
+  end
+
+  describe '#kill_unmanaged_pid!' do
+    let(:pid) { 12345 }
+
+    it 'kill processes if any' do
+      mock(runner).unmanaged_pid.returns { pid }
+      mock(runner).kill_process.with("KILL", pid).once
+      runner.send(:kill_unmanaged_pid!)
+    end
+
+    it 'does nothing if none' do
+      mock(runner).unmanaged_pid.returns { nil }
+      mock(runner).kill_process.with("KILL", pid).never
+      runner.send(:kill_unmanaged_pid!)
+    end
+  end
+
+  describe '#unmanaged_pid' do
+    let(:pid) { 12345 }
+
+    it 'returns pid if any' do
+      mock(runner, :'`').with(anything).returns {
+        "ruby #{pid} ranmocy 12u IPv4 0x9c30720e04d31a0f 0t0 TCP *:#{port} (LISTEN)"
+      }
+      expect(runner.send(:unmanaged_pid)).to eq pid
+    end
+
+    it 'returns nil if none' do
+      mock(runner, :'`').with(anything).returns { "\n" }
+      expect(runner.send(:unmanaged_pid)).to be nil
+    end
+  end
+
+  describe '#kill_process' do
+    let(:signal) { 'INT' }
+    let(:fake_signal) { 'INT0' }
+    let(:pid) { 12345 }
+
+    it 'returns true if killed' do
+      mock(Process).kill(signal, pid) { 0 }
+      expect(runner.send(:kill_process, signal, pid)).to be true
+    end
+
+    it 'returns false if signal is wrong' do
+      expect(runner.send(:kill_process, fake_signal, pid)).to be false
+    end
+
+    it 'returns false if no permission to kill' do
+      mock(Process).kill(signal, pid) { raise Errno::EPERM }
+      mock(Guard::UI).info("[Guard::Rails::Error] Don't have permission to KILL!")
+      expect(runner.send(:kill_process, signal, pid)).to be false
+    end
+  end
+
   describe '#sleep_time' do
     let(:timeout) { 30 }
     let(:options) { default_options.merge(:timeout => timeout) }
 
     it "adjusts the sleep time as necessary" do
-      expect(runner.sleep_time).to eq (timeout.to_f / Guard::RailsRunner::MAX_WAIT_COUNT.to_f)
+      expect(runner.sleep_time).to eq (timeout.to_f / Guard::Rails::Runner::MAX_WAIT_COUNT.to_f)
     end
   end
 end

data/spec/lib/guard/rails_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'guard/rails'
 
 describe Guard::Rails do
   let(:guard) { Guard::Rails.new(options) }
@@ -39,14 +38,14 @@ describe Guard::Rails do
     let(:pid) { '12345' }
 
     before do
-      any_instance_of(Guard::RailsRunner, pid: pid)
+      any_instance_of(Guard::Rails::Runner, pid: pid)
     end
 
     context 'at start' do
       before do
         mock(Guard::UI).info.with('Starting Rails...')
         mock(Guard::Notifier).notify.with(/Rails starting/, hash_including(:image => :pending))
-        any_instance_of(Guard::RailsRunner, restart: true)
+        any_instance_of(Guard::Rails::Runner, restart: true)
       end
 
       it "starts and shows the pid file" do
@@ -59,14 +58,14 @@ describe Guard::Rails do
 
     context "after start" do
       before do
-        any_instance_of(Guard::RailsRunner, pid: pid)
+        any_instance_of(Guard::Rails::Runner, pid: pid)
         mock(Guard::UI).info.with('Restarting Rails...')
         mock(Guard::Notifier).notify.with(/Rails restarting/, hash_including(:image => :pending))
       end
 
       context "with pid file" do
         before do
-          any_instance_of(Guard::RailsRunner, restart: true)
+          any_instance_of(Guard::Rails::Runner, restart: true)
         end
 
         it "restarts and shows the pid file" do
@@ -79,7 +78,7 @@ describe Guard::Rails do
 
       context "without pid file" do
         before do
-          any_instance_of(Guard::RailsRunner, restart: false)
+          any_instance_of(Guard::Rails::Runner, restart: false)
         end
 
         it "restarts and shows the pid file" do

data/spec/spec_helper.rb

@@ -1,5 +1,12 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
+if ENV['CI']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+else
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'guard/rails'
 
 RSpec.configure do |c|
   c.mock_with :rr

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - John Bintz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-14 00:00:00.000000000 Z
+date: 2014-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard