Class: Tapioca::Cli

Inherits:

Thor

• Object
• Thor
• Tapioca::Cli

Includes:

CliHelper, ConfigHelper, ShimsHelper, SorbetHelper

Defined in:

lib/tapioca/cli.rb

Constant Summary

FILE_HEADER_OPTION_DESC =

"Add a \"This file is generated\" header on top of each generated RBI file"

Constants included from ShimsHelper

ShimsHelper::SORBET_PAYLOAD_URL

Constants included from SorbetHelper

SorbetHelper::FEATURE_REQUIREMENTS, SorbetHelper::SORBET_BIN, SorbetHelper::SORBET_EXE_PATH_ENV_VAR, SorbetHelper::SORBET_GEM_SPEC

Instance Attribute Summary

Attributes included from ConfigHelper

#command_name, #defaults

Instance Method Summary

• #__print_version ⇒ Object
• #annotations ⇒ Object
• #check_shims ⇒ Object
• #dsl(*constants) ⇒ Object
• #gem(*gems) ⇒ Object
• #init ⇒ Object
• #require ⇒ Object
• #todo ⇒ Object

Methods included from ShimsHelper

#duplicated_nodes_from_index, #index_payload, #index_rbis, #location_to_payload_url

Methods included from SorbetHelper

#sorbet, #sorbet_path, #sorbet_supports?

Methods included from ConfigHelper

#initialize, #options

Methods included from CliHelper

#rbi_formatter, #say_error

Instance Method Details

#__print_version ⇒ Object

# File 'lib/tapioca/cli.rb', line 314

def __print_version
  puts "Tapioca v#{Tapioca::VERSION}"
end

#annotations ⇒ Object

# File 'lib/tapioca/cli.rb', line 306

def annotations
  command = Commands::Annotations.new(central_repo_root_uri: options[:repo_uri])
  command.execute
end

#check_shims ⇒ Object

# File 'lib/tapioca/cli.rb', line 247

def check_shims
  index = RBI::Index.new

  shim_rbi_dir = options[:shim_rbi_dir]
  if !Dir.exist?(shim_rbi_dir) || Dir.empty?(shim_rbi_dir)
    say("No shim RBIs to check", :green)
    exit(0)
  end

  payload_path = T.let(nil, T.nilable(String))

  if options[:payload]
    if sorbet_supports?(:print_payload_sources)
      Dir.mktmpdir do |dir|
        payload_path = dir
        result = sorbet("--no-config --print=payload-sources:#{payload_path}")

        unless result.status
          say_error("Sorbet failed to dump payload")
          say_error(result.err)
          exit(1)
        end

        index_payload(index, payload_path)
      end
    else
      say_error("The version of Sorbet used in your Gemfile.lock does not support `--print=payload-sources`")
      say_error("Current: v#{SORBET_GEM_SPEC.version}")
      say_error("Required: #{FEATURE_REQUIREMENTS[:print_payload_sources]}")
      exit(1)
    end
  end

  index_rbis(index, "shim", shim_rbi_dir)
  index_rbis(index, "gem", options[:gem_rbi_dir])
  index_rbis(index, "dsl", options[:dsl_rbi_dir])

  duplicates = duplicated_nodes_from_index(index, shim_rbi_dir)
  unless duplicates.empty?
    duplicates.each do |key, nodes|
      say_error("\nDuplicated RBI for #{key}:", :red)
      nodes.each do |node|
        node_loc = node.loc
        next unless node_loc

        loc_string = location_to_payload_url(node_loc, path_prefix: payload_path)
        say_error(" * #{loc_string}", :red)
      end
    end
    say_error("\nPlease remove the duplicated definitions from the #{shim_rbi_dir} directory.", :red)
    exit(1)
  end

  say("\nNo duplicates found in shim RBIs", :green)
  exit(0)
end

#dsl(*constants) ⇒ Object

# File 'lib/tapioca/cli.rb', line 104

def dsl(*constants)
  command = Commands::Dsl.new(
    requested_constants: constants,
    outpath: Pathname.new(options[:outdir]),
    only: options[:only],
    exclude: options[:exclude],
    file_header: options[:file_header],
    compiler_path: Tapioca::Dsl::Compilers::DIRECTORY,
    tapioca_path: TAPIOCA_DIR,
    should_verify: options[:verify],
    quiet: options[:quiet],
    verbose: options[:verbose],
    number_of_workers: options[:workers],
    rbi_formatter: rbi_formatter(options)
  )

  if options[:workers] != 1
    say(
      "Using more than one worker is experimental and might produce results that are not deterministic",
      :red
    )
  end

  Tapioca.silence_warnings do
    command.execute
  end
end

#gem(*gems) ⇒ Object

# File 'lib/tapioca/cli.rb', line 198

def gem(*gems)
  Tapioca.silence_warnings do
    all = options[:all]
    verify = options[:verify]

    command = Commands::Gem.new(
      gem_names: all ? [] : gems,
      exclude: options[:exclude],
      prerequire: options[:prerequire],
      postrequire: options[:postrequire],
      typed_overrides: options[:typed_overrides],
      outpath: Pathname.new(options[:outdir]),
      file_header: options[:file_header],
      doc: options[:doc],
      include_exported_rbis: options[:exported_gem_rbis],
      number_of_workers: options[:workers],
      auto_strictness: options[:auto_strictness],
      dsl_dir: options[:dsl_dir],
      rbi_formatter: rbi_formatter(options)
    )

    raise MalformattedArgumentError, "Options '--all' and '--verify' are mutually exclusive" if all && verify

    unless gems.empty?
      raise MalformattedArgumentError, "Option '--all' must be provided without any other arguments" if all
      raise MalformattedArgumentError, "Option '--verify' must be provided without any other arguments" if verify
    end

    if options[:workers] != 1
      say(
        "Using more than one worker is experimental and might produce results that are not deterministic",
        :red
      )
    end

    if gems.empty? && !all
      command.sync(should_verify: verify)
    else
      command.execute
    end
  end
end

#init ⇒ Object

# File 'lib/tapioca/cli.rb', line 26

def init
  command = Commands::Init.new(
    sorbet_config: SORBET_CONFIG_FILE,
    tapioca_config: TAPIOCA_CONFIG_FILE,
    default_postrequire: DEFAULT_POSTREQUIRE_FILE
  )
  command.execute
end

#require ⇒ Object

# File 'lib/tapioca/cli.rb', line 37

def require
  command = Commands::Require.new(
    requires_path: options[:postrequire],
    sorbet_config_path: SORBET_CONFIG_FILE
  )
  Tapioca.silence_warnings do
    command.execute
  end
end

#todo ⇒ Object

# File 'lib/tapioca/cli.rb', line 56

def todo
  command = Commands::Todo.new(
    todo_file: options[:todo_file],
    file_header: options[:file_header]
  )
  Tapioca.silence_warnings do
    command.execute
  end
end