leafy 0.0.3 → 0.1.0

data/spec/histogram_spec.rb

@@ -0,0 +1,20 @@
+require 'leafy/core/histogram'
+
+RSpec.describe Leafy::Core::Histogram do
+
+  let(:reservoir) do
+    reservoir = double('Reservoir')
+    allow(reservoir).to receive(:update).with(100)
+    reservoir
+  end
+
+  let(:histogram) {  Leafy::Core::Histogram.new(reservoir) }
+
+  it 'updatesTheCountOnUpdates' do
+    expect(histogram.count).to eq 0
+
+    histogram.update(100);
+
+    expect(histogram.count).to eq 1
+  end
+end

data/spec/meter_spec.rb

@@ -0,0 +1,40 @@
+require 'leafy/core/meter'
+
+RSpec.describe Leafy::Core::Meter do
+
+  let(:clock) do
+    clock = Leafy::Core::Clock.new
+    def clock.tick      
+      @ticks ||= [0, 0] + [10000000000] * 10
+      @ticks.shift
+    end
+    clock
+  end
+
+  let(:meter) {  Leafy::Core::Meter.new(clock) }
+
+  it 'starts out with no rates or count' do
+    expect(meter.count).to eq 0
+
+    expect(meter.mean_rate).to eq 0
+
+    expect(meter.one_minute_rate).to eq 0
+
+    expect(meter.five_minute_rate).to eq 0
+
+    expect(meter.fifteen_minute_rate).to eq 0
+  end
+
+  it 'marksEventsAndUpdatesRatesAndCount' do
+    meter.mark
+    meter.mark(2)
+
+    expect(meter.mean_rate).to eq 0.3
+
+    expect(Number[meter.one_minute_rate]).to eql Number[0.1840, 0.1]
+
+    expect(Number[meter.five_minute_rate]).to eql Number[0.1966, 0.1]
+
+    expect(Number[meter.fifteen_minute_rate]).to eql Number[0.1988, 0.1]
+  end
+end

data/spec/metric_registry_spec.rb

