tricle 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e1bf9319ba25a271eaae97c379e62f2f6a6b68e
-  data.tar.gz: 4a515d52060d25dcae9a4f6c00c41786bf930b10
+  metadata.gz: 9ab31c91268e7d383dbc8090108459f7359d9d94
+  data.tar.gz: 2408d69e0b97e949ff16e572eece95f8ceca80c0
 SHA512:
-  metadata.gz: bc6c048e313464575809c42d0dfd56857893be868834de9b8fc3c411c05dcfe813401cd60589ba4f9a65c0d7a7cf810486a5b542a2ece34857f102cec507d040
-  data.tar.gz: 204151436a1410c2b7138dd1480f929e733a8260b4c6b1a97dc893ad6c3f3dd46f8a62ebbd7e15fa3743b608bab95c56c34e9566be0a858802205684229bdc98
+  metadata.gz: ef63f1335cb81ca70af935ae1e495b0a2f78c260f7ca7a02a232de3f059dc267b40505ff99d4f10d89fa704420154ae309f9f8ad253570321cc1e0caff5ee649
+  data.tar.gz: f2eadcb789c8caf60fa2a1446740646831898eea9f734856c03f1355844628ef46fefc3a10bd93c5e6669649a48111572571bd3a54bdb5df8e419b3999dc8145

data/Gemfile

@@ -6,8 +6,8 @@ group :development, :test do
   gem 'appraisal'
   gem 'bundler'
   gem 'byebug', platforms: :mri_20
-  gem 'guard', '~> 2.6'
   gem 'guard-rspec'
+  gem 'guard', '~> 2.6'
   gem 'rake'
   gem 'rspec', '~> 3.0'
   gem 'ruby_gntp'

data/README.md

@@ -181,6 +181,23 @@ end
 
 The subject line will be based on the Mailer class name.
 
+#### Passing options to a Metric
+
+Sometimes, you'll want to initialize a Metric with specific options. If you pass a hash as a second argument to the mailer's `metric` method, the Metric will be initialized with an `@options` instance variable.
+
+```ruby
+class IntelligenceBrief < Tricle::Mailer
+
+  metric NewUsers, matching_email: '@gmail.com'
+
+  # or for a list...
+  list NewUsers, matching_email: '@gmail.com' do |item|
+    ...
+  end
+
+end
+```
+
 ### Previewing
 
 Since you'd probably like to preview your mailers before sending them, set up the `Tricle::MailPreview` Rack app (which uses [MailView](https://github.com/37signals/mail_view)).

data/gemfiles/rails_3.gemfile

@@ -9,8 +9,8 @@ group :development, :test do
   gem "appraisal"
   gem "bundler"
   gem "byebug", :platforms => :mri_20
-  gem "guard", "~> 2.6"
   gem "guard-rspec"
+  gem "guard", "~> 2.6"
   gem "rake"
   gem "rspec", "~> 3.0"
   gem "ruby_gntp"

data/gemfiles/rails_4.gemfile

@@ -9,8 +9,8 @@ group :development, :test do
   gem "appraisal"
   gem "bundler"
   gem "byebug", :platforms => :mri_20
-  gem "guard", "~> 2.6"
   gem "guard-rspec"
+  gem "guard", "~> 2.6"
   gem "rake"
   gem "rspec", "~> 3.0"
   gem "ruby_gntp"

data/lib/tricle/aggregation.rb

@@ -4,15 +4,6 @@ module Tricle
   module Aggregation
     extend ActiveSupport::Concern
 
-    included do
-      attr_reader :now
-
-      def initialize
-        # TODO allow Time to be passed in so it can be frozen
-        @now = Time.now
-      end
-    end
-
     def days_ago(n)
       start_at = self.now.beginning_of_day.ago(n.days)
       end_at = start_at + 1.day
@@ -33,9 +24,14 @@ module Tricle
       self.weeks_ago(1)
     end
 
-    def weeks_average(past_num_weeks)
+    def weekly_values(past_num_weeks)
       weeks_range = 1..past_num_weeks
-      total = weeks_range.reduce(0){|sum, n| sum + self.weeks_ago(n) }
+      weeks_range.map{|n| self.weeks_ago(n) }
+    end
+
+    def weeks_average(past_num_weeks)
+      values = self.weekly_values(past_num_weeks)
+      total = values.reduce(0, :+)
       total.to_f / past_num_weeks
     end
 

data/lib/tricle/email_helper.rb

@@ -44,7 +44,7 @@ module Tricle
       when :higher
         (new_val >= old_val) ? 'good' : 'bad'
       when :lower
-        (new_val >= old_val) ? 'bad' : 'good'
+        (new_val > old_val) ? 'bad' : 'good'
       else
         ''
       end
@@ -87,5 +87,11 @@ module Tricle
       end_at = start_at + 7.days
       list.items_markup(start_at, end_at).html_safe
     end
+
+    def sparkline(metric)
+      values = metric.weekly_values(13)
+      attachment_url = "https://sparklines.herokuapp.com/api/v1.png?values=#{values.join(',')}"
+      image_tag(attachment_url, alt: 'sparkline').html_safe
+    end
   end
 end

data/lib/tricle/mailer.rb

@@ -53,12 +53,12 @@ module Tricle
         yield if block_given?
       end
 
-      def metric(klass)
-        self.report.add_metric(klass)
+      def metric(klass, opts = {})
+        self.report.add_metric(klass, opts)
       end
 
-      def list(klass, &block)
-        self.report.add_list(klass, &block)
+      def list(klass, opts = {}, &block)
+        self.report.add_list(klass, opts, &block)
       end
 
       def send_all

