ahoy_captain 0.77 → 0.82

data/app/components/ahoy_captain/table_component.html.erb

@@ -1,44 +1,11 @@
 <div class="flex flex-col min-h-[380px] w-full pt-4">
-  <div class="flex text-sm font-bold text-base-content mb-4">
-    <span class="grow"><%= category_name %></span>
-    <span ><%= unit_name %></span>
-     <% if additional_cols.include?(:percent_total) %>
-      <span class="w-8 ml-8 text-right">%</span>
-    <% end %>
-     <% if additional_cols.include?(:total) %>
-      <span class="w-8 ml-8 text-right">Total</span>
-    <% end %>
-     <% if additional_cols.include?(:conversion_rate) %>
-      <span class="w-8 ml-8 text-right">CR</span>
-    <% end %>
-  </div>
+  <%= render @header %>
   <div class='min-h-[420px]'>
     <div class="grow">
       <% if items.respond_to?(:each) && items.any? %>
         <% items.each do |item| %>
           <div class='leading-10 flex relative'>
-            <progress class='progress-primary bg-base-100 h-8 grow' value="<%= item.unit_amount %>" max="<%= max_amount %>">
-            </progress>
-            <span class="grow text-elipsis overflow-hidden absolute left-4 bottom-3 h-8 text-base-content">
-              <%= item.display_name %>
-            </span>
-            <span class="w-8 ml-8 text-right">
-              <%= render AhoyCaptain::TooltipComponent.new(amount: item.unit_amount) %>
-            </span>
-
-            <% if additional_cols.include?(:percent_total) %>
-              <span class="w-8 ml-8 text-right"><%= percent_total(item) %></span>
-            <% end %>
-            <% if additional_cols.include?(:total) %>
-              <span class="w-8 ml-8 text-right">
-                <%= render AhoyCaptain::TooltipComponent.new(amount: item.total) %>
-              </span>
-            <% end %>
-            <% if additional_cols.include?(:conversion_rate) %>
-              <span class="w-8 ml-8 text-right">
-                <%= item.conversion_rate * 100.0 %>%
-              </span>
-            <% end %>
+            <%= render_row(item) %>
           </div>
         <% end %>
       <% else %>

data/app/components/ahoy_captain/table_component.rb

@@ -1,13 +1,24 @@
 # frozen_string_literal: true
 
 class AhoyCaptain::TableComponent < ViewComponent::Base
-  SUPPORTED_COLS = [:percent_total, :total, :conversion_rate]
+  DEFAULT_HEADER = AhoyCaptain::Tables::Headers::HeaderComponent
+  DEFAULT_ROW = AhoyCaptain::Tables::Rows::RowComponent
 
-  def initialize(items:, category_name:, unit_name:, additional_cols: [])
+  def initialize(items:, category_name: nil, unit_name: nil, header: nil, row: DEFAULT_ROW)
     @items = items
     @category_name = category_name
     @unit_name = unit_name
     @additional_cols = additional_cols
+    if header.nil?
+      @header = DEFAULT_HEADER.new(category_name: category_name, unit_name: unit_name)
+    else
+      @header = header.new
+    end
+    @row = row
+  end
+
+  def render_row(item)
+    @row.new(table: self, item: item).render_in(view_context)
   end
 
   private
@@ -22,7 +33,4 @@ class AhoyCaptain::TableComponent < ViewComponent::Base
     @total ||= items.first.total_count
   end
 
-  def percent_total(item)
-    '%.1f' % ((item.unit_amount.to_i * 1.0 / total)*100.0)
-  end
 end

data/app/components/ahoy_captain/tables/headers/devices_header_component.html.erb

@@ -0,0 +1,3 @@
+<%= render ::AhoyCaptain::Tables::Headers::HeaderComponent.new(category_name: "Device", unit_name: "Visitors") do %>
+  <span class="w-8 ml-8 text-right">%</span>
+<% end %>

data/app/components/ahoy_captain/tables/headers/devices_header_component.rb

@@ -0,0 +1,9 @@
+module AhoyCaptain
+  module Tables
+    module Headers
+      class DevicesHeaderComponent < ViewComponent::Base
+
+      end
+    end
+  end
+end

