ahoy_captain 0.83 → 1.0.0

data/app/components/ahoy_captain/tile_component.rb

@@ -5,12 +5,20 @@ class AhoyCaptain::TileComponent < ViewComponent::Base
   renders_one :display_links
   renders_one :details_cta
 
-  def initialize(title: nil, wide: false)
+  def initialize(title: nil, wide: false, classes: "p-8 mx-4")
+    @classes = classes
     @title = title
     @wide = wide
   end
 
+  def link_to(name, url, **options)
+    options[:class] = "inline-block h-5 font-semibold"
+    options[:data] ||= {}
+    options[:data].merge!(controller: "frame-link")
+    view_context.link_to name, url, **options
+  end
+
   private
 
   attr_reader :title, :wide
-end
+end

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

@@ -1,3 +1,3 @@
-<div class="tooltip" data-tip=<%= amount %>>
+<div class="tooltip " data-tip=<%= amount %>>
     <p><%= abbreviate %></p>
-</div>
+</div>

data/app/controllers/ahoy_captain/application_controller.rb

@@ -1,25 +1,16 @@
 module AhoyCaptain
-  module Limitable
-    private
-
-    def limit
-      if request.variant.include?(:details)
-        nil
-      else
-        if params[:limit]
-          params[:limit].to_i
-        else
-          10
-        end
-      end
-    end
-  end
-
   class ApplicationController < ActionController::Base
     include Pagy::Backend
+    include CompareMode
+    include RangeOptions
+    include Rangeable
 
     layout 'ahoy_captain/layouts/application'
 
+    def period
+      params[:period] || AhoyCaptain.config.ranges.default
+    end
+
     # show the details frame
     before_action :use_details_frame
 

data/app/controllers/ahoy_captain/exports_controller.rb

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

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

@@ -1,12 +1,10 @@
 module AhoyCaptain
   module Filters
     class BaseController < ApplicationController
-      include Rangeable
-
       private
 
       def serialize(value)
-        { text: value }
+        { text: (value.presence || AhoyCaptain.none.text), value: (value.presence || AhoyCaptain.none.value) }
       end
 
       def visit_query

data/app/controllers/ahoy_captain/filters/goals_controller.rb

@@ -0,0 +1,9 @@
+module AhoyCaptain
+  module Filters
+    class GoalsController < BaseController
+      def index
+        render json: AhoyCaptain.configuration.goals.map { |goal| { text: goal.title, value: goal.id } }
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module AhoyCaptain
         def index
           query = event_query.all.with_url.distinct_url
 
-          render json: query.map { |row| { text: row.url } }
+          render json: query.map { |row| serialize(row.url) }
         end
       end
     end

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

@@ -5,7 +5,7 @@ module AhoyCaptain
         def index
           query = event_query.all.distinct("entry_pages.url").select("entry_pages.url as url")
 
-          render json: query.map { |row| { text: row.url } }
+          render json: query.map { |row| serialize(row.url) }
         end
 
       end

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

@@ -5,7 +5,7 @@ module AhoyCaptain
         def index
           query = event_query.distinct("exit_pages.url").select("exit_pages.url as url")
 
-          render json: query.map { |row| { text: row.url } }
+          render json: query.map { |row| serialize(row.url) }
         end
 
       end

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

@@ -3,11 +3,11 @@ module AhoyCaptain
     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")
+          param_key = params[:q].to_unsafe_h.detect { |k,v| k.ends_with?("_i_cont") && k.starts_with?("properties.") }[0]
+          key = param_key.delete_prefix("properties.").delete_suffix("_i_cont")
+          query = event_query.all.distinct.select("properties->>'#{key}'").pluck(Arel.sql "properties->>'#{key}'")
 
-
-          render json: query.map(&:element).map { |element| serialize(element) }
+          render json: query.map { |element| serialize(element) }
         end
       end
     end

data/app/controllers/ahoy_captain/filters/sources_controller.rb

@@ -4,7 +4,7 @@ module AhoyCaptain
       def index
         query = visit_query.all
 