@@ -0,0 +1,168 @@
+require 'leafy/core/metric_registry'
+
+RSpec.describe Leafy::Core::MetricRegistry do
+
+  class MetricMock
+
+    def initialize(klass)
+      @klass = klass
+    end
+    def is_a?(klass)
+      @klass == klass
+    end
+  end
+
+  let(:registry) { subject }
+
+  let(:gauge) { MetricMock.new(Leafy::Core::Gauge) }
+  let(:counter) { MetricMock.new(Leafy::Core::Counter) }
+  let(:timer) { MetricMock.new(Leafy::Core::Timer) }
+  let(:histogram) { MetricMock.new(Leafy::Core::Histogram) }
+  let(:meter) { MetricMock.new(Leafy::Core::Meter) }
+
+  it 'registeringAGaugeTriggersANotification' do
+     expect(registry.register("thing", gauge)).to eq gauge
+
+     #     verify(listener).onGaugeAdded("thing", gauge);
+  end
+
+  it 'removingAGaugeTriggersANotification' do
+     registry.register("thing", gauge);
+
+     expect(registry.remove("thing")).to eq true
+
+     #      verify(listener).onGaugeRemoved("thing");
+  end
+
+  it 'registeringACounterTriggersANotification' do
+    expect(registry.register("thing", counter)).to eq counter
+
+    #       verify(listener).onCounterAdded("thing", counter);
+  end
+
+  it 'accessingACounterRegistersAndReusesTheCounter' do
+    counter1 = registry.counter("thing");
+    counter2 = registry.counter("thing");
+
+    expect(counter1).to equal counter2
+
+    #        verify(listener).onCounterAdded("thing", counter1);
+  end
+
+  it 'removingACounterTriggersANotification' do
+    registry.register("thing", counter);
+
+    expect(registry.remove("thing")).to eq true
+
+    #      verify(listener).onCounterRemoved("thing");
+  end
+
+  it 'registeringAHistogramTriggersANotification' do
+    expect(registry.register("thing", histogram)).to eq histogram
+
+    #       verify(listener).onHistogramAdded("thing", histogram);
+  end
+  
+  it 'accessingAHistogramRegistersAndReusesIt' do
+    histogram1 = registry.histogram("thing");
+    histogram2 = registry.histogram("thing");
+
+    expect(histogram1).to be histogram2
+
+    #        verify(listener).onHistogramAdded("thing", histogram1);
+  end
+  
+  it 'removingAHistogramTriggersANotification' do
+    registry.register("thing", histogram);
+
+    expect(registry.remove("thing")).to eq true
+
+    #      verify(listener).onHistogramRemoved("thing");
+  end
+  
+  it 'registeringAMeterTriggersANotification' do
+    expect(registry.register("thing", meter)).to eq meter
+
+    #       verify(listener).onMeterAdded("thing", meter);
+  end
+  
+  it 'accessingAMeterRegistersAndReusesIt' do
+    meter1 = registry.meter("thing");
+    meter2 = registry.meter("thing");
+
+    expect(meter1).to be meter2
+
+    #        verify(listener).onMeterAdded("thing", meter1);
+  end
+  
+  it 'removingAMeterTriggersANotification' do
+    registry.register("thing", meter);
+
+    expect(registry.remove("thing")).to eq true
+
+    #     verify(listener).onMeterRemoved("thing");
+  end
+  
+  it 'registeringATimerTriggersANotification' do
+    expect(registry.register("thing", timer)).to eq timer
+
+    #      verify(listener).onTimerAdded("thing", timer);
+  end
+  
+  it 'accessingATimerRegistersAndReusesIt' do
+    timer1 = registry.timer("thing");
+    timer2 = registry.timer("thing");
+
+    expect(timer1).to be timer2
+
+    #       verify(listener).onTimerAdded("thing", timer1);
+  end
+  
+  it 'removingATimerTriggersANotification' do
+    registry.register("thing", timer);
+
+    expect(registry.remove("thing")).to eq true
+
+    #        verify(listener).onTimerRemoved("thing");
+  end
+  
+  it 'hasAMapOfRegisteredGauges' do
+    registry.register("gauge", gauge)
+
+    expect(registry.gauges['gauge']).to eq gauge
+  end
+  
+  it 'hasAMapOfRegisteredCounters' do
+    registry.register("counter", counter);
+
+    expect(registry.counters['counter']).to eq counter
+  end
+  
+  it 'hasAMapOfRegisteredHistograms' do
+    registry.register("histogram", histogram);
+
+    expect(registry.histograms['histogram']).to eq histogram
+  end
+  
+  it 'hasAMapOfRegisteredMeters' do
+    registry.register("meter", meter);
+
+    expect(registry.meters['meter']).to eq meter
+  end
+  
+  it 'hasAMapOfRegisteredTimers' do
+    registry.register("timer", timer);
+
+    expect(registry.timers['timer']).to eq timer
+  end
+
+  it 'hasASetOfRegisteredMetricNames' do
+    registry.register("gauge", gauge);
+    registry.register("counter", counter);
+    registry.register("histogram", histogram);
+    registry.register("meter", meter);
+    registry.register("timer", timer);
+
+    expect(registry.names).to match_array ["gauge", "counter", "histogram", "meter", "timer"]
+  end
+end

data/spec/ratio_gauge_spec.rb

