kommandant 0.2.0 → 0.3.0

data/lib/generators/kommandant/templates/initializer.rb

@@ -0,0 +1,31 @@
+Kommandant.configure do |config|
+  # Commands are loaded from a JSON file. "config/kommandant/commands.json" is the default path. If you want to use a different path, you can set it here.
+  # config.commands_path = "your/custom/path"
+
+  # When meilisearch returns a result, it might include items, that the current user is not allowed to see. You can filter these results with a lamda. This setting has no default, but below is an example that works with cancancan.
+  # config.search_result_filter_lambda = ->(current_ability, resource) { current_ability.can?(:show, resource) }
+
+  # Another search result filter. We use this to allow admins, who are impersonating users, access to all their commands. This setting has no default.
+  # config.admin_only_filter_lambda = ->(current_user, current_admin) { current_user.admin? || current_admin }
+
+  # If you want Kommandant to use a different parent controller, this is the setting for you. Defaults to ApplicationController
+  # config :parent_controller = "YourVerySpecialController"
+
+  # We assume there is a logged in user and therefore a current_user method. The name of this method can be set here. It defaults to current_user.
+  # config.current_user_method = current_account
+
+  # If you use Kredis, Kommandant can display the current user's most recently used commands. It requires your user model to have kredis_unique_list called recent_commands. If you don't use Kredis or do not want this behavior, it can be disabled. It defaults to being enabled.
+  # class User < ApplicationRecord
+  # kredis_unique_list :recent_commands, limit: 5
+  # config.recent_commands.enabled = false
+
+  # When a search returns a lot of results, it can be useful to paginate them. We use Pagy by default to handle this. If you do not use Pagy, this functinality can be turned off or configured to suit your needs. It defaults to being enabled.
+  # config.pagination.enabled = false
+  # config.pagination.items_per_page = 10 # defaults to 10
+  # config.pagination.pagination_lambda = ->(results, items, controller) { controller.send(:pagy_array, results, items: items) }
+  # config.pagination.info_label_lambda = ->(pagination, controller) { controller.send(:pagy_info, pagination).html_safe }
+  # config.pagination.module = "Pagy::Frontend"
+
+  # If you don't want to use icons, you can disable them here. It defaults to being enabled.
+  # config.icons.enabled = false
+end

data/lib/kommandant/engine.rb

@@ -1,8 +1,8 @@
 module Kommandant
   class Engine < ::Rails::Engine
     isolate_namespace Kommandant
-  
-    PRECOMPILE_ASSETS = %w( kommandant.js )
+
+    PRECOMPILE_ASSETS = %w[kommandant.js kommandant.css]
     initializer "kommandant.assets" do |app|
       if Rails.application.config.respond_to?(:assets)
         Rails.application.config.assets.precompile += PRECOMPILE_ASSETS

data/lib/kommandant/version.rb

@@ -1,3 +1,3 @@
 module Kommandant
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/kommandant.rb

@@ -11,9 +11,13 @@ module Kommandant
   setting :admin_only_filter_lambda
   setting :parent_controller, default: "::ApplicationController"
   setting :current_user_method, default: "current_user"
+  setting :highlight_search_term, default: true
   setting :recent_commands do
     setting :enabled, default: true
   end
+  setting :icons do
+    setting :enabled, default: true
+  end
   setting :pagination do
     setting :enabled, default: true
     setting :items_per_page, default: 10

data/lib/tasks/kommandant_tasks.rake

@@ -1,4 +1,31 @@
-# desc "Explaining what the task does"
-# task :kommandant do
-#   # Task goes here
-# end
+namespace :kommandant do
+  desc "Reindexes all commmands defined in the commands.json file (or whatever you called it)"
+  task reindex_commands: :environment do
+    puts "Reindexing all Kommandant commands"
+
+    Kommandant::Command.reindex!
+  end
+
+  desc "Reindexes all models set up with Kommandant"
+  task reindex_models: :environment do
+    Rake::Task["meilisearch:reindex"].invoke
+  end
+
+  desc "Reindexes all commands and models. We recommend you run this task every time you deploy your application, to avoid any inconsistencies between what you expect to be indexed and what is actually indexed"
+  task reindex: [:reindex_commands, :reindex_models]
+
+  desc "Clears the Kommandant commands from the search engine"
+  task clear_command_index: :environment do
+    puts "Clearing the Kommandant commands"
+
+    Kommandant::Command.remove_from_index!
+  end
+
+  desc "Clears the search engine of all models set up with Kommandant"
+  task clear_model_index: :environment do
+    Rake::Task["meilisearch:clear_indexes"].invoke
+  end
+
+  desc "Clears the search engine of all commands and models"
+  task clear_indexes: [:clear_command_index, :clear_model_index]
+end

data/vendor/assets/javascripts/command_palette.js

