totalizer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 325cabe6e33e0ec8d6ff8f104b20cb50194f8ac0
+  data.tar.gz: 19e48c1f6977e45f048cfa9e4a6b9456b5d30ede
+SHA512:
+  metadata.gz: 543b8a101ff5fcacdb94703e9372b5a3f51ea0546934b677e5ff7a940ed83600e3027fa3c257a92cacefa9d4e1407c897ae3a519b1adb3e49263815738650cba
+  data.tar.gz: 7a6495f66fc42afe02c187347a5b228959e0e5e38945ed6db666f18567a52233904937b69201be7441a0b79f10a0610c840f85c886852487643bf57d14eb44e5

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in totalizer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Dijkstra
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,336 @@
+# Totalizer - Calculate important metrics in your Rails application.
+
+Provides tools to Ruby on Rails developers to create calculations for Acquisition, Activation, Engagement, Retention and Churn.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'totalizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install totalizer
+
+  
+
+*** 
+
+## Factory
+
+The Totalizer Factory makes it easy to report on Acquisition, Activation, Engagement, Retention and Churn.
+
+By defining one growth metric, like new user creation, and one key activity metric, like creating a post, you can generate all five reports.
+
+To create a Factory just use this in your Rails application:
+
+```ruby
+growth_metric = Totalizer::Metric.new(model: User)
+activity_metric = Totalizer::Metric.new(model: Project, map: 'user_id')
+factory = Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric)
+```
+
+This will return a message object for each calculation.
+
+#### Parameters
+
+You can pass the following parameters into the Factory:
+
++ `growth_metric`: (required) a Totalizer metric representing growth, usually a User model.
++ `activity_metric`: (required) a Totalizer metric representing the key activity a user should do within your application.
++ `date`: When to start measuring your records from. Must be a DateTime. Default is `now`.
++ `acquisition_duration`: Duration (in days) to measure your records. Must be an integer. Default is `7`.
++ `activation_duration`: Duration (in days) to measure your activation. Must be an integer. Default is `7`.
++ `engagement_duration`: Duration (in days) to measure your engagement. Must be an integer. Default is `7`.
++ `retention_duration`: Duration (in days) to measure your retention. Must be an integer. Default is `30`.
++ `churn_duration`: Duration (in days) to measure your churn. Must be an integer. Default is `30`.
+
+### Acquisition
+
+```ruby
+growth_metric = Totalizer::Metric.new(model: User)
+activity_metric = Totalizer::Metric.new(model: Project, map: 'user_id')
+factory = Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric)
+acquisition = factory.acquisition
+
+acquisition.title
+#=> "Acquisition"
+
+acquisition.pretext
+#=> "Signed up in the last 7 days"
+
+acquisition.text
+#=> "74 (Growth rate: 10%)"
+```
+
+### Activation
+
+```ruby
+growth_metric = Totalizer::Metric.new(model: User)
+activity_metric = Totalizer::Metric.new(model: Project, map: 'user_id')
+factory = Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric)
+activation = factory.activation
+
+activation.title
+#=> "Activation"
+
+activation.pretext
+#=> "Signed up in the last 7 days and did key activity"
+
+activation.text
+#=> "63/90  (Conversion rate: 70%)"
+```
+
+### Engagement
+
+```ruby
+growth_metric = Totalizer::Metric.new(model: User)
+activity_metric = Totalizer::Metric.new(model: Project, map: 'user_id')
+factory = Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric)
+engagement = factory.engagement
+
+engagement.title
+#=> "Engagement"
+
+retention.pretext
+#=> "Signed up more than 7 days ago and did key activity in the last 7 days"
+
+engagement.text
+#=> "42/350 (Engagement rate: 12%)"
+```
+
+### Retention
+
+```ruby
+growth_metric = Totalizer::Metric.new(model: User)
+activity_metric = Totalizer::Metric.new(model: Project, map: 'user_id')
+factory = Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric)
+retention = factory.retention
+
+retention.title
+#=> "Retention"
+
+retention.pretext
+#=> "Did key activity more than 7 days ago and again in the last 7 days"
+
+retention.text
+#=> "42/75  56%"
+```
+
+### Churn
+
+```ruby
+growth_metric = Totalizer::Metric.new(model: User)
+activity_metric = Totalizer::Metric.new(model: Project, map: 'user_id')
+factory = Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric)
+churn = factory.churn
+
+churn.title
+#=> "Churn"
+
+churn.pretext
+#=> "Acquired more than 7 days ago and did not do key activity in last 7 days over total acquired"
+
+churn.text
+#=> "33/75  44%"
+```
+
+## Make your metrics visible
+
+Metrics are only worthwhile if the team actually sees them.
+
+With the results of your Factory you can:
++ Post them to Slack
++ Send them via email
++ Create a dashboard view
+
+***
+
+You can also access the underlying objects directly.
+
+### Metric
+
+A Metric is a calculation based on one of your models for a duration of time. To create a Metric just use this in your Rails application:
+
+```ruby
+metric = Totalizer::Metric.new(model: User)
+
+metric.value
+#=> 10 (the number of records for the period)
+
+metric.start
+#=> 20 (the number of records before the period)
+
+metric.finish
+#=> 30 (the number of records at the end of the period)
+
+metric.rate
+#=> 0.5 (how much the number changed over the period)
+```
+
+##### Parameters
+
+You can pass the following parameters into the Metric:
++ `model` (required): The Rails model class that Totalizer will query.
++ `date`: When to start measuring your records. Default is `now`.
++ `duration`: Duration (in days) to measure your records from. Must be an integer. Default is `7`.
++ `filter`: Write a custom query to determine which records to use in calculation. For example to find all users who created a public response you could pass in: `filter: "is_public = true"`.
++ `map`: Which field to map records on. For example, to find unique users who did a response you could pass in: `map: 'user_id'`. Default is `id`.
+
+### Step
+
+A step allows you to easily compare two sets of ids to see who converted.
+
+To create a Funnel just use this in your Rails application:
+
+```ruby
+first_metric = Totalizer::Metric.new(model: User)
+second_metric = Totalizer::Metric.new(model: User, filter: "actions > 0")
+step = Totalizer::Step.new first_step_metric.ids, second_step_metric.ids
+
+step.start
+#=> 20 (the number of records that started the step)
+
+step.finish
+#=> 10 (the number of records that finished the step)
+
+step.rate
+#=> 0.5 (the rate that converted from start to finish)
+
+step.ids
+#=> [1,2,3,4,5,6,7,8,9,10] (the ids of the records that finished)
+```
+
+You can use the result of one step to feed into another step. Continuing on the example above, you could do the following:
+
+```ruby
+third_metric = Totalizer::Metric.new(model: User, filter: "actions > 5")
+next_step = Totalizer::Step.new step.ids, third_metric.ids
+```
+
+***
+
+## Manual Calculations
+
+You can also report on Acquisition, Activation, Retention, Engagement and Churn yourself without using a Factory.
+
+### Acquisition
+
+```ruby
+acquisition = Totalizer::Metric.new(model: User, duration: 7)
+
+acquisition.value
+#=> 7
+
+acquisition.rate
+#=> 10
+```
+
+### Activation
+
+```ruby
+sign_up = Totalizer::Metric.new(model: User, duration: 7)
+do_action = Totalizer::Metric.new(model: User, filter: "actions > 0")
+activation = Totalizer::Step.new sign_up.ids, do_action.ids
+
+activation.start
+#=> 10
+
+activation.finish
+#=> 5
+
+activation.rate
+#=> 0.5
+```
+
+### Engagement
+
+```ruby
+sign_up = Totalizer::Metric.new(model: User, duration: 7)
+do_action = Totalizer::Metric.new(model: User, filter: "actions > 0")
+
+existing_active = (sign_up.start_ids & do_action.ids).size
+#=> 14
+
+"(existing_active.to_f / sign_up.start.to_f * 100).round(0)}%"
+#=> 12%
+```
+
+### Retention
+
+```ruby
+this_week = Totalizer::Metric.new(model: Post, map: 'user_id')
+last_week = Totalizer::Metric.new(model: Post, map: 'user_id')
+retention = Totalizer::Step.new this_week.ids, last_week.ids
+
+retention.start
+#=> 14
+
+retention.finish
+#=> 7
+
+retention.rate
+#=> 0.5
+
+"#{(retention.rate * 100).round(0)}%"
+#=> 50%
+```
+
+### Churn
+
+```ruby
+acquisition = Totalizer::Metric.new(model: User, duration: 30)
+active_last_period = Totalizer::Metric.new(model: Post, map: 'user_id', duration: 30, date: 30.days.ago)
+active_this_period = Totalizer::Metric.new(model: Post, map: 'user_id', duration: 30)
+
+new_and_existing_customers = acquisition.end_value
+#=> 100
+
+lost_existing_customers = (active_last_period.ids - active_this_period.ids).size
+#=> 5
+
+lost_existing_customers.to_f / (new_and_existing_customers - lost_existing_customers).to_f
+#=> 0.04
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/micdijkstra/totalizer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Publishing
+
+1. Update the version number in `lib/totalizer/version.rb`
+2. Run `gem build totalizer.gemspec`
+3. Run `gem push totalizer-0.0.X.gem`
+
+## Licence
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Michael Dijkstra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/totalizer/errors.rb

@@ -0,0 +1,15 @@
+module Totalizer
+  module Errors
+    class InvalidData < StandardError
+    end
+
+    class InvalidModel < InvalidData
+    end
+
+    class InvalidDate < InvalidData
+    end
+
+    class InvalidDuration < InvalidData
+    end
+  end
+end

data/lib/totalizer/factory.rb

@@ -0,0 +1,81 @@
+module Totalizer
+  class Factory
+    attr_accessor :growth_metric, :activity_metric, :date, :acquisition_duration, :activation_duration, :engagement_duration, :retention_duration, :churn_duration
+
+    def initialize params
+      self.growth_metric = params[:growth_metric]
+      self.activity_metric = params[:activity_metric]
+      self.date = params[:date] || DateTime.now
+      self.acquisition_duration = params[:acquisition_duration] || 7
+      self.activation_duration = params[:activation_duration] || 7
+      self.engagement_duration = params[:engagement_duration] || 7
+      self.retention_duration = params[:retention_duration] || 30
+      self.churn_duration = params[:churn_duration] || 30
+      validate_attributes!
+    end
+
+    def acquisition
+      @acquisition ||= calculate_acquisition
+    end
+
+    def activation
+      @activation ||= calculate_activation
+    end
+
+    def engagement
+      @engagement ||= calculate_engagement
+    end
+
+    def retention
+      @retention || calculate_retention
+    end
+
+    def churn
+      @churn || calculate_churn
+    end
+
+    private
+
+    def calculate_acquisition
+      growth_metric = Totalizer::Metric.new self.growth_metric.attributes.merge(date: date, duration: acquisition_duration)
+      AcqusitionMessage.new(growth_metric, acquisition_duration)
+    end
+
+    def calculate_activation
+      growth_metric = Totalizer::Metric.new self.growth_metric.attributes.merge(date: date, duration: activation_duration)
+      activity_metric = Totalizer::Metric.new self.activity_metric.attributes.merge(date: date, duration: activation_duration)
+      step = Totalizer::Step.new growth_metric.ids, activity_metric.ids
+      ActivationMessage.new(step, activation_duration)
+    end
+
+    def calculate_engagement
+      growth_metric = Totalizer::Metric.new self.growth_metric.attributes.merge(date: date, duration: engagement_duration)
+      activity_metric = Totalizer::Metric.new self.activity_metric.attributes.merge(date: date, duration: engagement_duration)
+      EngagementMessage.new(growth_metric, activity_metric, engagement_duration)
+    end
+
+    def calculate_retention
+      previous_period = Totalizer::Metric.new self.activity_metric.attributes.merge(date: date - retention_duration.days, duration: retention_duration)
+      this_period = Totalizer::Metric.new self.activity_metric.attributes.merge(date: date, duration: retention_duration)
+      step = Totalizer::Step.new previous_period.ids, this_period.ids
+      RetentionMessage.new(step, retention_duration)
+    end
+
+    def calculate_churn
+      growth_metric = Totalizer::Metric.new self.growth_metric.attributes.merge(date: date, duration: churn_duration)
+      previous_activity_metric = Totalizer::Metric.new self.activity_metric.attributes.merge(date: date - churn_duration.days, duration: churn_duration)
+      this_activity_metc = Totalizer::Metric.new self.activity_metric.attributes.merge(date: date, duration: churn_duration)
+      ChurnMessage.new(growth_metric, previous_activity_metric, this_activity_metc, churn_duration)
+    end
+
+    def validate_attributes!
+      raise Errors::InvalidData unless growth_metric.kind_of?(Totalizer::Metric)
+      raise Errors::InvalidData unless activity_metric.kind_of?(Totalizer::Metric)
+      raise Errors::InvalidDate unless date.kind_of?(DateTime)
+      raise Errors::InvalidDuration unless acquisition_duration.kind_of?(Integer)
+      raise Errors::InvalidDuration unless activation_duration.kind_of?(Integer)
+      raise Errors::InvalidDuration unless retention_duration.kind_of?(Integer)
+      raise Errors::InvalidDuration unless churn_duration.kind_of?(Integer)
+    end
+  end
+end

data/lib/totalizer/message.rb

@@ -0,0 +1,67 @@
+module Totalizer
+  class Message
+    attr_accessor :title, :pretext, :text, :duration
+
+    def days_string
+      "#{duration if duration != 1} #{'day'.pluralize(duration)}"
+    end
+  end
+
+  class AcqusitionMessage < Message
+    def initialize growth_metric, duration
+      self.duration = duration
+      self.title = 'Acqusition'
+      self.pretext = "Signed up in the last #{days_string}"
+      self.text = "#{growth_metric.value} (Growth rate: #{(growth_metric.rate * 100).round(0)}%)"
+    end
+  end
+
+  class StepMessage < Message
+    def initialize step, duration
+      self.duration = duration
+      self.text = "#{step.finish}/#{step.start} (Conversion rate: #{(step.rate * 100).round(0)}%)"
+    end
+  end
+
+  class EngagementMessage < Message
+    def initialize growth_metric, activity_metric, duration
+      self.duration = duration
+      self.title = 'Engagement'
+
+      existing_active = (growth_metric.start_ids & activity_metric.ids).size
+
+      self.pretext = "Signed up more than #{days_string} ago and did key activity in the last #{days_string}"
+      self.text = "#{existing_active}/#{growth_metric.start} (Engagement rate: #{(existing_active.to_f / growth_metric.start.to_f * 100).round(0)}%)"
+    end
+  end
+
+  class ActivationMessage < StepMessage
+    def initialize step, duration
+      super
+      self.title = 'Activation'
+      self.pretext = "Signed up in the last #{days_string} and did key activity"
+    end
+  end
+
+  class RetentionMessage < StepMessage
+    def initialize step, duration
+      super
+      self.title = 'Retention'
+      self.pretext = "Did key activity more than #{days_string} ago and again in the last #{days_string}"
+    end
+  end
+
+  class ChurnMessage < Message
+    def initialize growth_metric, previous_activity_metric, this_activity_metc, duration
+      self.duration = duration
+      self.title = 'Churn'
+      self.pretext = "Acquired more than #{days_string} ago and did not do key activity in last #{days_string} over total acquired"
+
+      new_and_existing = growth_metric.finish
+      lost_existing = (previous_activity_metric.ids - this_activity_metc.ids).size
+      final = new_and_existing - lost_existing
+
+      self.text = "#{lost_existing}/#{new_and_existing} (Churn rate: #{(lost_existing.to_f / new_and_existing.to_f * 100).round(0)}%)"
+    end
+  end
+end

data/lib/totalizer/metric.rb

@@ -0,0 +1,66 @@
+module Totalizer
+  class Metric
+    attr_accessor :model, :date, :duration, :filter, :map, :ids, :value
+
+    def initialize params
+      self.model = params[:model]
+      self.date = params[:date] || DateTime.now
+      self.duration = params[:duration] || 7
+      self.filter = params[:filter]
+      self.map = params[:map] || 'id'
+      validate_attributes!
+    end
+
+    def attributes
+      { model: model, date: date, duration: duration, filter: filter, map: map }
+    end
+
+    def end_date
+      date
+    end
+
+    def start_date
+      date - duration.days
+    end
+
+    def ids
+      @ids ||= calculate(created_at: start_date..end_date)
+    end
+
+    def value
+      ids.size
+    end
+
+    def start_ids
+      @start_ids ||= calculate(["created_at < ?", start_date])
+    end
+
+    def start
+      start_ids.size
+    end
+
+    def finish_ids
+      @finish_ids ||= calculate(["created_at < ?", end_date])
+    end
+
+    def finish
+      finish_ids.size
+    end
+
+    def rate
+      (finish - start).to_f / start.to_f
+    end
+
+    private
+
+    def calculate where
+      model.where(filter).where(where).map { |object| object.send(map) }.uniq
+    end
+
+    def validate_attributes!
+      raise Errors::InvalidModel if model.nil?
+      raise Errors::InvalidDate unless date.kind_of?(DateTime)
+      raise Errors::InvalidDuration unless duration.kind_of?(Integer)
+    end
+  end
+end

data/lib/totalizer/step.rb

@@ -0,0 +1,37 @@
+module Totalizer
+  class Step
+    attr_accessor :start_ids, :end_ids
+
+    def initialize start_ids, end_ids
+      self.start_ids = start_ids
+      self.end_ids = end_ids
+      validate!
+    end
+
+    def rate
+      (finish.to_f/(start.to_f.nonzero? || 1)).round(2)
+    end
+
+    def ids
+      @ids ||= calculate
+    end
+
+    def start
+      start_ids.size
+    end
+
+    def finish
+      ids.size
+    end
+
+    private
+
+    def validate!
+      raise Errors::InvalidData unless start_ids.kind_of?(Array) && end_ids.kind_of?(Array)
+    end
+
+    def calculate
+      start_ids & end_ids
+    end
+  end
+end

data/lib/totalizer/version.rb

@@ -0,0 +1,3 @@
+module Totalizer
+  VERSION = "0.0.2"
+end

data/lib/totalizer.rb

@@ -0,0 +1,6 @@
+require "totalizer/version"
+require 'totalizer/errors'
+require 'totalizer/metric'
+require 'totalizer/step'
+require 'totalizer/factory'
+require 'totalizer/message'

data/spec/lib/totalizer/factory_spec.rb

@@ -0,0 +1,141 @@
+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(:duration) { nil }
+  let(:date) { nil }
+  let(:factory) { Totalizer::Factory.new growth_metric: growth_metric, activity_metric: activity_metric, date: date, retention_duration: 7, churn_duration: 7 }
+
+  describe "Validate" do
+    it "requires metrics" do
+      expect{ Totalizer::Factory.new(growth_metric: 'fake', activity_metric: 'metric') }.to raise_exception(Totalizer::Errors::InvalidData)
+    end
+
+    it "requires activity metric" do
+      expect{ Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: 'metric') }.to raise_exception(Totalizer::Errors::InvalidData)
+    end
+
+    it "requires growth metric" do
+      expect{ Totalizer::Factory.new(growth_metric: 'fake', activity_metric: activity_metric) }.to raise_exception(Totalizer::Errors::InvalidData)
+    end
+
+    it "requires a valid datetime" do
+      expect{ Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric, date: 'Whenever') }.to raise_exception(Totalizer::Errors::InvalidDate)
+    end
+
+    it "requires a acquisition duration" do
+      expect{ Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric, acquisition_duration: 'Whatever') }.to raise_exception(Totalizer::Errors::InvalidDuration)
+    end
+
+    it "requires a activation duration" do
+      expect{ Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric, activation_duration: 'Whatever') }.to raise_exception(Totalizer::Errors::InvalidDuration)
+    end
+
+    it "requires a retention duration" do
+      expect{ Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric, retention_duration: 'Whatever') }.to raise_exception(Totalizer::Errors::InvalidDuration)
+    end
+
+    it "requires a churn duration" do
+      expect{ Totalizer::Factory.new(growth_metric: growth_metric, activity_metric: activity_metric, churn_duration: 'Whatever') }.to raise_exception(Totalizer::Errors::InvalidDuration)
+    end
+  end
+
+  describe "Initialize" do
+    it "defaults to today" do
+      expect(factory.date).to eq DateTime.now
+    end
+
+    it "defaults to 7 day acquisition duration" do
+      expect(factory.acquisition_duration).to eq 7
+    end
+  end
+
+  describe "Calculate" do
+    let!(:user) { FactoryGirl.create :user, created_at: 2.days.ago }
+    let(:user_2) { FactoryGirl.create :user, created_at: 4.days.ago }
+    let(:user_3) { FactoryGirl.create :user, created_at: 8.days.ago }
+    let(:user_4) { FactoryGirl.create :user, created_at: 10.days.ago }
+    let(:user_5) { FactoryGirl.create :user, created_at: 11.days.ago }
+    let(:user_6) { FactoryGirl.create :user, created_at: 12.days.ago }
+    before do
+      user
+      FactoryGirl.create :post, user_id: user_2.id, created_at: 4.days.ago
+      FactoryGirl.create :post, user_id: user_3.id, created_at: 8.days.ago
+      FactoryGirl.create :post, user_id: user_4.id, created_at: 8.days.ago
+      FactoryGirl.create :post, user_id: user_4.id, created_at: 2.days.ago
+      FactoryGirl.create :post, user_id: user_5.id, created_at: 11.days.ago
+      FactoryGirl.create :post, user_id: user_6.id, created_at: 12.days.ago
+    end
+
+    describe "Acquisition" do
+      it "returns title" do
+        expect(factory.acquisition.title).to eq 'Acqusition'
+      end
+
+      it "returns pretext" do
+        expect(factory.acquisition.pretext).to eq 'Signed up in the last 7 days'
+      end
+
+      it "returns text" do
+        expect(factory.acquisition.text).to eq "2 (Growth rate: 50%)"
+      end
+    end
+
+    describe "Activation" do
+      it "returns title" do
+        expect(factory.activation.title).to eq 'Activation'
+      end
+
+      it "returns pretext" do
+        expect(factory.activation.pretext).to eq 'Signed up in the last 7 days and did key activity'
+      end
+
+      it "returns text" do
+        expect(factory.activation.text).to eq "1/2 (Conversion rate: 50%)"
+      end
+    end
+
+    describe "Engagement" do
+      it "returns title" do
+        expect(factory.engagement.title).to eq 'Engagement'
+      end
+
+      it "returns pretext" do
+        expect(factory.engagement.pretext).to eq 'Signed up more than 7 days ago and did key activity in the last 7 days'
+      end
+
+      it "returns text" do
+        expect(factory.engagement.text).to eq "1/4 (Engagement rate: 25%)"
+      end
+    end
+
+    describe "Retention" do
+      it "returns title" do
+        expect(factory.retention.title).to eq 'Retention'
+      end
+
+      it "returns pretext" do
+        expect(factory.retention.pretext).to eq 'Did key activity more than 7 days ago and again in the last 7 days'
+      end
+
+      it "returns text" do
+        expect(factory.retention.text).to eq "1/4 (Conversion rate: 25%)"
+      end
+    end
+
+    describe "Churn" do
+      it "returns title" do
+        expect(factory.churn.title).to eq 'Churn'
+      end
+
+      it "returns pretext" do
+        expect(factory.churn.pretext).to eq 'Acquired more than 7 days ago and did not do key activity in last 7 days over total acquired'
+      end
+
+      it "returns text" do
+        expect(factory.churn.text).to eq "3/6 (Churn rate: 50%)"
+      end
+    end
+  end
+end

data/spec/lib/totalizer/metric_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Totalizer::Metric do
+  let(:metric) { Totalizer::Metric.new(model: User) }
+
+  describe "Validate" do
+    it "requires a model" do
+      expect{ Totalizer::Metric.new(model: nil) }.to raise_exception(Totalizer::Errors::InvalidModel)
+    end
+
+    it "requires a valid datetime" do
+      expect{ Totalizer::Metric.new(model: User, date: 'Whenever') }.to raise_exception(Totalizer::Errors::InvalidDate)
+    end
+
+    it "requires a duration" do
+      expect{ Totalizer::Metric.new(model: User, duration: 'Whatever') }.to raise_exception(Totalizer::Errors::InvalidDuration)
+    end
+  end
+
+  describe "Initialize" do
+    it "defaults to today" do
+      expect(metric.date).to eq DateTime.now
+    end
+
+    it "defaults to 7 day duration" do
+      expect(metric.duration).to eq 7
+    end
+
+    it "sets the range" do
+      expect(metric.start_date).to eq DateTime.now - 7.days
+      expect(metric.end_date).to eq DateTime.now
+    end
+
+    it "defaults map to id" do
+      expect(metric.map).to eq 'id'
+    end
+  end
+
+
+  describe "Calculate" do
+    let!(:user_1) { FactoryGirl.create :user, created_at: 8.days.ago }
+    let!(:user_2) { FactoryGirl.create :user, created_at: 3.days.ago }
+    let!(:user_3) { FactoryGirl.create :user, created_at: 2.days.ago }
+
+    it "maps the ids for the duration" do
+      expect(metric.ids).to eq [user_2.id, user_3.id]
+    end
+
+    it "counts the ids for duration" do
+      expect(metric.value).to eq 2
+    end
+
+    it "maps the ids for the start" do
+      expect(metric.start_ids).to eq [user_1.id]
+    end
+
+    it "counts the ids for start" do
+      expect(metric.start).to eq 1
+    end
+
+    it "maps the ids for the end" do
+      expect(metric.finish_ids).to eq [user_1.id, user_2.id, user_3.id]
+    end
+
+    it "counts the ids for end" do
+      expect(metric.finish).to eq 3
+    end
+
+    it "calculates the rate of rate" do
+      expect(metric.rate).to eq 2
+    end
+
+    describe 'with invalid filter' do
+      let(:metric) { Totalizer::Metric.new(model: User, date: DateTime.now, duration: 7, filter: 'non_existant_field = true') }
+
+      it "requires a valid filter" do
+        expect{ metric.value }.to raise_exception(ActiveRecord::StatementInvalid)
+      end
+    end
+  end
+
+  describe "Filter" do
+    let!(:user_1) { FactoryGirl.create :user, created_at: 8.days.ago, actions: 2 }
+    let!(:user_2) { FactoryGirl.create :user, created_at: 3.days.ago, actions: 0 }
+    let!(:user_3) { FactoryGirl.create :user, created_at: 2.days.ago, actions: 2 }
+    let(:metric) { Totalizer::Metric.new(model: User, filter: "actions > 0") }
+
+    it "maps the ids for the duration" do
+      expect(metric.ids).to eq [user_3.id]
+    end
+
+    it "counts the ids for duration" do
+      expect(metric.value).to eq 1
+    end
+
+    it "maps the ids for the start" do
+      expect(metric.start_ids).to eq [user_1.id]
+    end
+
+    it "counts the ids for start" do
+      expect(metric.start).to eq 1
+    end
+
+    it "maps the ids for the end" do
+      expect(metric.finish_ids).to eq [user_1.id, user_3.id]
+    end
+
+    it "counts the ids for end" do
+      expect(metric.finish).to eq 2
+    end
+
+    it "calculates the rate of rate" do
+      expect(metric.rate).to eq 1
+    end
+  end
+end

data/spec/lib/totalizer/step_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Totalizer::Step do
+  let(:metric_1) { Totalizer::Metric.new(model: User) }
+  let(:metric_2) { Totalizer::Metric.new(model: Post, map: 'user_id') }
+
+  describe "Validate" do
+    it "requires arrays" do
+      expect{ Totalizer::Step.new('fake', 'metric') }.to raise_exception(Totalizer::Errors::InvalidData)
+    end
+
+    it "requires two arrays" do
+      expect{ Totalizer::Step.new(metric_1.ids, 'metric') }.to raise_exception(Totalizer::Errors::InvalidData)
+    end
+
+    it "requires two arrays" do
+      expect{ Totalizer::Step.new('fake', metric_2.ids) }.to raise_exception(Totalizer::Errors::InvalidData)
+    end
+  end
+
+  describe "Calculate" do
+    let(:user) { FactoryGirl.create :user, created_at: 2.days.ago }
+    let(:user_2) { FactoryGirl.create :user, created_at: 4.days.ago }
+    let(:user_3) { FactoryGirl.create :user, created_at: 8.days.ago }
+    let(:step) { Totalizer::Step.new metric_1.ids, metric_2.ids }
+    before do
+      user
+      FactoryGirl.create :post, user_id: user_2.id, created_at: 4.days.ago
+      FactoryGirl.create :post, user_id: user_3.id, created_at: 8.days.ago
+    end
+
+    it "maps the ids who finishd the step" do
+      expect(step.ids).to eq [user_2.id]
+    end
+
+    it "counts the number who start the step" do
+      expect(step.start).to eq 2
+    end
+
+    it "counts the number who finishd the step" do
+      expect(step.finish).to eq 1
+    end
+
+    it "calculates the rate from previous step" do
+      expect(step.rate).to eq 0.5
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+# 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.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+#
+#
+require 'totalizer'
+require 'active_record'
+require 'factory_girl'
+require 'database_cleaner'
+require 'timecop'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+load File.dirname(__FILE__) + '/support/schema.rb'
+require File.dirname(__FILE__) + '/support/models.rb'
+require File.dirname(__FILE__) + '/support/factories.rb'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+
+  config.include FactoryGirl::Syntax::Methods
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    Timecop.freeze(Time.local(1990))
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    Timecop.return
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/factories.rb

@@ -0,0 +1,11 @@
+# Read about factories at https://github.com/thoughtbot/factory_girl
+
+FactoryGirl.define do
+  factory :user do
+  end
+end
+
+FactoryGirl.define do
+  factory :post do
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+end
+
+class Post < ActiveRecord::Base
+end

data/spec/support/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, force: true do |t|
+    t.integer :actions
+    t.timestamps
+  end
+
+  create_table :posts, force: true do |t|
+    t.integer :user_id
+    t.timestamps
+  end
+end

data/totalizer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'totalizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "totalizer"
+  spec.version       = Totalizer::VERSION
+  spec.authors       = ["Michael Dijkstra"]
+  spec.email         = ["micdijkstra@gmail.com"]
+  spec.summary       = %q{Totalizer makes it easy to calculate important metrics in your Rails app.}
+  spec.description   = %q{Provides tools to Ruby on Rails developers to create calculations for acquisiton, activation, engagement, retention and churn.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "factory_girl_rails"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "timecop"
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: totalizer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Michael Dijkstra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: sqlite3
+  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: factory_girl_rails
+  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: database_cleaner
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides tools to Ruby on Rails developers to create calculations for
+  acquisiton, activation, engagement, retention and churn.
+email:
+- micdijkstra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/totalizer.rb
+- lib/totalizer/errors.rb
+- lib/totalizer/factory.rb
+- lib/totalizer/message.rb
+- lib/totalizer/metric.rb
+- lib/totalizer/step.rb
+- lib/totalizer/version.rb
+- spec/lib/totalizer/factory_spec.rb
+- spec/lib/totalizer/metric_spec.rb
+- spec/lib/totalizer/step_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- totalizer.gemspec
+homepage: ''
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Totalizer makes it easy to calculate important metrics in your Rails app.
+test_files:
+- spec/lib/totalizer/factory_spec.rb
+- spec/lib/totalizer/metric_spec.rb
+- spec/lib/totalizer/step_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/models.rb
+- spec/support/schema.rb