@@ -0,0 +1,47 @@
+require 'leafy/core/ratio_gauge'
+
+RSpec.describe Leafy::Core::RatioGauge do
+
+  
+    it 'ratiosAreHumanReadable' do
+      ratio = Leafy::Core::RatioGauge::Ratio.of(100, 200);
+
+      expect(ratio.to_s).to eq "100.0:200.0"
+    end
+
+    
+    it 'calculatesTheRatioOfTheNumeratorToTheDenominator' do
+        regular = Leafy::Core::RatioGauge.new do
+          Leafy::Core::RatioGauge::Ratio.of(2.0, 4.0)
+        end
+
+        expect(regular.value).to eq 0.5
+    end
+
+    
+    it 'handlesDivideByZeroIssues' do
+        divByZero = Leafy::Core::RatioGauge.new do
+          Leafy::Core::RatioGauge::Ratio.of(100, 0)
+        end
+        
+        expect(divByZero.value.nan?).to eq true
+    end
+
+    
+    it 'handlesInfiniteDenominators' do
+      infinite = Leafy::Core::RatioGauge.new do
+        Leafy::Core::RatioGauge::Ratio.of(10, Float::INFINITY)
+      end
+
+      expect(infinite.value.nan?).to eq true
+    end
+
+    
+    it 'handlesNaNDenominators' do
+      nan = Leafy::Core::RatioGauge.new do
+        Leafy::Core::RatioGauge::Ratio.of(10, Float::NAN)
+      end
+
+      expect(nan.value.nan?).to eq true
+    end
+end

data/spec/scheduled_reporter_spec.rb

@@ -0,0 +1,135 @@
+require 'leafy/core/scheduled_reporter'
+require 'concurrent/atomic/atomic_fixnum'
+
+
+RSpec.describe Leafy::Core::ScheduledReporter do
+
+  class MetricMock
+
+    def initialize(klass)
+      @klass = klass
+    end
+    def is_a?(klass)
+      @klass == klass
+    end
+  end
+
+  class Leafy::Core::DummyReporter < Leafy::Core::ScheduledReporter
+
+    attr_reader :execution_count, :args
+    def initialize(registry, name, *)#executor = nil, shutdownExecutorOnStop = false)
+      super
+      @execution_count = Concurrent::AtomicFixnum.new
+      @args = []
+    end
+
+    def do_report(*args)
+      @args << args
+      @execution_count.increment
+    end
+  end
+
+  let(:gauge) { MetricMock.new(Leafy::Core::Gauge) }
+  let(:counter) { MetricMock.new(Leafy::Core::Counter) }
+  let(:timer) { MetricMock.new(Leafy::Core::Timer) }
+  let(:histogram) { MetricMock.new(Leafy::Core::Histogram) }
+  let(:meter) { MetricMock.new(Leafy::Core::Meter) }
+  let(:registry) do
+    registry = Leafy::Core::MetricRegistry.new
+    registry.register("gauge", gauge)
+    registry.register("counter", counter)
+    registry.register("histogram", histogram)
+    registry.register("meter", meter)
+    registry.register("timer", timer)
+    registry
+  end
+
+  let(:custom_executor) { Concurrent::SingleThreadExecutor.new }
+  let(:external_executor) { Concurrent::SingleThreadExecutor.new }
+  let(:reporter) { Leafy::Core::DummyReporter.new(registry, 'example') }
+  let(:reporter_with_custom_executor) { Leafy::Core::DummyReporter.new(registry, 'example', custom_executor) }
+  let(:reporter_with_externally_managed_executor) { Leafy::Core::DummyReporter.new(registry, 'example', external_executor, false) }
+  let(:reporters) { [reporter, reporter_with_custom_executor,
+                     reporter_with_externally_managed_executor] }
+
+  after :each do
+    reporter.stop
+    custom_executor.shutdown
+    external_executor.shutdown
+  end
+
+  it 'pollsPeriodically' do
+    reporter.start(0.1)
+
+    sleep(0.55)
+    expect(reporter.execution_count.value).to eq 5
+    expect(reporter.args.size).to eq 5
+    reporter.args.each do |arg|
+      expect(arg[0]['gauge']).to eq gauge
+      expect(arg[1]['counter']).to eq counter
+      expect(arg[2]['histogram']).to eq histogram
+      expect(arg[3]['meter']).to eq meter
+      expect(arg[4]['timer']).to eq timer
+    end
+  end
+
+  it 'shouldDisallowToStartReportingMultiple' do
+    expect { reporter.start(0.2) }.not_to raise_error
+    expect { reporter.start(0.2) }.to raise_error ArgumentError
+  end
+
+  it 'shouldDisallowToStartReportingMultipleTimesOnCustomExecutor' do
+    expect { reporter_with_custom_executor.start(0.2) }.not_to raise_error
+    expect { reporter_with_custom_executor.start(0.2) }.to raise_error ArgumentError
+  end
+
+  it 'shouldDisallowToStartReportingMultipleTimesOnExternallyManagedExecutor' do
+    expect { reporter_with_externally_managed_executor.start(0.2) }.not_to raise_error
+    expect { reporter_with_externally_managed_executor.start(0.2) }.to raise_error ArgumentError
+  end
+    
+  it 'shouldNotFailOnStopIfReporterWasNotStared' do
+    reporters.each do |reporter|
+      expect { reporter.stop }.not_to raise_error
+    end
+  end
+
+  it 'shouldNotFailWhenStoppingMultipleTimes' do
+    reporters[2..2].each do |reporter|
+      reporter.start(0.2)
+      reporter.stop
+      reporter.stop
+      reporter.stop
+    end
+  end
+
+  it 'shouldShutdownExecutorOnStopByDefault' do
+    reporter_with_custom_executor.start(0.2)
+    reporter_with_custom_executor.stop
+    expect(custom_executor.shutdown?).to eq true
+  end
+
+  it 'shouldNotShutdownExternallyManagedExecutorOnStop' do
+    reporter_with_externally_managed_executor.start(0.2)
+    reporter_with_externally_managed_executor.stop
+    expect(external_executor.shutdown?).to eq false
+  end
+
+    
+  it 'shouldCancelScheduledFutureWhenStoppingWithExternallyManagedExecutor' do
+    # configure very frequency rate of execution
+    reporter_with_externally_managed_executor.start(0.001)
+    reporter_with_externally_managed_executor.stop
+    sleep(0.1)
+
+    # executionCount should not increase when scheduled future is canceled properly
+    execution_count = reporter_with_externally_managed_executor.execution_count.value
+    sleep(0.5)
+    expect(execution_count).to eq reporter_with_externally_managed_executor.execution_count.value
+  end
+
+    
+  it 'shouldConvertDurationToMillisecondsPrecisely' do
+    expect(2.0E-5).to eq reporter.send(:convert_duration, 20)
+  end
+end