@@ -0,0 +1,120 @@
+import { Controller } from "@hotwired/stimulus"
+import { enter, leave, toggle } from "./transition"
+
+export default class extends Controller {
+  static targets = ["background", "panel", "input", "content", "loadingMessage", "previousPageLink", "nextPageLink"]
+  static values = {
+    open: { type: Boolean, default: false },
+    loadingMessageDelay: { type: Number, default: 100 },
+    animationDuration: { type: Number, default: 200 },
+    modifierKeyDown: { type: Boolean, default: false }
+  }
+
+  initialize() {
+    this.submit = this.debounce(this.submit, 500).bind(this);
+  }
+
+  toggle(event) {
+    event.preventDefault()
+
+    toggle(this.backgroundTarget)
+    toggle(this.panelTarget)
+    this.openValue = !this.openValue
+  }
+
+  show(event) {
+    event.preventDefault()
+
+    enter(this.backgroundTarget)
+    enter(this.panelTarget)
+    this.openValue = true
+  }
+
+  hide(event) {
+    event.preventDefault()
+
+    leave(this.backgroundTarget)
+    leave(this.panelTarget)
+    this.openValue = false
+  }
+
+  hideWithBackgroundOverlay(event) {
+    if (event.target === this.panelTarget) {
+      this.hide(event)
+    }
+  }
+
+  submit(event) {
+    const ignoreKeys = ["Enter", "Tab", "Escape", "ArrowUp", "ArrowDown", "ArrowLeft", "ArrowRight", "Home", "End", "Alt", "Control", "Meta", "Shift"]
+    const modifierKeyPressed = event.ctrlKey || event.metaKey
+
+    if (!modifierKeyPressed && !ignoreKeys.includes(event.key) && this.inputTarget.value !== "") {
+      this.inputTarget.form.requestSubmit()
+    }
+  }
+
+  reset() {
+    setTimeout(() => {
+      Turbo.visit("/kommandant/searches/new", { frame: "command_palette" })
+    }, this.animationDurationValue)
+  }
+
+  showLoadingMessage() {
+    this.loadingTimeout = setTimeout(() => {
+      this.contentTarget.classList.add("hidden")
+      this.loadingMessageTarget.classList.remove("hidden")
+    }, this.loadingMessageDelayValue)
+  }
+
+  nextPage(event) {
+    event.preventDefault()
+
+    if (this.hasNextPageLinkTarget) {
+      this.nextPageLinkTarget.click()
+    }
+  }
+
+  previousPage(event) {
+    event.preventDefault()
+
+    if (this.hasPreviousPageLinkTarget) {
+      this.previousPageLinkTarget.click()
+    }
+  }
+
+  // Private
+
+  openValueChanged(value, previousValue) {
+    this.focusInputTarget()
+
+    if (value === false && previousValue !== undefined) {
+      this.reset()
+    }
+  }
+
+  inputTargetConnected() {
+    this.focusInputTarget()
+    clearTimeout(this.loadingTimeout)
+  }
+
+  focusInputTarget() {
+    if (this.openValue) {
+      this.inputTarget.focus()
+
+      // Set cursor at end of inputted text
+      let temp = this.inputTarget.value
+      this.inputTarget.value = ""
+      this.inputTarget.value = temp
+    }
+  }
+
+  debounce(func, delay) {
+    let timeoutId;
+    return function (...args) {
+      clearTimeout(timeoutId);
+      timeoutId = setTimeout(() => {
+        func.apply(this, args);
+      }, delay);
+    };
+  }
+}

data/vendor/assets/javascripts/keyboard_navigation.js

@@ -0,0 +1,72 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["focusable"]
+  static values = { activeOptionIndex: { type: Number, default: 0 } }
+
+  connect() {
+    if (this.activeOption) {
+      this.activateOption()
+    }
+  }
+
+  down(event) {
+    event.preventDefault()
+
+    if (this.activeOptionIndexValue < (this.focusableTargets.length - 1)) {
+      this.deactivateOption()
+      this.activeOptionIndexValue++
+      this.activateOption()
+    }
+  }
+
+  up(event) {
+    event.preventDefault()
+
+    if (this.activeOptionIndexValue > 0) {
+      this.deactivateOption()
+      this.activeOptionIndexValue--
+      this.activateOption()
+    }
+  }
+
+  focus(event) {
+    this.deactivateOption()
+    this.activeOptionIndexValue = this.focusableTargets.indexOf(event.currentTarget)
+    this.activateOption()
+  }
+
+  select(event) {
+    if (this.hasFocusableTarget && this.focusableTargetIsVisible) {
+      event.preventDefault()
+
+      this.activeOption.click()
+    }
+  }
+
+  // Private
+
+  deactivateOption() {
+    this.activeOption.dataset.active = false
+  }
+
+  activateOption() {
+    this.activeOption.dataset.active = true
+  }
+
+  focusableTargetDisconnected() {
+    this.activeOptionIndexValue = 0
+  }
+
+  focusableTargetConnected() {
+    this.activateOption()
+  }
+
+  get activeOption() {
+    return this.focusableTargets[this.activeOptionIndexValue]
+  }
+
+  get focusableTargetIsVisible() {
+    return this.focusableTarget.offsetParent !== null
+  }
+}

