rails-queue-it 0.1.0

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+Bundler::GemHelper.install_tasks

data/app/assets/config/queue_it_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/queue_it .css

data/app/assets/stylesheets/queue_it/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/queue_it/application_controller.rb

@@ -0,0 +1,5 @@
+module QueueIt
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/queue_it/application_helper.rb

@@ -0,0 +1,4 @@
+module QueueIt
+  module ApplicationHelper
+  end
+end

data/app/jobs/queue_it/application_job.rb

@@ -0,0 +1,4 @@
+module QueueIt
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/queue_it/application_mailer.rb

@@ -0,0 +1,6 @@
+module QueueIt
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/concerns/queue_it/queable.rb

@@ -0,0 +1,89 @@
+module QueueIt::Queable
+  extend ActiveSupport::Concern
+
+  included do
+    has_one :queue,
+            as: :queable, inverse_of: :queable, dependent: :destroy, class_name: 'QueueIt::Queue'
+
+    def find_or_create_queue!
+      QueueIt::Queue.find_or_create_by!(queable: self)
+    end
+
+    def push_to_queue(nodable, in_head = true)
+      if local_queue.empty?
+        local_queue.push_node_when_queue_length_is_zero(nodable)
+      elsif local_queue.one_node?
+        local_queue.push_node_when_queue_length_is_one(nodable, in_head)
+      else
+        in_head ? local_queue.push_in_head(nodable) : local_queue.push_in_tail(nodable)
+      end
+    end
+
+    def get_next_in_queue
+      get_next_node_in_queue&.nodable
+    end
+
+    def get_next_node_in_queue
+      return if local_queue.empty?
+
+      if local_queue.one_node?
+        local_queue.head_node
+      elsif local_queue.two_nodes?
+        local_queue.get_next_in_queue_with_length_two
+      else
+        local_queue.get_next_in_queue_generic
+      end
+    end
+
+    def formatted_queue(nodable_attribute)
+      return if local_queue.empty?
+
+      if local_queue.one_node?
+        [local_queue.head_node.nodable.send(nodable_attribute)]
+      elsif local_queue.two_nodes?
+        [local_queue.head_node.nodable.send(nodable_attribute),
+          local_queue.tail_node.nodable.send(nodable_attribute)]
+      else
+        current_node = local_queue.head_node
+        array = []
+        while !current_node.nil?
+          array.push(current_node.nodable.send(nodable_attribute))
+          current_node = current_node.child_node
+        end
+        array
+      end
+    end
+
+    def delete_queue_nodes
+      queue.nodes.delete_all
+    end
+
+    def remove_from_queue(nodable)
+      return if local_queue.empty? || local_queue.nodes.where(nodable: nodable).empty?
+
+      ActiveRecord::Base.transaction do
+        local_queue.lock!
+        local_queue.nodes.where(nodable: nodable).find_each do |node|
+          remove_node(node)
+        end
+      end
+    end
+
+    private
+
+    def local_queue
+      @local_queue ||= find_or_create_queue!
+    end
+
+    def remove_node(node)
+      node.reload
+      previous_node = node.parent_node
+      child_node = node.child_node
+      node_kind = node.kind
+      node.destroy
+      new_child_node_kind = node_kind == 'head' ? node_kind : child_node&.kind
+      child_node&.update!(parent_node: previous_node, kind: new_child_node_kind)
+      previous_node&.update!(kind: node_kind) if node_kind == 'tail' && previous_node&.any?
+    end
+  end
+end

data/app/models/queue_it/application_record.rb

@@ -0,0 +1,5 @@
+module QueueIt
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/queue_it/node.rb

@@ -0,0 +1,68 @@
+module QueueIt
+  class Node < ApplicationRecord
+    belongs_to :nodable, polymorphic: true
+    belongs_to :queue, optional: true, counter_cache: :count_of_nodes
+    belongs_to :parent_node, class_name: 'QueueIt::Node', optional: true
+    has_one :child_node,
+            class_name: 'QueueIt::Node',
+            dependent: :nullify,
+            foreign_key: 'parent_node_id',
+            inverse_of: :parent_node
+
+    enum kind: { head: 0, any: 1, tail: 2 }
+
+    validate :only_one_head, :only_one_tail
+
+    def only_one_head
+      if repeated_kind?('head')
+        errors.add(:kind, 'There can not be more than 1 head node in each queue')
+      end
+    end
+
+    def only_one_tail
+      if repeated_kind?('tail')
+        errors.add(:kind, 'There can not be more than 1 tail node in each queue')
+      end
+    end
+
+    def head?
+      kind == 'head'
+    end
+
+    def tail?
+      kind == 'tail'
+    end
+
+    def any?
+      kind == 'any'
+    end
+
+    private
+
+    def repeated_kind?(kind)
+      changes['kind'].present? && (changes['kind'].first == 'any' ||
+        changes['kind'].first.nil?) && changes['kind'].last == kind &&
+        queue.nodes.find_by(kind: kind).present?
+    end
+  end
+end
+
+# == Schema Information
+#
+# Table name: queue_it_nodes
+#
+#  id             :bigint(8)        not null, primary key
+#  nodable_type   :string
+#  nodable_id     :bigint(8)
+#  queue_id       :bigint(8)
+#  parent_node_id :bigint(8)
+#  kind           :integer
+#  created_at     :datetime         not null
+#  updated_at     :datetime         not null
+#
+# Indexes
+#
+#  index_queue_it_nodes_on_nodable         (nodable_type,nodable_id)
+#  index_queue_it_nodes_on_parent_node_id  (parent_node_id)
+#  index_queue_it_nodes_on_queue_id        (queue_id)
+#

