ahoy_captain 0.83 → 1.0.0

data/app/queries/ahoy_captain/visit_query.rb

@@ -1,6 +1,5 @@
 module AhoyCaptain
   class VisitQuery < ApplicationQuery
-    include Rangeable
 
     def build
       shared_context = Ransack::Context.for(AhoyCaptain.visit)
@@ -9,7 +8,7 @@ module AhoyCaptain
         ransack_params_for(:visit).reject { |k,v| k.start_with?("events_") }, context: shared_context
       )
       search_children = AhoyCaptain.event.ransack(
-        ransack_params_for(:event).reject { |k,v| k.start_with?("visit_") }.transform_keys { |key| "events_#{key}" }, context: shared_context
+        ransack_params_for(:event).reject { |k,v| k.start_with?("visit_") || k == :c }.transform_keys { |key| "events_#{key}" }, context: shared_context
       )
 
       shared_conditions = [search_parents, search_children].map { |search|

data/app/queries/concerns/ahoy_captain/comparable_queries.rb

@@ -0,0 +1,25 @@
+module AhoyCaptain
+  module ComparableQueries
+    def compare_range
+      @compare_range ||= begin
+                           ComparisonMode.new(@params).compared_to_range
+                         end
+    end
+
+    def range
+      @range ||= @query.send(:range)
+    end
+
+    def comparison_params
+      params = @params.deep_dup
+      params.delete("period")
+
+      params[:start_date] = compare_range[0]
+      params[:end_date] = compare_range[1]
+      params
+    end
+  end
+end
+
+require_relative './lazy_comparable_query'
+require_relative './comparable_query'

data/app/queries/concerns/ahoy_captain/comparable_query.rb

@@ -0,0 +1,138 @@
+module AhoyCaptain
+  module ComparableQuery
+    class Comparison
+      class ComparisonResult
+        attr_reader :current, :compared_to
+        def initialize(current, compared_to)
+          @current = current
+          @compared_to = compared_to
+        end
+      end
+
+      def initialize(query)
+        @query = query
+        @params = @query.params.deep_dup
+        @compare = @query.class.call(comparison_params)
+        @model = @query.all.klass
+        @query_class = @query.class
+      end
+
+      def count(column_name = :id)
+        @operation = :count
+        @column = column_name
+        perform_calculations(:count, column_name)
+
+        self
+      end
+
+      def average(column_name)
+        @operation = :average
+        @column = column_name
+
+        perform_calculations(:average, column_name)
+
+        self
+      end
+
+      def perform_calculations(operation, column_name)
+        @query = perform_calculation(@query, operation, column_name)
+        @compare = perform_calculation(@compare, operation, column_name)
+      end
+
+      def perform_calculation(q, operation, column_name)
+        operation = operation.to_s.downcase
+        # If #count is used with #distinct (i.e. `relation.distinct.count`) it is
+        # considered distinct.
+        distinct = q.send(:distinct_value)
+
+        if operation == "count"
+          column_name ||= q.send(:select_for_count)
+          if column_name == :all
+            if !distinct
+              distinct = q.send(:distinct_select?, :select_for_count) if q.group_values.empty?
+            elsif q.send(:group_values).any? || q.send(:select_values).empty? && q.order_values.empty?
+              column_name = q.primary_key
+            end
+          elsif q.all.send(:distinct_select?, column_name)
+            distinct = nil
+          end
+        end
+
+        if q.group_values.any?
+          raise "use a subquery"
+        else
+          execute_simple_calculation(q, operation, column_name, distinct)
+        end
+      end
+
+      def result
+        result = @model.with(
+          current: @query.to_sql,
+          compare: @compare.to_sql
+        ).select("current, compare").from("current, compare")[0]
+        type = @query_class.cast_type(@column)
+
+        if result
+          current = @query_class.cast_value(type, result.current[1...-1])
+          compare = @query_class.cast_value(type, result.compare[1...-1])
+        else
+          current = @query_class.cast_value(type, '0')
+          compare = @query_class.cast_value(type, '0')
+        end
+
+        @result = ComparisonResult.new((current), (compare))
+      end
+
+      def compare_range
+        @compare_range ||= begin
+                             og_range = range
+                             [og_range[0] - (og_range[1] - og_range[0]), og_range[0]]
+                           end
+
+      end
+
+      def range
+        @range ||= @query.send(:range)
+      end
+
+      private
+
+      def execute_simple_calculation(q, operation, column_name, distinct) # :nodoc:
+        if operation == "count" && (column_name == :all && distinct || q.has_limit_or_offset?)
+          # Shortcut when limit is zero.
+          return 0 if q.limit_value == 0
+
+          q.send(:build_count_subquery, q.spawn, column_name, distinct)
+        else
+          # PostgreSQL doesn't like ORDER BY when there are no GROUP BY
+          relation = q.all.unscope(:order).distinct!(false)
+
+          column = q.all.send(:aggregate_column, column_name)
+          select_value = q.all.send(:operation_over_aggregate_column, column, operation, distinct)
+          select_value.distinct = true if operation == "sum" && distinct
+
+          relation.select_values = [select_value]
+
+          relation.arel
+        end
+      end
+
+      def comparison_params
+        params = @params.deep_dup
+        params.delete("period")
+
+        params[:start_date] = compare_range[0]
+        params[:end_date] = compare_range[1]
+        params
+      end
+    end
+
+    def with_comparison(enabled = false)
+      if enabled
+        Comparison.new(self)
+      else
+        self
+      end
+    end
+  end
+end

data/app/queries/concerns/ahoy_captain/lazy_comparable_query.rb

@@ -0,0 +1,42 @@
+module AhoyCaptain
+  module LazyComparableQuery
+    class LazyComparison
+      class LazyComparisonResult
+        attr_accessor :current, :compared_to
+      end
+
+      include ::AhoyCaptain::ComparableQueries
+
+      def initialize(query)
+        @query = query
+        @params = @query.params.deep_dup
+        @compare = @query.class.call(comparison_params)
+      end
+
+      def method_missing(name, *args)
+        perform_operations(name, *args)
+      end
+
+      def perform_operations(name, *args)
+        @query = @query.public_send(name, *args)
+        @compare = @compare.public_send(name, *args)
+
+        self
+      end
+
+      def result
+        return @result if @result
+
+        @result = LazyComparisonResult.new.tap { |comparison| comparison.current =  @query; comparison.compared_to = @compare }
+      end
+    end
+
+    def with_lazy_comparison(enabled = false)
+      if enabled
+        LazyComparison.new(self)
+      else
+        self
+      end
+    end
+  end
+end

data/app/views/ahoy_captain/devices/_table.html.erb

@@ -1,5 +1,2 @@
 <%= render AhoyCaptain::TableComponent.new(items: @devices,
-                                           category_name: 'Devices',
-                                           unit_name: 'Visitors',
-                                           header: ::AhoyCaptain::Tables::Headers::DevicesHeaderComponent,
-                                           row: ::AhoyCaptain::Tables::Rows::DevicesRowComponent) %>
+                                           table: ::AhoyCaptain::Tables::DevicesTableComponent) %>

