tricle 0.1.0 → 0.2.0

data/spec/app/no_total_test_mailer.rb

@@ -0,0 +1,11 @@
+require_relative '../../lib/tricle/mailer'
+require_relative 'test_metric_with_no_total'
+
+class NoTotalTestMailer < Tricle::Mailer
+  default(
+    to: ['recipient1@test.com', 'recipient2@test.com'],
+    from: 'sender@test.com'
+  )
+
+  metric TestMetricWithNoTotal
+end

data/spec/app/test_metric.rb

@@ -1,38 +1,6 @@
-require 'csv'
-require_relative '../../lib/tricle/metric'
-require_relative '../../lib/tricle/range_data'
-
-class TestMetric < Tricle::Metric
-  attr_accessor :data_by_start_on
-
-  def initialize
-    super
-    self.load_data
-  end
-
-  def load_data
-    filename = File.join(File.dirname(__FILE__), '..', 'fixtures', 'weeks.csv')
-    data = CSV.read(filename)
-
-    self.data_by_start_on = Tricle::RangeData.new
-
-    data.each do |row|
-      start_on = Date.parse(row[0])
-      val = row[2].to_i
-      self.data_by_start_on.add(start_on, val)
-    end
-  end
-
-  def size_for_range(start_at, end_at)
-    self.items_for_range(start_at, end_at).reduce(&:+)
-  end
-
-  def items_for_range(start_at, end_at)
-    start_on = start_at.to_date
-    end_on = end_at.to_date
-    self.data_by_start_on.items_for_range(start_on, end_on)
-  end
+require_relative 'test_metric_with_no_total'
 
+class TestMetric < TestMetricWithNoTotal
   def total
     self.data_by_start_on.all_items.reduce(&:+)
   end

data/spec/app/test_metric_with_no_total.rb

@@ -0,0 +1,35 @@
+require 'csv'
+require_relative '../../lib/tricle/metric'
+require_relative '../../lib/tricle/range_data'
+
+class TestMetricWithNoTotal < Tricle::Metric
+  attr_accessor :data_by_start_on
+
+  def initialize
+    super
+    self.load_data
+  end
+
+  def load_data
+    filename = File.join(File.dirname(__FILE__), '..', 'fixtures', 'weeks.csv')
+    data = CSV.read(filename)
+
+    self.data_by_start_on = Tricle::RangeData.new
+
+    data.each do |row|
+      start_on = Date.parse(row[0])
+      val = row[2].to_i
+      self.data_by_start_on.add(start_on, val)
+    end
+  end
+
+  def size_for_range(start_at, end_at)
+    self.items_for_range(start_at, end_at).reduce(&:+)
+  end
+
+  def items_for_range(start_at, end_at)
+    start_on = start_at.to_date
+    end_on = end_at.to_date
+    self.data_by_start_on.items_for_range(start_on, end_on)
+  end
+end

data/spec/config/timecop.rb

@@ -2,6 +2,6 @@ require 'timecop'
 
 def reset_time
   # need to freeze the time for the TestMetric
-  now = Time.new(2013, 8, 1, 1, 0, 0, '-04:00')
+  now = Time.new(2013, 8, 1, 1, 0, 0)
   Timecop.freeze(now)
 end

data/spec/presenters/group_spec.rb

@@ -8,10 +8,9 @@ describe Tricle::Presenters::Group do
   describe '#add_metric' do
     it "should add a new metric instance" do
       group.add_metric(TestMetric)
-      group.metric_presenters.size.should eq(1)
-      presenter = group.metric_presenters.first
-      presenter.should be_a(Tricle::Presenters::Metric)
-      presenter.metric.should be_a(TestMetric)
+      expect(group.metrics.size).to eq(1)
+      metric = group.metrics.first
+      expect(metric).to be_a(TestMetric)
     end
   end
 end

data/spec/presenters/report_spec.rb

@@ -7,13 +7,13 @@ describe Tricle::Presenters::Report do
 
   describe '#add_metric' do
     it "should add a new group if none are present" do
-      report.sections.should eq([])
+      expect(report.sections).to eq([])
       report.add_metric(TestMetric)
-      report.sections.size.should eq(1)
+      expect(report.sections.size).to eq(1)
 
