guard-compat 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72fc80357bae89d7e82328112be553116b9eaab8
-  data.tar.gz: 6210ef62aaae9ffea55f758b46e9bef0eaf5e5d3
+  metadata.gz: 8bea3b0b5cc442c2c5b10976c87ad36407e5066d
+  data.tar.gz: df406a03c512afab623264e68c8fba0f926a9ceb
 SHA512:
-  metadata.gz: a0248a509ecf2c2d5e90e10bb74ce4ebedff29d2e241cf681224be16e38a41a9245c0849f257afa81ae0c8d5700a066c2bc2af9c9e42b8361decdb31292edee9
-  data.tar.gz: fdf358f5c04db54e00e6ff4c3edaf9a24531377e64cfd7be42942bcb676fce98d620c1d4ede17d639cb5eb7b211d32ae19863dcb867e4d131fffddb1494d20f4
+  metadata.gz: 01036358dd3830011dbeceac79ecdc19ef6a7788369d8f20f1314445bf187627b7214f23cde5330fa0bce6977431bdedee3e6f1ea5bc6a8dc2df2f5f2461c239
+  data.tar.gz: 32bf5202d15a4480394311cc5799e231ac9c3bf37b20e288507f609cc0159b8806090e48eb8723903cea6d9a709625dee0e0a643fbc073e01a5e533b128d40a7

data/README.md

@@ -43,6 +43,21 @@ require 'guard/myplugin'
 
 (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)
 
+### Migrating your API calls
+
+`Guard::UI` => `Guard::Compat::UI` (or Compat::UI for short)
+`Guard::Notifier.notify` => `Guard::Compat::UI.notify`
+
+`Guard::Watcher.match_files` => `Guard::Compat.matching_files` (Watcher is otherwise unavailable - see Guard::Less template for passing patterns as plugin options)
+
+### New API
+
+* `Guard::UI.color` => for creating ANSI colored text if currently enabled in Guard
+* `Guard::UI.color_enabled?` => for checking if ANSI color output is currently enabled in Guard
+* `Guard::UI.watched_directories` => compatible way of obtaining watched_directories (recommended instead of accessing Watcher patterns or pattern subgroup hacks)
+
+(Open an issue if you feel something important is missing)
+
 
 ## Example
 
