lookout-ahoy 0.1.0

data/app/views/lookout/roots/show.html.erb

@@ -0,0 +1,191 @@
+<main class='w-screen	overflow-hidden' data-action="combobox:init@window->application#comboboxInit">
+  <script id="tile-loader-template" type="template/html">
+    <%= render '/lookout/layouts/shared/tile_loader' %>
+  </script>
+  <%= render Lookout::StickyNavComponent.new do |nav| %>
+    <% nav.with_realtime_update do %>
+      <%= turbo_frame_tag :realtime, src: realtime_path, data: { controller:  "realtime", "realtime-interval-value" => Lookout.config.realtime_interval.to_i }, loading: :lazy %>
+    <% end %>
+  <% end %>
+
+  <div class="grid grid-cols-1 lg:grid-cols-2 grid-flow-row gap-4 min-h-screen pb-4 max-w-6xl mx-auto">
+    <%= render Lookout::TileComponent.new(wide: true, classes: "p-4 m-2") do |component| %>
+      <% component.with_statistic_display do %>
+        <%= turbo_frame_tag :stats, src: stats_path(search_params), loading: :lazy, skeleton: false do %>
+          <div class="grid grid-cols-1 divide-y divide-base-200 overflow-hidden rounded-lg grid-cols-2 md:grid-cols-6 md:divide-y-0">
+            <% 6.times do %>
+              <div class="relative px-4 md:px-6 w-1/2 my-4 w-auto group cursor-pointer" >
+                <div role="status" class="max-w-sm animate-pulse opacity-40">
+                  <div class="h-2 bg-gray-100 rounded-full dark:bg-gray-800 max-w-[120px] mb-2.5"></div>
+                  <div class="h-2 bg-gray-100 rounded-full dark:bg-gray-800 mb-2.5 max-w-[60px]"></div>
+                </div>
+              </div>
+            <% end %>
+          </div>
+        <% end %>
+        <%= turbo_frame_tag :chart, src: stats_unique_visitors_path(search_params) do %>
+          <div role="status" class="p-4 animate-pulse opacity-30 md:p-6">
+            <div class="flex items-baseline mt-4 space-x-6">
+              <div class="w-full bg-gray-100 rounded-t-lg h-72 dark:bg-gray-800"></div>
+              <div class="w-full h-56 bg-gray-100 rounded-t-lg dark:bg-gray-800"></div>
+              <div class="w-full bg-gray-100 rounded-t-lg h-72 dark:bg-gray-800"></div>
+              <div class="w-full h-64 bg-gray-100 rounded-t-lg dark:bg-gray-800"></div>
+              <div class="w-full bg-gray-100 rounded-t-lg h-80 dark:bg-gray-800"></div>
+              <div class="w-full bg-gray-100 rounded-t-lg h-72 dark:bg-gray-800"></div>
+              <div class="w-full bg-gray-100 rounded-t-lg h-80 dark:bg-gray-800"></div>
+            </div>
+            <span class="sr-only">Loading...</span>
+          </div>
+        <% end %>
+      <% end %>
+
+    <% end %>
+
+    <%= render Lookout::TileComponent.new(title: 'Top Sources') do |component| %>
+      <% component.with_display_links do  %>
+        <div class="flex text-xs font-medium text-gray-400 space-x-2">
+          <div class="relative inline-block text-left">
+            <%= component.link_to "All", sources_path(search_params), data: { turbo_frame: "sources" } %>
+            <%= render Lookout::DropdownLinkComponent.new(title: "Campaign") do |dropdown| %>
+              <% %w{utm_source utm_medium utm_term utm_content utm_campaign}.each do |source| %>
+                <%= dropdown.link_to source.titleize.gsub("Utm", "UTM"), public_send("campaign_#{source}_path".to_sym, **search_params), data: { turbo_frame: "sources" } %>
+              <% end %>
+            <% end %>
+          </div>
+        </div>
+
+
+      <% end %>
+      <% component.with_statistic_display do %>
+        <%= turbo_frame_tag :sources, src: sources_path(search_params), loading: :lazy do %>
+          <%= render '/lookout/layouts/shared/tile_loader' %>
+        <% end %>
+      <% end %>
+      <% component.with_details_cta do %>
+        <button data-action="click->details-modal#openModal" data-controller="details-modal" data-details-modal-target-value="#sources" class="no-underline text-xs text-gray-400 font-normal hover:text-gray-500">Details</button>
+      <% end %>
+    <% end %>
+
+    <%= render Lookout::TileComponent.new(title: 'Top Pages') do |component| %>
+      <% component.with_display_links do %>
+        <div class="flex text-xs font-medium text-gray-400 space-x-2">
+          <div class="relative inline-block text-left"><div>
+            <%= component.link_to "Top Pages", top_pages_path(search_params), data: { action: "click->tile#setTitle", turbo_frame: "pages" } %>
+            <%= component.link_to "Entry Pages", entry_pages_path(search_params), data: { action: "click->tile#setTitle", turbo_frame: "pages" } %>
+            <%= component.link_to "Exit Pages", exit_pages_path(search_params), data: { action: "click->tile#setTitle", turbo_frame: "pages" } %>
+          </div>
+          </div>
+        </div>
+
+      <% end %>
+      <% component.with_statistic_display do %>
+        <%= turbo_frame_tag :pages, src: top_pages_path(search_params), loading: :lazy do %>
+          <%= render '/lookout/layouts/shared/tile_loader' %>
+        <% end %>
+      <% end %>
+      <% component.with_details_cta do %>
+        <button data-action="click->details-modal#openModal" data-controller="details-modal"  data-details-modal-target-value="#pages" class="no-underline text-xs text-gray-400 font-normal hover:text-gray-500">Details</button>
+      <% end %>
+    <% end %>
+
+    <%= render Lookout::TileComponent.new(title: 'Map') do |component| %>
+      <% component.with_display_links do %>
+        <div class="flex text-xs font-medium text-gray-400 space-x-2">
+          <div class="relative inline-block text-left">
+            <%= component.link_to "Map", locations_map_path(search_params), data: { action: "click->tile#setTitle", turbo_frame: "geography" } %>
+            <%= component.link_to "Countries", locations_countries_path(search_params), data: { action: "click->tile#setTitle", turbo_frame: "geography" } %>
+            <%= component.link_to "Regions", locations_regions_path(search_params), data: { action: "click->tile#setTitle", turbo_frame: "geography" } %>
+            <%= component.link_to "Cities", locations_cities_path(search_params), data: { action: "click->tile#setTitle", turbo_frame: "geography" } %>
+          </div>
+        </div>
+      <% end %>
+      <% component.with_statistic_display do %>
+        <%= turbo_frame_tag :geography, src: locations_map_path(search_params), loading: :lazy do %>
+          <%= render '/lookout/layouts/shared/tile_loader' %>
+
+        <% end %>
+      <% end %>
+      <% component.with_details_cta do %>
+        <button data-action="click->details-modal#openModal" data-controller="details-modal" data-details-modal-target-value="#geography" class="no-underline text-xs text-gray-400 font-normal hover:text-gray-500">Details</button>
+      <% end %>
+    <% end %>
+
+    <%= render Lookout::TileComponent.new(title: 'Devices') do |component| %>
+      <% component.with_display_links do %>
+        <div class="flex text-xs font-medium text-gray-400 space-x-2">
+          <div class="relative inline-block text-left">
+            <%= component.link_to "Browser", devices_browsers_path(search_params), data: { turbo_frame: "devices" } %>
+            <%= component.link_to "OS", devices_operating_systems_path(search_params), data: { turbo_frame: "devices" } %>
+            <%= component.link_to "Size", devices_device_types_path(search_params), data: { turbo_frame: "devices" } %>
+          </div>
+        </div>
+      <% end %>
+      <% component.with_statistic_display do %>
+        <%= turbo_frame_tag :devices, src: devices_browsers_path(search_params), loading: :lazy do %>
+          <%= render '/lookout/layouts/shared/tile_loader' %>
+
+        <% end %>
+      <% end %>
+      <% component.with_details_cta do %>
+        <button data-action="click->details-modal#openModal" data-controller="details-modal" data-details-modal-target-value="#devices" class="no-underline text-xs text-gray-400 font-normal hover:text-gray-500">Details</button>
+      <% end %>
+    <% end %>
+    <%= render Lookout::TileComponent.new(title: "Funnels", wide: true, classes: "p-4 m-2") do |component| %>
+      <% component.with_display_links do %>
+        <div>
+          <div >
+            <div class="flex text-xs font-medium text-gray-400 space-x-2">
+              <div class="relative inline-block text-left">
+                <a href="<%= goals_path(search_params) %>" data-turbo-frame="goals" class="inline-block h-5 font-semibold" data-controller="frame-link" data-action="click->tile#setTitle">Goals</a>
+                <a href="<%= properties_path(search_params) %>" data-turbo-frame="goals" class="inline-block h-5 font-semibold" data-controller="frame-link" data-action="click->tile#setTitle">Properties</a>
+                <div class="dropdown dropdown-end inline-block" data-controller='dropdown-label'>
+                  <label
+                    tabindex="0"
+                    class="cursor-pointer inline-block h-5 font-semibold"
+                    data-action='click->dropdown-label#removeHidden'
+                    data-funnel-dropdown-label
+                    data-turbo-frame="goals"
+                    >
+                    <span data-dropdown-label-target="label">Funnels</span>
+                  </label>
+                  <ul class="dropdown-content z-[1] menu p-2 shadow bg-base-100 rounded-box w-52" data-dropdown-label-target="close">
+                    <% Lookout.config.funnels.each do |id, funnel| %>
+                      <li data-action="click->dropdown-label#setLabel">
+                        <a href="<%= funnel_path(id, search_params) %>" data-turbo-frame="goals" class="link" data-action="click->tile#setTitle" data-funnel-link title="<%= funnel.title %>">
+                          <%= funnel.title %>
+                        </a>
+                      </li>
+                    <% end %>
+                  </ul>
+                </div>
+              </div>
+            </div>
+
+          </div>
+        </div>
+      <% end %>
+      <% component.with_statistic_display do %>
+        <div class="pl-4 pb-4">
+          <%= turbo_frame_tag :goals, src: goals_path(search_params), loading: :lazy do %>
+            <%= render '/lookout/layouts/shared/tile_loader' %>
+          <% end %>
+
+        </div>
+      <% end %>
+      <% component.with_details_cta do %>
+        <button data-action="click->details-modal#openModal" data-controller="details-modal" data-details-modal-target-value="#goals" class="no-underline text-xs text-gray-400 font-normal hover:text-gray-500">Details</button>
+      <% end %>
+    <% end %>
+  </div>
+</main>
+
+<%= render 'lookout/roots/filters' %>
+
+<dialog id="detailsModal" class="modal">
+  <div class="modal-box w-11/12 max-w-5xl">
+    <%= turbo_frame_tag :details %>
+  </div>
+  <form method="dialog" class="modal-backdrop">
+    <button>close</button>
+  </form>
+</dialog>

