growth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6dfb52ff76c3eaf1a240204c4b4b756f1101a66
+  data.tar.gz: 6703922f42436afdf9742d0effcf6147133fa3e6
+SHA512:
+  metadata.gz: a7860472cecf90c1562f412c4efde29a0f0d3c679258496652f2a7e5a7b4cccea4473eedb5d8cb78eefd0dd83030fecc0efa8056b5a3eb8f53263be3d2e4d5e0
+  data.tar.gz: 9172015a11666bf11bf5ef6de1f47aef8d64a22a3f97e6d83f43bc8c151cb89b205661bba6ac17fa1a436e91b1b277bdd22cded0dbf37f2f97aeb8a486aa561d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Ryan Friedman
+
+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,52 @@
+# Grower
+Measure growth in your Rails models through charts and informational tables and custom views.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'growth'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Next, you need to run the install generator:
+```bash
+$ rails generate growth:install
+```
+
+Running the install generator does two things:
+
+1. Mounts the stats engine at '/stats' by adding to your routes.rb
+
+```ruby
+Rails.application.routes.draw do
+  mount Growth::Engine, at: "/stats"
+end
+```
+
+2. Creates an initializer at '/config/initalizers/growth.rb'
+
+```ruby
+Growth.models_to_measure = ApplicationRecord.descendants.map { |model| model.to_s }
+```
+
+```Growth.models_to_measure ``` takes an array of models as strings, ex. ["Posts", "Users", "Comments"], that you'd like to measure.  The default measures all models.
+
+```Growth.model_blacklist``` takes an array of models as strings, ex. ["AdminUsers"], that you want to prevent the gem from measuring.
+
+```Growth.username ``` is your username for http_basic_auth
+```Growth.password``` is your password for http_basic_auth
+
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+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    = 'Growth'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/growth_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/growth .js
+//= link_directory ../stylesheets/growth .css

data/app/assets/images/growth/baseline-trending_down-24px.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
+    <path d="M16 18l2.29-2.29-4.88-4.88-4 4L2 7.41 3.41 6l6 6 4-4 6.3 6.29L22 12v6z"/>
+    <path d="M0 0h24v24H0z" fill="none"/>
+</svg>

data/app/assets/images/growth/baseline-trending_up-24px.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
+    <path d="M16 6l2.29 2.29-4.88 4.88-4-4L2 16.59 3.41 18l6-6 4 4 6.3-6.29L22 12V6z"/>
+    <path d="M0 0h24v24H0z" fill="none"/>
+</svg>

data/app/assets/javascripts/growth/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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/growth/application.scss

@@ -0,0 +1,2 @@
+@import "sidebar";
+@import "stats";

data/app/assets/stylesheets/growth/sidebar.scss

@@ -0,0 +1,51 @@
+.sidebar {
+  position: fixed;
+  top: 0;
+  bottom: 0;
+  left: 0;
+  z-index: 100;
+  padding: 0 0 48px 0;
+  box-shadow: inset -1px 0 0 rgba(0, 0, 0, .1);
+}
+
+.sidebar-sticky {
+  position: relative;
+  top: 0;
+  height: calc(100vh - 48px);
+  padding-top: .5rem;
+  overflow-x: hidden;
+  overflow-y: auto;
+}
+
+.sidebar-sticky {
+  position: -webkit-sticky;
+  position: sticky;
+}
+
+.flex-column {
+  -ms-flex-direction: column!important;
+  flex-direction: column!important;
+}
+
+.bg-purple {
+	background-color: #282952;
+	box-shadow: 4px 0 8px 0 rgba(0, 0, 0, 0.1); 
+}
+
+.bg-blue {
+	background-color: #0b7ef4;
+	box-shadow: 4px 0 8px 0 rgba(0, 0, 0, 0.1); 
+}
+
+.nav-link, .logo {
+	color: #FFF;
+}
+
+.nav-item:hover {
+	background-color: #499df4;
+	border-right: 2px solid #fff;
+}
+
+.nav-item:hover a {
+	color: #FFF;
+}

data/app/assets/stylesheets/growth/stats.scss

