retention_magic 0.1beta2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 202a0352d4733122ab78e0761e9ef41d5477d13c
+  data.tar.gz: bcd0445686ed5e9bb71528a937d3e0fcc2911840
+SHA512:
+  metadata.gz: abc384b5ef612dee76e75ec282d5ffd2381ede9612e00bf5d48e215996fa9a201cd7804f760962504bcc416c2e575b9c6086a92a588d410d027dec581e24bed2
+  data.tar.gz: 80dd27806353b8d83801cd0b666f0e10929935829b88dd3e97d1c1d0d1ad69853339a2baa88f9a4bd2700f8c520a1dca318a4ec390f26148d8a27d9075b7165f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Michiel Sikkes
+
+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,70 @@
+RetentionMagic
+==============
+
+Simple cohorts analysis and retention graphs in your Rails app
+
+RetentionMagic is a drop-in gem that uses your current models and records in
+your database to generate simple cohort analysis and retention graphs for your
+app. There is no need to integrate an external service or explicitly add event
+tracking code to your controllers or views. All data stays in your app.
+
+Installation
+------------
+
+In your Gemfile:
+
+```ruby
+gem "retention_magic"
+```
+
+And run bundler:
+
+```
+$ bundle install
+```
+
+Then, generate the `config/initializers/retention_magic.rb` configuration file:
+
+```
+$ rails generate retention_magic
+```
+
+Configuration
+-------------
+
+Open `config/initializers/retention_magic.rb` and customize the sample
+configuration to your app.
+
+Then, make the RetentionMagic page available on a route in your app. For
+example, in your `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount RetentionMagic::Engine => "/retention_magic"
+
+  # your application routes
+end
+```
+
+Securing the RetentionMagic route
+--------------------------------
+
+*Devise*
+
+If you want to secure that page and your app uses Devise, you can use the following
+routing snipper:
+
+```ruby
+Rails.application.routes.draw do
+  authenticated :admin do
+    mount RetentionMagic::Engine => "/retention_magic"
+  end
+
+  # your application routes
+end
+```
+
+*Sorcery*
+
+The same can be be achieved in a similar manner with with Sorcery. Take a look
+at this Wiki page: https://github.com/NoamB/sorcery/wiki/Routes-Constraints

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RetentionMagic'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/retention_magic/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/retention_magic/graphs.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/retention_magic/application.css.scss

@@ -0,0 +1,4 @@
+@charset "utf-8";
+
+@import "bootstrap-sprockets";
+@import "bootstrap";

data/app/assets/stylesheets/retention_magic/graphs.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/retention_magic/application_controller.rb

@@ -0,0 +1,4 @@
+module RetentionMagic
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/retention_magic/graphs_controller.rb

@@ -0,0 +1,66 @@
+require_dependency "retention_magic/application_controller"
+
+module RetentionMagic
+  class GraphsController < ApplicationController
+    def index
+      # RetentionMagic configuration setup
+      @user_class = RetentionMagic.user_class.constantize
+
+
+      first_user = @user_class.order(:created_at).first
+      first_cohort = @first_user.created_at.beginning_of_month
+      today = Date.today
+
+      # For presenting the widgets
+      @first_cohort_label = first_cohort.strftime("%h %Y")
+      @current_cohort_label = today.strftime("%h %Y")
+      @number_of_months = (today.year * 12 + today.month) - (first_cohort.year * 12 + first_cohort.month)
+
+      @graphs = {
+        activation: {
+          signup_without_activation: {},
+          one_activation: {},
+          five_activations: {},
+        },
+        retention: {}
+      }
+
+      retention_models = RetentionMagic.retention_models.map { |class_name| class_name.constantize }
+      activation_fields_for_query = RetentionMagic.activation_counter_columns.join(" + ")
+
+      0.upto(@number_of_months - 1) do |month|
+        cohort_start = @first_user.created_at.beginning_of_month + month.months
+        cohort_start_end = (cohort_start + 1.month).beginning_of_month
+
+        cohort_users = @user_class.where(created_at: cohort_start..cohort_start_end)
+
+        @graphs[:activation][:signup_without_activation][cohort_start] = cohort_users.where("#{activation_fields_for_query} = 0").count
+        @graphs[:activation][:one_activation][cohort_start] = cohort_users.where("#{activation_fields_for_query} = 1").count
+        @graphs[:activation][:five_activations][cohort_start] = cohort_users.where("#{activation_fields_for_query} >= 5").count
+
+        cohort_start_label = cohort_start.strftime("%h %y")
+        @graphs[:retention][cohort_start_label] = {}
+        cohort_user_ids = cohort_users.pluck(:id)
+
+        -1.upto((Date.today.year * 12 + Date.today.month) - (cohort_start.year * 12 + cohort_start.month) - 1) do |month|
+          retention_month = (cohort_start + month.months).beginning_of_month
+          retention_month_end = (retention_month + 1.month).beginning_of_month
+
+          records_per_user = {}
+
+          retention_models.each do |model|
+            count_per_user = model.where(user_id: cohort_user_ids).where(created_at: retention_month..retention_month_end).group("user_id").count
+            count_per_user.each do |uid, count|
+              records_per_user[uid] ||= 0
+              records_per_user[uid] += count
+            end
+          end
+
+          @graphs[:retention][cohort_start_label][retention_month] = records_per_user.keys.size
+        end
+      end
+
+
+    end
+  end
+end

data/app/helpers/retention_magic/application_helper.rb

@@ -0,0 +1,4 @@
+module RetentionMagic
+  module ApplicationHelper
+  end
+end

data/app/helpers/retention_magic/graphs_helper.rb

@@ -0,0 +1,4 @@
+module RetentionMagic
+  module GraphsHelper
+  end
+end

data/app/views/layouts/retention_magic/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RetentionMagic</title>
+  <%= stylesheet_link_tag    "retention_magic/application", media: "all" %>
+  <%= javascript_include_tag "retention_magic/application" %>
+
+  <%= javascript_include_tag "//www.google.com/jsapi", "chartkick" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/retention_magic/graphs/index.html.erb

@@ -0,0 +1,89 @@
+<div class="container">
+  <div class="row">
+    <div class="col-xs-12">
+      <h1>How is your app doing?</h1>
+      <p class="lead">This page shows how your app is doing in cohorts of monthly signups. Analyzing
+        your app's usage in monthly cohorts helps you pinpoint important changes
+        to your app and or marketing strategy.</p>
+      <p class="lead">The <b>Activation</b> graph tells you how your app
+        is growing and which cohort performed the most subsequent actions in your app.<br>The
+        <b>Retention</b> graph shows you how many users stay active in your app in the months
+        after signing up.</p>
+    </div>
+  </div>
+  <div class="row">
+    <div class="col-xs-6 col-sm-3">
+      <div class="panel panel-default">
+        <div class="panel-heading">Users</div>
+        <div class="panel-body">
+          <%= @user_class.count %>
+        </div>
+      </div>
+    </div>
+    <div class="col-xs-6 col-sm-3">
+      <div class="panel panel-default">
+        <div class="panel-heading">Cohorts</div>
+        <div class="panel-body">
+          <%= @number_of_months %>
+        </div>
+      </div>
+    </div>
+    <div class="col-xs-6 col-sm-3">
+      <div class="panel panel-default">
+        <div class="panel-heading">First Cohort</div>
+        <div class="panel-body">
+          <%= @first_cohort %>
+        </div>
+      </div>
+    </div>
+    <div class="col-xs-6 col-sm-3">
+      <div class="panel panel-default">
+        <div class="panel-heading">Current Cohort</div>
+        <div class="panel-body">
+          <%= @current_cohort %>
+        </div>
+      </div>
+    </div>
+  </div>
+  <div class="row">
+    <div class="col-xs-12">
+
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <h3 class="panel-title">Activation</h3>
+      </div>
+      <div class="panel-body">
+
+    <%= area_chart(
+      [
+        {
+          name: ">= 5 interactions",
+          data: @graphs[:activation][:five_activations]
+        },
+        {
+          name: "One interaction",
+          data: @graphs[:activation][:one_activation]
+        },
+        {
+          name: "Signup without interacting",
+          data: @graphs[:activation][:signup_without_activation]
+        }], library: { legend: { position: "bottom" } } )%>
+    </div>
+  </div>
+  </div>
+  <div class="col-xs-12">
+
+  <div class="panel panel-default">
+    <div class="panel-heading">
+      <h3 class="panel-title">Retention</h3>
+    </div>
+    <div class="panel-body">
+      <%= area_chart(@graphs[:retention].map { |k,v| {name: k, data: v}}, library: { legend: { position: "bottom" } } ) %>
+
+    </div>
+  </div>
+  </div>
+
+    </div>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,3 @@
+RetentionMagic::Engine.routes.draw do
+  root to: "graphs#index"
+end

