Merge pull request #152 from mbland/modules-1-of-2

Refactor `./go modules`, list project modules before plugins

Author: mbland

lib/strings

@@ -27,9 +27,12 @@ export __GO_STRINGS_VALIDATION_SKIP_CALLERS=2
 # Splits fields from a delimited string into an array defined by the caller
 #
 # While `IFS= read -ra array_name <<<"$value"` is idiomatic, this function
-# guards against a bug in Bash 4.2.25 (the version in the Ubuntu Precise image
-# used by Travis CI) and not fixed until 4.2.41 whereby the temporary
-# environment of `IFS= read` isn't honored when running in a process
+# handles two situations. First, it handles splitting strings whose items
+# themselves contain newline characters.
+#
+# Second, it guards against a bug in Bash 4.2.25 (the version in the Ubuntu
+# Precise image used by Travis CI) and not fixed until 4.2.41 whereby the
+# temporary environment of `IFS= read` isn't honored when running in a process
 # substitution. For details, see the message for commit
 # 99ab7805e6ef0a14568d8a100eec03bb2cb03631.
 #
@@ -46,7 +49,22 @@ export __GO_STRINGS_VALIDATION_SKIP_CALLERS=2
 @go.split() {
   @go.validate_identifier_or_die 'Result array name' "$3"
   local IFS="$1"
-  read -ra "$3" <<<"$2"
+
+  # There are a few subtle interactions handled here.
+  #
+  # To handle items containing newlines, we set `-d ''` so that `read` will
+  # read the entire `value` string (i.e. `$2`). To avoid an EOF error on what
+  # should be a successful read with `-d ''`, we set `-n "${#2}"` to read
+  # exactly the number of characters in `value`.
+  #
+  # When `value` is the empty string, `<<<` will add a newline which will be
+  # read even with `read -n 0` being in effect. Consequently, we `unset` the
+  # result array explicitly (something normally handled by `read -a`) and only
+  # call `read` when the string is not empty.
+  unset "$3"
+  if [[ "${#2}" -ne '0' ]]; then
+    read -ra "$3" -n "${#2}" -d '' <<<"$2"
+  fi
 }
 
 # Joins multiple items into a string variable defined by the caller

libexec/modules

@@ -46,17 +46,25 @@
 # For detailed information about the module system, run `{{go}} {{cmd}} --help`
 # without a `<module-name>` argument.
 
