[RFC] Add a Guard::API module that Guard plugins should include #873

rymai · 2017-06-17T17:28:08Z

This is a first step toward a sanitized plugin architecture: Mixin instead of inheritance.

@ioquatix @e2 @thibaudgg What do you think?

Compatibility layer has been added at guard/guard-compat#6.

Example of implementation for guard-rspec can be found at guard/guard-rspec#397.

Related to #691 and #713 (comment).

lib/guard/api.rb

thibaudgg · 2017-06-17T20:43:58Z

Looks good to me! 👍

ioquatix · 2017-06-17T22:59:08Z

lib/guard/api.rb

+    def self.included(base)
+      base.extend(ClassMethods)
+      base.class_eval do
+        attr_accessor :group, :watchers, :callbacks, :options


I suggest you add documentation.

ioquatix · 2017-06-17T23:00:45Z

lib/guard/api.rb

+      # Guardfile.
+      #
+      def callbacks
+        @callbacks ||= Hash.new { |hash, key| hash[key] = [] }


I think Ruby will complain about this as it wasn't defined prior. Unfortunately, I think you need to do something like this: https://github.com/ioquatix/utopia/blob/9239e84edfeaf7177f74ae9408c4e16468faa505/lib/utopia/controller/actions.rb#L126-L131

Check by running tests with warnings turned on.

ioquatix · 2017-06-17T23:02:14Z

lib/guard/api.rb

+      # @return [String]
+      #
+      def non_namespaced_classname
+        to_s.sub("Guard::", "")


What's this used for? What about to_s.split('::').last?

Will this work for, say, Guard::Falcon::Plugin - what is the desired output?

I think the desired output would be Falcon in the last case.

ioquatix · 2017-06-17T23:04:27Z

lib/guard/api.rb

+      # @param [String] plugin_location the plugin location
+      #
+      def template(plugin_location)
+        File.read(format(TEMPLATE_FORMAT, plugin_location, non_namespaced_name))


Can we do something better than this? Rather than putting templates in lib/..., which is a tiny bit odd since it's not code - why not put it in templates/ of root of gem?

ioquatix · 2017-06-17T23:08:44Z

Just for comparison, a long time ago I wrote a general EventEmitter like controller class. It might be interesting just to eye over https://github.com/ioquatix/synco/blob/master/lib/synco/controller.rb as it handles generic events. It's a bit more complex as I needed to be able to nest things easily, but it's an interesting idea, especially #try method, and looks a (tiny) bit similar to things like add_callback, etc.

How does this allow us to avoid global state? I don't think there is something fundamentally wrong with inheritance, but I do have an extreme distaste for global state in general. So, for me, I'm more interested in how you propose to reduce global state/API.

This is a first step toward a sanitized plugin architecture: Mixin instead of inheritance. Signed-off-by: Rémy Coutable <remy@rymai.me>

spec/lib/guard/plugin_spec.rb

spec/lib/guard/dsl_describer_spec.rb

spec/lib/guard/deprecated/guard_spec.rb

spec/lib/guard/commands/pause_spec.rb

spec/lib/guard/commands/notification_spec.rb

spec/lib/guard/commands/change_spec.rb

spec/lib/guard/commands/all_spec.rb

lib/guard/api.rb

Signed-off-by: Rémy Coutable <remy@rymai.me>

houndci-bot · 2018-03-03T17:52:58Z

spec/lib/guard/dsl_describer_spec.rb

        { name: :gntp, options: { sticky: true } }
-      ]
+      ])


Indent the right bracket the same as the first position after the preceding left parenthesis.

houndci-bot · 2018-03-03T17:52:58Z

spec/lib/guard/dsl_describer_spec.rb

        { name: :gntp, options: { sticky: true } }
-      ]
+      ])


Indent the right bracket the same as the first position after the preceding left parenthesis.

Signed-off-by: Rémy Coutable <remy@rymai.me>

houndci-bot · 2018-03-03T18:19:41Z

spec/spec_helper.rb

-    end
+    #
+    # allow(ENV).to receive(:[]=) do |*args|
+    #   abort "stub me: ENV[#{args.first}]= #{args.map(&:inspect)[1..-1] * ','}!"


Line is too long. [81/80]

spec/spec_helper.rb

houndci-bot · 2018-03-03T18:19:42Z