data/lib/generators/retention_magic/USAGE

@@ -0,0 +1,8 @@
+Description:
+    RetentionMagic install generator
+
+Example:
+    rails generate retention_magic
+
+    This will create config/initializers/retention_magic.rb with sample
+    configuration options for using RetentionMagic.

data/lib/generators/retention_magic/retention_magic_generator.rb

@@ -0,0 +1,7 @@
+class RetentionMagicGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer_file
+    copy_file "initializer.rb", "config/initializers/retention_magic.rb"
+  end
+end

data/lib/generators/retention_magic/templates/initializer.rb

@@ -0,0 +1,35 @@
+# This file contains the nessesary configuration options for RetentionMagic.
+
+# ==> User Class
+# The user class that is used by RetentionMagic. The records of this class
+# will be tracked and automatically devided into monthly cohort groups.
+RetentionMagic.user_class = "User"
+
+# ==> Activation Counters
+# This is a list of columns that contain counters towards a user's activation
+# actions over the total lifetime of the user.
+#
+# For example, when you have a blogging app and the number of posts someone
+# writes is an important metric for your app you would specify:
+#
+#   RetentionMagic.activation_counter_columns = [ :posts_count ]
+#
+# These column need to be present on the model you specified as user_class.
+# For example, you can use Rails counter_cache on a Post=>belongs_to=>User
+# relation to keep the posts_count column up-to-date.
+#
+RetentionMagic.activation_counter_columns = [ ]
+
+# ==> Retention Models
+# This is the list of model class names that you want to track retention for.
+# RetentionMagic will use the model's created_at column to build a retention
+# graph for your users. If you add more than one model, any of them count
+# towards the retention of your user.
+#
+# For example, when you run a blogging app or maybe a forum app and writing
+# posts and commenting on other people's post is your metric for activation,
+# you would specify:
+#
+#   RetentionMagic.retention_models = %w( Post Comment )
+#
+RetentionMagic.retention_models = %w()

data/lib/retention_magic/engine.rb

@@ -0,0 +1,12 @@
+require "chartkick"
+require "bootstrap-sass"
+
+module RetentionMagic
+  class Engine < ::Rails::Engine
+    isolate_namespace RetentionMagic
+
+    config.to_prepare do
+      ActionView::Base.send :include, Chartkick::Helper
+    end
+  end
+end

data/lib/retention_magic/version.rb

@@ -0,0 +1,3 @@
+module RetentionMagic
+  VERSION = "0.1beta2"
+end

data/lib/retention_magic.rb

@@ -0,0 +1,12 @@
+require "retention_magic/engine"
+
+module RetentionMagic
+  mattr_accessor :user_class do
+    "User"
+  end
+  mattr_accessor :activation_counter_columns do
+    []
+  mattr_accessor :retention_models do
+    []
+  end
+end

data/lib/tasks/retention_magic_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :retention_magic do
+#   # Task goes here
+# end

data/test/controllers/retention_magic/graphs_controller_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+module RetentionMagic
+  class GraphsControllerTest < ActionController::TestCase
+    setup do
+      @routes = Engine.routes
+    end
+
+    test "index" do
+      RetentionMagic.user_class = "User"
+      RetentionMagic.activation_counter_columns = [ :posts_count ]
+      RetentionMagic.retention_models = %w()
+
+      User.create!(name: "John", created_at: Date.civil(2015, 10, 1), posts_count: 10)
+
+      get :index
+
+      assert_response :success
+      assert_equal "Oct 2015", assigns(:first_cohort)
+      assert_equal User, assigns(:user_class)
+    end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/user.rb

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

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "retention_magic"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)