tty-file 0.6.0 → 0.7.0

data/spec/unit/diff_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#diff' do
+  it "diffs two files" do
+    file_a = tmp_path('diff/file_a')
+    file_b = tmp_path('diff/file_b')
+
+    diff = TTY::File.diff(file_a, file_b, verbose: false)
+
+    expect(diff).to eq(strip_heredoc(<<-EOS
+      @@ -1,4 +1,4 @@
+       aaa
+      -bbb
+      +xxx
+       ccc
+    EOS
+    ))
+  end
+
+  it "diffs identical files" do
+    src_a = tmp_path('diff/file_a')
+
+    expect(TTY::File.diff(src_a, src_a, verbose: false)).to eq('')
+  end
+
+  it "diffs a file and a string" do
+    src_a = tmp_path('diff/file_a')
+    src_b = "aaa\nxxx\nccc\n"
+
+    diff = TTY::File.diff(src_a, src_b, verbose: false)
+
+    expect(diff).to eq(strip_heredoc(<<-EOS
+      @@ -1,4 +1,4 @@
+       aaa
+      -bbb
+      +xxx
+       ccc
+    EOS
+    ))
+  end
+
+  it "diffs two strings" do
+    file_a = "aaa\nbbb\nccc\n"
+    file_b = "aaa\nxxx\nccc\n"
+
+    diff = TTY::File.diff(file_a, file_b, verbose: false)
+
+    expect(diff).to eq(strip_heredoc(<<-EOS
+      @@ -1,4 +1,4 @@
+       aaa
+      -bbb
+      +xxx
+       ccc
+    EOS
+    ))
+  end
+
+  it "logs status" do
+    file_a = tmp_path('diff/file_a')
+    file_b = tmp_path('diff/file_b')
+
+    expect {
+      TTY::File.diff_files(file_a, file_b, verbose: true)
+    }.to output(%r{diff(.*)/diff/file_a(.*)/diff/file_b}).to_stdout_from_any_process
+  end
+
+  it "doesn't diff files when :noop option is given" do
+    file_a = tmp_path('diff/file_a')
+    file_b = tmp_path('diff/file_b')
+
+    diff = TTY::File.diff(file_a, file_b, verbose: false, noop: true)
+
+    expect(diff).to eq('')
+  end
+
+  it "doesn't diff if first file is too large" do
+    file_a = tmp_path('diff/file_a')
+    file_b = tmp_path('diff/file_b')
+
+    expect {
+      TTY::File.diff(file_a, file_b, threshold: 10)
+    }.to raise_error(ArgumentError, /file size of (.*) exceeds 10 bytes/)
+  end
+
+  it "doesn't diff binary files" do
+    file_a = tmp_path('blackhole.png')
+    file_b = tmp_path('diff/file_b')
+
+    expect {
+      TTY::File.diff(file_a, file_b)
+    }.to raise_error(ArgumentError, /is binary, diff output suppressed/)
+  end
+end

