sk_progress_bar 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 155393a8fa686a988a353acc6a29574f64080a560ff60bf18049e41e9cf0d0e2
+  data.tar.gz: 8786bee479a514594d3c2ed7939fe8cd111692e3f3de60db2bd79f88c8aa2146
+SHA512:
+  metadata.gz: c7a0138bd049e909a17a9defa9448660a23efb47851931939b5d5d2c190eb68493fa0cd8e0aa6ede488fc55e4987ff73c24cfbbd5f342a83b0de1d44d444485c
+  data.tar.gz: 7774bd32bdc7457c0e8a8fe95e2b5e87179c755ba3f04fe2d4a4fdb44afd325e66ec87884a42cfdbc5f501d5c7ae5ab47e62e6d93a3e0d4e9c0f7ef5dc838e96

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+sk-progress-bar

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kondzolko@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sk_progress_bar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 andriy.kondzolko
+
+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,123 @@
+# SkProgressBar (Progress Bar For Sidekiq worker)
+[![Watch the video](http://i3.ytimg.com/vi/B4xov2rMtAA/maxresdefault.jpg)](https://www.youtube.com/embed/B4xov2rMtAA)
+## Rails version
+    from rails 5.0 up to 6.0
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sk_progress_bar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sk_progress_bar
+    
+## Database setup (if needed)
+(ActiveRecord only) Create migration for Sidekiq Progress Bar and migrate the database (in your Rails project):
+
+    rails g sk_progress_bar:migration
+    rake db:migrate
+
+## Add ProgressBar model (if needed)
+    rails g sk_progress_bar:models
+
+## Setup action cable (Required)
+    rails g sk_progress_bar:channel
+    
+## Routes (Required)
+    mount ActionCable.server, at: '/cable'
+    
+## Required gems
+    gem 'sidekiq'
+    
+    gem 'bootstrap' 
+    # "Boostrap" need if you will use progress bar from "bootstrap"
+## Usage
+    require 'sk_progress_bar'
+    
+    index = 0
+    objects = 10
+    
+    progress = SkProgressBar.progress_status(index, objects)
+    # progress => {:percentage=>10, :message=>"Almost done"}
+    # Calculate and return how many percent of the work done on the total amount of work
+    
+    SkProgressBar.update_progress_bar(10, Almost done, 46b26c4df9a6c0e2603552bf)
+    # Update Html Progress Bar
+    
+    SkProgressBar.create_update_db(progress[:percentage], progress[:message], jid)
+    # Create/Update Record in DB
+    
+## Example Html Code with Bootstrap
+    <div class="progress">
+      <div class="progress-bar progress-bar-striped" role="progressbar" style="width: 2%" aria-valuenow="10" aria-valuemin="2" aria-valuemax="100"></div>
+    </div>
+
+## Example Haml Code with Bootstrap
+    .progress
+      .progress-bar.progress-bar-striped{"aria-valuemax" => "100", "aria-valuemin" => "2", "aria-valuenow" => "10", :role => "progressbar", :style => "width: 2%"}
+
+
+## Example Worker Code
+    /app/workers/progress_bar_worker.rb
+    
+    
+    class ProgressBarWorker
+      include Sidekiq::Worker
+      require 'sk_progress_bar'
+    
+      def perform
+        objects = [*1..10]
+        # objects => [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+        start_cycle(objects)
+      end
+    
+      def start_cycle(objects)
+        objects.each_with_index do |object, index|
+          sleep(0.5)
+    
+          progress = SkProgressBar.progress_status(index, objects.count)
+          # progress => {:percentage=>10, :message=>"Almost done"}
+          # jid => Sidekiq Process ID (46b26c4df9a6c0e2603552bf)
+    
+          SkProgressBar.update_progress_bar(progress[:percentage], progress[:message], jid)
+          # Update Html Progress Bar
+          
+          SkProgressBar.create_update_db(progress[:percentage], progress[:message], jid)
+          # Create/Update Record in DB
+        end
+      end
+    end
+
+## Rails console
+    ProgressBarWorker.perform_async
+    or
+    ProgressBarWorker.new.perform
+    
+
+## Development
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Kondzolko/sk_progress_bar. 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.
+
+## 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 SkProgressBar project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sk_progress_bar/blob/master/CODE_OF_CONDUCT.md).
+
+## Author
+    Andriy Kondzolko

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sk_progress_bar"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/sk_progress_bar/channel/channel_generator.rb

@@ -0,0 +1,18 @@
+require 'generators/sk_progress_bar'
+require 'rails/generators/active_record'
+
+module SkProgressBar
+  module Generators
+    # Sidekiq Progress Bar generator that creates action_cable files from template
+    class ChannelGenerator < ActiveRecord::Generators::Base
+      extend Base
+
+      argument :name, :type => :string, :default => 'sk_progress_bar'
+      # Add action cable in project's folder
+      def generate_files
+        copy_file 'sk_progress_bar_channel.rb', "app/channels/#{name}_channel.rb"
+        copy_file 'sk_progress_bar.coffee', "app/assets/javascripts/channels/#{name}.coffee"
+      end
+    end
+  end
+end

data/lib/generators/sk_progress_bar/channel/templates/sk_progress_bar.coffee

@@ -0,0 +1,19 @@
+App.sk_progress_bar = App.cable.subscriptions.create "SkProgressBarChannel",
+  connected: ->
+# Called when the subscription is ready for use on the server
+
+  disconnected: ->
+# Called when the subscription has been terminated by the server
+
+  received: (data) ->
+    # Example: "data" variable => "message"=>"Almost done", "sk_process_id"=>"ea5d1b09c0d8538bc1b571be", "progress_status"=>50
+    progress_status = data.progress_status
+    # sk_process_id - Sidekiq Job Id
+    # $('.progress-bar') can be replaced to sk_process_id or any other business logic
+
+    # Example: $("##{data.sk_process_id}").attr('aria-valuenow', progress_status).css 'width', progress_status + '%'
+    $(".progress-bar").attr('aria-valuenow', progress_status).css 'width', progress_status + '%'
+
+    # For add percentage inside in progress bar
+    $(".progress-bar").text(progress_status + '%')
+    # Called when there's incoming data on the websocket for this channel

data/lib/generators/sk_progress_bar/channel/templates/sk_progress_bar_channel.rb

@@ -0,0 +1,9 @@
+class SkProgressBarChannel < ApplicationCable::Channel
+  def subscribed
+    stream_from "sk_progress_bar_channel"
+  end
+
+  def unsubscribed
+    # Any cleanup needed when channel is unsubscribed
+  end
+end

data/lib/generators/sk_progress_bar/migration/migration_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/sk_progress_bar'
+require 'rails/generators/active_record'
+
+module SkProgressBar
+  module Generators
+    # Migration generator that creates migration file from template
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      extend Base
+
+      argument :name, :type => :string, :default => 'create_sk_progress_bar'
+      # Create migration in project's folder
+      def generate_files
+        migration_template 'migration.rb', "db/migrate/#{name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/sk_progress_bar/migration/templates/migration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Migration responsible for creating a table with sk_progress_bar
+class CreateSkProgressBar < (ActiveRecord.version.release() < Gem::Version.new('5.2.0') ? ActiveRecord::Migration : ActiveRecord::Migration[5.2])
+  # Create table
+  def self.up
+    create_table :progress_bars do |t|
+      t.string :message
+      t.string :sk_process_id
+      t.integer :percentage
+
+      t.timestamps
+    end
+
+  end
+  # Drop table
+  def self.down
+    drop_table :progress_bars
+  end
+end

data/lib/generators/sk_progress_bar/models/models_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/sk_progress_bar'
+require 'rails/generators/active_record'
+
+module SkProgressBar
+  module Generators
+    # Sidekiq Progress Bar generator that creates model file from template
+    class ModelsGenerator < ActiveRecord::Generators::Base
+      extend Base
+
+      argument :name, :type => :string, :default => 'progress_bar'
+      # Create model file
+      def generate_files
+        copy_file 'progress_bar.rb', "app/models/#{name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/sk_progress_bar/models/templates/progress_bar.rb

@@ -0,0 +1,3 @@
+# SkProgressBar model for customisation & custom methods
+class ProgressBar < ApplicationRecord
+end

data/lib/generators/sk_progress_bar.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module SkProgressBar
+  # A generator module with SkProgressBar table schema.
+  module Generators
+    # A base module
+    module Base
+      # Get path for migration template
+      def source_root
+        @_sk_progress_bar_source_root ||= File.expand_path(File.join('../sk_progress_bar', generator_name, 'templates'), __FILE__)
+      end
+    end
+  end
+end

data/lib/sk_progress_bar/version.rb

@@ -0,0 +1,3 @@
+module SkProgressBar
+  VERSION = "0.1.1"
+end

data/lib/sk_progress_bar.rb

@@ -0,0 +1,37 @@
+require "sk_progress_bar/version"
+
+module SkProgressBar
+
+  def self.division_by_cycle(object_count)
+    return unless object_count.present? && object_count.positive?
+    (100 / object_count)
+  end
+
+  # Update Progress Bar
+  def self.update_progress_bar(percentage, message, jid=nil)
+    ActionCable.server.broadcast 'sk_progress_bar_channel',
+                                 message:  message,
+                                 sk_process_id: jid,
+                                 progress_status: percentage
+  end
+
+  # Return Percentage and Message result of cycle
+  def self.progress_status(cycle_index, objects_count)
+    percentage = (cycle_index + 1) * division_by_cycle(objects_count)
+    message = percentage == 100 ? 'Done' : 'Almost done'
+    { percentage: percentage, message: message }
+  end
+
+  # Add/Update record in ProgressBar table
+  def self.create_update_db(percentage, message, jid=nil)
+    return unless !!defined?(ProgressBar)
+
+    db_record = jid.present? ? ProgressBar.find_by(sk_process_id: jid) : nil
+    if db_record.present?
+      db_record.update( message: message, sk_process_id: jid, percentage: percentage )
+    else
+      new_record = ProgressBar.new( message: message, sk_process_id: jid, percentage: percentage )
+      new_record.save
+    end
+  end
+end

data/sk_progress_bar.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sk_progress_bar/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sk_progress_bar"
+  spec.version       = SkProgressBar::VERSION
+  spec.authors       = ["andriy.kondzolko"]
+  spec.email         = ["kondzolko@gmail.com"]
+
+  spec.summary       = %q{Progress bar for Sidekiq Workers}
+  spec.description   = %q{Gem 'Sidekiq-progress-bar' will help to show the current stage in the work of a Sidekiq worker in the form of a progress bar!}
+  spec.homepage      = "https://github.com/Kondzolko/sk_progress_bar"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = 'http://mygemserver.com'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Kondzolko/sk_progress_bar"
+    spec.metadata["changelog_uri"] = "https://github.com/Kondzolko/sk_progress_bar"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: sk_progress_bar
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- andriy.kondzolko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Gem 'Sidekiq-progress-bar' will help to show the current stage in the
+  work of a Sidekiq worker in the form of a progress bar!
+email:
+- kondzolko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/sk_progress_bar.rb
+- lib/generators/sk_progress_bar/channel/channel_generator.rb
+- lib/generators/sk_progress_bar/channel/templates/sk_progress_bar.coffee
+- lib/generators/sk_progress_bar/channel/templates/sk_progress_bar_channel.rb
+- lib/generators/sk_progress_bar/migration/migration_generator.rb
+- lib/generators/sk_progress_bar/migration/templates/migration.rb
+- lib/generators/sk_progress_bar/models/models_generator.rb
+- lib/generators/sk_progress_bar/models/templates/progress_bar.rb
+- lib/sk_progress_bar.rb
+- lib/sk_progress_bar/version.rb
+- sk_progress_bar.gemspec
+homepage: https://github.com/Kondzolko/sk_progress_bar
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Kondzolko/sk_progress_bar
+  source_code_uri: https://github.com/Kondzolko/sk_progress_bar
+  changelog_uri: https://github.com/Kondzolko/sk_progress_bar
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Progress bar for Sidekiq Workers
+test_files: []