tricle 0.1.0

data/spec/config/timecop.rb

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

data/spec/fixture_generator

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'csv'
+require 'active_support/all'
+
+end_at = Time.now.beginning_of_week
+filename = File.join(File.dirname(__FILE__), 'fixtures', 'weeks.csv')
+CSV.open(filename, 'wb') do |csv|
+  (0..12).reverse_each do |n|
+    week_start_at = end_at - (n + 1).weeks
+    week_end_at = end_at - n.weeks
+    csv << [
+      week_start_at.to_date,
+      week_end_at.to_date,
+      rand(100)
+    ]
+  end
+end

data/spec/fixtures/weeks.csv

@@ -0,0 +1,13 @@
+2013-04-29,2013-05-06,96
+2013-05-06,2013-05-13,83
+2013-05-13,2013-05-20,82
+2013-05-20,2013-05-27,16
+2013-05-27,2013-06-03,70
+2013-06-03,2013-06-10,67
+2013-06-10,2013-06-17,76
+2013-06-17,2013-06-24,75
+2013-06-24,2013-07-01,11
+2013-07-01,2013-07-08,19
+2013-07-08,2013-07-15,51
+2013-07-15,2013-07-22,79
+2013-07-22,2013-07-29,62

data/spec/presenters/group_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require_relative '../../lib/tricle/presenters/group'
+require_relative '../app/test_metric'
+
+describe Tricle::Presenters::Group do
+  let(:group) { Tricle::Presenters::Group.new }
+
+  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)
+    end
+  end
+end

data/spec/presenters/metric_spec.rb

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

data/spec/presenters/report_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+require_relative '../../lib/tricle/presenters/report'
+
+describe Tricle::Presenters::Report do
+  let(:report) { Tricle::Presenters::Report.new }
+
+  describe '#add_metric' do
+    it "should add a new group if none are present" do
+      report.sections.should eq([])
+      report.add_metric(TestMetric)
+      report.sections.size.should eq(1)
+
+      presenters = report.sections.first.metric_presenters
+      presenters.size.should eq(1)
+      presenters.first.metric.should be_a(TestMetric)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup
+
+require 'action_mailer'
+require 'timecop'
+
+require_relative 'config/timecop'
+
+# TODO find a less heavy-handed way of handling this
+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
+
+  ActionMailer::Base.delivery_method = :test
+  config.before do
+    ActionMailer::Base.deliveries.clear
+    reset_time
+  end
+
+  # 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'
+end

data/spec/unit/abstract_method_error_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require_relative '../../lib/tricle/abstract_method_error'
+
+describe Tricle::AbstractMethodError do
+  class TestAbstractMethod
+    def foo
+      raise Tricle::AbstractMethodError.new
+    end
+  end
+
+  it "should include the method name in the message" do
+    expect {
+      TestAbstractMethod.new.foo
+    }.to raise_error("#foo not implemented")
+  end
+end

data/spec/unit/email_helper_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require_relative '../../lib/tricle/email_helper'
+
+describe Tricle::EmailHelper do
+  class HelperTester
+    include Tricle::EmailHelper
+  end
+
+  let(:helper) { HelperTester.new }
+
+  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')
+    end
+  end
+
+  describe "#percent_change" do
+    it "should prefix positive values with a +" do
+      helper.percent_change(110, 100).should eq('+10.0%')
+    end
+
+    it "should prefix negative values with a -" do
+      helper.percent_change(90, 100).should eq('-10.0%')
+    end
+
+    it "should handle a zero as the old value with positive change" do
+      helper.percent_change(10, 0).should eq('+')
+    end
+
+    it "should handle a zero as the old value with negative change" do
+      helper.percent_change(-20, 0).should eq('-')
+    end
+  end
+
+  describe "#single_week_dates_cell" 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')
+    end
+  end
+end

data/spec/unit/mail_preview_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require_relative '../app/test_mailer'
+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)
+    end
+
+    it "should return a Mail::Message" do
+      Tricle::MailPreview.new.test_mailer.should be_a(Mail::Message)
+    end
+  end
+end

data/spec/unit/mailer_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require_relative '../../lib/tricle/mailer'
+require_relative '../app/group_test_mailer'
+require_relative '../app/list_test_mailer'
+require_relative '../app/test_mailer'
+
+describe Tricle::Mailer do
+  def deliver(klass)
+    klass.email.deliver
+    ActionMailer::Base.deliveries.length.should eq(1)
+  end
+
+  let(:message) { ActionMailer::Base.deliveries.last }
+  let(:markup) { message.html_part.body.to_s }
+
+  describe '.email' do
+    before do
+      deliver(TestMailer)
+    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'])
+    end
+
+    it "should set the subject based on the class name" do
+      message.subject.should 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
+    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')
+    end
+  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")
+    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')
+    end
+  end
+
+  describe '.send_all' do
+    it "should .deliver all defined mailers" do
+      Tricle::Mailer.send_all
+      ActionMailer::Base.deliveries.length.should eq(3)
+    end
+  end
+end

