ahoy_captain 0.91 → 1.0.0

data/app/components/ahoy_captain/tables/devices_table_component.rb

@@ -0,0 +1,11 @@
+module AhoyCaptain
+  module Tables
+    class DevicesTableComponent < DynamicTable
+      register do
+        progress_bar :display_name, value: :count, max: :total_count, title: "Device"
+        number :count, title: "Visitors"
+      end
+
+    end
+  end
+end

data/app/components/ahoy_captain/tables/dynamic_table.rb

@@ -0,0 +1,13 @@
+module AhoyCaptain
+  module Tables
+    class DynamicTable
+      def self.register(options = {}, &block)
+        @table ||= DynamicTableComponent.build(self, options, &block)
+      end
+
+      def self.table
+        @table
+      end
+    end
+  end
+end

data/app/components/ahoy_captain/tables/dynamic_table_component.rb

@@ -0,0 +1,204 @@
+module AhoyCaptain
+  module Tables
+    class DynamicTableComponent < ViewComponent::Base
+      class TableDefinition
+        attr_reader :rows
+        class Row
+          attr_reader :attribute, :view_context
+          attr_reader :item
+          def initialize(attribute, options = {}, &block)
+            @attribute = attribute
+            @options = options
+            @block = block
+            @view_context = nil
+          end
+
+          def render(item, view_context)
+            @view_context = view_context
+            @item = item
+            if @options[:type] == :progress_bar
+              progress_bar(item)
+            else
+              if @block
+                column(@block.call(item))
+              else
+                column(item.public_send(attribute).presence)
+              end
+            end
+
+          end
+
+          def header
+            @options[:title] || @attribute.to_s.titleize
+          end
+
+          def link_to(*args)
+            @view_context.link_to(*args)
+          end
+
+          def request
+            @view_context.request
+          end
+
+          def h
+            @view_context.helpers
+          end
+
+          def search_params
+            @view_context.search_params
+          end
+
+          # needed for tricky instance_eval with blocks and view_context
+          def method_missing(method, *args, &block)
+            if klass.respond_to?(method)
+              klass.send(method, *args, &block)
+            else
+              @item.send method, *args, &block
+            end
+          end
+
+          def klass
+            @options[:klass]
+          end
+
+          def progress_bar(item)
+            @item = item
+            value = if @options[:value]
+                      build_option(item, @options[:value]).to_s
+                    else
+                      item.public_send(@attribute)
+                    end
+
+            max = build_option(item, @options[:max]).to_s
+            label = if @block
+                      instance_eval(&@block)
+                    else
+                      item.public_send(@attribute)
+                    end.to_s
+
+            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-primary-content") do
+              label
+            end
+
+            items.join.html_safe
+          end
+
+          def build_option(item, value)
+            if value.is_a?(Symbol)
+              item.public_send(value)
+            else
+              value
+            end
+          end
+
+          def column(value = nil, &block)
+            view_context.content_tag(:span, class: "w-8 ml-8 text-right") do
+              if value
+                if @options[:formatter]
+                  if respond_to?(@options[:formatter])
+                    public_send(@options[:formatter], value)
+                  else
+                    view_context.public_send(@options[:formatter], value)
+                  end
+                else
+                  value.to_s
+                end
+              else
+                view_context.capture(&block).to_s
+              end
+            end
+          end
+
+          def number_to_human(amount)
+            tooltip(amount) do
+              view_context.number_to_human(amount, format: '%n%u', precision: 2, units: { thousand: 'k', million: 'm', billion: 'b' })
+            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(view_context)
+          end
+        end
+
+        def initialize(klass)
+          @klass = klass
+          @rows = []
+        end
+
+        def column(key = nil, options = {}, &block)
+          options[:klass] = @klass
+          @rows << Row.new(key, options, &block)
+
+          self
+        end
+
+        def progress_bar(*args, &block)
+          options = args.extract_options!
+          options.assert_valid_keys(:value, :max, :title)
+          options[:klass] = @klass
+
+          @rows << Row.new(args[0], options.merge(type: :progress_bar), &block)
+
+          self
+        end
+
+        def number(key = nil, options = {}, &block)
+          options[:klass] = @klass
+
+          @rows << Row.new(key, options.merge(formatter: :number_to_human), &block)
+
+          self
+        end
+
+        def percent(key = nil, options = {}, &block)
+          options[:klass] = @klass
+
+          @rows << Row.new(key, options.merge(formatter: :number_to_percentage), &block)
+
+          self
+        end
+
+        def row(item, view_context)
+          items = []
+          @rows.each do |row|
+            items << row.render(item, view_context)
+          end
+          items.join.html_safe
+        end
+      end
+
+      def self.build(klass, options = {}, &block)
+        if options.key?(:fixed_height)
+          options[:header_options] = { fixed_height: options.delete(:fixed_height) }
+        end
+        table = TableDefinition.new(klass).instance_exec(&block)
+        new(klass, table, options)
+      end
+
+      def initialize(klass, table, options = {})
+        @klass = klass
+        @table = table
+        @options = options
+      end
+
+      def for(item)
+        @item = item
+        self
+      end
+
+      def row(item, view_context)
+        @table.row(item, view_context)
+      end
+
+      def headers
+        HeaderComponent.new(@table.rows.map.with_index { |row, index| { label: row.header, grow: index.zero? } }, @options[:header_options] || {})
+      end
+    end
+  end
+end

