infobar 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b394ca03e7b4a64c6c3aaa730c05727fc33bb4c
-  data.tar.gz: f0d57d7647a4c43decf21a3b001a14fa46fa321b
+  metadata.gz: 259fca2fcc19735ccd0650f9ca07aebd363d2370
+  data.tar.gz: c92a5e348371aa5a241e8bdac2eb1b886e3abe79
 SHA512:
-  metadata.gz: 1b575a6725e49e44556b4866fb45985ca19790b51321d10cc5e0581df57f71ce8f55c7b4b598bd7dfd7f3d5cffd76558c5d5da46ac1d7d8cdfeff94644ff36a2
-  data.tar.gz: 1793197d1e8b73ae6a611824d946c634fcc3fb2abce3ccc422de02da00568009b5daec63b19088571f8a5202d3adc39af97a97e5898f1e8940dab1cf94f7ccb0
+  metadata.gz: 9ab2fa237f9279a5b0b99239a0afe64845193317d22588dbda3a5b4fbbcdeb887f2a84b5912cf4425b0e96d0bdfc35d4aa227cf6470a3b670d1a2182e89c0729
+  data.tar.gz: 2ff8ec4f87a375fcf508182ffd30544305aa6ba6eb1c2f06cbb33af3d790c84e8dc3ad93f7a59e77a9482f80e88d72be59d93a220db4f4588aaa627926aed910

data/README.md

@@ -21,6 +21,9 @@ Display progress of computations and additional information to the terminal.
 
 ## Changes
 
+* 2017-02-10 Release 0.0.2
+  - Add trend arrow to rate directive
+
 * 2017-02-08 Release 0.0.1
   - Allow disabling of delegated output via infobar.show = false
 

data/Rakefile

@@ -20,6 +20,7 @@ GemHadar do
   dependency 'tins',           '~> 1.0', '>= 1.13.2'
   dependency 'term-ansicolor', '~> 1.4'
   dependency 'complex_config', '~> 0.10'
+  dependency 'more_math'
   development_dependency 'rake'
   development_dependency 'simplecov'
   development_dependency 'rspec'

data/TODO.md

@@ -3,11 +3,11 @@
 - add color gradients?
 - cumulative counters to summarize several progress bars
 - categorize do progress and display accordingly
-- add trend arrow to rate
 - more documentation, lol
 
 ## DONE
 
+- add trend arrow to rate
 - units
 - configuration file?
 - add finished directive

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/infobar.gemspec

@@ -1,24 +1,24 @@
 # -*- encoding: utf-8 -*-
-# stub: infobar 0.0.1 ruby lib
+# stub: infobar 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "infobar".freeze
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2017-02-08"
+  s.date = "2017-02-10"
   s.description = "This gem displays progress of computations and additional information to the terminal.".freeze
   s.email = "flori@ping.de".freeze