-        render json: query.result.select("distinct referring_domain").where.not(referring_domain: nil).group(:referring_domain).order(Arel.sql "count(*) desc").pluck(:referring_domain).map { |city| serialize(city) }
+        render json: query.select("distinct referring_domain").where.not(referring_domain: nil).group(:referring_domain).order(Arel.sql "count(*) desc").pluck(:referring_domain).map { |city| serialize(city) }
       end
     end
   end

data/app/controllers/ahoy_captain/filters/utms_controller.rb

@@ -2,7 +2,7 @@ module AhoyCaptain
   module Filters
     class UtmsController < BaseController
       def index
-        query = visit_query.select("#{params[:type]}", "count(#{params[:type]}) as total").group(params[:type]).order(Arel.sql "count(#{params[:type]}) desc").pluck(params[:type]).map { |city| serialize(city || "Direct/none") }
+        query = visit_query.select("#{params[:type]}", "count(#{params[:type]}) as total").group(params[:type]).order(Arel.sql "count(#{params[:type]}) desc").pluck(params[:type]).map { |city| serialize(city) }
         render json: query
       end
     end

data/app/controllers/ahoy_captain/locations/cities_controller.rb

@@ -0,0 +1,22 @@
+module AhoyCaptain
+  module Locations
+    class CitiesController < ApplicationController
+      include AhoyCaptain::Limitable
+
+      before_action do
+        if Widget.disabled?(:locations, :cities)
+          raise Widget::WidgetDisabled.new("Widget disabled", :geography)
+        end
+      end
+
+      def index
+        results = cached(:cities) do
+          CityQuery.call(params)
+                   .limit(limit)
+        end
+
+        @cities = paginate(results).map { |city| CityDecorator.new(city, self) }
+      end
+    end
+  end
+end

data/app/controllers/ahoy_captain/locations/countries_controller.rb

@@ -0,0 +1,22 @@
+module AhoyCaptain
+  module Locations
+    class CountriesController < ApplicationController
+      include Limitable
+
+      before_action do
+        if Widget.disabled?(:locations, :countries)
+          raise Widget::WidgetDisabled.new("Widget disabled", :geography)
+        end
+      end
+
+      def index
+        results = cached(:countries) do
+          CountryQuery.call(params)
+                      .limit(limit)
+        end
+
+        @countries = paginate(results).map { |country| CountryDecorator.new(country, self) }
+      end
+    end
+  end
+end

data/app/controllers/ahoy_captain/locations/maps_controller.rb

@@ -0,0 +1,24 @@
+module AhoyCaptain
+  module Locations
+    class MapsController < ApplicationController
+      include Limitable
+
+      before_action do
+        if Widget.disabled?(:locations, :map)
+          raise Widget::WidgetDisabled.new("Widget disabled", :geography)
+        end
+      end
+
+      def show
+        if request.variant.include?(:details)
+          results = CountryQuery.call(params)
+          results = results.limit(limit)
+          @countries = paginate(results).map { |country| CountryDecorator.new(country, self) }
+          render template: 'ahoy_captain/locations/countries/index'
+        else
+          @countries = visit_query.group("country").count
+        end
+      end
+    end
+  end
+end

data/app/controllers/ahoy_captain/locations/regions_controller.rb

@@ -0,0 +1,22 @@
+module AhoyCaptain
+  module Locations
+    class RegionsController < ApplicationController
+      include Limitable
+
+      before_action do
+        if Widget.disabled?(:locations, :regions)
+          raise Widget::WidgetDisabled.new("Widget disabled", :geography)
+        end
+      end
+
+      def index
+        results = cached(:regions) do
+          RegionQuery.call(params)
+                     .limit(limit)
+        end
+
+        @regions = paginate(results).map { |region| RegionDecorator.new(region, self) }
+      end
+    end
+  end
+end

data/app/controllers/ahoy_captain/properties_controller.rb

