tty 0.7.0 → 0.8.0

data/spec/integration/add_namespaced_spec.rb

@@ -0,0 +1,291 @@
+RSpec.describe "teletype add", type: :cli do
+  it "adds a command to namespaced application" do
+    app_name = tmp_path('cli-app')
+    silent_run("teletype new #{app_name} --test rspec")
+
+    output = <<-OUT
+      create  spec/integration/server_spec.rb
+      create  spec/unit/server_spec.rb
+      create  lib/cli/app/commands/server.rb
+      create  lib/cli/app/templates/server/.gitkeep
+      inject  lib/cli/app/cli.rb
+    OUT
+
+    within_dir(app_name) do
+      command = "teletype add server --no-color"
+
+      out, err, status = Open3.capture3(command)
+
+      expect(err).to eq('')
+      expect(out).to eq(output)
+      expect(status.exitstatus).to eq(0)
+
+      # lib/cli/app/commands/server.rb
+      #
+      expect(::File.read('lib/cli/app/commands/server.rb')).to eq <<-EOS
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Cli
+  module App
+    module Commands
+      class Server < Cli::App::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
+
+      # 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
+
+      desc 'server', 'Command description...'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def server(*)
+        if options[:help]
+          invoke :help, ['server']
+        else
+          require_relative 'commands/server'
+          Cli::App::Commands::Server.new(options).execute
+        end
+      end
+    end
+  end
+end
+      EOS
+
+      # test setup
+      #
+      expect(::File.read('spec/integration/server_spec.rb')).to eq <<-EOS
+RSpec.describe "`cli-app server` command", type: :cli do
+  it "executes `cli-app help server` command successfully" do
+    output = `cli-app help server`
+    expected_output = <<-OUT
+Usage:
+  cli-app server
+
+Options:
+  -h, [--help], [--no-help]  # Display usage information
+
+Command description...
+    OUT
+
+    expect(output).to eq(expected_output)
+  end
+end
+      EOS
+
+      expect(::File.read('spec/unit/server_spec.rb')).to eq <<-EOS
+require 'cli/app/commands/server'
+
+RSpec.describe Cli::App::Commands::Server do
+  it "executes `server` command successfully" do
+    output = StringIO.new
+    options = {}
+    command = Cli::App::Commands::Server.new(options)
+
+    command.execute(output: output)
+
+    expect(output.string).to eq("OK\\n")
+  end
+end
+      EOS
+    end
+  end
+
+  it "adds a subcommand to namespaced application" do
+    app_name = tmp_path('cli-app')
+    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/cli/app/commands/config.rb
+      create  lib/cli/app/commands/config/set.rb
+      create  lib/cli/app/templates/config/set/.gitkeep
+      inject  lib/cli/app/cli.rb
+      inject  lib/cli/app/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)
+
+      # 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
+
+      require_relative 'commands/config'
+      register Cli::App::Commands::Config, 'config', 'config [SUBCOMMAND]', 'Command description...'
+    end
+  end
+end
+      EOS
+
+      # lib/cli/app/commands/config.rb
+      #
+      expect(::File.read('lib/cli/app/commands/config.rb')).to eq <<-EOS
+# frozen_string_literal: true
+
+require 'thor'
+
+module Cli
+  module App
+    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'
+            Cli::App::Commands::Config::Set.new(options).execute
+          end
+        end
+      end
+    end
+  end
+end
+      EOS
+
+      # Subcommand `set`
+      #
+      expect(::File.read('lib/cli/app/commands/config/set.rb')).to eq <<-EOS
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+module Cli
+  module App
+    module Commands
+      class Config
+        class Set < Cli::App::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
+end
+      EOS
+
+      # test setup
+      #
+      expect(::File.read('spec/integration/config_spec.rb')).to eq <<-EOS
+RSpec.describe "`cli-app config` command", type: :cli do
+  it "executes `cli-app help config` command successfully" do
+    output = `cli-app help config`
+    expected_output = <<-OUT
+Commands:
+    OUT
+
+    expect(output).to eq(expected_output)
+  end
+end
+      EOS
+
+      expect(::File.read('spec/integration/config/set_spec.rb')).to eq <<-EOS
+RSpec.describe "`cli-app config set` command", type: :cli do
+  it "executes `cli-app config help set` command successfully" do
+    output = `cli-app config help set`
+    expected_output = <<-OUT
+Usage:
+  cli-app set
+
+Options:
+  -h, [--help], [--no-help]  # Display usage information
+
+Command description...
+    OUT
+
+    expect(output).to eq(expected_output)
+  end
+end
+      EOS
+
+      expect(::File.read('spec/unit/config/set_spec.rb')).to eq <<-EOS
+require 'cli/app/commands/config/set'
+
+RSpec.describe Cli::App::Commands::Config::Set do
+  it "executes `config set` command successfully" do
+    output = StringIO.new
+    options = {}
+    command = Cli::App::Commands::Config::Set.new(options)
+
+    command.execute(output: output)
+
+    expect(output.string).to eq("OK\\n")
+  end
+end
+      EOS
+    end
+  end
+end