data/spec/sliging_window_reservoir_spec.rb

@@ -0,0 +1,22 @@
+require 'leafy/core/sliding_window_reservoir'
+
+RSpec.describe Leafy::Core::SlidingWindowReservoir do
+
+  let(:reservoir) {  Leafy::Core::SlidingWindowReservoir.new(3) }
+
+  it 'handles small data streams' do
+    reservoir.update(1)
+    reservoir.update(2)
+
+    expect(reservoir.snapshot.values).to eq [1,2]
+  end
+
+  it 'onlyKeepsTheMostRecentFromBigDataStreams' do
+    reservoir.update(1)
+    reservoir.update(2)
+    reservoir.update(3)
+    reservoir.update(4)
+    
+    expect(reservoir.snapshot.values).to eq [2, 3, 4]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,123 @@
+require 'pry'
+require 'coveralls'
+Coveralls.wear!
+
+class Number
+
+  def self.[](number, offset = 1)
+    new(number, offset)
+  end
+
+  attr_reader :number, :offset
+
+  def initialize(number, offset = 1)
+    @number = number
+    @offset = offset
+  end
+
+  def eql?(other)
+    offset =  other.offset / 100.0
+    (number / offset + 0.5).to_i == (other.number / offset + 0.5).to_i
+  end
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end