spec/lib/guard_spec.rb

-  # Initialize before Guard::Interactor const is stubbed
-  let!(:interactor) { instance_double("Guard::Interactor") }
+  describe '.init' do
+    it 'creates a new Engine object' do


Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

houndci-bot · 2018-03-03T18:19:42Z

spec/lib/guard_spec.rb

@@ -1,247 +1,13 @@
 require "guard"

 RSpec.describe Guard do
-  # Initialize before Guard::Interactor const is stubbed
-  let!(:interactor) { instance_double("Guard::Interactor") }
+  describe '.init' do


Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

houndci-bot · 2018-03-03T18:19:42Z

spec/lib/guard/runner_spec.rb


      it "returns :task_has_failed" do
-        symbol = described_class.stopping_symbol_for(guard_plugin)
-        expect(symbol).to eq :task_has_failed
+        expect(described_class.stopping_symbol_for(foo_plugin)).to eq :task_has_failed


Line is too long. [86/80]

houndci-bot · 2018-03-03T18:19:42Z

spec/lib/guard/runner_spec.rb

+    end
+  end
+
+  describe "#run_on_changes" do


Block has too many lines. [103/25]

houndci-bot · 2018-03-03T18:19:43Z

spec/lib/guard/runner_spec.rb

+      end
+    end
+
+    context "with a task that succeeds" do


Block has too many lines. [27/25]

houndci-bot · 2018-03-04T00:51:22Z

spec/lib/guard/plugin_util_spec.rb

@@ -164,7 +155,7 @@ class DashedClassName

    context "with a name with underscores" do
      it "returns the Guard class" do
-        plugin = described_class.new("underscore_class_name")
+        plugin = described_class.new(engine: engine, name: "underscore_class_name")


Line is too long. [83/80]

houndci-bot · 2018-03-04T00:51:23Z

spec/lib/guard/plugin_util_spec.rb

-      end
+    it "instantiate the plugin" do
+      options = { watchers: ["watcher"], group: "foo" }
+      expect(guard_rspec_class).to receive(:new).with(engine: engine, options: options) { guard_rspec }


Line is too long. [103/80]

houndci-bot · 2018-03-04T00:51:23Z

spec/lib/guard/plugin_util_spec.rb

    end

    it "accepts a name with guard-" do
-      expect(described_class.new("guard-rspec").name).to eq "rspec"
+      expect(described_class.new(engine: engine, name: "guard-rspec").name).to eq "rspec"


Line is too long. [89/80]

houndci-bot · 2018-03-04T00:51:23Z

spec/lib/guard/plugin_util_spec.rb

@@ -52,39 +47,35 @@

  describe "#initialize" do
    it "accepts a name without guard-" do
-      expect(described_class.new("rspec").name).to eq "rspec"
+      expect(described_class.new(engine: engine, name: "rspec").name).to eq "rspec"


Line is too long. [83/80]

houndci-bot · 2018-03-04T00:51:23Z

spec/lib/guard/internals/session_spec.rb

    end

    it "returns a plugin and group scope" do
      scopes, = subject.convert_scope %w(foo backend)
-      expect(scopes).to eq(plugins: [foo], groups: [backend])
+
+      expect(scopes).to eq(plugins: [subject.plugins.find(:foo)], groups: [subject.groups.find(:backend)])


Line is too long. [106/80]

spec/lib/guard/internals/plugins_spec.rb

houndci-bot · 2018-03-04T00:51:24Z

spec/support/with_fake_pry_class_shared_context.rb

@@ -0,0 +1,7 @@
+RSpec.shared_context 'with fake_pry_class' do


Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

houndci-bot · 2018-03-04T00:51:24Z

spec/spec_helper.rb

+    # end
+    #
+    # allow(ENV).to receive(:[]=) do |*args|
+    #   abort "stub me: ENV[#{args.first}]= #{args.map(&:inspect)[1..-1] * ','}!"


Line is too long. [81/80]

houndci-bot · 2018-03-04T00:51:24Z

spec/spec_helper.rb

+    # excluded << Guard::Internals::Queue if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Scope if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Session if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::State if Guard.constants.include?(:Internals)


Line is too long. [81/80]

houndci-bot · 2018-03-04T00:51:24Z

spec/spec_helper.rb

+    # excluded << Guard::Internals::Plugins if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Queue if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Scope if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Session if Guard.constants.include?(:Internals)


Line is too long. [83/80]

houndci-bot · 2018-03-04T01:05:05Z

spec/spec_helper.rb

+    # excluded << Guard::Internals::Groups if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Plugins if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Queue if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Scope if Guard.constants.include?(:Internals)


Line is too long. [81/80]

houndci-bot · 2018-03-04T01:05:05Z

spec/spec_helper.rb

+    # excluded << Guard::Jobs::TerminalSettings if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Internals::Groups if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Plugins if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Queue if Guard.constants.include?(:Internals)


Line is too long. [81/80]

houndci-bot · 2018-03-04T01:05:05Z

spec/spec_helper.rb

+    # excluded << Guard::Jobs::PryWrapper if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Jobs::TerminalSettings if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Internals::Groups if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Plugins if Guard.constants.include?(:Internals)


Line is too long. [83/80]

houndci-bot · 2018-03-04T01:05:05Z

spec/spec_helper.rb

+    # excluded << Guard::Jobs::Base if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Jobs::PryWrapper if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Jobs::TerminalSettings if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Internals::Groups if Guard.constants.include?(:Internals)


Line is too long. [82/80]

houndci-bot · 2018-03-04T01:05:05Z

spec/spec_helper.rb

+    # excluded << Guard::Options if Guard.constants.include?(:Options)
+    # excluded << Guard::Jobs::Base if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Jobs::PryWrapper if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Jobs::TerminalSettings if Guard.constants.include?(:Jobs)


Line is too long. [82/80]

houndci-bot · 2018-03-04T01:05:05Z

spec/spec_helper.rb

+    # excluded << Guard::Commands::Notification if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Notification)
+    # excluded << Guard::Commands::Pause if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Pause)
+    # excluded << Guard::Commands::Reload if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Reload)
+    # excluded << Guard::Commands::Scope if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Scope)


Line is too long. [125/80]

houndci-bot · 2018-03-04T01:05:05Z

spec/spec_helper.rb

+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)
+    # excluded << Guard::Commands::Notification if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Notification)
+    # excluded << Guard::Commands::Pause if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Pause)
+    # excluded << Guard::Commands::Reload if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Reload)


Line is too long. [127/80]

houndci-bot · 2018-03-04T01:05:05Z

spec/spec_helper.rb

+    # excluded << Guard::Commands::All if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:All)
+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)
+    # excluded << Guard::Commands::Notification if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Notification)
+    # excluded << Guard::Commands::Pause if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Pause)


Line is too long. [125/80]

houndci-bot · 2018-03-04T01:05:06Z

spec/spec_helper.rb

+    # excluded << Guard::Engine if Guard.constants.include?(:Engine)
+    # excluded << Guard::Commands::All if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:All)
+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)
+    # excluded << Guard::Commands::Notification if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Notification)


Line is too long. [139/80]

houndci-bot · 2018-03-04T01:05:06Z

spec/spec_helper.rb

+    # excluded += Array(example.metadata[:exclude_stubs])
+    # excluded << Guard::Engine if Guard.constants.include?(:Engine)
+    # excluded << Guard::Commands::All if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:All)
+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)


Line is too long. [127/80]

houndci-bot · 2018-03-04T01:05:06Z

spec/spec_helper.rb

+    # excluded << Guard::Internals::Groups if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Plugins if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Queue if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Scope if Guard.constants.include?(:Internals)


Line is too long. [81/80]

houndci-bot · 2018-03-04T01:05:06Z

spec/spec_helper.rb

+    # excluded << Guard::Jobs::TerminalSettings if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Internals::Groups if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Plugins if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Queue if Guard.constants.include?(:Internals)


Line is too long. [81/80]

houndci-bot · 2018-03-04T01:05:06Z

spec/spec_helper.rb

+    # excluded << Guard::Jobs::PryWrapper if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Jobs::TerminalSettings if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Internals::Groups if Guard.constants.include?(:Internals)
+    # excluded << Guard::Internals::Plugins if Guard.constants.include?(:Internals)


Line is too long. [83/80]

houndci-bot · 2018-03-04T01:05:06Z

spec/spec_helper.rb

+    # excluded << Guard::Jobs::Base if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Jobs::PryWrapper if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Jobs::TerminalSettings if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Internals::Groups if Guard.constants.include?(:Internals)