data/app/views/lookout/sources/index.html+details.erb

@@ -0,0 +1,4 @@
+<%= turbo_frame_tag :details do %>
+  <%= render Lookout::TableComponent.new(items: @sources, category_name: 'Sources', unit_name: 'Visitors') %>
+  <span class="flex justify-center"><%= render_pagination %></span>
+<% end %>

data/app/views/lookout/sources/index.html.erb

@@ -0,0 +1,3 @@
+<%= turbo_frame_tag :sources do %>
+  <%= render Lookout::TableComponent.new(items: @sources, category_name: 'Sources', unit_name: 'Visitors') %>
+<% end %>

data/app/views/lookout/stats/base/index.html.erb

@@ -0,0 +1,40 @@
+<%= turbo_frame_tag :chart do %>
+  <div class="p-4">
+    <div class="flex justify-end gap-3 items-center ">
+      <a href="<%= export_path(request.query_parameters) %>" class="link text-sm" target="_blank" data-turbo-frame="false">Download</a>
+      <%= form_with url: url_for(params.permit!), method: :get, data: { controller: "interval" } do %>
+        <%= select_tag :interval, options_for_select(available_intervals.collect { |interval| [interval.titleize, interval] }, selected: selected_interval), class: "select text-accent select-sm w-full max-w-sm", 'data-action': "change->interval#handleChange" %>
+      <% end %>
+    </div>
+    <div>
+      <canvas id="overlay" width="600" height="400" style="position:absolute;pointer-events:none;"></canvas>
+
+      <% if compare_mode? %>
+        <canvas class="h-[300px] w-full"
+                data-controller="line-chart"
+                data-line-chart-label-value="<%= @label %>"
+                data-line-chart-interval-value="<%= selected_interval %>"
+                data-line-chart-current-value="<%= @stats.current.to_json %>"
+                data-line-chart-comparison-value="<%= params[:comparison] %>"
+                data-line-chart-compared-to-value="<%= @stats.compared_to.to_json %>"
+                data-line-chart-metric-value="<%= metric_type(@stats) %>"
+                data-action="resize@window->line-chart#resize"
+                data-action="mouseenter->line-chart#hover"
+                data-action="mouseleave->line-chart#hover"
+        ></canvas>
+      <% else %>
+        <canvas class="h-[300px] w-full"
+                data-controller="line-chart"
+                data-line-chart-label-value="<%= @label %>"
+                data-line-chart-interval-value="<%= selected_interval %>"
+                data-line-chart-current-value="<%= @stats.to_json %>"
+                data-line-chart-metric-value="<%= metric_type(@stats) %>"
+                data-action="resize@window->line-chart#resize"
+                data-action="mouseenter->line-chart#hover"
+                data-action="mouseleave->line-chart#hover"
+        ></canvas>
+      <% end %>
+    </div>
+  </div>
+
+<% end %>

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

