tty-progressbar 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9e021f67756883c39075abe088ad0861ef85582
-  data.tar.gz: 08b1cd0a9925899b0a7c6ace9dddeef1a1545953
+  metadata.gz: c2470861861ae00abd4f276cede9731c712d2508
+  data.tar.gz: 38d29289ddfd613781defa037dc1181654ef7a3a
 SHA512:
-  metadata.gz: 7719a9ffa8814c51e301dd5e441a4516e87230ee7f66780ba40c3b29556bdd086f5dc18b6ee024b2b54b1344bb52996c51048837bafffcc560164c4b44165f0e
-  data.tar.gz: 98974cccbbad3174dcbf24dfd66957db87aca29f79ba94f4f287c6fff789251130a042c6e2ed8ae9831ea1be95380f433c3b14093a9ae01b282d4a4331f0ef97
+  metadata.gz: 1e2e6a01da4dcb082e8e55e1ecfc18841dd42a1cf1a2d622aa6d081d13f112a9f28fa4ef32cec33ffa68f50578a979eb3e4398f28145ac7204114a18a4145eaa
+  data.tar.gz: 5226faf2809e8939088d0d9ab4b91f391c687bc7e92149df9b13d0fbd6a7ea0a7a337863d9c1c54a59a6cbe92088605b0e915f6c7640d4b88d9e32b71fb6111a

data/.travis.yml

@@ -7,9 +7,10 @@ script: "bundle exec rake ci"
 rvm:
   - 2.0.0
   - 2.1.10
-  - 2.2.8
+  - 2.2.9
   - 2.3.6
-  - 2.4.3
+  - 2.4.4
+  - 2.5.1
   - ruby-head
   - jruby-9.1.5.0
   - jruby-head

data/CHANGELOG.md

@@ -1,6 +1,25 @@
 # Change log
 
-## [v0.14.0] - 2017-01-17
+## [v0.15.0] - 2018-06-24
+
+### Added
+* Add #format= for overriding formatting string
+* Add #display_columns for determining display width of multibyte characters
+* Add :inset option to bar configuration options
+* Add ability to configure width for multi bar with top level bar
+* Add unicode-display_width dependency
+
+### Changed
+* Change #update to only set configuration if actually present
+* Change bar formatter to handle multibyte characters
+
+### Fixed
+* Fix to stop reseting multibar state when registered bar reset by Eric Hodel(@drbrain)
+* Fix rendered bar to pad formatted output when it gets shorter by Eric Hodel(@drbrain)
+* Fix multi bar to advance in steps matching each bar advance progress
+* Fix multi bar rendering for widths exceeding screen columns count
+
+## [v0.14.0] - 2018-01-17
 
 ### Changed
 * Change to only output to a console and stop output to a file, pipe etc...
@@ -160,6 +179,7 @@
 
 * Initial implementation and release
 
+[v0.15.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.14.0...v0.15.0
 [v0.14.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.13.0...v0.14.0
 [v0.13.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.12.2...v0.13.0
 [v0.12.2]: https://github.com/peter-murach/tty-progressbar/compare/v0.12.1...v0.12.2

data/README.md

@@ -26,6 +26,7 @@
 * Includes many predefined tokens to calculate ETA, Bytes ... [tokens](#41-tokens)
 * Allows to define your [custom tokens](#42-custom-formatters)
 * Supports parallel multi progress bars [multi](#6-ttyprogressbarmulti-api)
+* Handles Unicode characters in progress bar [unicode](#44-unicode)
 * Works on all ECMA-48 compatible terminals
 
 ## Installation
@@ -70,6 +71,7 @@ Or install it yourself as:
   * [4.1 Tokens](#41-tokens)
   * [4.2 Custom Formatters](#42-custom-formatters)
   * [4.3 Custom Tokens](#43-custom-tokens)
+  * [4.4 Unicode](#44-unicode)
 * [5. Logging](#5-logging)
 * [6. TTY::ProgressBar::Multi API](#6-ttyprogressbarmulti-api)
   * [6.1 new](#61-new)
@@ -302,10 +304,10 @@ trap(:WINCH) { bar.resize }
 
 The progress bar fires events when it is progressing, stopped or finished. You can register to listen for events using the `on` message.
 
-Every time an `advance` is called the `:progress` event gets fired which you can listen for:
+Every time an `advance` is called the `:progress` event gets fired which you can listen for inside a block which includes the actual amount of progress as a first yielded argument:
 
 ```ruby
-bar.on(:progress) { ... }
+bar.on(:progress) { |amount| ... }
 ```
 
 When the progress bar finishes and completes then the `:done` event is fired. You can listen for this event:
@@ -474,6 +476,26 @@ which outputs:
 (4) Bye Piotr!
 ```
 
+### 4.4 Unicode
+
+The format string as well as `:complete`, `:head` and `:incompelte` configuration options can contain Unicode characters that aren't monospaced.
+
+For example, you can specify complete bar progression character to be Unicode non-monospaced:
+
+```ruby
+bar = TTY::ProgressBar.new("Unicode [:bar]", total: 30, complete: 'あ')
+#
+# => Unicode [あああああああああああああああ]
+```
+
+Similarly, the formatted string can include Unicode characters:
+
+```ruby
+bar = TTY::ProgressBar.new("あめかんむり[:bar]", total: 20)
+#
+# => あめかんむり[==    ]
+```
+
 ## 5. Logging
 
 If you want to print messages out to terminal along with the progress bar use the `log` method. The messages will appear above the progress bar and will continue scrolling up as more are logged out.

data/appveyor.yml

@@ -19,3 +19,5 @@ environment:
     - ruby_version: "23-x64"
     - ruby_version: "24"
     - ruby_version: "24-x64"
+    - ruby_version: "25"
+    - ruby_version: "25-x64"

data/examples/multi/width.rb

@@ -0,0 +1,13 @@
+require_relative '../../lib/tty-progressbar'
+
+bars = TTY::ProgressBar::Multi.new("main [:bar] :percent")
+
+bar1 = bars.register "foo [:bar] :percent", total: 150
+bar2 = bars.register "bar [:bar] :percent", total: 250
+bar3 = bars.register "baz [:bar] :percent", total: 100
+
+th1 = Thread.new { 15.times { sleep(0.1); bar1.advance(10) } }
+th2 = Thread.new { 50.times { sleep(0.1); bar2.advance(5)} }
+th3 = Thread.new { 50.times { sleep(0.1); bar3.advance(5) } }
+
+[th1, th2, th3].each(&:join)

data/examples/unicode.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/tty-progressbar'
+
+bar = TTY::ProgressBar.new("Unicode [:bar]", total: 30, complete: 'あ')
+30.times do
+  sleep(0.1)
+  bar.advance
+end

data/lib/tty/progressbar.rb

@@ -5,6 +5,7 @@ require 'forwardable'
 require 'monitor'
 require 'tty-cursor'
 require 'tty-screen'
+require 'unicode/display_width'
 
 require_relative 'progressbar/configuration'
 require_relative 'progressbar/formatter'
@@ -23,7 +24,7 @@ module TTY
 
     CURSOR_LOCK = Monitor.new
 
-    attr_reader :format
+    attr_accessor :format
 
     attr_reader :current
 
@@ -33,12 +34,33 @@ module TTY
 
     def_delegators :@configuration, :total, :width, :no_width,
                    :complete, :incomplete, :head, :hide_cursor, :clear,
-                   :output, :frequency, :interval, :width=
+                   :output, :frequency, :interval, :inset, :width=
 
     def_delegators :@meter, :rate, :mean_rate
 
     def_delegator :@formatter, :use
 
+    # Determine terminal width
+    #
+    # @return [Integer]
+    #
+    # @api public
+    def self.max_columns
+      TTY::Screen.width
+    end
+
+    # Determine the monospace display width of a string
+    #
+    # @param [String] value
+    #   the value to determine width of
+    #
+    # @return [Integer]
+    #
+    # @api public
+    def self.display_columns(value)
+      Unicode::DisplayWidth.of(value)
+    end
+
     # Create progress bar
     #
     # @param [String] format
@@ -80,6 +102,10 @@ module TTY
 
       @formatter.load
       reset
+
+      @first_render = true
+      @multibar     = nil
+      @row          = nil
     end
 
     # Reset progress to default configuration
@@ -96,9 +122,6 @@ module TTY
       @start_at          = Time.now
       @started           = false
       @tokens            = {}
-      @multibar          = nil
-      @row               = nil
-      @first_render      = true
 
       @meter.clear
     end
@@ -135,7 +158,7 @@ module TTY
       return if done?
 
       synchronize do
-        emit(:progress)
+        emit(:progress, progress)
         if progress.respond_to?(:to_hash)
           tokens, progress = progress, 1
         end
@@ -201,7 +224,9 @@ module TTY
     def update(options = {})
       synchronize do
         options.each do |name, val|
-          @configuration.public_send("#{name}=", val)
+          if @configuration.respond_to?("#{name}=")
+            @configuration.public_send("#{name}=", val)
+          end
         end
       end
     end
@@ -250,14 +275,22 @@ module TTY
         write(TTY::Cursor.hide)
       end
 
+      if @multibar
+        characters_in = @multibar.line_inset(self)
+        update(inset: self.class.display_columns(characters_in))
+      end
+
       formatted = @formatter.decorate(self, @format)
       @tokens.each do |token, val|
         formatted = formatted.gsub(":#{token}", val)
       end
-      write(formatted, true)
+
+      padded = padout(formatted)
+
+      write(padded, true)
 
       @last_render_time  = Time.now
-      @last_render_width = formatted.length
+      @last_render_width = self.class.display_columns(formatted)
     end
 
     # Move cursor to a row of the current bar if the bar is rendered
@@ -420,15 +453,6 @@ module TTY
       render
     end
 
-    # Determine terminal width
-    #
-    # @return [Integer]
-    #
-    # @api public
-    def max_columns
-      TTY::Screen.width
-    end
-
     # Show bar format
     #
     # @return [String]
@@ -461,8 +485,10 @@ module TTY
     #
     # @api private
     def padout(message)
-      if @last_render_width > message.length
-        remaining_width = @last_render_width - message.length
+      message_length = self.class.display_columns(message)
+
+      if @last_render_width > message_length
+        remaining_width = @last_render_width - message_length
         message += ' ' * remaining_width
       end
       message

data/lib/tty/progressbar/configuration.rb

@@ -5,6 +5,7 @@ module TTY
       attr_reader :total
 
       attr_accessor :width
+      #attr_reader :width
 
       attr_accessor :no_width
 
@@ -24,9 +25,11 @@ module TTY
 
       attr_accessor :interval
 
+      attr_accessor :inset
+
       def initialize(options)
         self.total   = options[:total] if options[:total]
-        @width       = options.fetch(:width) { total }
+        @width   = options.fetch(:width) { total }
         @no_width    = options.fetch(:no_width) { false }
         @incomplete  = options.fetch(:incomplete) { ' ' }
         @complete    = options.fetch(:complete) { '=' }
@@ -36,12 +39,23 @@ module TTY
         @output      = options.fetch(:output) { $stderr }
         @frequency   = options.fetch(:frequency) { 0 } # 0Hz
         @interval    = options.fetch(:interval) { 1 } # 1 sec
+        @inset       = options.fetch(:inset) { 0 }
       end
 
+      # def width=(value)
+      #   return if value.nil?
+
+      #   if value < ProgressBar.max_columns
+      #     @width = value
+      #   else
+      #     @width = ProgressBar.max_columns
+      #   end
+      # end
+
       def total=(value)
         fail ArgumentError unless value
         @total = value
-        @width = value unless width
+        self.width = value if width.nil?
       end
     end # Configuration
   end # ProgressBar

data/lib/tty/progressbar/formatter/bar.rb

@@ -30,12 +30,23 @@ module TTY
       #
       # @api public
       def format(value)
-        available_space = [0, @progress.max_columns - value.gsub(/:bar/, '').length].max
+        without_bar = value.gsub(/:bar/, '')
+        available_space = [0, ProgressBar.max_columns -
+                              ProgressBar.display_columns(without_bar) -
+                              @progress.inset].max
         width = [@progress.width, available_space].min
-        complete_length = (width * @progress.ratio).round
-        complete   = Array.new(complete_length, @progress.complete)
-        incomplete = Array.new(width - complete_length, @progress.incomplete)
-        complete[-1] = @progress.head if complete_length > 0
+        complete_bar_length    = (width * @progress.ratio).round
+        complete_char_length   = ProgressBar.display_columns(@progress.complete)
+        incomplete_char_length = ProgressBar.display_columns(@progress.incomplete)
+
+        # decimal number of items only when unicode chars are used
+        # otherwise it has no effect on regular ascii chars
+        complete_items   = (complete_bar_length / complete_char_length.to_f).round
+        incomplete_items = (width - complete_items * complete_char_length) / incomplete_char_length
+
+        complete   = Array.new(complete_items, @progress.complete)
+        incomplete = Array.new(incomplete_items, @progress.incomplete)
+        complete[-1] = @progress.head if complete_bar_length > 0
 
         bar = ''
         bar += complete.join

data/lib/tty/progressbar/multi.rb

@@ -18,6 +18,8 @@ module TTY
 
       def_delegators :@bars, :each, :empty?, :length, :[]
 
+      def_delegators :@top_bar, :width, :width=
+
       DEFAULT_INSET = {
         top:    Gem.win_platform? ? '+ '   : "\u250c ",
         middle: Gem.win_platform? ? '|-- ' : "\u251c\u2500\u2500 ",
@@ -51,6 +53,9 @@ module TTY
         @top_bar = nil
         @top_bar = register(format, observable: false) if format
 
+        @width = @options[:width]
+        @top_bar.update(width: @width) if @width
+
         @callbacks = {
           progress: [],
           stopped:  [],
@@ -73,7 +78,8 @@ module TTY
           @bars << bar
           observe(bar) if observable
           if @top_bar
-            @top_bar.update(total: total, width: total)
+            @top_bar.update(total: total)
+            @top_bar.update(width: total) unless @width
           end
         end
 
@@ -105,9 +111,9 @@ module TTY
       #
       # @api private
       def progress_handler
-        proc do
-          @top_bar.advance if @top_bar
-          emit(:progress)
+        -> (progress) do
+          @top_bar.advance(progress) if @top_bar
+          emit(:progress, progress)
         end
       end
 

data/lib/tty/progressbar/version.rb

@@ -1,5 +1,5 @@
 module TTY
   class ProgressBar
-    VERSION = '0.14.0'.freeze
+    VERSION = '0.15.0'.freeze
   end # ProgressBar
 end # TTY

data/spec/spec_helper.rb

@@ -17,6 +17,7 @@ require 'timecop'
 require 'tty-progressbar'
 
 class StringIO
+  undef_method :tty?
   def tty?
     true
   end

data/spec/unit/custom_token_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe TTY::ProgressBar, 'custom token' do
     output.rewind
     expect(output.read).to eq([
       "\e[1G(1) Hello Piotr!",
-      "\e[1G(4) Bye Piotr!\n"
+      "\e[1G(4) Bye Piotr!  \n"
     ].join)
   end
 end

data/spec/unit/multi/reset_spec.rb

@@ -0,0 +1,28 @@
+RSpec.describe TTY::ProgressBar::Multi, '#reset' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "leaves multibar state alone" do
+    main = TTY::ProgressBar::Multi.new("", output: output, total: 10)
+    progress = main.register("[:bar]")
+    progress.advance(10)
+    expect(progress.complete?).to be(true)
+    progress.reset
+    expect(progress.complete?).to be(false)
+    progress.advance(10)
+    output.rewind
+
+    top    = TTY::ProgressBar::Multi::DEFAULT_INSET[:top]
+    bottom = TTY::ProgressBar::Multi::DEFAULT_INSET[:bottom]
+
+    progress_updates =
+      output.read.scan(/#{Regexp.escape top}|#{Regexp.escape bottom}/)
+    expect(progress_updates.shift).to match(top)
+    expect(progress_updates.shift).to match(top)
+    expect(progress_updates.shift).to match(bottom)
+    expect(progress_updates.shift).to match(bottom)
+    expect(progress_updates.shift).to match(bottom)
+    expect(progress_updates.shift).to match(bottom)
+
+    expect(progress_updates).to be_empty
+  end
+end

data/spec/unit/multi/width_spec.rb

@@ -0,0 +1,118 @@
+RSpec.describe TTY::ProgressBar::Multi, 'width' do
+  let(:output) { StringIO.new('', 'w+') }
+  let(:save)    { TTY::Cursor.save }
+  let(:restore) { TTY::Cursor.restore }
+  let(:top) { TTY::ProgressBar::Multi::DEFAULT_INSET[:top] }
+  let(:middle) { TTY::ProgressBar::Multi::DEFAULT_INSET[:middle] }
+  let(:bottom) { TTY::ProgressBar::Multi::DEFAULT_INSET[:bottom] }
+
+  it "sets top level bar width to maximum columns when exceeds terminal width" do
+    allow(TTY::Screen).to receive(:width).and_return(15)
+
+    bars = TTY::ProgressBar::Multi.new("[:bar] main", output: output)
+
+    bar1 = bars.register("[:bar] one", total: 20)
+    bar2 = bars.register("[:bar] two", total: 20)
+
+    bar1.advance(10)
+    bar2.advance(10)
+
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G#{top}[==    ] main\n",
+      "\e[1G#{bottom}[===  ] one\n",
+      save,
+      "\e[2A",   # up 2 lines
+      "\e[1G#{top}[===   ] main",
+      restore,
+      "\e[1G#{bottom}[===  ] two\n"
+    ].join)
+
+    bar1.advance(10)
+
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G#{top}[==    ] main\n",
+      "\e[1G#{bottom}[===  ] one\n",
+      save,
+      "\e[2A",   # up 2 lines
+      "\e[1G#{top}[===   ] main",
+      restore,
+      "\e[1G#{bottom}[===  ] two\n",
+      save,
+      "\e[3A",   # up 3 lines
+      "\e[1G#{top}[===== ] main",
+      restore,
+      save,
+      "\e[2A",   # up 2 lines
+      "\e[1G#{middle}[=====] one",
+      restore,
+      save,
+      "\e[2A",   # up 2 lines
+      "#{middle}\n", # bar finished
+      restore
+    ].join)
+
+    bar2.advance(10)
+
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G#{top}[==    ] main\n",
+      "\e[1G#{bottom}[===  ] one\n",
+      save,
+      "\e[2A",   # up 2 lines
+      "\e[1G#{top}[===   ] main",
+      restore,
+      "\e[1G#{bottom}[===  ] two\n",
+      save,
+      "\e[3A",   # up 3 lines
+      "\e[1G#{top}[===== ] main",
+      restore,
+      save,
+      "\e[2A",   # up 2 lines
+      "\e[1G#{middle}[=====] one",
+      restore,
+      save,
+      "\e[2A",   # up 2 lines
+      "#{middle}\n", # bar finished
+      restore,
+      save,
+      "\e[3A",   # up 3 lines
+      "\e[1G#{top}[======] main",
+      restore,
+      save,
+      "\e[3A",  # up 1 line
+      "#{top}\n",
+      restore,
+      save,
+      "\e[1A",  # up 1 line
+      "\e[1G#{bottom}[=====] two",
+      restore,
+      save,
+      "\e[1A",  # up 1 line
+      "#{bottom}\n",
+      restore
+    ].join)
+  end
+
+  it "sets top level bar width to a custom value" do
+    bars = TTY::ProgressBar::Multi.new("[:bar] main", output: output, width: 20)
+
+    bar1 = bars.register("[:bar] one", total: 20)
+    bar2 = bars.register("[:bar] two", total: 20)
+
+    bar1.advance(10)
+    bar2.advance(10)
+
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G#{top}[=====               ] main\n",
+      "\e[1G#{bottom}[==========          ] one\n",
+      save,
+      "\e[2A",   # up 2 lines
+      "\e[1G#{top}[==========          ] main",
+      restore,
+      "\e[1G#{bottom}[==========          ] two\n"
+    ].join)
+  end
+end

data/spec/unit/new_spec.rb

@@ -7,6 +7,16 @@ RSpec.describe TTY::ProgressBar, '::new' do
     }.to raise_error(ArgumentError, /Expected bar formatting string, got `{:output=>#{output}}` instead\./)
   end
 
+  it "allows to change formatting string" do
+    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 4)
+    bar.advance(2)
+    bar.format = "(:bar)"
+    bar.advance(2)
+    output.rewind
+
+    expect(output.read).to eq("\e[1G[==  ]\e[1G(====)\n")
+  end
+
   it "displays output where width == total" do
     progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
     progress.advance

data/spec/unit/render_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe TTY::ProgressBar, "#render" do
+  let(:output) { StringIO.new("", "w+") }
+
+  it "pads out longer previous lines" do
+    progress = TTY::ProgressBar.new ":current_byte" do |config|
+      config.no_width = true
+      config.output   = output
+      config.total    = 1_048_577
+    end
+
+    progress.advance(1)
+    progress.advance(1_048_574)
+    progress.advance(1)
+    progress.advance(1)
+
+    output.rewind
+
+    expect(output.read).to eq([
+      "\e[1G1B",
+      "\e[1G1024.00KB", # must not pad, line is longer
+      "\e[1G1.00MB   ", # must pad out "0KB"
+      "\e[1G1.00MB",    # must not pad, line is equal
+    ].join)
+  end
+end

data/spec/unit/resize_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe TTY::ProgressBar, '#resize' do
       "\e[1G[==        ]",
       "\e[1G[====      ]",
       "\e[0m\e[2K\e[1G",
-      "\e[1G[===  ]",
+      "\e[1G[===  ]     ",
       "\e[1G[==== ]",
       "\e[1G[=====]\n"
     ].join)

data/spec/unit/width_spec.rb

@@ -8,8 +8,10 @@ RSpec.describe TTY::ProgressBar, '#width' do
       config.width = 1024
     end
     allow(TTY::Screen).to receive(:width).and_return(20)
+
     5.times { progress.advance }
     output.rewind
+
     expect(output.read).to eq([
       "\e[1G[====              ]",
       "\e[1G[=======           ]",
@@ -18,4 +20,67 @@ RSpec.describe TTY::ProgressBar, '#width' do
       "\e[1G[==================]\n"
     ].join)
   end
+
+  it "handles unicode characters width in formatting string" do
+    bar = TTY::ProgressBar.new("あめかんむり[:bar]", output: output, total: 20)
+    allow(TTY::Screen).to receive(:width).and_return(20)
+
+    4.times { bar.advance(5) }
+    output.rewind
+
+    expect(output.read).to eq([
+      "\e[1Gあめかんむり[==    ]",
+      "\e[1Gあめかんむり[===   ]",
+      "\e[1Gあめかんむり[===== ]",
+      "\e[1Gあめかんむり[======]\n"
+    ].join)
+  end
+
+  it "handles unicodes characters within bar" do
+    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 20,
+                                         complete: 'あ', incomplete: 'め')
+    allow(TTY::Screen).to receive(:width).and_return(20)
+
+    4.times { bar.advance(5) }
+    output.rewind
+
+    expect(output.read).to eq([
+      "\e[1G[あああめめめめめめ]",
+      "\e[1G[あああああめめめめ]",
+      "\e[1G[あああああああめめ]",
+      "\e[1G[あああああああああ]\n"
+    ].join)
+  end
+
+  it "handles unicodes characters within bar" do
+    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 20,
+                                         complete: 'あ', incomplete: ' ')
+    allow(TTY::Screen).to receive(:width).and_return(20)
+
+    4.times { bar.advance(5) }
+    output.rewind
+
+    expect(output.read).to eq([
+      "\e[1G[あああ            ]",
+      "\e[1G[あああああ        ]",
+      "\e[1G[あああああああ    ]",
+      "\e[1G[あああああああああ]\n"
+    ].join)
+  end
+
+  it "handles unicodes characters within bar" do
+    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 20,
+                                         complete: 'x', incomplete: 'め')
+    allow(TTY::Screen).to receive(:width).and_return(20)
+
+    4.times { bar.advance(5) }
+    output.rewind
+
+    expect(output.read).to eq([
+      "\e[1G[xxxxxめめめめめめ]",
+      "\e[1G[xxxxxxxxxめめめめ]",
+      "\e[1G[xxxxxxxxxxxxxxめめ]",
+      "\e[1G[xxxxxxxxxxxxxxxxxx]\n"
+    ].join)
+  end
 end

data/tty-progressbar.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency "tty-cursor", '~> 0.5.0'
-  spec.add_dependency "tty-screen", '~> 0.6.4'
+  spec.add_dependency 'tty-cursor', '~> 0.5.0'
+  spec.add_dependency 'tty-screen', '~> 0.6.4'
+  spec.add_dependency 'unicode-display_width', '~> 1.3'
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
   spec.add_development_dependency 'rspec', '~> 3.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-progressbar
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2018-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-cursor
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.4
+- !ruby/object:Gem::Dependency
+  name: unicode-display_width
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,11 +138,13 @@ files:
 - examples/lazy.rb
 - examples/multi/main_bar.rb
 - examples/multi/simple.rb
+- examples/multi/width.rb
 - examples/simple.rb
 - examples/slow_process.rb
 - examples/speed.rb
 - examples/threaded.rb
 - examples/tokens.rb
+- examples/unicode.rb
 - lib/tty-progressbar.rb
 - lib/tty/progressbar.rb
 - lib/tty/progressbar/configuration.rb
@@ -185,10 +201,13 @@ files:
 - spec/unit/multi/finish_spec.rb
 - spec/unit/multi/line_inset_spec.rb
 - spec/unit/multi/register_spec.rb
+- spec/unit/multi/reset_spec.rb
 - spec/unit/multi/stop_spec.rb
+- spec/unit/multi/width_spec.rb
 - spec/unit/new_spec.rb
 - spec/unit/pipeline_spec.rb
 - spec/unit/ratio_spec.rb
+- spec/unit/render_spec.rb
 - spec/unit/reset_spec.rb
 - spec/unit/resize_spec.rb
 - spec/unit/set_current_spec.rb
@@ -260,10 +279,13 @@ test_files:
 - spec/unit/multi/finish_spec.rb
 - spec/unit/multi/line_inset_spec.rb
 - spec/unit/multi/register_spec.rb
+- spec/unit/multi/reset_spec.rb
 - spec/unit/multi/stop_spec.rb
+- spec/unit/multi/width_spec.rb
 - spec/unit/new_spec.rb
 - spec/unit/pipeline_spec.rb
 - spec/unit/ratio_spec.rb
+- spec/unit/render_spec.rb
 - spec/unit/reset_spec.rb
 - spec/unit/resize_spec.rb
 - spec/unit/set_current_spec.rb