data/app/components/ahoy_captain/tables/headers/goals_header_component.html.erb

@@ -0,0 +1,6 @@
+<div class="flex text-sm font-bold text-base-content mb-4">
+  <span class="grow">Goal</span>
+  <span class="w-8 ml-8 text-right">Uniques</span>
+  <span class="w-8 ml-8 text-right">Total</span>
+  <span class="w-8 ml-8 text-right">CR</span>
+</div>

data/app/components/ahoy_captain/tables/headers/goals_header_component.rb

@@ -0,0 +1,9 @@
+module AhoyCaptain
+  module Tables
+    module Headers
+      class GoalsHeaderComponent < ViewComponent::Base
+
+      end
+    end
+  end
+end

data/app/components/ahoy_captain/tables/headers/header_component.html.erb

@@ -0,0 +1,5 @@
+<div class="flex text-sm font-bold text-base-content mb-4">
+  <span class="grow"><%= @category_name %></span>
+  <span ><%= @unit_name %></span>
+  <%= content %>
+</div>

data/app/components/ahoy_captain/tables/headers/header_component.rb

@@ -0,0 +1,12 @@
+module AhoyCaptain
+  module Tables
+    module Headers
+      class HeaderComponent < ViewComponent::Base
+        def initialize(category_name:, unit_name:)
+          @category_name = category_name
+          @unit_name = unit_name
+        end
+      end
+    end
+  end
+end

data/app/components/ahoy_captain/tables/rows/devices_row_component.html.erb

@@ -0,0 +1,5 @@
+<%= progress_bar(@item.count, @item.total_count, @item.display_name) %>
+<%= item do %>
+  <%= tooltip(@item.count) %>
+<% end %>
+<%= item(percent_total(@item)) %>

data/app/components/ahoy_captain/tables/rows/devices_row_component.rb

@@ -0,0 +1,12 @@
+module AhoyCaptain
+  module Tables
+    module Rows
+      class DevicesRowComponent < RowComponent
+
+        def total
+          @item.total_count
+        end
+      end
+    end
+  end
+end

data/app/components/ahoy_captain/tables/rows/goals_row_component.html.erb

@@ -0,0 +1,11 @@
+<%= progress_bar(@item.cr, 100, @item.name) %>
+<%= item do %>
+  <%= tooltip(@item.unique_visits) %>
+<% end %>
+<%= item do %>
+  <%= tooltip(@item.total_events) %>
+<% end %>
+<%= item do %>
+  <%= tooltip(@item.cr) %>
+<% end %>
+

data/app/components/ahoy_captain/tables/rows/goals_row_component.rb

@@ -0,0 +1,12 @@
+module AhoyCaptain
+  module Tables
+    module Rows
+      class GoalsRowComponent < RowComponent
+
+        def total
+          @item.total_count
+        end
+      end
+    end
+  end
+end

data/app/components/ahoy_captain/tables/rows/row_component.html.erb

@@ -0,0 +1,6 @@
+<%= progress_bar(@item.count, @item.total_count, @item.display_name) %>
+<%=
+  item do
+    tooltip(@item.count)
+  end
+%>

data/app/components/ahoy_captain/tables/rows/row_component.rb

@@ -0,0 +1,41 @@
+module AhoyCaptain
+  module Tables
+    module Rows
+      class RowComponent < ViewComponent::Base
+        def initialize(table:, item:)
+          @table = table
+          @item = item
+        end
+
+        def progress_bar(value, max, label)
+          items = []
+          items << view_context.content_tag(:progress, "", class: "progress-primary bg-base-100 h-8 grow", value: value, max: max)
+          items << view_context.content_tag(:span, class: "grow text-elipsis overflow-hidden absolute left-4 bottom-3 h-8 text-base-content") do
+            label
+          end
+
+          items.join.html_safe
+        end
+
+        def item(value = nil, &block)
+          view_context.content_tag(:span, class: "w-8 ml-8 text-right") do
+            if value
+              value
+            else
+              capture(&block)
+            end
+          end
+        end
+
+
+        def percent_total(item)
+          '%.1f' % ((item.unit_amount.to_i * 1.0 / total)*100.0)
+        end
+
+        def tooltip(value)
+          AhoyCaptain::TooltipComponent.new(amount: value).render_in(self)
+        end
+      end
+    end
+  end
+end