@@ -0,0 +1,15 @@
+<%= turbo_frame_tag :stats, data: { controller: "active-frame-link" } do %>
+  <div class="grid grid-cols-1 divide-y divide-base-200 overflow-hidden rounded-lg grid-cols-2 md:grid-cols-6 md:divide-y-0" data-controller="active-links" data-active-links-classes-value='["text-primary"]'>
+    <% if @presenter.send(:range).realtime? %>
+      <%= render stats_container(@presenter.unique_visitors, stats_unique_visitors_url(search_params), "Unique Visits (30 min)", :number_with_delimiter, true) %>
+      <%= render stats_container(@presenter.total_pageviews, stats_total_pageviews_path(search_params), "Total Pageviews (30 min)", :number_with_delimiter) %>
+    <% else %>
+      <%= render stats_container(@presenter.unique_visitors, stats_unique_visitors_url(search_params), "Unique Visits", :number_with_delimiter, true) %>
+      <%= render stats_container(@presenter.total_visits, stats_total_visits_path(search_params), "Total Visits", :number_with_delimiter) %>
+      <%= render stats_container(@presenter.total_pageviews, stats_total_pageviews_path(search_params), "Total Pageviews", :number_with_delimiter) %>
+      <%= render stats_container(@presenter.views_per_visit, stats_views_per_visits_path(search_params), "Views per Visit", :number_with_delimiter) %>
+      <%= render stats_container(@presenter.bounce_rate, stats_bounce_rates_path(search_params), "Bounce Rate", :number_with_delimiter) %>
+      <%= render stats_container(@presenter.visit_duration, stats_visit_durations_url(search_params), "Visit Duration", :number_to_duration) %>
+    <% end %>
+  </div>
+<% end %>

data/app/views/lookout/top_pages/index.html+details.erb

@@ -0,0 +1,4 @@
+<%= turbo_frame_tag :details do %>
+  <%= render Lookout::TableComponent.new(items: @pages, category_name: 'Page', unit_name: 'Visitors') %>
+  <span class="flex justify-center"><%= render_pagination %></span>
+<% end %>

data/app/views/lookout/top_pages/index.html.erb

@@ -0,0 +1,3 @@
+<%= turbo_frame_tag :pages do %>
+  <%= render Lookout::TableComponent.new(items: @pages, category_name: 'Page', unit_name: 'Visitors') %>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,69 @@
+Lookout::Engine.routes.draw do
+  root to: 'roots#show'
+  %w{utm_source utm_medium utm_term utm_content utm_campaign}.each do |utm|
+    get "campaigns/#{utm}" => "campaigns#index", defaults: { campaigns_type: utm }, as: "campaign_#{utm}"
+  end
+
+  {
+    browsers: :browser,
+    operating_systems: :os,
+    device_types: :device_type
+  }.each do |k,v|
+    get "/devices/#{k}" => 'devices#index', defaults: { devices_type: v }, as: "devices_#{k}"
+  end
+
+  namespace :locations do
+    resource :map, only: [:show]
+    resources :countries, only: [:index]
+    resources :regions, only: [:index]
+    resources :cities, only: [:index]
+  end
+
+  resources :properties, only: [:index, :show]
+  resource :export, only: [:show]
+  resource :realtime, only: [:show]
+  resources :funnels, only: [:show]
+  resources :goals, only: [:index]
+  resource :stats, only: [:show]
+  resources :campaigns, only: [:index]
+  resources :sources, only: [:index]
+  resources :exit_pages, only: [:index]
+  resources :top_pages, only: [:index]
+  resources :entry_pages, only: [:index]
+
+  namespace :stats do
+    resources :unique_visitors, only: [:index]
+    resources :total_visits, only: [:index]
+    resources :total_pageviews, only: [:index]
+    resources :views_per_visits, only: [:index]
+    resources :bounce_rates, only: [:index]
+    resources :visit_durations, only: [:index]
+  end
+  namespace :filters do
+    %w{source medium term content campaign}.each do |utm|
+      get "utm/#{utm}s" => "utms#index", defaults: { type: "utm_#{utm}" }
+    end
+
+    %w{country region city}.each do |type|
+      get "locations/#{type.pluralize}" => "locations#index", defaults: { type: type }
+    end
+
+    namespace :properties do
+      resources :names, only: [:index]
+      resources :values, only: [:index]
+    end
+
+    resources :goals, only: [:index]
+    resources :sources, only: [:index]
+    resources :screens, only: [:index]
+    scope :operating_systems, module: :operating_systems do
+      resources :names, only: [:index]
+      resources :versions, only: [:index]
+    end
+    scope :pages, module: :pages do
+      resources :actions, only: [:index]
+      resources :entry_pages, only: [:index]
+      resources :exit_pages, only: [:index]
+    end
+  end
+end

