resque-stagger 0.2.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 295255a8e4bc398c6ee16a781b2216605a02b805
-  data.tar.gz: fccfa6015f9a35d74e85db1247ba33cff46e7fbc
+SHA256:
+  metadata.gz: 159e7ada89f6f00107b1445850c12eedfa73ad6dd5e45cbc806e286467b5a964
+  data.tar.gz: 8f0bb3379c3f431729907b1c652b62fbb6ed55319bef75569b683d7b87d55e27
 SHA512:
-  metadata.gz: 1a2f1f97d40dea588561632468115cbcc610c90d21c8bd75b34f4b27bb585df78b06153077e10946f558d7b2befb72aefb8a247e30a73959939b51d3ae6884a0
-  data.tar.gz: 4f6e89328f246286cd4ea444977bcf0808426878bdae07dcbb93b7b62a8040e7743022e2c464015bade0d3acc3749caf74ab447cedb4e585fddff00e584d168f
+  metadata.gz: 50e12311484c9454639c035ef8ac8165ace0ccec1841454ea47305245083563678361ffd8e94c25ef5cca1f31f46c2d39328b0c2cc2db8b5946d27670eb3de07
+  data.tar.gz: ae8b9148e21084f60462a8e668900d205b58dd02c9624e16025c9805e62560b84cd72c6a5ea17db01e51f66bd11c627bdc9daa027a84e4d1fe849c49695cf225

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+.idea
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+## 0.2.1
+
+### Added
+
+* Staggering functionality
+
+## 0.3.0
+
+### Added
+
+* Queue name can be given on runtime
+
+## 1.0.2
+
+### Fixed
+
+* Improper way of prepending module
+
+### Added
+
+* Functionality to enqueue single job in a non-unit time range.
+  For example, earlier "n" jobs could have been scheduled per unit time,
+  i.e. in 1 second, but now it can be done both ways i.e. 1 job can be
+  scheduled to be enqueued per 5 seconds as well as 5 jobs can be
+  scheduled to be enqueued in 1 second.
+

data/README.md

@@ -1,6 +1,7 @@
-# Resque Stagger
+# Resque-Stagger
 