data/app/views/ahoy_captain/funnels/show.html.erb

@@ -1,6 +1,9 @@
 <%= turbo_frame_tag :goals do %>
   <div >
-    <canvas data-controller="funnel-chart" data-data="<%= @funnel.to_json %>" ></canvas>
-
+    <% if params.dig(:q, :goal_id) %>
+      <p>Funnels are unavailable if filtering by a goal.</p>
+    <% else %>
+      <canvas data-controller="funnel-chart" data-data="<%= @funnel.to_json %>" ></canvas>
+    <% end %>
   </div>
 <% end %>

data/app/views/ahoy_captain/goals/index.html.erb

@@ -1,7 +1,4 @@
 <%= turbo_frame_tag :goals do %>
   <%= render AhoyCaptain::TableComponent.new(items: @presenter.goals,
-                                             header: ::AhoyCaptain::Tables::Headers::GoalsHeaderComponent,
-                                             row: ::AhoyCaptain::Tables::Rows::GoalsRowComponent) %>
-
-
+                                             table: ::AhoyCaptain::Tables::GoalsTableComponent) %>
 <% end %>

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

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html>
+<html data-theme='<%= AhoyCaptain.config.theme %>'>
 <head>
   <title>Ahoy Captain</title>
   <meta name="viewport" content="width=device-width,initial-scale=1">
@@ -21,7 +21,6 @@
   <meta name="theme-color" content="#ffffff">
   <link href="https://cdn.jsdelivr.net/npm/daisyui@3.5.0/dist/full.css" rel="stylesheet" type="text/css"/>
   <script src="https://cdn.tailwindcss.com"></script>