data/lib/generators/lookout/install_generator.rb

@@ -0,0 +1,31 @@
+require "rails/generators"
+
+module Lookout
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.join(__dir__, "templates")
+
+      def copy_templates
+        insert_into_file ::Rails.root.join("app/models/ahoy/event.rb").to_s, "  include Lookout::Ahoy::EventMethods\n", after: "class Ahoy::Event < ApplicationRecord\n"
+        insert_into_file ::Rails.root.join("app/models/ahoy/visit.rb").to_s, "  include Lookout::Ahoy::VisitMethods\n", after: "class Ahoy::Visit < ApplicationRecord\n"
+
+        template "config.rb", "config/initializers/lookout.rb"
+
+        route "mount Lookout::Engine => '/lookout'"
+
+        # Importmap (Rails 8+): add one-liner to host app if importmap.rb exists and hasn't been configured yet
+        importmap_path = ::Rails.root.join("config/importmap.rb")
+        if File.exist?(importmap_path)
+          content = File.read(importmap_path)
+          unless content.include?("Lookout.importmap(self)")
+            append_to_file importmap_path.to_s, <<~RUBY
+
+              # Lookout (analytics dashboard)
+              Lookout.importmap(self)
+            RUBY
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/lookout/migration_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Lookout
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
+
+      def copy_templates
+        migration_template "migration.rb", "db/migrate/create_lookout_indexes.rb", migration_version: migration_version
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/lookout/templates/config.rb.tt

