tricle 0.1.0

data/lib/tricle/metric.rb

@@ -0,0 +1,23 @@
+require 'active_support/core_ext/date/calculations'
+require 'active_support/core_ext/numeric/time'
+require_relative 'abstract_method_error'
+
+module Tricle
+  class Metric
+    def title
+      self.class.name.titleize
+    end
+
+    def size_for_range(start_at, end_at)
+      self.items_for_range(start_at, end_at).size
+    end
+
+    def total
+      raise Tricle::AbstractMethodError.new
+    end
+
+    def items_for_range(start_at, end_at)
+      raise Tricle::AbstractMethodError.new
+    end
+  end
+end

data/lib/tricle/presenters/group.rb

@@ -0,0 +1,20 @@
+require_relative 'metric'
+require_relative 'section'
+
+module Tricle
+  module Presenters
+    class Group < Section
+      attr_reader :metric_presenters, :title
+
+      def initialize(title=nil)
+        @title = title
+        @metric_presenters = []
+      end
+
+      def add_metric(klass)
+        presenter = Tricle::Presenters::Metric.new(klass)
+        self.metric_presenters << presenter
+      end
+    end
+  end
+end

data/lib/tricle/presenters/list.rb

@@ -0,0 +1,27 @@
+require_relative 'section'
+
+module Tricle
+  class List < Section
+    attr_reader :block, :metric
+
+    def initialize(klass, &block)
+      @metric = klass.new
+      @block = block
+    end
+
+    def title
+      self.metric.title
+    end
+
+    def items_markup(start_at, end_at)
+      markup = ''
+      items = self.metric.items_for_range(start_at, end_at)
+      items.each do |item|
+        val = self.block.call(item)
+        markup << %{<tr><td class="list-item" colspan="4">#{val}</td></tr>}
+      end
+
+      markup
+    end
+  end
+end

data/lib/tricle/presenters/metric.rb

@@ -0,0 +1,51 @@
+module Tricle
+  module Presenters
+    class Metric
+      attr_reader :metric, :now
+
+      def initialize(klass)
+        @metric = klass.new
+        # TODO allow Time to be passed in so it can be frozen
+        @now = Time.now
+      end
+
+      def title
+        self.metric.title
+      end
+
+      def total
+        self.metric.total
+      end
+
+      def days_ago(n)
+        start_at = self.now.beginning_of_day.days_ago(n)
+        end_at = start_at + 1.day
+        self.metric.size_for_range(start_at, end_at)
+      end
+
+      def yesterday
+        self.days_ago(1)
+      end
+
+      def weeks_ago(n)
+        start_at = self.now.beginning_of_week.weeks_ago(n)
+        end_at = start_at + 7.days
+        self.metric.size_for_range(start_at, end_at)
+      end
+
+      def last_week
+        self.weeks_ago(1)
+      end
+
+      def weeks_average(past_num_weeks)
+        weeks_range = 1..past_num_weeks
+        total = weeks_range.reduce(0){|sum, n| sum + self.weeks_ago(n) }
+        total.to_f / past_num_weeks
+      end
+
+      def week_average_this_quarter
+        self.weeks_average(13)
+      end
+    end
+  end
+end

data/lib/tricle/presenters/report.rb

@@ -0,0 +1,40 @@
+require_relative 'group'
+require_relative 'list'
+
+# internal representation of the data displayed in the Mailer
+module Tricle
+  module Presenters
+    class Report
+      attr_reader :sections
+
+      def initialize
+        @sections = []
+      end
+
+      def add_section(section)
+        self.sections << section
+        section
+      end
+
+      def add_group(title=nil)
+        group = Tricle::Presenters::Group.new(title)
+        self.add_section(group)
+      end
+
+      def add_metric(klass)
+        last_section = self.sections.last
+        unless last_section.is_a?(Tricle::Presenters::Group)
+          last_section = self.add_group
+        end
+
+        # TODO don't assume they want to add this metric to the last group?
+        last_section.add_metric(klass)
+      end
+
+      def add_list(klass, &block)
+        list = Tricle::List.new(klass, &block)
+        self.add_section(list)
+      end
+    end
+  end
+end

data/lib/tricle/presenters/section.rb

@@ -0,0 +1,9 @@
+require_relative '../abstract_method_error'
+
+module Tricle
+  class Section
+    def title
+      raise Tricle::AbstractMethodError.new
+    end
+  end
+end

data/lib/tricle/range_data.rb

@@ -0,0 +1,27 @@
+# TODO add this class to the README?
+module Tricle
+  class RangeData
+    def initialize
+      @data = {}
+    end
+
+    def add(key, val)
+      @data[key] ||= []
+      @data[key] << val
+    end
+
+    def all_items
+      @data.values.flatten
+    end
+
+    def items_for_range(low, high)
+      @data.reduce([]) { |memo, (key, values)|
+        if key >= low && key < high
+          memo + values
+        else
+          memo
+        end
+      }
+    end
+  end
+end

data/lib/tricle/tasks.rb

@@ -0,0 +1,19 @@
+require 'rack'
+require 'rake'
+require_relative '../tricle'
+
+namespace :tricle do
+  desc "Start a local server to preview your mailers"
+  task :preview do
+    require_relative 'mail_preview'
+
+    Rack::Server.start app: Tricle::MailPreview
+  end
+
+  namespace :emails do
+    desc "Send all emails"
+    task :send do
+      Tricle::Mailer.send_all
+    end
+  end
+end

data/lib/tricle/templates/email.css

@@ -0,0 +1,47 @@
+table {
+  border-collapse: collapse;
+  font-size: 16px;
+  line-height: 1.2;
+}
+
+th {
+  padding-left: 10px;
+  padding-right: 10px;
+}
+
+.section-heading {
+  font-size: 22px;
+  text-align: left;
+}
+
+th,
+td {
+  padding: 10px;
+  text-align: right;
+}
+
+.date-range {
+  font-size: 13px;
+}
+
+td {
+  border: 1px solid #c7c7c7;
+}
+
+.list-item {
+  text-align: left;
+}
+
+td div:first-child {
+  font-size: 20px;
+}
+
+.positive {
+  background-color: #e4ffea;
+  color: green;
+}
+
+.negative {
+  background-color: #ffe3e4;
+  color: #c21717;
+}

data/lib/tricle/templates/email.html.erb

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+  <body>
+    <table>
+      <% @report.sections.each do |section| %>
+        <tr>
+          <th class="section-heading" colspan="4"><%= section.title %></th>
+        </tr>
+        <% if section.is_a?(Tricle::List) %>
+          <%= list_markup(section) %>
+        <% else %>
+          <tr>
+            <th><!--Title--></th>
+            <th>
+              <div>Last week</div>
+              <%= last_week_dates_cell %>
+            </th>
+            <th>
+              <div>Previous week</div>
+              <%= previous_week_dates_cell %>
+            </th>
+            <th>
+              <div>Quarterly average</div>
+              <%= quarter_dates_cell %>
+            </th>
+          </tr>
+          <% section.metric_presenters.each do |metric| %>
+            <tr>
+              <th class="metric-title"><%= metric.title %></th>
+              <td>
+                <div><%= number_with_delimiter(metric.last_week) %></div>
+                <div><%= number_with_delimiter(metric.total) %> (total)</div>
+              </td>
+              <%= percent_change_cell(metric.last_week, metric.weeks_ago(2)) %>
+              <%= percent_change_cell(metric.last_week, metric.week_average_this_quarter) %>
+            </tr>
+          <% end %>
+        <% end %>
+      <% end %>
+    </table>
+  </body>
+</html>

data/lib/tricle/templates/email.text.erb

@@ -0,0 +1,2 @@
+You should be seeing the HTML email.  If this seems to be in error, please file a bug:
+https://github.com/artsy/tricle/issues

data/lib/tricle/version.rb

@@ -0,0 +1,3 @@
+module Tricle
+  VERSION = "0.1.0"
+end

data/spec/app/group_test_mailer.rb

@@ -0,0 +1,14 @@
+require_relative '../../lib/tricle/mailer'
+require_relative 'test_metric'
+require_relative 'test_metric_with_long_name'
+
+class GroupTestMailer < Tricle::Mailer
+  default(to: 'recipient1@test.com', from: 'sender@test.com')
+
+  group "Test Group 1" do
+    metric TestMetric
+  end
+  group "Test Group 2" do
+    metric TestMetricWithLongName
+  end
+end

data/spec/app/list_test_mailer.rb

@@ -0,0 +1,10 @@
+require_relative '../../lib/tricle/mailer'
+require_relative 'test_metric'
+
+class ListTestMailer < Tricle::Mailer
+  default(to: 'recipient1@test.com', from: 'sender@test.com')
+
+  list TestMetric do |val|
+    sprintf('%.1f', val)
+  end
+end

data/spec/app/test_mailer.rb

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

data/spec/app/test_metric.rb

@@ -0,0 +1,39 @@
+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
+
+  def total
+    self.data_by_start_on.all_items.reduce(&:+)
+  end
+end

data/spec/app/test_metric_with_long_name.rb

@@ -0,0 +1,4 @@
+require_relative 'test_metric'
+
+class TestMetricWithLongName < TestMetric
+end

data/spec/app/uber_test_mailer.rb

@@ -0,0 +1,20 @@
+require_relative '../../lib/tricle/mailer'
+require_relative 'test_metric'
+require_relative 'test_metric_with_long_name'
+
+class UberTestMailer < Tricle::Mailer
+  default(to: 'recipient1@test.com', from: 'sender@test.com')
+
+  metric TestMetric
+
+  group "Test Group 1" do
+    metric TestMetric
+  end
+  group "Test Group 2" do
+    metric TestMetricWithLongName
+  end
+
+  list TestMetric do |val|
+    sprintf('%.1f', val)
+  end
+end