guard-puma 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e00ac65e68f7b4921cfa5a02bc117182de5c0d9
-  data.tar.gz: ad040e3870595a66d6aae79cace22b5a59d6ef4f
+  metadata.gz: ba3c0c0435df8f3c4ebc9383ae9afbd92bd2f41d
+  data.tar.gz: c89ab9b1313f04b420a8ac8be2dc6a2b685f9440
 SHA512:
-  metadata.gz: 493b03f73a243ceb4c4a8a6542d80f8e7c5be67a94b83383e80bf064f136918ddb0c37500d1eccb5cfa61a897e9432f876ef28acb87c436c733f5bd8751a2ad4
-  data.tar.gz: 3ec94f2e799ed2a9a8148289a13673118a97c5b62d85e6d7d655b0db0f5dae85f77a2f79011244d68cec92d36df011a3b2765d857f91ebca851833179da50839
+  metadata.gz: f3bf2e82c1da9bdfc4ae1d78244455642b5a07f242f0af7f4998b121492214b5322d5094b9f21b538575d04d2599a93c813055d7a07e614e98f07bce176aa60a
+  data.tar.gz: 073f9b90a53e4aed7fd27c282d63b50ff82f54e57fec7d6579a5446d24dd539648630d0a66f99bc16f88f47ad61f27ec6c35c9a96f431bc676b00aaa8e2ec9f9

data/CHANGES.md

@@ -1,5 +1,9 @@
 # Changes
 
+## 0.4.1
+
+* Improve notifications. Via #30
+
 ## 0.4.0
 
 * Support Windows with custom start command. Via #29

data/README.md

@@ -44,6 +44,7 @@ end
 * `:control_token` is the token to use as authentication for the control server(optional)
 * `:control_port` is the port to use for the control server(optional)
 * `:threads` is the min:max number of threads to use. Defaults to 0:16 (optional)
+* `:notifications` is the list of notification types that will be sent. Defaults to `[:restarting, :restarted, :not_restarted, :stopped]` (optional)
 
 ## Contributing
 

data/lib/guard/puma.rb

@@ -19,40 +19,56 @@ module Guard
       :start_on_start => true,
       :force_run => false,
       :timeout => 20,
-      :debugger => false
+      :debugger => false,
+      :notifications => %i[restarting restarted not_restarted stopped]
     }
 
     def initialize(options = {})
       super
       @options = DEFAULT_OPTIONS.merge(options)
+      @options[:port] = nil if @options.key?(:config)
       @runner = ::Guard::PumaRunner.new(@options)
     end
 
     def start
       server = options[:server] ? "#{options[:server]} and " : ""
-      UI.info "Guard::Puma will now start your app on port #{options[:port]} using #{server}#{options[:environment]} environment."
+      UI.info "Puma starting#{port_text} in #{server}#{options[:environment]} environment."
       runner.start if options[:start_on_start]
     end
 
     def reload
       UI.info "Restarting Puma..."
-      Notifier.notify("Puma restarting on port #{options[:port]} in #{options[:environment]} environment...", :title => "Restarting Puma...", :image => :pending)
+      if options[:notifications].include?(:restarting)
+        Notifier.notify("Puma restarting#{port_text} in #{options[:environment]} environment...", :title => "Restarting Puma...", :image => :pending)
+      end
       if runner.restart
         UI.info "Puma restarted"
-        Notifier.notify("Puma restarted on port #{options[:port]}.", :title => "Puma restarted!", :image => :success)
+        if options[:notifications].include?(:restarted)
+          Notifier.notify("Puma restarted#{port_text}.", :title => "Puma restarted!", :image => :success)
+        end
       else
         UI.info "Puma NOT restarted, check your log files."
-        Notifier.notify("Puma NOT restarted, check your log files.", :title => "Puma NOT restarted!", :image => :failed)
+        if options[:notifications].include?(:not_restarted)
+          Notifier.notify("Puma NOT restarted, check your log files.", :title => "Puma NOT restarted!", :image => :failed)
+        end
       end
     end
 
     def stop
-      Notifier.notify("Until next time...", :title => "Puma shutting down.", :image => :pending)
+      if options[:notifications].include?(:stopped)
+        Notifier.notify("Until next time...", :title => "Puma shutting down.", :image => :pending)
+      end
       runner.halt
     end
 
-    def run_on_change(paths)
+    def run_on_changes(paths)
       reload
     end
+
+    private
+
+    def port_text
+      " on port #{options[:port]}" if options[:port]
+    end
   end
 end

data/lib/guard/puma/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module PumaVersion
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

