rails-queue-it 0.1.0

data/.ruby-version

@@ -0,0 +1 @@
+2.7

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v0.1.0
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in queue_it.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,277 @@
+PATH
+  remote: .
+  specs:
+    rails-queue-it (0.1.0)
+      rails (>= 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4)
+      actionpack (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activesupport (= 6.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4)
+      actionpack (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4)
+      activesupport (= 6.1.4)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activestorage (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activesupport (= 6.1.4)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    annotate (3.1.1)
+      activerecord (>= 3.2, < 7.0)
+      rake (>= 10.4, < 14.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    erubi (1.10.0)
+    factory_bot (6.2.0)
+      activesupport (>= 5.0.0)
+    factory_bot_rails (6.2.0)
+      factory_bot (~> 6.2.0)
+      railties (>= 5.0.0)
+    faker (2.18.0)
+      i18n (>= 1.6, < 2)
+    ffi (1.15.3)
+    formatador (0.3.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    json (2.5.1)
+    listen (3.6.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.10.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.2.8)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mini_mime (1.1.0)
+    minitest (5.14.4)
+    nenv (0.3.0)
+    nio4r (2.5.8)
+    nokogiri (1.11.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.11.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.11.7-x86_64-linux)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pg (1.2.3)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-rails (0.3.9)
+      pry (>= 0.10.4)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4)
+      actioncable (= 6.1.4)
+      actionmailbox (= 6.1.4)
+      actionmailer (= 6.1.4)
+      actionpack (= 6.1.4)
+      actiontext (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activemodel (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-rails (2.11.3)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    shoulda-matchers (5.0.0)
+      activesupport (>= 5.2.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.1.0)
+    tins (1.29.1)
+      sync
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  annotate (~> 3.0)
+  bundler (~> 2.2.15)
+  coveralls
+  factory_bot_rails
+  faker
+  guard-rspec
+  pg
+  pry
+  pry-rails
+  rails-queue-it!
+  rspec-rails
+  rspec_junit_formatter
+  rubocop (~> 1.9)
+  rubocop-rails
+  shoulda-matchers
+  sqlite3
+
+BUNDLED WITH
+   2.2.24

data/Guardfile

@@ -0,0 +1,12 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  spec_dic = "spec"
+  # RSpec files
+  watch("spec/spec_helper.rb") { spec_dic }
+  watch("spec/rails_helper.rb") { spec_dic }
+  watch(%r{^spec/support/(.+)\.rb$}) { spec_dic }
+  watch(%r{^spec/.+_spec\.rb$})
+  # Engine files
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb)$}) { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2021 Platanus
+
+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,202 @@
+# Queue It
+
+[![Gem Version](https://badge.fury.io/rb/queue-it.svg)](https://badge.fury.io/rb/queue-it)
+[![CircleCI](https://circleci.com/gh/platanus/queue-it.svg?style=shield)](https://app.circleci.com/pipelines/github/platanus/queue-it)
+
+This gem has been develope to manage recurrent processes that need someone (or something) responsable.
+For example, imagine you have a recurrent task for a certain group of people like responding the chat of
+your website. A recurrent queue would help you distribuit in a uniform way the workload of the people in the group.
+This gem installs an engine in your rails app.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "queue-it"
+```
+
+```bash
+bundle install
+```
+
+Then, run the installer:
+
+```bash
+rails generate queue_it:install
+```
+
+## Usage
+
+For the purpose of this explanation we'll use the models `Task` and `User` to explain the workaround of this gem. Both models only have one attribute: `:name`.
+### Models of the gem
+This gem implements the models `QueueIt::Queue` and `QueueIt::Node`, each queue has polymorphic relation with a queable object (i.e. a `Task` instace) and each node has a polymorphic relation with a nodable object (i.e. the object queued).
+
+### Before Starting
+This gem uses [`ActiveRecord::Locking::Pessimistic `](https://api.rubyonrails.org/classes/ActiveRecord/Locking/Pessimistic.html) so the behaviour with sqlite is not the same as with Postgres or MySql. Make sure you use one of the latters.
+### Queable concern
+Add the `QueueIt::Queable` concern to the model you want to have a queue. In this case we'll ilustrate this with the task model:
+```ruby
+class Task < ApplicationRecord
+  include QueueIt::Queable
+end
+```
+
+### Concern methods
+With the `QueueIt::Queable` concern added to your model you'll have access to a group of methods to manage the queue's behaviour.
+Note that in this version of the gem the model with the concern will have only one queue through a `has_one` relationship included in the concern.
+
+#### Create a Queue
+The method `find_or_create_queue!` present in the concern will return a new queue (in case it was not created) or the queue realated to the instance model.
+```ruby
+task = Task.create!(name: 'Example Task')
+task_queue = task.find_or_create_queue!
+```
+
+#### Add a node to the Queue
+The method `push_to_queue` will allow you to add a nodable in the first position of the queue or the last one depending on the `head_node` param.
+```ruby
+task = Task.create!(name: 'Example Task')
+nodable = User.create!(name: 'Gabriel')
+head_node = true
+# add the user as the nodable object in the first node of the queue
+task.push_to_queue(nodable, head_node)
+```
+Note that the second value (`head_node`) is optional with a default `true` value.
+
+> It's not necessary to create the queue manually. The `push_to_queue` method will execute `find_or_create_queue!` before adding the node.
+
+#### Get next nodable/node of the queue
+To obtain the next nodable/node of the queue we've implemented the methods `get_next_in_queue` and `get_next_node_in_queue`. The first one calls the second one but instead of returning the node returns the nodable object.
+First, let's add some nodes to the queue:
+```ruby
+task = Task.create!(name: 'Example')
+task.push_to_queue(User.create!(name: 'Gabriel'))
+task.push_to_queue(User.create!(name: 'Leandro'))
+task.push_to_queue(User.create!(name: 'Raimundo'))
+# Note that the order of the queue is now: [Raimundo's node, Leandro's node, Gabriel's node]
+```
+Now with the `get_next_in_queue` method we'll the obtain user with name `'Raimundo'` and the order of the queue will be updated.
+```ruby
+nodable = task.get_next_in_queue
+nodable.name == 'Raimundo' # true
+# the new order of the queue will be: [Leandro's node, Gabriel's node, Raimundo's node]
+```
+Now if we would of used `get_next_node_in_queue` instead of `get_next_in_queue` method we would of obtained the node containing the user with name `'Raimundo'` as nodable and the order of the queue would have been updated like before.
+```ruby
+node = task.get_next_in_queue
+node.nodable.name == 'Raimundo' # true
+# the new order of the queue will be: [Leandro's node, Gabriel's node, Raimundo's node]
+```
+
+#### Formatted Queue
+We included a method to obtain the queue formatted by an attribute/method. Note that the nodables will need to have the attribute or an implementation of the method called.
+```ruby
+# creation of the queue
+task = Task.create!(name: 'Example')
+task.push_to_queue(User.create!(name: 'Gabriel'))
+task.push_to_queue(User.create!(name: 'Leandro'))
+task.push_to_queue(User.create!(name: 'Raimundo'))
+# The order of the queue is now: [Raimundo's node, Leandro's node, Gabriel's node]
+response = task.formatted_queue('name')
+response == ['Raimundo', 'Leandro', 'Gabriel'] # true
+```
+
+#### Delete all the nodes of the queue
+With the method `delete_queue_nodes` you'll be able to clean the queue.
+```ruby
+task = Task.create!(name: 'Example')
+task.push_to_queue(User.create!(name: 'Gabriel'))
+task.push_to_queue(User.create!(name: 'Leandro'))
+task.push_to_queue(User.create!(name: 'Raimundo'))
+# delete de queue nodes
+task.delete_queue_nodes
+task.queue.size? == 0 # true
+```
+
+#### Remove a nodable object
+In case you need to remove all the nodes of a queue containing an specific nodable you can use the `remove_from_queue(nodable)` method.
+```ruby
+task = Task.create!(name: 'Example')
+gabriel = User.create!(name: 'Gabriel')
+leandro = User.create!(name: 'Leandro')
+raimundo = User.create!(name: 'Raimundo')
+task.push_to_queue(gabriel)
+task.push_to_queue(leandro)
+task.push_to_queue(raimundo)
+task.push_to_queue(leandro)
+# Now we have a queue that look's like this:
+# [Leandro's node, Raimundo's node, Leandro's node, Gabriel's node]
+task.remove_from_queue(leandro)
+# The queue will now look like this: [Raimundo's node, Gabriel's node]
+```
+
+## Development
+
+### Models and migrations
+
+- Create dummy app models with development and testing purposes inside the dummy app `spec/dummy`:
+
+  `bin/rails g model user`
+
+  The `User` model will be created in `spec/dummy/app/models`.
+  The `user_spec.rb` file needs to be deleted, but it is a good idea to leave the factory.
+
+- Create engine related models inside the engine's root path '/':
+
+  `bin/rails g model job`
+
+  The `EngineName::Job` model will be created in `app/models/engine_name`.
+  A factory will be added to `engine_name/spec/factories/engine_name/jobs.rb`, you must to add the `class` option manually.
+
+  ```ruby
+  FactoryBot.define do
+    factory :job, class: "EngineName::Job" do
+      # ...
+    end
+  end
+  ```
+
+- While developing the engine run migrations in the root path `bin/rails db:migrate`. This will apply the gem and dummy app migrations too.
+- When using in a project, the engine migrations must be copied to it. This can be done by running: `bin/rails engine_name:install:migrations`
+
+## Testing
+
+To run the specs you need to execute, in the root path of the engine, the following command:
+
+```bash
+bundle exec guard
+```
+
+You need to put **all your tests** in the `/queue_it/spec` directory.
+
+## Publishing
+
+On master/main branch...
+
+1. Change `VERSION` in `lib/queue_it/version.rb`.
+2. Change `Unreleased` title to current version in `CHANGELOG.md`.
+3. Run `bundle install`.
+4. Commit new release. For example: `Releasing v0.1.0`.
+5. Create tag. For example: `git tag v0.1.0`.
+6. Push tag. For example: `git push origin v0.1.0`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/queue_it/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+Queue It is maintained by [platanus](http://platan.us).
+
+## License
+
+Queue It is © 2021 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.