progressor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa7eacefe70e6b186f9a72625d6158db19b7f9b45b327c397b7b4402dc56bc47
+  data.tar.gz: 5cb7a42fffe3d6650a48454e41c73d8f74e7cb72fdf521fb2fdd6e59bb2cae8c
+SHA512:
+  metadata.gz: 2d11d38113127328cb2d0cd6b6d98652f9e6010816aebdbbd0c44cc27b331ba03c9b961308f2ec71e6abb5f0b0694f4952132214a126cdbecb5d062741e7cbe0
+  data.tar.gz: cba7008ee6ca3151ba3c89159dc7835d8d76b5cb981da4017d3dffe0fdb14a9bf0c3ef9e18a6f532ab220f4abececc487a8145e86e34b77b226b9a81f9473f13

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 andrey.radev@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/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrew Radev
+
+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,31 @@
+A very basic library to measure loops in a long-running task.
+
+*Note: Very incomplete, so mostly for personal usage. Will hopefully flesh it out, write tests, configuration, etc, at some point (PRs welcome). Until then, a similar library can be found here: https://github.com/mkdynamic/ke*
+
+Example usage:
+
+``` ruby
+progressor = Progressor.new(total_count: Product.count)
+
+Product.find_each do |product|
+  if product.not_something_we_want_to_process?
+    progressor.skip(1)
+    next
+  end
+
+  progressor.run do |progress|
+    puts "[#{progress}] Product #{product.id}"
+    product.calculate_interesting_stats
+  end
+end
+```
+
+Example output:
+
+```
+...
+[0038/1000, (004%), t/i: 0.5s, ETA: 8m:0.27s] Product 38
+[0039/1000, (004%), t/i: 0.5s, ETA: 7m:58.47s] Product 39
+[0040/1000, (004%), t/i: 0.5s, ETA: 7m:57.08s] Product 40
+...
+```

data/lib/progressor.rb

@@ -0,0 +1,119 @@
+require 'benchmark'
+
+# Used to measure the running time of parts of a long-running task and output
+# an estimation based on the average of the last 10-100 measurements.
+#
+# Example usage:
+#
+#   progressor = Progressor.new(total_count: Product.count)
+#
+#   Product.find_each do |product|
+#     if product.not_something_we_want_to_process?
+#       progressor.skip(1)
+#       next
+#     end
+#
+#     progressor.run do |progress|
+#       puts "[#{progress}] Product #{product.id}"
+#       product.calculate_interesting_stats
+#     end
+#   end
+#
+# Example output:
+#
+#   ...
+#   [0038/1000, (004%), t/i: 0.5s, ETA: 8m:0.27s] Product 38
+#   [0039/1000, (004%), t/i: 0.5s, ETA: 7m:58.47s] Product 39
+#   [0040/1000, (004%), t/i: 0.5s, ETA: 7m:57.08s] Product 40
+#   ...
+#
+class Progressor
+  VERSION = '0.0.1'
+
+  # Utility method to print a message with the time it took to run the contents
+  # of the block.
+  #
+  # > Progressor.puts("Working on a thing") { thing_work }
+  #
+  # Working on a thing...
+  # Working on a thing DONE: 2.1s
+  #
+  def self.puts(message, &block)
+    Kernel.puts "#{message}..."
+    measurement = Benchmark.measure { block.call }
+    Kernel.puts "#{message} DONE: #{format_time(measurement.real)}"
+  end
+
+  def initialize(total_count:)
+    @total_count = total_count
+    @total_count_digits = total_count.to_s.length
+    @current = 0
+    @measurements = []
+    @averages = []
+  end
+
+  def run
+    @current += 1
+
+    measurement = Benchmark.measure { yield self }
+
+    @measurements << measurement.real
+    # only keep last 1000
+    @measurements.shift if @measurements.count > 1000
+
+    @averages << average(@measurements)
+    @averages = @averages.compact
+    # only keep last 100
+    @averages.shift if @averages.count > 100
+  end
+
+  def skip(n)
+    @total_count -= n
+  end
+
+  def to_s
+    [
+      "#{@current.to_s.rjust(@total_count_digits, '0')}/#{@total_count}",
+      "(#{((@current / @total_count.to_f) * 100).round.to_s.rjust(3, '0')}%)",
+      "t/i: #{self.class.format_time(per_iteration)}",
+      "ETA: #{self.class.format_time(eta)}",
+    ].join(', ')
+  end
+
+  def per_iteration
+    return nil if @measurements.count < 10
+    average(@averages)
+  end
+
+  def eta
+    return nil if @measurements.count < 10
+
+    remaining_time = per_iteration * (@total_count - @current)
+    remaining_time.round(2)
+  end
+
+  private
+
+  def self.format_time(time)
+    return "?s" if time.nil?
+
+    if time < 0.1
+      "#{(time * 1000).round(2)}ms"
+    elsif time < 60
+      "#{time.round(2)}s"
+    elsif time < 3600
+      minutes = time.to_i / 60
+      seconds = (time - minutes * 60).round(2)
+      "#{minutes}m:#{seconds}s"
+    else
+      hours = time.to_i / 3600
+      minutes = (time.to_i % 3600) / 60
+      seconds = (time - (hours * 3600 + minutes * 60)).round(2)
+      "#{hours}h:#{minutes}m:#{seconds}s"
+    end
+  end
+
+  def average(collection)
+    collection.inject(&:+) / collection.count.to_f
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: progressor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Radev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: |
+  Provides a way to measure how long each loop in a task took, outputting a
+  report with an estimated time till the task is done.
+email:
+- andrey.radev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- lib/progressor.rb
+homepage: https://github.com/AndrewRadev/progressor
+licenses:
+- MIT
+metadata: {}
+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.0
+signing_key: 
+specification_version: 4
+summary: Measure iterations in a long-running task
+test_files: []