bullet_train-sortable 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fff0856e0a46a10b09270bc22d59958017ef78bbb70b02e095cbf5d503480c68
-  data.tar.gz: 6cb89997aa69c266582a59e5aa91512045e919600a43befd6e931799d85c5347
+  metadata.gz: 2ee6c7f7c14019d295c69144738fa9ec71f66d6f496b53bed2d531c60bd22ae6
+  data.tar.gz: 81f82e2c4b041eb531cd34898c929085ebedb2e09b6498d3078f2f2fc5fb1442
 SHA512:
-  metadata.gz: 8de58432c2ad9f78f670636bb8b370f40470124e929f993704fc0d17adb7ad934eebc65dd70ba80e438d7d257d4091fa67a02d7790c5776668ee66519b7cfc89
-  data.tar.gz: 7b31ae826cf01892d88dfb5d22cbcd941d164294e82401d2e5b22298fc801d0928583b85ecd7bec96bf6f73754e58012bcb3dfffb7e93d50640bfa0a35459e1a
+  metadata.gz: 83ff615e5473b5a572679c00612a829f69541bef34811048b33a68dc31c8887f35352bb699bec0d07b26db837d499729029af41323017f0b71ea0df2f4b937be
+  data.tar.gz: 8e703c9fc8be22fcb2ec469d293af6877559b77308c01637ed331df2702859aab2199a1fb4b52cd9cc7977eec74c84dabbf8ec7d7d35e777120cb1ea838336f8

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2022 Andrew Culver
+Copyright 2022 Bullet Train, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -22,7 +22,7 @@ $ gem install bullet_train-sortable
 ```
 
 ## Contributing
-Contribution directions go here.
+See [`RELEASE.md` in bullet_train-base](https://github.com/bullet-train-co/bullet_train-base/blob/main/RELEASE.md) for instructions on local development and for publishing both the gem and the npm package.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/javascript/concerns/index.js

@@ -0,0 +1 @@
+import "./reassignable"

data/app/javascript/controllers/index.js

@@ -0,0 +1,18 @@
+import { identifierForContextKey } from "@hotwired/stimulus-webpack-helpers"
+
+import SortableController from './sortable_controller'
+
+export const controllerDefinitions = [
+  [SortableController, 'sortable_controller.js']
+].map(function(d) {
+  const key = d[1]
+  const controller = d[0]
+  return {
+    identifier: identifierForContextKey(key),
+    controllerConstructor: controller
+  }
+})
+
+export {
+  SortableController
+}

data/app/javascript/controllers/sortable_controller.js

@@ -0,0 +1,81 @@
+import { Controller } from "@hotwired/stimulus"
+import { post } from '@rails/request.js'
+require("dragula/dist/dragula.min.css")
+
+import dragula from 'dragula';
+
+export default class extends Controller {
+  static values = {
+    reorderPath: String,
+    saveOnReorder: { type: Boolean, default: true }
+  }
+  
+  // will be reissued as native dom events name prepended with 'sortable:' e.g. 'sortable:drag', 'sortable:drop', etc
+  static pluginEventsToReissue = [ "drag", "dragend", "drop", "cancel", "remove", "shadow", "over", "out", "cloned" ]
+
+  connect() {
+    if (!this.hasReorderPathValue) { return }
+    this.initPluginInstance()
+  }
+
+  disconnect() {
+    this.teardownPluginInstance()
+  }
+
+  initPluginInstance() {
+    const self = this
+    this.plugin = dragula([this.element], {
+      moves: function(el, container, handle) {
+        var $handles = $(el).find('.reorder-handle')
+        if ($handles.length) {
+          return !!$(handle).closest('.reorder-handle').length
+        } else {
+          if (!$(handle).closest('.undraggable').length) {
+            return self.element === container
+          } else {
+            return false
+          }
+        }
+      },
+      accepts: function (el, target, source, sibling) {
+        if ($(sibling).hasClass('undraggable') && $(sibling).prev().hasClass('undraggable')) {
+          return false
+        } else {
+          return true
+        }
+      },
+    }).on('drop', function (el) {
+      // save order here.
+      if (self.saveOnReorderValue) {
+        self.saveSortOrder()
+      }
+    }).on('over', function (el, container) {
+      // deselect any text fields, or else things go slow!
+      $(document.activeElement).blur()
+    })
+    
+    this.initReissuePluginEventsAsNativeEvents()
+  }
+  
+  initReissuePluginEventsAsNativeEvents() {
+    this.constructor.pluginEventsToReissue.forEach((eventName) => {
+      this.plugin.on(eventName, (...args) => {
+        this.dispatch(eventName, { detail: { plugin: 'dragula', type: eventName, args: args }})
+      })
+    })
+  }
+
+  teardownPluginInstance() {
+    if (this.plugin === undefined) { return }
+
+    // revert to original markup, remove any event listeners
+    this.plugin.destroy()
+  }
+  
+  saveSortOrder() {
+    var idsInOrder = Array.from(this.element.childNodes).map((el) => { return parseInt(el.dataset?.id) });
+    
+    post(this.reorderPathValue, { body: JSON.stringify({ids_in_order: idsInOrder}) })
+  }
+
+}

data/app/javascript/index.js

@@ -0,0 +1,2 @@
+import "./concerns"
+export * from './controllers'

data/lib/bullet_train/sortable/engine.rb

@@ -2,7 +2,7 @@ module BulletTrain
   module Sortable
     class Engine < ::Rails::Engine
       initializer "bullet_train.sortable.register_routing_concerns" do |app|
-        BulletTrain.routing_concerns << Proc.new do
+        BulletTrain.routing_concerns << proc do
           concern :sortable do
             collection do
               post :reorder

data/lib/bullet_train/sortable/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Sortable
-    VERSION = "1.0.2"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-sortable
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-12 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 6.0.0
 description: Bullet Train Sortable
 email:
 - andrew.culver@gmail.com
@@ -36,8 +50,11 @@ files:
 - Rakefile
 - app/assets/config/bullet_train_sortable_manifest.js
 - app/controllers/concerns/sortable_actions.rb
+- app/javascript/concerns/index.js
 - app/javascript/concerns/reassignable.js
-- app/javascript/concerns/sortable.js
+- app/javascript/controllers/index.js
+- app/javascript/controllers/sortable_controller.js
+- app/javascript/index.js
 - app/models/concerns/sortable.rb
 - config/routes.rb
 - lib/bullet_train/sortable.rb
@@ -65,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Bullet Train Sortable

data/app/javascript/concerns/sortable.js

@@ -1,70 +0,0 @@
-require("dragula/dist/dragula.min.css")
-
-import dragula from 'dragula';
-
-function saveSortOrder($container) {
-  var idsInOrder = $container.find('> *').map(function(index,element) { return parseInt($(element).attr('data-id')); }).toArray();
-  $.post($container.attr('data-reorder'), {ids_in_order: idsInOrder}, function() {
-    if ($container.closest('.opened-modally').length) {
-      refreshModalBase();
-    }
-  });
-}
-
-function enableSortable($scope) {
-  setTimeout(function() {
-    var selector = '[data-reorder]';
-    var $reorderable = $scope.find(selector).addBack(selector);
-    console.log("enabling sort on array of " + $reorderable.length);
-
-    $reorderable.each(function (index, container) {
-
-      var $container = $(container);
-
-      // enable drag-and-drop reordering.
-      var dragulaObj = dragula([container], {
-        moves: function(el, container, handle) {
-          var $handles = $(el).find('.reorder-handle')
-          if ($handles.length) {
-            return !!$(handle).closest('.reorder-handle').length
-          } else {
-            if (!$(handle).closest('.undraggable').length) {
-              return $(handle).closest('[data-reorder]')[0] == container;
-            } else {
-              return false;
-            }
-          }
-        },
-        accepts: function (el, target, source, sibling) {
-          if ($(sibling).hasClass('undraggable') && $(sibling).prev().hasClass('undraggable')) {
-            return false;
-          } else {
-            return true;
-          }
-        },
-      }).on('drop', function (el) {
-
-        // save order here.
-        saveSortOrder($container);
-
-      }).on('over', function (el, container) {
-
-        // deselect any text fields, or else things go slow!
-        $(document.activeElement).blur();
-
-      });
-
-    });
-  }, 500);
-}
-
-$(document).on('turbo:load', function() {
-  console.log("🍩 Sortable: Enabling on <body> after a Turbo load.")
-  enableSortable($('body'));
-})
-
-$(document).on('sprinkles:update', function(event) {
-  console.log("🍩 Sortable: Enabling on the following element after a Sprinkles content update:")
-  console.log(event.target);
-  enableSortable($(event.target));
-})