resque-stagger 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2750c1757a945716e79e0f58ad4f32f15f8d20f5
-  data.tar.gz: 4b6c3d32a6721d4fa43cce4909f4b38ac79d3cf5
+  metadata.gz: 295255a8e4bc398c6ee16a781b2216605a02b805
+  data.tar.gz: fccfa6015f9a35d74e85db1247ba33cff46e7fbc
 SHA512:
-  metadata.gz: b3cff4560f6019f023f0caab822e1b2700d90c33fe8221914c3dcdcb27758ff024a73fe0914e79278ac8e5e3a350bd37500c262650b602663ad5f1ba60b30cb0
-  data.tar.gz: 85ab53b25b74eb50856c2cb97060aa565891b841c6cb8f4eac14b0f990c1fac22570a6eb73529cd4c22b121b35d5843fa1bc380a8a833e3e5fa1c0b65402a132
+  metadata.gz: 1a2f1f97d40dea588561632468115cbcc610c90d21c8bd75b34f4b27bb585df78b06153077e10946f558d7b2befb72aefb8a247e30a73959939b51d3ae6884a0
+  data.tar.gz: 4f6e89328f246286cd4ea444977bcf0808426878bdae07dcbb93b7b62a8040e7743022e2c464015bade0d3acc3749caf74ab447cedb4e585fddff00e584d168f

data/README.md

@@ -1,8 +1,6 @@
-# Resque::Stagger
+# Resque Stagger
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/resque/stagger`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Resque plugin for adding a stagger effect to enqueuing jobs.
 
 ## Installation
 
@@ -14,7 +12,7 @@ gem 'resque-stagger'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -22,17 +20,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You can use `Resque::Staggered` to enqueue jobs with a stagger effect.
+
+```ruby
+require "resque/stagger"
 
-## Development
+staggered_instance = Resque::Staggered.new(per_second: 2, start_from: Time.now + 5.seconds)
+staggered_instance.enqueue(MyJob, "arg1", "arg2")
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+The Staggered class takes two optional parameters: :per_second and :start_from.
+
+> **: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.
+
+> **:start_from** is the starting time for enqueuing jobs. The default value is Time.current.
 
 ## 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](http://contributor-covenant.org) code of conduct.
+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.
 
 ## License
 
@@ -40,5 +46,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
-# resque-stagger
+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).
+

data/lib/resque/stagger/version.rb

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

data/lib/resque/stagger.rb

@@ -1,33 +1,53 @@
 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.blank?
+        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
+        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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-stagger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Parikshit Singh