DRYing up API

Author: jarl-dk

lib/aruba/api.rb

@@ -362,43 +362,36 @@ def with_file_content(file, &block)
     # @param [String] file
     #   The file to be checked
     #
-    # @param [String] partial_content
-    #   The content which must/must not be in the file
+    # @param [String, Regexp] content
+    #   The content which must/must not be in the file. If content is
+    #   a String exact match is done, if content is a Regexp then file
+    #   is matched using regular expression
     #
     # @param [true, false] expect_match
     #   Must the content be in the file or not
-    def check_file_content(file, partial_content, expect_match = true)
-      regexp = regexp(partial_content)
+    def check_file_content(file, content, expect_match = true)
+      match_content =
+        if(Regexp === content)
+          match(content)
+        else
+          eq(content)
+        end
       prep_for_fs_check do
         content = IO.read(File.expand_path(file))
-
         if expect_match
-          expect(content).to match regexp
+          expect(content).to match_content
         else
-          expect(content).not_to match regexp
+          expect(content).not_to match_content
         end
       end
     end
 
-    # Check if the exact content can be found in file
-    #
-    # @param [String] file
-    #   The file to be checked
-    #
-    # @param [String] exact_content_or_file
-    #   The content of the file or an IO
-    #
-    # @param [true, false] expect_match
-    #   Must the content be in the file or not
+    # @private
+    # @deprecated
     def check_exact_file_content(file, exact_content, expect_match = true)
-      prep_for_fs_check do
-        content = IO.read(File.expand_path(file))
-        if expect_match
-          expect(content).to eq exact_content
-        else
-          expect(content).not_to eq exact_content
-        end
-      end
+      warn('The use of "check_exact_file_content" is deprecated. Use "#check_file_content" with a string instead instead.')
+
+      check_file_content(file, exact_content, expect_match = true)
     end
 
     # Check if the content of file against the content of a reference file
@@ -476,10 +469,6 @@ def unescape(string)
       string
     end
 
-    def regexp(string_or_regexp)
-      Regexp === string_or_regexp ? string_or_regexp : Regexp.compile(Regexp.escape(string_or_regexp))
-    end
-
     # Fetch output (stdout, stderr) from command
     #
     # @param [String] cmd

lib/aruba/cucumber.rb

@@ -332,36 +332,24 @@
   check_directory_presence(directories.raw.map{|directory_row| directory_row[0]}, false)
 end
 
-Then /^a directory named "([^"]*)" should exist$/ do |directory|
-  check_directory_presence([directory], true)
+Then /^a directory named "([^"]*)" should (not )?exist$/ do |directory, expect_match|
+  check_directory_presence([directory], !expect_match)
 end
 
-Then /^a directory named "([^"]*)" should not exist$/ do |directory|
-  check_directory_presence([directory], false)
+Then /^the file "([^"]*)" should (not )?contain "([^"]*)"$/ do |file, expect_match, partial_content|
+  check_file_content(file, Regexp.compile(Regexp.escape(partial_content)), !expect_match)
 end
 
-Then /^the file "([^"]*)" should contain "([^"]*)"$/ do |file, partial_content|
-  check_file_content(file, partial_content, true)
+Then /^the file "([^"]*)" should (not )?contain:$/ do |file, expect_match, partial_content|
+  check_file_content(file, Regexp.compile(Regexp.escape(partial_content)), !expect_match)
 end
 
-Then /^the file "([^"]*)" should not contain "([^"]*)"$/ do |file, partial_content|
-  check_file_content(file, partial_content, false)
+Then /^the file "([^"]*)" should (not )?contain exactly:$/ do |file, expect_match, exact_content|
+  check_file_content(file, exact_content, !expect_match)
 end
 
-Then /^the file "([^"]*)" should contain:$/ do |file, partial_content|
-  check_file_content(file, partial_content, true)
-end
-
-Then /^the file "([^"]*)" should contain exactly:$/ do |file, exact_content|
-  check_exact_file_content(file, exact_content)
-end
-
-Then /^the file "([^"]*)" should match \/([^\/]*)\/$/ do |file, partial_content|
-  check_file_content(file, /#{partial_content}/, true)
-end
-
-Then /^the file "([^"]*)" should not match \/([^\/]*)\/$/ do |file, partial_content|
-  check_file_content(file, /#{partial_content}/, false)
+Then /^the file "([^"]*)" should (not )?match \/([^\/]*)\/$/ do |file, expect_match, partial_content|
+  check_file_content(file, /#{partial_content}/, !expect_match)
 end
 
 Then /^the file "([^"]*)" should (not )?be equal to file "([^"]*)"/ do |file, expect_match, reference_file|

spec/aruba/api_spec.rb

@@ -316,26 +316,53 @@ def announce_or_puts(*args)
       end
     end
 
-    context "#check_file_content" do
-      before :each do
+    context "check file content" do
+      before :example do
         @aruba.write_file(@file_name, "foo bar baz")
       end
 
-      it "succeeds if file content matches" do
-        @aruba.check_file_content(@file_name, "foo bar baz")
-        @aruba.check_file_content(@file_name, "foo bar baz", true)
-      end
+      context "#check_file_content" do
+        context "with regexp" do
+          let(:matching_content){/bar/}
+          let(:non_matching_content){/nothing/}
+          it "succeeds if file content matches" do
+            @aruba.check_file_content(@file_name, matching_content)
+            @aruba.check_file_content(@file_name, matching_content, true)
+          end
 
-      it "succeeds if file content does not match" do
-        @aruba.check_file_content(@file_name, "hello world", false)
-      end
+          it "succeeds if file content does not match" do
+            @aruba.check_file_content(@file_name, non_matching_content, false)
+          end
 
-      it "works with ~ in path name" do
-        file_path = File.join('~', random_string)
+          it "works with ~ in path name" do
+            file_path = File.join('~', random_string)
 
-        with_env 'HOME' => File.expand_path(current_dir) do
-          @aruba.write_file(file_path, "foo bar baz")
-          @aruba.check_file_content(file_path, "hello world", false)
+            with_env 'HOME' => File.expand_path(current_dir) do
+              @aruba.write_file(file_path, "foo bar baz")
+              @aruba.check_file_content(file_path, non_matching_content, false)
+            end
+          end
+        end
+        context "with string" do
+          let(:matching_content){"foo bar baz"}
+          let(:non_matching_content){"bar"}
+          it "succeeds if file content matches" do
+            @aruba.check_file_content(@file_name, matching_content)
+            @aruba.check_file_content(@file_name, matching_content, true)
+          end
+
+          it "succeeds if file content does not match" do
+            @aruba.check_file_content(@file_name, non_matching_content, false)
+          end
+
+          it "works with ~ in path name" do
+            file_path = File.join('~', random_string)
+
+            with_env 'HOME' => File.expand_path(current_dir) do
+              @aruba.write_file(file_path, "foo bar baz")
+              @aruba.check_file_content(file_path, non_matching_content, false)
+            end
+          end
         end
       end
     end