rails_command_palette 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ca48265d126c8cc7ab903d30a2f310b0e2208c8e000fd3ef836100f190dd185
-  data.tar.gz: 20591c07d75d52373423d684f603024d7df589babd50ca121ca47f4652782ef1
+  metadata.gz: 683e84e27b724804149e4b7a31953f73e1f38ba308d2cf9123edead6846f5bd8
+  data.tar.gz: a7a16641eb989cf6306bd3899a4f82009d2f9a6309323d1e0dcbeb2305db0aef
 SHA512:
-  metadata.gz: 3a6b2de6b696b99b83b66a1b5d077baa29d5202172e88e39bdd1c7580049365f7850b034cfe9a9258aa44066b4fac52132eefb9caaa9581a5aa1a1ba2efd3ada
-  data.tar.gz: aafb6d9089af23a396cfc5aaf8d01eee6ea78279f1e9ad257c0b5c0739804b4c8bfc22a8afe3bf27725be83607a6202d4353dd2ef91daf5431c214a4c535e7e0
+  metadata.gz: 8a53fea2aef2c10652db8abd9764f65e91d088ffc7de62884416212d79c7380ec472d0debc58dc2f1502f94493767057084bb21516e010313774c80f24f31771
+  data.tar.gz: e9ff20dc4fd7ced37533fbf35795f74d63ede12afba0168f75f48d890013525f1877e68efd0a02ee3cf85b37b845bcaba5c6c3f1017116f002393a1d1deea3f3

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Alexander C. Mingoia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# rails_command_palette
+
+A command palette for Rails using Stimulus and [Ninja Keys](https://github.com/ssleptsov/ninja-keys).
+
+## Install
+
+Install the gem:
+
+  bundle add rails_command_palette
+
+Install Ninja Keys:
+
+  yarn add --dev ninja-keys
+
+Install the Stimulus controller:
+
+  rails g command_palette:install
+
+## Usage
+
+### Controller
+
+Add commands using `add_command(id:, title:, href: nil, frame: nil, hotkey: nil, icon: nil, section: nil, parent: nil, children: nil, **options)`.
+
+`frame` is used when calling `Turbo.visit` for commands with `href`. `icon` accepts HTML.
+
+### View
+
+Render the command palette in your layout using `<%= command_palette %>` 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/command_palette/install_generator.rb

@@ -0,0 +1,18 @@
+module CommandPalette
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      desc "This generator installs the javascript needed for rails_command_palette."
+
+      def copy_the_javascript
+        copy_file "command_palette_controller.js", "app/javascript/controllers/command_palette_controller.js"
+        if (Rails.root.join("app/javascript/controllers/index.js")).exist?
+          append_to_file "app/javascript/controllers/index.js", 
+            %(import CommandPaletteController from "./command_palette_controller"\napplication.register("command-palette", CommandPaletteController)\n)
+        else
+          say %(Couldn't find "app/javascript/controllers/index.js".), :red
+        end
+      end
+    end
+  end
+end

data/lib/generators/command_palette/templates/command_palette_controller.js

@@ -0,0 +1,45 @@
+import { Controller } from "@hotwired/stimulus"
+import "ninja-keys"
+
+export default class CommandPaletteController extends Controller {
+  static values = {
+    commands: Array
+  }
+
+  connect() {
+    this.close = this.close.bind(this)
+    this.handleChange = this.handleChange.bind(this)
+    this.handleSelected = this.handleSelected.bind(this)
+    this.element.data = this.commandsValue.map((cmd) => Object.assign(cmd, {
+      handler: !cmd.children && this.handleSelected.bind(this)
+    }))
+    this.element.addEventListener("change", this.handleChange)
+    this.element.addEventListener("selected", this.handleSelected)
+  }
+
+  // @param ev Event `{ detail: { search: string } }`
+  handleChange(ev) {}
+
+  handleSelected({ frame, href }) {
+    if (href) {
+      document.removeEventListener("turbo:load", this.close)
+      document.removeEventListener("turbo:frame-load", this.close)
+      document.addEventListener("turbo:load", this.close, { once: true })
+      document.addEventListener("turbo:frame-load", this.close, { once: true })
+
+      Turbo.visit(href, { frame: frame })
+    }
+  }
+
+  get commands() {
+    return this.element.data
+  }
+
+  open(opts) {
+    this.element.open(opts)
+  }
+
+  close() {
+    this.element.close()
+  }
+}

data/lib/rails_command_palette/action_controller.rb

@@ -0,0 +1,34 @@
+module RailsCommandPalette
+  module ActionController
+    extend ActiveSupport::Concern
+
+    included do |base|
+      helper HelperMethods
+      helper_method :add_command, :prepend_command, :commands
+
+      unless base.respond_to?(:before_action)
+        base.alias_method :before_action, :before_filter
+      end
+    end
+
+    protected
+
+    def commands
+      @command_palette_commands ||= []
+    end
+
+    def add_command(id:, title:, href: nil, frame: nil, hotkey: nil, icon: nil, section: nil, parent: nil, children: nil, **options)
+      commands << {id:, title:, href:, frame:, hotkey:, icon:, section:, parent:, children:, options:}
+    end
+
+    def prepend_command(id:, title:, href: nil, frame: nil, hotkey: nil, icon: nil, section: nil, parent: nil, children: nil, **options)
+      commands.unshift({id:, title:, href:, frame:, hotkey:, icon:, section:, parent:, children:, options:})
+    end
+
+    module HelperMethods
+      def command_palette(options = {})
+        CommandPalette.new(commands, options).to_html
+      end
+    end
+  end
+end

data/lib/rails_command_palette/command_palette.rb

@@ -0,0 +1,33 @@
+module RailsCommandPalette
+  class CommandPalette
+    include ActionView::Helpers::TagHelper
+
+    def initialize(commands, options = {})
+      @commands = flatten_commands(commands)
+      @options = options
+    end
+
+    def flatten_commands(commands, flattened = [])
+      commands.each do |cmd|
+        flattened << cmd
+        if cmd[:children].present?
+          flatten_commands(cmd[:children], flattened)
+          cmd[:children] = cmd[:children].map do |childCmd|
+            childCmd[:parent] = cmd[:id]
+            childCmd[:id]
+          end
+        end
+      end
+      flattened
+    end
+
+    def to_html
+      tag("ninja-keys", @options.merge(
+        data: {
+          controller: "command-palette",
+          command_palette_commands_value: @commands
+        }
+      ))
+    end
+  end
+end

data/lib/rails_command_palette/railtie.rb

@@ -0,0 +1,7 @@
+module RailsCommandPalette
+  class Railtie < Rails::Railtie
+    ActiveSupport.on_load(:action_controller) do
+      ::ActionController::Base.send(:include, RailsCommandPalette::ActionController)
+    end
+  end
+end

data/lib/rails_command_palette/version.rb

@@ -0,0 +1,3 @@
+module RailsCommandPalette
+  VERSION = "1.0.1"
+end

data/lib/rails_command_palette.rb

@@ -0,0 +1,9 @@
+require "rails_command_palette/version"
+require "rails_command_palette/command_palette.rb"
+require "rails_command_palette/action_controller.rb"
+require "rails_command_palette/railtie.rb"
+
+module RailsCommandPalette
+  NAME = "Rails command palette"
+  GEM = "rails_command_palette"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_command_palette
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - alexmingoia
@@ -70,7 +70,16 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE
+- README.md
+- lib/generators/command_palette/install_generator.rb
+- lib/generators/command_palette/templates/command_palette_controller.js
+- lib/rails_command_palette.rb
+- lib/rails_command_palette/action_controller.rb
+- lib/rails_command_palette/command_palette.rb
+- lib/rails_command_palette/railtie.rb
+- lib/rails_command_palette/version.rb
 homepage: https://github.com/alexmingoia/rails_command_palette
 licenses:
 - MIT