guard-compat 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 778facd6a20816307eec1ff3f98ed495f6294981
-  data.tar.gz: c68a7c17a5d0f67d6b96e5088c4ddc8dfb5f7261
+  metadata.gz: a717c9cc74638fef19735c7029e547853fd957d0
+  data.tar.gz: 4e2f952d70ce108ec8cf2b473f98499690a45285
 SHA512:
-  metadata.gz: e81ee48ff70b4385b757e06d1c85ff8c36d9ed16b273ef9d5f29e14692f9b634dff880e5096d6d10750fa64a8e8c59a4d3fe1d15bec80c6b1d302ea19c2d035e
-  data.tar.gz: a4be81d2c57c69d674ff453a91899b36d65c3484e42c90d8a16291c278e6ab1544bf6dea4d00f2f01a0c85fd9e708a0f349ed17f8c7f0c685fcaaf44ba9379eb
+  metadata.gz: 857bca959b9ffd37e30537cea11574dfb3d6c4a402f59375e435da8548ac43e9d22e1276e7c0aee5217634606906441807389d5b1548942e2b8c2eb7af782037
+  data.tar.gz: db48127d844b15360e34e787226e70b3cf4bac4f89a688373c3a38b4c184ad0a2bf6fa26de465530b453c72212bc974541213d4c72f356fbface2f8aaa363035

data/README.md

@@ -2,26 +2,18 @@
 
 Currently, provides only a test helper for testing custom Guard plugins.
 
-## Installation
+## Usage (in a Guard plugin)
 
-Add this to your application's Gemfile:
+In your gemspec:
 
 ```ruby
-group :test do
-  gem 'guard-compat', '>= 0.0.2', require: false
-end
+s.add_dependency('guard-compat', '~> 0.3')
 ```
 
-And then execute:
-
-    $ bundle
-
-## Usage
-
-Put the following in your plugin files (e.g. `lib/guard/myplugin.rb`):
+In all your plugin files (e.g. `lib/guard/myplugin.rb`):
 
 ```ruby
-# Don't require "guard/plugin" in hits files
+# Don't require "guard/plugin" here or in any other plugin's files
 require 'guard/compat/plugin'
 
 module Guard
@@ -32,12 +24,6 @@ end
 
 ```
 
-In your gemspec:
-
-```ruby
-s.add_dependency('guard-compat', '~> 0.1')
-```
-
 
 ### IMPORTANT
 

data/lib/guard/compat/example.rb

@@ -21,6 +21,8 @@ module Guard
       Guard::UI.error('foo', bar: :baz)
       Guard::UI.debug('foo', bar: :baz)
       Guard::UI.deprecation('foo', bar: :baz)
+
+      Guard::UI.color_enabled?
     end
   end
 end

data/lib/guard/compat/plugin.rb

@@ -1,3 +1,6 @@
+# Note: currently, this file only exists to allow Bundler to require this file
+# without crashing (e.g. when Guard hasn't been included)
+
 unless Object.const_defined?('Guard')
   module Guard
   end

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

@@ -44,6 +44,10 @@ module Guard
       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
     end
   end
 end

data/lib/guard/compat/version.rb

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

data/spec/guard/compat/example_spec.rb

@@ -11,12 +11,18 @@ RSpec.describe Guard::MyPlugin, exclude_stubs: [Guard::Plugin] do
     %w(info warning error deprecation debug).each do |type|
       allow(Guard::UI).to receive(type.to_sym)
     end
+
+    allow(Guard::UI).to receive(:color_enabled?).and_return(false)
   end
 
   it 'passes options' do
     expect(subject.options).to include(foo: :bar)
   end
 
+  it 'works without options' 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
@@ -38,4 +44,10 @@ RSpec.describe Guard::MyPlugin, exclude_stubs: [Guard::Plugin] do
       subject.run_all
     end
   end
+
+  it 'uses the UI color_enabled? method' do
+    expect(Guard::UI).to receive(:color_enabled?).and_return(true)
+    subject.run_all
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-compat
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Cezary Baginski