data/spec/unit/differ/call_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File::Differ, '#call' do
+  it "diffs identical content" do
+    string_a = "aaa bbb ccc"
+
+    diff = TTY::File::Differ.new(string_a, string_a).call
+
+    expect(diff).to eq('')
+  end
+
+  it "diffs two files with single line content" do
+    string_a = "aaa bbb ccc"
+    string_b = "aaa xxx ccc"
+
+    diff = TTY::File::Differ.new(string_a, string_b).call
+
+    expect(diff).to eq(strip_heredoc(<<-EOS
+      @@ -1,2 +1,2 @@
+      -aaa bbb ccc
+      +aaa xxx ccc
+    EOS
+    ))
+  end
+
+  it "diffs two files with multi line content" do
+    string_a = "aaa\nbbb\nccc\nddd\neee\nfff\nggg\nhhh\niii\njjj\nkkk\nlll\n"
+    string_b = "aaa\nbbb\nzzz\nddd\neee\nfff\nggg\nhhh\niii\njjj\nwww\n"
+
+    diff = TTY::File::Differ.new(string_a, string_b).call
+
+    expect(diff).to eq(strip_heredoc(<<-EOS
+      @@ -1,6 +1,6 @@
+       aaa
+       bbb
+      -ccc
+      +zzz
+       ddd
+       eee
+       fff
+      @@ -8,6 +8,5 @@
+       hhh
+       iii
+       jjj
+      -kkk
+      -lll
+      +www
+    EOS
+    ))
+  end
+
+  it "handles differently encoded files" do
+    string_a = "wikipedia".encode('us-ascii')
+    string_b = "ウィキペディア".encode('UTF-8')
+
+    diff = TTY::File::Differ.new(string_a, string_b).call
+
+    expect(diff).to eq(strip_heredoc(<<-EOS
+      @@ -1,2 +1,2 @@
+      -wikipedia
+      +ウィキペディア
+    EOS
+    ))
+  end
+
+  it "accepts format" do
+    string_a = "aaa\nbbb\nccc\n"
+    string_b = "aaa\nxxx\nccc\n"
+
+    diff = TTY::File::Differ.new(string_a, string_b, format: :old).call
+
+    expect(diff).to eq(strip_heredoc(<<-EOS
+      1,4c1,4
+      < aaa
+      < bbb
+      < ccc
+      ---
+      > aaa
+      > xxx
+      > ccc
+
+    EOS
+    ))
+  end
+
+  it "accepts context lines" do
+    string_a = "aaa\nbbb\nccc\nddd\neee\nfff"
+    string_b = "aaa\nbbb\nccc\nddd\nxxx\nfff"
+
+    diff = TTY::File::Differ.new(string_a, string_b, context_lines: 1).call
+
+    expect(diff).to eq(strip_heredoc(<<-EOS
+      @@ -4,3 +4,3 @@
+       ddd
+      -eee
+      +xxx
+       fff
+    EOS
+    ))
+  end
+end

data/spec/unit/download_file_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#download_file' do
+  it "downloads a file from remote uri" do
+    body = "##Header1\nCopy text.\n"
+    stub_request(:get, "https://example.com/README.md").to_return(body: body)
+    path = tmp_path('doc/README.md')
+
+    TTY::File.download_file('https://example.com/README.md', path, verbose: false)
+
+    expect(File.read(path)).to eq(body)
+  end
+
+  it "yields content from remoe uri" do
+    body = "##Header1\nCopy text.\n"
+    stub_request(:get, "https://example.com/README.md").to_return(body: body)
+    path = tmp_path('doc/README.md')
+
+    TTY::File.download_file('https://example.com/README.md', path, verbose: false) do |content|
+      expect(a_request(:get, 'https://example.com/README.md')).to have_been_made
+      expect(content).to eq(body)
+    end
+  end
+
+  it "logs file operation" do
+    body = "##Header1\nCopy text.\n"
+    stub_request(:get, "https://example.com/README.md").to_return(body: body)
+    path = tmp_path('doc/README.md')
+
+    expect {
+      TTY::File.download_file('https://example.com/README.md', path)
+    }.to output(/create(.*)doc\/README.md/).to_stdout_from_any_process
+  end
+
+  it "specifies limit on redirects" do
+    stub_request(:get, "https://example.com/wrong").to_return(status: 302, headers: { location: 'https://example.com/wrong_again'})
+    stub_request(:get, "https://example.com/wrong_again").to_return(status: 302, headers: { location: 'https://example.com/README.md'})
+
+    path = tmp_path('doc/README.md')
+
+    expect {
+      TTY::File.download_file('https://example.com/wrong', path, verbose: false, limit: 1)
+    }.to raise_error(TTY::File::DownloadError)
+  end
+
+  it "copies the file from relative location if not URI" do
+    src_path  = tmp_path('Gemfile')
+    dest_path = tmp_path('app/Gemfile')
+
+    TTY::File.get_file(src_path, dest_path, verbose: false)
+
+    exists_and_identical?('Gemfile', 'app/Gemfile')
+  end
+end