@@ -0,0 +1,41 @@
+module AhoyCaptain
+  class PropertiesController < ApplicationController
+    before_action do
+      @options = ::Ahoy::Event.select("jsonb_object_keys(properties) as keys").distinct("jsonb_object_keys(properties)").map(&:keys).map { |key| [Base64.urlsafe_encode64(key), key]}.to_h
+    end
+
+    def index
+    end
+
+    def show
+      value = Base64.urlsafe_decode64(params[:id])
+
+      @properties = event_query
+        .select(
+          "COALESCE(properties->>'#{value}', '(none)') AS label",
+          "COUNT(*) AS events_count",
+          "COUNT(DISTINCT visit_id) AS unique_visitors_count",
+          "(COUNT(DISTINCT visit_id)/COUNT(*)::numeric) * 100 as percentage"
+        )
+        .group("COALESCE(properties->>'#{value}', '(none)')")
+        .order(Arel.sql "COUNT(*) desc")
+    end
+
+    private
+
+    helper_method :has_property?
+    def has_property?(value)
+      searching_properties[value]
+    end
+
+    helper_method :selected_property?
+    def selected_property?(value)
+      encoded = Base64.urlsafe_encode64(value, padding: false)
+      encoded == params[:id]
+    end
+
+    def searching_properties
+      JSON.parse(params.dig("q", "properties_json_cont") || '{}')
+    end
+  end
+end

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

@@ -1,7 +1,6 @@
 module AhoyCaptain
   module Stats
     class BaseController < ApplicationController
-      include Rangeable
 
       INTERVAL_PERIOD = {
         "realtime" => ["minute"],
@@ -12,8 +11,18 @@ module AhoyCaptain
       }
 
       INTERVALS = ["minute", "hour", "day", "week", "month"]
+
       private
 
+      helper_method :metric_type
+      def metric_type(stats)
+        if compare_mode?
+          stats.current.values.first.try(:class) || stats.compared_to.values.first.try(:class)
+        else
+          stats.values.first.class
+        end
+      end
+
       helper_method :selected_interval
       def selected_interval
         if params[:interval].in?(INTERVALS)
@@ -32,11 +41,13 @@ module AhoyCaptain
           # assume we're in a realtime
           return INTERVAL_PERIOD["realtime"][0]
         end
-        diff = (range[1] - range[0]).seconds
-        if diff.in_months > 1
+        diff = (range[1] - range[0]).seconds.in_days
+        if diff >= 31
           "month"
-        elsif diff.in_days > 0
+        elsif diff > 1
           "day"
+        elsif diff == 1
+          "hour"
         else
           "hour"
         end
@@ -49,7 +60,7 @@ module AhoyCaptain
 
           diff = (range[1] - range[0]).seconds.in_days
 
-          if diff == 0
+          if diff < 1
             INTERVAL_PERIOD["day"]
           elsif diff <= 7
             INTERVAL_PERIOD["7d"]
@@ -62,6 +73,76 @@ module AhoyCaptain
           INTERVAL_PERIOD["month"]
         end
       end
+
+      def lazy_window(result, value = 0, base = nil)
+        if result.is_a?(AhoyCaptain::LazyComparableQuery::LazyComparison)
+          result.result.current = lazy_window(result.result.current, value, range)
+          result.result.compared_to = lazy_window(result.result.compared_to, value, result.compare_range)
+          return result.result
+        end
+
+        base ||= range
+        window = window_for(selected_interval, result.keys[0].class, base.numeric)
+
+        window.each do |item|
+          if result.key?(item)
+            next
+          end
+
+          result[item] ||= value
+        end
+
+        transform = interval_label_transformation(selected_interval)
+
+        if transform
+          result.transform_keys! { |key| key.strftime(transform) }
+        end
+
+        result
+      end
+
+      def interval_label_transformation(interval)
+        return nil
+        if interval == 'hour'
+          return '%H:%M %p'
+        end
+
+        nil
+      end
+
+      # base should be a range
+      def window_for(interval, type, base = nil)
+        function = case type.to_s
+                    when 'Date', 'NilClass'
+                      ->(value) {
+                        date = Time.at(value).utc
+                        if interval == 'month'
+                          date.change(day: 1)
+                        elsif interval == 'week'
+                          date.beginning_of_week
+                        elsif interval == 'day'
+                          date.beginning_of_day
+                        elsif interval == 'hour'
+                          date.beginning_of_hour
+                        elsif interval == 'minute'
+                          date.beginning_of_minute
+                        else
+                          abort
+                        end.to_date
+                      }
+                    when 'DateTime'
+                      ->(value) { Time.at(value).utc.change(sec: 0) }
+                   when 'ActiveSupport::TimeWithZone'
+                     ->(value) { Time.at(value).utc }
+                   else
+                        raise ArgumentError
+                    end
+
+        base
+             .step(1.send(interval))
+             .to_a
+             .map { |value| function.call(value) }
+      end
     end
   end
 end

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