Line is too long. [82/80]

houndci-bot · 2018-03-04T01:05:06Z

spec/spec_helper.rb

+    # excluded << Guard::Options if Guard.constants.include?(:Options)
+    # excluded << Guard::Jobs::Base if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Jobs::PryWrapper if Guard.constants.include?(:Jobs)
+    # excluded << Guard::Jobs::TerminalSettings if Guard.constants.include?(:Jobs)


Line is too long. [82/80]

houndci-bot · 2018-03-04T01:05:07Z

spec/spec_helper.rb

+    # excluded << Guard::Commands::Notification if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Notification)
+    # excluded << Guard::Commands::Pause if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Pause)
+    # excluded << Guard::Commands::Reload if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Reload)
+    # excluded << Guard::Commands::Scope if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Scope)


Line is too long. [125/80]

houndci-bot · 2018-03-04T01:05:07Z

spec/spec_helper.rb

+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)
+    # excluded << Guard::Commands::Notification if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Notification)
+    # excluded << Guard::Commands::Pause if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Pause)
+    # excluded << Guard::Commands::Reload if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Reload)


Line is too long. [127/80]

houndci-bot · 2018-03-04T01:05:07Z

spec/spec_helper.rb

+    # excluded << Guard::Commands::All if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:All)
+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)
+    # excluded << Guard::Commands::Notification if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Notification)
+    # excluded << Guard::Commands::Pause if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Pause)


Line is too long. [125/80]

houndci-bot · 2018-03-04T01:05:07Z

spec/spec_helper.rb

+    # excluded << Guard::Engine if Guard.constants.include?(:Engine)
+    # excluded << Guard::Commands::All if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:All)
+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)
+    # excluded << Guard::Commands::Notification if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Notification)


Line is too long. [139/80]

houndci-bot · 2018-03-04T01:05:07Z

spec/spec_helper.rb

+    # excluded += Array(example.metadata[:exclude_stubs])
+    # excluded << Guard::Engine if Guard.constants.include?(:Engine)
+    # excluded << Guard::Commands::All if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:All)
+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)


Line is too long. [127/80]

Signed-off-by: Rémy Coutable <remy@rymai.me>

Update rubocop to match hound Adapt hound style to new rubocop version Add style config file for specs Exclude vendor/**/* Default for rubocop is to overwrite arrays. This happens here and leads to uncomfortable usage of rubocop locally. Update target version to minimum supported version Autoupdate rubocop settings using mry

Co-Authored-By: chadmetcalf <chadmetcalf@users.noreply.github.com>

Pry 0.12.0 Deprecation warnings

Signed-off-by: Rémy Coutable <remy@rymai.me>

Bump to 2.15.0

Add a "Reviewed by Hound" badge

@param

- Avoid warnings like: [UnknownParam] @param tag has unknown parameter name: options

Fix YARD annotation

- jruby-9.1.17.0, jruby-9.2.6.0 - rbx-3.107

CI: Use 2.4.6, 2.5.5, 2.6.2...

- service closed

README: Drop outdated badge for Gemnasium

Ruby 2.6 changed Pathname#read from using IO.read to File.read.

Signed-off-by: Rémy Coutable <remy@rymai.me>

Stub Pathname instead of IO.read in spec

Ensure Guard calls `#stop` even if an exception is raised

Add a `simplecov` filter for the `/spec` folder

This is a first step toward a sanitized plugin architecture: Mixin instead of inheritance. Signed-off-by: Rémy Coutable <remy@rymai.me>

Signed-off-by: Rémy Coutable <remy@rymai.me>

houndci-bot · 2019-04-17T20:40:46Z

spec/support/with_fake_pry_class_shared_context.rb

@@ -0,0 +1,7 @@
+RSpec.shared_context 'with fake_pry_class' do


Style/StringLiterals: Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

houndci-bot · 2019-04-17T20:40:46Z

spec/spec_helper.rb

+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)
+    # excluded << Guard::Commands::Notification if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Notification)
+    # excluded << Guard::Commands::Pause if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Pause)
+    # excluded << Guard::Commands::Reload if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Reload)


Metrics/LineLength: Line is too long. [127/125]

houndci-bot · 2019-04-17T20:40:47Z

spec/spec_helper.rb

