tty 0.7.0 → 0.8.0

data/spec/integration/add_subcommand_spec.rb

@@ -0,0 +1,259 @@
+RSpec.describe "`teletype add` subcommad", type: :cli do
+  it "adds a new subcommand" do
+    app_name = tmp_path('newcli')
+    silent_run("teletype new #{app_name} --test rspec")
+
+    output = <<-OUT
+      create  spec/integration/config_spec.rb
+      create  spec/integration/config/set_spec.rb
+      create  spec/unit/config/set_spec.rb
+      create  lib/newcli/commands/config.rb
+      create  lib/newcli/commands/config/set.rb
+      create  lib/newcli/templates/config/set/.gitkeep
+      inject  lib/newcli/cli.rb
+      inject  lib/newcli/commands/config.rb
+    OUT
+
+    within_dir(app_name) do
+      command_set = "teletype add config set --no-color"
+
+      out, err, status = Open3.capture3(command_set)
+
+      expect(err).to eq('')
+      expect(out).to eq(output)
+      expect(status.exitstatus).to eq(0)
+
+      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
+
+    require_relative 'commands/config'
+    register Newcli::Commands::Config, 'config', 'config [SUBCOMMAND]', 'Command description...'
+  end
+end
+      EOS
+
+      expect(::File.read('lib/newcli/commands/config.rb')).to eq <<-EOS
+# frozen_string_literal: true
+
+require 'thor'
+
+module Newcli
+  module Commands
+    class Config < Thor
+
+      namespace :config
+
+      desc 'set', 'Command description...'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def set(*)
+        if options[:help]
+          invoke :help, ['set']
+        else
+          require_relative 'config/set'
+          Newcli::Commands::Config::Set.new(options).execute
+        end
+      end
+    end
+  end
+end
+      EOS
+
+      # Subcommand `set`
+      #
+      expect(::File.read('lib/newcli/commands/config/set.rb')).to eq <<-EOS
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+module Newcli
+  module Commands
+    class Config
+      class Set < Newcli::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          # Command logic goes here ...
+          output.puts "OK"
+        end
+      end
+    end
+  end
+end
+      EOS
+
+      # spec/integration/config_spec.rb
+      #
+      expect(::File.read('spec/integration/config_spec.rb')).to eq <<-EOS
+RSpec.describe "`newcli config` command", type: :cli do
+  it "executes `newcli help config` command successfully" do
+    output = `newcli help config`
+    expected_output = <<-OUT
+Commands:
+    OUT
+
+    expect(output).to eq(expected_output)
+  end
+end
+      EOS
+
+      # spec/integration/config/set_spec.rb
+      #
+      expect(::File.read('spec/integration/config/set_spec.rb')).to eq <<-EOS
+RSpec.describe "`newcli config set` command", type: :cli do
+  it "executes `newcli config help set` command successfully" do
+    output = `newcli config help set`
+    expected_output = <<-OUT
+Usage:
+  newcli set
+
+Options:
+  -h, [--help], [--no-help]  # Display usage information
+
+Command description...
+    OUT
+
+    expect(output).to eq(expected_output)
+  end
+end
+      EOS
+
+      # spec/unit/config/set_spec.rb
+      #
+      expect(::File.read('spec/unit/config/set_spec.rb')).to eq <<-EOS
+require 'newcli/commands/config/set'
+
+RSpec.describe Newcli::Commands::Config::Set do
+  it "executes `config set` command successfully" do
+    output = StringIO.new
+    options = {}
+    command = Newcli::Commands::Config::Set.new(options)
+
+    command.execute(output: output)
+
+    expect(output.string).to eq("OK\\n")
+  end
+end
+      EOS
+
+      command_get = "teletype add config get --no-color"
+
+      out, err, status = Open3.capture3(command_get)
+
+      expect(out).to include <<-OUT
+      create  spec/integration/config/get_spec.rb
+      create  spec/unit/config/get_spec.rb
+      create  lib/newcli/commands/config/get.rb
+      create  lib/newcli/templates/config/get/.gitkeep
+      inject  lib/newcli/commands/config.rb
+      OUT
+      expect(err).to eq('')
+      expect(status.exitstatus).to eq(0)
+    end
+  end
+
+  it "adds a new subcommand with minitest" do
+    app_name = tmp_path('newcli')
+    silent_run("teletype new #{app_name} --test minitest")
+
+    output = <<-OUT
+      create  test/integration/config_test.rb
+      create  test/integration/config/set_test.rb
+      create  test/unit/config/set_test.rb
+      create  lib/newcli/commands/config.rb
+      create  lib/newcli/commands/config/set.rb
+      create  lib/newcli/templates/config/set/.gitkeep
+      inject  lib/newcli/cli.rb
+      inject  lib/newcli/commands/config.rb
+    OUT
+
+    within_dir(app_name) do
+      command_set = "teletype add config set --no-color"
+
+      out, err, status = Open3.capture3(command_set)
+
+      expect(err).to eq('')
+      expect(out).to eq(output)
+      expect(status.exitstatus).to eq(0)
+
+      # test setup
+      #
+      expect(::File.read('test/integration/config_test.rb')).to eq <<-EOS
+require 'test_helper'
+require 'newcli/commands/config'
+
+class Newcli::Commands::ConfigTest < Minitest::Test
+  def test_executes_newcli_help_config_command_successfully
+    output = `newcli help config`
+    expected_output = <<-OUT
+Commands:
+    OUT
+
+    assert_equal expected_output, output
+  end
+end
+      EOS
+
+      expect(::File.read('test/integration/config/set_test.rb')).to eq <<-EOS
+require 'test_helper'
+require 'newcli/commands/config/set'
+
+class Newcli::Commands::Config::SetTest < Minitest::Test
+  def test_executes_newcli_config_help_set_command_successfully
+    output = `newcli config help set`
+    expect_output = <<-OUT
+Usage:
+  newcli set
+
+Options:
+  -h, [--help], [--no-help]  # Display usage information
+
+Command description...
+    OUT
+
+    assert_equal expected_output, output
+  end
+end
+      EOS
+
+      # test/unit/config/set_test.rb
+      #
+      expect(::File.read('test/unit/config/set_test.rb')).to eq <<-EOS
+require 'test_helper'
+require 'newcli/commands/config/set'
+
+class Newcli::Commands::Config::SetTest < Minitest::Test
+  def test_executes_config_set_command_successfully
+    output = StringIO.new
+    options = {}
+    command = Newcli::Commands::Config::Set.new(options)
+
+    command.execute(output: output)
+
+    assert_equal "OK\\n", output.string
+  end
+end
+    EOS
+    end
+  end
+end