@@ -0,0 +1,52 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+.increase {
+	color: #2ecc71;
+	background-color: #e8f5e9;
+	display: inline;
+	padding: 8px;
+	border-radius: 10em;
+	font-size: 16px;
+}
+
+.decrease {
+	color: #e74c3c;
+	background-color: #ffebee;
+	display: inline;
+	padding: 8px;
+	border-radius: 10em;
+	font-size: 16px;
+}
+
+.growth {
+	.blue-text {
+		color: #74A9F8;
+	}
+}
+
+.box {
+	border: 1px solid #DDD;
+	border-radius: 5px;
+	padding: 20px;
+	background-color: #FFF;
+	
+	h6, p, b {
+		color: #72777a;
+	}
+}
+
+.table {
+	background-color: #FFF !important;
+	border-radius: 5px;
+}
+
+body {
+	background-color: rgb(249, 250, 251) !important;
+}
+
+.child-resource {
+	text-decoration: underline;
+}

data/app/controllers/growth/application_controller.rb

@@ -0,0 +1,7 @@
+module Growth
+  class ApplicationController < ActionController::Base
+    http_basic_authenticate_with name: Growth.username, password: Growth.password unless Rails.env.test?
+
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/growth/stats_controller.rb

@@ -0,0 +1,72 @@
+require 'csv'
+
+require_dependency "growth/application_controller"
+require_dependency "growth/transactions/generate_retention_report"
+
+module Growth
+  class StatsController < ApplicationController
+    def index
+      resources = Growth.models_to_measure
+
+      render :index, locals: {year: get_year, resources: resources}
+    end
+
+    def show
+      resource = params[:id].camelize
+
+      respond_to do |format|
+        format.html do
+          Growth::Transactions::GenerateRetentionReport.new.call(associations: params['association']) do |m|
+            m.success do |result|
+              render :show, locals: {resource: resource, report: result[:report]}
+            end
+
+            m.failure do |result|
+              render :show, locals: {resource: resource, report: result[:report]}
+            end
+          end
+        end
+
+        format.csv do
+          source_resources_count = params[:source_resources_count].to_i
+          target_resources_count = params[:target_resources_count].to_i
+
+          Growth::Transactions::GenerateRetentionReport.new.call(associations: params['association']) do |m|
+            m.success do |result|
+              stats = result[:report][:resources_stats].find do |stats|
+                stats[:total_source_resources] == source_resources_count
+                stats[:total_target_resources] == target_resources_count
+              end
+
+              resources = resource.constantize.find(stats[:total_source_resources_ids])
+
+              send_data to_csv(resources), filename: "#{resource.pluralize}-#{Date.today}.csv"
+            end
+
+            m.failure do |result|
+              raise 'failed to export csv'
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def get_year
+      params[:year].present? ? params[:year].to_i : Date.current.year
+    end
+
+    def to_csv(resources)
+      attributes = %w{email}
+
+      CSV.generate(headers: true) do |csv|
+        csv << attributes
+
+        resources.each do |user|
+          csv << attributes.map{ |attr| user.send(attr) }
+        end
+      end
+    end
+  end
+end

data/app/helpers/growth/application_helper.rb

