def get_project_files(log_printer,
printer,
project_dir,
file_path_completer,
non_interactive=False):
"""
Gets the list of files matching files in the user's project directory
after prompting for glob expressions.
:param log_printer:
A ``LogPrinter`` object.
:param printer:
A ``ConsolePrinter`` object.
:param file_path_completer:
A ``file_path_completer`` object.
:param non_interactive
Whether coala-quickstart is in non-interactive mode
:return:
A list of file paths matching the files.
"""
file_globs = ['**']
ignore_globs = None
if os.path.isfile(os.path.join(project_dir, '.gitignore')):
printer.print(
'The contents of your .gitignore file for the project '
'will be automatically loaded as the files to ignore.',
color='green')
ignore_globs = get_gitignore_glob(project_dir)
if non_interactive and not ignore_globs:
ignore_globs = []
if ignore_globs is None:
printer.print(GLOB_HELP)
file_path_completer.activate(seed_dir=project_dir)
ignore_globs = ask_question(
'Which files do you want coala to ignore inside the '
'project directory?',
printer=printer,
typecast=list)
file_path_completer.deactivate()
printer.print()
ignore_globs = list(ignore_globs)
escaped_project_dir = glob_escape(project_dir)
file_path_globs = [
os.path.join(escaped_project_dir, glob_exp) for glob_exp in file_globs
]
ignore_path_globs = [
os.path.join(escaped_project_dir, glob_exp)
for glob_exp in ignore_globs
]
ignore_path_globs.append(os.path.join(escaped_project_dir, '.git/**'))
file_paths = collect_files(file_path_globs,
log_printer,
ignored_file_paths=ignore_path_globs)
return file_paths, ignore_globs
def test_invalid_answer_type(self):
with simulate_console_inputs("test", "42"), \
retrieve_stdout() as custom_stdout:
response = ask_question(self.question_text, typecast=int)
self.assertIn("Please enter a", custom_stdout.getvalue())
self.assertEqual(response, 42)
def test_question_caption(self):
with simulate_console_inputs(""), retrieve_stdout() as custom_stdout:
response = ask_question(self.question_text, default=self.caption)
self.assertIn(
self.question_text + " \x1b[0m[" + self.caption + "]",
custom_stdout.getvalue())
self.assertEqual(response, self.caption)
def main():
arg_parser = _get_arg_parser()
args = arg_parser.parse_args()
printer = ConsolePrinter()
log_printer = LogPrinter(printer)
project_dir = os.getcwd()
if not args.non_interactive:
print_welcome_message(printer)
project_dir = ask_question("What is your project directory?",
default=project_dir,
typecast=valid_path)
project_files, ignore_globs = get_project_files(log_printer, printer,
project_dir)
used_languages = list(get_used_languages(project_files))
print_used_languages(printer, used_languages)
relevant_bears = filter_relevant_bears(used_languages, arg_parser)
print_relevant_bears(printer, relevant_bears)
if args.non_interactive:
unusable_bears = get_non_optional_settings_bears(relevant_bears)
remove_unusable_bears(relevant_bears, unusable_bears)
print_relevant_bears(printer, relevant_bears, 'usable')
settings = generate_settings(project_dir, project_files, ignore_globs,
relevant_bears)
write_coafile(printer, project_dir, settings)
def test_ask_question(self):
with simulate_console_inputs(self.simulated_input),\
retrieve_stdout() as custom_stdout:
response = ask_question(self.question_text,
default=None,
printer=self.printer)
self.assertIn(self.question_text, custom_stdout.getvalue())
self.assertEqual(response, self.simulated_input)
def main():
arg_parser = _get_arg_parser()
args = arg_parser.parse_args()
logging.basicConfig(stream=sys.stdout)
printer = ConsolePrinter()
logging.getLogger(__name__)
fpc = None
project_dir = os.getcwd()
if args.green_mode:
args.non_interactive = None
args.no_filter_by_capabilities = None
args.incomplete_sections = None
if not args.non_interactive and not args.green_mode:
fpc = FilePathCompleter()
fpc.activate()
print_welcome_message(printer)
printer.print(PROJECT_DIR_HELP)
project_dir = ask_question('What is your project directory?',
default=project_dir,
typecast=valid_path)
fpc.deactivate()
project_files, ignore_globs = get_project_files(None, printer, project_dir,
fpc, args.non_interactive)
used_languages = list(get_used_languages(project_files))
print_used_languages(printer, used_languages)
extracted_information = collect_info(project_dir)
relevant_bears = filter_relevant_bears(used_languages, printer, arg_parser,
extracted_information)
if args.green_mode:
collect_bear_settings(relevant_bears)
print_relevant_bears(printer, relevant_bears)
if args.non_interactive and not args.incomplete_sections:
unusable_bears = get_non_optional_settings_bears(relevant_bears)
remove_unusable_bears(relevant_bears, unusable_bears)
print_relevant_bears(printer, relevant_bears, 'usable')
settings = generate_settings(project_dir, project_files, ignore_globs,
relevant_bears, extracted_information,
args.incomplete_sections)
write_coafile(printer, project_dir, settings)
def get_project_files(log_printer, printer, project_dir):
"""
Gets the list of files matching files in the user's project directory
after prompting for glob expressions.
:param log_printer:
A ``LogPrinter`` object.
:param printer:
A ``ConsolePrinter`` object.
:return:
A list of file paths matching the files.
"""
printer.print(GLOB_HELP)
file_globs = ask_question(
"Which files do you want coala to run on?",
default="**",
printer=printer,
typecast=list)
ignore_globs = ask_question(
"Which files do you want coala to run on?",
printer=printer,
typecast=list)
printer.print()
escaped_project_dir = glob_escape(project_dir)
file_path_globs = [os.path.join(
escaped_project_dir, glob_exp) for glob_exp in file_globs]
ignore_path_globs = [os.path.join(
escaped_project_dir, glob_exp) for glob_exp in ignore_globs]
file_paths = collect_files(
file_path_globs,
log_printer,
ignored_file_paths=ignore_path_globs)
return file_paths
def get_project_files(log_printer, printer, project_dir):
"""
Gets the list of files matching files in the user's project directory
after prompting for glob expressions.
:param log_printer:
A ``LogPrinter`` object.
:param printer:
A ``ConsolePrinter`` object.
:return:
A list of file paths matching the files.
"""
file_globs = ["**"]
ignore_globs = None
if os.path.isfile(os.path.join(project_dir, ".gitignore")):
printer.print(
"The contents of your .gitignore file for the project "
"will be automatically loaded as the files to ignore.",
color="green")
ignore_globs = get_gitignore_glob(project_dir)
if ignore_globs is None:
printer.print(GLOB_HELP)
ignore_globs = ask_question("Which files do you want coala to ignore?",
printer=printer,
typecast=list)
printer.print()
escaped_project_dir = glob_escape(project_dir)
file_path_globs = [
os.path.join(escaped_project_dir, glob_exp) for glob_exp in file_globs
]
ignore_path_globs = [
os.path.join(escaped_project_dir, glob_exp)
for glob_exp in ignore_globs
]
ignore_path_globs.append(os.path.join(escaped_project_dir, ".git/**"))
file_paths = collect_files(file_path_globs,
log_printer,
ignored_file_paths=ignore_path_globs)
return file_paths, ignore_globs
def main():
printer = ConsolePrinter()
log_printer = LogPrinter(printer)
print_welcome_message(printer)
project_dir = ask_question("What is your project directory?",
default=os.getcwd(),
typecast=valid_path)
project_files, ignore_globs = get_project_files(log_printer, printer,
project_dir)
used_languages = list(get_used_languages(project_files))
print_used_languages(printer, used_languages)
relevant_bears = filter_relevant_bears(used_languages)
print_relevant_bears(printer, relevant_bears)
settings = generate_settings(project_dir, project_files, ignore_globs,
relevant_bears)
write_coafile(printer, project_dir, settings)
def get_project_files(log_printer,
printer,
project_dir,
file_path_completer,
non_interactive=False):
"""
Gets the list of files matching files in the user's project directory
after prompting for glob expressions.
:param log_printer:
A ``LogPrinter`` object.
:param printer:
A ``ConsolePrinter`` object.
:param file_path_completer:
A ``file_path_completer`` object.
:param non_interactive
Whether coala-quickstart is in non-interactive mode
:return:
A list of file paths matching the files.
"""
file_globs = ['**']
ignore_globs = None
gitignore_dir_list = []
for dir_name, subdir_name, file_list in os.walk(project_dir):
if os.path.isfile(os.path.join(dir_name, '.gitignore')):
gitignore_dir_list += [dir_name]
if gitignore_dir_list:
printer.print('The contents of your .gitignore file for the project '
'will be automatically loaded as the files to ignore.',
color='green')
ignore_globs = get_gitignore_glob(project_dir, gitignore_dir_list)
if non_interactive and not ignore_globs:
ignore_globs = []
if ignore_globs is None:
printer.print(GLOB_HELP)
file_path_completer.activate(seed_dir=project_dir)
ignore_globs = ask_question(
'Which files do you want coala to ignore inside the '
'project directory?',
printer=printer,
typecast=list)
file_path_completer.deactivate()
printer.print()
ignore_globs = list(ignore_globs)
escaped_project_dir = glob_escape(project_dir)
file_path_globs = [os.path.join(
escaped_project_dir, glob_exp) for glob_exp in file_globs]
ignore_path_globs = [os.path.join(
escaped_project_dir, glob_exp) for glob_exp in ignore_globs]
ignore_path_globs.append(os.path.join(escaped_project_dir, '.git/**'))
file_paths = collect_files(
file_path_globs,
log_printer,
ignored_file_paths=ignore_path_globs)
return file_paths, ignore_globs
def main():
global MAX_ARGS_GREEN_MODE, MAX_VALUES_GREEN_MODE
arg_parser = _get_arg_parser()
args = arg_parser.parse_args()
logging.basicConfig(stream=sys.stdout)
printer = ConsolePrinter()
logging.getLogger(__name__)
fpc = None
project_dir = os.getcwd()
if args.green_mode:
args.no_filter_by_capabilities = None
args.incomplete_sections = None
if args.max_args:
MAX_ARGS_GREEN_MODE = args.max_args
if args.max_values:
MAX_VALUES_GREEN_MODE = args.max_values
if not args.green_mode and (args.max_args or args.max_values):
logging.warning(' --max-args and --max-values can be used '
'only with --green-mode. The arguments will '
'be ignored.')
if not args.non_interactive and not args.green_mode:
fpc = FilePathCompleter()
fpc.activate()
print_welcome_message(printer)
printer.print(PROJECT_DIR_HELP)
project_dir = ask_question(
'What is your project directory?',
default=project_dir,
typecast=valid_path)
fpc.deactivate()
project_files, ignore_globs = get_project_files(
None,
printer,
project_dir,
fpc,
args.non_interactive)
used_languages = list(get_used_languages(project_files))
used_languages = ask_to_select_languages(used_languages, printer,
args.non_interactive)
extracted_information = collect_info(project_dir)
relevant_bears = filter_relevant_bears(
used_languages, printer, arg_parser, extracted_information)
if args.green_mode:
bear_settings_obj = collect_bear_settings(relevant_bears)
green_mode(
project_dir, ignore_globs, relevant_bears, bear_settings_obj,
MAX_ARGS_GREEN_MODE,
MAX_VALUES_GREEN_MODE,
project_files,
printer,
)
exit()
print_relevant_bears(printer, relevant_bears)
if args.non_interactive and not args.incomplete_sections:
unusable_bears = get_non_optional_settings_bears(relevant_bears)
remove_unusable_bears(relevant_bears, unusable_bears)
print_relevant_bears(printer, relevant_bears, 'usable')
settings = generate_settings(
project_dir,
project_files,
ignore_globs,
relevant_bears,
extracted_information,
args.incomplete_sections)
write_coafile(printer, project_dir, settings)
def main():
global MAX_ARGS_GREEN_MODE, MAX_VALUES_GREEN_MODE
arg_parser = _get_arg_parser()
args = arg_parser.parse_args()
logging.basicConfig(stream=sys.stdout)
printer = ConsolePrinter()
logging.getLogger(__name__)
fpc = None
project_dir = os.getcwd()
if args.green_mode:
args.no_filter_by_capabilities = None
args.incomplete_sections = None
if args.max_args:
MAX_ARGS_GREEN_MODE = args.max_args
if args.max_values:
MAX_VALUES_GREEN_MODE = args.max_values
if not args.green_mode and (args.max_args or args.max_values):
logging.warning(' --max-args and --max-values can be used '
'only with --green-mode. The arguments will '
'be ignored.')
if not args.non_interactive and not args.green_mode:
fpc = FilePathCompleter()
fpc.activate()
print_welcome_message(printer)
printer.print(PROJECT_DIR_HELP)
project_dir = ask_question('What is your project directory?',
default=project_dir,
typecast=valid_path)
fpc.deactivate()
project_files, ignore_globs = get_project_files(None, printer, project_dir,
fpc, args.non_interactive)
used_languages = list(get_used_languages(project_files))
used_languages = ask_to_select_languages(used_languages, printer,
args.non_interactive)
extracted_information = collect_info(project_dir)
relevant_bears = filter_relevant_bears(used_languages, printer, arg_parser,
extracted_information)
if args.green_mode:
bear_settings_obj = collect_bear_settings(relevant_bears)
green_mode(
project_dir,
ignore_globs,
relevant_bears,
bear_settings_obj,
MAX_ARGS_GREEN_MODE,
MAX_VALUES_GREEN_MODE,
project_files,
printer,
)
exit()
print_relevant_bears(printer, relevant_bears)
if args.non_interactive and not args.incomplete_sections:
unusable_bears = get_non_optional_settings_bears(relevant_bears)
remove_unusable_bears(relevant_bears, unusable_bears)
print_relevant_bears(printer, relevant_bears, 'usable')
settings = generate_settings(project_dir, project_files, ignore_globs,
relevant_bears, extracted_information,
args.incomplete_sections)
write_coafile(printer, project_dir, settings)
def test_question_typecast(self):
with simulate_console_inputs("apples, mangoes"), suppress_stdout():
response = ask_question(self.question_text, typecast=list)
self.assertEqual(response, ["apples", "mangoes"])