+    # excluded << Guard::Engine if Guard.constants.include?(:Engine)
+    # excluded << Guard::Commands::All if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:All)
+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)
+    # excluded << Guard::Commands::Notification if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Notification)


Metrics/LineLength: Line is too long. [139/125]

houndci-bot · 2019-04-17T20:40:47Z

spec/spec_helper.rb

+    # excluded += Array(example.metadata[:exclude_stubs])
+    # excluded << Guard::Engine if Guard.constants.include?(:Engine)
+    # excluded << Guard::Commands::All if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:All)
+    # excluded << Guard::Commands::Change if Guard.constants.include?(:Commands) && Guard::Commands.constants.include?(:Change)


Metrics/LineLength: Line is too long. [127/125]

houndci-bot · 2019-04-17T20:40:47Z

spec/lib/guard_spec.rb

-      subject
-    end
+  describe '.init' do
+    it 'creates a new Engine object' do


Style/StringLiterals: Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

houndci-bot · 2019-04-17T20:40:48Z

spec/lib/guard/plugin_spec.rb

      end
    end

    context "without a group in the options" do
      it "assigns a default group" do
-        allow(groups).to receive(:add).with(:default).and_return(default)
-        expect(Guard::Plugin.new.group).to eq default
+        expect(Guard::Bar.new(engine: engine).group).


Layout/DotPosition: Place the . on the next line, together with the method name.

houndci-bot · 2019-04-17T20:40:48Z

spec/lib/guard/plugin_spec.rb

    end

    context "with a group in the options" do
      it "assigns the given group" do
-        expect(Guard::Plugin.new(group: :test).group).to eq test
+        expect(Guard::Bar.new(engine: engine, options: { group: :test }).group).


Layout/DotPosition: Place the . on the next line, together with the method name.

houndci-bot · 2019-04-17T20:40:48Z

spec/lib/guard/plugin_spec.rb

+    it "display a deprecation message" do
+      expect(Guard::UI).to receive(:deprecation).
+        with(format(Guard::Deprecated::Plugin::INHERITHING_FROM_PLUGIN,
+             "Bar", "/lib/guard/bar.rb", "Bar"))


Layout/AlignParameters: Align the parameters of a method call if they span more than one line.

houndci-bot · 2019-04-17T20:40:48Z

spec/lib/guard/plugin_spec.rb

+    end
+
+    it "display a deprecation message" do
+      expect(Guard::UI).to receive(:deprecation).


Layout/DotPosition: Place the . on the next line, together with the method name.

houndci-bot · 2019-04-17T20:40:49Z

spec/lib/guard/plugin_spec.rb

  end

  describe "#initialize" do
    it "assigns the defined watchers" do
      watchers = [double("foo")]
-      expect(Guard::Plugin.new(watchers: watchers).watchers).to eq watchers
+
+      expect(Guard::Bar.new(engine: engine, options: { watchers: watchers }).watchers).


Layout/DotPosition: Place the . on the next line, together with the method name.

houndci-bot reviewed Jun 17, 2017

View reviewed changes

This was referenced Jun 17, 2017

[RFC] Add a compat layer for Guard::API guard/guard-compat#6

Open

Extract Guard::UI into a separate gem #713

Open

ioquatix reviewed Jun 17, 2017

View reviewed changes

Add a Guard::API module that Guard plugins should include

add7310

This is a first step toward a sanitized plugin architecture: Mixin instead of inheritance. Signed-off-by: Rémy Coutable <remy@rymai.me>

rymai force-pushed the guard-api branch from 80c385b to 32cdf8f Compare March 3, 2018 17:48

houndci-bot reviewed Mar 3, 2018

View reviewed changes

Continue the work on the new Guard::API

672ed89

Signed-off-by: Rémy Coutable <remy@rymai.me>

rymai force-pushed the guard-api branch from 32cdf8f to 672ed89 Compare March 3, 2018 17:52

houndci-bot reviewed Mar 3, 2018

View reviewed changes

Continue work on using Guard::API

1814234

Signed-off-by: Rémy Coutable <remy@rymai.me>

houndci-bot reviewed Mar 3, 2018

View reviewed changes

houndci-bot reviewed Mar 4, 2018

View reviewed changes

rymai force-pushed the guard-api branch from 7dcedd2 to a780389 Compare March 4, 2018 01:04

houndci-bot reviewed Mar 4, 2018

