cohortly 0.0.1

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  namespace :cohortly do
+    match     'report_all', :controller => 'reports', :action => 'show', :as => :report_all
+    resources :metrics, :only => [:index]
+    resources :reports, :only => [:index, :show]
+  end
+end

data/lib/cohortly.rb

@@ -0,0 +1,15 @@
+require 'mongo_mapper'
+require "cohortly/config"
+require "cohortly/engine"
+require "cohortly/tag_config"
+
+MongoMapper.database = "cohortly-#{Rails.env}"
+
+require "active_support/notifications"
+
+ActiveSupport::Notifications.subscribe "cohortly.event" do |*args|
+  Cohortly::Metric.store!(args)
+end
+
+module Cohortly
+end

data/lib/cohortly/config.rb

@@ -0,0 +1,6 @@
+module Cohortly
+  class Config
+    include ActiveSupport::Configurable    
+    
+  end
+end

data/lib/cohortly/engine.rb

@@ -0,0 +1,16 @@
+module Cohortly
+  class Engine < Rails::Engine
+    initializer "read_config" do |app|
+      config_file = File.join(Rails.root, 'config', 'cohortly.yml')
+      if File.exists?(config_file)
+        Cohortly::Config.config.tap do |cfg|
+          conf = YAML.load_file(config_file)[Rails.env]
+          conf.keys.each { |k| cfg.send("#{k}=", conf[k]) }          
+          Cohortly::Metric.connection Mongo::Connection.new(cfg.host, cfg.port)
+          Cohortly::Metric.set_database_name cfg.database
+          Cohortly::Metric.database.authenticate(cfg.username, cfg.password) if(cfg.password)
+        end        
+      end
+    end
+  end
+end

data/lib/cohortly/tag_config.rb

@@ -0,0 +1,85 @@
+require 'singleton'
+module Cohortly
+  class TagConfig
+    include Singleton
+    attr_accessor :_tags, :lookup_table
+    def self.draw_tags(&block)
+      instance._tags = []
+      instance.lookup_table = {}
+      instance.instance_eval(&block)
+      instance.compile!
+      instance
+    end
+
+    def tag(tag_name, &block)
+      self._tags << Tag.new(tag_name, &block)
+    end
+
+    def tags(*args, &block)
+      args.each {|x| tag(x, &block) }
+    end
+
+    def compile!
+      self._tags.each do |tag|
+        tag._controllers.each do |cont|
+          lookup_table[cont._name] ||= {}
+          cont._acts.each do |a|
+            lookup_table[cont._name][a] ||= []
+            tag_names = lookup_table[cont._name][a] << tag._name
+            lookup_table[cont._name][a] = tag_names.uniq
+          end
+        end
+      end
+    end
+
+    def tags_for(controller, action = :_all)
+      res = []
+      if lookup_table[controller.to_sym]
+        res += lookup_table[controller.to_sym][action.to_sym] || []
+        res += lookup_table[controller.to_sym][:_all] || []
+      end
+      res.uniq.collect &:to_s
+    end
+
+    def self.tags_for(controller, action = :_all)
+      return [] if controller.nil?
+      instance.tags_for(controller, action)
+    end
+
+    def self.all_tags
+      if instance._tags
+        instance._tags.collect {|x| x._name.to_s }
+      else
+        []
+      end
+    end
+
+    class Tag
+      attr_accessor :_name, :_controllers
+      def initialize(tag_name, &block)
+        self._controllers ||= []
+        self._name = tag_name.to_sym
+        instance_eval(&block)
+      end
+      def controller(controller_name, &block)
+        _controllers << Controller.new(controller_name, &block)
+      end
+      def controllers(*args)
+        args.each { |name| controller(name) { actions :_all } }
+      end
+    end
+
+    class Controller
+      attr_accessor :_name, :_acts
+      def initialize(controller_name, &block)
+        self._acts ||= []
+        self._name = controller_name.to_sym
+        self.instance_eval(&block)
+      end
+
+      def actions(*act_names)
+        self._acts = act_names.collect &:to_sym
+      end
+    end
+  end
+end