data/app/components/ahoy_captain/tables/goals_table_component.rb

@@ -0,0 +1,17 @@
+module AhoyCaptain
+  module Tables
+    class GoalsTableComponent < DynamicTable
+      register fixed_height: false do
+        progress_bar value: :cr, max: 100, title: "Name" do |row|
+          search_params = view_context.search_params
+          query = search_params.dup.merge(q: { goal_in: row.goal_id}).to_query
+          url = AhoyCaptain::Engine.app.url_helpers.root_path + "?#{query}"
+          link_to row.item.name, url, target: :_top
+        end
+        number :unique_visits, title: "Uniques"
+        number :total_events, title: "Total"
+        percent :cr, title: "CR"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+<div class="flex text-sm font-bold  mb-4">
+  <% @headers.each do |header| %>
+  <span class="<%= header[:grow] ? 'grow' : 'w-8 ml-8 text-right' %>"><%= header[:label] %></span>
+  <% end %>
+</div>

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

@@ -0,0 +1,18 @@
+module AhoyCaptain
+  module Tables
+    class HeaderComponent < ViewComponent::Base
+      def initialize(headers, options = {})
+        @headers = headers.flatten
+        @options = options
+      end
+
+      def fixed_height?
+        if @options.key?(:fixed_height)
+          @options[:fixed_height]
+        else
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,10 @@ module AhoyCaptain
           @category_name = category_name
           @unit_name = unit_name
         end
+
+        def fixed_height?
+          true
+        end
       end
     end
   end

data/app/components/ahoy_captain/tables/properties_table_component.rb

@@ -0,0 +1,27 @@
+module AhoyCaptain
+  module Tables
+    class PropertiesTableComponent < DynamicTable
+      register do
+        progress_bar :label, value: :percentage, max: 100, title: "Name" do |item|
+          link_to item.label, url(item), target: :_top
+        end
+        number :unique_visitors_count, title: "Visitors"
+        number :events_count, title: "Events"
+        percent :percentage, title: "%"
+      end
+
+      def self.url(item)
+        name = Base64.decode64(item.request.params[:id])
+        params = item.search_params.dup
+        if params["q"] && params["q"].key?("properties_json_cont")
+          json = JSON.parse(params["q"]["properties_json_cont"])
+          json[name] = item.item.label
+          params["q"]["properties_json_cont"] = json.to_json
+        else
+          params[:q] = { "properties_json_cont" => { name => item.item.label }.to_json }
+        end
+        params
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+<% @rows.each do |row| %>
+  <%= row.render(@item, view_context) %>
+
+<% end %>

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

@@ -27,7 +27,6 @@ module AhoyCaptain
           end
         end
 
-
         def percent_total(item)
           '%.1f' % ((item.unit_amount.to_i * 1.0 / total)*100.0)
         end

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

@@ -1,13 +1,23 @@
-<div class="card card-compact <%= 'lg:col-span-2' if wide %> col-span-1 p-4 shadow-xl rounded-md p-8 mx-4 lg:mx-0 bg-base-100 ">
-  <div class="flex justify-between">
-    <h2 class="card-title"><%= title %></h2>
-    <div class="flex self-center gap-3">
-      <%= display_links %>
+<div
+  data-controller="tile"
+  class="card card-compact <%= 'lg:col-span-2' if wide %> col-span-1 shadow-xl rounded-md lg:mx-0 bg-base-200 <%= @classes %>">
+  <% if title.present? || display_links.present? %>
+    <div class="flex justify-between">
+      <% if title.present? %>
+        <h2 class="card-title" data-tile-target="title"><%= title %></h2>
+      <% end %>
+      <% if display_links.present? %>
+        <div class="flex self-center lg:gap-3">
+          <%= display_links %>
+        </div>
+      <% end %>
     </div>
-  </div>
+  <% end %>
 
   <%= statistic_display %>
-  <div class="flex justify-center">
-    <%= details_cta %>
-  </div>
+  <% if details_cta.present? %>
+    <div class="flex justify-center">
+      <%= details_cta %>
+    </div>
+  <% end %>
 </div>

data/app/components/ahoy_captain/tile_component.rb

@@ -5,11 +5,19 @@ 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

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/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