+# Imports the functions from `lib/internal/use`. Since the last line invokes
+# `_@go.use_modules`, this wrapper ensures the argument list is empty to avoid
+# having it attempt to process this command script's argument array.
+_@go.modules_import_use_modules_functions() {
+  . "$_GO_USE_MODULES"
+}
+_@go.modules_import_use_modules_functions
+
 _@go.modules_help() {
-  local module_name="$1"
-  local __go_module_path
+  local __go_module_name="$1"
+  local __go_module_file
 
   if [[ "$#" -eq '0' ]]; then
-    module_name='$_GO_USE_MODULES'
-    __go_module_path="$_GO_USE_MODULES"
+    __go_module_name='$_GO_USE_MODULES'
+    __go_module_file="$_GO_USE_MODULES"
   elif [[ "$#" -ne '1' ]]; then
     @go.printf "Please specify only one module name.\n" >&2
     return 1
-  elif ! _@go.modules_path "$module_name"; then
+  elif ! _@go.find_module; then
     @go.printf "Unknown module: $1\n" >&2
     return 1
   fi
@@ -65,33 +73,12 @@ _@go.modules_help() {
 
   . "$_GO_CORE_DIR/lib/internal/command_descriptions"
 
-  if ! _@go.command_description "$__go_module_path"; then
+  if ! _@go.command_description "$__go_module_file"; then
     @go.printf "ERROR: failed to parse description from %s\n" \
-      "$__go_module_path" >&2
+      "$__go_module_file" >&2
     return 1
   fi
-  @go.printf "$module_name - $__go_cmd_desc\n"
-}
-
-_@go.modules_path() {
-  local module_name="$1"
-
-  __go_module_path="$_GO_CORE_DIR/lib/$module_name"
-  if [[ -f "$__go_module_path" ]]; then
-    return
-  fi
-
-  # Convert <plugin>/<module> to _GO_PLUGINS_DIR/<plugin>/lib/<module>
-  __go_module_path="$_GO_PLUGINS_DIR/${module_name/\///lib/}"
-  if [[ -n "$_GO_PLUGINS_DIR" && -f "$__go_module_path" ]]; then
-    return
-  fi
-
-  __go_module_path="$_GO_SCRIPTS_DIR/lib/$module_name"
-  if [[ -f "$__go_module_path" ]]; then
-    return
-  fi
-  return 1
+  @go.printf "$__go_module_name - $__go_cmd_desc\n"
 }
 
 _@go.modules_find_all_in_dir() {
@@ -149,33 +136,34 @@ _@go.modules_produce_listing() {
     return
   fi
 
-  . "$_GO_CORE_DIR/lib/format"
-
-  local padded_modules=()
-  local zipped_modules=()
-
-  @go.pad_items padded_modules "${modules[@]}"
-  modules=("${padded_modules[@]}")
+  . "$_GO_USE_MODULES" 'format'
+  @go.pad_items modules "${modules[@]}"
 
   case "$action" in
   paths)
     local relative_paths=("${__go_modules[@]#$_GO_ROOTDIR/}")
-    @go.zip_items modules relative_paths '  ' zipped_modules
+    @go.zip_items modules relative_paths '  ' modules
     ;;
   summaries)
     local __go_modules_summaries=()
     if ! _@go.modules_summaries; then
       return 1
     fi
-    @go.zip_items modules __go_modules_summaries '  ' zipped_modules
+    @go.zip_items modules __go_modules_summaries '  ' modules
     ;;
   *)
     # Should only happen if _@go.modules is updated and this case statement
     # isn't.
     @go.printf 'ERROR: Unknown action: %s\n' "$action" >&2
     return 1
   esac
