progress_job_mongoid 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b2764293a5ae97cbdf2ef371354865a371a83009a96b2f0dfc041cfb637c021
-  data.tar.gz: ccf194fae8132ca6251da0248bc1915cf68e827ff5a5c41a230a27a89c621980
+  metadata.gz: 8654f41d67f0ce605f092d39f59e7b51310035962a643bdda25145a5b4ac9cff
+  data.tar.gz: ad21678c57997320cf7350f398c37eb38bb8d0f0d759443ba110cc6706345f33
 SHA512:
-  metadata.gz: cd883936afa4204dbc509fefa2e9dc93639598da8b56f8165d816f62e9dea91dc8d62eaea3ae9ef4e46d3c3ff3bf04de1aa06f6a8ab20bd15eb3b22b0f856122
-  data.tar.gz: d3f2c86d7751cc4fc3342f87a8ae626a010a420427686dbbc248f45dd0d858a65832cc23f6fc49358cc992bbd7b29463ef858ac1d4f0893507bd57eee24ea580
+  metadata.gz: 974af13784eb9e1626dd7c269b92c61ecaf8e7c23776aab36a7d971fe720cdc4b0ef32c2a9a7d7e066893749858373582c0a666fd1f1d8190bfc4162a3488db3
+  data.tar.gz: b93ec7f7126e0288639c08c213ca84e71b5eb9cfe1ab92217f7716697d3b74f8b9a508fd53449c0036ea272db60231ae1532d636c6d3d9e036e0a3855492479f

data/README.md

@@ -1,8 +1,6 @@
 # ProgressJobMongoid
 
-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/progress_job_mongoid`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem adds a couple of columns to delayed job table, and gives you a basic class for working with progress with support for delayed_job_mongoid.
 
 ## Installation
 
@@ -16,28 +14,38 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Run generator (run delayed job generators first):
 
-    $ gem install progress_job_mongoid
+    $ rails generate progress_job_mongoid:install
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a new class that extends ProgressJobMongoid::Base
 
-## Development
+```
+class NewJob < ProgressJobMongoid::Base
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  def perform
+    # some actions
+  end
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+end
+```
 
-## Contributing
+Inside perform method you can use:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/progress_job_mongoid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/progress_job_mongoid/blob/master/CODE_OF_CONDUCT.md).
+```
+update_progress(step: 10) # default step is 1
+update_stage('name of stage')
+update_stage_progress('name of stage', step: 11)
+update_progress_max(progress_max)
+```
+methods to update the job progress.
 
-## License
+To create a new job use Delayed job enqueue method, and pass the progress_max value
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+    $ job = Delayed::Job.enqueue NewJob.new(progress_max: 100) # default progress_max is 100
 
-## Code of Conduct
+There is also a controller which returns the delayed job with calculated percentage
 
-Everyone interacting in the ProgressJobMongoid project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/progress_job_mongoid/blob/master/CODE_OF_CONDUCT.md).
+    $ GET 'progress-jobs/:job_id/'

data/lib/progress_job_mongoid/mongoid.rb

@@ -9,7 +9,7 @@ module Delayed
         include ::Mongoid::Timestamps
 
         field :progress_stage,   type: String, default: ''
-        field :progress_current, type: Integer
+        field :progress_current, type: Integer, default: 0
         field :progress_max,     type: Integer, default: 100
       end
     end

data/lib/progress_job_mongoid/version.rb

@@ -1,3 +1,3 @@
 module ProgressJobMongoid
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progress_job_mongoid
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Priyank Abhani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: delayed_job_mongoid
@@ -46,7 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/generators/progress_job_mongoid/install_generator.rb
+- lib/generators/install_generator.rb
 - lib/progress_job_mongoid.rb
 - lib/progress_job_mongoid/base.rb
 - lib/progress_job_mongoid/mongoid.rb