Module: Tabry::Shells::Fish

Defined in:
lib/tabry/shells/fish.rb

Class Method Summary collapse

Class Method Details

.add_uniq_id(str, pattern, uniq_id) ⇒ Object 



48
49
50
 
# File 'lib/tabry/shells/fish.rb', line 48

def self.add_uniq_id(str, pattern, uniq_id)
  str.gsub! pattern, "#{pattern}_#{uniq_id}"
end

.esc(str) ⇒ Object 



44
45
46
 
# File 'lib/tabry/shells/fish.rb', line 44

def self.esc(str)
  Shellwords.escape(str)
end

.generate(cmd_name, tabry_file_path, uniq_fn_id: nil) ⇒ Object

NOTE! This code uses sh/fish/tabry_fish.fish and is described in sh/fish/README.md; see that README for more info



17
18
19
20
21
22
23
24
25
 
# File 'lib/tabry/shells/fish.rb', line 17

def self.generate(cmd_name, tabry_file_path, uniq_fn_id: nil)
  generate_internal(
    cmd_name: cmd_name,
    import_path: File.expand_path(tabry_file_path),
    tabry_fish_executable: File.expand_path("#{path_to_tabry}/bin/tabry-fish"),
    tabry_fish_arg: nil,
    uniq_fn_id: uniq_fn_id
  )
end

.generate_internal(cmd_name:, import_path:, tabry_fish_executable:, tabry_fish_arg:, uniq_fn_id: nil) ⇒ Object 



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
 
# File 'lib/tabry/shells/fish.rb', line 52

def self.generate_internal(cmd_name:, import_path:, tabry_fish_executable:, tabry_fish_arg:, uniq_fn_id: nil)
  # uniq_fn_id is added to the bash functions to ensure they are unique
  # -- by default this is the capitalized command name
  uniq_fn_id ||= cmd_name
  uniq_fn_id = uniq_fn_id.upcase.gsub(/[^A-Z0-9_]/, "_")
  script = File.read("#{__dir__}/../../../sh/fish/tabry_fish.fish")

  add_uniq_id(script, "tabry_completion_init", uniq_fn_id)
  add_uniq_id(script, "__fish_tabry_internal_invoke", uniq_fn_id)
  add_uniq_id(script, "__fish_tabry_check_only_args", uniq_fn_id)
  add_uniq_id(script, "__fish_tabry_check_only_file", uniq_fn_id)
  add_uniq_id(script, "__fish_tabry_check_args_and_file", uniq_fn_id)
  add_uniq_id(script, "__fish_tabry_completions", uniq_fn_id)

  script.gsub! "# TABRY_IMPORT_PATH_REPLACE (DO NOT REMOVE)", "set TABRY_IMPORTS_PATH #{esc import_path}"
  script.gsub! "# TABRY_EXECUTABLE_REPLACE (DO NOT REMOVE)", "set TABRY_EXECUTABLE #{esc tabry_fish_executable}"
  unless tabry_fish_arg.nil?
    script.gsub! "# TABRY_ARG_REPLACE (DO NOT REMOVE)", "set TABRY_ARG #{esc tabry_fish_arg}"
  end

  <<~END_FISH_CODE_TEMPLATE
    # The following Autocomplete is for a Tabry-powered command. It was
    # generated by the command itself. See the documentation located in
    # #{esc path_to_tabry}/sh/fish/README.md
    #{script}
    tabry_completion_init_#{uniq_fn_id} #{esc cmd_name}
  END_FISH_CODE_TEMPLATE
end

.generate_self(cmd_name: nil) ⇒ Object

Generate fish completion code that will run the currently running command ($0) with “completion” to get completion options. “cmd_name” is used to tell fish which command to make options for



30
31
32
33
34
35
36
37
38
 
# File 'lib/tabry/shells/fish.rb', line 30

def self.generate_self(cmd_name: nil)
  cmd_name ||= File.basename($0)
  generate_internal(
    cmd_name: cmd_name,
    import_path: "",
    tabry_fish_executable: File.expand_path($0),
    tabry_fish_arg: "completion"
  )
end

.path_to_tabry ⇒ Object 



40
41
42
 
# File 'lib/tabry/shells/fish.rb', line 40

def self.path_to_tabry
  File.expand_path("#{__dir__}/../../../")
end