-      presenters = report.sections.first.metric_presenters
-      presenters.size.should eq(1)
-      presenters.first.metric.should be_a(TestMetric)
+      metrics = report.sections.first.metrics
+      expect(metrics.size).to eq(1)
+      expect(metrics.first).to be_a(TestMetric)
     end
   end
 end

data/spec/spec_helper.rb

@@ -17,7 +17,6 @@ reset_time
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

data/spec/unit/aggregation_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require_relative '../../lib/tricle/aggregation'
+
+describe Tricle::Aggregation do
+  let(:metric) { TestMetric.new }
+
+  describe '#days_ago' do
+    it "should start and end at midnight" do
+      expect(metric).to receive(:size_for_range).with(Time.new(2013, 7, 29), Time.new(2013, 7, 30))
+      metric.days_ago(3)
+    end
+  end
+
+  describe '#yesterday' do
+    it "should start and end at midnight" do
+      expect(metric).to receive(:size_for_range).with(Time.new(2013, 7, 31), Time.new(2013, 8, 1))
+      metric.yesterday
+    end
+  end
+
+  describe '#weeks_ago' do
+    it "should start and end on Monday" do
+      expect(metric).to receive(:size_for_range).with(Time.new(2013, 7, 8), Time.new(2013, 7, 15))
+      metric.weeks_ago(3)
+    end
+  end
+
+  describe '#last_week' do
+    it "should start and end on Monday" do
+      expect(metric).to receive(:size_for_range).with(Time.new(2013, 7, 22), Time.new(2013, 7, 29))
+      metric.last_week
+    end
+  end
+
+  describe '#week_average_this_quarter' do
+    it "should average the values provided by #size_for_range" do
+      expect(metric).to receive(:size_for_range).exactly(13).times.and_return(1)
+      expect(metric.week_average_this_quarter).to eq(1)
+    end
+  end
+end

data/spec/unit/email_helper_spec.rb

@@ -10,25 +10,105 @@ describe Tricle::EmailHelper do
 
   describe "#number_with_delimiter" do
     it "should put commas between every three digits" do
-      helper.number_with_delimiter(1234567.89).should eq('1,234,567.89')
+      expect(helper.number_with_delimiter(1234567.89)).to eq('1,234,567.89')
+      expect(helper.number_with_delimiter(1234567)).to eq('1,234,567')
+    end
+
+    it "should not put commas between every three digits of the decimal portion of non-integers" do
+      expect(helper.number_with_delimiter(0.123456789)).to eq('0.123456789')
+      expect(helper.number_with_delimiter(1234.56789)).to eq('1,234.56789')
+      expect(helper.number_with_delimiter(-0.123456789)).to eq('-0.123456789')
+      expect(helper.number_with_delimiter(-1234.56789)).to eq('-1,234.56789')
+    end
+  end
+
+  describe "#sig_figs" do
+    it "works for large numbers, positive and negative" do
+      expect(helper.sig_figs(1234.56789)).to eq(1230)
+      expect(helper.sig_figs(-1234.56789)).to eq(-1230)
+      expect(helper.sig_figs(1234.56789).to_s).to eq('1230')
+      expect(helper.sig_figs(-1234.56789).to_s).to eq('-1230')
+    end
+
+    it "works for small numbers, positive and negative" do
+      expect(helper.sig_figs(0.123456789)).to eq(0.123)
+      expect(helper.sig_figs(-0.123456789)).to eq(-0.123)
+      expect(helper.sig_figs(0.123456789).to_s).to eq('0.123')
+      expect(helper.sig_figs(-0.123456789).to_s).to eq('-0.123')
+    end
+
+    it "works for numbers with leading zeroes, positive and negative" do
+      expect(helper.sig_figs(0.00000123456789)).to eq(0.00000123)
+      expect(helper.sig_figs(-0.00000123456789)).to eq(-0.00000123)
+      expect(helper.sig_figs(0.00000123456789).to_s).to eq('1.23e-06')
+      expect(helper.sig_figs(-0.00000123456789).to_s).to eq('-1.23e-06')
+    end
+
+    it "works for integer-like numbers, positive and negative" do
+      expect(helper.sig_figs(10).is_a?(Float)).to be_truthy
+      expect(helper.sig_figs(10).to_s).to eq('10.0')
+      expect(helper.sig_figs(-10).is_a?(Float)).to be_truthy
+      expect(helper.sig_figs(-10).to_s).to eq('-10.0')
+    end
+  end
+
+  describe "#format_number" do
+    it "does not decrease the precision of large integers" do
+      expect(helper.format_number(123456789)).to eq('123,456,789')
+      expect(helper.format_number(-123456789)).to eq('-123,456,789')
+    end
+
+    it "decreases the precision of large numbers to no fewer than 3 sig figs" do
+      expect(helper.format_number(123.45)).to eq('123')
+      expect(helper.format_number(-123.45)).to eq('-123')
+    end
+
+    it "decreases the precision of small numbers to no fewer than 3 sig figs" do
+      expect(helper.format_number(0.00123456789)).to eq('0.00123')
+      expect(helper.format_number(-0.00123456789)).to eq('-0.00123')
     end
   end
 
   describe "#percent_change" do
     it "should prefix positive values with a +" do