data/app/controllers/ahoy_captain/application_controller.rb

@@ -1,5 +1,3 @@
-
-
 module AhoyCaptain
   module Limitable
     private
@@ -22,19 +20,25 @@ module AhoyCaptain
 
     layout 'ahoy_captain/layouts/application'
 
-    before_action do
-      Current.request = self
+    # show the details frame
+    before_action :use_details_frame
+
+    # act like an spa without being an spa
+    before_action :act_like_an_spa
+
+    rescue_from Widget::WidgetDisabled do |e|
+      render template: 'ahoy_captain/shared/widget_disabled', locals: { frame: e.frame }
     end
 
-    # show the details frame
-    before_action do
+    private
+
+    def use_details_frame
       if request.headers['Turbo-Frame'] == 'details'
         request.variant = :details
       end
     end
 
-    # act like an spa without being an spa
-    before_action do
+    def act_like_an_spa
       if request.format.html? && request.headers['Turbo-Frame'].blank?
         if request.path != root_path
           requested_params = Rails.application.routes.recognize_path(request.path).except(:controller, :action)
@@ -46,12 +50,6 @@ module AhoyCaptain
       end
     end
 
-    rescue_from Widget::WidgetDisabled do |e|
-      render template: 'ahoy_captain/shared/widget_disabled', locals: { frame: e.frame }
-    end
-
-    private
-
     def visit_query
       VisitQuery.call(params)
     end
@@ -60,6 +58,7 @@ module AhoyCaptain
       EventQuery.call(params)
     end
 
+    # Only paginate details requests requests
     def paginate(collection)
       if paginate?
         pagy, results = pagy(collection, page: params[:page])
@@ -75,7 +74,10 @@ module AhoyCaptain
     end
 
     def cached(*names)