data/spec/integration/new_author_spec.rb

@@ -0,0 +1,19 @@
+RSpec.describe "`teletype new --author` command", type: :cli do
+  it "sets an author" do
+    app_name = tmp_path('newcli')
+    command = "teletype new #{app_name} --author 'Author A'"
+    `#{command}`
+
+    license = ::File.binread(tmp_path('newcli/LICENSE.txt'))
+    expect(license).to include('Author A')
+  end
+
+  it "sets multiple authors" do
+    app_name = tmp_path('newcli')
+    command = "teletype new #{app_name} --author 'Author A' 'Author B'"
+    `#{command}`
+
+    license = ::File.binread(tmp_path('newcli/LICENSE.txt'))
+    expect(license).to include('Author A, Author B')
+  end
+end

data/spec/integration/new_license_spec.rb

@@ -0,0 +1,39 @@
+RSpec.describe 'teletype new --license', type: :cli do
+  it "generates a MIT license file" do
+    app_name = tmp_path('newcli')
+    command = "teletype new #{app_name} --license mit --author 'Piotr Murach'"
+    `#{command}`
+
+    license = File.binread(tmp_path('newcli/LICENSE.txt'))
+    gemspec = File.binread(tmp_path('newcli/newcli.gemspec'))
+    readme  = File.binread(tmp_path('newcli/README.md'))
+
+    expect(license.lines[0]).to eq("The MIT License (MIT)\n")
+    expect(gemspec).to match(/spec.license\s{7}= "MIT"/)
+    expect(readme).to include "Copyright (c) #{Time.now.year} Piotr Murach. See [MIT License](LICENSE.txt) for further details."
+  end
+
+  it "generates a GPL-3.0 license file" do
+    app_name = tmp_path('newcli')
+    command = "teletype new #{app_name} -l gplv3 -a 'Piotr Murach'"
+    `#{command}`
+
+    license = File.binread(tmp_path('newcli/LICENSE.txt'))
+    gemspec = File.binread(tmp_path('newcli/newcli.gemspec'))
+    readme  = File.binread(tmp_path('newcli/README.md'))
+
+    expect(license.lines[0]).to eq("GNU GENERAL PUBLIC LICENSE\n")
+    expect(gemspec).to match(/spec.license\s{7}= "GPL-3.0"/)
+    expect(readme).to include "Copyright (c) #{Time.now.year} Piotr Murach. See [GNU General Public License v3.0](LICENSE.txt) for further details."
+  end
+
+  it "fails to recognise the license type" do
+    app_name = tmp_path('newcli')
+    command = "teletype new #{app_name} --license unknown"
+    out, err, process = Open3.capture3(command)
+
+    expect(out).to eq('')
+    expect(err).to eq("Expected '--license' to be one of agplv3, apache, bsd2, bsd3, gplv2, gplv3, lgplv3, mit, mplv2, custom; got unknown\n")
+    expect(process.exitstatus).to eq(0) # FIXME: wrong status
+  end
+end