@@ -0,0 +1,111 @@
+module Growth
+  module ApplicationHelper
+    def get_grouped_options(resources)
+      resources.map do |model|
+        [
+            model,
+            model.reflect_on_all_associations(:has_many).map do |reflection|
+              name = reflection.name.to_s.singularize.camelize
+              [name, "#{model}-#{name}"]
+            end
+        ]
+      end
+    end
+
+    def counts(grouped_models)
+      counts = {}
+      grouped_models&.count&.each do |key, value|
+        counts.has_key?(value) ? counts[value] += 1 : counts[value] = 1
+      end
+
+      counts
+    end
+
+    def group_resource_by_month(resource, year)
+      from, to = Date.parse("#{year.to_i - 1}-12-01"), Date.parse("#{year}-12-31")
+      grouped_resource_by_month = resource
+                                      .unscoped
+                                      .group_by_month(:created_at, range: from..to)
+                                      .count
+
+      map_grouped_resource(grouped_resource_by_month, 1.month)
+    end
+
+    def group_resource_by_year(resource, resources)
+      from = Date.parse("#{years_since_first_resource(resources).first}-01-01")
+      to = Date.parse("#{years_since_first_resource(resources).last}-12-31")
+
+      grouped_resource_by_year = resource.unscoped.group_by_year(:created_at, range: from..to).count
+      map_grouped_resource(grouped_resource_by_year, 1.year)
+    end
+
+    def growth_today(resource)
+      resource.constantize.where(created_at: Time.current.beginning_of_day..Time.current.end_of_day).count
+    end
+    
+    def growth_month(resource)
+      resource.constantize.where(created_at: Date.current.beginning_of_month..Date.current.end_of_month).count
+    end
+    
+    def growth_year_to_date(resource)
+      resource.constantize.unscoped.where('extract(year from created_at) = ?', Date.current.year).count
+    end
+
+    def years_since_first_resource(resources)
+      return @years if defined? @years
+
+      mapped_resources = resources.map do |resource|
+        resource.unscoped.order(:created_at).first
+      end.compact.map(&:created_at).sort
+
+      @years = mapped_resources.empty? ? [Date.current.year] : (mapped_resources.first.to_date.year..Date.current.year).to_a
+    end
+    
+    def pluralize_constant(count = nil, constant)
+      return constant.to_s.pluralize if count == nil
+      return pluralize(count, constant.to_s)
+    end
+    
+    private
+
+    def percentage_to_string(percentage)
+      return percentage if percentage == '-'
+      return '0%' if percentage == 0
+      percentage > 0 ? "+#{percentage}%" : "#{percentage}%"
+    end
+
+    def growth_css_class(growth)
+      return '' if growth == 0 || growth == '-'
+      growth > 0 ? 'increase' : 'decrease'
+    end
+
+    def map_grouped_resource(grouped_resource, interval)
+      grouped_resource.each do |date, count|
+        percentage = get_change_in_percentage(grouped_resource[date - interval].try(:fetch, :count), count)
+
+        grouped_resource[date] = {
+            count: count,
+            growth: percentage_to_string(percentage),
+            css: growth_css_class(percentage)
+        }
+      end
+    end
+
+    def get_change_in_percentage(previous_value, current_value)
+      return 0 if previous_value == current_value
+      return '-' if previous_value.nil? || previous_value == 0
+
+      if current_value > previous_value
+        increase = current_value - previous_value
+        increase_in_percentage = (increase / previous_value.to_f) * 100
+        
+        increase_in_percentage.round(2)
+      else
+        decrease = previous_value - current_value
+        decrease_in_percentage = (decrease / previous_value.to_f) * 100
+        
+        -decrease_in_percentage.round(2)
+      end
+    end
+  end
+end

data/app/views/growth/stats/_associations.html.erb

@@ -0,0 +1,14 @@
+<h5 class="my-4">Associations</h5>
+
+<%= form_tag '/growth/stats', method: :get, class: 'mb-5' do %>
+	<div class="row">
+		<div class="col-md-2">
+    	<%= select_tag 'association-select', grouped_options_for_select(get_grouped_options(resources), nil, prompt: 'Select model'), class: "form-control" %>
+		</div>
+		<div class="col-md-1">
+			<%= submit_tag("Submit", class: "btn btn-primary") %>
+		</div>
+	</div>
+<% end %>
+
+<%= render "report", report: report %>

data/app/views/growth/stats/_growth.html.erb

@@ -0,0 +1,75 @@
+<h5 class="my-4 blue-text">MoM Growth</h5>
+
+<%= form_tag '/growth/stats', method: :get do %>
+	<div class="row">
+		<div class="col-md-2">
+  		<%= select_tag 'year', options_for_select((2014..Date.current.year).to_a, year), class: "form-control" %>
+		</div>
+		<div class="col-md-1">
+			<%= submit_tag("Submit", class: "btn btn-primary") %>
+		</div>
+	</div>
+<% end %>
+
+<div class="row mt-2">
+	<div class="col-md-12">
+		<table class="table table-bordered">
+		  <tr>
+		    <th></th>
+		    <th>January</th>
+		    <th>February</th>
+		    <th>March</th>
+		    <th>April</th>
+		    <th>May</th>
+		    <th>June</th>
+		    <th>July</th>
+		    <th>August</th>
+		    <th>September</th>
+		    <th>October</th>
+		    <th>November</th>
+		    <th>December</th>
+		  </tr>
+		  <% resources.each do |resource| %>
+		    <tr>
+		      <td><b><%= pluralize_constant(resource) %></b></td>
+					
+          <% group_resource_by_month(resource, year).each do |date, stats| %>
+            <% if date.year == year %>
+              <td>
+                <p><%= stats[:count] %></p>
+                <p class="<%= stats[:css] %>"><%= stats[:growth] %></p>
+              </td>
+            <% end %>
+          <% end %>
+		    </tr>
+		  <% end %>
+		</table>
+	</div>
+</div>
+
+<h5 class="my-4 blue-text">YoY Growth</h5>
+
+<div class="row mt-2">
+  <div class="col-md-12">
+    <table class="table table-bordered">
+      <tr>
+        <th></th>
+        <% years_since_first_resource(resources).each do |year| %>
+          <th><%= year %></th>
+        <% end %>
+      </tr>
+      <% resources.each do |resource| %>
+        <tr>
+          <td><b><%= pluralize_constant(resource) %></b></td>
+
+          <% group_resource_by_year(resource, resources).each do |date, stats| %>
+            <td>
+              <p><%= stats[:count] %></p>
+              <p class="<%= stats[:css] %>"><%= stats[:growth] %></p>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    </table>
+  </div>
+</div>