data/app/models/queue_it/queue.rb

@@ -0,0 +1,111 @@
+module QueueIt
+  class Queue < ApplicationRecord
+    belongs_to :queable, polymorphic: true
+    has_many :nodes, dependent: :destroy
+
+    def head_node
+      nodes.find_by(kind: :head)
+    end
+
+    def tail_node
+      nodes.find_by(kind: :tail)
+    end
+
+    def size
+      nodes.size
+    end
+
+    def empty?
+      size.zero?
+    end
+
+    def one_node?
+      size == 1
+    end
+
+    def two_nodes?
+      size == 2
+    end
+
+    def get_next_in_queue_with_length_two
+      next_node = ActiveRecord::Base.transaction do
+        lock!
+        old_head_node = head_node.lock!
+        old_tail_node = tail_node.lock!
+        nodes.where.not(kind: :any).each { |node| node.update!(kind: :any) }
+        old_head_node.update!(kind: :tail, parent_node: old_tail_node)
+        old_tail_node.update!(kind: :head, parent_node: nil)
+        old_head_node
+      end
+      next_node
+    end
+
+    def get_next_in_queue_generic
+      next_node = ActiveRecord::Base.transaction do
+        lock!
+        old_head_node = head_node.lock!
+        old_second_node = old_head_node.child_node.lock!
+        old_tail_node = tail_node.lock!
+        nodes.where.not(kind: :any).find_each { |node| node.update!(kind: :any) }
+        old_head_node.update!(kind: :tail, parent_node: old_tail_node)
+        old_second_node.update!(kind: :head, parent_node: nil)
+        old_head_node
+      end
+      next_node
+    end
+
+    def push_node_when_queue_length_is_zero(nodable)
+      ActiveRecord::Base.transaction do
+        lock!
+        nodes.create!(nodable: nodable, kind: :head)
+      end
+    end
+
+    def push_node_when_queue_length_is_one(nodable, in_head)
+      if in_head
+        push_in_head(nodable)
+      else
+        ActiveRecord::Base.transaction do
+          lock!
+          nodes.create!(nodable: nodable, kind: :tail, parent_node: head_node)
+        end
+      end
+    end
+
+    def push_in_head(nodable)
+      ActiveRecord::Base.transaction do
+        lock!
+        old_head_node = head_node.lock!
+        kind = one_node? ? :tail : :any
+        old_head_node.update!(kind: kind)
+        new_head_node = nodes.create!(nodable: nodable, kind: :head)
+        old_head_node.update!(parent_node: new_head_node)
+      end
+    end
+
+    def push_in_tail(nodable)
+      ActiveRecord::Base.transaction do
+        lock!
+        old_tail_node = tail_node.lock!
+        old_tail_node.update!(kind: :any)
+        nodes.create!(nodable: nodable, kind: :tail, parent_node: old_tail_node)
+      end
+    end
+  end
+end
+
+# == Schema Information
+#
+# Table name: queue_it_queues
+#
+#  id             :bigint(8)        not null, primary key
+#  queable_type   :string
+#  queable_id     :bigint(8)
+#  created_at     :datetime         not null
+#  updated_at     :datetime         not null
+#  count_of_nodes :bigint(8)        default(0)
+#
+# Indexes
+#
+#  index_queue_it_queues_on_queable  (queable_type,queable_id)
+#

data/app/views/layouts/queue_it/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Queue it</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "queue_it/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/rails

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/queue_it/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "action_cable/engine"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,2 @@
+QueueIt::Engine.routes.draw do
+end

data/db/migrate/20210723140008_create_queue_it_queues.rb

@@ -0,0 +1,10 @@
+class CreateQueueItQueues < ActiveRecord::Migration[6.1]
+  def change
+    create_table :queue_it_queues do |t|
+      t.references :queable, polymorphic: true
+      t.bigint :count_of_nodes, default: 0
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210723140434_create_queue_it_nodes.rb

@@ -0,0 +1,12 @@
+class CreateQueueItNodes < ActiveRecord::Migration[6.1]
+  def change
+    create_table :queue_it_nodes do |t|
+      t.references :nodable, polymorphic: true
+      t.references :queue
+      t.references :parent_node
+      t.integer :kind
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/queue_it/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Install the engine in host app.
+
+Example:
+    rails generate queue_it:install

data/lib/generators/queue_it/install/install_generator.rb

@@ -0,0 +1,19 @@
+class QueueIt::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_initializer
+    template "initializer.rb", "config/initializers/queue_it.rb"
+  end
+
+  def mount_routes
+    line = "Rails.application.routes.draw do\n"
+    inject_into_file "config/routes.rb", after: line do <<-"HERE".gsub(/^ {4}/, '')
+      mount QueueIt::Engine => "/queue_it"
+    HERE
+    end
+  end
+
+  def copy_engine_migrations
+    rake "queue_it:install:migrations"
+  end
+end

data/lib/generators/queue_it/install/templates/initializer.rb

@@ -0,0 +1,2 @@
+QueueIt.setup do |config|
+end