data/spec/integration/new_namespaced_spec.rb

@@ -0,0 +1,228 @@
+RSpec.describe 'teletype new', type: :cli do
+  it "generates cli application namespaced" do
+    app_name = tmp_path('cli-app')
+
+    output = <<-OUT
+Creating gem 'cli-app'...
+      create  tmp/cli-app/Gemfile
+      create  tmp/cli-app/lib/cli/app.rb
+      create  tmp/cli-app/lib/cli/app/version.rb
+      create  tmp/cli-app/cli-app.gemspec
+      create  tmp/cli-app/Rakefile
+      create  tmp/cli-app/README.md
+      create  tmp/cli-app/bin/console
+      create  tmp/cli-app/bin/setup
+      create  tmp/cli-app/.gitignore
+      create  tmp/cli-app/.travis.yml
+      create  tmp/cli-app/.rspec
+      create  tmp/cli-app/spec/spec_helper.rb
+      create  tmp/cli-app/spec/cli/app_spec.rb
+      append  tmp/cli-app/README.md
+      inject  tmp/cli-app/cli-app.gemspec
+      create  tmp/cli-app/lib/cli/app/cli.rb
+      create  tmp/cli-app/lib/cli/app/command.rb
+      create  tmp/cli-app/exe/cli-app
+      create  tmp/cli-app/LICENSE.txt
+      create  tmp/cli-app/lib/cli/app/commands/.gitkeep
+      create  tmp/cli-app/lib/cli/app/templates/.gitkeep
+      create  tmp/cli-app/spec/integration/.gitkeep
+      create  tmp/cli-app/spec/support/.gitkeep
+      create  tmp/cli-app/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"
+
+    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
+
+      # exe/cli-app
+      #
+      expect(::File.read('exe/cli-app')).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 'cli/app/cli'
+
+Signal.trap('INT') do
+  warn(\"\\n\#{caller.join(\"\\n\")}: interrupted\")
+  exit(1)
+end
+
+begin
+  Cli::App::CLI.start
+rescue Cli::App::CLI::Error => err
+  puts \"ERROR: \#{err.message}\"
+  exit 1
+end
+      EOS
+
+      # lib/cli/app/cli.rb
+      #
+      expect(::File.read('lib/cli/app/cli.rb')).to eq(<<-EOS)
+# frozen_string_literal: true
+
+require 'thor'
+
+module Cli
+  module App
+    # 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', 'cli-app version'
+      def version
+        require_relative 'version'
+        puts \"v\#{Cli::App::VERSION}\"
+      end
+      map %w(--version -v) => :version
+    end
+  end
+end
+    EOS
+
+      # lib/newcli/cmd.rb
+      #
+      expect(::File.read('lib/cli/app/command.rb')).to eq(<<-EOS)
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Cli
+  module App
+    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
+end
+    EOS
+    end
+  end
+end