data/lib/tricle/metric.rb

@@ -7,12 +7,19 @@ module Tricle
   class Metric
     include Aggregation
 
+    attr_reader :now, :options
+
+    def initialize(opts = {})
+      @now = opts[:now] || Time.now
+      @options = opts
+    end
+
     def better
-      :higher
+      options[:better] || :higher
     end
 
     def title
-      self.class.name.titleize
+      options[:title] || self.class.name.titleize
     end
 
     def size_for_range(start_at, end_at)

data/lib/tricle/presenters/group.rb

@@ -10,8 +10,8 @@ module Tricle
         @metrics = []
       end
 
-      def add_metric(klass)
-        self.metrics << klass.new
+      def add_metric(klass, opts = {})
+        self.metrics << klass.new(opts)
       end
     end
   end

data/lib/tricle/presenters/list.rb

@@ -4,13 +4,13 @@ module Tricle
   class List < Section
     attr_reader :block, :metric
 
-    def initialize(klass, &block)
-      @metric = klass.new
+    def initialize(klass, opts = {}, &block)
+      @metric = klass.new(opts)
       @block = block
     end
 
     def title
-      self.metric.title
+      self.metric.options[:title] || self.metric.title
     end
 
     def items_markup(start_at, end_at)

data/lib/tricle/presenters/report.rb

@@ -21,18 +21,18 @@ module Tricle
         self.add_section(group)
       end
 
-      def add_metric(klass)
+      def add_metric(klass, opts = {})
         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)
+        last_section.add_metric(klass, opts)
       end
 
-      def add_list(klass, &block)
-        list = Tricle::List.new(klass, &block)
+      def add_list(klass, opts = {}, &block)
+        list = Tricle::List.new(klass, opts, &block)
         self.add_section(list)
       end
     end

data/lib/tricle/templates/email.css

@@ -28,6 +28,10 @@ td {
   border: 1px solid #c7c7c7;
 }
 
+.separator {
+  height: 10px;
+}
+
 .list-item {
   text-align: left;
 }

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

@@ -29,7 +29,7 @@
           </tr>
           <% section.metrics.each do |metric| %>
             <tr>
-              <th class="metric-title"><%= metric.title %></th>
+              <th class="metric-title" rowspan="2"><%= metric.title %></th>
               <td>
                 <div><%= format_number(metric.last_week) %></div>
                 <% if metric.total? %>
@@ -39,6 +39,12 @@
               <%= percent_change_cell(metric.last_week, metric.weeks_ago(2), metric.better) %>
               <%= percent_change_cell(metric.last_week, metric.week_average_this_quarter, metric.better) %>
             </tr>
+            <tr>
+              <td colspan="3">
+                <%= sparkline(metric) %>
+              </td>
+            </tr>
+            <tr class="separator"></tr>
           <% end %>
         <% end %>
       <% end %>

data/lib/tricle/version.rb

@@ -1,3 +1,3 @@
 module Tricle
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/app/list_test_mailer_with_options.rb

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

data/spec/app/test_metric_with_no_total.rb

@@ -5,8 +5,8 @@ require_relative '../../lib/tricle/range_data'
 class TestMetricWithNoTotal < Tricle::Metric
   attr_accessor :data_by_start_on
 
-  def initialize
-    super
+  def initialize(*args)
+    super(*args)
     self.load_data
   end
 

data/spec/presenters/group_spec.rb

@@ -12,5 +12,11 @@ describe Tricle::Presenters::Group do
       metric = group.metrics.first
       expect(metric).to be_a(TestMetric)
     end
+
+    it "should pass options to the metric" do
+      group.add_metric(TestMetric, foo: 'bar')
+      metric = group.metrics.first
+      expect(metric.instance_variable_get(:@options)[:foo]).to eq 'bar'
+    end
   end
 end

data/spec/unit/mailer_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 require_relative '../../lib/tricle/mailer'
 require_relative '../app/group_test_mailer'
 require_relative '../app/list_test_mailer'
+require_relative '../app/list_test_mailer_with_options'
 require_relative '../app/no_total_test_mailer'
 require_relative '../app/test_mailer'
 
@@ -62,12 +63,17 @@ describe Tricle::Mailer do
       expect(markup).to include('62.0')
       expect(markup).not_to include('79.0')
     end
+
+    it "should pass options" do
+      deliver(ListTestMailerWithOptions)
+      expect(markup).to include("TheNewTitle")
+    end
   end
 
   describe '.send_all' do
     it "should .deliver all defined mailers" do
       Tricle::Mailer.send_all
-      expect(ActionMailer::Base.deliveries.length).to eq(4)
+      expect(ActionMailer::Base.deliveries.length).to eq(5)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tricle
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Aidan Feldman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -133,6 +133,7 @@ files:
 - screenshot.png
 - spec/app/group_test_mailer.rb
 - spec/app/list_test_mailer.rb
+- spec/app/list_test_mailer_with_options.rb
 - spec/app/no_total_test_mailer.rb
 - spec/app/test_mailer.rb
 - spec/app/test_metric.rb
@@ -183,6 +184,7 @@ summary: A datastore-agnostic mailer where you can define custom metrics, where
 test_files:
 - spec/app/group_test_mailer.rb
 - spec/app/list_test_mailer.rb
+- spec/app/list_test_mailer_with_options.rb
 - spec/app/no_total_test_mailer.rb
 - spec/app/test_mailer.rb
 - spec/app/test_metric.rb