-A Resque plugin for adding a stagger effect to enqueuing jobs.
+resque-stagger is a simple Ruby gem that allows you to stagger the enqueuing of jobs
+in [Resque](https://github.com/resque/resque).
 
 ## Installation
 
@@ -12,39 +13,48 @@ gem 'resque-stagger'
 
 And then execute:
 
-    $ bundle install
+```shell
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install resque-stagger
+```shell
+gem install resque-stagger
+```
 
 ## Usage
 
-You can use `Resque::Staggered` to enqueue jobs with a stagger effect.
-
 ```ruby
-require "resque/stagger"
-
-staggered_instance = Resque::Staggered.new(per_second: 2, start_from: Time.now + 5.seconds)
-staggered_instance.enqueue(MyJob, "arg1", "arg2")
-
+require 'resque/staggered'
+
+# Set up a new staggered queue
+queue = Resque::Staggered.new(
+  start_from: Time.now + 60, # Start queuing jobs 60 seconds from now
+  number_of_jobs: 10, # Enqueue 10 jobs per time interval
+  unit_time_in_seconds: 300, # Interval of 5 minutes between each set of jobs
+  queue: 'low' # Enqueue jobs in the 'low' queue
+)
+
+# Enqueue a job with arguments
+queue.enqueue(MyJobClass, arg1, arg2, arg3)
 ```
 
-The Staggered class takes two optional parameters: :per_second and :start_from.
+- The code sets up a new staggered queue using Resque::Staggered and then enqueues a job with arguments using the
+  enqueue method of the staggered queue.
 
-> **:per_second** is the number of jobs to enqueue per second. The default value is nil, which means no limit on the number of jobs to enqueue per second.
+- Based on the options passed to the Resque::Staggered constructor, the staggered queue will enqueue 10 jobs every 5
+  minutes (300 seconds) starting 60 seconds from the current time, and enqueue the jobs in the "low" queue.
 
-> **:start_from** is the starting time for enqueuing jobs. The default value is Time.current.
+- So, if this code is run at 12:00 PM, the first set of 10 jobs will be enqueued at 12:01 PM (60 seconds later), the
+  second set of 10 jobs will be enqueued at 12:06 PM (5 minutes later), the third set of 10 jobs will be enqueued at 12:
+  11 PM (5 minutes later), and so on.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/resque-stagger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/parikshit223933/resque-stagger.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Resque Stagger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/resque-stagger/blob/master/CODE_OF_CONDUCT.md).
-
+The gem is available as open source under the terms of
+the [MIT License](https://github.com/parikshit223933/resque-stagger/blob/master/LICENSE.txt).

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "resque/stagger"
+require "resque/staggered"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/resque/{stagger → staggered}/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module Stagger
-    VERSION = "0.2.1"
+    VERSION = "1.0.3"
   end
 end

data/lib/resque/staggered.rb

@@ -0,0 +1,80 @@
+require "resque/staggered/version"
+
+module Resque
+  class Staggered
+    # Initializes a new Staggered object.
+    #
+    # @param options [Hash] The options to create the Staggered object with.
+    # @option options [Time] :start_from The time to start enqueueing jobs from (defaults to Time.current).
+    # @option options [Integer] :number_of_jobs The number of jobs to enqueue per unit time.
+    # @option options [Integer] :unit_time_in_seconds The time interval between each set of jobs.
+    # @option options [String] :queue The name of the queue to enqueue the jobs in (optional).
+    #
+    # @return [Staggered] A new instance of the Staggered class.
+    def initialize(**options)
+      @options = options
+    end
+
+    # Enqueues a job with the given arguments at a staggered time.
+    #
+    # @param klass [Object] The job class to enqueue.
+    # @param args [Array] The arguments to pass to the job.
+    #
+    # @return [void]
+    def enqueue(klass, *args)
+      if queue.present?
+        ::Resque.enqueue_at_with_queue(queue, current_enqueue_at, klass, *args)
+      else
+        ::Resque.enqueue_at(current_enqueue_at, klass, *args)
+      end
+    end
+
+    private
+
+    # Calculates the staggered time for the next job and returns it.
+    #
+    # @return [Time] The staggered time for the next job.
+    def current_enqueue_at
+      if number_of_jobs > @enqueues_in_last_unit_time.to_i
+        @enqueues_in_last_unit_time = @enqueues_in_last_unit_time.to_i + 1
+        if @unit_time_timestamp.nil?
+          return @unit_time_timestamp = starting_from
+        else
+          return @unit_time_timestamp
+        end
+      else
+        @enqueues_in_last_unit_time = 0
+        @unit_time_timestamp = @unit_time_timestamp + unit_time_in_seconds.second
+        current_enqueue_at
+      end
+    end
+
+    # Returns the time to start from.
+    #
+    # @return [Time] The time to start from.
+    def starting_from
+      @starting_from ||= @options[:start_from] || Time.current
+    end
+
+    # Returns the number of jobs to enqueue.
+    #
+    # @return [Integer] The number of jobs to enqueue.
+    def number_of_jobs
+      @options[:number_of_jobs] || nil
+    end
+
+    # Returns the time interval between each set of jobs.
+    #
+    # @return [Integer] The time interval between each set of jobs.
+    def unit_time_in_seconds
+      @options[:unit_time_in_seconds] || nil
+    end
+
+    # Returns the name of the queue to enqueue the jobs in.
+    #
+    # @return [String] The name of the queue to enqueue the jobs in.
+    def queue
+      @options[:queue] || nil
+    end
+  end
+end

data/lib/resque-staggered.rb

@@ -0,0 +1,2 @@
+require 'resque/staggered'
+require 'resque/staggered/version'

data/resque-stagger.gemspec

@@ -1,6 +1,6 @@
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "resque/stagger/version"
+require "resque/staggered/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "resque-stagger"
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/parikshit223933/resque-stagger"
-  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["changelog_uri"] = "https://github.com/parikshit223933/resque-stagger/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -33,5 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_runtime_dependency 'resque', '>= 1.25'
+  spec.add_runtime_dependency 'activesupport', '>= 5.1.7'
   spec.add_runtime_dependency 'resque-scheduler', '>= 4.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-stagger
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Parikshit Singh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.7
 - !ruby/object:Gem::Dependency
   name: resque-scheduler
   requirement: !ruby/object:Gem::Requirement
@@ -88,13 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".idea/.gitignore"
-- ".idea/misc.xml"
-- ".idea/modules.xml"
-- ".idea/resque-stagger.iml"
-- ".idea/vcs.xml"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -102,8 +112,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/resque/stagger.rb
-- lib/resque/stagger/version.rb
+- lib/resque-staggered.rb
+- lib/resque/staggered.rb
+- lib/resque/staggered/version.rb
 - resque-stagger.gemspec
 homepage: https://github.com/parikshit223933/resque-stagger
 licenses:
@@ -112,7 +123,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/parikshit223933/resque-stagger
   source_code_uri: https://github.com/parikshit223933/resque-stagger
-  changelog_uri: 'TODO: Put your gem''s CHANGELOG.md URL here.'
+  changelog_uri: https://github.com/parikshit223933/resque-stagger/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -128,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: This will stagger your resque jobs over a configurable duration rather then

data/.idea/.gitignore

@@ -1,8 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml

data/.idea/misc.xml

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" project-jdk-name="ruby-2.6.3-p62" project-jdk-type="RUBY_SDK" />
-</project>

data/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/resque-stagger.iml" filepath="$PROJECT_DIR$/.idea/resque-stagger.iml" />
-    </modules>
-  </component>
-</project>

data/.idea/resque-stagger.iml

@@ -1,16 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="RUBY_MODULE" version="4">
-  <component name="ModuleRunConfigurationManager">
-    <shared />
-  </component>
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
-      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
-      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.32, ruby-2.6.3-p62) [gem]" level="application" />
-  </component>
-</module>

data/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>

data/lib/resque/stagger.rb

@@ -1,58 +0,0 @@
-require "resque/stagger/version"
-
-# The Resque module contains the Stagger module.
-module Resque
-  module Stagger
-    # The Staggered class is used to enqueue jobs with a stagger effect.
-    class Staggered
-      # Initializes the Staggered class with given options.
-      #
-      # @param options [Hash] the options for the stagger effect.
-      # @option options [Time] :start_from starting time for enqueuing jobs.
-      # @option options [Integer] :per_second number of jobs to enqueue per second.
-      def initialize(**options)
-        @options = options
-      end
-
-      # Enqueues the given job with a stagger effect.
-      #
-      # @param klass [Class] the job class to be enqueued.
-      # @param args [Array] the arguments for the job.
-      def enqueue(klass, *args)
-        ::Resque.enqueue_at(current_enqueue_at, klass, *args)
-      end
-
-      private
-
-      # Calculates the time at which the job should be enqueued.
-      #
-      # @return [Time] the enqueue time for the job.
-      def current_enqueue_at
-        return starting_from if per_second.to_i.zero?
-        return @last_enqueued_at = starting_from if @last_enqueued_at.nil?
-
-        @enqueued_last_second = @enqueued_last_second.to_i + 1
-        return @last_enqueued_at if @enqueued_last_second < per_second.to_i
-
-        @enqueued_last_second = 0
-        @last_enqueued_at += 1.second
-      end
-
-      # Gets the starting time for enqueuing jobs.
-      #
-      # @return [Time] the starting time for enqueuing jobs.
-      def starting_from
-        @starting_from ||= @options[:start_from] || Time.current
-      end
-
-      # Gets the number of jobs to enqueue per second.
-      #
-      # @return [Integer, nil] the number of jobs to enqueue per second.
-      def per_second
-        @options[:per_second] || nil
-      end
-    end
-  end
-end
-
-Resque.prepend(Resque::Stagger)