more_math 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2945331f84849efc01cafcdd9dec0e1402a6296c979d6b6d5ecb41ff49427a2
-  data.tar.gz: 2e25d9b28a5c326eb50d7ca12ef66d0562f8e5839a8f9c37a9db504fc13c286c
+  metadata.gz: 72c52f7fecd9e87621f806bf86d7063f7aae2aef24e539d1d20182d5513bbd8f
+  data.tar.gz: 84a63a576ca178c7cefc591ba8373260259dfed4a83ec1c536817afce466c2b7
 SHA512:
-  metadata.gz: 11a42069a9e921c857849cceb0f912a3989a4bf046645be765c8acb54f9bea299ced8790be585fd04367531e6484847866cde89486c7aa6943fb396d80bfcf31
-  data.tar.gz: ee3e2b0ba782557eb94770833b0e98494254ce1a138caf493e72d208b54f56bb62645bd0779e71c84b32b949df2b8de3f4424c2c107b3c609a7bd5901a2cd471
+  metadata.gz: 56ba92f6abcdc5b305f8069ce562418d799b9eeeab777e7b47b1c9b69a9cb1a61c69403750da8ecc59bb1d69a11b8ddca3fa40b18031e63d401550b2690acf67
+  data.tar.gz: 0cf1a0cab01791ff617910f4840ba58f1b14257b3bc611ece8085880ee1164abf20d2c8f3394108052c51a4ef00868d6d0b613146565dcd71ebbec2b08edca07

data/CHANGES.md

@@ -1,5 +1,22 @@
 # Changes
 
+## 2024-09-30 v1.3.0
+
+* **Added support for displaying histograms based on percentage of terminal width**
+	+ Added `terminal_width` method to `Histogram` class
+	+ Updated `display` method to take interpret the `width` parameter as a percentage string, e.g. `75%`
+	+ Updated test cases to use the new `display` method with different widths
+	+ Added a new test case for displaying histograms with counts and `75%` width
+
+## 2024-09-30 v1.2.2
+
+### Improvements
+* Refactor Histogram display logic for better UTF-8 support:
+	+ Extracted `output_row_with_count` and `output_row_without_count` methods
+	+ Updated test cases for histogram display with counts and UTF-8 support
+* Update Rakefile to ignore `.utilsrc` file:
+	- Add `.utilsrc` to `package_ignore` list in Rakefile
+
 ## 2024-09-30 v1.2.1
 
 * Refactor histogram display logic for utf8 and ascii bars

data/Rakefile

@@ -14,7 +14,7 @@ GemHadar do
     '.AppleDouble', 'tags', '.byebug_history', '.DS_Store'
   readme      'README.md'
   title       "#{name.camelize} -- More Math in Ruby"
-  package_ignore '.all_images.yml', '.gitignore', 'VERSION',
+  package_ignore '.all_images.yml', '.gitignore', 'VERSION', '.utilsrc',
     *Dir.glob('.github/**/*', File::FNM_DOTMATCH)
 
   required_ruby_version '>= 2.0'

data/lib/more_math/histogram.rb

@@ -1,3 +1,5 @@
+require 'tins'
+
 module MoreMath
   # A histogram gives an overview of a sequence's elements.
   class Histogram
@@ -35,8 +37,12 @@ module MoreMath
 
     # Display this histogram to +output+, +width+ is the parameter for
     # +prepare_display+
-    def display(output = $stdout, width = 50)
-      width >= 1 or raise ArgumentError, "width needs to be >= 1"
+    def display(output = $stdout, width = 65)
+      if width.is_a?(String) && width =~ /(.+)%\z/
+        percentage = Float($1).clamp(0, 100)
+        width = (terminal_width * (percentage / 100.0)).floor
+      end
+      width > 15 or raise ArgumentError, "width needs to be >= 15"
       for r in rows
         output << output_row(r, width)
       end
@@ -44,6 +50,10 @@ module MoreMath
       self
     end
 
+    def terminal_width
+      Tins::Terminal.columns
+    end
+
     def max_count
       counts.max
     end
@@ -62,7 +72,7 @@ module MoreMath
     end
 
     def ascii_bar(bar_width)
-      bar = ?* * bar_width
+      ?* * bar_width
     end
 
     def utf8?
@@ -72,29 +82,35 @@ module MoreMath
     def output_row(row, width)
       left, right, count = row
       if @with_counts
-        c = utf8? ? 2 : 1
-        left_width = width - (counts.map { |x| x.to_s.size }.max + c)
+        output_row_with_count(left, right, count, width)
       else
-        left_width = width
+        output_row_without_count(left, right, count, width)
       end
+    end
+
+    def output_row_with_count(left, right, count, width)
+      width -= 15
+      c = utf8? ? 2 : 1
+      left_width = width - (counts.map { |x| x.to_s.size }.max + c)
       if left_width < 0
         left_width = width
       end
       factor    = left_width.to_f / max_count
       bar_width = (count * factor)
       bar = utf8? ? utf8_bar(bar_width) : ascii_bar(bar_width)
-      if @with_counts
-        if utf8?
-          if bar[-1] == ' '
-            bar += count.to_s.rjust(width - bar_width - 1)
-          else
-            bar += count.to_s.rjust(width - bar_width)
-          end
-        else
-          bar += count.to_s.rjust(width - bar_width)
-        end
-      end
-      "%11.5f -|%s\n" % [ (left + right) / 2.0, bar ]
+      max_count_length = max_count.to_s.size
+      "%11.5f -|%#{-width + max_count_length}s%#{max_count_length}s\n" %
+        [ (left + right) / 2.0, bar, count ]
+    end
+
+    def output_row_without_count(left, right, count, width)
+      width -= 15
+      left_width = width
+      left_width < 0 and left_width = width
+      factor    = left_width.to_f / max_count
+      bar_width = (count * factor)
+      bar = utf8? ? utf8_bar(bar_width) : ascii_bar(bar_width)
+      "%11.5f -|%#{-width}s\n" % [ (left + right) / 2.0, bar ]
     end
 
     def rows

data/lib/more_math/version.rb

@@ -1,6 +1,6 @@
 module MoreMath
   # MoreMath version
-  VERSION         = '1.2.1'
+  VERSION         = '1.3.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/more_math.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: more_math 1.2.1 ruby lib
+# stub: more_math 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "more_math".freeze
-  s.version = "1.2.1".freeze
+  s.version = "1.3.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

data/tests/histogram_test.rb

@@ -23,9 +23,9 @@ class HistogramTest < Test::Unit::TestCase
     assert_equal [[2.0, 3.0, 1], [1.0, 2.0, 2], [0.0, 1.0, 2]],
       histogram.instance_eval { rows }
     output = StringIO.new
-    histogram.display output
+    histogram.display output, 65
     assert_equal <<~end, output.string
-        2.50000 -|*************************
+        2.50000 -|*************************                         
         1.50000 -|**************************************************
         0.50000 -|**************************************************
     max_count=2
@@ -41,7 +41,7 @@ class HistogramTest < Test::Unit::TestCase
     assert_equal [[2.0, 3.0, 1], [1.0, 2.0, 2], [0.0, 1.0, 2]],
       histogram.instance_eval { rows }
     output = StringIO.new
-    histogram.display output
+    histogram.display output, 65
     assert_equal <<~end, output.string
         2.50000 -|************************                         1
         1.50000 -|************************************************ 2
@@ -50,6 +50,23 @@ class HistogramTest < Test::Unit::TestCase
     end
   end
 
+  def test_histogram_display_with_counts_lots
+    srand 1337
+    sequence = Sequence.new 1000.times.map { rand(10) * rand(10) }
+    histogram = Histogram.new sequence, with_counts: true, bins: 3
+    def histogram.utf8?
+      false
+    end
+    output = StringIO.new
+    histogram.display output, 65
+    assert_equal <<~end, output.string
+       67.50000 -|*****                                           81
+       40.50000 -|*************                                  206
+       13.50000 -|********************************************** 713
+    max_count=713
+    end
+  end
+
   def test_histogram_display_utf8
     srand 1337
     sequence = Sequence.new 1000.times.map { rand(10) }
@@ -58,10 +75,10 @@ class HistogramTest < Test::Unit::TestCase
       true
     end
     output = StringIO.new
-    histogram.display output
+    histogram.display output, 65
     assert_equal <<~end, output.string
-        7.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿ 
-        4.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡇
+        7.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿               
+        4.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡇                
         1.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿ 
     max_count=420
     end
@@ -75,7 +92,7 @@ class HistogramTest < Test::Unit::TestCase
       true
     end
     output = StringIO.new
-    histogram.display output
+    histogram.display output, 65
     assert_equal <<~end, output.string
         7.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡇               295
         4.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡇                285
@@ -83,4 +100,49 @@ class HistogramTest < Test::Unit::TestCase
     max_count=420
     end
   end
+
+  def test_histogram_display_with_counts_utf8_product
+    srand 1337
+    sequence = Sequence.new 1000.times.map { rand(10) * rand(10) }
+    histogram = Histogram.new sequence, with_counts: true, bins: 3
+    def histogram.utf8?
+      true
+    end
+    output = StringIO.new
+    histogram.display output, 65
+    assert_equal <<~end, output.string
+       67.50000 -|⣿⣿⣿⣿⣿                                           81
+       40.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿                                  206
+       13.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿  713
+    max_count=713
+    end
+  end
+
+  def test_histogram_display_with_counts_utf8_product_width_75_percent
+    srand 1337
+    sequence = Sequence.new 1000.times.map { rand(10) * rand(10) }
+    histogram = Histogram.new sequence, with_counts: true, bins: 3
+    def histogram.utf8?
+      true
+    end
+    def histogram.terminal_width
+      80
+    end
+    output = StringIO.new
+    histogram.display output, '90%'
+    assert_equal <<~end, output.string
+       67.50000 -|⣿⣿⣿⣿⣿⡇                                                 81
+       40.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿                                       206
+       13.50000 -|⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿  713
+    max_count=713
+    end
+  end
+
+  private
+
+  def output_histogram(histogram, width = 65)
+    $stdout.puts
+    histogram.display $stdout, width
+    $stdout.puts
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: more_math
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Florian Frank