data/app/views/growth/stats/_report.html.erb

@@ -0,0 +1,24 @@
+<% if report[:resources_stats].any? %>
+  <div class="mt-2">
+    <p><%= pluralize_constant(report[:source_resource]).capitalize %> that have <%= pluralize_constant(report[:target_resource]) %>: <%= report[:total_associated_resources] %></p>
+    <p>Total <%= pluralize_constant(report[:target_resource]) %> created: <%= report[:total_target_resources] %></p>
+
+    <% report[:resources_stats].each do |stats| %>
+      <p>
+        <b><%= pluralize_constant(stats[:total_source_resources], report[:source_resource]) %></b> 
+				have <b><%= pluralize(stats[:total_target_resources], report[:target_resource].to_s.downcase) %> (<%= stats[:total_source_resources_percentage] %>% 
+					of <%= pluralize_constant(report[:source_resource]).capitalize %>)
+        </b>
+        <% if report[:source_resource].has_attribute? :email %>
+          <%= link_to 'export emails to csv', stat_path(report[:source_resource],
+                                                        format: 'csv',
+                                                        association: "#{report[:source_resource]}-#{report[:target_resource]}",
+                                                        source_resources_count: stats[:total_source_resources],
+                                                        target_resources_count: stats[:total_target_resources]),
+                      class: 'ml-3'
+          %>
+        <% end %>
+      </p>
+    <% end %>
+  </div>
+<% end %>

data/app/views/growth/stats/_sidebar.html.erb

@@ -0,0 +1,14 @@
+<div class="sidebar-sticky">
+	<ul class="nav flex-column">
+		<li class="nav-link">
+			<%= link_to root_path do %>
+			  <h3 class="logo"><b>Growth</b>Engine</h3>
+			<% end %>
+		</li>
+    <% resources.each do |resource| %>
+      <li class="nav-item">
+				<%= link_to resource.to_s.pluralize, stat_path(resource.to_s.camelize(:lower)), class: 'nav-link' %>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/app/views/growth/stats/_totals.html.erb

@@ -0,0 +1,12 @@
+<h5 class="my-4 blue-text">Totals</h5>
+
+<div class="row">
+  <% resources.each do |resource| %>
+		<div class="col-md-2">
+			<div class="box">
+				<p><%= pluralize_constant(resource) %></p>
+				<h4><%= number_with_delimiter(resource.count, delimiter: ",") %></h4>
+			</div>
+		</div>
+	<% end %>
+</div>

data/app/views/growth/stats/index.html.erb

@@ -0,0 +1,2 @@
+<%= render "totals", resources: resources %>
+<%= render "growth", resources: resources, year: year %>

data/app/views/growth/stats/show.html.erb

