tty-progressbar 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 940663302a6775a3d728f4f10d15baf71da3506de9f3d38c41afd1cb9e62c9fd
-  data.tar.gz: 60d9a661744ebf03811bb9c68a3254003c1f28882998fe21083b0226beab720e
+  metadata.gz: 3538f92c577a1c9890b5389aed821f5f1f6de04521b291c01640e5a22d1e8d50
+  data.tar.gz: 752d77e450c845506e9b66453c2b9e780ced9239e7cf279a8fef4e4454c60d31
 SHA512:
-  metadata.gz: 0f195b2df5a8c46be31ab2464a4b0413357e2a1ed89136a8e11ffc509b59e243a8a5719d1caa616f0e5b1e0608936ce271992e06ed2d7db4dbfb4a6aabf05396
-  data.tar.gz: 4223f51b08087157277d8bc660b06751962b2884401484e4962250e6031fa24c6fc524f21f90bb5709adc76f023eacf063ca652a792088292a44ef0c1af1a7ec
+  metadata.gz: ed90ceccfbddcecdda4e4fbbe0e56a732aa641949756c0de7c8e4accd4054293362991f9bea615fb1ca8e4665e670cda1242251608f3046b2e3eb013154c072d
+  data.tar.gz: 1d0913a024299a2b709d9bb892b68620cc19f527100f27577edc123b220e4b50f554d530afcc14a45e15a55f7aa7051f6751e9abdc4e1f6c45ce745de0100834

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log
 
+## [v0.16.0] - 2018-08-27
+
+### Added
+* Add strings-ansi dependency
+
+### Changed
+* Change tty-cursor dependency version
+
+### Fixed
+* Fix to handle ANSI codes in bar formatting to allow correct size calculation
+
 ## [v0.15.1] - 2018-07-19
 
 ### Fixed
@@ -184,6 +195,7 @@
 
 * Initial implementation and release
 
+[v0.16.0]: https://github.com/piotrmurach/tty-progressbar/compare/v0.15.1...v0.16.0
 [v0.15.1]: https://github.com/piotrmurach/tty-progressbar/compare/v0.15.0...v0.15.1
 [v0.15.0]: https://github.com/piotrmurach/tty-progressbar/compare/v0.14.0...v0.15.0
 [v0.14.0]: https://github.com/piotrmurach/tty-progressbar/compare/v0.13.0...v0.14.0

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+### Are you in the right place?
+* For issues or feature requests file a GitHub issue in this repository
+* For general questions or discussion post in [Gitter](https://gitter.im/piotrmurach/tty)
+
+### Describe the problem
+A brief description of the issue/feature.
+
+### Steps to reproduce the problem
+```
+Your code here to reproduce the issue
+```
+
+### Actual behaviour
+What happened? This could be a description, log output, error raised etc...
+
+### Expected behaviour
+What did you expect to happen?
+
+### Describe your environment
+
+* OS version:
+* Ruby version:
+* TTY::ProgressBar version:

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+### Describe the change
+What does this Pull Request do?
+
+### Why are we doing this?
+Any related context as to why is this is a desirable change.
+
+### Benefits
+How will the library improve?
+
+### Drawbacks
+Possible drawbacks applying this change.
+
+### Requirements
+Put an X between brackets on each line if you have done the item:
+[] Tests written & passing locally?
+[] Code style checked?
+[] Rebased with `master` branch?
+[] Documentaion updated?

data/README.md

@@ -1,3 +1,7 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+</div>
+
 # TTY::ProgressBar [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-progressbar.svg)][gem]

data/lib/tty/progressbar.rb

@@ -5,6 +5,7 @@ require 'forwardable'
 require 'monitor'
 require 'tty-cursor'
 require 'tty-screen'
+require 'strings-ansi'
 require 'unicode/display_width'
 
 require_relative 'progressbar/configuration'
@@ -58,7 +59,7 @@ module TTY
     #
     # @api public
     def self.display_columns(value)
-      Unicode::DisplayWidth.of(value)
+      Unicode::DisplayWidth.of(Strings::ANSI.sanitize(value))
     end
 
     # Create progress bar

data/lib/tty/progressbar/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module TTY
   class ProgressBar
-    VERSION = '0.15.1'.freeze
+    VERSION = '0.16.0'
   end # ProgressBar
 end # TTY

data/spec/unit/formatter/bar_spec.rb

@@ -13,4 +13,21 @@ RSpec.describe TTY::ProgressBar, ':bar token' do
       "\e[1G[=====]\n"
     ].join)
   end
+
+  it "animates colors correctly" do
+    red = "\e[31m \e[0m"
+    green = "\e[32m \e[0m"
+    progress = TTY::ProgressBar.new("[:bar]", total: 5, complete: green,
+                                    incomplete: red, output: output)
+
+    5.times { progress.advance }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[#{green}#{red}#{red}#{red}#{red}]",
+      "\e[1G[#{green}#{green}#{red}#{red}#{red}]",
+      "\e[1G[#{green}#{green}#{green}#{red}#{red}]",
+      "\e[1G[#{green}#{green}#{green}#{green}#{red}]",
+      "\e[1G[#{green}#{green}#{green}#{green}#{green}]\n",
+    ].join)
+  end
 end

data/tty-progressbar.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'tty-cursor', '~> 0.5.0'
+  spec.add_dependency 'strings-ansi', '~> 0.1.0'
+  spec.add_dependency 'tty-cursor', '~> 0.6.0'
   spec.add_dependency 'tty-screen', '~> 0.6.4'
   spec.add_dependency 'unicode-display_width', '~> 1.3'
 

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: tty-progressbar
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2018-08-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: strings-ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: tty-screen
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +142,9 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- ISSUE_TEMPLATE.md
 - LICENSE.txt
+- PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile
 - appveyor.yml