@@ -4,7 +4,7 @@ module AhoyCaptain
       # @todo: this is lazy
       def index
         @stats = AhoyCaptain::Stats::BounceRatesQuery.call(params)
-        @stats = @stats.group_by_period(selected_interval, "daily_bounce_rate.date").average("bounce_rate")
+        @stats = lazy_window(@stats.with_lazy_comparison(compare_mode?).group_by_period(selected_interval, "daily_bounce_rate.date").average("bounce_rate"))
         @label = "Bounce Rate"
       end
     end

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

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

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

@@ -2,7 +2,7 @@ module AhoyCaptain
   module Stats
     class TotalVisitsController < BaseController
       def index
-        @stats = AhoyCaptain::Stats::TotalVisitorsQuery.call(params).group_by_period(selected_interval, :started_at).count
+        @stats = lazy_window(AhoyCaptain::Stats::TotalVisitorsQuery.call(params).with_lazy_comparison(compare_mode?).group_by_period(selected_interval, :started_at).count)
         @label = "Visitors"
       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_period(selected_interval, :started_at).count
+        @stats = AhoyCaptain::Stats::UniqueVisitorsQuery.call(params).with_lazy_comparison(compare_mode?).group_by_period(selected_interval, :started_at).count
+        @stats = lazy_window(@stats)
         @label = "Visitors"
       end
     end

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

@@ -1,19 +1,10 @@
 module AhoyCaptain
   module Stats
     class ViewsPerVisitsController < BaseController
-      # @todo: make me a window func
       def index
-        @stats = AhoyCaptain::Stats::ViewsPerVisitQuery.call(params).group_by_period(selected_interval, 'views_per_visit_table.started_at').average(:views_per_visit)
-        if range[1]
-          (range[0].to_date..range[1].to_date).to_a.each do |date|
-            unless @stats.key?(date.to_date)
-              @stats[date.to_date] = 2
-            end
-          end
-        end
+        @stats = lazy_window(AhoyCaptain::Stats::ViewsPerVisitQuery.call(params).with_lazy_comparison(compare_mode?).group_by_period(selected_interval, 'views_per_visit_table.started_at').average(:views_per_visit))
 
         @label = "Views"
-
       end
     end
   end

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

@@ -2,7 +2,7 @@ module AhoyCaptain
   module Stats
     class VisitDurationsController < BaseController
       def index
-        @stats = AhoyCaptain::Stats::VisitDurationQuery.call(params).group_by_period(selected_interval, 'started_at').average(:duration)
+        @stats = lazy_window(AhoyCaptain::Stats::VisitDurationQuery.call(params).with_lazy_comparison(compare_mode?).group_by_period(selected_interval, 'started_at').average(:duration))
         @label = "Duration"
       end
     end

data/app/helpers/ahoy_captain/application_helper.rb

@@ -2,7 +2,36 @@ module AhoyCaptain
   module ApplicationHelper
     include Pagy::Frontend
 
