tty-file 0.6.0 → 0.7.0

data/spec/unit/copy_directory_spec.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#copy_directory' do
+  it "copies directory of files recursively" do
+    app = tmp_path('cli_app')
+    apps = tmp_path('apps')
+
+    variables = OpenStruct.new
+    variables[:name] = 'tty'
+    variables[:foo] = 'Foo'
+    variables[:bar] = 'Bar'
+
+    TTY::File.copy_directory(app, apps, context: variables, verbose: false)
+
+    expect(Find.find(apps).to_a).to eq([
+      tmp_path('apps'),
+      tmp_path('apps/README'),
+      tmp_path('apps/command.rb'),
+      tmp_path('apps/commands'),
+      tmp_path('apps/commands/subcommand.rb'),
+      tmp_path('apps/excluded'),
+      tmp_path('apps/excluded/command.rb'),
+      tmp_path('apps/excluded/tty_cli.rb'),
+      tmp_path('apps/tty_cli.rb')
+    ])
+
+    expect(File.read(tmp_path('apps/command.rb'))).to eq("class FooCommand\nend\n")
+    expect(File.read(tmp_path('apps/excluded/command.rb'))).to eq("class BarCommand\nend\n")
+  end
+
+  it "copies top level directory of files and evalutes templates" do
+    app  = tmp_path('cli_app')
+    apps = tmp_path('apps')
+
+    variables = OpenStruct.new
+    variables[:name] = 'tty'
+    variables[:foo] = 'Foo'
+    variables[:bar] = 'Bar'
+
+    TTY::File.copy_directory(app, apps, recursive: false,
+                                        context: variables,
+                                        verbose: false)
+
+    expect(Find.find(apps).to_a).to eq([
+      tmp_path('apps'),
+      tmp_path('apps/README'),
+      tmp_path('apps/command.rb'),
+      tmp_path('apps/tty_cli.rb')
+    ])
+  end
+
+  it "handles glob characters in the path" do
+    src = tmp_path("foo[1]")
+    dest = tmp_path("foo1")
+    TTY::File.copy_directory(src, dest, verbose: false)
+
+    expect(Find.find(dest).to_a).to eq([
+      tmp_path('foo1'),
+      tmp_path('foo1/README.md')
+    ])
+  end
+
+  it "ignores excluded directories" do
+    src = tmp_path('cli_app')
+    dest = tmp_path('ignored')
+
+    variables = OpenStruct.new
+    variables[:name] = 'tty'
+    variables[:foo] = 'Foo'
+    variables[:bar] = 'Bar'
+
+    TTY::File.copy_directory(src, dest, context: variables,
+                                        exclude: %r{excluded/},
+                                        verbose: false)
+
+    expect(Find.find(dest).to_a).to eq([
+      tmp_path('ignored'),
+      tmp_path('ignored/README'),
+      tmp_path('ignored/command.rb'),
+      tmp_path('ignored/commands'),
+      tmp_path('ignored/commands/subcommand.rb'),
+      tmp_path('ignored/tty_cli.rb')
+    ])
+  end
+
+  it "raises error when source directory doesn't exist" do
+    expect {
+      TTY::File.copy_directory('unknown')
+    }.to raise_error(ArgumentError, %r{File path "unknown" does not exist.})
+  end
+
+  it "logs status" do
+    app  = tmp_path('cli_app')
+    apps = tmp_path('apps')
+
+    variables = OpenStruct.new
+    variables[:name] = 'tty'
+    variables[:class_name] = 'TTY'
+
+    expect {
+      TTY::File.copy_directory(app, apps, context: variables, verbose: true)
+    }.to output(
+      %r{create(.*)apps/tty_cli.rb\n(.*)create(.*)apps/README\n(.*)create(.*)apps/command.rb\n}m
+    ).to_stdout_from_any_process
+  end
+end

data/spec/unit/copy_file_spec.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+require 'ostruct'
+
+RSpec.describe TTY::File, '#copy_file' do
+  def exists_and_identical?(source, dest)
+    dest_path = File.join(tmp_path, dest)
+    expect(::File.exist?(dest_path)).to be(true)
+
+    source_path = File.join(fixtures_path, source)
+    expect(::FileUtils).to be_identical(source_path, dest_path)
+  end
+
+  it "copies file without destination" do
+    src = tmp_path('Gemfile')
+
+    TTY::File.copy_file(src, verbose: false)
+
+    exists_and_identical?('Gemfile', 'Gemfile')
+  end
+
+  it "copies file to the destination" do
+    src  = tmp_path('Gemfile')
+    dest = tmp_path('app/Makefile')
+
+    TTY::File.copy_file(src, dest, verbose: false)
+
+    exists_and_identical?('Gemfile', 'app/Makefile')
+  end
+
+  it "copies file to existing destination" do
+    src  = tmp_path('Gemfile')
+    dest = tmp_path('app/Gemfile')
+
+    TTY::File.copy_file(src, dest, verbose: false)
+
+    exists_and_identical?('Gemfile', 'app/Gemfile')
+  end
+
+  it "copies file with block content" do
+    src  = tmp_path('Gemfile')
+    dest = tmp_path('app/Gemfile')
+
+    TTY::File.copy_file(src, dest, verbose: false) do |content|
+      "https://rubygems.org\n" + content
+    end
+    expect(File.read(dest)).to eq("https://rubygems.org\ngem 'nokogiri'\ngem 'rails', '5.0.0'\ngem 'rack', '>=1.0'\n")
+  end
+
+  it "copies file and preservs metadata" do
+    src  = tmp_path('Gemfile')
+    dest = tmp_path('app/Gemfile')
+
+    expect {
+      TTY::File.copy_file(src, dest, verbose: false, preserve: true)
+    }.to output('').to_stdout_from_any_process
+
+    expect(File.stat(src)).to eq(File.stat(dest))
+  end
+
+  it "doesn't copy file if :noop is true" do
+    src  = tmp_path('Gemfile')
+    dest = tmp_path('app/Gemfile')
+
+    TTY::File.copy_file(src, dest, verbose: false, noop: true)
+
+    expect(File.exist?(dest)).to eq(false)
+  end
+
+  it "logs status" do
+    src  = tmp_path('Gemfile')
+    dest = tmp_path('app/Gemfile')
+
+    expect {
+      TTY::File.copy_file(src, dest)
+    }.to output(/\e\[32mcreate\e\[0m.*Gemfile/).to_stdout_from_any_process
+  end
+
+  it "logs status without color" do
+    src  = tmp_path('Gemfile')
+    dest = tmp_path('app/Gemfile')
+
+    expect {
+      TTY::File.copy_file(src, dest, color: false)
+    }.to output(/\s+create.*Gemfile/).to_stdout_from_any_process
+  end
+
+  it "removes template .erb extension" do
+    src = tmp_path('templates/application.html.erb')
+
+    TTY::File.copy_file(src, verbose: false)
+
+    exists_and_identical?('templates/application.html.erb',
+                          'templates/application.html')
+  end
+
+  it "converts filename based on context" do
+    src = tmp_path('templates/%file_name%.rb')
+    dest = tmp_path('app/%file_name%.rb')
+
+    variables = OpenStruct.new
+    variables[:foo] = 'bar'
+    variables[:file_name] = 'expected'
+
+    TTY::File.copy_file(src, dest, context: variables, verbose: false)
+
+    expected = tmp_path('app/expected.rb')
+    expect(File.read(expected)).to eq("bar\n")
+  end
+
+  it "converts filename based on class context" do
+    src  = tmp_path('templates/%file_name%.rb')
+    dest = tmp_path('templates/expected.rb')
+
+    stub_const('TestCase', Class.new {
+      def foo
+        'bar'
+      end
+
+      def file_name
+        'expected'
+      end
+    })
+    TestCase.send(:include, TTY::File)
+
+    TestCase.new.send(:copy_file, src, verbose: false)
+
+    expect(File.read(dest)).to eq("bar\n")
+  end
+
+  it "copies file with custom class context" do
+    src  = tmp_path('templates/unit_test.rb')
+    dest = tmp_path('test/unit_test.rb')
+
+    stub_const('TestCase', Class.new {
+      def self.class_name
+        'Example'
+      end
+    })
+    TestCase.extend(TTY::File)
+
+    TestCase.send(:copy_file, src, dest, verbose: false)
+
+    expect(File.read(dest)).to eq("class ExampleTest; end\n")
+  end
+
+  it "copies template with custom context binding" do
+    src  = tmp_path('templates/unit_test.rb')
+    dest = tmp_path('test/unit_test.rb')
+
+    variables = OpenStruct.new
+    variables[:class_name] = 'Example'
+
+    TTY::File.copy_file(src, dest, context: variables, verbose: false)
+
+    expect(File.read(dest)).to eq("class ExampleTest; end\n")
+  end
+end

data/spec/unit/create_directory_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#create_directory' do
+  it "creates empty directory" do
+    app_dir = tmp_path('app')
+
+    TTY::File.create_directory(app_dir, verbose: false)
+
+    expect(File.exist?(app_dir)).to eq(true)
+  end
+
+  it "logs status" do
+    doc_dir = tmp_path('doc')
+
+    expect {
+      TTY::File.create_dir(doc_dir, verbose: true)
+    }.to output(%r{    \e\[32mcreate\e\[0m(.*)doc\n}).to_stdout_from_any_process
+  end
+
+  it "logs status wihtout color" do
+    doc_dir = tmp_path('doc')
+
+    expect {
+      TTY::File.create_dir(doc_dir, verbose: true, color: false)
+    }.to output(%r{    create(.*)doc\n}).to_stdout_from_any_process
+  end
+
+  it "creates tree of dirs and files" do
+    app_dir = tmp_path('app')
+
+    tree = {
+      tmp_path('app') => [
+        'empty_file',
+        ['full_file', 'File with contents'],
+        'subdir' => [
+          'empty_file_subdir',
+          ['full_file_subdir', 'File with contents']
+        ],
+        'empty' => []
+      ]
+    }
+
+    TTY::File.create_directory(tree, verbose: false)
+
+    expect(Find.find(app_dir).to_a).to eq([
+      tmp_path('app'),
+      tmp_path('app/empty'),
+      tmp_path('app/empty_file'),
+      tmp_path('app/full_file'),
+      tmp_path('app/subdir'),
+      tmp_path('app/subdir/empty_file_subdir'),
+      tmp_path('app/subdir/full_file_subdir'),
+    ])
+
+    expect(::File.read(tmp_path('app/subdir/full_file_subdir'))).to eq('File with contents')
+  end
+
+  it "creates tree of dirs in parent directory" do
+    app_dir = tmp_path('parent')
+
+    tree = {
+      'app' => [
+        ['file', "File multi\nline contents"],
+        'subdir' => ['file1', 'file2']
+      ]
+    }
+
+    TTY::File.create_dir(tree, app_dir, verbose: false)
+
+    expect(Find.find(app_dir).to_a).to eq([
+      tmp_path('parent'),
+      tmp_path('parent/app'),
+      tmp_path('parent/app/file'),
+      tmp_path('parent/app/subdir'),
+      tmp_path('parent/app/subdir/file1'),
+      tmp_path('parent/app/subdir/file2')
+    ])
+  end
+end

data/spec/unit/create_file_spec.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::File, '#create_file' do
+  context 'when new file' do
+    it "creates file" do
+      expect {
+        TTY::File.create_file(tmp_path('doc/README.md'))
+      }.to output(/create/).to_stdout_from_any_process
+
+      expect(File.exist?(tmp_path('doc/README.md'))).to eq(true)
+    end
+
+    it "creates file with content" do
+      file = tmp_path('doc/README.md')
+      TTY::File.create_file(file, '# Title', verbose: false)
+
+      expect(File.read(file)).to eq('# Title')
+    end
+
+    it "creates file with content in a block" do
+      file = tmp_path('doc/README.md')
+      TTY::File.create_file(file, verbose: false) do
+        "# Title"
+      end
+
+      expect(File.read(file)).to eq('# Title')
+    end
+
+    it "doesn't create file if :noop is true" do
+      file = tmp_path('doc/README.md')
+      TTY::File.create_file(file, '# Title', noop: true, verbose: false)
+
+      expect(File.exist?(file)).to eq(false)
+    end
+  end
+
+  context 'when file exists' do
+    context 'and is identical' do
+      it "logs identical status" do
+        file = tmp_path('README.md')
+        TTY::File.create_file(file, '# Title', verbose: false)
+        expect {
+          TTY::File.create_file(file, '# Title', verbose: true)
+        }.to output(/identical/).to_stdout_from_any_process
+      end
+    end
+
+    context 'and is not identical' do
+      context 'and :force is true' do
+        it "logs forced status to stdout" do
+          file = tmp_path('README.md')
+          TTY::File.create_file(file, '# Title', verbose: false)
+          expect {
+            TTY::File.create_file(file, '# Header', verbose: true, force: true)
+          }.to output(/force/).to_stdout_from_any_process
+        end
+
+        it 'overrides the previous file' do
+          file = tmp_path('README.md')
+          TTY::File.create_file(file, '# Title', verbose: false)
+          TTY::File.create_file(file, '# Header', force: true, verbose: false)
+          content = File.read(file)
+          expect(content).to eq('# Header')
+        end
+      end
+
+      it "displays collision menu and overwrites" do
+        test_prompt = TTY::TestPrompt.new
+        test_prompt.input << "\n"
+        test_prompt.input.rewind
+        allow(TTY::Prompt).to receive(:new).and_return(test_prompt)
+
+        file = tmp_path('README.md')
+        TTY::File.create_file(file, '# Title', verbose: false)
+
+        expect {
+          TTY::File.create_file(file, '# Header', verbose: true)
+        }.to output(/collision/).to_stdout_from_any_process
+
+        expect(File.read(file)).to eq('# Header')
+      end
+
+      it "displays collision menu and doesn't overwrite" do
+        test_prompt = TTY::TestPrompt.new
+        test_prompt.input << "n\n"
+        test_prompt.input.rewind
+        allow(TTY::Prompt).to receive(:new).and_return(test_prompt)
+
+        file = tmp_path('README.md')
+        TTY::File.create_file(file, '# Title', verbose: false)
+
+        expect {
+          TTY::File.create_file(file, '# Header', verbose: true)
+        }.to output(/collision/).to_stdout_from_any_process
+
+        expect(File.read(file)).to eq('# Title')
+      end
+
+      it "displays collision menu and aborts" do
+        test_prompt = TTY::TestPrompt.new
+        test_prompt.input << "q\n"
+        test_prompt.input.rewind
+        allow(TTY::Prompt).to receive(:new).and_return(test_prompt)
+
+        file = tmp_path('README.md')
+        TTY::File.create_file(file, '# Title', verbose: false)
+
+        expect {
+          TTY::File.create_file(file, '# Header', verbose: false)
+        }.to raise_error(SystemExit)
+
+        expect(File.read(file)).to eq('# Title')
+      end
+    end
+  end
+end