data/lib/cohortly/version.rb

@@ -0,0 +1,3 @@
+module Cohortly
+  VERSION = "0.0.1"
+end

data/lib/tasks/run_reports.rake

@@ -0,0 +1,11 @@
+namespace :cohortly do
+  namespace :run do
+    desc "run the reports for all the tags"
+    task :reports => :environment do
+      Cohortly::Metric.cohort_chart_for_tag
+      Cohortly::TagConfig.all_tags.each do |tag|
+        Cohortly::Metric.cohort_chart_for_tag(tag)
+      end
+    end
+  end
+end

data/test/cohortly_test.rb

@@ -0,0 +1,119 @@
+require 'test_helper'
+
+
+
+
+class CohortlyTest < ActiveSupport::TestCase
+
+  test "tag config" do
+    assert_equal Cohortly::TagConfig.tags_for(:hi_there, :index), ['hello']
+    assert_equal Cohortly::TagConfig.tags_for(:see_ya, :index), []
+    assert_equal Cohortly::TagConfig.tags_for(:see_ya, :create), ['goodbye']
+    assert_equal Cohortly::TagConfig.tags_for(:hi_there, :what), []
+    assert_equal Cohortly::TagConfig.tags_for(:hi_there, :update), ['hello', 'goodbye']
+    assert_equal Cohortly::TagConfig.tags_for(:stuff, :a), ['only_good', 'only_bad']
+    assert_equal Cohortly::TagConfig.tags_for(:stuff, :b), ['only_good', 'only_bad']
+    assert_equal Cohortly::TagConfig.tags_for(:goodies, :a), ['only_good', 'only_bad']
+    assert_equal Cohortly::TagConfig.tags_for(:goodies, :b), ['only_good', 'only_bad']
+    assert_equal Cohortly::TagConfig.tags_for(:hellas, :b), ['heh', 'whoa']
+    assert_equal Cohortly::TagConfig.tags_for(:hellas, :b), ['heh', 'whoa']
+
+    assert_equal Cohortly::TagConfig.all_tags, ['hello', 'goodbye', 'only_good', 'only_bad', 'heh', 'whoa', 'over13', 'login']
+  end
+
+  test "cohortly record event" do
+
+
+    payload = { :user_start_date => Time.now - 1.month,
+                :user_id         => 5,
+                :user_email => "jordon@example.com",
+                :controller => "session",
+                :action => "login"
+                }
+
+    ActiveSupport::Notifications.instrument("cohortly.event", payload)
+
+    metric = Cohortly::Metric.first
+    assert metric,  "should create metric"
+    assert metric.created_at
+    assert metric.tags.include? 'login'
+    assert metric.tags.include? 'over13'
+    assert_equal metric.controller, 'session'
+    assert_equal metric.action, 'login'
+    assert_equal metric.user_email, 'jordon@example.com'
+    assert_equal metric.user_start_date.utc.to_s, payload[:user_start_date].utc.to_s
+
+  end
+
+  test "report map reduce" do
+    setup_data_to_report_on
+    Cohortly::Metric.cohort_chart_for_tag
+    assert_equal (Cohortly::Metric.all.collect &:user_id).uniq.length, 105
+
+    report = Cohortly::Report.new('cohort_report')
+    assert_equal report.month_to_time('2011-08'), Time.utc(2011, 8)
+    assert_equal report.time_to_month(Time.utc(2011,8)), '2011-08'
+    assert_equal report.start_month, (Time.now - 15.months).year.to_s + '-0' + (Time.now - 14.months).month.to_s
+    assert_equal report.month_cohorts.length, 15
+
+#    assert_equal report.report_line(report.month_cohorts[2]), []
+    assert_equal report.report_totals, [[14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1],
+                                        [13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1],
+                                        [12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1],
+                                        [11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1],
+                                        [10, 9, 8, 7, 6, 5, 4, 3, 2, 1],
+                                        [9, 8, 7, 6, 5, 4, 3, 2, 1],
+                                        [8, 7, 6, 5, 4, 3, 2, 1],
+                                        [7, 6, 5, 4, 3, 2, 1],
+                                        [6, 5, 4, 3, 2, 1],
+                                        [5, 4, 3, 2, 1],
+                                        [4, 3, 2, 1],
+                                        [3, 2, 1],
+                                        [2, 1],
+                                        [1],
+                                        []]
+  end
+
+  test "counting uniq users in cohort" do
+    setup_data_to_report_on
+    Cohortly::Metric.cohort_chart_for_tag
+    report = Cohortly::Report.new('cohort_report')
+    start_month = report.start_month
+    start_month_time = report.month_to_time(report.start_month)
+    next_month  = report.time_to_month(start_month_time + 1.month)
+    
+    assert_equal report.user_count_in_cohort(start_month), 14
+    assert_equal report.user_count_in_cohort(next_month), 13    
+  end
+
+  test "getting a line of percentages" do
+    setup_data_to_report_on
+    Cohortly::Metric.cohort_chart_for_tag
+    report = Cohortly::Report.new('cohort_report')
+    line = report.percent_line(report.start_month)
+    cohort_count = report.user_count_in_cohort(report.start_month)
+    assert_equal line, [cohort_count, 100, 93, 86, 79, 71, 64, 57, 50, 43, 36, 29, 21, 14, 7]
+    
+  end
+
+  def setup_data_to_report_on
+    payload = { :user_start_date => Time.now - 1.month,
+                :user_id         => 5,
+                :controller => "session",
+                :action => "login"
+                }
+    # 15 months of data
+    15.times do |start_offset|
+      start_offset.times do |m|
+        ((start_offset * 100)..((start_offset * 100) + m)).to_a.each do |user_id|
+          payload[:user_id] = user_id
+          payload[:user_start_date] = Time.now - start_offset.months
+          payload[:created_at] = Time.now - m.months
+
+          5.times { ActiveSupport::Notifications.instrument("cohortly.event", payload) }
+        end
+      end
+    end
+
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# 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__)
+require 'rake'
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,17 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  before_filter :record_event
+
+
+  protected
+
+  def record_event
+    payload = { :user_start_date => Time.now - 1.month,
+                :user_id         => 5,
+                :controller => params[:controller],
+                :action => params[:action]
+                }
+    ActiveSupport::Notifications.instrument("cohortly.event", payload)
+  end
+end

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

