Module: Thor::Completion::Bash::CommandMixin

Defined in:
lib/thor/completion/bash/command_mixin.rb

Overview

Methods mixed in to Thor::Command.

Instance Method Summary collapse

Instance Method Details

#bash_complete(request:, index:, klass:) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/thor/completion/bash/command_mixin.rb', line 176

def bash_complete request:, index:, klass:
  # logger.level = :trace

  logger.trace "ENTERING #{ self.class }##{ __method__ }",
    request: request,
    index: index,
    index_word: request.words[index]

  # Index we'll increment as we scan past options
  scan_index = index
  arg_count = 0
  
  # Skip over args (for now)
  while scan_index < request.cword &&
        scan_index < request.words.length &&
        !request.words[scan_index].start_with?( '-' )
    scan_index += 1
    arg_count += 1
  end

  if  scan_index == request.cword ||
      ( request.split &&
        scan_index == request.cword - 1 )
    return bash_complete_cur request: request, arg_count: arg_count, klass: klass
  end

  unless scan_index < request.words.length
    # We ran out of words without hitting a command name or ending 
    # empty string (for which we would provide all commands as options)
    # 
    # TODO  In the future we can deal with half-written class options
    #       I guess? Maybe? But for now we just give up.
    # 
    return [].tap { |results|
      logger.trace "No option or empty string found",
        results: []
    }
  end

  # match_word = request.words[scan_index]

  # matching_options = options.values.select { |option|
  #   option.all_switch_tokens.any? { |token| token.start_with? match_word }
  # }

  return [].tap { |results|
    logger.trace "Not implemented",
      results: results
  }
  
end

#bash_complete_cur(request:, arg_count:, klass:) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/thor/completion/bash/command_mixin.rb', line 124

def bash_complete_cur request:, arg_count:, klass:
  return bash_complete_cur_split( request: request ) if request.split
  
  if request.cur == ''
    results = [ '--help' ]

    argument = klass.arguments( command: self )[arg_count]

    if argument
      results += argument.bash_complete( request: request, klass: klass )
    end

    results += options.values.flat_map { |option| option.long_switch_tokens }

    return results.
      tap { |results|
        logger.trace "`request.cur` is ''; returning all long opts",
          results: results
      }
  end

  if request.cur.start_with? '-'
    return options.values.flat_map { |option|
      option.long_switch_names.flat_map { |name|
        if option.boolean?
          [ "--#{ name }", "--no-#{ name }" ]
        else
          "--#{ name }="
        end
      }
    }.
    +( [ '--help' ] ).
    select { |token| token.start_with? request.cur }.
    tap { |results|
      logger.trace "Completing partial switch token",
        results: results
    }
  end

  argument = klass.arguments( command: self )[arg_count]
  if argument
    return argument.
      bash_complete( request: request, klass: klass).
      tap { |results|
        logger.trace "We b here"
      }
  end

  return []
end

#bash_complete_cur_split(request:) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/thor/completion/bash/command_mixin.rb', line 42

def bash_complete_cur_split request:
  # The input was split at a `=`, so we're looking for a value for
  # an option whose name will be at {Request#prev}.

  logger.trace "Processing split Bash complete request...",
    command: self.name,
    request: request

  matching_options = options.values.select { |option|
    option.long_switch_tokens.
      reject { |token| token.end_with? '=' }.
      include? request.prev
  }

  case matching_options.length
  when 0
    return [].tap { |results|
      logger.trace "No matching options found",
        results: results,
        options: options.transform_values { |option|
          {
            tokens: option.all_switch_tokens,
            names: option.all_switch_names,
          }
        }
    }

  when 1
    option = matching_options[0]

    logger.trace "Unique option found for `request.prev`",
      prev: request.prev,
      option: option
    
    if option.enum
      return option.enum.
        select { |value|
          value.to_s.start_with? request.cur
        }.
        tap { |results|
          logger.trace \
            "Matched against enum option #{ option.name }",
            prev: request.prev,
            results: results,
            option: option
        }

    elsif option.complete
      return option.complete.call.
        select { |value|
          value.to_s.start_with? request.cur
        }.
        tap { |results|
          logger.trace \
            "Matched against complete option #{ option.name }",
            prev: request.prev,
            results: results,
            option: option
        }

    else
      return [].tap { |results|
        logger.trace \
          ( "Matched against non-enum option #{ option.name } " +
            "but we don't have any completions to provide" ),
          prev: request.prev,
          results: results,
          option: option
      }
    end

  else
    return [].tap { |results|
      logger.trace "Multiple options found for prev",
        results: results,
        prev: request.prev,
        options: matching_options
    }
  end
end