io-line.rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30852709ffb0f880474bb199ffe2a6a8d09a2e4d7eaa57d44807742a93dd58c3
+  data.tar.gz: 84e951c35619e7180504effc5e074af828061f69264febe9fd3be430b2b6e575
+SHA512:
+  metadata.gz: 399d5e5e18b760f86a563526c235fd3f43942acff34ea1a8c00a1278c2768dbb8dc6671a6ec7da0b859ab6aef9fabefab5cb402d3918b0f381ee44b27d243848
+  data.tar.gz: 575d115de80bd38981f9a67296add1ac71f96f221cce02ce1bba0945022c77beb10b1ccac51948cded2646b01361da2b368176191caacdf6a02fa76b7308a140

data/README.md

@@ -0,0 +1,47 @@
+## About
+
+io-line.rb is an IO library that can reuse one or more lines of output. <br>
+The implementation uses the
+[io-console](https://www.rubydoc.info/gems/io-console)
+library from Ruby's stdlib.
+
+## Examples
+
+### One line
+
+The following example counts from 1 up to 100. The number from the previous
+iteration is replaced with a number from the current iteration, and the same
+line is reused until the iteration is completed. It is possible to end the
+current line, and move onto the next line with the `IO::Line#end` method:
+
+ ```ruby
+require "io/line"
+line = IO::Line.new($stdout)
+1.upto(100) do |number|
+  line.rewind.print(number)
+  sleep 0.1
+end
+line.end
+```
+
+## Documentation
+
+A complete API reference is available at
+[0x1eef.github.io/x/io-line.rb](https://0x1eef.github.io/x/io-line.rb)
+
+## Install
+
+io-line.rb can be installed via rubygems.org:
+
+    gem install io-line.rb
+
+## Sources
+
+* [GitHub](https://github.com/0x1eef/io-line.rb)
+* [GitLab](https://gitlab.com/0x1eef/io-line.rb)
+
+## License
+
+[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
+<br>
+See [LICENSE](./LICENSE)

data/io-line.rb.gemspec

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "./lib/io/line"
+Gem::Specification.new do |gem|
+  gem.name = "io-line.rb"
+  gem.authors = ["0x1eef"]
+  gem.email = ["0x1eef@protonmail.com"]
+  gem.homepage = "https://github.com/0x1eef/io-line.rb#readme"
+  gem.version = IO::Line::VERSION
+  gem.licenses = ["BSD0L"]
+  gem.files = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+  gem.summary = "Line manipulation via io-console"
+  gem.description = gem.summary
+  gem.add_runtime_dependency "io-console", "~> 0.5"
+end

data/lib/io/line/multiple.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class IO::Line::Multiple
+  def initialize(lines, cursor)
+    @lines = lines
+    @cursor = cursor
+  end
+
+  def print(*strs, lineno:)
+    line = @lines[lineno]
+    if lineno > @cursor
+      line.io.cursor_down(lineno - @cursor)
+    elsif lineno < @cursor
+      line.io.cursor_up(lineno + @cursor)
+    end
+    @cursor = lineno
+    line.rewind.print(*strs)
+  end
+end

data/lib/io/line.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class IO::Line
+  require "io/console"
+  require_relative "line/multiple"
+
+  VERSION = "0.1.0"
+  attr_reader :io
+
+  def initialize(io)
+    @io = io
+  end
+
+  def print(*strs)
+    tap { @io.print(strs.join.gsub($/, "")) }
+  end
+
+  def end
+    tap { @io.print($/) }
+  end
+
+  def rewind
+    tap do
+      @io.erase_line(2)
+      @io.goto_column(0)
+    end
+  end
+end

data/share/examples/io-line.rb/one_line_example.rb

@@ -0,0 +1,7 @@
+require "io/line"
+line = IO::Line.new($stdout)
+1.upto(100) do |number|
+  line.rewind.print(number)
+  sleep 0.1
+end
+line.end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: io-line.rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- '0x1eef'
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: io-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Line manipulation via io-console
+email:
+- 0x1eef@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".projectile"
+- README.md
+- io-line.rb.gemspec
+- lib/io/line.rb
+- lib/io/line/multiple.rb
+- share/examples/io-line.rb/one_line_example.rb
+homepage: https://github.com/0x1eef/io-line.rb#readme
+licenses:
+- BSD0L
+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.5.9
+signing_key:
+specification_version: 4
+summary: Line manipulation via io-console
+test_files: []