totalizer 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89db1d11fe08b6b477c7fc209ddb24f7537aec4e
-  data.tar.gz: fcd8cb2f3df52526a4c759c4e993792f79296fa2
+  metadata.gz: 4168eb566d3334c9710a3f461640552537773c8f
+  data.tar.gz: 40691a8c784e3d4ab21e40bb2321545dd9333b3f
 SHA512:
-  metadata.gz: ec66b19d81c43e9fa88adab5f90b475fb4937f93f358048a194fc7bd177b413e303675a7256bf1135305c91dcd944701dc7d5846706eee3c060517e394aef022
-  data.tar.gz: 7bf3ff04481892b39383f66a06f7b06e01b1b8c67fd9041d3b0d289b5d3194402ea34370eee77da8d37941f0f8b1916e87d256615f4c4b9972f88a8b9e767385
+  metadata.gz: 19fa70b6a453e6d137cebb9da4da276f16e4d5c6a50c730afb96928852a0dccc9a49484710d079f70df51a3d3202692f020aeaa841f2c7c49500071706cc3737
+  data.tar.gz: c3ed4b77d762ff54cf27b97c108e93be3d00eca03d3b8f5e8a4067c5fd60136fd8ea7d9f77310c754f27861187aa247df41fa16d1c7026e0e42cf0dc53fee251

data/README.md

@@ -1,8 +1,8 @@
-# Totalizer - Calculate and share important metrics in your Rails application.
+# Totalizer - Calculate and share product and engagement metrics in your Rails application.
 
-Totalizer makes it easy for Ruby on Rails developers to report on Acquisition, Activation, Activity, Engagement, Retention and Churn.
+Totalizer makes it easy for Ruby on Rails developers to report on Product and Engagement metrics.
 
-By defining two key metrics, Growth and Key Activity, all five reports can be generated.
+By defining three metrics, Growth, Vanity and Key Activity, you can generate reports on Acquisition, Activity, Vanity, Activation, Engagement, Retention and Churn.
 
 Metrics are only worthwhile if your team sees them so Totalizer includes notifiers for Slack and email.
 
@@ -28,6 +28,7 @@ You need to define your Growth Metric and Key Activity Metric in order to use To
 # config/initializers/totalizer.rb
 
 Totalizer.growth_metric = Totalizer::Metric.new model: User
+Totalizer.vanity_metric = Totalizer::Metric.new model: Post
 Totalizer.activity_metric = Totalizer::Metric.new model: Post, map: 'user_id'
 ```
 
@@ -139,20 +140,21 @@ This will generate the following report:
 
 ```
 Acquisition
-  Yesterday: 20 (∆ 10%)
-  Last 7 days: 100 (∆ 7%)
   Signed up this period (with rate of change)
+  Yesterday: 20 (∆ 10%)
+Vanity
+  Total this period (with rate of change)
+  Yesterday: 15 (∆ 5%)
 Activity
-  Yesterday: 60 (∆ 9%)
-  Last 7 days: 120 (∆ 8%)
   Key activities this period (with rate of change)
+  Yesterday: 60 (∆ 9%)
 ```
 
 ### Weekly
 
-Every week it’s important to review your important metrics to ensure you are trending in the right direction.
+Every week it's important to review your important metrics to ensure you are trending in the right direction.
 
-Totalizer generates your Activation, Engagement, Retention and Churn for the previous week and previous month.
+Totalizer generates your Acquisition, Vanity, Activity, Activation, Engagement, Retention and Churn for the previous week and previous month.
 
 ```
 $ rake totalizer:weekly
@@ -161,6 +163,18 @@ $ rake totalizer:weekly
 This will generate the following report:
 
 ```
+Acquisition
+  Signed up this period (with rate of change)
+  Last 7 days: 77 (∆ 7%)
+  Last 30 days: 444 (∆ 10%)
+Vanity
+  Total this period (with rate of change)
+  Last 7 days: 92 (∆ 4%)
+  Last 30 days: 412 (∆ 5%)
+Activity
+  Key activities this period (with rate of change)
+  Last 7 days: 120 (∆ 8%)
+  Last 30 days: 250 (∆ 6%)
 Activation
   Created this period and did key activity
   Last 7 days: 77 → 58 (75.32%)
@@ -179,6 +193,18 @@ Churn
   Last 30 days: 3.29% (34/1032)
 ```
 