-      AhoyCaptain.cache.fetch("ahoy_captain:#{names.join(":")}:#{request.query_parameters.sort.map { |k,v| "#{k}-#{v}" }.join(":")}", expire_in: AhoyCaptain.config.cache.ttl) do
+      if AhoyCaptain.cache.class == ActiveSupport::Cache::NullStore
+        return yield
+      end
+      AhoyCaptain.cache.fetch("ahoy_captain:#{names.join(":")}:#{request.query_parameters.sort.map { |k,v| "#{k}-#{v}" }.join(":")}", expire_in: AhoyCaptain.config.cache[:ttl]) do
         yield
       end
     end

data/app/controllers/ahoy_captain/campaigns_controller.rb

@@ -10,17 +10,9 @@ module AhoyCaptain
 
     def index
       results = cached(:campaigns, params[:campaigns_type]) do
-        visit_query
-                   .select(
-                     "COALESCE(#{params[:campaigns_type]}, 'Direct/None') as label",
-                     "count(COALESCE(#{params[:campaigns_type]}, 'Direct/None')) as count",
-                     "sum(count(COALESCE(#{params[:campaigns_type]}, 'Direct/None'))) OVER() as total_count"
-                   )
-                   .group("COALESCE(#{params[:campaigns_type]}, 'Direct/None')")
-                   .order(Arel.sql("count(COALESCE(#{params[:campaigns_type]}, 'Direct/None')) desc"))
-                   .limit(limit)
+        CampaignQuery.call(params).limit(limit)
       end
-      @campaigns = paginate(results).map { |campaign| CampaignDecorator.new(campaign) }
+      @campaigns = paginate(results).map { |campaign| CampaignDecorator.new(campaign, self) }
       @campaign_type = params[:campaigns_type]&.titleize&.gsub("Utm", "UTM")
     end
   end

data/app/controllers/ahoy_captain/cities_controller.rb

@@ -10,15 +10,11 @@ module AhoyCaptain
 
     def index
       results = cached(:cities) do
-        visit_query
-          .select("city, country, count(concat(city, region, country)) as count, sum(count(concat(city, region, country))) over() as total_count")
-          .where.not(city: nil)
-          .group("city, region, country")
-          .order(Arel.sql "count(concat(city, region, country)) desc")
+        CityQuery.call(params)
           .limit(limit)
       end
 
-      @cities = paginate(results).map { |city| CityDecorator.new(city) }
+      @cities = paginate(results).map { |city| CityDecorator.new(city, self) }
     end
   end
 end

data/app/controllers/ahoy_captain/countries_controller.rb

@@ -1,7 +1,6 @@
 module AhoyCaptain
   class CountriesController < ApplicationController
     include Limitable
-    include Rangeable
 
     before_action do
       if Widget.disabled?(:locations, :countries)
@@ -11,14 +10,11 @@ module AhoyCaptain
 
     def index
       results = cached(:countries) do
-        visit_query
-          .reselect("country as label, count(country) as count, sum(count(country)) OVER() as total_count")
-          .group("country")
-          .order("count(country) desc")
+        CountryQuery.call(params)
           .limit(limit)
       end
 
-      @countries = paginate(results).map { |country| CountryDecorator.new(country) }
+      @countries = paginate(results).map { |country| CountryDecorator.new(country, self) }
     end
   end
 end

data/app/controllers/ahoy_captain/devices_controller.rb

@@ -10,14 +10,11 @@ module AhoyCaptain
 
     def index
       results = cached(:devices, params[:devices_type]) do
-          visit_query
-          .select("#{params[:devices_type]} as label", "count(#{params[:devices_type]}) as count", "sum(count(#{params[:devices_type]})) over() as total_count")
-          .group(params[:devices_type])
-          .order("count(#{params[:devices_type]}) desc")
-          .limit(limit)
+        DeviceQuery.call(params)
+                   .limit(limit)
       end
 
-      @devices = results.map { |device| DeviceDecorator.new(device) }
+      @devices = results.map { |device| DeviceDecorator.new(device, self) }
     end
   end
 end

data/app/controllers/ahoy_captain/entry_pages_controller.rb

@@ -10,12 +10,10 @@ module AhoyCaptain
 
     def index
       results = cached(:entry_pages) do
-        EntryPagesQuery.call(params, event_query)
-                      .order(Arel.sql "count(#{AhoyCaptain.config.event[:url_column]}) desc")
-                      .limit(limit)
+        EntryPagesQuery.call(params).limit(limit)
       end
 
-      @pages = paginate(results).map { |page| EntryPageDecorator.new(page) }
+      @pages = paginate(results).map { |page| EntryPageDecorator.new(page, self) }
     end
   end
 end

data/app/controllers/ahoy_captain/exit_pages_controller.rb

@@ -10,11 +10,10 @@ module AhoyCaptain
 
     def index
       results = cached(:exit_pages) do
-        ExitPagesQuery.call(params, event_query)
-                      .order(Arel.sql "count(#{AhoyCaptain.config.event[:url_column]}) desc")
-                              .limit(limit)
+        ExitPagesQuery.call(params)
+                      .limit(limit)
       end
-      @pages = paginate(results).map { |page| ExitPageDecorator.new(page) }
+      @pages = paginate(results).map { |page| ExitPageDecorator.new(page, self) }
     end
   end
 end

data/app/controllers/ahoy_captain/exports_controller.rb

@@ -0,0 +1,15 @@
+module AhoyCaptain
+  class ExportsController < ApplicationController
+    skip_before_action :act_like_an_spa
+    include Rangeable
+
+    def show
+      export = Export.new(params, self).build
+      file = export.to_zip
+      send_data file.read,
+                type: 'application/zip',
+                disposition: 'attachment',
+                filename: "AhoyCaptain export #{request.host} #{range[0].to_date} to #{range[1].to_date}.zip"
+    end
+  end
+end

data/app/controllers/ahoy_captain/filters/pages/entry_pages_controller.rb

@@ -1,10 +1,10 @@
 module AhoyCaptain
   module Filters
     module Pages
-      # TODO: ACCOMODATE EXIT_PAGES
       class EntryPagesController < BaseController
         def index
-          query = event_query.all.with_url.distinct_url
+          query = event_query.all.distinct("entry_pages.url").select("entry_pages.url as url")
+
           render json: query.map { |row| { text: row.url } }
         end
 

data/app/controllers/ahoy_captain/filters/pages/exit_pages_controller.rb

@@ -1,10 +1,9 @@
 module AhoyCaptain
   module Filters
     module Pages
-      # TODO: ACCOMODATE ENTRY_PAGES
       class ExitPagesController < BaseController
         def index
-          query = event_query.with_url.distinct_url
+          query = event_query.distinct("exit_pages.url").select("exit_pages.url as url")
 
           render json: query.map { |row| { text: row.url } }
         end

data/app/controllers/ahoy_captain/filters/properties/names_controller.rb

@@ -0,0 +1,11 @@
+module AhoyCaptain
+  module Filters
+    module Properties
+      class NamesController < BaseController
+        def index
+          render json: ::Ahoy::Event.select("jsonb_object_keys(properties) as keys").distinct("jsonb_object_keys(properties)").map(&:keys).map { |key| serialize(key) }
+        end
+      end
+    end
+  end
+end

data/app/controllers/ahoy_captain/filters/properties/values_controller.rb

@@ -0,0 +1,15 @@
+module AhoyCaptain
+  module Filters
+    module Properties
+      class ValuesController < BaseController
+        def index
+          query = ::Ahoy::Event.with(elements: event_query.select("ahoy_events.properties->>'controller' as element"))
+                               .select("distinct elements.element").from("elements")
+
+
+          render json: query.map(&:element).map { |element| serialize(element) }
+        end
+      end
+    end
+  end
+end

data/app/controllers/ahoy_captain/realtimes_controller.rb

@@ -1,7 +1,7 @@
 module AhoyCaptain
   class RealtimesController < ApplicationController
     def show
-      @total = event_query.where('time > ?', 1.minute.ago).distinct(:visit_id).count(:visit_id)
+      @total = event_query.where("#{AhoyCaptain.event.table_name}.time > ?", 1.minute.ago).distinct(:visit_id).count(:visit_id)
     end
   end
 end

data/app/controllers/ahoy_captain/regions_controller.rb

@@ -10,15 +10,11 @@ module AhoyCaptain
 
     def index
       results = cached(:regions) do
-        visit_query
-          .reselect("region, country, count(concat(region, country)) as count, sum(count(region)) over() as total_count")
-          .where.not(region: nil)
-          .group("region, country")
-          .order(Arel.sql "count(concat(region, country)) desc")
-          .limit(limit)
+        RegionQuery.call(params)
+                   .limit(limit)
       end
 
-      @regions = paginate(results).map { |region| RegionDecorator.new(region) }
+      @regions = paginate(results).map { |region| RegionDecorator.new(region, self) }
     end
   end
 end

data/app/controllers/ahoy_captain/sources_controller.rb

@@ -10,14 +10,11 @@ module AhoyCaptain
 
     def index
       results = cached(:sources) do
-        visit_query.select("substring(referring_domain from '(?:.*://)?(?:www\.)?([^/?]*)') as referring_domain, count(substring(referring_domain from '(?:.*://)?(?:www\.)?([^/?]*)')) as count, sum(count(substring(referring_domain from '(?:.*://)?(?:www\.)?([^/?]*)'))) OVER() as total_count")
-                   .where.not(referring_domain: nil)
-                   .group("substring(referring_domain from '(?:.*://)?(?:www\.)?([^/?]*)')")
-                   .order(Arel.sql "count(substring(referring_domain from '(?:.*://)?(?:www\.)?([^/?]*)')) desc")
+        SourceQuery.call(params)
                    .limit(limit)
       end
 
-      @sources = paginate(results).map { |source| AhoyCaptain::SourceDecorator.new(source) }
+      @sources = paginate(results).map { |source| AhoyCaptain::SourceDecorator.new(source, self) }
     end
   end
 

data/app/controllers/ahoy_captain/stats/base_controller.rb

@@ -1,6 +1,67 @@
 module AhoyCaptain
   module Stats
     class BaseController < ApplicationController
+      include Rangeable
+
+      INTERVAL_PERIOD = {
+        "realtime" => ["minute"],
+        "day" => ["minute", "hour"],
+        "7d" => ["hour", "day"],
+        "month" => ["day", "week"],
+        "all" => ["day", "week", "month"]
+      }
+
+      INTERVALS = ["minute", "hour", "day", "week", "month"]
+      private
+
+      helper_method :selected_interval
+      def selected_interval
+        if params[:interval].in?(INTERVALS)
+          params[:interval]
+        else
+          default_interval_for_period
+        end
+      end
+
+      def default_interval_for_period
+        default_interval_for_date_range(range)
+      end
+
+      def default_interval_for_date_range(range)
+        if range[1].nil?
+          # assume we're in a realtime
+          return INTERVAL_PERIOD["realtime"][0]
+        end
+        diff = (range[1] - range[0]).seconds
+        if diff.in_months > 1
+          "month"
+        elsif diff.in_days > 0
+          "day"
+        else
+          "hour"
+        end
+      end
+
+      helper_method :available_intervals
+      def available_intervals
+        if range
+          return INTERVAL_PERIOD["realtime"] if range[1].nil?
+
+          diff = (range[1] - range[0]).seconds.in_days
+
+          if diff == 0
+            INTERVAL_PERIOD["day"]
+          elsif diff <= 7
+            INTERVAL_PERIOD["7d"]
+          elsif diff <= 31
+            INTERVAL_PERIOD["month"]
+          else
+            INTERVAL_PERIOD["all"]
+          end
+        else
+          INTERVAL_PERIOD["month"]
+        end
+      end
     end
   end
 end

data/app/controllers/ahoy_captain/stats/bounce_rates_controller.rb

@@ -1,9 +1,11 @@
 module AhoyCaptain
   module Stats
     class BounceRatesController < BaseController
+      # @todo: this is lazy
       def index
-        @stats = AhoyCaptain::Stats::BounceRatesQuery.call(params).group_by_day("ahoy_visits.started_at").average("num_events * 100")
-        #.group_by_day("ahoy_visits.started_at").average("total_events")
+        @stats = AhoyCaptain::Stats::BounceRatesQuery.call(params)
+        @stats = @stats.group_by_period(selected_interval, "daily_bounce_rate.date").average("bounce_rate")
+        @label = "Bounce Rate"
       end
     end
   end

data/app/controllers/ahoy_captain/stats/total_pageviews_controller.rb

@@ -2,7 +2,8 @@ module AhoyCaptain
   module Stats
     class TotalPageviewsController < BaseController
       def index
-        @stats = AhoyCaptain::Stats::TotalPageviewsQuery.call(params).group_by_day(:time).count
+        @stats = AhoyCaptain::Stats::TotalPageviewsQuery.call(params).group_by_period(selected_interval, :time).count
+        @label = "Visitors"
       end
     end
   end

data/app/controllers/ahoy_captain/stats/total_visits_controller.rb

@@ -2,7 +2,8 @@ module AhoyCaptain
   module Stats
     class TotalVisitsController < BaseController
       def index
-        @stats = AhoyCaptain::Stats::TotalVisitorsQuery.call(params).group_by_day(:started_at).count
+        @stats = AhoyCaptain::Stats::TotalVisitorsQuery.call(params).group_by_period(selected_interval, :started_at).count
+        @label = "Visitors"
       end
     end
   end

data/app/controllers/ahoy_captain/stats/unique_visitors_controller.rb

@@ -2,7 +2,8 @@ module AhoyCaptain
   module Stats
     class UniqueVisitorsController < BaseController
       def index
-        @stats = AhoyCaptain::Stats::UniqueVisitorsQuery.call(params).group_by_day(:started_at).count
+        @stats = AhoyCaptain::Stats::UniqueVisitorsQuery.call(params).group_by_period(selected_interval, :started_at).count
+        @label = "Visitors"
       end
     end
   end