tty-file 0.7.0 → 0.7.1

data/spec/unit/remove_file_spec.rb

@@ -1,53 +1,67 @@
 # frozen_string_literal: true
 
 RSpec.describe TTY::File, '#remove_file' do
-  it "removes a given file", unless: RSpec::Support::OS.windows? do
-    src_path = tmp_path('Gemfile')
+  shared_context "removing a file" do
+    it "removes a given file", unless: RSpec::Support::OS.windows? do
+      src_path = path_factory.call('Gemfile')
 
-    TTY::File.remove_file(src_path, verbose: false)
+      TTY::File.remove_file(src_path, verbose: false)
 
-    expect(::File.exist?(src_path)).to be(false)
-  end
+      expect(::File.exist?(src_path)).to be(false)
+    end
 
-  it "removes a directory" do
-    src_path = tmp_path('templates')
+    it "removes a directory" do
+      src_path = path_factory.call('templates')
 
-    TTY::File.remove_file(src_path, verbose: false)
+      TTY::File.remove_file(src_path, verbose: false)
 
-    expect(::File.exist?(src_path)).to be(false)
-  end
+      expect(::File.exist?(src_path)).to be(false)
+    end
 
-  it "pretends removing file" do
-    src_path = tmp_path('Gemfile')
+    it "pretends removing file" do
+      src_path = path_factory.call('Gemfile')
 
-    TTY::File.remove_file(src_path, noop: true, verbose: false)
+      TTY::File.remove_file(src_path, noop: true, verbose: false)
 
-    expect(::File.exist?(src_path)).to be(true)
-  end
+      expect(::File.exist?(src_path)).to be(true)
+    end
+
+    it "removes files in secure mode" do
+      src_path = path_factory.call('Gemfile')
+      allow(::FileUtils).to receive(:rm_r)
+
+      TTY::File.remove_file(src_path, verbose: false, secure: false)
+
+      expect(::FileUtils).to have_received(:rm_r).
+        with(src_path.to_s, force: nil, secure: false)
+    end
+
+    it "logs status" do
+      src_path = path_factory.call('Gemfile')
 
