moonshot-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cff18680c071a47e756d4e2c374e225786f91c20fcf36cdff9874b6d3646fe3
+  data.tar.gz: 5650ffebc7e361df9cbb0bc3ed9f46adbd9b05f9f559dbc2a1520f5719e09cc2
+SHA512:
+  metadata.gz: d36236cd06717459b4d7865d6377d200a8bce9013942f91ed2f0c0c0dc12d74b03a06198e41453447f3384e0f6039c256dcf2c6efee9f846fb331a9c2553031f
+  data.tar.gz: 99cf637fd557d987c3ea2336202ec867851839c3c1983e8ad46c555c142472e51d2b7cc5924453053b4e68b7ea3964022c3475d247614886d22c2bc7b5749c48

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright 2023 Catalin Ionescu
+
+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 @@
+# Moonshot Rails

data/app/assets/javascripts/moonshot/index.js

@@ -0,0 +1,7 @@
+import Shepherd from './shepherd_controller'
+
+export { Shepherd }
+
+export function registerControllers(application) {
+  application.register('moonshot-shepherd', Shepherd)
+}

data/app/assets/javascripts/moonshot/shepherd_controller.js

@@ -0,0 +1,75 @@
+import Shepherd from "shepherd.js";
+import { post } from '@rails/request.js'
+import { Controller } from "@hotwired/stimulus";
+
+export default class extends Controller {
+  static values={
+    tourName: String,
+    endpoint: String,
+    config: Object,
+    context: Object
+  };
+
+  initialize() {
+    this.tour = new Shepherd.Tour(this.configValue.tour);
+  }
+
+  connect() {
+    const steps = this.processTourConfigAction(this.configValue.steps)
+
+    if (steps) {
+      this.addTourListeners()
+
+      this.tour.addSteps(steps);
+      this.tour.start();
+    }
+  }
+
+  addTourListeners() {
+    [
+      'hide',
+      'cancel',
+      'complete',
+      'start'
+    ].map(eventName => {
+      this.tour.on(eventName, (event) => this.processTourEvent({ event, tourName: this.tourNameValue, eventName }))
+    })
+  }
+
+  async processTourEvent({ event, tourName, eventName }) {
+    const body = JSON.stringify({ tour: tourName, event: eventName, context: this.contextValue })
+    const response = await post(this.endpointValue, { body })
+    if (!response.ok) {
+      console.warn('Failed', response)
+    }
+  }
+
+  processTourConfigAction(steps) {
+    if (!steps.length) { return false }
+
+    return steps.map((step => {
+      let {buttons: buttons, ...rest} = step;
+      if (buttons) {
+        buttons = buttons.map((button => {
+          switch (button.action) {
+            case "next":
+            button.action = this.tour.next;
+            break;
+
+            case "back":
+            button.action = this.tour.back;
+            break;
+
+            default:
+            button.action = this.tour.complete;
+          }
+          return button;
+        }));
+      }
+      return {
+        buttons: buttons,
+        ...rest
+      };
+    }));
+  }
+}