tty-file 0.6.0 → 0.7.0

data/spec/fixtures/templates/unit_test.rb

@@ -0,0 +1 @@
+class <%= class_name %>Test; end

data/spec/spec_helper.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+if ENV['COVERAGE'] || ENV['TRAVIS']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
+require 'tty/file'
+require 'find'
+require "webmock/rspec"
+
+module Helpers
+  def gem_root
+    ::File.join(File.dirname(__FILE__), "..")
+  end
+
+  def dir_path(*args)
+    path = ::File.join(gem_root, *args)
+    ::FileUtils.mkdir_p(path) unless ::File.exist?(path)
+    ::File.realpath(path)
+  end
+
+  def fixtures_path(filename = nil)
+    ::File.join(dir_path('spec', 'fixtures'), filename.to_s)
+  end
+
+  def tmp_path(filename = nil)
+    ::File.join(dir_path('tmp'), filename.to_s)
+  end
+
+  def exists_and_identical?(source, dest)
+    dest_path = tmp_path(dest)
+    expect(::File.exist?(dest_path)).to be(true)
+
+    source_path = fixtures_path(source)
+    expect(::FileUtils).to be_identical(source_path, dest_path)
+  end
+
+  def strip_heredoc(content)
+    indent = content.scan(/^[ \t]*(?=\S)/).min.size || 0
+    content.gsub(/^[ \t]{#{indent}}/, '')
+  end
+end
+
+RSpec.configure do |config|
+  config.include(Helpers)
+
+  config.before(:each) do
+    FileUtils.cp_r(fixtures_path('/.'), tmp_path)
+  end
+
+  config.after(:each) do
+    FileUtils.rm_rf(tmp_path)
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 2
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/unit/append_to_file_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#append_to_file' do
+  it "appends to file" do
+    file = tmp_path('Gemfile')
+    TTY::File.append_to_file(file, "gem 'tty'", 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 "appends multiple lines to file" do
+    file = tmp_path('Gemfile')
+    TTY::File.append_to_file(file, "gem 'tty'\n", "gem 'rake'", 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 'rake'"
+    ].join)
+  end
+
+  it "appends content in a block" do
+    file = tmp_path('Gemfile')
+    TTY::File.append_to_file(file, verbose: false) { "gem 'tty'"}
+    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 "doesn't append if already present" do
+    file = tmp_path('Gemfile')
+    TTY::File.append_to_file(file, "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",
+    ].join)
+  end
+
+  it "appends safely checking if content already present" do
+    file = tmp_path('Gemfile')
+    TTY::File.safe_append_to_file(file, "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",
+    ].join)
+  end
+
+  it "appends multiple times by default" do
+    file = tmp_path('Gemfile')
+    TTY::File.append_to_file(file, "gem 'tty'\n", verbose: false)
+    TTY::File.append_to_file(file, "gem 'tty'\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 'tty'\n"
+    ].join)
+  end
+
+  it "logs action" do
+    file = tmp_path('Gemfile')
+    expect {
+      TTY::File.add_to_file(file, "gem 'tty'")
+    }.to output(/\e\[32mappend\e\[0m.*Gemfile/).to_stdout_from_any_process
+  end
+
+  it "logs action without color" do
+    file = tmp_path('Gemfile')
+    expect {
+      TTY::File.add_to_file(file, "gem 'tty'", color: false)
+    }.to output(/\s+append.*Gemfile/).to_stdout_from_any_process
+  end
+end

data/spec/unit/binary_spec.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#binary?' do
+  let(:ascii) { "This is a text file.\nWith more than one line.\nAnd a \tTab.\nAnd other printable chars too: ~!@\#$%^&*()`:\"<>?{}|_+,./;'[]\\-=\n" }
+
+  let(:utf_8) { "Testing utf-8 unicode...\n\n\non a new line: \xE2\x80\x93\n" }
+
+  let(:latin_1) { "Testing latin chars...\nsuch as #{0xFD.chr}mlaut.\n" }
+
+  let(:shift_jis) { "And some kanjis:\n #{0x83.chr}#{0x80.chr}.\n" }
+
+  it "identifies zero-length file as non-binary" do
+    Tempfile.open('tty-file-binary-spec') do |file|
+      expect(TTY::File.binary?(file)).to eq(false)
+    end
+  end
+
+  it "indentifies text with hex as binary" do
+    Tempfile.open('tty-file-binary-spec') do |file|
+      file << "hi \xAD"
+      file.close
+
+      expect(TTY::File.binary?(file)).to eq(true)
+    end
+  end
+
+  it "identifies image as binary" do
+    file = tmp_path('blackhole.png')
+
+    expect(TTY::File.binary?(file)).to eq(true)
+  end
+
+  it "indetifies text file as non-binary" do
+    file = tmp_path('Gemfile')
+
+    expect(TTY::File.binary?(file)).to eq(false)
+  end
+
+  it "indetifies a null-terminated string file as binary" do
+    Tempfile.open('tty-file-binary-spec') do |file|
+      file.write("Binary content.\0")
+      file.close
+
+      expect(TTY::File.binary?(file)).to eq(true)
+    end
+  end
+
+  it "indetifies a null-terminated multi-line string file as binary" do
+    Tempfile.open('tty-file-binary-spec') do |file|
+      file.write("Binary content.\non manylnes\nreally\0")
+      file.close
+
+      expect(TTY::File.binary?(file)).to eq(true)
+    end
+  end
+
+  context "when the default external encoding is UTF-8" do
+    before do
+      @saved_verbosity =  $VERBOSE
+      @saved_encoding = Encoding.default_external
+      $VERBOSE = nil
+      Encoding.default_external = Encoding::UTF_8
+    end
+
+    after do
+      Encoding.default_external = @saved_encoding
+      $VERBOSE = @saved_verbosity
+    end
+
+    it "identifies ASCII as non-binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << ascii
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(false)
+      end
+    end
+
+    it "identifies UTF-8 as non-binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << utf_8
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(false)
+      end
+    end
+
+    it "indentifies Latin-1 as invalid UTF-8 and hence as binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << latin_1
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(true)
+      end
+    end
+
+    it "identifies Shift-JIS as invalid UTF-8 and hence as binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << shift_jis
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(true)
+      end
+    end
+  end
+
+  context "when the default external encoding is Latin-1" do
+    before do
+      @saved_verbosity =  $VERBOSE
+      @saved_encoding = Encoding.default_external
+      $VERBOSE = nil
+      Encoding.default_external = Encoding::ISO_8859_1
+    end
+
+    after do
+      Encoding.default_external = @saved_encoding
+      $VERBOSE = @saved_verbosity
+    end
+
+    it "identifies ASCII as non-binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << ascii
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(false)
+      end
+    end
+
+    it "identifies UTF-8 as invalid Latin-1 and hence binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << utf_8
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(true)
+      end
+    end
+
+    it "indentifies Latin-1 as non-binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << latin_1
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(false)
+      end
+    end
+
+    it "identifies Shift-JIS as invalid Latin-1 and hence as binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << shift_jis
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(true)
+      end
+    end
+  end
+
+  context "when the default external encoding is Shift-JIS" do
+    before do
+      @saved_verbosity =  $VERBOSE
+      @saved_encoding = Encoding.default_external
+      $VERBOSE = nil
+      Encoding.default_external = Encoding::SHIFT_JIS
+    end
+
+    after do
+      Encoding.default_external = @saved_encoding
+      $VERBOSE = @saved_verbosity
+    end
+
+    it "identifies ASCII as non-binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << ascii
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(false)
+      end
+    end
+
+    it "identifies UTF-8 as invalid Shift-JIS and hence as binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << utf_8
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(true)
+      end
+    end
+
+    it "indentifies Latin-1 as invalid Shift-JIS and hence as binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << latin_1
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(true)
+      end
+    end
+
+    it "identifies Shift-JIS as non-binary" do
+      Tempfile.open('tty-file-binary-spec') do |file|
+        file << shift_jis
+        file.close
+
+        expect(TTY::File.binary?(file)).to eq(false)
+      end
+    end
+  end
+end

data/spec/unit/checksum_file_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#checksum_file' do
+  it "generates checksum for a file" do
+    file = tmp_path('checksum/README.md')
+
+    checksum = TTY::File.checksum_file(file)
+    expected = '76ba1beb6c611fa32624ed253444138cdf23eb938a3812137f8a399c5b375bfe'
+
+    expect(checksum).to eq(expected)
+  end
+
+  it "generates checksum for IO object" do
+    io = StringIO.new("Some content\nThe end")
+
+    checksum = TTY::File.checksum_file(io, 'md5')
+    expected = "ad0962e2374b1899fcfb818896703e50"
+
+    expect(checksum).to eq(expected)
+  end
+
+  it "generates checksum for String" do
+    string = "Some content\nThe end"
+
+    checksum = TTY::File.checksum_file(string, 'sha1')
+    expected = "289388f187404135e6c15b21460442cf867180dd"
+
+    expect(checksum).to eq(expected)
+  end
+
+  it "doesn't digest when :noop option" do
+    digester = double(:digester)
+    allow(TTY::File::DigestFile).to receive(:new).and_return(digester)
+
+    TTY::File.checksum_file('string', noop: true)
+
+    expect(digester).to_not receive(:call)
+  end
+end

data/spec/unit/chmod_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#chmod' do
+  context 'when octal permisssions' do
+    it "adds permissions to file - user executable",
+      unless: RSpec::Support::OS.windows? do
+
+      file = tmp_path('script.sh')
+      mode = File.lstat(file).mode
+      expect(File.executable?(file)).to eq(false)
+
+      TTY::File.chmod(file, mode | TTY::File::U_X, verbose: false)
+
+      expect(File.lstat(file).mode).to eq(mode | TTY::File::U_X)
+    end
+
+    it "logs status when :verbose flag is true",
+      unless: RSpec::Support::OS.windows? do
+
+      file = tmp_path('script.sh')
+      mode = File.lstat(file).mode
+      expect(File.executable?(file)).to eq(false)
+
+      expect {
+        TTY::File.chmod(file, mode | TTY::File::U_X)
+      }.to output(/chmod/).to_stdout_from_any_process
+
+      expect(File.lstat(file).mode).to eq(mode | TTY::File::U_X)
+    end
+
+    it "doesn't change permission when :noop flag is true" do
+      file = tmp_path('script.sh')
+      mode = File.lstat(file).mode
+      expect(File.executable?(file)).to eq(false)
+
+      TTY::File.chmod(file, mode | TTY::File::U_X, verbose: false, noop: true)
+
+      expect(File.lstat(file).mode).to eq(mode)
+    end
+  end
+
+  context 'when human readable permissions' do
+    it "adds permisions to file - user executable",
+      unless: RSpec::Support::OS.windows? do
+
+      file = tmp_path('script.sh')
+      mode = File.lstat(file).mode
+      expect(File.executable?(file)).to eq(false)
+
+      TTY::File.chmod(file, 'u+x', verbose: false)
+
+      expect(File.lstat(file).mode).to eq(mode | TTY::File::U_X)
+    end
+
+    it "removes permission for user executable" do
+      file = tmp_path('script.sh')
+      mode = File.lstat(file).mode
+      expect(File.writable?(file)).to eq(true)
+
+      TTY::File.chmod(file, 'u-w', verbose: false)
+
+      expect(File.lstat(file).mode).to eq(mode ^ TTY::File::U_W)
+      expect(File.writable?(file)).to eq(false)
+    end
+
+    it "adds multiple permissions separated by comma",
+      unless: RSpec::Support::OS.windows? do
+
+      file = tmp_path('script.sh')
+      mode = File.lstat(file).mode
+      expect(File.executable?(file)).to eq(false)
+
+      TTY::File.chmod(file, 'u+x,g+x', verbose: false)
+
+      expect(File.lstat(file).mode).to eq(mode | TTY::File::U_X | TTY::File::G_X)
+    end
+  end
+end