@@ -50,6 +65,8 @@ See [lib/guard/compat/example.rb](https://github.com/guard/guard-compat/blob/mas
 
 See [spec/guard/compat/example_spec.rb](https://github.com/guard/guard-compat/blob/master/spec/guard/compat/example_spec.rb) for an example on how to test plugins using Guard::Compat.
 
+See [spec/guard/compat/example_template_spec.rb](https://github.com/guard/guard-compat/blob/master/spec/guard/compat/example_template_spec.rb) for an example on how to test plugin templates.
+
 ## Contributing
 
 1. Fork it ( https://github.com/guard/guard-compat/fork )

data/lib/guard/compat/plugin.rb

@@ -38,9 +38,8 @@ module Guard
 
     def self.watched_directories
       unless Guard.const_defined?('CLI')
-        msg = 'either Guard has not been required or you did not' \
-          ' stub this method in your plugin tests'
-        fail NotImplementedError, msg
+        fail NotImplementedError, 'either Guard has not been required or'\
+          ' you did not stub this method in your plugin tests'
       end
 
       if Guard.respond_to?(:state)
@@ -54,35 +53,67 @@ module Guard
 
     module UI
       def self.color(text, *colors)
-        Guard::UI.send(:color, text, *colors)
+        if Guard.const_defined?(:UI)
+          Guard::UI.send(:color, text, *colors)
+        else
+          text
+        end
       end
 
       def self.color_enabled?
-        Guard::UI.send(:color_enabled?)
+        if Guard.const_defined?(:UI)
+          Guard::UI.send(:color_enabled?)
+        else
+          false
+        end
       end
 
       def self.info(message, options = {})
-        Guard::UI.info(message, options)
+        if Guard.const_defined?(:UI)
+          Guard::UI.info(message, options)
+        else
+          $stdout.puts(message)
+        end
       end
 
       def self.warning(message, options = {})
-        Guard::UI.warning(message, options)
+        if Guard.const_defined?(:UI)
+          Guard::UI.warning(message, options)
+        else
+          $stdout.puts(message)
+        end
       end
 
       def self.error(message, options = {})
-        Guard::UI.error(message, options)
+        if Guard.const_defined?(:UI)
+          Guard::UI.error(message, options)
+        else
+          $stderr.puts(message)
+        end
       end
 
       def self.debug(message, options = {})
-        Guard::UI.debug(message, options)
+        if Guard.const_defined?(:UI)
+          Guard::UI.debug(message, options)
+        else
+          $stdout.puts(message)
+        end
       end
 
       def self.deprecation(message, options = {})
-        Guard::UI.deprecation(message, options)
+        if Guard.const_defined?(:UI)
+          Guard::UI.deprecation(message, options)
+        else
+          $stdout.puts(message)
+        end
       end
 
       def self.notify(message, options = {})
-        Guard::Notifier.notify(message, options)
+        if Guard.const_defined?(:UI)
+          Guard::Notifier.notify(message, options)
+        else
+          $stdout.puts(message)
+        end
       end
     end
   end

data/lib/guard/compat/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module Compat
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/spec/guard/compat/no_guard_spec.rb

@@ -0,0 +1,63 @@
+# This test requires UI be not defined to simulate using plugin outside Guard
+
+require 'guard/compat/plugin'
+
+Guard.send(:remove_const, :UI) if Guard.const_defined?(:UI)
+
+RSpec.describe Guard::Compat do
+  context 'when Guard is not loaded' do
+    describe '.color' do
+      it 'returns uncolored text' do
+        expect(Guard::Compat::UI.color('foo', 'red')).to eq('foo')
+      end
+    end
+
+    describe '.color_enabled?' do
+      it 'returns false' do
+        expect(Guard::Compat::UI.color_enabled?).to be(false)
+      end
+    end
+
+    describe '.info' do
+      it 'outputs to stdout' do
+        expect($stdout).to receive(:puts).with('foo')
+        Guard::Compat::UI.info('foo')
+      end
+    end
+
+    describe '.warning' do
+      it 'outputs to stdout' do
+        expect($stdout).to receive(:puts).with('foo')
+        Guard::Compat::UI.warning('foo')
+      end
+    end
+
+    describe '.error' do
+      it 'outputs to stdout' do
+        expect($stderr).to receive(:puts).with('foo')
+        Guard::Compat::UI.error('foo')
+      end
+    end
+
+    describe '.debug' do
+      it 'outputs to stdout' do
+        expect($stdout).to receive(:puts).with('foo')
+        Guard::Compat::UI.debug('foo')
+      end
+    end
+
+    describe '.deprecation' do
+      it 'outputs to stdout' do
+        expect($stdout).to receive(:puts).with('foo')
+        Guard::Compat::UI.deprecation('foo')
+      end
+    end
+
+    describe '.notify' do
+      it 'outputs to stdout' do
+        expect($stdout).to receive(:puts).with('foo')
+        Guard::Compat::UI.notify('foo')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-compat
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Cezary Baginski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-11 00:00:00.000000000 Z
+date: 2014-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ files:
 - lib/guard/compat/version.rb
 - spec/guard/compat/example_spec.rb
 - spec/guard/compat/example_template_spec.rb
+- spec/guard/compat/no_guard_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -83,11 +84,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Tools for developing Guard compatible plugins
 test_files:
 - spec/guard/compat/example_spec.rb
 - spec/guard/compat/example_template_spec.rb
+- spec/guard/compat/no_guard_spec.rb
 - spec/spec_helper.rb