File: evaluator_spec.rb

package info (click to toggle)
ruby-guard 2.18.1-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,344 kB
  • sloc: ruby: 9,256; makefile: 6
file content (240 lines) | stat: -rw-r--r-- 6,962 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# frozen_string_literal: true

require "guard/guardfile/evaluator"

# TODO: shouldn't be necessary
require "guard"

RSpec.describe Guard::Guardfile::Evaluator do
  let(:options) { {} }
  subject { described_class.new(options) }

  let!(:local_guardfile) { Pathname("Guardfile").to_s }
  let!(:home_guardfile) { Pathname("~/.Guardfile").expand_path.to_s }
  let!(:home_config) { Pathname("~/.guard.rb").expand_path.to_s }

  let(:valid_guardfile_string) { "group :foo; do guard :bar; end; end; " }

  let(:dsl) { instance_double("Guard::Dsl") }

  let(:rel_guardfile) do
    Pathname("../relative_path_to_Guardfile").expand_path.to_s
  end

  before do
    allow(Guard::Interactor).to receive(:new).with(false)
    allow(Guard::Dsl).to receive(:new).and_return(dsl)
    allow(dsl).to receive(:instance_eval)
    stub_pathname
  end

  describe ".evaluate" do
    describe "error cases" do
      context "with an invalid Guardfile" do
        let(:options) { { contents: "guard :foo Bad Guardfile" } }

        it "displays an error message and raises original exception" do
          stub_user_guard_rb

          allow(dsl).to receive(:evaluate)
            .and_raise(Guard::Dsl::Error,
                       "Invalid Guardfile, original error is:")

          expect { subject.evaluate }.to raise_error(Guard::Dsl::Error)
        end
      end

      context "with no Guardfile at all" do
        it "displays an error message and exits" do
          stub_guardfile_rb
          stub_guardfile
          stub_user_guardfile
          stub_user_project_guardfile

          expect { subject.evaluate }
            .to raise_error(Guard::Guardfile::Evaluator::NoGuardfileError)
        end
      end

      context "with Guardfile as guardfile.rb" do
        it "evalutates guardfile.rb" do
          stub_guardfile_rb("guard :bar")
          allow(dsl).to receive(:evaluate).with("guard :bar", "", 1)
        end
      end

      context "with a problem reading a Guardfile" do
        let(:path) { File.expand_path("Guardfile") }

        before do
          stub_user_project_guardfile
          stub_guardfile_rb
          stub_guardfile(" ") do
            fail Errno::EACCES.new("permission error")
          end
        end

        it "displays an error message and exits" do
          expect(Guard::UI).to receive(:error).with(/^Error reading file/)
          expect { subject.evaluate }.to raise_error(SystemExit)
        end
      end

      context "with empty Guardfile content" do
        let(:options) { { contents: "" } }

        it "displays an error message about no plugins" do
          stub_user_guard_rb
          stub_guardfile(" ")
          allow(dsl).to receive(:evaluate).with("", "", 1)

          expect { subject.evaluate }
            .to raise_error(Guard::Guardfile::Evaluator::NoPluginsError)
        end
      end

      context "when provided :contents is nil" do
        before do
          # Anything
          stub_guardfile("guard :foo")

          stub_guardfile_rb
          stub_user_guard_rb
          stub_user_project_guardfile
          stub_user_guardfile
        end

        it "does not raise error and skip it" do
          allow(dsl).to receive(:evaluate).with("guard :foo", anything, 1)

          expect(Guard::UI).to_not receive(:error)
          expect do
            described_class.new(contents: nil).evaluate
          end.to_not raise_error
        end
      end

      context "with a non-existing Guardfile given" do
        let(:non_existing_path) { "/non/existing/path/to/Guardfile" }
        let(:options) { { guardfile: non_existing_path } }

        before do
          stub_file(non_existing_path)
        end

        it "raises error" do
          expect { subject.evaluate }
            .to raise_error(Guard::Guardfile::Evaluator::NoCustomGuardfile)
        end
      end
    end

    describe "selection of the Guardfile data contents" do
      context "with a valid :contents option" do
        before do
          stub_user_guard_rb
          allow(dsl).to receive(:evaluate)
        end

        context "with inline content and other Guardfiles available" do
          let(:inline_code) { "guard :foo" }
          let(:options) do
            {
              contents: inline_code,
              guardfile: "/abc/Guardfile"
            }
          end

          before do
            stub_file("/abc/Guardfile", "guard :bar")
            stub_guardfile_rb("guard :baz")
            stub_guardfile("guard :baz")
            stub_user_guardfile("guard :buz")
          end

          it "gives ultimate precedence to inline content" do
            expect(dsl).to receive(:evaluate).with(inline_code, "", 1)
            subject.evaluate
          end
        end
      end

      context "with the :guardfile option" do
        let(:options) { { guardfile: "../relative_path_to_Guardfile" } }

        before do
          stub_file(File.expand_path("../relative_path_to_Guardfile"),
                    valid_guardfile_string)
          allow(dsl).to receive(:evaluate)
            .with(valid_guardfile_string, anything, 1)
        end
      end
    end
  end

  describe "#inline?" do
    before do
      allow(dsl).to receive(:evaluate)
      stub_guardfile("guard :bar")
      stub_guardfile_rb
      stub_user_guard_rb
      subject.evaluate
    end

    context "when guardfile_contents is provided" do
      let(:options) { { guardfile_contents: "guard :foo" } }
      it { is_expected.to be_inline }
    end

    context "when contents is provided" do
      let(:options) { { contents: "guard :foo" } }
      it { is_expected.to be_inline }
    end

    context "when no content is provided" do
      let(:options) { {} }
      it { is_expected.to_not be_inline }
    end
  end

  describe ".guardfile_include?" do
    subject do
      evaluator = described_class.new(options)
      evaluator.evaluate
      evaluator
    end

    let(:dsl_reader) { instance_double(Guard::DslReader) }

    before do
      allow(dsl).to receive(:evaluate)
      allow(Guard::DslReader).to receive(:new).and_return(dsl_reader)
      allow(dsl_reader).to receive(:evaluate)
      stub_user_guard_rb
    end

    context "when plugin is present" do
      let(:options) { { contents: 'guard "test" {watch("c")}' } }

      it "returns true" do
        allow(dsl_reader)
          .to receive(:evaluate).with('guard "test" {watch("c")}', "", 1)

        allow(dsl_reader).to receive(:plugin_names).and_return(["test"])
        expect(subject).to be_guardfile_include("test")
      end
    end

    context "when plugin is not present" do
      let(:options) { { contents: 'guard "other" {watch("c")}' } }

      it "returns false" do
        allow(dsl_reader)
          .to receive(:evaluate).with('guard "test" {watch("c")}', "", 1)

        allow(dsl_reader).to receive(:plugin_names).and_return(["other"])
        expect(subject).to_not be_guardfile_include("test")
      end
    end
  end
end