data/spec/unit/metric_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+require_relative '../../lib/tricle/metric'
+
+describe Tricle::Metric do
+  let(:metric) { Tricle::Metric.new }
+
+  describe '#size_for_range' do
+    it "should raise an exception if #items_for_range isn't overridden" do
+      expect { metric.size_for_range(Time.now.yesterday, Time.now) }.to raise_error
+    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)
+    end
+  end
+end

data/spec/unit/range_data_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require_relative '../../lib/tricle/range_data'
+
+describe Tricle::RangeData do
+  let(:rd) { Tricle::RangeData.new }
+  before do
+    rd.add(10.days.ago, 5)
+    rd.add(5.days.ago, 6)
+    rd.add(1.day.ago, 7)
+  end
+
+  describe '#all_items' do
+    it "should return all the items" do
+      rd.all_items.sort.should 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])
+    end
+  end
+end

data/spec/unit/test_metric_spec.rb

@@ -0,0 +1,20 @@
+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) }
+
+  describe '#weeks_ago' do
+    it "should start and end on Monday" do
+      presenter.weeks_ago(3).should eq(51)
+    end
+  end
+
+  describe '#last_week' do
+    it "should start and end on Monday" do
+      presenter.last_week.should eq(62)
+    end
+  end
+end

data/tricle.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tricle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tricle"
+  spec.version       = Tricle::VERSION
+  spec.authors       = ["Aidan Feldman"]
+  spec.email         = ["aidan.feldman@gmail.com"]
+  spec.description   = %q{Automated metrics reporting via email}
+  spec.summary       = %q{A datastore-agnostic mailer where you can define custom metrics, where you can query SQL, MongoDB, external APIs, etc. to generate the stats you need.  It can be used within a larger project (e.g. Rails), or standalone.}
+  spec.homepage      = "https://github.com/artsy/tricle"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionmailer", "~> 4.0"
+  spec.add_dependency "activesupport", "~> 4.0"
+  spec.add_dependency "mail_view", "~> 1.0"
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "premailer", "~> 1.7"
+  spec.add_dependency "rack", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "debugger"
+  spec.add_development_dependency "guard", "~> 1.8"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "ruby_gntp"
+  spec.add_development_dependency "shotgun"
+  spec.add_development_dependency "timecop", "~> 0.6.2"
+end

metadata

@@ -0,0 +1,324 @@
+--- !ruby/object:Gem::Specification
+name: tricle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aidan Feldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: mail_view
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: premailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shotgun
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+description: Automated metrics reporting via email
+email:
+- aidan.feldman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tricle.rb
+- lib/tricle/abstract_method_error.rb
+- lib/tricle/email_helper.rb
+- lib/tricle/mail_preview.rb
+- lib/tricle/mailer.rb
+- lib/tricle/metric.rb
+- lib/tricle/presenters/group.rb
+- lib/tricle/presenters/list.rb
+- lib/tricle/presenters/metric.rb
+- lib/tricle/presenters/report.rb
+- lib/tricle/presenters/section.rb
+- lib/tricle/range_data.rb
+- lib/tricle/tasks.rb
+- lib/tricle/templates/email.css
+- lib/tricle/templates/email.html.erb
+- lib/tricle/templates/email.text.erb
+- lib/tricle/version.rb
+- screenshot.png
+- spec/app/group_test_mailer.rb
+- spec/app/list_test_mailer.rb
+- spec/app/test_mailer.rb
+- spec/app/test_metric.rb
+- spec/app/test_metric_with_long_name.rb
+- spec/app/uber_test_mailer.rb
+- spec/config/timecop.rb
+- spec/fixture_generator
+- spec/fixtures/weeks.csv
+- spec/presenters/group_spec.rb
+- spec/presenters/metric_spec.rb
+- spec/presenters/report_spec.rb
+- spec/spec_helper.rb
+- spec/unit/abstract_method_error_spec.rb
+- spec/unit/email_helper_spec.rb
+- spec/unit/mail_preview_spec.rb
+- spec/unit/mailer_spec.rb
+- spec/unit/metric_spec.rb
+- spec/unit/range_data_spec.rb
+- spec/unit/test_metric_spec.rb
+- tricle.gemspec
+homepage: https://github.com/artsy/tricle
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A datastore-agnostic mailer where you can define custom metrics, where you
+  can query SQL, MongoDB, external APIs, etc. to generate the stats you need.  It
+  can be used within a larger project (e.g. Rails), or standalone.
+test_files:
+- spec/app/group_test_mailer.rb
+- spec/app/list_test_mailer.rb
+- spec/app/test_mailer.rb
+- spec/app/test_metric.rb
+- spec/app/test_metric_with_long_name.rb
+- spec/app/uber_test_mailer.rb
+- spec/config/timecop.rb
+- spec/fixture_generator
+- spec/fixtures/weeks.csv
+- spec/presenters/group_spec.rb
+- spec/presenters/metric_spec.rb
+- spec/presenters/report_spec.rb
+- spec/spec_helper.rb
+- spec/unit/abstract_method_error_spec.rb
+- spec/unit/email_helper_spec.rb
+- spec/unit/mail_preview_spec.rb
+- spec/unit/mailer_spec.rb
+- spec/unit/metric_spec.rb
+- spec/unit/range_data_spec.rb
+- spec/unit/test_metric_spec.rb