data/spec/unit/escape_glob_path_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#escape_glob_path' do
+  {
+    "foo?" => "foo\\?",
+    "*foo" => "\\*foo",
+    "foo[bar]" => "foo\\[bar\\]",
+    "foo{bar}" => "foo\\{bar\\}"
+  }.each do |glob, escaped_glob|
+    it "escapes #{glob} to #{escaped_glob}" do
+      expect(TTY::File.escape_glob_path(glob)).to eq(escaped_glob)
+    end
+  end
+end

data/spec/unit/inject_into_file_spec.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#inject_into_file' do
+  it "injects content into file :before" do
+    file = tmp_path('Gemfile')
+    TTY::File.inject_into_file(file, "gem 'tty'\n",
+      before: "gem 'rack', '>=1.0'\n", verbose: false)
+
+    expect(File.read(file)).to eq([
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'tty'\n",
+      "gem 'rack', '>=1.0'\n",
+    ].join)
+  end
+
+  it "injects content into file :after" do
+    file = tmp_path('Gemfile')
+
+    expect {
+      TTY::File.inject_into_file(file, "gem 'tty'", after: "gem 'rack', '>=1.0'\n")
+    }.to output(/inject/).to_stdout_from_any_process
+
+    expect(File.read(file)).to eq([
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+      "gem 'tty'"
+    ].join)
+  end
+
+  it "accepts content in block" do
+    file = tmp_path('Gemfile')
+
+    expect {
+      TTY::File.insert_into_file(file, after: "gem 'rack', '>=1.0'\n") do
+        "gem 'tty'"
+      end
+    }.to output(/inject/).to_stdout_from_any_process
+
+    expect(File.read(file)).to eq([
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+      "gem 'tty'"
+    ].join)
+  end
+
+  it "accepts many lines" do
+    file = tmp_path('Gemfile')
+
+    TTY::File.inject_into_file(file, "gem 'tty'\n", "gem 'loaf'",
+      after: "gem 'rack', '>=1.0'\n", verbose: false)
+
+    expect(File.read(file)).to eq([
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+      "gem 'tty'\n",
+      "gem 'loaf'"
+    ].join)
+  end
+
+  it "logs action" do
+    file = tmp_path('Gemfile')
+
+    expect {
+    TTY::File.inject_into_file(file, "gem 'tty'\n", "gem 'loaf'",
+      after: "gem 'rack', '>=1.0'\n", verbose: true)
+    }.to output(/\e\[32minject.*Gemfile/).to_stdout_from_any_process
+  end
+
+  it "logs action without color" do
+    file = tmp_path('Gemfile')
+
+    expect {
+    TTY::File.inject_into_file(file, "gem 'tty'\n", "gem 'loaf'",
+      after: "gem 'rack', '>=1.0'\n", verbose: true, color: false)
+    }.to output(/\s+inject.*Gemfile/).to_stdout_from_any_process
+  end
+
+  it "doesn't inject new content if already present" do
+    file = tmp_path('Gemfile')
+    TTY::File.inject_into_file(file, "gem 'tty'",
+                               after: "gem 'rack', '>=1.0'\n", verbose: false)
+
+    expect(File.read(file)).to eq([
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+      "gem 'tty'"
+    ].join)
+
+    TTY::File.inject_into_file(file, "gem 'tty'",
+                               after: "gem 'rack', '>=1.0'\n",
+                               force: false, verbose: false)
+
+    expect(File.read(file)).to eq([
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+      "gem 'tty'"
+    ].join)
+  end
+
+  it "checks if a content can be safely injected" do
+    file = tmp_path('Gemfile')
+    TTY::File.safe_inject_into_file(file, "gem 'tty'",
+                                    after: "gem 'rack', '>=1.0'\n", verbose: false)
+    expect(::File.read(file)).to eq([
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+      "gem 'tty'"
+    ].join)
+  end
+
+  it "changes content already present if :force flag is true" do
+    file = tmp_path('Gemfile')
+
+    TTY::File.inject_into_file(file, "gem 'tty'\n",
+      before: "gem 'nokogiri'", verbose: false)
+
+    expect(File.read(file)).to eq([
+      "gem 'tty'\n",
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+    ].join)
+
+    TTY::File.inject_into_file(file, "gem 'tty'\n",
+      before: "gem 'nokogiri'", verbose: false, force: true)
+
+    expect(File.read(file)).to eq([
+      "gem 'tty'\n",
+      "gem 'tty'\n",
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+    ].join)
+  end
+
+  it "fails to inject into non existent file" do
+    file = tmp_path('unknown')
+
+    expect {
+      TTY::File.inject_into_file(file, "gem 'tty'", after: "gem 'rack', '>=1.0'\n")
+    }.to raise_error(ArgumentError, /File path (.)* does not exist/)
+  end
+
+  it "doesn't change content when :noop flag is true" do
+    file = tmp_path('Gemfile')
+    TTY::File.inject_into_file(file, "gem 'tty'\n",
+      before: "gem 'nokogiri'", verbose: false, noop: true)
+
+    expect(File.read(file)).to eq([
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+    ].join)
+  end
+end

data/spec/unit/prepend_to_file_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#prepend_to_file' do
+  it "appends to file" do
+    file = tmp_path('Gemfile')
+    result = TTY::File.prepend_to_file(file, "gem 'tty'\n", verbose: false)
+    expect(result).to eq(true)
+    expect(File.read(file)).to eq([
+      "gem 'tty'\n",
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+    ].join)
+  end
+
+  it "prepends multiple lines to file" do
+    file = tmp_path('Gemfile')
+    TTY::File.prepend_to_file(file, "gem 'tty'\n", "gem 'rake'\n", verbose: false)
+    expect(File.read(file)).to eq([
+      "gem 'tty'\n",
+      "gem 'rake'\n",
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+    ].join)
+  end
+
+  it "prepends content in a block" do
+    file = tmp_path('Gemfile')
+    TTY::File.prepend_to_file(file, verbose: false) { "gem 'tty'\n"}
+    expect(File.read(file)).to eq([
+      "gem 'tty'\n",
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+    ].join)
+  end
+
+  it "doesn't prepend if already present" do
+    file = tmp_path('Gemfile')
+    TTY::File.prepend_to_file(file, "gem 'nokogiri'\n", force: false, 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 "checks if a content can be safely prepended" do
+    file = tmp_path('Gemfile')
+    TTY::File.safe_prepend_to_file(file, "gem 'nokogiri'\n", 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 prepend if already present for multiline content" do
+    file = tmp_path('Gemfile')
+    TTY::File.prepend_to_file(file, "gem 'nokogiri'\n", verbose: false)
+    TTY::File.prepend_to_file(file, "gem 'nokogiri'\n", "gem 'nokogiri'\n", force: false, verbose: false)
+    expect(::File.read(file)).to eq([
+      "gem 'nokogiri'\n",
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n",
+    ].join)
+  end
+
+  it "prepends multiple times if forced" do
+    file = tmp_path('Gemfile')
+    TTY::File.prepend_to_file(file, "gem 'nokogiri'\n", force: true, verbose: false)
+    TTY::File.prepend_to_file(file, "gem 'nokogiri'\n", "gem 'nokogiri'\n", force: true, verbose: false)
+    expect(::File.read(file)).to eq([
+      "gem 'nokogiri'\n",
+      "gem 'nokogiri'\n",
+      "gem 'nokogiri'\n",
+      "gem 'nokogiri'\n",
+      "gem 'rails', '5.0.0'\n",
+      "gem 'rack', '>=1.0'\n"
+    ].join)
+  end
+
+  it "logs action" do
+    file = tmp_path('Gemfile')
+    expect {
+      TTY::File.prepend_to_file(file, "gem 'tty'")
+    }.to output(/\e\[32mprepend\e\[0m.*Gemfile/).to_stdout_from_any_process
+  end
+
+  it "logs action without color" do
+    file = tmp_path('Gemfile')
+    expect {
+      TTY::File.prepend_to_file(file, "gem 'tty'", color: false)
+    }.to output(/\s+prepend.*Gemfile/).to_stdout_from_any_process
+  end
+end