-  s.extra_rdoc_files = ["README.md".freeze, "lib/infobar.rb".freeze, "lib/infobar/counter.rb".freeze, "lib/infobar/display.rb".freeze, "lib/infobar/duration.rb".freeze, "lib/infobar/fancy_interface.rb".freeze, "lib/infobar/frequency.rb".freeze, "lib/infobar/input_output.rb".freeze, "lib/infobar/message.rb".freeze, "lib/infobar/number.rb".freeze, "lib/infobar/spinner.rb".freeze, "lib/infobar/timer.rb".freeze, "lib/infobar/version.rb".freeze]
-  s.files = [".gitignore".freeze, ".rspec".freeze, ".utilsrc".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "TODO.md".freeze, "VERSION".freeze, "infobar.gemspec".freeze, "lib/infobar.rb".freeze, "lib/infobar/counter.rb".freeze, "lib/infobar/display.rb".freeze, "lib/infobar/duration.rb".freeze, "lib/infobar/fancy_interface.rb".freeze, "lib/infobar/frequency.rb".freeze, "lib/infobar/input_output.rb".freeze, "lib/infobar/message.rb".freeze, "lib/infobar/number.rb".freeze, "lib/infobar/spinner.rb".freeze, "lib/infobar/timer.rb".freeze, "lib/infobar/version.rb".freeze, "spec/config/infobar.yml".freeze, "spec/infobar/config_spec.rb".freeze, "spec/infobar/counter_spec.rb".freeze, "spec/infobar/display_spec.rb".freeze, "spec/infobar/duration_spec.rb".freeze, "spec/infobar/frequency_spec.rb".freeze, "spec/infobar/input_output_spec.rb".freeze, "spec/infobar/message_spec.rb".freeze, "spec/infobar/number_spec.rb".freeze, "spec/infobar/spinner_spec.rb".freeze, "spec/infobar/timer_spec.rb".freeze, "spec/infobar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/infobar.rb".freeze, "lib/infobar/counter.rb".freeze, "lib/infobar/display.rb".freeze, "lib/infobar/duration.rb".freeze, "lib/infobar/fancy_interface.rb".freeze, "lib/infobar/fifo.rb".freeze, "lib/infobar/frequency.rb".freeze, "lib/infobar/input_output.rb".freeze, "lib/infobar/message.rb".freeze, "lib/infobar/number.rb".freeze, "lib/infobar/rate.rb".freeze, "lib/infobar/spinner.rb".freeze, "lib/infobar/timer.rb".freeze, "lib/infobar/trend.rb".freeze, "lib/infobar/version.rb".freeze]
+  s.files = [".gitignore".freeze, ".rspec".freeze, ".utilsrc".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "TODO.md".freeze, "VERSION".freeze, "infobar.gemspec".freeze, "lib/infobar.rb".freeze, "lib/infobar/counter.rb".freeze, "lib/infobar/display.rb".freeze, "lib/infobar/duration.rb".freeze, "lib/infobar/fancy_interface.rb".freeze, "lib/infobar/fifo.rb".freeze, "lib/infobar/frequency.rb".freeze, "lib/infobar/input_output.rb".freeze, "lib/infobar/message.rb".freeze, "lib/infobar/number.rb".freeze, "lib/infobar/rate.rb".freeze, "lib/infobar/spinner.rb".freeze, "lib/infobar/timer.rb".freeze, "lib/infobar/trend.rb".freeze, "lib/infobar/version.rb".freeze, "spec/config/infobar.yml".freeze, "spec/infobar/config_spec.rb".freeze, "spec/infobar/counter_spec.rb".freeze, "spec/infobar/display_spec.rb".freeze, "spec/infobar/duration_spec.rb".freeze, "spec/infobar/fifo_spec.rb".freeze, "spec/infobar/frequency_spec.rb".freeze, "spec/infobar/input_output_spec.rb".freeze, "spec/infobar/message_spec.rb".freeze, "spec/infobar/number_spec.rb".freeze, "spec/infobar/rate_spec.rb".freeze, "spec/infobar/spinner_spec.rb".freeze, "spec/infobar/timer_spec.rb".freeze, "spec/infobar/trend_spec.rb".freeze, "spec/infobar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
   s.homepage = "http://flori.github.com/infobar".freeze
   s.rdoc_options = ["--title".freeze, "Infobar".freeze, "--main".freeze, "README.md".freeze]
   s.required_ruby_version = Gem::Requirement.new(">= 2.3".freeze)
   s.rubygems_version = "2.6.8".freeze
   s.summary = "Gem to display information about computations.".freeze
-  s.test_files = ["spec/infobar/config_spec.rb".freeze, "spec/infobar/counter_spec.rb".freeze, "spec/infobar/display_spec.rb".freeze, "spec/infobar/duration_spec.rb".freeze, "spec/infobar/frequency_spec.rb".freeze, "spec/infobar/input_output_spec.rb".freeze, "spec/infobar/message_spec.rb".freeze, "spec/infobar/number_spec.rb".freeze, "spec/infobar/spinner_spec.rb".freeze, "spec/infobar/timer_spec.rb".freeze, "spec/infobar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.test_files = ["spec/infobar/config_spec.rb".freeze, "spec/infobar/counter_spec.rb".freeze, "spec/infobar/display_spec.rb".freeze, "spec/infobar/duration_spec.rb".freeze, "spec/infobar/fifo_spec.rb".freeze, "spec/infobar/frequency_spec.rb".freeze, "spec/infobar/input_output_spec.rb".freeze, "spec/infobar/message_spec.rb".freeze, "spec/infobar/number_spec.rb".freeze, "spec/infobar/rate_spec.rb".freeze, "spec/infobar/spinner_spec.rb".freeze, "spec/infobar/timer_spec.rb".freeze, "spec/infobar/trend_spec.rb".freeze, "spec/infobar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<tins>.freeze, [">= 1.13.2", "~> 1.0"])
       s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.4"])
       s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.10"])
+      s.add_runtime_dependency(%q<more_math>.freeze, [">= 0"])
     else
       s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
       s.add_dependency(%q<rake>.freeze, [">= 0"])
@@ -39,6 +40,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<tins>.freeze, [">= 1.13.2", "~> 1.0"])
       s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.4"])
       s.add_dependency(%q<complex_config>.freeze, ["~> 0.10"])
+      s.add_dependency(%q<more_math>.freeze, [">= 0"])
     end
   else
     s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
@@ -48,5 +50,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<tins>.freeze, [">= 1.13.2", "~> 1.0"])
     s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.4"])
     s.add_dependency(%q<complex_config>.freeze, ["~> 0.10"])
+    s.add_dependency(%q<more_math>.freeze, [">= 0"])
   end
 end

data/lib/infobar.rb

@@ -1,5 +1,6 @@
 require 'tins/xt'
 require 'complex_config'
+require 'more_math'
 
 class Infobar
 end

data/lib/infobar/counter.rb

@@ -1,7 +1,7 @@
 require 'infobar/timer'
 
 class Infobar::Counter
-  class <<
+  class << self
     prepend Tins::Delegate
   end
 
@@ -23,6 +23,8 @@ class Infobar::Counter
 
   delegate :rate, to: :@timer
 
+  delegate :fifo, to: :@timer, as: :fifo_rate
+
   delegate :average_time, to: :@timer
 
   def started?

data/lib/infobar/fifo.rb

@@ -0,0 +1,40 @@
+class Infobar::FIFO
+  include Enumerable
+
+  def initialize(n)
+    @n = n
+    clear
+  end
+
+  def max_size
+    @n
+  end
+
+  def <<(value)
+    @i += 1
+    if @i > @n
+      @values.shift
+      @i -= 1
+    end
+    @values.push(value)
+    self
+  end
+
+  def each(&block)
+    @values.each(&block)
+    self
+  end
+
+  def empty?
+    @i.zero?
+  end
+
+  alias size count
+
+  def clear
+    @i = 0
+    @values = []
+    self
+  end
+end
+

data/lib/infobar/message.rb

@@ -1,6 +1,7 @@
 require 'infobar/spinner'
 require 'infobar/duration'
 require 'infobar/number'
+require 'infobar/rate'
 
 class Infobar::Message
   class << self
@@ -88,12 +89,8 @@ class Infobar::Message
   end
 
   # rate with or without units
-  register('%r', unit: nil, prefix: 1000, format: '%f %U') do |directive, opts|
-    if opts[:unit]
-      Tins::Unit.format(Infobar.counter.rate, **opts)
-    else
-      Infobar.counter.rate
-    end
+  register('%r', unit: nil, prefix: 1000, format: '%.3f%U%t') do |directive, opts|
+    Infobar::Rate.new(Infobar.counter.rate, Infobar.counter.fifo_rate, **opts)
   end
 
   # average time as a duration

data/lib/infobar/rate.rb

@@ -0,0 +1,28 @@
+require 'infobar/trend'
+
+class Infobar::Rate
+  def initialize(value, fifo_values = [], **opts)
+    opts[:format] = add_trend(opts[:format], fifo_values)
+    @string =
+      if opts[:format].include?('%U')
+        Tins::Unit.format(value, **opts)
+      else
+        opts[:format] % value
+      end
+  end
+
+  def to_s
+    @string
+  end
+
+  private
+
+  def add_trend(format, fifo_values)
+    if fifo_values.empty?
+      format.gsub('%t', ?⤿)
+    else
+      trend = Infobar::Trend.new(fifo_values)
+      format.gsub('%t', trend.to_s)
+    end
+  end
+end

data/lib/infobar/timer.rb

@@ -1,13 +1,18 @@
+require 'infobar/fifo'
+
 class Infobar::Timer
   def initialize
     @n    = 0
     @x    = 0.0
+    @fifo = Infobar::FIFO.new(30)
   end
 
   attr_reader :x
 
   attr_reader :n
 
+  attr_reader :fifo
+
   def add(time, count)
     case @n
     when 0
@@ -42,6 +47,7 @@ class Infobar::Timer
   def <<(x)
     @n +=1
     @x += (x - @x) / @n
+    @fifo << rate
     self
   end
 end

data/lib/infobar/trend.rb

@@ -0,0 +1,25 @@
+class Infobar::Trend
+  def initialize(values, symbols: %i[ ↘ → ↗ ])
+    @values  = values
+    @symbols = symbols
+    @string  = arrow
+  end
+
+  def to_s
+    @string
+  end
+
+  private
+
+  def arrow
+    lr = MoreMath::LinearRegression.new(@values)
+    case
+    when lr.slope_zero?
+      @symbols[1]
+    when lr.a > 0
+      @symbols[2]
+    else
+      @symbols[0]
+    end.to_s
+  end
+end

data/lib/infobar/version.rb

@@ -1,6 +1,6 @@
 class Infobar
   # Infobar version
-  VERSION         = '0.0.1'
+  VERSION         = '0.0.2'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/spec/infobar/fifo_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Infobar::FIFO do
+  let :fifo do
+    described_class.new(3)
+  end
+
+  it 'has max_size' do
+    expect(fifo.max_size).to eq 3
+  end
+
+  it 'has size' do
+    expect(fifo.size).to eq 0
+    fifo << 1
+    expect(fifo.size).to eq 1
+  end
+
+  it 'has size <= max_size' do
+    fifo << 1 << 2 << 3 << 4
+    expect(fifo.size).to eq 3
+  end
+
+  it 'can be added to' do
+    fifo << 1 << 2
+    expect(fifo.to_a).to eq [ 1, 2 ]
+  end
+
+  it 'can be empty' do
+    expect(fifo).to be_empty
+  end
+
+  it 'can be non-empty' do
+    fifo << 1
+    expect(fifo).not_to be_empty
+  end
+
+  it 'can be cleared' do
+    fifo << 1
+    expect(fifo).not_to be_empty
+    expect(fifo.clear).to be_empty
+  end
+end

data/spec/infobar/message_spec.rb

@@ -33,7 +33,7 @@ describe Infobar::Message do
   it 'can be interpolated' do
     Time.dummy(now) do
       expect(message.to_str).to eq(
-        "23 42 19 Test 0.55 0.452 54.76 45.24 00:00:02 00:00:21 00:00:19 11:11:30 1.0 00:01.000000 – %"
+        "23 42 19 Test 0.55 0.452 54.76 45.24 00:00:02 00:00:21 00:00:19 11:11:30 1.000→ 00:01.000000 – %"
       )
     end
   end
@@ -57,6 +57,14 @@ describe Infobar::Message do
     end
   end
 
+  it 'can display eta in native format' do
+    Time.dummy(now) do
+      message =
+        described_class.new(format: 'test %E', '%E' => { format: nil }).to_str
+      expect(message).to eq "test #{now + 19}"
+    end
+  end
+
   it 'can be converted into a format string' do
     expect(message.to_s).to eq format
   end

data/spec/infobar/rate_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Infobar::Rate do
+  context 'with trend' do
+    let :rate do
+      described_class.new(23.45, (1..10).to_a, format: '%.2f%t')
+    end
+
+    it 'can be displayed' do
+      expect(rate.to_s).to eq '23.45↗'
+    end
+  end
+end

data/spec/infobar/trend_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Infobar::Trend do
+  let :trend do
+    described_class.new(values)
+  end
+
+  context 'downwards' do
+    let :values do
+      (1..10).to_a.reverse
+    end
+
+    it 'can be a string' do
+      expect(trend.to_s).to eq ?↘
+    end
+  end
+
+  context 'sideways' do
+    let :values do
+      [ Math::PI ] * 10
+    end
+
+    it 'can be a string' do
+      expect(trend.to_s).to eq ?→
+    end
+  end
+
+  context 'upwards' do
+    let :values do
+      (1..10).to_a
+    end
+
+    it 'can be a string' do
+      expect(trend.to_s).to eq ?↗
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infobar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Florian Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -114,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: more_math
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem displays progress of computations and additional information
   to the terminal.
 email: flori@ping.de
@@ -126,12 +140,15 @@ extra_rdoc_files:
 - lib/infobar/display.rb
 - lib/infobar/duration.rb
 - lib/infobar/fancy_interface.rb
+- lib/infobar/fifo.rb
 - lib/infobar/frequency.rb
 - lib/infobar/input_output.rb
 - lib/infobar/message.rb
 - lib/infobar/number.rb
+- lib/infobar/rate.rb
 - lib/infobar/spinner.rb
 - lib/infobar/timer.rb
+- lib/infobar/trend.rb
 - lib/infobar/version.rb
 files:
 - ".gitignore"
@@ -148,24 +165,30 @@ files:
 - lib/infobar/display.rb
 - lib/infobar/duration.rb
 - lib/infobar/fancy_interface.rb
+- lib/infobar/fifo.rb
 - lib/infobar/frequency.rb
 - lib/infobar/input_output.rb
 - lib/infobar/message.rb
 - lib/infobar/number.rb
+- lib/infobar/rate.rb
 - lib/infobar/spinner.rb
 - lib/infobar/timer.rb
+- lib/infobar/trend.rb
 - lib/infobar/version.rb
 - spec/config/infobar.yml
 - spec/infobar/config_spec.rb
 - spec/infobar/counter_spec.rb
 - spec/infobar/display_spec.rb
 - spec/infobar/duration_spec.rb
+- spec/infobar/fifo_spec.rb
 - spec/infobar/frequency_spec.rb
 - spec/infobar/input_output_spec.rb
 - spec/infobar/message_spec.rb
 - spec/infobar/number_spec.rb
+- spec/infobar/rate_spec.rb
 - spec/infobar/spinner_spec.rb
 - spec/infobar/timer_spec.rb
+- spec/infobar/trend_spec.rb
 - spec/infobar_spec.rb
 - spec/spec_helper.rb
 homepage: http://flori.github.com/infobar
@@ -200,11 +223,14 @@ test_files:
 - spec/infobar/counter_spec.rb
 - spec/infobar/display_spec.rb
 - spec/infobar/duration_spec.rb
+- spec/infobar/fifo_spec.rb
 - spec/infobar/frequency_spec.rb
 - spec/infobar/input_output_spec.rb
 - spec/infobar/message_spec.rb
 - spec/infobar/number_spec.rb
+- spec/infobar/rate_spec.rb
 - spec/infobar/spinner_spec.rb
 - spec/infobar/timer_spec.rb
+- spec/infobar/trend_spec.rb
 - spec/infobar_spec.rb
 - spec/spec_helper.rb