Module: CompletionKit::ApplicationHelper

Defined in:
app/helpers/completion_kit/application_helper.rb

Constant Summary collapse

OPENAI_MODEL_FAMILY_ORDER =
["GPT-5", "GPT-4", "o-series", "GPT-3.5", "GPT-OSS", "Other"].freeze

Instance Method Summary collapse

Instance Method Details

#ck_badge_classes(kind) ⇒ Object



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'app/helpers/completion_kit/application_helper.rb', line 26

def ck_badge_classes(kind)
  case kind.to_s
  when "high"
    "ck-badge ck-badge--high"
  when "medium"
    "ck-badge ck-badge--medium"
  when "low"
    "ck-badge ck-badge--low"
  when "pending"
    "ck-badge ck-badge--pending"
  when "running"
    "ck-badge ck-badge--running"
  when "completed"
    "ck-badge ck-badge--high"
  when "failed"
    "ck-badge ck-badge--low"
  else
    "ck-badge ck-badge--pending"
  end
end

#ck_button_classes(tone = :dark, variant: :solid) ⇒ Object



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# File 'app/helpers/completion_kit/application_helper.rb', line 3

def ck_button_classes(tone = :dark, variant: :solid)
  base = "ck-button"

  styles = case [tone, variant]
           when [:dark, :solid]
             "ck-button--primary"
           when [:light, :outline]
             "ck-button--secondary"
           when [:green, :solid]
             "ck-button--success"
           when [:red, :outline]
             "ck-button--danger"
           when [:amber, :outline]
             "ck-button--warning"
           when [:blue, :outline]
             "ck-button--info"
           else
             "ck-button--primary"
           end

  "#{base} #{styles}"
end

#ck_dataset_path(dataset) ⇒ Object



190
191
192
# File 'app/helpers/completion_kit/application_helper.rb', line 190

def ck_dataset_path(dataset)
  CompletionKit::Engine.routes.url_helpers.dataset_path(dataset, **ck_engine_path_options)
end

#ck_engine_path_optionsObject

