rpv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fdb60cbf7a2013a1c3d8f226de95a1fe2504d5d783d475d693caec111100e58b
+  data.tar.gz: 283247bce675713e7b752461fcf6ce458c4d9e9e3d70a63d633dd943b14a7c85
+SHA512:
+  metadata.gz: 3374d40f52abb43edb38a6d27641e6b2d3d1e9080c705ece404a984b475a53257430c64361fb65f400d81f94985911eae3854dd185486e39018b686317c3723a
+  data.tar.gz: b684b97e157f6a7314206d30bb6d2670c3702b9b288ac463e468da1d883cfbcdb76df1f53e15f22d878518c5b9b940640cb25df864723719fd6b9b73a079d58a

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-11
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Sergio Gil
+
+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,25 @@
+# Rpv
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rpv
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rpv
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on Codeberg at https://codeberg.org/sgilperez/rpv.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/rpv/extensions.rb

@@ -0,0 +1,21 @@
+require "rpv"
+require "rpv/global"
+
+module Enumerable
+  def with_rpv(**options)
+    Rpv::Global.init(size: size, **options)
+    self
+  end
+
+  def finish_rpv
+    Rpv::Global.finish
+    self
+  end
+end
+
+class Object
+  def rpv
+    Rpv::Global.increment
+    self
+  end
+end

data/lib/rpv/global.rb

@@ -0,0 +1,13 @@
+module Rpv::Global
+  def self.init(**options)
+    @rpv = Rpv.new(**options)
+  end
+
+  def self.increment
+    @rpv.increment
+  end
+
+  def self.finish
+    @rpv.finish
+  end
+end

data/lib/rpv/options.rb

@@ -0,0 +1,16 @@
+class Rpv::Options
+  MAPPED_OPTIONS = %w[size name interval rate_limit]
+  BOOLEAN_MAPPED_OPTIONS = %w[quiet progress fineta]
+
+  def self.parse(options)
+    options.transform_keys!(&:to_s)
+    args = %w[--si --line-mode --discard --cursor]
+    MAPPED_OPTIONS.each do |option|
+      args << ["--#{option.tr("_", "-")}", options[option].to_s] if options[option]
+    end
+    BOOLEAN_MAPPED_OPTIONS.each do |option|
+      args << "--#{option.tr("_", "-")}" if options[option]
+    end
+    args.flatten
+  end
+end

data/lib/rpv/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Rpv
+  VERSION = "0.1.0"
+end

data/lib/rpv.rb

@@ -0,0 +1,17 @@
+require "rpv/options"
+
+class Rpv
+  def initialize(options = {})
+    @pv = IO.popen(["pv"] + Options.parse(options).to_a, "w+")
+  end
+
+  def increment
+    @pv.puts
+    @pv.flush
+  end
+
+  def finish
+    @pv.flush
+    @pv.close
+  end
+end

data/sig/rpv.rbs

@@ -0,0 +1,4 @@
+module Rpv
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: rpv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergio Gil
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-11 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- sgilperez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rpv.rb
+- lib/rpv/extensions.rb
+- lib/rpv/global.rb
+- lib/rpv/options.rb
+- lib/rpv/version.rb
+- sig/rpv.rbs
+homepage: https://codeberg.org/sgilperez/rpv
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://codeberg.org/sgilperez/rpv
+  source_code_uri: https://codeberg.org/sgilperez/rpv
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Provides progress bars (including multiple parallel bars) and rate limiting
+  by wrapping pv
+test_files: []