data/vendor/assets/javascripts/kommandant.js

@@ -0,0 +1,2 @@
+export { default as CommandPalette } from './command_palette'
+export { default as KeyboardNavigation } from './keyboard_navigation'

data/vendor/assets/javascripts/transition.js

@@ -0,0 +1,57 @@
+// This was taken from https://github.com/mmccall10/el-transition but is included here to avoid the need for a separate package
+
+export async function enter(element, transitionName = null) {
+  element.classList.remove('hidden')
+  await transition('enter', element, transitionName)
+}
+
+export async function leave(element, transitionName = null) {
+  await transition('leave', element, transitionName)
+  element.classList.add('hidden')
+}
+
+export async function toggle(element, transitionName = null) {
+  if (element.classList.contains('hidden')) {
+    await enter(element, transitionName)
+  } else {
+    await leave(element, transitionName)
+  }
+}
+
+async function transition(direction, element, animation) {
+  const dataset = element.dataset
+  const animationClass = animation ? `${animation}-${direction}` : direction
+  let transition = `transition${direction.charAt(0).toUpperCase() + direction.slice(1)}`
+  const genesis = dataset[transition] ? dataset[transition].split(" ") : [animationClass]
+  const start = dataset[`${transition}Start`] ? dataset[`${transition}Start`].split(" ") : [`${animationClass}-start`]
+  const end = dataset[`${transition}End`] ? dataset[`${transition}End`].split(" ") : [`${animationClass}-end`]
+
+  addClasses(element, genesis)
+  addClasses(element, start)
+  await nextFrame()
+  removeClasses(element, start)
+  addClasses(element, end);
+  await afterTransition(element)
+  removeClasses(element, end)
+  removeClasses(element, genesis)
+}
+
+function addClasses(element, classes) {
+  element.classList.add(...classes)
+}
+
+function removeClasses(element, classes) {
+  element.classList.remove(...classes)
+}
+
+function nextFrame() {
+  return new Promise(resolve => {
+    requestAnimationFrame(() => {
+      requestAnimationFrame(resolve)
+    });
+  });
+}
+
+function afterTransition(element) {
+  return Promise.all(element.getAnimations().map(animation => animation.finished));
+}

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: kommandant
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nicolai Bach Woller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.5
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.5
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: meilisearch-rails
   requirement: !ruby/object:Gem::Requirement
@@ -39,39 +45,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.8.1
 - !ruby/object:Gem::Dependency
-  name: turbo-rails
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 7.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 7.0.5
 - !ruby/object:Gem::Dependency
-  name: dry-configurable
+  name: turbo-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: tailwindcss-rails
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,7 @@ files:
 - Rakefile
 - app/assets/builds/kommandant.css
 - app/assets/config/kommandant_manifest.js
+- app/assets/images/kommandant/logo.svg
 - app/assets/stylesheets/kommandant/application.css
 - app/assets/stylesheets/kommandant/application.tailwind.css
 - app/controllers/concerns/kommandant/recent_commands.rb
@@ -111,6 +112,11 @@ files:
 - app/models/kommandant/application_record.rb
 - app/models/kommandant/command.rb
 - app/models/kommandant/commands/search_result.rb
+- app/views/kommandant/commands/_command.html.erb
+- app/views/kommandant/commands/_form.html.erb
+- app/views/kommandant/commands/edit.html.erb
+- app/views/kommandant/commands/index.html.erb
+- app/views/kommandant/commands/new.html.erb
 - app/views/kommandant/commands/searches/show.html.erb
 - app/views/kommandant/commands/show.html.erb
 - app/views/kommandant/searches/index.html.erb
@@ -122,17 +128,25 @@ files:
 - app/views/kommandant/shared/command_palette/_loading_message.html.erb
 - app/views/kommandant/shared/command_palette/_result.html.erb
 - app/views/kommandant/shared/icons/_chevron_right.html.erb
-- app/views/kommandant/shared/icons/_command.erb
-- app/views/kommandant/shared/icons/_search.erb
-- app/views/kommandant/shared/icons/_spinner.erb
+- app/views/kommandant/shared/icons/_command.html.erb
+- app/views/kommandant/shared/icons/_kommandant.html.erb
+- app/views/kommandant/shared/icons/_search.html.erb
+- app/views/kommandant/shared/icons/_spinner.html.erb
 - app/views/layouts/kommandant/application.html.erb
 - config/locales/da.yml
 - config/locales/en.yml
 - config/routes.rb
+- lib/generators/kommandant/USAGE
+- lib/generators/kommandant/install_generator.rb
+- lib/generators/kommandant/templates/initializer.rb
 - lib/kommandant.rb
 - lib/kommandant/engine.rb
 - lib/kommandant/version.rb
 - lib/tasks/kommandant_tasks.rake
+- vendor/assets/javascripts/command_palette.js
+- vendor/assets/javascripts/keyboard_navigation.js
+- vendor/assets/javascripts/kommandant.js
+- vendor/assets/javascripts/transition.js
 homepage: https://traels.it
 licenses:
 - MIT