View reviewed changes

Fix more specs

cef6aa5

Signed-off-by: Rémy Coutable <remy@rymai.me>

rymai force-pushed the guard-api branch from a780389 to cef6aa5 Compare March 4, 2018 01:44

edthamm added 6 commits August 19, 2018 08:48

Auto correct: Style/StringLiterals in spec

e0eefa7

Auto correct: Style/FrozenStringLiteralComment

b680c6c

Correct: Violations in gemfile

87a677a

Fix: Unfreeze string literal in failing test

cf64428

Auto correct: Layout/DotPosition

6f3ef4b

rymai and others added 29 commits November 9, 2018 08:08

Use Gem Version in comparison

0ba79a6

Co-Authored-By: chadmetcalf <chadmetcalf@users.noreply.github.com>

Merge pull request #916 from chadmetcalf/pry_deprecation

a47aed1

Pry 0.12.0 Deprecation warnings

Bump to 2.15.0

68dc4bb

Signed-off-by: Rémy Coutable <remy@rymai.me>

Merge pull request #918 from guard/bump-to-2.15.0

8df6a45

Bump to 2.15.0

Add a "Reviewed by Hound" badge

929ffdf

Merge pull request #919 from salbertson/patch-1

a3104cb

Add a "Reviewed by Hound" badge

Update Ruby versions tested in .travis.yml

7ed2884

Fix YARD annotation

568e12a

- Avoid warnings like: [UnknownParam] @param tag has unknown parameter name: options

Fix YARD annotation

8dc0c4f

Merge pull request #925 from olleolleolle/patch-1

ebe4b12

Fix YARD annotation

CI: Use 2.4.6, 2.5.5, 2.6.2...

ca71795

- jruby-9.1.17.0, jruby-9.2.6.0 - rbx-3.107

Merge pull request #926 from olleolleolle/patch-1

586224d

CI: Use 2.4.6, 2.5.5, 2.6.2...

README: Drop outdated badge for Gemnasium

ba67757

- service closed

Merge pull request #927 from olleolleolle/patch-1

fbae74a

README: Drop outdated badge for Gemnasium

Stub File.read instead of IO.read in spec.

f469f51

Ruby 2.6 changed Pathname#read from using IO.read to File.read.

Properly stub Pathname and their methods in specs

0363572

Signed-off-by: Rémy Coutable <remy@rymai.me>

Merge pull request #928 from guard/jackorp-fix-spec-helper

435ffc3

Stub Pathname instead of IO.read in spec

Cleanup guard process anytime

98a4868

Add spec for cleanup process

f004880

Merge pull request #930 from pocke/cleanup-process

c9888b4

Ensure Guard calls `#stop` even if an exception is raised

Update Ruby versions and fix a few small things in the README

ea80783

Merge pull request #914 from Mifrill/simplecov

7bc081a

Add a `simplecov` filter for the `/spec` folder

Add a Guard::API module that Guard plugins should include

516b062

This is a first step toward a sanitized plugin architecture: Mixin instead of inheritance. Signed-off-by: Rémy Coutable <remy@rymai.me>

Continue the work on the new Guard::API

ec27de8

Signed-off-by: Rémy Coutable <remy@rymai.me>

Continue work on using Guard::API

486ef0d

Signed-off-by: Rémy Coutable <remy@rymai.me>

Fix more specs

d6a4ec6

Signed-off-by: Rémy Coutable <remy@rymai.me>

Not sure what I'm doing

a033cb7

Signed-off-by: Rémy Coutable <remy@rymai.me>

Fix some missed conflicts

1d993a6

Signed-off-by: Rémy Coutable <remy@rymai.me>

Merge branch 'guard-api' of github.com:guard/guard into guard-api

2866275

Signed-off-by: Rémy Coutable <remy@rymai.me>

houndci-bot reviewed Apr 17, 2019

View reviewed changes

		@@ -0,0 +1,7 @@
		RSpec.shared_context 'with fake_pry_class' do

[RFC] Add a Guard::API module that Guard plugins should include #873

Are you sure you want to change the base?

[RFC] Add a Guard::API module that Guard plugins should include #873

Conversation

rymai commented Jun 17, 2017 • edited

thibaudgg commented Jun 17, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ioquatix commented Jun 17, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rymai commented Jun 17, 2017 •

edited