guard-compat 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5c15f5a243693a6af0123db855199c6dd3ce1a0
-  data.tar.gz: 2b4187ea85ba0bfa512d5298788c5c21f46a89cd
+  metadata.gz: f427877d1a7d6c838c4472d3ec9c0c89eb95371e
+  data.tar.gz: a797c283daf477b9a4bd67784abb8f9e976f5326
 SHA512:
-  metadata.gz: d5c161fe3ef52a00aaca0a1c81ee30acda5febb69c642b9067ea8866ecfb4440f8d41da0ad5572fdd2ea2b7dde923b177dd6319b7c23b1a328d8db5f362806a3
-  data.tar.gz: 7706bfba6558b2abf1642afc25280f5cbb6af15c83f59af5b5bb5f29b7e19e9764e4d4634c1e9dfff11ecfaa0c8d12bb3a26d25f7def96a6c80ad5ff5b864165
+  metadata.gz: 626bce3667b1627b41a86cd2d8883d9cfb8e3dac9067cb012a8475d07e7ac9f8b4a81adabce90e984aa706e8d759af896718fc634bffde0653ea5d4bba6c49b0
+  data.tar.gz: 7a2cbc0e873fe72ccc68daaceb19019ab67c29ad63b73de02f22c37296e9c63fb79b89d6d54b99911124618a649c6f4874e3cfe729111aa355079b47de5acd36

data/README.md

@@ -7,8 +7,8 @@ Currently, provides only a test helper for testing custom Guard plugins.
 Add this to your application's Gemfile:
 
 ```ruby
-group :development do
-  gem 'guard-compat', require: false
+group :test do
+  gem 'guard-compat', '>= 0.0.2', require: false
 end
 ```
 
@@ -18,13 +18,27 @@ And then execute:
 
 ## Usage
 
-Put the following notes in your plugin file (e.g. `lib/guard/myplugin.rb`):
+Put the following in your plugin files (e.g. `lib/guard/myplugin.rb`):
 
 ```ruby
-# Do NOT require "guard/plugin"
-# It will either be required or a stub will be supplied by the test class
+# Don't require "guard/plugin" in hits files
+require 'guard/compat/plugin'
+
+module Guard
+  class MyPlugin < Plugin
+    # (...)
+  end
+end
+
 ```
 
+### IMPORTANT
+
+1) Do not include *any* files from Guard directly (if you need something from Guard which Guard::Compat doesn't provide, file an issue)
+2) include 'guard/compat/plugin' is *all* your files which use `Guard::Plugin`
+3) make sure you include the `< Plugin` part in *every* file which add classes or methods to your plugin class (important if your plugin consists of multiple files/sub class)
+
+
 And in your plugin tests (e.g. `spec/lib/guard/myplugin_spec.rb`):
 
 ```ruby
@@ -35,8 +49,9 @@ require 'guard/myplugin'
 ```
 ## Example
 
-See `lib/guard/example.rb` for an example plugin implementation.
+See [lib/guard/compat/example.rb](https://github.com/guard/guard-compat/blob/master/lib/guard/compat/example.rb ) for an example plugin implementation.
 
+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.
 
 ## Contributing
 

data/lib/guard/compat/plugin.rb

@@ -0,0 +1,11 @@
+unless Object.const_defined?('Guard::Plugin')
+  # Provided empty definition so requiring the plugin without Guard won't crash
+  # (e.g. when added to a Gemfile without `require: false`)
+  module Guard
+    class Plugin
+      def initialize
+        fail NotImplementedError
+      end
+    end
+  end
+end

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

@@ -1,4 +1,7 @@
 # Minimal stub allowing a plugin to work
+
+require 'guard/compat/plugin'
+
 module Guard
   class Plugin
     attr_reader :options

data/lib/guard/compat/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module Compat
-    VERSION = '0.0.2'
+    VERSION = '0.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-compat
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Cezary Baginski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
+date: 2014-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,6 +56,7 @@ files:
 - guard-compat.gemspec
 - lib/guard/compat.rb
 - lib/guard/compat/example.rb
+- lib/guard/compat/plugin.rb
 - lib/guard/compat/test/helper.rb
 - lib/guard/compat/version.rb
 - spec/guard/compat/example_spec.rb