-  <link href="https://unpkg.com/slim-select@latest/dist/slimselect.css" rel="stylesheet" />
   <%= ahoy_captain_importmap_tags %>
   <style>
       /* Application styles */
@@ -116,9 +115,9 @@
   </style>
 </head>
 
-<body data-theme='<%= AhoyCaptain.config.theme %>' class='bg-base-300' data-controller='application'>
+<body data-controller='application'>
   <%= yield %>
-  <div class="flex justify-center bg-base-300 border-t-4 border-base-100 py-4">
+  <div class="flex justify-center border-t-4 border-base-100 py-4">
     <div class="flex justify-around space-x-4 my-4">
       <h5>Powered by <a href='https://github.com/joshmn/ahoy_captain' target=”_blank”>Ahoy Captain v<%= AhoyCaptain::VERSION %></a></h5>
     </div>

data/app/views/ahoy_captain/layouts/shared/_tile_loader.html.erb

@@ -0,0 +1,12 @@
+<div class="mt-5" >
+  <div role="status" class="animate-pulse">
+    <div class="flex justify-between w-full mb-2">
+      <div class="h-2.5 bg-gray-200 rounded-full dark:bg-gray-700 w-32"></div>
+      <div class="h-2.5 bg-gray-300 rounded-full dark:bg-gray-600 w-24"></div>
+    </div>
+    <% 10.times do |i| %>
+      <div class="h-6 bg-gray-200 dark:bg-gray-700 max-w-[<%= 100 - (i * 10) %>%] mb-2.5"></div>
+    <% end %>
+    <span class="sr-only">Loading...</span>
+  </div>
+</div>

data/app/views/ahoy_captain/locations/maps/show.html.erb

@@ -0,0 +1,3 @@
+<%= turbo_frame_tag :geography do %>
+  <canvas style="position: relative; width: 500px; height: 300px;" data-controller="map" data-map-data-value="<%= @countries.to_json %>"></canvas>
+<% end %>

data/app/views/ahoy_captain/properties/_form.html.erb

@@ -0,0 +1,6 @@
+<select class="select text-accent select-sm w-full max-w-sm" data-controller="properties" data-action="change->properties#handleChange">
+  <option></option>
+  <% @options.each do |key, value| %>
+    <option value="<%= property_path(id: key) %>" <%= 'selected' if local_assigns[:selected] == value %>><%= value %></option>
+  <% end %>
+</select>

data/app/views/ahoy_captain/properties/index.html.erb

@@ -0,0 +1,3 @@
+<%= turbo_frame_tag :goals do %>
+  <%= render 'ahoy_captain/properties/form' %>
+<% end %>

data/app/views/ahoy_captain/properties/show.html.erb

@@ -0,0 +1,6 @@
+<%= turbo_frame_tag :goals do %>
+  <%= render 'ahoy_captain/properties/form', selected: Base64.strict_decode64(params[:id]) %>
+
+  <%= render AhoyCaptain::TableComponent.new(items: @properties,
+                                             table: ::AhoyCaptain::Tables::PropertiesTableComponent) %>
+<% end %>

data/app/views/ahoy_captain/realtimes/show.html.erb

@@ -1,6 +1,6 @@
 <%= turbo_frame_tag :realtime do %>
   <div>
-    <a class="block ml-1 md:ml-2 mr-auto text-xs md:text-sm font-bold text-base-content dark:text-base-content" title="" data-realtime-target="label">
+    <a class="block ml-1 md:ml-2 mr-auto text-xs md:text-sm font-bold " title="" data-realtime-target="label">
       <svg class="inline w-2 mr-1 md:mr-2 text-green-500 fill-current animate-pulse" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg">
         <circle cx="8" cy="8" r="8"></circle>
       </svg><%= @total %> <span class="hidden sm:inline-block">current visitors</span>

data/app/views/ahoy_captain/roots/_filters.html.erb