data/spec/lib/guard/puma_spec.rb

@@ -12,6 +12,18 @@ describe Guard::Puma do
 
       expect(guard.runner.options[:port]).to eq(4000)
     end
+
+    context "when config is set" do
+      let(:options) { { :config => 'config.rb' } }
+
+      it "initializes with config option" do
+        expect(guard.runner.options[:config]).to eq('config.rb')
+      end
+
+      it "initializes without port option" do
+        expect(guard.runner.options[:port]).to be_nil
+      end
+    end
   end
 
   describe "#default_env" do
@@ -61,40 +73,121 @@ describe Guard::Puma do
         guard.start
       end
     end
+
+    describe "UI message" do
+      before do
+        allow(guard.runner).to receive(:start)
+      end
+
+      context "when no config option set" do
+        it "contains port" do
+          expect(Guard::UI).to receive(:info).with(/starting on port 4000/)
+          guard.start
+        end
+      end
+
+      context "when config option set" do
+        let(:options) { { :config => 'config.rb' } }
+
+        it "doesn't contain port" do
+          expect(Guard::UI).to receive(:info).with(/starting/)
+          guard.start
+        end
+      end
+    end
   end
 
   describe '#reload' do
 
     before do
       expect(Guard::UI).to receive(:info).with('Restarting Puma...')
-      expect(Guard::Notifier).to receive(:notify).with(/Puma restarting/, hash_including(:image => :pending))
+      expect(Guard::UI).to receive(:info).with('Puma restarted')
       allow(guard.runner).to receive(:restart).and_return(true)
     end
 
     let(:runner_stub) { allow_any_instance_of(Guard::PumaRunner).to receive(:halt) }
 
-    it "restarts and show the message" do
-      expect(Guard::UI).to receive(:info)
-      expect(Guard::Notifier).to receive(:notify).with(/Puma restarted/, hash_including(:image => :success))
+    context "with default options" do
+      it "restarts and show the message" do
+        expect(Guard::Notifier).to receive(:notify).with(
+          /restarting on port 4000/,
+          hash_including(:title => "Restarting Puma...", :image => :pending)
+        )
 
-      guard.reload
+        expect(Guard::Notifier).to receive(:notify).with(
+          "Puma restarted on port 4000.",
+          hash_including(:title => "Puma restarted!", :image => :success)
+        )
+
+        guard.reload
+      end
+    end
+
+    context "with config option set" do
+      let(:options) { { :config => "config.rb" } }
+
+      it "restarts and show the message" do
+        expect(Guard::Notifier).to receive(:notify).with(
+          /restarting/,
+          hash_including(:title => "Restarting Puma...", :image => :pending)
+        )
+
+        expect(Guard::Notifier).to receive(:notify).with(
+          "Puma restarted.",
+          hash_including(:title => "Puma restarted!", :image => :success)
+        )
+
+        guard.reload
+      end
+    end
+
+    context "with custom :notifications option" do
+      let(:options) { { :notifications => [:restarted] } }
+
+      it "restarts and show the message only about restarted" do
+        expect(Guard::Notifier).not_to receive(:notify).with(/restarting/)
+        expect(Guard::Notifier).to receive(:notify).with(/restarted/, kind_of(Hash))
+
+        guard.reload
+      end
+    end
+
+    context "with empty :notifications option" do
+      let(:options) { { :notifications => [] } }
+
+      it "restarts and doesn't show the message" do
+        expect(Guard::Notifier).not_to receive(:notify)
+
+        guard.reload
+      end
     end
 
   end
 
   describe '#stop' do
-    it "stops correctly" do
-      expect(Guard::Notifier).to receive(:notify).with('Until next time...', anything)
-      expect(guard.runner).to receive(:halt).once
-      guard.stop
+    context "with default options" do
+      it "stops correctly with notification" do
+        expect(Guard::Notifier).to receive(:notify).with('Until next time...', anything)
+        expect(guard.runner).to receive(:halt).once
+        guard.stop
+      end
+    end
+
+    context "with custom :notifications option" do
+      let(:options) { { :notifications => [] } }
+
+      it "stops correctly without notification" do
+        expect(Guard::Notifier).not_to receive(:notify)
+        expect(guard.runner).to receive(:halt).once
+        guard.stop
+      end
     end
   end
 
-  describe '#run_on_change' do
+  describe '#run_on_changes' do
     it "reloads on change" do
       expect(guard).to receive(:reload).once
-      guard.run_on_change([])
+      guard.run_on_changes([])
     end
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-puma
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jesse Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2018-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard