guard-compat 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a717c9cc74638fef19735c7029e547853fd957d0
-  data.tar.gz: 4e2f952d70ce108ec8cf2b473f98499690a45285
+  metadata.gz: dac5757ac72c5138cbe1e418d03c0940369134f9
+  data.tar.gz: 742bdf3df8a9dad0ff0ba6e625aa2357b0a000c8
 SHA512:
-  metadata.gz: 857bca959b9ffd37e30537cea11574dfb3d6c4a402f59375e435da8548ac43e9d22e1276e7c0aee5217634606906441807389d5b1548942e2b8c2eb7af782037
-  data.tar.gz: db48127d844b15360e34e787226e70b3cf4bac4f89a688373c3a38b4c184ad0a2bf6fa26de465530b453c72212bc974541213d4c72f356fbface2f8aaa363035
+  metadata.gz: e25d27e907b888ee18a59d227b96ad7f5a728fcaf0370e995b8567d101171a0946e038093cc5c918198be3f8e2e16912b10cb5c79cc5e3dd876943057ceecfdc
+  data.tar.gz: d2082d551d671421e7f30e60017f86e6f9d842263b7bbc65731109dece82d101ca5e8fbed56753f669a06be3cc313aaf714e22347a07a05ec9c6c055ed23004a

data/README.md

@@ -40,6 +40,10 @@ require 'guard/myplugin'
 
 # And your tests instantiating your plugin go here...
 ```
+
+(OPTIONAL: if your plugin consists of many files, you may prefer to add the two above requires to your `spec/spec_helper.rb` or test setup files)
+
+
 ## Example
 
 See [lib/guard/compat/example.rb](https://github.com/guard/guard-compat/blob/master/lib/guard/compat/example.rb ) for an example plugin implementation.

data/lib/guard/compat/example.rb

@@ -4,25 +4,30 @@
 module Guard
   class MyPlugin < Plugin
     def start
-      Guard::Notifier.notify('foo')
+      Guard::Compat::UI.notify('foo')
+      Guard::Compat::UI.color('foo')
 
-      Guard::UI.info('foo')
-      Guard::UI.warning('foo')
-      Guard::UI.error('foo')
-      Guard::UI.debug('foo')
-      Guard::UI.deprecation('foo')
+      Guard::Compat::UI.info('foo')
+      Guard::Compat::UI.warning('foo')
+      Guard::Compat::UI.error('foo')
+      Guard::Compat::UI.debug('foo')
+      Guard::Compat::UI.deprecation('foo')
     end
 
     def run_all
-      Guard::Notifier.notify('foo', title: 'bar')
+      Guard::Compat::UI.notify('foo', bar: :baz)
+      Guard::Compat::UI.color('foo', :white)
 
-      Guard::UI.info('foo', bar: :baz)
-      Guard::UI.warning('foo', bar: :baz)
-      Guard::UI.error('foo', bar: :baz)
-      Guard::UI.debug('foo', bar: :baz)
-      Guard::UI.deprecation('foo', bar: :baz)
+      Guard::Compat::UI.info('foo', bar: :baz)
+      Guard::Compat::UI.warning('foo', bar: :baz)
+      Guard::Compat::UI.error('foo', bar: :baz)
+      Guard::Compat::UI.debug('foo', bar: :baz)
+      Guard::Compat::UI.deprecation('foo', bar: :baz)
+    end
 
-      Guard::UI.color_enabled?
+    def run_on_modifications
+      Guard::Compat::UI.color_enabled?
+      Guard::Compat.matching_files(self, ['foo'])
     end
   end
 end

data/lib/guard/compat/plugin.rb

@@ -11,8 +11,60 @@ unless Guard.const_defined?('Plugin')
   # (e.g. when added to a Gemfile without `require: false`)
   module Guard
     class Plugin
-      def initialize
-        fail NotImplementedError
+      def initialize(_options = {})
+        msg = 'either Guard has not been required or you did not' \
+          ' include guard/compat/test/helper'
+        fail NotImplementedError, msg
+      end
+    end
+  end
+end
+
+module Guard
+  module Compat
+    # TODO: this is just a temporary workaround to allow plugins
+    # to use watcher patterns in run_all
+    def self.matching_files(plugin, files)
+      unless Guard.const_defined?('Watcher')
+        msg = 'either Guard has not been required or you did not' \
+          ' stub this method in your plugin tests'
+        fail NotImplementedError, msg
+      end
+
+      Guard::Watcher.match_files(plugin, files)
+    end
+
+    module UI
+      def self.color(text, *colors)
+        Guard::UI.send(:color, text, *colors)
+      end
+
+      def self.color_enabled?
+        Guard::UI.send(:color_enabled?)
+      end
+
+      def self.info(message, options = {})
+        Guard::UI.info(message, options)
+      end
+
+      def self.warning(message, options = {})
+        Guard::UI.warning(message, options)
+      end
+
+      def self.error(message, options = {})
+        Guard::UI.warning(message, options)
+      end
+
+      def self.debug(message, options = {})
+        Guard::UI.warning(message, options)
+      end
+
+      def self.deprecation(message, options = {})
+        Guard::UI.warning(message, options)
+      end
+
+      def self.notify(message, options = {})
+        Guard::Notifier.notify(message, options)
       end
     end
   end

data/lib/guard/compat/test/helper.rb

@@ -3,9 +3,12 @@
 require 'guard/compat/plugin'
 
 module Guard
+  # Monkey patch Plugin to just keep the interface
   class Plugin
     attr_reader :options
 
+    remove_method(:initialize)
+
     def initialize(options = {})
       @options = options
     end
@@ -15,9 +18,8 @@ module Guard
   # is while guard-process is being tested
   unless Guard.const_defined?('Notifier')
     module Notifier
-      def self.notify(_msg, _options = {})
-        fail NotImplementedError, 'stub this method in your tests'
-      end
+      # NOTE: do not implement anything here, so using any UI methods
+      # causes tests to fail
     end
   end
 
@@ -25,29 +27,8 @@ module Guard
   # through using Guard::Notifier
   unless Guard.const_defined?('UI')
     module UI
-      def self.info(_msg, _options = {})
-        fail NotImplementedError, 'stub this method in your tests'
-      end
-
-      def self.warning(_msg, _options = {})
-        fail NotImplementedError, 'stub this method in your tests'
-      end
-
-      def self.error(_msg, _options = {})
-        fail NotImplementedError, 'stub this method in your tests'
-      end
-
-      def self.debug(_msg, _options = {})
-        fail NotImplementedError, 'stub this method in your tests'
-      end
-
-      def self.deprecation(_msg, _options = {})
-        fail NotImplementedError, 'stub this method in your tests'
-      end
-
-      def self.color_enabled?
-        fail NotImplementedError, 'stub this method in your tests'
-      end
+      # NOTE: do not implement anything here, so using any UI methods
+      # causes tests to fail
     end
   end
 end

data/lib/guard/compat/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module Compat
-    VERSION = '0.3.0'
+    VERSION = '1.0.0'
   end
 end

data/spec/guard/compat/example_spec.rb

@@ -7,12 +7,10 @@ RSpec.describe Guard::MyPlugin, exclude_stubs: [Guard::Plugin] do
   subject { described_class.new(options) }
 
   before do
-    allow(Guard::Notifier).to receive(:notify)
-    %w(info warning error deprecation debug).each do |type|
-      allow(Guard::UI).to receive(type.to_sym)
+    meths = %w(info warning error deprecation debug notify color color_enabled?)
+    meths.each do |type|
+      allow(Guard::Compat::UI).to receive(type.to_sym)
     end
-
-    allow(Guard::UI).to receive(:color_enabled?).and_return(false)
   end
 
   it 'passes options' do
@@ -23,31 +21,32 @@ RSpec.describe Guard::MyPlugin, exclude_stubs: [Guard::Plugin] do
     expect { described_class.new }.to_not raise_error
   end
 
-  it 'uses the notifier' do
-    expect(Guard::Notifier).to receive(:notify).with('foo')
-    subject.start
-  end
-
-  it 'uses the notifier with options' do
-    expect(Guard::Notifier).to receive(:notify).with('foo', title: 'bar')
-    subject.run_all
+  describe '#start' do
+    before { subject.start }
+    %w(info warning error deprecation debug notify).each do |type|
+      specify do
+        expect(Guard::Compat::UI).to have_received(type.to_sym).with('foo')
+      end
+    end
   end
 
-  %w(info warning error deprecation debug).each do |type|
-    it "outputs #{type} messages" do
-      expect(Guard::UI).to receive(type.to_sym).with('foo')
-      subject.start
+  describe '#run_all' do
+    before { subject.run_all }
+    %w(info warning error deprecation debug notify).each do |type|
+      specify do
+        expect(Guard::Compat::UI).to have_received(type.to_sym)
+          .with('foo', bar: :baz)
+      end
     end
+  end
 
-    it "outputs #{type} messages with options" do
-      expect(Guard::UI).to receive(type.to_sym).with('foo', bar: :baz)
-      subject.run_all
+  describe '#run_on_modifications' do
+    before do
+      allow(Guard::Compat).to receive(:matching_files)
     end
-  end
 
-  it 'uses the UI color_enabled? method' do
-    expect(Guard::UI).to receive(:color_enabled?).and_return(true)
-    subject.run_all
+    before { subject.run_on_modifications }
+    specify { expect(Guard::Compat::UI).to have_received(:color_enabled?) }
+    specify { expect(Guard::Compat).to have_received(:matching_files) }
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-compat
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Cezary Baginski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-06 00:00:00.000000000 Z
+date: 2014-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler