nanoc 4.6.3 → 4.6.4

data/spec/nanoc/telemetry/counter_spec.rb

@@ -0,0 +1,18 @@
+describe Nanoc::Telemetry::Counter do
+  subject(:counter) { described_class.new }
+
+  it 'starts at 0' do
+    expect(counter.value).to eq(0)
+  end
+
+  describe '#increment' do
+    subject { counter.increment }
+
+    it 'increments' do
+      expect { subject }
+        .to change { counter.value }
+        .from(0)
+        .to(1)
+    end
+  end
+end

data/spec/nanoc/telemetry/labelled_counter_spec.rb

@@ -0,0 +1,56 @@
+describe Nanoc::Telemetry::LabelledCounter do
+  subject(:counter) { described_class.new }
+
+  describe 'new counter' do
+    it 'starts at 0' do
+      expect(subject.value(filter: :erb)).to eq(0)
+      expect(subject.value(filter: :haml)).to eq(0)
+    end
+
+    it 'has no values' do
+      expect(subject.values).to eq({})
+    end
+  end
+
+  describe '#increment' do
+    subject { counter.increment(filter: :erb) }
+
+    it 'increments the matching value' do
+      expect { subject }
+        .to change { counter.value(filter: :erb) }
+        .from(0)
+        .to(1)
+    end
+
+    it 'does not increment any other value' do
+      expect(counter.value(filter: :haml)).to eq(0)
+      expect { subject }
+        .not_to change { counter.value(filter: :haml) }
+    end
+
+    it 'correctly changes #values' do
+      expect { subject }
+        .to change { counter.values }
+        .from({})
+        .to({ filter: :erb } => 1)
+    end
+  end
+
+  describe '#get' do
+    subject { counter.get(filter: :erb) }
+
+    context 'not incremented' do
+      its(:value) { is_expected.to eq(0) }
+    end
+
+    context 'incremented' do
+      before { counter.increment(filter: :erb) }
+      its(:value) { is_expected.to eq(1) }
+    end
+
+    context 'other incremented' do
+      before { counter.increment(filter: :haml) }
+      its(:value) { is_expected.to eq(0) }
+    end
+  end
+end

data/spec/nanoc/telemetry/labelled_summary_spec.rb

@@ -0,0 +1,63 @@
+describe Nanoc::Telemetry::LabelledSummary do
+  subject(:summary) { described_class.new }
+
+  describe '#labels' do
+    subject { summary.labels }
+
+    context 'empty summary' do
+      it { is_expected.to eq([]) }
+    end
+
+    context 'some observations' do
+      before do
+        summary.observe(7.2, filter: :erb)
+        summary.observe(5.3, filter: :erb)
+        summary.observe(3.0, filter: :haml)
+      end
+
+      it { is_expected.to eq([{ filter: :erb }, { filter: :haml }]) }
+    end
+  end
+
+  describe '#get' do
+    subject { summary.get(filter: :erb) }
+
+    context 'empty summary' do
+      its(:count) { is_expected.to eq(0) }
+    end
+
+    context 'one observation with that label' do
+      before { summary.observe(0.1, filter: :erb) }
+      its(:count) { is_expected.to eq(1) }
+    end
+
+    context 'one observation with a different label' do
+      before { summary.observe(0.1, filter: :haml) }
+      its(:count) { is_expected.to eq(0) }
+    end
+  end
+
+  describe '#quantile' do
+    before do
+      subject.observe(2.1, filter: :erb)
+      subject.observe(4.1, filter: :erb)
+      subject.observe(5.3, filter: :haml)
+    end
+
+    it 'has proper quantiles for :erb' do
+      expect(subject.quantile(0.00, filter: :erb)).to be_within(0.000001).of(2.1)
+      expect(subject.quantile(0.25, filter: :erb)).to be_within(0.000001).of(2.6)
+      expect(subject.quantile(0.50, filter: :erb)).to be_within(0.000001).of(3.1)
+      expect(subject.quantile(0.90, filter: :erb)).to be_within(0.000001).of(3.9)
+      expect(subject.quantile(0.99, filter: :erb)).to be_within(0.000001).of(4.08)
+    end
+
+    it 'has proper quantiles for :erb' do
+      expect(subject.quantile(0.00, filter: :haml)).to be_within(0.000001).of(5.3)
+      expect(subject.quantile(0.25, filter: :haml)).to be_within(0.000001).of(5.3)
+      expect(subject.quantile(0.50, filter: :haml)).to be_within(0.000001).of(5.3)
+      expect(subject.quantile(0.90, filter: :haml)).to be_within(0.000001).of(5.3)
+      expect(subject.quantile(0.99, filter: :haml)).to be_within(0.000001).of(5.3)
+    end
+  end
+end

data/spec/nanoc/telemetry/stopwatch_spec.rb

@@ -0,0 +1,59 @@
+describe Nanoc::Telemetry::Stopwatch do
+  subject(:stopwatch) { described_class.new }
+
+  it 'is zero by default' do
+    expect(stopwatch.duration).to eq(0.0)
+  end
+
+  # TODO: if running, raise error when asking for #duration
+
+  it 'records correct duration after start+stop' do
+    Timecop.freeze(Time.local(2008, 9, 1, 10, 5, 0))
+    stopwatch.start
+
+    Timecop.freeze(Time.local(2008, 9, 1, 10, 5, 1))
+    stopwatch.stop
+
+    expect(stopwatch.duration).to eq(1.0)
+  end
+
+  it 'records correct duration after start+stop+start+stop' do
+    Timecop.freeze(Time.local(2008, 9, 1, 10, 5, 0))
+    stopwatch.start
+
+    Timecop.freeze(Time.local(2008, 9, 1, 10, 5, 1))
+    stopwatch.stop
+
+    Timecop.freeze(Time.local(2008, 9, 1, 10, 5, 3))
+    stopwatch.start
+
+    Timecop.freeze(Time.local(2008, 9, 1, 10, 5, 6))
+    stopwatch.stop
+
+    expect(stopwatch.duration).to eq(1.0 + 3.0)
+  end
+
+  it 'errors when stopping when not started' do
+    expect { stopwatch.stop }.to raise_error(Nanoc::Telemetry::Stopwatch::NotRunningError)
+  end
+
+  it 'errors when starting when already started' do
+    stopwatch.start
+    expect { stopwatch.start }.to raise_error(Nanoc::Telemetry::Stopwatch::AlreadyRunningError)
+  end
+
+  it 'reports running status' do
+    expect(stopwatch).not_to be_running
+    expect(stopwatch).to be_stopped
+
+    stopwatch.start
+
+    expect(stopwatch).to be_running
+    expect(stopwatch).not_to be_stopped
+
+    stopwatch.stop
+
+    expect(stopwatch).not_to be_running
+    expect(stopwatch).to be_stopped
+  end
+end

data/spec/nanoc/telemetry/summary_spec.rb

@@ -0,0 +1,66 @@
+describe Nanoc::Telemetry::Summary do
+  subject(:summary) { described_class.new }
+
+  context 'no observations' do
+    it 'errors on #min' do
+      expect { subject.min }
+        .to raise_error(Nanoc::Telemetry::Summary::EmptySummaryError)
+    end
+
+    it 'errors on #max' do
+      expect { subject.max }
+        .to raise_error(Nanoc::Telemetry::Summary::EmptySummaryError)
+    end
+
+    it 'errors on #avg' do
+      expect { subject.avg }
+        .to raise_error(Nanoc::Telemetry::Summary::EmptySummaryError)
+    end
+
+    it 'errors on #sum' do
+      expect { subject.sum }
+        .to raise_error(Nanoc::Telemetry::Summary::EmptySummaryError)
+    end
+
+    its(:count) { is_expected.to eq(0) }
+  end
+
+  context 'one observation' do
+    before { subject.observe(2.1) }
+
+    its(:count) { is_expected.to eq(1) }
+    its(:sum) { is_expected.to eq(2.1) }
+    its(:avg) { is_expected.to eq(2.1) }
+    its(:min) { is_expected.to eq(2.1) }
+    its(:max) { is_expected.to eq(2.1) }
+
+    it 'has proper quantiles' do
+      expect(subject.quantile(0.00)).to eq(2.1)
+      expect(subject.quantile(0.25)).to eq(2.1)
+      expect(subject.quantile(0.50)).to eq(2.1)
+      expect(subject.quantile(0.90)).to eq(2.1)
+      expect(subject.quantile(0.99)).to eq(2.1)
+    end
+  end
+
+  context 'two observations' do
+    before do
+      subject.observe(2.1)
+      subject.observe(4.1)
+    end
+
+    its(:count) { is_expected.to be_within(0.000001).of(2) }
+    its(:sum) { is_expected.to be_within(0.000001).of(6.2) }
+    its(:avg) { is_expected.to be_within(0.000001).of(3.1) }
+    its(:min) { is_expected.to be_within(0.000001).of(2.1) }
+    its(:max) { is_expected.to be_within(0.000001).of(4.1) }
+
+    it 'has proper quantiles' do
+      expect(subject.quantile(0.00)).to be_within(0.000001).of(2.1)
+      expect(subject.quantile(0.25)).to be_within(0.000001).of(2.6)
+      expect(subject.quantile(0.50)).to be_within(0.000001).of(3.1)
+      expect(subject.quantile(0.90)).to be_within(0.000001).of(3.9)
+      expect(subject.quantile(0.99)).to be_within(0.000001).of(4.08)
+    end
+  end
+end

data/spec/nanoc/telemetry_spec.rb

@@ -0,0 +1,26 @@
+describe Nanoc::Telemetry do
+  subject { described_class.new }
+
+  example do
+    expect(subject.counter(:filters).values).to eq({})
+    expect(subject.counter(:filters).get(identifier: :erb).value).to eq(0)
+    expect(subject.counter(:filters).value(identifier: :erb)).to eq(0)
+
+    subject.counter(:filters).increment(identifier: :erb)
+    expect(subject.counter(:filters).values).to eq({ identifier: :erb } => 1)
+    expect(subject.counter(:filters).get(identifier: :erb).value).to eq(1)
+    expect(subject.counter(:filters).value(identifier: :erb)).to eq(1)
+  end
+
+  example do
+    subject.summary(:filters).observe(0.1, identifier: :erb)
+    expect(subject.summary(:filters).quantile(0.0, identifier: :erb)).to be_within(0.00001).of(0.1)
+    expect(subject.summary(:filters).quantile(0.5, identifier: :erb)).to be_within(0.00001).of(0.1)
+    expect(subject.summary(:filters).quantile(1.0, identifier: :erb)).to be_within(0.00001).of(0.1)
+
+    subject.summary(:filters).observe(1.1, identifier: :erb)
+    expect(subject.summary(:filters).quantile(0.0, identifier: :erb)).to be_within(0.00001).of(0.1)
+    expect(subject.summary(:filters).quantile(0.5, identifier: :erb)).to be_within(0.00001).of(0.6)
+    expect(subject.summary(:filters).quantile(1.0, identifier: :erb)).to be_within(0.00001).of(1.1)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc
 version: !ruby/object:Gem::Version
-  version: 4.6.3
+  version: 4.6.4
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
@@ -334,6 +334,13 @@ files:
 - lib/nanoc/rule_dsl/rules_collection.rb
 - lib/nanoc/rule_dsl/rules_loader.rb
 - lib/nanoc/spec.rb
+- lib/nanoc/telemetry.rb
+- lib/nanoc/telemetry/counter.rb
+- lib/nanoc/telemetry/labelled_counter.rb
+- lib/nanoc/telemetry/labelled_summary.rb
+- lib/nanoc/telemetry/registry.rb
+- lib/nanoc/telemetry/stopwatch.rb
+- lib/nanoc/telemetry/summary.rb
 - lib/nanoc/version.rb
 - nanoc.gemspec
 - spec/contributors_spec.rb
@@ -408,6 +415,7 @@ files:
 - spec/nanoc/cli/commands/show_plugins_spec.rb
 - spec/nanoc/cli/commands/show_rules_spec.rb
 - spec/nanoc/cli/commands/view_spec.rb
+- spec/nanoc/cli/stream_cleaners/utf8_spec.rb
 - spec/nanoc/data_sources/filesystem_spec.rb
 - spec/nanoc/deploying/fog_spec.rb
 - spec/nanoc/deploying/git_spec.rb
@@ -481,6 +489,13 @@ files:
 - spec/nanoc/rule_dsl/rule_context_spec.rb
 - spec/nanoc/rule_dsl/rule_memory_calculator_spec.rb
 - spec/nanoc/rule_dsl/rules_collection_spec.rb
+- spec/nanoc/spec_spec.rb
+- spec/nanoc/telemetry/counter_spec.rb
+- spec/nanoc/telemetry/labelled_counter_spec.rb
+- spec/nanoc/telemetry/labelled_summary_spec.rb
+- spec/nanoc/telemetry/stopwatch_spec.rb
+- spec/nanoc/telemetry/summary_spec.rb
+- spec/nanoc/telemetry_spec.rb
 - spec/regression_filenames_spec.rb
 - spec/spec_helper.rb
 - test/base/core_ext/array_spec.rb