bullet_train-sortable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3e9f130a8eaf38775f12b57b19eec6e24f09173fe73fe86f21d482c72485432
+  data.tar.gz: a03eb64c8764ab04ff8009e3551d85393edbac81798e4126ce371040704aa872
+SHA512:
+  metadata.gz: a705a94240af2aa513253152dd5f9e5698a6b24e465f2c96c34f41f6b6050f005b9e4b6c64d8fc3bc0975196b15550bbd1ee76baa34103d30a76b27bffaaefde
+  data.tar.gz: 6c5b267403b3cc410e31bd31e6b280339b67f416f6fbc305680f49325bbb5fe8ba2d3a9b0f512ee1dd03da910a98360d57782d80f78c2072ad43ad30ee429344

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Andrew Culver
+
+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,28 @@
+# BulletTrain::Sortable
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bullet_train-sortable"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install bullet_train-sortable
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/concerns/sortable_actions.rb

@@ -0,0 +1,13 @@
+module SortableActions
+  extend ActiveSupport::Concern
+
+  def reorder
+    params[:ids_in_order].each_with_index do |id, sort_order|
+      if (child_object = @parent_object.send(@child_collection).find_by_id(id))
+        child_object.sort_order = sort_order
+        child_object.save
+      end
+    end
+    render json: true, status: :ok
+  end
+end

data/app/javascript/concerns/reassignable.js

@@ -0,0 +1,63 @@
+require("dragula/dist/dragula.min.css")
+
+import dragula from 'dragula';
+
+function saveAssignments($container) {
+  var parents = $container.find('[data-reassignment-parent]').map(function(index,element) { return parseInt($(element).attr('data-id')); }).toArray();
+  var assignmentsById = {}
+  $.each(parents, function(_, parentId) {
+    assignmentsById[parentId] = $container.find("[data-reassignment-parent]").filter("[data-id='" + parentId + "']").find("[data-reassignable]").map(function(index,element) { return parseInt($(element).attr('data-id')); }).toArray();
+  });
+  $.post($container.attr('data-reassign'), {assignments_by_id: assignmentsById, dispatched_at: new Date().getTime()});
+}
+
+function enableReassignable($scope) {
+  setTimeout(function() {
+    var selector = '[data-reassign]';
+    var $reassignable = $scope.find(selector).addBack(selector);
+
+    $reassignable.each(function (_, container) {
+
+      console.log("🍩 Reassignable 💬 Found the following container:")
+      console.log(container);
+
+      var $container = $(container);
+      var dragulaObj = dragula($container.find('[data-reassignment-parent]').toArray(), {
+        moves: function(el, container, handle) {
+          if ($(handle).hasClass('undraggable') || ($(handle).closest('.undraggable').length > 0)) {
+            return false;
+          }
+          return !!$(handle).closest('[data-reassignable]').length;
+        },
+        accepts: function (el, target, source, sibling) {
+          if ($(sibling).hasClass('undraggable') && $(sibling).prev().hasClass('undraggable')) {
+            return false;
+          } else {
+            return true;
+          }
+        },
+      }).on('drag', function (el) {
+        $reassignable.addClass('show-reassignable-targets')
+      }).on('drop', function (el) {
+        $reassignable.removeClass('show-reassignable-targets')
+        saveAssignments($container);
+      }).on('cancel', function (el) {
+        $reassignable.removeClass('show-reassignable-targets')
+        saveAssignments($container);
+      }).on('over', function (el, container) {
+        $(document.activeElement).blur();
+      });
+    });
+  }, 500);
+}
+
+$(document).on('turbo:load', function() {
+  console.log("🍩 Reassignable: Enabling on <body> after a Turbo load.")
+  enableReassignable($('body'));
+})
+
+$(document).on('sprinkles:update', function(event) {
+  console.log("🍩 Reassignable: Enabling on the following element after a Sprinkles content update:")
+  console.log(event.target);
+  enableReassignable($(event.target));
+})

data/app/javascript/concerns/sortable.js

@@ -0,0 +1,70 @@
+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));
+})

data/app/models/concerns/sortable.rb

@@ -0,0 +1,14 @@
+module Sortable
+  extend ActiveSupport::Concern
+
+  # define relationships.
+  included do
+    # Yes, everyone hates default scopes, but they for sure make sense here.
+    # See the thread at https://twitter.com/andrewculver/status/1405900896664313867?s=20 for more context.
+    default_scope -> { order(:sort_order) }
+
+    before_create do
+      self.sort_order ||= (collection.maximum(:sort_order) || -1) + 1
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/bullet_train/sortable/engine.rb

@@ -0,0 +1,6 @@
+module BulletTrain
+  module Sortable
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/bullet_train/sortable/version.rb

@@ -0,0 +1,5 @@
+module BulletTrain
+  module Sortable
+    VERSION = "1.0.0"
+  end
+end

data/lib/bullet_train/sortable.rb

@@ -0,0 +1,8 @@
+require "bullet_train/sortable/version"
+require "bullet_train/sortable/engine"
+
+module BulletTrain
+  module Sortable
+    # Your code goes here...
+  end
+end

data/lib/tasks/bullet_train/sortable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bullet_train_sortable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: bullet_train-sortable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Culver
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Bullet Train Sortable
+email:
+- andrew.culver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/bullet_train_sortable_manifest.js
+- app/controllers/concerns/sortable_actions.rb
+- app/javascript/concerns/reassignable.js
+- app/javascript/concerns/sortable.js
+- app/models/concerns/sortable.rb
+- config/routes.rb
+- lib/bullet_train/sortable.rb
+- lib/bullet_train/sortable/engine.rb
+- lib/bullet_train/sortable/version.rb
+- lib/tasks/bullet_train/sortable_tasks.rake
+homepage: https://github.com/bullet-train-co/bullet_train-sortable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bullet-train-co/bullet_train-sortable
+  source_code_uri: https://github.com/bullet-train-co/bullet_train-sortable
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Bullet Train Sortable
+test_files: []