@@ -0,0 +1,185 @@
+Lookout.configure do |config|
+  # ==> Navigation
+  #
+  # Return path for the back link in the dashboard header
+  # Default: "/"
+  # config.return_path = "/admin"
+  
+  # Return link text (can include HTML entities)
+  # Default: "← Back"
+  # config.return_copy = "← Dashboard"
+  # config.return_copy = "⟵ Admin Panel"
+  
+  # ==> Event tracking
+  #
+  # View name
+  # The event you use to dictate if a page view occurred
+  # config.event.view_name = "$view"
+  #
+  # URL column
+  # The properties that indicate what URL was viewed. Ahoy suggested tracking the
+  # controller and action for each view by default, so we use that here.
+  # This is automatically adapted for your database (PostgreSQL or SQLite).
+  # Default configuration extracts: properties['controller'] + '#' + properties['action']
+  #
+  # If you have a `url` key in your `properties`, you can customize it:
+  # For PostgreSQL:
+  #   config.event.url_column = "properties->>'url'"
+  # For SQLite:
+  #   config.event.url_column = "JSON_EXTRACT(properties, '$.url')"
+  #
+  # URL exists
+  # A query that indicates if a view event has the correct properties for a page view.
+  # This is also automatically adapted for your database.
+  #
+  # ==> Models
+  #
+  # Ahoy::Event model
+  # config.models.event = '::Ahoy::Event'
+  #
+  # Ahoy::Visit model
+  # config.models.visit = '::Ahoy::Visit'
+  #
+  #
+  # ==> Theme
+  #
+  # https://daisyui.com/docs/themes/
+  # config.theme = "dark"
+
+  # ==> Disabled widgets
+  # Some widgets are more expensive than others. You can disable them here.
+  #
+  # Here's the list of widgets:
+  #   * sources
+  #   * campaigns.utm_medium
+  #   * campaigns.utm_source
+  #   * campaigns.utm_term
+  #   * campaigns.utm_content
+  #   * campaigns.utm_campaign
+  #   * top_pages
+  #   * entry_pages
+  #   * landing_pages
+  #   * locations.countries
+  #   * locations.regions
+  #   * locations.cities
+  #   * devices.browsers
+  #   * devices.operating_systems
+  #   * devices.device_types
+  #
+  # config.disabled_widgets = []
+
+  # ==> Time periods
+  #
+  # Defaults come from lib/lookout/period_collection.rb
+  #
+  # If you want your own entirely, first call reset.
+  # config.ranges.reset
+  #
+  # Then you can add your own.
+  # config.ranges.add :param_name, "Label", -> { [3.days.ago, Date.today] }
+  #
+  # You can also remove an existing one:
+  # config.ranges.delete(:mtd)
+  #
+  # Or add to the defaults:
+  # config.ranges.add :custom, "Custom", -> { [6.hours.ago, 2.minutes.ago] }
+  #
+  # Or overwrite the defaults:
+  # config.ranges.add :mtd, "Custom MTD", -> { [2.weeks.ago, Time.current] }
+  #
+  # And handle the default range, which will be used if no range is given:
+  # config.ranges.default = '3d'
+  #
+  # The max range if a custom range is sent
+  # config.ranges.max = 180.days
+  #
+  # Set to false to disable custom ranges
+  # config.ranges.custom = true
+  #
+  # For an interval to be considered "realtime" it must not have a secondary item in the range
+
+  # ==> Filters
+  #
+  # Defaults come from lib/lookout/filters_configuration.rb
+  #
+  # If you want your own entirely, first call reset.
+  # config.filters.reset
+  #
+  # Then you can add your own.
+  #
+  # config.filters.register "Group label" do
+  #   filter label: "Some label", column: :column_name, url: :url_for_options, predicates: [:in, :not_in], multiple: true
+  # end
+  #
+  # You can also remove an existing group:
+  #
+  # config.filters.delete("Group label")
+  #
+  # Remove a specific filter from a group:
+  #
+  # config.filters["Group label"].delete(:column_name)
+  #
+  # You can add to an existing group:
+  #
+  # config.filters["Group label"].filter label: "Some label", column: :column_name, url: :url_for_options, predicates: [:in, :not_in], multiple: true
+
+  # ==> Caching
+  # config.cache.enabled = false
+  #
+  # Cache store should be an ActiveSupport::Cache::Store instance
+  # config.cache.store = Rails.cache
+  #
+  # TTL
+  # config.cache.ttl = 1.minute
+
+  #==> Goal tracking
+  # Your mother told you to have goals. Track those goals.
+  #
+  # Basically:
+  #
+  #   config.goal :unique_id do
+  #     label "Some label here"
+  #     name "The event name you're tracking in your Ahoy::Event table"
+  #   end
+  #
+  # Real-world example:
+  #
+  #   config.goal :appointment_paid do
+  #     label "Appointment Paid"
+  #     name "$appointment.paid"
+  #   end
+  #
+  # You can also use queries:
+  #
+  #   config.goal :appointment_paid do
+  #     label "Appointment Paid"
+  #     query do
+  #       ::Ahoy::Event.where(...)
+  #     end
+  #   end
+
+  # ==> Funnels
+  # Your mother definitely didn't tell you about conversion rate.
+  # Except, you're here, so...
+  #
+  # Basically:
+  #
+  #   config.funnel :id do
+  #     label "Some label"
+  #     goal :goal_id_1
+  #     goal :goal_id_2
+  #   end
+  #
+  # Real-world example:
+  #
+  #   config.funnel :appointments do
+  #     label "Appointment Workflow"
+  #     goal :appointment_created
+  #     goal :appointment_paid
+  #   end
+  #
+  # => Realtime interval
+  # config.realtime_interval = 30.seconds
+  #
+  # How frequently the page should refresh if the interval is realtime
+end

data/lib/generators/lookout/templates/migration.rb.tt

@@ -0,0 +1,7 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_index :<%= ::Lookout.visit.table_name %>, :started_at unless index_exists?(:<%= ::Lookout.visit.table_name %>, :started_at)
+    add_index :<%= ::Lookout.event.table_name %>, :visit_id unless index_exists?(:<%= ::Lookout.event.table_name %>, :visit_id)
+    add_index :<%= ::Lookout.event.table_name %>, :time unless index_exists?(:<%= ::Lookout.event.table_name %>, :time)
+  end
+end