-  it "removes files in secure mode" do
-    src_path = tmp_path('Gemfile')
-    allow(::FileUtils).to receive(:rm_r)
+      expect {
+        TTY::File.remove_file(src_path, noop: true)
+      }.to output(/\e\[31mremove\e\[0m(.*)Gemfile/).to_stdout_from_any_process
+    end
 
-    TTY::File.remove_file(src_path, verbose: false, secure: false)
+    it "logs status without color" do
+      src_path = path_factory.call('Gemfile')
 
-    expect(::FileUtils).to have_received(:rm_r).
-      with(src_path.to_s, force: nil, secure: false)
+      expect {
+        TTY::File.remove_file(src_path, noop: true, color: false)
+      }.to output(/\s+remove(.*)Gemfile/).to_stdout_from_any_process
+    end
   end
 
-  it "logs status" do
-    src_path = tmp_path('Gemfile')
+  context "when passed a String instance for the file argument" do
+    let(:path_factory) { method(:tmp_path) }
 
-    expect {
-      TTY::File.remove_file(src_path, noop: true)
-    }.to output(/\e\[31mremove\e\[0m(.*)Gemfile/).to_stdout_from_any_process
+    include_context "removing a file"
   end
 
-  it "logs status without color" do
-    src_path = tmp_path('Gemfile')
+  context "when passed a Pathname instance for the file argument" do
+    let(:path_factory) { method(:tmp_pathname) }
 
-    expect {
-      TTY::File.remove_file(src_path, noop: true, color: false)
-    }.to output(/\s+remove(.*)Gemfile/).to_stdout_from_any_process
+    include_context "removing a file"
   end
 end

data/spec/unit/replace_in_file_spec.rb

@@ -1,126 +1,140 @@
 # frozen_string_literal: true
 
 RSpec.describe TTY::File, '#replace_in_file' do
-  it "replaces file content with a matching string" do
-    file = tmp_path('Gemfile')
-    status = nil
-    expect {
-      status = TTY::File.replace_in_file(file, /gem 'rails'/, "gem 'hanami'")
-    }.to output(/replace/).to_stdout_from_any_process
-
-    expect(status).to eq(true)
-    expect(File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'hanami', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n"
-    ].join)
-  end
-
-  it "replaces file content with a matching block value" do
-    file = tmp_path('Gemfile')
-    status = nil
-    expect {
-      status =TTY::File.replace_in_file(file, /gem 'rails'/, verbose: false) do |match|
-        match = "gem 'hanami'"
-      end
-    }.to_not output(/replace/).to_stdout_from_any_process
-
-    expect(status).to eq(true)
-    expect(File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'hanami', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n"
-    ].join)
-  end
+  shared_context "replacing in a file" do
+    it "replaces file content with a matching string" do
+      file = path_factory.call('Gemfile')
+      status = nil
+      expect {
+        status = TTY::File.replace_in_file(file, /gem 'rails'/, "gem 'hanami'")
+      }.to output(/replace/).to_stdout_from_any_process
+
+      expect(status).to eq(true)
+      expect(File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'hanami', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n"
+      ].join)
+    end
+
+    it "replaces file content with a matching block value" do
+      file = path_factory.call('Gemfile')
+      status = nil
+      expect {
+        status =TTY::File.replace_in_file(file, /gem 'rails'/, verbose: false) do |match|
+          match = "gem 'hanami'"
+        end
+      }.to_not output(/replace/).to_stdout_from_any_process
+
+      expect(status).to eq(true)
+      expect(File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'hanami', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n"
+      ].join)
+    end
+
+    it "doesn't match file content" do
+      file = path_factory.call('Gemfile')
+      content = ::File.read(file)
+      status = TTY::File.replace_in_file(file, /unknown/, 'Hello', verbose: false)
+
+      expect(status).to eq(false)
+      expect(::File.read(file)).to eq(content)
+    end
+
+    it "silences verbose output" do
+      content = "gem 'hanami'"
+      file = path_factory.call('Gemfile')
+      expect {
+        TTY::File.replace_in_file(file, /gem 'rails'/, content, verbose: false)
+      }.to_not output(/replace/).to_stdout_from_any_process
+    end
+
+    it "fails to replace content when missing correct file path" do
+      expect {
+        TTY::File.replace_in_file(path_factory.call('non-existent-path'),
+          /gem 'rails'/, "gem 'hanami'", verbose: false)
+      }.to raise_error(ArgumentError, /File path (.)* does not exist/)
+    end
+
+    it "logs action" do
+      content = "gem 'hanami'"
+      file = path_factory.call('Gemfile')
+
+      expect {
+        TTY::File.replace_in_file(file, /gem 'rails'/, content, noop: true)
+      }.to output(/\e\[32mreplace\e\[0m(.*)Gemfile/).to_stdout_from_any_process
+    end
+
+    it "logs action without color" do
+      content = "gem 'hanami'"
+      file = path_factory.call('Gemfile')
+
+      expect {
+        TTY::File.replace_in_file(file, /gem 'rails'/, content,
+                                  noop: true, color: false)
+      }.to output(/\s+replace(.*)Gemfile/).to_stdout_from_any_process
+    end
+
+    it "allows for noop run" do
+      content = "gem 'hanami'"
+      file = path_factory.call('Gemfile')
 
-  it "doesn't match file content" do
-    file = tmp_path('Gemfile')
-    content = ::File.read(file)
-    status = TTY::File.replace_in_file(file, /unknown/, 'Hello', verbose: false)
-
-    expect(status).to eq(false)
-    expect(::File.read(file)).to eq(content)
-  end
-
-  it "silences verbose output" do
-    content = "gem 'hanami'"
-    file = tmp_path('Gemfile')
-    expect {
-      TTY::File.replace_in_file(file, /gem 'rails'/, content, verbose: false)
-    }.to_not output(/replace/).to_stdout_from_any_process
-  end
-
-  it "fails to replace content when missing correct file path" do
-    expect {
-      TTY::File.replace_in_file('/non-existent-path',
-        /gem 'rails'/, "gem 'hanami'", verbose: false)
-    }.to raise_error(ArgumentError, /File path (.)* does not exist/)
-  end
-
-  it "logs action" do
-    content = "gem 'hanami'"
-    file = tmp_path('Gemfile')
-
-    expect {
-      TTY::File.replace_in_file(file, /gem 'rails'/, content, noop: true)
-    }.to output(/\e\[32mreplace\e\[0m(.*)Gemfile/).to_stdout_from_any_process
-  end
-
-  it "logs action without color" do
-    content = "gem 'hanami'"
-    file = tmp_path('Gemfile')
-
-    expect {
       TTY::File.replace_in_file(file, /gem 'rails'/, content,
-                                noop: true, color: false)
-    }.to output(/\s+replace(.*)Gemfile/).to_stdout_from_any_process
+                                noop: true, verbose: false)
+
+      expect(File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'rails', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n"
+      ].join)
+    end
+
+    it "doesn't replace content when no match found" do
+      content = "gem 'hanami'"
+      file = path_factory.call('Gemfile')
+
+      status = TTY::File.gsub_file(file, /gem 'rails'/, content, verbose: false)
+      expect(status).to eq(true)
+      expect(File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'hanami', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n"
+      ].join)
+
+      status = TTY::File.gsub_file(file, /gem 'rails'/, content, verbose: false)
+      expect(status).to eq(false)
+
+      expect(File.read(file)).to eq([
+        "gem 'nokogiri'\n",
+        "gem 'hanami', '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n"
+      ].join)
+    end
+
+    it "replaces with multibyte content" do
+      content = "gem 'ようこそ'"
+      file = path_factory.call('Gemfile')
+
+      TTY::File.gsub_file(file, /gem 'rails'/, content, verbose: false)
+      expect(File.open(file, 'r:UTF-8', &:read)).to eq([
+        "gem 'nokogiri'\n",
+        "#{content}, '5.0.0'\n",
+        "gem 'rack', '>=1.0'\n"
+      ].join)
+    end
   end
 
-  it "allows for noop run" do
-    content = "gem 'hanami'"
-    file = tmp_path('Gemfile')
-
-    TTY::File.replace_in_file(file, /gem 'rails'/, content,
-                              noop: true, verbose: false)
-
-    expect(File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'rails', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n"
-    ].join)
-  end
+  context "when passed a String instance for the file argument" do
+    let(:path_factory) { method(:tmp_path) }
 