-    SPECIAL_PARAMS = [:campaigns_type, :devices_type]
+    def current_property_filter
+      return nil unless params[:q]
+
+      prop = params[:q].to_unsafe_h.detect { |key, _| key.starts_with?("properties.") }
+      if prop
+        key = prop[0].dup
+        Ransack::Predicate.detect_and_strip_from_string!(key)
+        { key: key, value: prop[1] }
+
+      else
+        nil
+      end
+    end
+
+    def stats_container(value, url, label, formatter, selected = false)
+      if value.is_a?(AhoyCaptain::ComparableQuery::Comparison)
+        ::AhoyCaptain::Stats::ComparableContainerComponent.new(url, label, value, formatter, selected, compare_mode?)
+      else
+        ::AhoyCaptain::Stats::ContainerComponent.new(url, label, value, formatter, selected)
+      end
+    end
+
+    def number_to_duration(duration)
+      if duration
+        "#{duration.in_minutes.to_i}M #{duration.parts[:seconds].to_i}S"
+      else
+        "0M 0S"
+      end
+    end
+
     def ahoy_captain_importmap_tags(entry_point = "application", shim: true)
       safe_join [
         (javascript_importmap_shim_tag if shim),
@@ -17,8 +46,36 @@ module AhoyCaptain
       request.query_parameters
     end
 
-    def special_params
-      params.to_unsafe_h.slice(*SPECIAL_PARAMS)
+    # gets put into the form as a hidden field
+    #
+    def non_filter_ransack_params
+      other_params = {}
+      map = [
+        :start_date,
+        :end_date,
+        :period,
+        :interval,
+        :comparison,
+      ]
+
+      # properties stuff falls into current_property_filter
+      ransack = [:goal]
+
+      map.each do |key|
+        if params[key]
+          other_params[key] = params[key]
+        end
+      end
+
+      ransack.each do |key|
+        Ransack.predicates.keys.each do |predicate|
+          if value = params.dig(:q, "#{key}_#{predicate}")
+            other_params["q[#{key}_#{predicate}]"] = value
+          end
+        end
+      end
+
+      other_params
     end
 
     def render_pagination

data/app/models/ahoy_captain/comparison_mode.rb

@@ -0,0 +1,72 @@
+module AhoyCaptain
+  class ComparisonMode
+    VALID_COMPARISONS = %w{previous year true}
+
+    include RangeOptions
+    include Rangeable
+
+    attr_reader :params
+    def initialize(params)
+      @params = params
+    end
+
+    # can't compare realtime
+    def enabled?(strict = true)
+      comparing = (params[:comparison].in?(VALID_COMPARISONS) || custom_compare?)
+      if strict
+        comparing && !range.realtime?
+      else
+        comparing
+      end
+    end
+
+    def label
+      if custom_compare?
+        return "Custom period"
+      end
+
+      if type == :true || type == :previous
+        "Previous period"
+      elsif type == :year
+        "Year-over-year"
+      else
+        raise ArgumentError
+      end
+    end
+
+    def compared_to_range
+      return custom_compare if custom_compare?
+
+      if type == :true || type == :previous
+        RangeFromParams.new(period: nil, start_date: (range[0] - (range[1] - range[0])).utc.to_s, end_date: range[0].utc.to_s).build
+      elsif type == :year
+        RangeFromParams.new(period: nil, start_date: range[0].change(year: range[0].year - 1).utc.to_s, end_date: range[1].change(year: range[1].year - 1).utc.to_s).build
+      else
+        raise ArgumentError
+      end
+    end
+
+    def type
+      return params[:comparison].to_sym if params[:comparison].in?(VALID_COMPARISONS)
+      return :custom if custom_compare?
+
+      nil
+    end
+
+    def match_to
+      return params[:compare_to].to_sym if params[:compare_to].in?(%w{dow date})
+
+      nil
+    end
+
+    def custom_compare
+      return nil unless (params[:compare_to_start_date].present? && params[:compare_to_end_date].present?)
+
+      RangeFromParams.new(period: nil, start_date: params[:compare_to_start_date], end_date: params[:compare_to_end_date]).build
+    end
+
+    def custom_compare?
+      custom_compare
+    end
+  end
+end