-      helper.percent_change(110, 100).should eq('+10.0%')
+      expect(helper.percent_change(110, 100)).to eq('+10.0%')
     end
 
     it "should prefix negative values with a -" do
-      helper.percent_change(90, 100).should eq('-10.0%')
+      expect(helper.percent_change(90, 100)).to eq('-10.0%')
     end
 
     it "should handle a zero as the old value with positive change" do
-      helper.percent_change(10, 0).should eq('+')
+      expect(helper.percent_change(10, 0)).to eq('+')
     end
 
     it "should handle a zero as the old value with negative change" do
-      helper.percent_change(-20, 0).should eq('-')
+      expect(helper.percent_change(-20, 0)).to eq('-')
+    end
+
+    it "should not display small values as 0" do
+      expect(helper.percent_change(100_001_234, 100_000_000)).to eq('+0.00123%')
+      expect(helper.percent_change(100_000_000, 100_001_234)).to eq('-0.00123%')
+    end
+
+    it "should display 'no change' when unchanged" do
+      expect(helper.percent_change(100, 100)).to eq('No change')
+      expect(helper.percent_change(0, 0)).to eq('No change')
+    end
+  end
+
+  describe '#percent_change_cell' do
+    it "should be positive with positive change and better = :higher" do
+      expect(helper.percent_change_cell(4, 2, :higher)).to match('good')
+    end
+
+    it "should be negative with positive change and better = :lower" do
+      expect(helper.percent_change_cell(4, 2, :lower)).to match('bad')
+    end
+
+    it "should not be positive or negative with positive change and better = :none" do
+      expect(helper.percent_change_cell(4, 2, :none)).to_not match('good')
+      expect(helper.percent_change_cell(4, 2, :none)).to_not match('bad')
     end
   end
 
@@ -36,8 +116,8 @@ describe Tricle::EmailHelper do
     it "should not include the last day of the week" do
       start_at = Time.new(2013, 7, 22) # a Monday
       markup = helper.single_week_dates_cell(start_at)
-      markup.should include('7/22/13')
-      markup.should include('7/28/13')
+      expect(markup).to include('7/22/13')
+      expect(markup).to include('7/28/13')
     end
   end
 end

data/spec/unit/mail_preview_spec.rb

@@ -5,11 +5,11 @@ require_relative '../../lib/tricle/mail_preview'
 describe Tricle::MailPreview do
   describe 'mailer methods' do
     it "should have methods corresponding to all mailers" do
-      Tricle::MailPreview.instance_methods(false).should include(:test_mailer)
+      expect(Tricle::MailPreview.instance_methods(false)).to include(:test_mailer)
     end
 
     it "should return a Mail::Message" do
-      Tricle::MailPreview.new.test_mailer.should be_a(Mail::Message)
+      expect(Tricle::MailPreview.new.test_mailer).to be_a(Mail::Message)
     end
   end
 end

data/spec/unit/mailer_spec.rb

@@ -2,12 +2,13 @@ require 'spec_helper'
 require_relative '../../lib/tricle/mailer'
 require_relative '../app/group_test_mailer'
 require_relative '../app/list_test_mailer'
+require_relative '../app/no_total_test_mailer'
 require_relative '../app/test_mailer'
 
 describe Tricle::Mailer do
   def deliver(klass)
     klass.email.deliver
-    ActionMailer::Base.deliveries.length.should eq(1)
+    expect(ActionMailer::Base.deliveries.length).to eq(1)
   end
 
   let(:message) { ActionMailer::Base.deliveries.last }