-  it "doesn't replace content when no match found" do
-    content = "gem 'hanami'"
-    file = tmp_path('Gemfile')
-
-    status = TTY::File.gsub_file(file, /gem 'rails'/, content, verbose: false)
-    expect(status).to eq(true)
-    expect(File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'hanami', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n"
-    ].join)
-
-    status = TTY::File.gsub_file(file, /gem 'rails'/, content, verbose: false)
-    expect(status).to eq(false)
-
-    expect(File.read(file)).to eq([
-      "gem 'nokogiri'\n",
-      "gem 'hanami', '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n"
-    ].join)
+    include_context "replacing in a file"
   end
 
-  it "replaces with multibyte content" do
-    content = "gem 'ようこそ'"
-    file = tmp_path('Gemfile')
+  context "when passed a Pathname instance for the file argument" do
+    let(:path_factory) { method(:tmp_pathname) }
 
-    TTY::File.gsub_file(file, /gem 'rails'/, content, verbose: false)
-    expect(File.open(file, 'r:UTF-8', &:read)).to eq([
-      "gem 'nokogiri'\n",
-      "#{content}, '5.0.0'\n",
-      "gem 'rack', '>=1.0'\n"
-    ].join)
+    include_context "replacing in a file"
   end
 end

data/spec/unit/tail_file_spec.rb

@@ -1,63 +1,77 @@
 # frozen_string_literal: true
 
 RSpec.describe TTY::File, '#tail_file' do
-  it "tails file for lines with chunks smaller than file size" do
-    file = tmp_path('tail/lines')
-
-    lines = TTY::File.tail_file(file, 5, chunk_size: 2**3)
-
-    expect(lines).to eq([
-      "line12",
-      "line13",
-      "line14",
-      "line15",
-      "line16"
-    ])
-  end
+  shared_context "tailing a file" do
+    it "tails file for lines with chunks smaller than file size" do
+      file = path_factory.call('tail/lines')
 
-  it "tails file for lines with chunks equal file size" do
-    file = tmp_path('tail/lines')
+      lines = TTY::File.tail_file(file, 5, chunk_size: 2**3)
 
-    lines = TTY::File.tail_file(file, 5, chunk_size: file.size)
+      expect(lines).to eq([
+        "line12",
+        "line13",
+        "line14",
+        "line15",
+        "line16"
+      ])
+    end
 
-    expect(lines).to eq([
-      "line12",
-      "line13",
-      "line14",
-      "line15",
-      "line16"
-    ])
+    it "tails file for lines with chunks equal file size" do
+      file = path_factory.call('tail/lines')
 
-  end
+      lines = TTY::File.tail_file(file, 5, chunk_size: file.size)
 
-  it "tails file for lines with chunks larger than file size" do
-    file = tmp_path('tail/lines')
+      expect(lines).to eq([
+        "line12",
+        "line13",
+        "line14",
+        "line15",
+        "line16"
+      ])
 
-    lines = TTY::File.tail_file(file, 5, chunk_size: 2**9)
+    end
 
-    expect(lines).to eq([
-      "line12",
-      "line13",
-      "line14",
-      "line15",
-      "line16"
-    ])
-  end
+    it "tails file for lines with chunks larger than file size" do
+      file = path_factory.call('tail/lines')
+
+      lines = TTY::File.tail_file(file, 5, chunk_size: 2**9)
+
+      expect(lines).to eq([
+        "line12",
+        "line13",
+        "line14",
+        "line15",
+        "line16"
+      ])
+    end
+
+    it "tails file and yields lines" do
+      file = path_factory.call('tail/lines')
+      lines = []
 
-  it "tails file and yields lines" do
-    file = tmp_path('tail/lines')
-    lines = []
+      TTY::File.tail_file(file, 5, chunk_size: 8) do |line|
+        lines << line
+      end
 
-    TTY::File.tail_file(file, 5, chunk_size: 8) do |line|
-      lines << line
+      expect(lines).to eq([
+        "line12",
+        "line13",
+        "line14",
+        "line15",
+        "line16"
+      ])
     end
+  end
+
+  context "when passed a String instance for the file argument" do
+    let(:path_factory) { method(:tmp_path) }
+
+    include_context "tailing a file"
+  end
+
+  context "when passed a Pathname instance for the file argument" do
+    let(:path_factory) { method(:tmp_pathname) }
 
-    expect(lines).to eq([
-      "line12",
-      "line13",
-      "line14",
-      "line15",
-      "line16"
-    ])
+    include_context "tailing a file"
   end
 end