@@ -0,0 +1,36 @@
+<h4 class="my-4"><%= resource.pluralize %></h4>
+
+<div class="row">
+	<div class="col-md-2">
+		<div class="box">
+			<h6>Today</h6>
+			<h2><%= number_with_delimiter(growth_today(resource), delimiter: ",") %></h2>
+		</div>
+	</div>
+	<div class="col-md-2">
+		<div class="box">
+			<h6>This Month</h6>
+			<h2><%= number_with_delimiter(growth_month(resource), delimiter: ",") %></h2>
+		</div>
+	</div>
+	<div class="col-md-2">
+		<div class="box">
+			<h6>Year to date</h6>
+			<h2><%= number_with_delimiter(growth_year_to_date(resource), delimiter: ",") %></h2>
+		</div>
+	</div>
+</div>
+
+<h4 class="my-4">Associations</h4>
+
+<div class="row">
+	<div class="col-md-12">
+    <% resource.constantize.reflect_on_all_associations(:has_many).map do |reflection| %>
+     	<span class="mr-3">
+				<%= link_to reflection.name.to_s.singularize.camelize, stat_path(resource, association: "#{resource}-#{reflection.name.to_s.singularize.camelize}"), class: 'child-resource' %>
+			</span>
+		<% end %>
+	
+		<%= render "report", report: report %>
+	</div>
+</div>

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

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Growth</title>
+  <%= stylesheet_link_tag "growth/application", media: "all" %>
+  <%= javascript_include_tag "growth/application" %>
+	
+	<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
+	
+	<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js" integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q" crossorigin="anonymous"></script>
+	<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
+	
+  <%= csrf_meta_tags %>
+</head>
+<body class="growth">
+	<div class="container-fluid">
+		<div class="row">
+			<div class="col-md-2 d-none d-md-block bg-blue sidebar px-0">
+				<%= render "sidebar", resources: Growth.models_to_measure %>
+			</div>
+			<div class="col-md-10 pl-3">
+				<%= yield %>
+			</div>
+		</div>
+	</div>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Growth::Engine.routes.draw do
+  root to: 'stats#index'
+  
+  resources :stats, only: [:index, :show]
+end

data/lib/generators/growth/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators/base'
+require 'securerandom'
+
+module Growth
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates the growth.rb initializer and adds '/stats' routes to your application."
+
+      def copy_initializer
+        template "growth.rb", "config/initializers/growth.rb"
+      end
+      
+      def setup_routes
+        route 'mount Growth::Engine, at: "/growth"'
+      end
+    end
+  end
+end

data/lib/generators/templates/growth.rb

@@ -0,0 +1,23 @@
+Growth.setup do |config|      
+  # Default: Measures all models.
+  # models_to_measure takes an array of Rails models, for example:
+  #
+  # Growth.models_to_measure = [User, Product, Order, Payment]
+  
+  # Default: Prevent specific models from being measured
+  # model_blacklist takes an array of Rails models, for example:
+  #
+  # Growth.model_blacklist = [AdminUser]
+  
+  # This is your username for securing the '/stats' URL
+  # You will be prompted to enter this when viewing the page
+  # This value would be better stored in an environment variabe
+  #
+  # Growth.username = ENV['growth_username']
+  
+  # This is your password for securing the /stats page
+  # You will be prompted to enter this when viewing the page
+  # This value would be better stored in an environment variabe
+  #
+  # Growth.password = ENV['growth_password']
+end

data/lib/growth.rb

@@ -0,0 +1,19 @@
+require "growth/engine"
+
+module Growth    
+  mattr_accessor :username
+  mattr_accessor :password
+
+  mattr_accessor :model_blacklist
+  @@model_blacklist = []
+
+  mattr_writer :models_to_measure
+
+  def self.models_to_measure
+    @@models_to_measure ||= ::ActiveRecord::Base.descendants.map(&:name) - ::ActiveRecord::Base.send(:subclasses).map(&:name)
+  end
+  
+  def self.setup
+    yield if block_given?
+  end
+end

data/lib/growth/engine.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "pry"
+require "dry-transaction"
+
+module Growth
+  class Engine < ::Rails::Engine
+    isolate_namespace Growth 
+  end
+end

data/lib/growth/operations/retention_report/generate.rb

@@ -0,0 +1,42 @@
+module Growth
+  module Operations
+    module RetentionReport
+      class Generate
+        include Dry::Transaction::Operation
+
+        def call(input)
+          report = []
+          input[:grouped_resources_count].each do |count, source_resources_ids|
+            report.push(
+                {
+                    total_source_resources_percentage: calculate_percentage(source_resources_ids.count, input[:resources_distinct_count]),
+                    total_source_resources: source_resources_ids.count,
+                    total_target_resources: count,
+                    total_source_resources_ids: source_resources_ids.sort
+                }
+            )
+          end
+
+          Success(
+              {
+                  report: {
+                      source_resource: input[:source_resource],
+                      target_resource: input[:target_resource],
+                      total_associated_resources: input[:resources_distinct_count],
+                      total_target_resources: input[:target_resource].count,
+                      resources_stats: report
+                  }
+              }
+          )
+        end
+
+        private
+
+        def calculate_percentage(number, total)
+          ((number.to_f / total.to_f) * 100).round(2)
+        end
+      end
+    end
+  end
+end
+

data/lib/growth/operations/retention_report/prepare.rb

