tty 0.7.0 → 0.8.0

data/spec/integration/new_spec.rb

@@ -0,0 +1,354 @@
+RSpec.describe 'teletype new', type: :cli do
+
+  it "generates cli application" do
+    app_name = tmp_path('newcli')
+
+    output = <<-OUT
+Creating gem 'newcli'...
+      create  tmp/newcli/Gemfile
+      create  tmp/newcli/lib/newcli.rb
+      create  tmp/newcli/lib/newcli/version.rb
+      create  tmp/newcli/newcli.gemspec
+      create  tmp/newcli/Rakefile
+      create  tmp/newcli/README.md
+      create  tmp/newcli/bin/console
+      create  tmp/newcli/bin/setup
+      create  tmp/newcli/.gitignore
+      create  tmp/newcli/.travis.yml
+      create  tmp/newcli/.rspec
+      create  tmp/newcli/spec/spec_helper.rb
+      create  tmp/newcli/spec/newcli_spec.rb
+      append  tmp/newcli/README.md
+      inject  tmp/newcli/newcli.gemspec
+      create  tmp/newcli/lib/newcli/cli.rb
+      create  tmp/newcli/lib/newcli/command.rb
+      create  tmp/newcli/exe/newcli
+      create  tmp/newcli/LICENSE.txt
+      create  tmp/newcli/lib/newcli/commands/.gitkeep
+      create  tmp/newcli/lib/newcli/templates/.gitkeep
+      create  tmp/newcli/spec/integration/.gitkeep
+      create  tmp/newcli/spec/support/.gitkeep
+      create  tmp/newcli/spec/unit/.gitkeep
+Initializing git repo in #{app_name}
+
+Your teletype project has been created successfully.
+
+Run "teletype help" for more commands.
+    OUT
+
+    command = "teletype new #{app_name} --no-coc --no-color --license mit --no-ext"
+    out, err, status = Open3.capture3(command)
+
+    expect(out).to include(output)
+    expect(err).to eq('')
+    expect(status.exitstatus).to eq(0)
+
+    within_dir(app_name) do
+
+      # doesn't generate coc
+      expect(::File.exist?('CODE_OF_CONDUCT.md')).to eq(false)
+
+      # doesn't generate ext
+      expect(::File.exist?("ext/newcli/extconf.rb")).to eq(false)
+
+      expect(::File.read('LICENSE.txt')).to match(/The MIT License \(MIT\)/)
+
+      # newcli.gemspec
+      gemspec = ::File.read('newcli.gemspec')
+
+      expect(gemspec).to match(/spec.license\s+= \"MIT\"/)
+
+      expect(gemspec).to match(%r{
+  spec.add_dependency "tty-color", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-command", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-config", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-cursor", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-editor", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-file", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-font", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-markdown", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-pager", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-platform", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-progressbar", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-prompt", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-screen", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-spinner", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-table", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-tree", "~> \d+.\d+.\d+"
+  spec.add_dependency "tty-which", "~> \d+.\d+.\d+"
+  spec.add_dependency "pastel", "~> \d+.\d+.\d+"
+  spec.add_dependency "thor", "~> \d+.\d+.\d+"
+})
+
+      # exe/newcli
+      #
+      expect(::File.read('exe/newcli')).to eq(<<-EOS)
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$:.unshift(lib_path) if !$:.include?(lib_path)
+require 'newcli/cli'
+
+Signal.trap('INT') do
+  warn(\"\\n\#{caller.join(\"\\n\")}: interrupted\")
+  exit(1)
+end
+
+begin
+  Newcli::CLI.start
+rescue Newcli::CLI::Error => err
+  puts \"ERROR: \#{err.message}\"
+  exit 1
+end
+      EOS
+
+      # lib/newcli/cli.rb
+      #
+      expect(::File.read('lib/newcli/cli.rb')).to eq(<<-EOS)
+# frozen_string_literal: true
+
+require 'thor'
+
+module Newcli
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc 'version', 'newcli version'
+    def version
+      require_relative 'version'
+      puts \"v\#{Newcli::VERSION}\"
+    end
+    map %w(--version -v) => :version
+  end
+end
+    EOS
+
+      # lib/newcli/cmd.rb
+      #
+      expect(::File.read('lib/newcli/command.rb')).to eq(<<-EOS)
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Newcli
+  class Command
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "\#{self.class}#\#{__method__} must be implemented"
+      )
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command(**options)
+      require 'tty-command'
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require 'tty-cursor'
+      TTY::Cursor
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require 'tty-editor'
+      TTY::Editor
+    end
+
+    # File manipulation utility methods
+    #
+    # @see http://www.rubydoc.info/gems/tty-file
+    #
+    # @api public
+    def generator
+      require 'tty-file'
+      TTY::File
+    end
+
+    # Terminal output paging
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def pager(**options)
+      require 'tty-pager'
+      TTY::Pager.new(options)
+    end
+
+    # Terminal platform and OS properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def platform
+      require 'tty-platform'
+      TTY::Platform.new
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt(**options)
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+
+    # Get terminal screen properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-screen
+    #
+    # @api public
+    def screen
+      require 'tty-screen'
+      TTY::Screen
+    end
+
+    # The unix which utility
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def which(*args)
+      require 'tty-which'
+      TTY::Which.which(*args)
+    end
+
+    # Check if executable exists
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def exec_exist?(*args)
+      require 'tty-which'
+      TTY::Which.exist?(*args)
+    end
+  end
+end
+    EOS
+
+      # Ensure executable
+      #
+      unless Gem.win_platform?
+        expect(::File.executable?("exe/newcli")).to eq(true)
+      end
+    end
+  end
+
+  it "generates C extensions boilerplate" do
+    app_name = tmp_path('newcli')
+
+    output = <<-OUT
+      create  tmp/newcli/ext/newcli/extconf.rb
+      create  tmp/newcli/ext/newcli/newcli.h
+      create  tmp/newcli/ext/newcli/newcli.c
+    OUT
+
+    command = "teletype new #{app_name} --ext --no-color --license mit"
+    out, err, status = Open3.capture3(command)
+
+    expect(out).to include(output)
+    expect(err).to eq('')
+    expect(status.exitstatus).to eq(0)
+
+    within_dir(app_name) do
+      expect(::File.exist?("ext/newcli/extconf.rb")).to eq(true)
+    end
+  end
+
+  it "generates code of conduct file" do
+    app_name = tmp_path('newcli')
+
+    output = <<-OUT
+      create  tmp/newcli/CODE_OF_CONDUCT.md
+    OUT
+
+    command = "teletype new #{app_name} --coc --no-color --license mit"
+    out, err, status = Open3.capture3(command)
+
+    expect(out).to match(output)
+    expect(err).to eq('')
+    expect(status.exitstatus).to eq(0)
+
+    within_dir(app_name) do
+      expect(::File.exist?("CODE_OF_CONDUCT.md")).to eq(true)
+    end
+  end
+
+  it "fails without cli name" do
+    output = <<-OUT.unindent
+      ERROR: 'teletype new' was called with no arguments
+      Usage: 'teletype new PROJECT_NAME'\n
+    OUT
+    command = "teletype new"
+    out, err, status = Open3.capture3(command)
+    expect([out, err, status.exitstatus]).to match_array([output, '', 1])
+  end
+
+  it "displays help" do
+    output = <<-OUT
+Usage:
+  teletype new PROJECT_NAME [OPTIONS]
+
+Options:
+  -a, [--author=name1 name2]       # Author(s) of this library
+      [--ext], [--no-ext]          # Generate a boilerpalate for C extension
+      [--coc], [--no-coc]          # Generate a code of conduct file
+                                   # Default: true
+  -f, [--force]                    # Overwrite existing files
+  -h, [--help], [--no-help]        # Display usage information
+  -l, [--license=mit]              # Generate a license file
+                                   # Default: mit
+                                   # Possible values: agplv3, apache, bsd2, bsd3, gplv2, gplv3, lgplv3, mit, mplv2, custom
+  -t, [--test=rspec]               # Generate a test setup
+                                   # Default: rspec
+                                   # Possible values: rspec, minitest
+      [--no-color]                 # Disable colorization in output
+  -r, [--dry-run], [--no-dry-run]  # Run but do not make any changes
+      [--debug], [--no-debug]      # Run in debug mode
+
+Description:
+  The 'teletype new' command creates a new command line application with a 
+  default directory structure and configuration at the specified path.
+
+  The PROJECT_NAME will be the name for the directory that includes all the 
+  files and be the default binary name.
+
+  Example: teletype new cli_app
+    OUT
+
+    command = "teletype new --help"
+    out, err, status = Open3.capture3(command)
+    expect(out).to eq(output)
+    expect(err).to eq('')
+    expect(status.exitstatus).to eq(0)
+  end
+end

data/spec/integration/new_test_spec.rb

@@ -0,0 +1,21 @@
+RSpec.describe 'teletype new --test', type: :cli do
+  it "generates a rspec test setup" do
+    app_name = tmp_path('newcli')
+    command = "teletype new #{app_name} --test rspec"
+    `#{command}`
+
+    expect(File.exist?('newcli/spec/unit/.gitkeep'))
+    expect(File.exist?('newcli/spec/support/.gitkeep'))
+    expect(File.exist?('newcli/spec/integration/.gitkeep'))
+  end
+
+  it "generates a minitest test setup" do
+    app_name = tmp_path('newcli')
+    command = "teletype new #{app_name} --test=minitest"
+    `#{command}`
+
+    expect(File.exist?('newcli/test/unit/.gitkeep'))
+    expect(File.exist?('newcli/test/support/.gitkeep'))
+    expect(File.exist?('newcli/test/integration/.gitkeep'))
+  end
+end

data/spec/integration/start_spec.rb

@@ -0,0 +1,21 @@
+RSpec.describe 'teletype' do
+  xit "prints available commands and global options" do
+    command = "teletype"
+
+    out = `#{command}`
+
+    expect(out).to eq(<<-OUT)
+#{TTY::CLI.top_banner}Commands:
+  teletype add COMMAND_NAME [OPTIONS]  # Add a command to the command line app.
+  teletype help [COMMAND]              # Describe available commands or one specific command
+  teletype new PROJECT_NAME [OPTIONS]  # Create a new command line app skeleton.
+  teletype version                     # TTY version
+
+Options:
+      [--no-color]                 # Disable colorization in output.
+  -r, [--dry-run], [--no-dry-run]  # Run but do not make any changes.
+      [--debug], [--no-debug]      # Run with debug logging.
+
+OUT
+  end
+end

data/spec/spec_helper.rb

@@ -2,11 +2,9 @@
 
 if ENV['TRAVIS'] || ENV['COVERAGE']
   require 'simplecov'
-  require 'coveralls'
 
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
     SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
   ]
 
   SimpleCov.start do
@@ -14,29 +12,62 @@ if ENV['TRAVIS'] || ENV['COVERAGE']
   end
 end
 
-require 'rubygems'
 require 'tty'
+require 'tty-file'
+require 'fileutils'
+require 'open3'
 
-module Helpers
-  def fixtures_dir
-    File.join(File.dirname(__FILE__), 'fixtures')
+class String
+  def unindent
+    gsub(/^[ \t]*/, '').chomp
   end
+end
+
+module TestHelpers
+  module Paths
+    def gem_root
+      File.expand_path("#{File.dirname(__FILE__)}/..")
+    end
 
-  def fixtures_path(filename = nil)
-    File.join(File.dirname(__FILE__), 'fixtures', filename.to_s)
+    def dir_path(*args)
+      path = File.join(gem_root, *args)
+      FileUtils.mkdir_p(path)
+      File.realpath(path)
+    end
+
+    def tmp_path(*args)
+      File.join(dir_path('tmp'), *args)
+    end
+
+    def fixtures_path(*args)
+      File.join(dir_path('spec/fixtures'), *args)
+    end
+
+    def within_dir(target, &block)
+      ::Dir.chdir(target, &block)
+    end
+  end
+
+  module Silent
+    def silent_run(*args)
+      out = Tempfile.new('tty-cmd')
+      result = system(*args, out: out.path)
+      return if result
+      out.rewind
+      fail "#{args.join} failed:\n#{out.read}"
+    end
   end
 end
 
 RSpec.configure do |config|
-  config.include(Helpers)
+  config.include(TestHelpers::Paths)
+  config.include(TestHelpers::Silent)
+  config.after(:example, type: :cli) do
+    FileUtils.rm_rf(tmp_path)
+  end
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
-  config.order = 'random'
+  config.order = :random
   config.raise_errors_for_deprecations!
-end
-
-class String
-  def normalize
-    gsub(/^[ \t]*/, '').chomp
-  end
+  config.disable_monkey_patching!
 end