@@ -19,48 +20,54 @@ describe Tricle::Mailer do
     end
 
     it "should respect all the options in the 'default hash'" do
-      message.to.should eq(['recipient1@test.com', 'recipient2@test.com'])
-      message.from.should eq(['sender@test.com'])
+      expect(message.to).to eq(['recipient1@test.com', 'recipient2@test.com'])
+      expect(message.from).to eq(['sender@test.com'])
     end
 
     it "should set the subject based on the class name" do
-      message.subject.should eq("Your Test Mailer")
+      expect(message.subject).to eq("Your Test Mailer")
     end
 
     it "should include the Metric values in the HTML part" do
-      markup.should include('Test Metric')
-      markup.should match(/\b62\b/) # last week
-      markup.should match(/\b787\b/) # total
+      expect(markup).to include('Test Metric')
+      expect(markup).to match(/\b62\b/) # last week
+      expect(markup).to match(/\b787\b/) # total
     end
 
     it "should link to the Issues page in the text part" do
       source = message.text_part.body.to_s
-      source.should include('github.com/artsy/tricle')
+      expect(source).to include('github.com/artsy/tricle')
     end
   end
 
+  it "should exclude the total if not defined" do
+    deliver(NoTotalTestMailer)
+    expect(markup).to_not include('total')
+    expect(markup).to_not match(/\b787\b/)
+  end
+
   describe '.group' do
     it "should include the group title" do
       deliver(GroupTestMailer)
-      markup.should include("Test Group 1")
-      markup.should include("Test Group 2")
-      markup.should include("Test Metric")
+      expect(markup).to include("Test Group 1")
+      expect(markup).to include("Test Group 2")
+      expect(markup).to include("Test Metric")
     end
   end
 
   describe '.list' do
     it "should include the list title" do
       deliver(ListTestMailer)
-      markup.should include("Test Metric")
-      markup.should include('62.0')
-      markup.should_not include('79.0')
+      expect(markup).to include("Test Metric")
+      expect(markup).to include('62.0')
+      expect(markup).not_to include('79.0')
     end
   end
 
   describe '.send_all' do
     it "should .deliver all defined mailers" do
       Tricle::Mailer.send_all
-      ActionMailer::Base.deliveries.length.should eq(3)
+      expect(ActionMailer::Base.deliveries.length).to eq(4)
     end
   end
 end

data/spec/unit/metric_spec.rb

@@ -11,8 +11,8 @@ describe Tricle::Metric do
     end
 
     it "should use the number of items by default" do
-      metric.stub(:items_for_range) { [1,2,3] }
-      metric.size_for_range(Time.now.yesterday, Time.now).should eq(3)
+      allow(metric).to receive(:items_for_range) { [1,2,3] }
+      expect(metric.size_for_range(Time.now.yesterday, Time.now)).to eq(3)
     end
   end
 end

data/spec/unit/range_data_spec.rb

@@ -11,14 +11,14 @@ describe Tricle::RangeData do
 
   describe '#all_items' do
     it "should return all the items" do
-      rd.all_items.sort.should eq([5, 6, 7])
+      expect(rd.all_items.sort).to eq([5, 6, 7])
     end
   end
 
   describe '#items_for_range' do
     it "should return the items for the days provided" do
       items = rd.items_for_range(11.days.ago, 3.days.ago)
-      items.sort.should eq([5, 6])
+      expect(items.sort).to eq([5, 6])
     end
   end
 end

data/spec/unit/test_metric_spec.rb

@@ -1,20 +1,19 @@
 require 'spec_helper'
 require_relative '../app/test_metric'
-require_relative '../../lib/tricle/presenters/metric'
 
 # test the tests
 describe TestMetric do
-  let(:presenter) { Tricle::Presenters::Metric.new(TestMetric) }
+  let(:metric) { TestMetric.new }
 
   describe '#weeks_ago' do
     it "should start and end on Monday" do
-      presenter.weeks_ago(3).should eq(51)
+      expect(metric.weeks_ago(3)).to eq(51)
     end
   end
 
   describe '#last_week' do
     it "should start and end on Monday" do
-      presenter.last_week.should eq(62)
+      expect(metric.last_week).to eq(62)
     end
   end
 end