-  __go_modules_listing=("${zipped_modules[@]}")
+  __go_modules_listing=("${modules[@]}")
+}
+
+_@go.modules_search_plugins() {
+  for plugin in "$1/"${plugin_glob[0]:-*}; do
+    _@go.modules_find_all_in_dir "$plugin" "${plugin_glob[1]:-*}"
+  done
 }
 
 _@go.modules_search() {
@@ -194,15 +182,11 @@ _@go.modules_search() {
   _@go.modules_find_all_in_dir "$_GO_CORE_DIR" "$glob"
   __go_core_modules_end="${#__go_modules[@]}"
 
-  if [[ -n "$_GO_PLUGINS_DIR" ]]; then
-    for plugin in "$_GO_PLUGINS_DIR/"${plugin_glob[0]:-*}; do
-      _@go.modules_find_all_in_dir "$plugin" "${plugin_glob[1]:-*}"
-    done
-  fi
-  __go_plugin_modules_end="${#__go_modules[@]}"
-
   _@go.modules_find_all_in_dir "$_GO_SCRIPTS_DIR" "$glob"
   __go_project_modules_end="${#__go_modules[@]}"
+
+  @go.search_plugins '_@go.modules_search_plugins'
+  __go_plugin_modules_end="${#__go_modules[@]}"
 }
 
 _@go.modules_emit_class() {
@@ -215,61 +199,90 @@ _@go.modules_emit_class() {
 
   if [[ "${#__go_modules[@]}" -ne '0' ]] &&
         _@go.modules_produce_listing "$action"; then
-    local IFS=$'\n'
-    printf "From the %s:\n%s\n\n" "$class" "${__go_modules_listing[*]/#/  }"
+    printf 'From the %s:\n' "$class"
+    printf '%s\n' "${__go_modules_listing[@]/#/  }" ''
   fi
 }
 
 _@go.modules_list_by_class() {
   local action="$1"
   local __go_modules=()
   local __go_core_modules_end=0
-  local __go_plugin_modules_end=0
   local __go_project_modules_end=0
+  local __go_plugin_modules_end=0
   local __go_all_modules
 
   _@go.modules_search
   __go_all_modules=("${__go_modules[@]}")
   _@go.modules_emit_class 'core framework library' "$action" \
     0 "$__go_core_modules_end"
-  _@go.modules_emit_class 'installed plugin libraries' "$action" \
-    "$__go_core_modules_end" "$__go_plugin_modules_end"
   _@go.modules_emit_class 'project library' "$action" \
-    "$__go_plugin_modules_end" "$__go_project_modules_end"
+    "$__go_core_modules_end" "$__go_project_modules_end"
+  _@go.modules_emit_class 'installed plugin libraries' "$action" \
+    "$__go_project_modules_end" "$__go_plugin_modules_end"
 }
 
 _@go.modules_list() {
   local action="$1"
   shift
   local module_specs=("$@")
   local __go_modules=()
-  local __go_module_path
-  local module_spec
+  local __go_module_name
+  local __go_module_file
 
-  for module_spec in "${module_specs[@]}"; do
-    if [[ "$module_spec" == '*' ]]; then
+  for __go_module_name in "${module_specs[@]}"; do
+    if [[ "$__go_module_name" == '*' ]]; then
       if [[ "${#module_specs[@]}" -ne 1 ]]; then
         @go.printf "Do not specify other patterns when '*' is present.\n" >&2
         return 1
       fi
       _@go.modules_search
-    elif [[ "$module_spec" =~ \*|/$ ]]; then
-      _@go.modules_search "$module_spec"
-    elif ! _@go.modules_path "$module_spec"; then
-      @go.printf "Unknown module: $module_spec\n" >&2
+    elif [[ "$__go_module_name" =~ \*|/$ ]]; then
+      _@go.modules_search "$__go_module_name"
+    elif ! _@go.find_module; then
+      @go.printf "Unknown module: $__go_module_name\n" >&2
       return 1
     else
-      __go_modules+=("$__go_module_path")
+      __go_modules+=("$__go_module_file")
     fi
   done
 
   local __go_modules_listing=()
-  if _@go.modules_produce_listing "$action"; then
-    local IFS=$'\n'
-    echo "${__go_modules_listing[*]}"
-  else
+  if ! _@go.modules_produce_listing "$action"; then
     return 1
   fi
+  printf '%s\n' "${__go_modules_listing[@]}"
+}
+
+_@go.modules_tab_completion_plugins() {
+  local plugin
+
+  # `glob` indicates specific plugin module.
+  if [[ "$glob" =~ / ]]; then
+    plugin="${glob%/*}"
+    _@go.modules_find_all_in_dir "$1/$plugin" "${glob#*/}*"
+    return
+  fi
+
+  # Otherwise collect all plugin modules and the names of the plugins to
+  # which they belong. Which set gets returned will be decided at the end.
+  for plugin in "$1"/$glob; do
+    _@go.modules_find_all_in_dir "$plugin"
+    if [[ "${#__go_modules[@]}" -eq '0' ]]; then
+      continue
+    fi
+
+    __go_modules=("${__go_modules[@]#$1/}")
+    __go_modules=("${__go_modules[@]/\/lib\///}")
+    @go.complete_remove_completions_already_present 'args' '__go_modules' \
+      "${#__go_modules[@]}"
+
+    if [[ "${#__go_modules[@]}" -ne '0' ]]; then
+      plugins+=("$plugin/")
+      plugin_modules+=("${__go_modules[@]}")
+      __go_modules=()
+    fi
+  done
 }
 
 _@go.modules_tab_completion() {
@@ -304,37 +317,7 @@ _@go.modules_tab_completion() {
   local plugin_modules=()
 
   . "$_GO_USE_MODULES" 'complete'
-
-  if [[ -n "$_GO_PLUGINS_DIR" ]]; then
-    local plugin
-
-    # Complete a specific plugin module (word contains a '/').
-    if [[ "$glob" =~ / ]]; then
-      plugin="${glob%/*}"
-      _@go.modules_find_all_in_dir "$_GO_PLUGINS_DIR/$plugin" "${glob#*/}*"
-
-    else
-      # Otherwise collect all plugin modules and the names of the plugins to
-      # which they belong. Which set gets returned will be decided at the end.
-      for plugin in "$_GO_PLUGINS_DIR"/$glob; do
-        _@go.modules_find_all_in_dir "$plugin"
-        if [[ "${#__go_modules[@]}" -eq '0' ]]; then
-          continue
-        fi
-
-        __go_modules=("${__go_modules[@]#$_GO_PLUGINS_DIR/}")
-        __go_modules=("${__go_modules[@]/\/lib\///}")
-        @go.complete_remove_completions_already_present \
-          'args' '__go_modules' "${#__go_modules[@]}"
-
-        if [[ "${#__go_modules[@]}" -ne '0' ]]; then
-          plugins+=("$plugin/")
-          plugin_modules+=("${__go_modules[@]}")
-          __go_modules=()
-        fi
-      done
-    fi
-  fi
+  @go.search_plugins '_@go.modules_tab_completion_plugins'
 
   # Don't search other dirs if completing a plugin (word contains a '/').
   if [[ ! "$glob" =~ / ]]; then
@@ -352,15 +335,35 @@ _@go.modules_tab_completion() {
   fi
 
   local __go_modules_listing=()
-  if _@go.modules_produce_listing; then
-    completions+=("${__go_modules_listing[@]}")
-    @go.complete_remove_completions_already_present \
-      'args' 'completions' "${#completions[@]}"
-    echo "${completions[@]}"
-  else
+  if ! _@go.modules_produce_listing; then
     # Shouldn't happen, since modules_produce_listing isn't parsing summaries.
     return 1
   fi
+  completions+=("${__go_modules_listing[@]}")
+  @go.complete_remove_completions_already_present \
+    'args' 'completions' "${#completions[@]}"
+  echo "${completions[@]}"
+}
+
+_@go.modules_list_imported() {
+  if [[ "$#" -ne 0 ]]; then
+    @go.printf 'The --imported option takes no other arguments.\n' >&2
+    return 1
+  fi
+
+  # Collect imported module info before _GO_USE_MODULES imports possibly more.
+  local imported_modules=("${_GO_IMPORTED_MODULES[@]}")
+  local imported_files=("${_GO_IMPORTED_MODULE_FILES[@]#$_GO_ROOTDIR/}")
+  local imported_callers=("${_GO_IMPORTED_MODULE_CALLERS[@]#$_GO_ROOTDIR/}")
+  local caller_pad
+  local imported_listing=()
+
+  . "$_GO_USE_MODULES" 'format'
+  @go.pad_items imported_modules "${imported_modules[@]}"
+  @go.zip_items imported_modules imported_files '  ' imported_listing
+  printf -v 'caller_pad' -- "\n%$((${#imported_modules[0]} + 4))s" ''
+  @go.zip_items imported_listing imported_callers "$caller_pad" imported_listing
+  printf '%s\n' "${imported_listing[@]}"
 }
 
 _@go.modules() {
@@ -384,12 +387,7 @@ _@go.modules() {
     fi
     ;;
   --imported)
-    if [[ "$#" -ne 0 ]]; then
-      @go.printf 'The --imported option takes no other arguments.\n' >&2
-      return 1
-    elif [[ "${#_GO_IMPORTED_MODULES[@]}" -ne '0' ]]; then
-      _@go.modules_list 'paths' "${_GO_IMPORTED_MODULES[@]}"
-    fi
+    _@go.modules_list_imported "$@"
     ;;
   -*)
     @go.printf "Unknown option: $action\n" >&2

tests/modules/help.bats

@@ -4,6 +4,7 @@ load ../environment
 load helpers
 
 setup() {
+  test_filter
   @go.create_test_go_script '@go "$@"'
   setup_test_modules
 }