remain_timer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e885186ec61a3639b97081e6aba086912b09259bdc78d700126736eb810f57f
+  data.tar.gz: 3f448dfbf3f199a5469d39bec354073f215414b8e68fe0bee7b7cc689b21d8fb
+SHA512:
+  metadata.gz: af16182e3b6b625b1f09ca19ab73a7ecdf13104ed42d93e8aac427dd6ea1358909bc1ddb870b2cb24575674fb209eea9ee9d6fdb8b84b93b4e4a1b36f88018e0
+  data.tar.gz: 92cd591491ffcf66746afcc64cf28eb2251a6fbce4f94ab9aa3b23f01e6ee89352ba2b6f4a2bf90ae4b0ec1cfb2825c3876851cbe871214538c3ac00c50560cb

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.prettierrc

@@ -0,0 +1,3 @@
+printWidth: 100
+addTrailingCommas: true
+preferSingleQuotes: false

data/.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_from:
+  - .rubocop_airbnb.yml
+# prettier
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/rubocop-hq/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    ! '%': ()
+    ! '%i': ()
+    ! '%q': ()
+    ! '%Q': ()
+    ! '%r': ! '{}'
+    ! '%s': ()
+    ! '%w': ()
+    ! '%W': ()
+    ! '%x': ()

data/.rubocop_airbnb.yml

@@ -0,0 +1,2 @@
+require:
+  - rubocop-airbnb

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in remain_timer.gemspec
+gemspec
+
+gem "rake", ">= 12.0"
+gem "yard", ">= 0.9"
+gem "minitest", "~> 5.0"
+gem "minitest-power_assert", "~> 0.3"
+gem "rubocop", "~> 0.76"
+gem "rubocop-airbnb", "~> 3"
+gem "prettier", ">= 0.19"
+gem "rubocop-config-prettier", "~> 0.1"
+gem "simplecov"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Narazaka
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+   1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+   2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+   3. This notice may not be removed or altered from any source
+   distribution.

data/README.md

@@ -0,0 +1,45 @@
+# RemainTimer
+
+A small tool for estimating and displaying the remaining time of batch jobs/tasks
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'remain_timer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install remain_timer
+
+## Usage
+
+```ruby
+remain_timer = RemainTimer.new
+remain_timer.all_count = all_users.count
+remain_timer.start
+
+all_users.find_in_batches do |users|
+  remain_timer.remain_time.puts(prefix: "[fetching users]")
+  # [fetching users] past: 20:34 / remain: 55:33 / all: 1:16:07 || past: 24000 / remain: 12000 / all: 36000
+  ... # main process
+  remain_timer.progress(users.size)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/remain_timer.
+

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+require "yard/rake/yardoc_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+YARD::Rake::YardocTask.new
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "remain_timer"
+
+# 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/remain_timer.rb

@@ -0,0 +1,86 @@
+require "remain_timer/version"
+require "chronic_duration"
+
+class RemainTimer
+  attr_accessor :all_count, :estimate_laptime_size, :duration_format
+
+  def initialize(estimate_laptime_size: 20, duration_format: :chrono)
+    @laptimes = []
+    @estimate_laptime_size = estimate_laptime_size
+    @duration_format = duration_format
+  end
+
+  def start(count = 0, time = now)
+    @laptimes << LapTime.new(count, time)
+  end
+
+  def progress(count, time = now)
+    @laptimes << LapTime.new(@laptimes.last.past_count + count, time)
+  end
+
+  def remain_time
+    laptimes = @estimate_laptime_size ? @laptimes.last(@estimate_laptime_size) : @laptimes
+    first_laptime = laptimes.first
+    last_laptime = laptimes.last
+    past_count = last_laptime.past_count
+    past_duration = last_laptime.time - @laptimes.first.time
+    period_past_count = last_laptime.past_count - first_laptime.past_count
+    period_past_duration = last_laptime.time - first_laptime.time
+    if all_count
+      remain_count = all_count - past_count
+      if period_past_count > 0
+        remain_duration = period_past_duration / period_past_count * remain_count
+        all_duration = past_duration + remain_duration
+      end
+    end
+    RemainTime.new(
+      all_duration: all_duration,
+      past_duration: past_duration,
+      remain_duration: remain_duration,
+      all_count: all_count,
+      past_count: past_count,
+      remain_count: remain_count,
+      duration_format: duration_format,
+    )
+  end
+
+  private
+
+  def now
+    (@use_current ||= Time.respond_to?(:current)) ? Time.current : Time.now
+  end
+
+  LapTime = Struct.new(:past_count, :time)
+
+  RemainTime =
+    Struct.new(
+      :all_duration,
+      :past_duration,
+      :remain_duration,
+      :all_count,
+      :past_count,
+      :remain_count,
+      :duration_format,
+      keyword_init: true,
+    ) do
+      def to_s
+        "past: #{dfmt past_duration} / remain: #{dfmt remain_duration} / all: #{
+          dfmt all_duration
+        } || past: #{past_count} / remain: #{remain_count || "?"} / all: #{all_count || "?"}"
+      end
+
+      def puts(prefix: nil, postfix: nil)
+        Kernel.puts [prefix, to_s, postfix].compact.join(" ")
+      end
+
+      def print(prefix: nil, postfix: nil)
+        Kernel.print [prefix, to_s, postfix].compact.join(" ")
+      end
+
+      private
+
+      def dfmt(duration)
+        duration.nil? ? "?" : ChronicDuration.output(duration, format: duration_format)
+      end
+    end
+end

data/lib/remain_timer/version.rb

@@ -0,0 +1,3 @@
+class RemainTimer
+  VERSION = "0.1.0".freeze
+end

data/remain_timer.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/remain_timer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "remain_timer"
+  spec.version       = RemainTimer::VERSION
+  spec.licenses      = ["Zlib"]
+  spec.authors       = ["Narazaka"]
+  spec.email         = ["info@narazaka.net"]
+
+  spec.summary = "A small tool for estimating and displaying the remaining time of batch jobs/tasks"
+  spec.homepage = "https://github.com/Narazaka/remain_timer"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Narazaka/remain_timer"
+
+  # 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_dependency "chronic_duration", "~> 0.10"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: remain_timer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Narazaka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- info@narazaka.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".prettierrc"
+- ".rubocop.yml"
+- ".rubocop_airbnb.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/remain_timer.rb
+- lib/remain_timer/version.rb
+- remain_timer.gemspec
+homepage: https://github.com/Narazaka/remain_timer
+licenses:
+- Zlib
+metadata:
+  homepage_uri: https://github.com/Narazaka/remain_timer
+  source_code_uri: https://github.com/Narazaka/remain_timer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: A small tool for estimating and displaying the remaining time of batch jobs/tasks
+test_files: []