+To change the descriptions for each metric you can add the following to your
+initializer:
+
+```ruby
+Totalizer.descriptions.acquisition = "New users"
+Totalizer.descriptions.vanity = "Posts created"
+Totalizer.descriptions.activity = "Users who created post"
+Totalizer.descriptions.engagement = "Existing users who created post"
+Totalizer.descriptions.retention = "Existing user who created post again"
+Totalizer.descriptions.churn = "Existing user who did not do key activity"
+```
+
 ### Combined
 
 You can also run a single rake task every day which will run execute the daily
@@ -198,7 +224,7 @@ To change the week day add the following line to your initializer:
 Totalizer.weekly_day = 0 #(0-6, Sunday is zero)
 ```
 
-***
+---
 
 In addition to Metric, you can also use the following underlying objects.
 

data/lib/tasks/totalizer.rake

@@ -2,13 +2,15 @@ namespace :totalizer do
   task validate: :environment do
     abort '! Growth metric not defined. Please define your growth metric before running this task. See https://github.com/micdijkstra/totalizer' unless Totalizer.growth_metric
     abort '! Activity metric not defined. Please define your growth metric before running this task. See https://github.com/micdijkstra/totalizer' unless Totalizer.activity_metric
+    abort '! Vanity metric not defined. Please define your vanity metric before running this task. See https://github.com/micdijkstra/totalizer' unless Totalizer.vanity_metric
   end
 
   task daily: :validate do
     Totalizer.logger.info "Totalizer: Daily"
     messages = {
-      acquisition: [Totalizer.generate(:acquisition, 1), Totalizer.generate(:acquisition, 7)],
-      activity: [Totalizer.generate(:activity, 1), Totalizer.generate(:activity, 7)],
+      acquisition: [Totalizer.generate(:acquisition, 1)],
+      vanity: [Totalizer.generate(:vanity, 1)],
+      activity: [Totalizer.generate(:activity, 1)],
     }
     Totalizer.notify messages
   end
@@ -16,6 +18,9 @@ namespace :totalizer do
   task weekly: :validate do
     Totalizer.logger.info "Totalizer: Weekly"
     messages = {
+      acquisition: [Totalizer.generate(:acquisition, 7), Totalizer.generate(:acquisition, 30)],
+      vanity: [Totalizer.generate(:vanity, 7), Totalizer.generate(:vanity, 30)],
+      activity: [Totalizer.generate(:activity, 7), Totalizer.generate(:activity, 30)],
       activation: [Totalizer.generate(:activation, 7), Totalizer.generate(:activation, 30)],
       engagement: [Totalizer.generate(:engagement, 7), Totalizer.generate(:engagement, 30)],
       retention: [Totalizer.generate(:retention, 7), Totalizer.generate(:retention, 30)],
@@ -25,7 +30,10 @@ namespace :totalizer do
   end
 
   task combined: :validate do
-    Rake::Task["totalizer:daily"].invoke
-    Rake::Task["totalizer:weekly"].invoke if DateTime.now.wday == Totalizer.weekly_day
+    if DateTime.now.wday == Totalizer.weekly_day
+      Rake::Task["totalizer:weekly"].invoke
+    else
+      Rake::Task["totalizer:daily"].invoke
+    end
   end
 end

data/lib/totalizer/base.rb

@@ -3,6 +3,16 @@ module Totalizer
   NOTIFIERS = { log: 'Totalizer::LogNotifier', action_mailer: 'Totalizer::ActionMailerNotifier', mandrill_mailer: 'Totalizer::MandrillMailerNotifier', slack: 'Totalizer::SlackNotifier' }
   attr_reader :growth_metric, :activity_metric
 
+  def descriptions
+    @descriptions ||= OpenStruct.new acquisition: "Signed up this period (with rate of change)",
+      vanity: "Total this period (with rate of change)",
+      activity: "Did key activity this period (with rate of change)",
+      activation: "Created this period and did key activity",
+      engagement: "Created before this period and did key activity this period",
+      retention: "Did key activity the previous period and again this period",
+      churn: "Did key activity last period but not this period over the total who did key activity last period plus new users"
+  end
+
   def growth_metric= metric
     @growth_metric = validate_metric(metric)
   end

data/lib/totalizer/factory.rb

@@ -1,10 +1,11 @@
 module Totalizer
   class Factory
-    attr_accessor :growth_metric, :activity_metric, :date, :duration
+    attr_accessor :growth_metric, :activity_metric, :vanity_metric, :date, :duration
 
-    def initialize growth_metric, activity_metric, params={}
+    def initialize growth_metric, activity_metric, vanity_metric, params={}
       self.growth_metric = growth_metric
       self.activity_metric = activity_metric
+      self.vanity_metric = vanity_metric
       self.date = params[:date] || DateTime.now.change(hour: 0)
       self.duration = params[:duration] || 7
       validate_attributes!
@@ -15,6 +16,11 @@ module Totalizer
       AcqusitionMessage.new(growth_metric, duration)
     end
 
+    def vanity
+      vanity_metric = Totalizer::Metric.new self.vanity_metric.attributes.merge(date: date, duration: duration)
+      VanityMessage.new(vanity_metric, duration)
+    end
+
     def activation
       growth_metric = Totalizer::Metric.new self.growth_metric.attributes.merge(date: date, duration: duration)
       activity_metric = Totalizer::Metric.new self.activity_metric.attributes.merge(date: date, duration: duration)
@@ -52,6 +58,7 @@ module Totalizer
     def validate_attributes!
       raise Errors::InvalidMetric unless growth_metric.kind_of?(Totalizer::Metric)
       raise Errors::InvalidMetric unless activity_metric.kind_of?(Totalizer::Metric)
+      raise Errors::InvalidMetric unless vanity_metric.kind_of?(Totalizer::Metric)
       raise Errors::InvalidDate unless date.kind_of?(DateTime)
       raise Errors::InvalidDuration unless duration.kind_of?(Integer)
     end

data/lib/totalizer/message.rb

@@ -18,21 +18,28 @@ module Totalizer
   class MetricMessage < Message
     def initialize metric, duration
       self.duration = duration
-      self.text = "#{period_string}: #{metric.value} (∆ #{percentage_string(metric.rate)})"
+      self.text = "#{period_string}: #{metric.value} (∆ #{percentage_string(metric.rate)} | Σ #{metric.finish})"
     end
   end
 
   class AcqusitionMessage < MetricMessage
     def initialize metric, duration
       super
-      self.description = "Signed up this period (with rate of change)"
+      self.description = Totalizer.descriptions.acquisition
+    end
+  end
+
+  class VanityMessage < MetricMessage
+    def initialize metric, duration
+      super
+      self.description = Totalizer.descriptions.vanity
     end
   end
 
   class ActivityMessage < MetricMessage
     def initialize metric, duration
       super
-      self.description = "Did key activity this period (with rate of change)"
+      self.description = Totalizer.descriptions.activity
     end
   end
 
@@ -40,7 +47,7 @@ module Totalizer
     def initialize step, duration
       self.duration = duration
       self.text = "#{period_string}: #{step.start} → #{step.finish} (#{percentage_string(step.rate)})"
-      self.description = "Created this period and did key activity"
+      self.description = Totalizer.descriptions.activation
     end
   end
 
@@ -50,7 +57,7 @@ module Totalizer
 
       existing_active = (growth_metric.start_ids & activity_metric.ids).size
       self.text = "#{period_string}: #{percentage_string existing_active.to_f / growth_metric.start.to_f} (#{existing_active}/#{growth_metric.start})"
-      self.description = "Created before this period and did key activity this period"
+      self.description = Totalizer.descriptions.engagement
     end
   end
 
@@ -58,7 +65,7 @@ module Totalizer
     def initialize step, duration
       self.duration = duration
       self.text = "#{period_string}: #{percentage_string(step.rate)} (#{step.finish}/#{step.start})"
-      self.description = "Did key activity the previous period and again this period"
+      self.description = Totalizer.descriptions.retention
     end
   end
 
@@ -70,7 +77,7 @@ module Totalizer
       lost_existing = (previous_activity_metric.ids - this_activity_metc.ids).size
       final = new_and_existing - lost_existing
       self.text = "#{period_string}: #{percentage_string lost_existing.to_f / new_and_existing.to_f} (#{lost_existing}/#{new_and_existing})"
-      self.description = "Did key activity last period but not this period over the total who did key activity last period plus new users"
+      self.description = Totalizer.descriptions.churn
     end
   end
 end

data/lib/totalizer/version.rb

@@ -1,3 +1,3 @@
 module Totalizer
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/lib/totalizer/factory_spec.rb

@@ -3,29 +3,34 @@ require 'spec_helper'
 describe Totalizer::Factory do
   let(:growth_metric) { Totalizer::Metric.new model: User }
   let(:activity_metric) { Totalizer::Metric.new model: Post, map: 'user_id' }
+  let(:vanity_metric) { Totalizer::Metric.new model: Post }
   let(:duration) { nil }
   let(:date) { nil }
-  let(:factory) { Totalizer::Factory.new growth_metric, activity_metric, date: date }
+  let(:factory) { Totalizer::Factory.new growth_metric, activity_metric, vanity_metric, date: date }
 
   describe "Validate" do
     it "requires metrics" do
-      expect{ Totalizer::Factory.new('fake', 'metric') }.to raise_exception(Totalizer::Errors::InvalidMetric)
+      expect{ Totalizer::Factory.new('fake', 'metric', 'here') }.to raise_exception(Totalizer::Errors::InvalidMetric)
     end
 
     it "requires activity metric" do
-      expect{ Totalizer::Factory.new(growth_metric, 'metric') }.to raise_exception(Totalizer::Errors::InvalidMetric)
+      expect{ Totalizer::Factory.new(growth_metric, 'metric', vanity_metric) }.to raise_exception(Totalizer::Errors::InvalidMetric)
     end
 
     it "requires growth metric" do
-      expect{ Totalizer::Factory.new('fake', activity_metric) }.to raise_exception(Totalizer::Errors::InvalidMetric)
+      expect{ Totalizer::Factory.new('fake', activity_metric, vanity_metric) }.to raise_exception(Totalizer::Errors::InvalidMetric)
+    end
+
+    it "requires vanity metric" do
+      expect{ Totalizer::Factory.new(growth_metric, activity_metric, 'here') }.to raise_exception(Totalizer::Errors::InvalidMetric)
     end
 
     it "requires a valid datetime" do
-      expect{ Totalizer::Factory.new(growth_metric, activity_metric, date: 'Whenever') }.to raise_exception(Totalizer::Errors::InvalidDate)
+      expect{ Totalizer::Factory.new(growth_metric, activity_metric, vanity_metric, date: 'Whenever') }.to raise_exception(Totalizer::Errors::InvalidDate)
     end
 
     it "requires a duration" do
-      expect{ Totalizer::Factory.new(growth_metric, activity_metric, duration: 'Whatever') }.to raise_exception(Totalizer::Errors::InvalidDuration)
+      expect{ Totalizer::Factory.new(growth_metric, activity_metric, vanity_metric, duration: 'Whatever') }.to raise_exception(Totalizer::Errors::InvalidDuration)
     end
   end
 
@@ -37,6 +42,17 @@ describe Totalizer::Factory do
     it "defaults to 7 day acquisition duration" do
       expect(factory.duration).to eq 7
     end
+
+    it "defaults description text" do
+      expect(factory.vanity.description).to eq "Total this period (with rate of change)"
+    end
+
+    it "overrides description text" do
+      original = Totalizer.descriptions.vanity
+      Totalizer.descriptions.vanity = "Sites created"
+      expect(factory.vanity.description).to eq "Sites created"
+      Totalizer.descriptions.vanity = original
+    end
   end
 
   describe "Calculate" do
@@ -58,13 +74,19 @@ describe Totalizer::Factory do
 
     describe "Acquisition" do
       it "returns text" do
-        expect(factory.acquisition.text).to eq "Last 7 days: 2 (∆ 50%)"
+        expect(factory.acquisition.text).to eq "Last 7 days: 2 (∆ 50% | Σ 6)"
+      end
+    end
+
+    describe "Vanity" do
+      it "returns text" do
+        expect(factory.vanity.text).to eq "Last 7 days: 2 (∆ 50% | Σ 6)"
       end
     end
 
     describe "Activity" do
       it "returns text" do
-        expect(factory.activity.text).to eq "Last 7 days: 2 (∆ 25%)"
+        expect(factory.activity.text).to eq "Last 7 days: 2 (∆ 25% | Σ 5)"
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: totalizer
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Michael Dijkstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler