RubyGems - paralines - Versions diffs - 1.0.0 → 1.1.0 - Mend

paralines 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 529c8563443dc4d0433a4e969ad894b76ded11e579a8f1781d859bd004e83464
-  data.tar.gz: 4f96bf28dfcc1726a27fe770f558b82b1ae7d77f4216abf818df34c970043fc0
+  metadata.gz: ed6bff64ad603e59c3cc6a32adf7bbaba2872a69bb7c84bbe4173434bd2165c8
+  data.tar.gz: faffc56b4a7f731fa92057d0e01daefb7f33c2252715df5fd604925a22bf5ec7
 SHA512:
-  metadata.gz: 849db8748f0ffac034e984a3083ff6feab2e238a01b23b8c8ce77059ae804349413870444077d374eab0570e261fcb855b425dd7e94905ff289a9d72affd9527
-  data.tar.gz: 87cc010c941f8a029ed86f5a8b1945e5ce37cfbb0661cb90052874b74cb81e023ea68eab46ed2ccd4db06e81100c58f03b135ec6b1c0f8d169a3401eaf916f6c
+  metadata.gz: 169868a642b113e709e6e1b76b20a829971b46e525020f3ce61ab91bb9d0a50c17583a1818002676a64d3c3594568be31eac91dfdd21d5543fb7a89dc4e756df
+  data.tar.gz: fec478726daccb53dd2ec805ec0784a220e82c85a5ae2abe2c9dd686f31b9820b97186db0d2a59cf0d737b1458c19f8a4bc76587e72434223c76d4c981a77493

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2022 Inversion
+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 ADDED Viewed

@@ -0,0 +1,126 @@
+# ParaLines Ruby Gem [![version](https://badge.fury.io/rb/paralines.svg)](https://rubygems.org/gems/paralines)
+Nice output to console/file from concurrent threads:
+![sample output](sample_output.gif)
+#### Features:
+- only 170 lines of code;
+- no dependencies;
+- works on Linux and Windows;
+- if output to file and the script crashes in the middle — it is handled with at_exit and in the file, you will find partial output not an empty file.
+## Installation
+    gem install paralines
+or in your Gemfile
+    gem 'paralines'
+## Sample with all the features (output is on the gif animation)
+```ruby
+require 'paralines'
+puts '- start -'
+ParaLines.new do |plines|
+    odd_line = plines.add_shared_line 'Odd: '
+    even_line = plines.add_shared_line 'Even: '
+    done_order_line = plines.add_shared_line 'Done order: '
+    workers = (0..9).map do |n|
+        Thread.new do
+            if n == 0
+                # special case with sub-tasks in sub-threads
+                shared_line = plines.add_shared_line "Worker_#{n}: "
+                (1..3).map do |sn|
+                    Thread.new do
+                        sleep 0.01
+                        ticks_n = 5
+                        part = shared_line.part_open "[subtask#{sn}…#{' '*(ticks_n-1)}] "
+                        ticks_n.times do |n|
+                            sleep rand
+                            part.close '.' * (n+1)
+                        end
+                    end
+                end.each &:join
+                next
+            else
+                sleep n>5 ? 0.3 : 0.1  # make Worker_0 to be the first in the list
+            end
+            plines << "Worker_#{n}"
+            start = Time.now
+            n.odd? \
+                ? (odd_part = odd_line.part_open "#{n}… ")
+                : (even_part = even_line.part_open "[#{n} ")
+            2.times do
+                sleep rand
+                plines << '.'
+                fail if rand < 0.07 if !:with_fail_chanse   # remove ! here to test crashes
+            end
+            time = Time.now - start
+            plines << "done (in %.3fs)" % time
+            done_order_line << n
+            odd_part&.close '+'
+            even_part&.close ']'
+        end
+            .tap do
+                if n==5
+                    sleep 0.2
+                    plines.add_static_line '- 5 workers added'
+                elsif n==9
+                    sleep 0.4
+                    plines.add_static_line '- all workers added'
+                end
+            end
+    end.each &:join
+end
+puts '- ready -'
+```
+### Usage without a block
+```ruby
+require 'paralines'
+plines = ParaLines.new
+plines.add_static_line 'Gems latest versions'
+plines.add_empty_line
+gems = %w[sinatra rspec paralines rails hanami]
+plines.add_static_line '- Random order:'
+threads = gems.map do |name|
+    Thread.new do
+        plines << name.ljust(15, '.')
+        res = `gem list -r #{name} -e`
+        plines << 'v' + res[/\((.+)\)/, 1]
+    end
+end
+sleep 0.2
+plines.add_empty_line
+plines.add_static_line '- Sorted:'
+threads += gems.sort.map do |name|
+    sline = plines.add_shared_line name.ljust(15, '.')
+    Thread.new do
+        res = `gem list -r #{name} -e`
+        sline << 'v' + res[/\((.+)\)/, 1]
+    end
+end
+threads.each &:join
+```
+## Contributing
+Bug reports and pull requests are welcome on GitHub: https://github.com/Inversion-des/paralines
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/paralines.rb CHANGED Viewed

@@ -1,20 +1,10 @@
-# frozen_string_literal: true
+# *frozen_string_literal: true — should not be used here to ensure unique object_id for ''
 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:''} }
+		@line_by_key = Hash.new {|h, key| h[key] = {line:h.length, col:1, text:''.freeze} }
 		# *ensure flush at exit
 		if @f_to_file
@@ -41,7 +31,7 @@ class ParaLines
 	# plines.add_static_line '- 5 workers added'
 	def add_static_line(text)
 		key = text.object_id
-		C_mutex.synchronize do
+		MUTEX.synchronize do
 			d = @line_by_key[key]
 			if @f_to_console
 				puts text
@@ -51,6 +41,11 @@ class ParaLines
 		end
 	end
+	# plines.add_empty_line
+	def add_empty_line
+		add_static_line ''
+	end
 	# done_order_line = plines.add_shared_line 'Done order: '
 	# done_order_line << 'some text'
 	# part = shared_line.part_open "#{n}… " + later: part.close '+'
@@ -73,9 +68,9 @@ class ParaLines
 				d = line_by_key[key]
 				part_col = nil
-				C_mutex.synchronize do
+				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)
+					part_col = d[:col] + (text_.index('…'.freeze) || text_.index('_'.freeze) || text_.length-1)
 					rel.send :output, key, text_
 				end
@@ -84,13 +79,15 @@ class ParaLines
 				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
+						MUTEX.synchronize do
+							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
@@ -118,7 +115,7 @@ class ParaLines
 	private \
 	def output(key, text)
 		text = text.to_s
-		C_mutex.sync_if_needed do
+		MUTEX.sync_if_needed do
 			# add line
 			puts if @f_to_console && !@line_by_key.has_key?(key)
@@ -155,4 +152,16 @@ class ParaLines
 		OUT
 	end
+	MUTEX = Mutex.new
+	def MUTEX.sync_if_needed
+		if owned?
+			yield
+		else
+			synchronize do
+				yield
+			end
+		end
+	end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paralines
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yura Babak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,6 +31,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - lib/paralines.rb
 homepage: https://github.com/Inversion-des/paralines
 licenses:
@@ -44,14 +46,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: Nice output to console/file from concurrent threads.