Dynamic route segments owned by the host’s mount scope (e.g. an ‘org_slug` from `scope “/orgs/:org_slug”`) live in `url_options`. The engine’s url_helpers won’t read them out of the nested recall hash to satisfy a required segment — they have to arrive as explicit kwargs.



198
199
200
# File 'app/helpers/completion_kit/application_helper.rb', line 198

def ck_engine_path_options
  (url_options[:_recall] || {}).except(:controller, :action)
end

#ck_field_aria(form, field) ⇒ Object



292
293
294
295
# File 'app/helpers/completion_kit/application_helper.rb', line 292

def ck_field_aria(form, field)
  return {} unless form.object.errors[field].any?
  { "aria-invalid" => "true", "aria-describedby" => ck_field_error_id(form, field) }
end

#ck_field_error(form, field) ⇒ Object



297
298
299
300
# File 'app/helpers/completion_kit/application_helper.rb', line 297

def ck_field_error(form, field)
  return nil unless form.object.errors[field].any?
  (:p, form.object.errors[field].first, class: "ck-field-error", id: ck_field_error_id(form, field))
end

#ck_field_error_id(form, field) ⇒ Object



302
303
304
# File 'app/helpers/completion_kit/application_helper.rb', line 302

def ck_field_error_id(form, field)
  "#{form.object.model_name.param_key}_#{field}_error"
end

#ck_format_maybe_json(text) ⇒ Object



202
203
204
205
206
207
208
209
210
211
212
213
# File 'app/helpers/completion_kit/application_helper.rb', line 202

def ck_format_maybe_json(text)
  s = text.to_s
  return s if s.strip.empty?
  payload = ck_unwrap_json_fence(s.strip)
  first = payload[0]
  return s unless first == "{" || first == "["
  begin
    ck_highlight_json(JSON.pretty_generate(JSON.parse(payload)))
  rescue JSON::ParserError
    s
  end
end

#ck_grouped_models(models, selected = nil) ⇒ Object



121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'app/helpers/completion_kit/application_helper.rb', line 121

def ck_grouped_models(models, selected = nil)
  if selected.present? && models.none? { |m| m[:id] == selected }
    retired = CompletionKit::Model.find_by(model_id: selected)
    if retired
      models = models + [{ id: retired.model_id, name: "#{retired.display_name || retired.model_id} (retired)", provider: retired.provider }]
    end
  end

  groups = models.group_by { |m| ck_model_optgroup_label(m) }
  ordered_keys = groups.keys.sort_by { |label| ck_model_optgroup_sort_key(label) }
  grouped = ordered_keys.map { |label| [label, groups[label].map { |m| [ck_model_option_label(m), m[:id]] }] }
  grouped_options_for_select(grouped, selected)
end

#ck_highlight_json(text) ⇒ Object



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'app/helpers/completion_kit/application_helper.rb', line 220

def ck_highlight_json(text)
  tokens = ck_tokenize_json(text)
  is_key = ck_mark_json_keys(tokens)
  parts = tokens.each_with_index.map do |(type, value), idx|
    escaped = ERB::Util.html_escape(value)
    case type
    when :punct then %(<span class="ck-json-punct">#{escaped}</span>)
    when :string
      %(<span class="#{is_key[idx] ? "ck-json-key" : "ck-json-string"}">#{escaped}</span>)
    when :number then %(<span class="ck-json-number">#{escaped}</span>)
    when :keyword then %(<span class="ck-json-keyword">#{escaped}</span>)
    else escaped
    end
  end
  parts.join.html_safe
end

#ck_mark_json_keys(tokens) ⇒ Object



276
277
278
279
280
281
282
283
# File 'app/helpers/completion_kit/application_helper.rb', line 276

def ck_mark_json_keys(tokens)
  tokens.each_with_index.map do |(type, _), idx|
    next false unless type == :string
    j = idx + 1
    j += 1 while j < tokens.length && tokens[j][0] == :ws
    j < tokens.length && tokens[j] == [:punct, ":"]
  end
end

#ck_masked_token(token) ⇒ Object



75
76
77
78
79
# File 'app/helpers/completion_kit/application_helper.rb', line 75

def ck_masked_token(token)
  return "YOUR_TOKEN" if token.blank?
  return "••••••••" if token.length < 12
  "#{token[0..3]}#{'' * [token.length - 8, 4].max}#{token[-4..]}"
end

#ck_model_optgroup_label(model) ⇒ Object

Optgroup label for the model select — mirrors the provider models table: OpenRouter splits by upstream vendor, OpenAI splits by family, everyone else is a single group.



138
139
140
141
142
143
144
# File 'app/helpers/completion_kit/application_helper.rb', line 138

def ck_model_optgroup_label(model)
  case model[:provider]
  when "openrouter" then "OpenRouter — #{model[:id].to_s.split("/", 2).first.delete_prefix("~")}"
  when "openai"     then "OpenAI — #{ck_openai_model_family(model[:id])}"
  else ck_provider_label(model[:provider])
  end
end

#ck_model_optgroup_sort_key(label) ⇒ Object



146
147
148
149
150
151
152
153
154
# File 'app/helpers/completion_kit/application_helper.rb', line 146

def ck_model_optgroup_sort_key(label)
  if label.start_with?("OpenAI — ")
    [0, OPENAI_MODEL_FAMILY_ORDER.index(label.delete_prefix("OpenAI — ")), label]
  elsif label.start_with?("OpenRouter")
    [2, 0, label]
  else
    [1, 0, label]
  end
end

#ck_model_option_label(model) ⇒ Object



116
117
118
119
# File 'app/helpers/completion_kit/application_helper.rb', line 116

def ck_model_option_label(model)
  return "#{model[:name]} (?)" if model.key?(:judging_confirmed) && !model[:judging_confirmed]
  model[:name]
end

#ck_model_options_html(scope) ⇒ Object



156
157
158
159
160
# File 'app/helpers/completion_kit/application_helper.rb', line 156

def ck_model_options_html(scope)
  models = CompletionKit::ApiConfig.available_models(scope: scope)
  return "" if models.empty?
  ck_grouped_models(models)
end

#ck_model_table_sections(models) ⇒ Object

Groups a provider’s models for the models-card table, mirroring how the dropdown sub-groups: OpenRouter clusters by upstream vendor (the part before “/”); OpenAI clusters by family; everyone else stays flat. Returns [[section_label_or_nil, [models]], …]. A single section collapses to a nil label so we don’t render a redundant header.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'app/helpers/completion_kit/application_helper.rb', line 98

def ck_model_table_sections(models)
  models = models.to_a
  sections =
    case models.first&.provider
    when "openrouter"
      models.group_by { |m| m.model_id.to_s.split("/", 2).first.delete_prefix("~") }
            .sort_by { |label, _| label }
    when "openai"
      grouped = models.group_by { |m| ck_openai_model_family(m.model_id) }
      ordered = OPENAI_MODEL_FAMILY_ORDER.filter_map { |label| [label, grouped[label]] if grouped[label] }
      extras = (grouped.keys - OPENAI_MODEL_FAMILY_ORDER).sort.map { |label| [label, grouped[label]] }
      ordered + extras
    else
      [[nil, models]]
    end
  sections.size <= 1 ? [[nil, models]] : sections
end

#ck_openai_model_family(model_id) ⇒ Object



83
84
85
86
87
88
89
90
91
# File 'app/helpers/completion_kit/application_helper.rb', line 83

def ck_openai_model_family(model_id)
  id = model_id.to_s
  return "GPT-5" if id.match?(/\Agpt-5/i)
  return "GPT-4" if id.match?(/\Agpt-4/i)
  return "GPT-3.5" if id.match?(/\Agpt-3/i)
  return "GPT-OSS" if id.match?(/\Agpt-oss/i)
  return "o-series" if id.match?(/\Ao\d/i)
  "Other"
end

#ck_prompt_path(prompt) ⇒ Object



186
187
188
# File 'app/helpers/completion_kit/application_helper.rb', line 186

def ck_prompt_path(prompt)
  CompletionKit::Engine.routes.url_helpers.prompt_path(prompt, **ck_engine_path_options)
end

#ck_provider_label(provider) ⇒ Object



71
72
73
# File 'app/helpers/completion_kit/application_helper.rb', line 71

def ck_provider_label(provider)
  CompletionKit::ProviderCredential::PROVIDER_LABELS[provider.to_s] || provider.to_s.titleize
end

#ck_run_dot(run) ⇒ Object



47
48
49
50
51
52
53
54
# File 'app/helpers/completion_kit/application_helper.rb', line 47

def ck_run_dot(run)
  case run.status
  when "running" then "ck-dot ck-dot--running"
  when "failed" then "ck-dot ck-dot--failed"
  when "completed" then "ck-dot ck-dot--completed"
  else "ck-dot ck-dot--pending"
  end
end

#ck_run_path(run) ⇒ Object



182
183
184
# File 'app/helpers/completion_kit/application_helper.rb', line 182

def ck_run_path(run)
  CompletionKit::Engine.routes.url_helpers.run_path(run, **ck_engine_path_options)
end

#ck_run_status_label(run) ⇒ Object



56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'app/helpers/completion_kit/application_helper.rb', line 56

def ck_run_status_label(run)
  case run.status
  when "pending" then "Ready to run"
  when "running"
    if run.progress_total.to_i > 0
      "Running (#{run.progress_current}/#{run.progress_total})"
    else
      "Running…"
    end
  when "completed" then "Completed"
  when "failed" then "Failed"
  else run.status.capitalize
  end
end

#ck_score_kind(score) ⇒ Object



162
163
164
165
166
167
168
# File 'app/helpers/completion_kit/application_helper.rb', line 162

def ck_score_kind(score)
  return :pending if score.nil?
  return :high if score >= CompletionKit.config.high_quality_threshold
  return :medium if score >= CompletionKit.config.medium_quality_threshold

  :low
end

#ck_tokenize_json(text) ⇒ Object



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'app/helpers/completion_kit/application_helper.rb', line 237

def ck_tokenize_json(text)
  tokens = []
  i = 0
  len = text.length
  while i < len
    ch = text[i]
    if ch == " " || ch == "\n" || ch == "\t"
      tokens << [:ws, ch]
      i += 1
    elsif "{}[]:,".include?(ch)
      tokens << [:punct, ch]
      i += 1
    elsif ch == '"'
      j = i + 1
      while j < len && text[j] != '"'
        j += text[j] == "\\" ? 2 : 1
      end
      j = len - 1 if j >= len
      tokens << [:string, text[i..j]]
      i = j + 1
    elsif ch == "-" || (ch >= "0" && ch <= "9")
      j = i + 1
      j += 1 while j < len && "0123456789.eE+-".include?(text[j])
      tokens << [:number, text[i...j]]
      i = j
    elsif text[i, 4] == "true" || text[i, 4] == "null"
      tokens << [:keyword, text[i, 4]]
      i += 4
    elsif text[i, 5] == "false"
      tokens << [:keyword, "false"]
      i += 5
    else
      tokens << [:other, ch]
      i += 1
    end
  end
  tokens
end

#ck_unwrap_json_fence(text) ⇒ Object



215
216
217
218
# File 'app/helpers/completion_kit/application_helper.rb', line 215

def ck_unwrap_json_fence(text)
  m = text.match(/\A```(?:json|JSON)?\s*\n(.*?)\n?```\s*\z/m)
  m ? m[1].strip : text
end

#ck_word_diff_new(old_text, new_text) ⇒ Object



174
175
176
# File 'app/helpers/completion_kit/application_helper.rb', line 174

def ck_word_diff_new(old_text, new_text)
  diff_tokens(old_text, new_text, :new)
end

#ck_word_diff_old(old_text, new_text) ⇒ Object



170
171
172
# File 'app/helpers/completion_kit/application_helper.rb', line 170

def ck_word_diff_old(old_text, new_text)
  diff_tokens(old_text, new_text, :old)
end

#tag_filter_url(base_path, selected, toggling) ⇒ Object



285
286
287
288
289
290
# File 'app/helpers/completion_kit/application_helper.rb', line 285

def tag_filter_url(base_path, selected, toggling)
  remaining = selected.reject { |t| t.id == toggling.id }
  next_set = selected.include?(toggling) ? remaining : remaining + [toggling]
  return base_path if next_set.empty?
  "#{base_path}?#{{ tag: next_set.map(&:name) }.to_query}"
end

#tag_pill_class(tag, outline: false) ⇒ Object



178
179
180
# File 'app/helpers/completion_kit/application_helper.rb', line 178

def tag_pill_class(tag, outline: false)
  ["tag", "tag-#{tag.color}", ("tag-outline" if outline)].compact.join(" ")
end