@@ -0,0 +1,33 @@
+module Growth
+  module Operations
+    module RetentionReport
+      class Prepare
+        include Dry::Transaction::Operation
+
+        def call(input)
+          begin
+            source_resource, target_resource = input[:associations].split('-').map(&:constantize)
+            resources = source_resource.unscoped.joins(target_resource.to_s.pluralize.underscore.to_sym)
+            grouped_resources = resources.group(:id).order("#{target_resource.to_s.pluralize.underscore}.count ASC")
+
+            Success({
+                source_resource: source_resource,
+                target_resource: target_resource,
+                grouped_resources_count: invert(grouped_resources.count),
+                resources_distinct_count: resources.distinct.count
+            })
+          rescue => e
+            Failure({report: {resources_stats: []}, error: e})
+          end
+        end
+
+        private
+
+        def invert(hash)
+          hash.each_with_object({}) {|(k, v), o| (o[v] ||= []) << k}
+        end
+      end
+    end
+  end
+end
+

data/lib/growth/operations/retention_report/validate.rb

@@ -0,0 +1,18 @@
+module Growth
+  module Operations
+    module RetentionReport
+      class Validate
+        include Dry::Transaction::Operation
+
+        def call(input)
+          if input[:associations].blank?
+            Failure({report: {resources_stats: []}})
+          else
+            Success(input)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/growth/system/container.rb

@@ -0,0 +1,31 @@
+require "dry/transaction/operation"
+
+require_relative '../operations/retention_report/validate'
+require_relative '../operations/retention_report/prepare'
+require_relative '../operations/retention_report/generate'
+
+module Growth
+  module System
+    class Container
+      extend Dry::Container::Mixin
+
+      namespace "growth" do
+        namespace "operations" do
+          namespace "retention_report" do
+            register "validate" do
+              Growth::Operations::RetentionReport::Validate.new
+            end
+
+            register "prepare" do
+              Growth::Operations::RetentionReport::Prepare.new
+            end
+
+            register "generate" do
+              Growth::Operations::RetentionReport::Generate.new
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/growth/transactions/generate_retention_report.rb

@@ -0,0 +1,13 @@
+require_relative '../system/container'
+
+module Growth
+  module Transactions
+    class GenerateRetentionReport
+      include Dry::Transaction(container: Growth::System::Container)
+
+      step :validate, with: "growth.operations.retention_report.validate"
+      step :prepare, with: "growth.operations.retention_report.prepare"
+      step :generate, with: "growth.operations.retention_report.generate"
+    end
+  end
+end

data/lib/growth/version.rb

@@ -0,0 +1,3 @@
+module Growth
+  VERSION = '0.1.0'
+end

data/lib/tasks/growth_tasks.rake

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

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: growth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Friedman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-transaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: groupdate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+description: Make what you measure and get beatiful charts and statistics about your
+  Rails application
+email:
+- ryan@soundtribe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/growth_manifest.js
+- app/assets/images/growth/baseline-trending_down-24px.svg
+- app/assets/images/growth/baseline-trending_up-24px.svg
+- app/assets/javascripts/growth/application.js
+- app/assets/stylesheets/growth/application.scss
+- app/assets/stylesheets/growth/sidebar.scss
+- app/assets/stylesheets/growth/stats.scss
+- app/controllers/growth/application_controller.rb
+- app/controllers/growth/stats_controller.rb
+- app/helpers/growth/application_helper.rb
+- app/views/growth/stats/_associations.html.erb
+- app/views/growth/stats/_growth.html.erb
+- app/views/growth/stats/_report.html.erb
+- app/views/growth/stats/_sidebar.html.erb
+- app/views/growth/stats/_totals.html.erb
+- app/views/growth/stats/index.html.erb
+- app/views/growth/stats/show.html.erb
+- app/views/layouts/growth/application.html.erb
+- config/routes.rb
+- lib/generators/growth/install_generator.rb
+- lib/generators/templates/growth.rb
+- lib/growth.rb
+- lib/growth/engine.rb
+- lib/growth/operations/retention_report/generate.rb
+- lib/growth/operations/retention_report/prepare.rb
+- lib/growth/operations/retention_report/validate.rb
+- lib/growth/system/container.rb
+- lib/growth/transactions/generate_retention_report.rb
+- lib/growth/version.rb
+- lib/tasks/growth_tasks.rake
+homepage: http://vibrantlight.co
+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.14
+signing_key: 
+specification_version: 4
+summary: Monitor the growth of your Rails database
+test_files: []