[RFC] Change Guard::RSpec to be a module and create Plugin which includes Compat::API

Gemfile

@@ -5,6 +5,8 @@
 filename = "gemfiles/common"
 instance_eval(IO.read(filename), filename, 1)
 
+gem 'guard', github: 'guard/guard', branch: 'guard-api'
+
 group :test do
   gem "rspec", "~> 3.4"
 end
@@ -21,5 +23,6 @@ end
 group :development do
   gem "rubocop", require: false
   gem "guard-rubocop", require: false
-  gem "guard-compat", ">= 0.0.2", require: false
+  # gem "guard-compat", ">= 0.0.2", require: false
+  gem 'guard-compat', github: 'guard/guard-compat', branch: 'guard-api', require: false
 end

guard-rspec.gemspec

@@ -5,7 +5,7 @@ require "guard/rspec/version"
 
 Gem::Specification.new do |s|
   s.name        = "guard-rspec"
-  s.version     = Guard::RSpecVersion::VERSION
+  s.version     = Guard::RSpec::VERSION
   s.author      = "Thibaud Guillaume-Gentil"
   s.email       = "thibaud@thibaud.gg"
   s.summary     = "Guard gem for RSpec"

lib/guard/rspec.rb

@@ -4,48 +4,7 @@
 require "guard/rspec/deprecator"
 require "guard/rspec/runner"
 
-# NOTE: To avoid 'superclass mismatch for class RSpec' errors,
-# every file has to have
-#
-#   class RSpec < Plugin
-#
-# and not just
-#
-#   class RSpec
-
 module Guard
-  class RSpec < Plugin
-    attr_accessor :options, :runner
-
-    def initialize(options = {})
-      super
-      @options = Options.with_defaults(options)
-      Deprecator.warns_about_deprecated_options(@options)
-      @runner = Runner.new(@options)
-    end
-
-    def start
-      Compat::UI.info "Guard::RSpec is running"
-      run_all if options[:all_on_start]
-    end
-
-    def run_all
-      _throw_if_failed { runner.run_all }
-    end
-
-    def reload
-      runner.reload
-    end
-
-    def run_on_modifications(paths)
-      return false if paths.empty?
-      _throw_if_failed { runner.run(paths) }
-    end
-
-    private
-
-    def _throw_if_failed
-      throw :task_has_failed unless yield
-    end
+  module RSpec
   end
 end

lib/guard/rspec/command.rb

@@ -4,7 +4,7 @@
 require "guard/rspec"
 
 module Guard
-  class RSpec < Plugin
+  module RSpec
     class Command < String
       FAILURE_EXIT_CODE = 2
 

lib/guard/rspec/deprecator.rb

@@ -1,5 +1,5 @@
 module Guard
-  class RSpec < Plugin
+  module RSpec
     class Deprecator
       attr_accessor :options
 

lib/guard/rspec/dsl.rb

@@ -3,7 +3,7 @@
 require "guard/rspec"
 
 module Guard
-  class RSpec < Plugin
+  module RSpec
     class Dsl
       def initialize(dsl)
         @dsl = dsl

lib/guard/rspec/inspectors/base_inspector.rb

@@ -1,5 +1,5 @@
 module Guard
-  class RSpec < Plugin
+  module RSpec
     module Inspectors
       class BaseInspector
         attr_accessor :options, :spec_paths

lib/guard/rspec/inspectors/factory.rb

@@ -3,7 +3,7 @@
 require "guard/rspec/inspectors/focused_inspector.rb"
 
 module Guard
-  class RSpec < Plugin
+  module RSpec
     module Inspectors
       class Factory
         class << self

lib/guard/rspec/inspectors/focused_inspector.rb

@@ -1,7 +1,7 @@
 require "guard/rspec/inspectors/base_inspector.rb"
 
 module Guard
-  class RSpec < Plugin
+  module RSpec
     module Inspectors
       # Inspector that focuses on set of paths if any of them is failing.
       # Returns only that set of paths on all future calls to #paths

lib/guard/rspec/inspectors/keeping_inspector.rb

@@ -1,7 +1,7 @@
 require "guard/rspec/inspectors/base_inspector.rb"
 
 module Guard
-  class RSpec < Plugin
+  module RSpec
     module Inspectors
       # Inspector that remembers all failed paths and
       # returns that paths in future calls to #paths method
@@ -52,7 +52,7 @@ def _location_path(location)
 #  https://github.com/rspec/rspec-core/issues/952
 #
 # module Guard
-#  class RSpec < Plugin
+#  module RSpec
 #    module Inspectors
 #      # Inspector that remembers all failed paths and
 #      # returns that paths in future calls to #paths method

lib/guard/rspec/inspectors/simple_inspector.rb

@@ -1,7 +1,7 @@
 require "guard/rspec/inspectors/base_inspector"
 
 module Guard
-  class RSpec < Plugin
+  module RSpec
     module Inspectors
       class SimpleInspector < BaseInspector
         def paths(paths)

lib/guard/rspec/notifier.rb

@@ -1,5 +1,5 @@
 module Guard
-  class RSpec < Plugin
+  module RSpec
     class Notifier
       attr_accessor :options
 

lib/guard/rspec/options.rb

@@ -1,5 +1,5 @@
 module Guard
-  class RSpec < Plugin
+  module RSpec
     module Options
       DEFAULTS = {
         all_on_start:    false,

lib/guard/rspec/plugin.rb

@@ -0,0 +1,40 @@
+module Guard
+  module RSpec
+    class Plugin
+      include Compat::API
+
+      attr_accessor :runner
+
+      def initialize(opts = {})
+        super
+        @options = Options.with_defaults(opts)
+        Deprecator.warns_about_deprecated_options(options)
+        @runner = Runner.new(options)
+      end
+
+      def start
+        Compat::UI.info "Guard::RSpec is running"
+        run_all if options[:all_on_start]
+      end
+
+      def run_all
+        _throw_if_failed { runner.run_all }
+      end
+
+      def reload
+        runner.reload
+      end
+
+      def run_on_modifications(paths)
+        return false if paths.empty?
+        _throw_if_failed { runner.run(paths) }
+      end
+
+      private
+
+      def _throw_if_failed
+        throw :task_has_failed unless yield
+      end
+    end
+  end
+end

lib/guard/rspec/results.rb

@@ -1,5 +1,5 @@
 module Guard
-  class RSpec < Plugin
+  module RSpec
     class Results
       class InvalidData < RuntimeError
       end

lib/guard/rspec/rspec_process.rb

@@ -1,7 +1,7 @@
 require "guard/rspec/command"
 
 module Guard
-  class RSpec < Plugin
+  module RSpec
     class RSpecProcess
       class Failure < RuntimeError
       end

lib/guard/rspec/runner.rb

@@ -7,7 +7,7 @@
 require "guard/rspec/rspec_process"
 
 module Guard
-  class RSpec < Plugin
+  module RSpec
     class Runner
       class NoCmdOptionError < RuntimeError
         def initialize

lib/guard/rspec/version.rb

@@ -1,5 +1,5 @@
 module Guard
-  module RSpecVersion
+  module RSpec
     VERSION = "4.7.3".freeze
   end
 end

spec/lib/guard/rspec_spec.rb → spec/lib/guard/rspec/plugin_spec.rb

@@ -1,10 +1,10 @@
 require "guard/compat/test/helper"
-require "guard/rspec"
+require "guard/rspec/plugin"
 
-RSpec.describe Guard::RSpec do
+RSpec.describe Guard::RSpec::Plugin do
   let(:default_options) { Guard::RSpec::Options::DEFAULTS }
   let(:options) { {} }
-  let(:plugin) { Guard::RSpec.new(options) }
+  let(:plugin) { described_class.new(options) }
   let(:runner) { instance_double(Guard::RSpec::Runner) }
 
   before do
@@ -14,23 +14,25 @@
   end
 
   describe ".initialize" do
+    let(:options) { { foo: :bar } }
+
     it "instanciates with default and custom options" do
-      guard_rspec = Guard::RSpec.new(foo: :bar)
-      expect(guard_rspec.options).to eq(default_options.merge(foo: :bar))
+      expect(plugin.options).to eq(default_options.merge(options))
     end
 
     it "instanciates Runner with all default and custom options" do
       expect(Guard::RSpec::Runner).to receive(:new).
-        with(default_options.merge(foo: :bar))
-      Guard::RSpec.new(foo: :bar)
+        with(default_options.merge(options))
+
+      plugin
     end
 
     it "warns deprecated options" do
       expect(Guard::RSpec::Deprecator).
         to receive(:warns_about_deprecated_options).
-        with(default_options.merge(foo: :bar))
+        with(default_options.merge(options))
 
-      Guard::RSpec.new(foo: :bar)
+      plugin
     end
   end