paralines 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 529c8563443dc4d0433a4e969ad894b76ded11e579a8f1781d859bd004e83464
+  data.tar.gz: 4f96bf28dfcc1726a27fe770f558b82b1ae7d77f4216abf818df34c970043fc0
+SHA512:
+  metadata.gz: 849db8748f0ffac034e984a3083ff6feab2e238a01b23b8c8ce77059ae804349413870444077d374eab0570e261fcb855b425dd7e94905ff289a9d72affd9527
+  data.tar.gz: 87cc010c941f8a029ed86f5a8b1945e5ce37cfbb0661cb90052874b74cb81e023ea68eab46ed2ccd4db06e81100c58f03b135ec6b1c0f8d169a3401eaf916f6c

data/lib/paralines.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+class ParaLines
+	C_mutex = Mutex.new
+	def C_mutex.sync_if_needed
+		if owned?
+			yield
+		else
+			synchronize do
+				yield
+			end
+		end
+	end
+
+	def initialize
+		set_flags!
+		@line_by_key = Hash.new {|h, key| h[key] = {line:h.length, col:1, text:''} }
+
+		# *ensure flush at exit
+		if @f_to_file
+			at_exit do
+				flush
+			end
+		end
+
+		if block_given?
+			begin
+				yield self
+			ensure
+				flush
+			end
+		end
+	end
+
+	# plines << "done (#{n})"
+	def << (text)
+		key = Thread.current
+		output key, text
+	end
+
+	# plines.add_static_line '- 5 workers added'
+	def add_static_line(text)
+		key = text.object_id
+		C_mutex.synchronize do
+			d = @line_by_key[key]
+			if @f_to_console
+				puts text
+			else  # for file
+				d[:text] += text.to_s
+			end
+		end
+	end
+
+	# done_order_line = plines.add_shared_line 'Done order: '
+	# done_order_line << 'some text'
+	# part = shared_line.part_open "#{n}… " + later: part.close '+'
+	# *can output part progress by adding dots: [LS   ] [cloud2…   ] --> [LS....] [cloud2…   ] — call .close('.' * done_count) multiple times with increasing number of dots
+	# *this line can be used by many threads
+	def add_shared_line(text)
+		key = text.object_id
+		output key, text
+		# < helper obj with the << and .part_open methods
+		Object.new.tap do |o|
+			rel = self
+			line_by_key = @line_by_key
+			f_to_console = @f_to_console
+
+			o.define_singleton_method :<< do |text|
+				rel.send :output, key, text
+			end
+
+			o.define_singleton_method :part_open do |text_|
+				d = line_by_key[key]
+				part_col = nil
+
+				C_mutex.synchronize do
+					# *we replace placeholder chars like: … or _ or just the last char (order here needed for priority to be able to have _ in text and use … as a placeholder)
+					part_col = d[:col] + (text_.index('…') || text_.index('_') || text_.length-1)
+
+					rel.send :output, key, text_
+				end
+
+				# < helper obj with the .close method
+				Object.new.tap do |o|
+					o.define_singleton_method :close do |end_text|
+						# *print the closing chars in the saved position
+						if f_to_console
+							rel.send :print_in_line,
+								lines_up: line_by_key.count - d[:line],
+								col: part_col,
+								text: end_text
+						else  # for file
+							d[:text][part_col-1, end_text.length] = end_text
+						end
+					end
+				end
+			end
+		end
+	end
+
+	# plines.flush
+	# *needed only when @f_to_file
+	# *can be called manually if the block form was not used and all the threads are finished
+	def flush
+		puts @line_by_key.map {|key, d| d[:text] }  if @f_to_file
+		@line_by_key.clear
+	end
+
+
+	# *needed for rewriting in tests
+	private \
+	def set_flags!
+		@f_to_console = $>.tty?
+		@f_to_file = !$>.tty?
+	end
+
+
+	private \
+	def output(key, text)
+		text = text.to_s
+		C_mutex.sync_if_needed do
+
+			# add line
+			puts if @f_to_console && !@line_by_key.has_key?(key)
+
+			d = @line_by_key[key]
+
+			if @f_to_console
+				print_in_line(
+					lines_up: @line_by_key.count - d[:line],
+					col: d[:col],
+					text: text
+				)
+			else  # for file
+				d[:text] += text
+			end
+
+			d[:col] += text.length
+		end
+	end
+
+
+	private \
+	def print_in_line(lines_up:, col:, text:)
+		# \e[s — save cursor position
+		# \e[nA — move n lines up
+		# \e[nG — move to n-th column
+		# \e[u — restore cursor position
+		print <<~OUT.delete("\n")
+			\e[s
+			\e[#{lines_up}A
+			\e[#{col}G
+			#{text}
+			\e[u
+		OUT
+	end
+
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: paralines
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yura Babak
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description:
+email:
+- yura.des@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/paralines.rb
+homepage: https://github.com/Inversion-des/paralines
+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.2.22
+signing_key:
+specification_version: 4
+summary: Nice output to console/file from concurrent threads.
+test_files: []