@@ -0,0 +1,12 @@
+class StuffController < ApplicationController
+
+  def index
+  end
+
+  def my_stuff
+  end
+
+  def your_stuff
+  end
+
+end

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

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

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

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

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

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<ul>
+  <li><%= link_to "My Stuff", '/stuff/my_stuff' %></li>
+  <li><%= link_to "Your Stuff", '/stuff/your_stuff' %></li>
+  <li><%= link_to "Metrics", cohortly_metrics_path %></li>
+  <li><%= link_to "Cohort Reports", cohortly_reports_path %></li>
+</ul>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/stuff/index.html.erb

@@ -0,0 +1 @@
+<h1>Home page</h1>

data/test/dummy/app/views/stuff/my_stuff.html.erb

@@ -0,0 +1,2 @@
+<h1>Stuff#my_stuff</h1>
+<p>Find me in app/views/stuff/my_stuff.html.erb</p>

data/test/dummy/app/views/stuff/your_stuff.html.erb

@@ -0,0 +1,2 @@
+<h1>Stuff#your_stuff</h1>
+<p>Find me in app/views/stuff/your_stuff.html.erb</p>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "cohortly"
+
+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.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # 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
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/cohortly.yml

@@ -0,0 +1,15 @@
+defaults: &defaults
+  host: localhost
+  port: 27017
+
+test:
+  <<: *defaults
+  database: cohortly-test
+
+development:
+  <<: *defaults
+  database: cohortly-development
+
+production:
+  <<: *defaults
+  database: cohortly-production

data/test/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000