data/spec/integration/add_spec.rb

@@ -0,0 +1,535 @@
+RSpec.describe "`teletype add` command", type: :cli do
+  it "adds a command" do
+    app_name = tmp_path('newcli')
+    silent_run("teletype new #{app_name} --test rspec")
+
+    output = <<-OUT
+      create  spec/integration/server_spec.rb
+      create  spec/unit/server_spec.rb
+      create  lib/newcli/commands/server.rb
+      create  lib/newcli/templates/server/.gitkeep
+      inject  lib/newcli/cli.rb
+    OUT
+
+    within_dir(app_name) do
+      command = "teletype add server --no-color"
+
+      out, err, status = Open3.capture3(command)
+
+      expect(out).to match(output)
+      expect(err).to eq('')
+      expect(status.exitstatus).to eq(0)
+
+      # lib/newcli/commands/server.rb
+      #
+      expect(::File.read('lib/newcli/commands/server.rb')).to eq <<-EOS
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Newcli
+  module Commands
+    class Server < 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
+      EOS
+
+      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
+
+    desc 'server', 'Command description...'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def server(*)
+      if options[:help]
+        invoke :help, ['server']
+      else
+        require_relative 'commands/server'
+        Newcli::Commands::Server.new(options).execute
+      end
+    end
+  end
+end
+      EOS
+
+      # test setup
+      #
+      expect(::File.read('spec/integration/server_spec.rb')).to eq <<-EOS
+RSpec.describe "`newcli server` command", type: :cli do
+  it "executes `newcli help server` command successfully" do
+    output = `newcli help server`
+    expected_output = <<-OUT
+Usage:
+  newcli server
+
+Options:
+  -h, [--help], [--no-help]  # Display usage information
+
+Command description...
+    OUT
+
+    expect(output).to eq(expected_output)
+  end
+end
+      EOS
+
+      expect(::File.read('spec/unit/server_spec.rb')).to eq <<-EOS
+require 'newcli/commands/server'
+
+RSpec.describe Newcli::Commands::Server do
+  it "executes `server` command successfully" do
+    output = StringIO.new
+    options = {}
+    command = Newcli::Commands::Server.new(options)
+
+    command.execute(output: output)
+
+    expect(output.string).to eq("OK\\n")
+  end
+end
+      EOS
+
+    end
+  end
+
+  it "adds a command with minitests" do
+    app_name = tmp_path('newcli')
+    silent_run("teletype new #{app_name} --test minitest")
+
+    output = <<-OUT
+      create  test/integration/server_test.rb
+      create  test/unit/server_test.rb
+      create  lib/newcli/commands/server.rb
+      create  lib/newcli/templates/server/.gitkeep
+      inject  lib/newcli/cli.rb
+    OUT
+
+    within_dir(app_name) do
+      command = "teletype add server --no-color"
+
+      out, err, status = Open3.capture3(command)
+
+      expect(out).to match(output)
+      expect(err).to eq('')
+      expect(status.exitstatus).to eq(0)
+
+      # test setup
+      #
+      expect(::File.read('test/integration/server_test.rb')).to eq <<-EOS
+require 'test_helper'
+require 'newcli/commands/server'
+
+class Newcli::Commands::ServerTest < Minitest::Test
+  def test_executes_newcli_help_server_command_successfully
+    output = `newcli help server`
+    expected_output = <<-OUT
+Usage:
+  newcli server
+
+Options:
+  -h, [--help], [--no-help]  # Display usage information
+
+Command description...
+    OUT
+
+    assert_equal expected_output, output
+  end
+end
+      EOS
+
+      expect(::File.read('test/unit/server_test.rb')).to eq <<-EOS
+require 'test_helper'
+require 'newcli/commands/server'
+
+class Newcli::Commands::ServerTest < Minitest::Test
+  def test_executes_server_command_successfully
+    output = StringIO.new
+    options = {}
+    command = Newcli::Commands::Server.new(options)
+
+    command.execute(output: output)
+
+    assert_equal "OK\\n", output.string
+  end
+end
+      EOS
+    end
+  end
+
+  it "adds command in cli without any commands" do
+    app_path = tmp_path('newcli')
+    cli_template = <<-EOS
+require 'thor'
+
+module Newcli
+  class CLI < Thor
+  end
+end
+    EOS
+    dir = {
+      app_path => [
+        'lib' => [
+          'newcli' => [
+            ['cli.rb', cli_template]
+          ]
+        ]
+      ]
+    }
+
+    ::TTY::File.create_dir(dir, verbose: false)
+    within_dir(app_path) do
+      command = "teletype add server --no-color"
+
+      _, err, status = Open3.capture3(command)
+
+      expect(err).to eq('')
+      expect(status.exitstatus).to eq(0)
+
+      expect(::File.read('lib/newcli/cli.rb')).to eq <<-EOS
+require 'thor'
+
+module Newcli
+  class CLI < Thor
+
+    desc 'server', 'Command description...'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def server(*)
+      if options[:help]
+        invoke :help, ['server']
+      else
+        require_relative 'commands/server'
+        Newcli::Commands::Server.new(options).execute
+      end
+    end
+  end
+end
+      EOS
+    end
+  end
+
+  it "adds more than one command to cli file" do
+    app_path = tmp_path('newcli')
+    cli_template = <<-EOS
+require 'thor'
+
+module Newcli
+  class CLI < Thor
+  end
+end
+    EOS
+    dir = {
+      app_path => [
+        'lib' => [
+          'newcli' => [
+            ['cli.rb', cli_template]
+          ]
+        ]
+      ]
+    }
+
+    ::TTY::File.create_dir(dir, verbose: false)
+    within_dir(app_path) do
+      command_init = "teletype add init --no-color"
+
+      out, err, status = Open3.capture3(command_init)
+
+      expect(out).to eq <<-OUT
+      create  test/integration/init_test.rb
+      create  test/unit/init_test.rb
+      create  lib/newcli/commands/init.rb
+      create  lib/newcli/templates/init/.gitkeep
+      inject  lib/newcli/cli.rb
+      OUT
+      expect(err).to eq('')
+      expect(status.exitstatus).to eq(0)
+
+      expect(::File.read('lib/newcli/cli.rb')).to eq <<-EOS
+require 'thor'
+
+module Newcli
+  class CLI < Thor
+
+    desc 'init', 'Command description...'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def init(*)
+      if options[:help]
+        invoke :help, ['init']
+      else
+        require_relative 'commands/init'
+        Newcli::Commands::Init.new(options).execute
+      end
+    end
+  end
+end
+      EOS
+
+      command_clone = "teletype add clone --no-color"
+      out, err, status = Open3.capture3(command_clone)
+
+      expect(out).to eq <<-OUT
+      create  test/integration/clone_test.rb
+      create  test/unit/clone_test.rb
+      create  lib/newcli/commands/clone.rb
+      create  lib/newcli/templates/clone/.gitkeep
+      inject  lib/newcli/cli.rb
+      OUT
+      expect(err).to eq('')
+      expect(status.exitstatus).to eq(0)
+
+      expect(::File.read('lib/newcli/cli.rb')).to eq <<-EOS
+require 'thor'
+
+module Newcli
+  class CLI < Thor
+
+    desc 'clone', 'Command description...'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def clone(*)
+      if options[:help]
+        invoke :help, ['clone']
+      else
+        require_relative 'commands/clone'
+        Newcli::Commands::Clone.new(options).execute
+      end
+    end
+
+    desc 'init', 'Command description...'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def init(*)
+      if options[:help]
+        invoke :help, ['init']
+      else
+        require_relative 'commands/init'
+        Newcli::Commands::Init.new(options).execute
+      end
+    end
+  end
+end
+      EOS
+    end
+  end
+
+  it "adds complex command name as camel case" do
+    app_path = tmp_path('newcli')
+    cli_template = <<-EOS
+require 'thor'
+
+module Newcli
+  class CLI < Thor
+  end
+end
+    EOS
+    dir = {
+      app_path => [
+        'lib' => [
+          'newcli' => [
+            ['cli.rb', cli_template]
+          ]
+        ]
+      ]
+    }
+    ::TTY::File.create_dir(dir, verbose: false)
+    within_dir(app_path) do
+      command = "teletype add newServerCommand --no-color"
+
+      _, err, status = Open3.capture3(command)
+
+      expect(err).to eq('')
+      expect(status.exitstatus).to eq(0)
+
+      expect(::File.read('lib/newcli/commands/new_server_command.rb')).to eq <<-EOS
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Newcli
+  module Commands
+    class NewServerCommand < 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
+      EOS
+
+      expect(::File.read('lib/newcli/cli.rb')).to eq <<-EOS
+require 'thor'
+
+module Newcli
+  class CLI < Thor
+
+    desc 'new_server_command', 'Command description...'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def new_server_command(*)
+      if options[:help]
+        invoke :help, ['new_server_command']
+      else
+        require_relative 'commands/new_server_command'
+        Newcli::Commands::NewServerCommand.new(options).execute
+      end
+    end
+  end
+end
+      EOS
+    end
+  end
+
+  it "adds complex command name as snake case" do
+    app_path = tmp_path('newcli')
+    cli_template = <<-EOS
+require 'thor'
+
+module Newcli
+  class CLI < Thor
+  end
+end
+    EOS
+    dir = {
+      app_path => [
+        'lib' => [
+          'newcli' => [
+            ['cli.rb', cli_template]
+          ]
+        ]
+      ]
+    }
+    ::TTY::File.create_dir(dir, verbose: false)
+
+    within_dir(app_path) do
+      command = "teletype add new_server_command --no-color"
+
+      _, err, status = Open3.capture3(command)
+
+      expect(err).to eq('')
+      expect(status.exitstatus).to eq(0)
+
+      expect(::File.read('lib/newcli/commands/new_server_command.rb')).to eq <<-EOS
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Newcli
+  module Commands
+    class NewServerCommand < 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
+      EOS
+
+      expect(::File.read('lib/newcli/cli.rb')).to eq <<-EOS
+require 'thor'
+
+module Newcli
+  class CLI < Thor
+
+    desc 'new_server_command', 'Command description...'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def new_server_command(*)
+      if options[:help]
+        invoke :help, ['new_server_command']
+      else
+        require_relative 'commands/new_server_command'
+        Newcli::Commands::NewServerCommand.new(options).execute
+      end
+    end
+  end
+end
+      EOS
+    end
+  end
+
+  it "fails without command name" do
+    output = <<-OUT.unindent
+      ERROR: 'teletype add' was called with no arguments
+      Usage: 'teletype add COMMAND_NAME'\n
+    OUT
+    command = "teletype add"
+    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 add COMMAND [SUBCOMMAND] [OPTIONS]
+
+Options:
+  -a, [--args=arg1 arg2]           # List command argument names
+  -d, [--desc=DESC]                # Describe command's purpose
+  -f, [--force]                    # Overwrite existing command
+  -h, [--help], [--no-help]        # Display usage information
+  -t, [--test=rspec]               # Generate a test setup
+                                   # 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 add` will create a new command and place it into appropriate 
+  structure in the cli app.
+
+  Example: teletype add config --desc 'Set and get configuration options'
+
+  This generates a command in app/commands/config.rb
+
+  You can also add subcommands
+
+  Example: teletype add config server
+
+  This generates a command in app/commands/config/server.rb
+    OUT
+
+    command = "teletype add --help"
+    out, err, status = Open3.capture3(command)
+    expect(out).to eq(output)
+    expect(err).to eq('')
+    expect(status.exitstatus).to eq(0)
+  end
+end