@@ -0,0 +1,80 @@
+<%= form_with url: url_for(params.permit!.except(:q)), method: :get, data: { turbo_frame: "_top", controller: "filter-form", action: "reset->filter-form#handleReset" } do |form| %>
+  <% non_filter_ransack_params.each do |k,v| %>
+    <%= form.hidden_field k, value: v %>
+  <% end %>
+  <% AhoyCaptain.config.filters.each do |name, filters| %>
+    <%= render AhoyCaptain::Filter::ModalComponent.new(title: "Filter by #{name}", id: "#{filters.modal_name}") do |modal| %>
+      <% modal.with_modal_display do %>
+        <% filters.each do |filter| %>
+          <%= render AhoyCaptain::Filter::SelectComponent.new(label: filter.label, column: filter.column, url: public_send(filter.url), predicates: filter.predicates, multiple: filter.multiple, form: form) %>
+        <% end %>
+      <% end %>
+    <% end %>
+  <% end %>
+
+  <%= render AhoyCaptain::Filter::ModalComponent.new(title: "Filter by Custom Property", id: "customPropertyFilterModal") do |modal| %>
+    <% modal.with_modal_display do %>
+      <div data-controller="property-filter">
+        <fieldset class="flex space-x-4 items-end">
+          <% if current_property_filter %>
+            <%= render ::AhoyCaptain::ComboboxComponent.new(name: "", multiple: false, column: "", url: filters_properties_names_path, value: [current_property_filter[:key].delete_prefix("properties.")], select_html: { "data-property-filter-target" => 'name', id: "property-name" }) %>
+          <% else %>
+            <%= render ::AhoyCaptain::ComboboxComponent.new(name: "", multiple: false, column: "", url: filters_properties_names_path, select_html: { "data-property-filter-target" => 'name', id: "property-name" } ) %>
+          <% end %>
+
+          <div class="flex flex-col w-[20%]">
+            <select class='select select-primary bg-gray-900 ring-0  focus-within:ring-0 focus-within:ring-0 focus:ring-0 focus:outline-none inline-flex justify-between items-center w-full rounded-md border px-4 py-2 text-sm'>
+              <option value="in">in</option>
+            </select>
+          </div>
+
+          <% if current_property_filter %>
+            <%= render ::AhoyCaptain::ComboboxComponent.new(name: "q[#{current_property_filter[:key]}_in]", multiple: false, column: "", url: filters_properties_values_path, value: [current_property_filter[:value]], select_html: { "data-property-filter-target" => 'value', id: "property-value" } ) %>
+          <% else %>
+            <%= render ::AhoyCaptain::ComboboxComponent.new(name: "", multiple: false, column: "", url: filters_properties_values_path, select_html: { "data-property-filter-target" => 'value', id: "property-value" }, disabled: true) %>
+          <% end %>
+
+        </fieldset>
+
+      </div>
+    <% end %>
+  <% end %>
+
+  <%= render AhoyCaptain::Filter::ModalComponent.new(title: "Custom Range", id: "customRangeModal") do |modal| %>
+    <% modal.with_modal_display do %>
+      <div class="flex gap-2 w-full">
+        <div class="form-control w-full max-w-xs">
+          <label class="label" for="start_date">
+            <span class="label-text">Start Date</span>
+          </label>
+          <input type="datetime-local" id="start_date" name="start_date" class="input input-bordered w-full" value="<%= params[:start_date] %>" />
+        </div>
+        <div class="form-control w-full max-w-xs">
+          <label class="label" for="end_date">
+            <span class="label-text">End Date</span>
+          </label>
+          <input type="datetime-local" id="end_date" name="end_date" class="input input-bordered w-full" value="<%= params[:end_date] %>" />
+        </div>
+      </div>
+    <% end %>
+  <% end %>
+
+  <%= render AhoyCaptain::Filter::ModalComponent.new(title: "Custom Comparison", id: "customComparisonModal") do |modal| %>
+    <% modal.with_modal_display do %>
+      <div class="flex gap-2 w-full">
+        <div class="form-control w-full max-w-xs">
+          <label class="label" for="start_date">
+            <span class="label-text">Start Date</span>
+          </label>
+          <input type="datetime-local" id="start_date" name="compare_to_start_date" class="input input-bordered w-full" value="<%= params[:compare_to_start_date] %>" />
+        </div>
+        <div class="form-control w-full max-w-xs">
+          <label class="label" for="end_date">
+            <span class="label-text">End Date</span>
+          </label>
+          <input type="datetime-local" id="end_date" name="compare_to_end_date" class="input input-bordered w-full" value="<%= params[:compare_to_end_date] %>" />
+        </div>
+      </div>
+    <% end %>
+  <% end %>
+<% end %>