ahoy_captain 0.8 → 0.10.0

data/lib/ahoy_captain/filter_configuration/filter.rb

@@ -0,0 +1,16 @@
+module AhoyCaptain
+  class FilterConfiguration
+    class Filter
+      attr_reader :column, :label, :url, :predicates, :multiple, :position
+
+      def initialize(label:, column:, url:, predicates: [:in, :not_in], multiple: true, position: nil)
+        @column = column
+        @label = label
+        @url = url
+        @predicates = predicates
+        @multiple = multiple
+        @position = position
+      end
+    end
+  end
+end

data/lib/ahoy_captain/filter_configuration/filter_collection.rb

@@ -0,0 +1,48 @@
+module AhoyCaptain
+  class FilterConfiguration
+    class FilterCollection
+      def initialize(label)
+        @label = label
+        @registry = []
+      end
+
+      def filter(label:, column:, url:, predicates: [:in, :not_in], multiple: true, position: nil)
+        position ||= @registry.size
+        if item = find(column)
+          @registry.delete(item)
+        end
+
+        @registry << FilterConfiguration::Filter.new(label: label, column: column, url: url, predicates: predicates, multiple: multiple, position: position)
+        @registry = @registry.sort_by { |filter| filter.position }
+      end
+
+      def each(&block)
+        @registry.each(&block)
+      end
+
+      def modal_name
+        "#{@label.parameterize.underscore}Modal"
+      end
+
+      def find(column)
+        @registry.find { |filter| filter.column == column.to_sym }
+      end
+
+      def delete(name)
+        @registry.delete_if { |filter| filter.column == name }
+      end
+
+      def filters
+        @registry
+      end
+
+      def [](name)
+        find(name)
+      end
+
+      def include?(name)
+        find(name).present?
+      end
+    end
+  end
+end

data/lib/ahoy_captain/filters_configuration.rb

@@ -0,0 +1,77 @@
+require 'ahoy_captain/filter_configuration/filter'
+require 'ahoy_captain/filter_configuration/filter_collection'
+
+module AhoyCaptain
+  class FiltersConfiguration
+    def self.load_default
+      new.tap do |config|
+        config.register("Page") do
+          filter column: :route, label: "Route", url: :filters_actions_path, predicates: [:in, :not_in]
+          filter column: :entry_page, label: "Entry Page", url: :filters_entry_pages_path, predicates: [:in, :not_in]
+          filter column: :exit_page, label: "Exit Page", url: :filters_exit_pages_path, predicates: [:in, :not_in]
+        end
+
+        config.register("Geography") do
+          filter column: :country, label: "Country", url: :filters_locations_countries_path, predicates: [:in, :not_in]
+          filter column: :region, label: "Region", url: :filters_locations_regions_path, predicates: [:in, :not_in]
+          filter column: :city, label: "City", url: :filters_locations_cities_path, predicates: [:in, :not_in]
+        end
+
+        config.register("Source") do
+          filter column: :referring_domain, label: "Source", url: :filters_sources_path, predicates: [:in, :not_in]
+        end
+
+        config.register("Screen size") do
+          filter column: :device_type, label: "Screen size", url: :filters_screens_path, predicates: [:in, :not_in]
+        end
+
+        config.register("Operating System") do
+          filter column: :os, label: "OS Name", url: :filters_names_path, predicates: [:in, :not_in]
+          filter column: :os_version, label: "OS Version", url: :filters_versions_path, predicates: [:in, :not_in]
+        end
+
+        config.register("UTM Tags") do
+          filter column: :utm_medium, label: "UTM Medium", url: :filters_utm_mediums_path, predicates: [:in, :not_in]
+          filter column: :utm_source, label: "UTM Source", url: :filters_utm_sources_path, predicates: [:in, :not_in]
+          filter column: :utm_campaign, label: "UTM Campaign", url: :filters_utm_campaigns_path, predicates: [:in, :not_in]
+          filter column: :utm_term, label: "UTM Term", url: :filters_utm_terms_path, predicates: [:in, :not_in]
+          filter column: :utm_content, label: "UTM Content", url: :filters_utm_contents_path, predicates: [:in, :not_in]
+        end
+
+        config.register("Goal") do
+          filter column: :goal, label: "Goal", url: :filters_goals_path, predicates: [:in]
+        end
+      end
+    end
+
+    def initialize
+      @registry = {}
+    end
+
+    def register(label, &block)
+      item = FilterConfiguration::FilterCollection.new(label)
+      item.instance_exec(&block)
+      @registry[label] = item
+    end
+
+    def [](val)
+      @registry[val]
+    end
+
+    def delete(name)
+      @registry.delete(name)
+    end
+
+    def reset
+      @registry = {}
+    end
+
+    def each(&block)
+      @registry.each(&block)
+    end
+
+    def detect(&block)
+      @registry.detect(&block)
+    end
+  end
+end

data/lib/ahoy_captain/goals.rb

@@ -13,7 +13,15 @@ module AhoyCaptain
     end
 
     def name(value)
-      @event_query = -> { AhoyCaptain.event.where(name: value) }
+      @event_query = -> { ::AhoyCaptain.event.where(name: value) }
+    end
+
+    def event(value)
+      ActiveSupport::Deprecation.warn(
+        "event is deprecated. " \
+    "Use name instead."
+      )
+      name(value)
     end
 
     def query(&block)
@@ -25,7 +33,7 @@ module AhoyCaptain
     include Enumerable
 
     def initialize
-      @goals = {}
+      @goals = {}.with_indifferent_access
     end
 
     def register(goal)

data/lib/ahoy_captain/period_collection.rb

@@ -51,7 +51,7 @@ module AhoyCaptain
       }.each do |param, options|
         instance.add(param, options[:label], options[:range])
       end
-      instance.default = :mtd
+      instance.default = :'30d'
       instance
     end
 

data/lib/ahoy_captain/predicate_label.rb

@@ -0,0 +1,7 @@
+module AhoyCaptain
+  class PredicateLabel
+    def self.[](value)
+      AhoyCaptain.config.predicate_labels[value.to_sym] || value.to_s.titleize
+    end
+  end
+end

data/lib/ahoy_captain/version.rb

@@ -1,3 +1,3 @@
 module AhoyCaptain
-  VERSION = "0.8"
+  VERSION = "0.10.0"
 end

data/lib/ahoy_captain.rb

@@ -4,6 +4,7 @@ require "ahoy_captain/engine"
 require "ahoy_captain/goals"
 require "ahoy_captain/funnels"
 require "ahoy_captain/configuration"
+require "ahoy_captain/predicate_label"
 require 'ahoy_captain/ahoy/visit_methods'
 require 'ahoy_captain/ahoy/event_methods'
 
@@ -27,11 +28,12 @@ module AhoyCaptain
         pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
         pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
         pin "application", to: "ahoy_captain/application.js", preload: true
-        pin "slim-select", to: "https://ga.jspm.io/npm:slim-select@2.6.0/dist/slimselect.es.js", preload: true
         pin "chartkick", to: "chartkick.js"
         pin "Chart.bundle", to: "Chart.bundle.js"
         pin "chartjs-plugin-datalabels", to: "https://cdn.jsdelivr.net/npm/chartjs-plugin-datalabels@2", preload: true
+        pin "classnames", to: "https://cdnjs.cloudflare.com/ajax/libs/classnames/2.3.2/index.min.js", preload: true
         pin_all_from AhoyCaptain::Engine.root.join("app/assets/javascript/ahoy_captain/controllers"), under: "controllers", to: "ahoy_captain/controllers"
+        pin_all_from AhoyCaptain::Engine.root.join("app/assets/javascript/ahoy_captain/helpers"), under: "helpers", to: "ahoy_captain/helpers"
       end
     end
 
@@ -50,5 +52,9 @@ module AhoyCaptain
     def visit
       @visit ||= config.models[:visit].constantize
     end
+
+    def none
+      @none ||= OpenStruct.new(text: "(none)", value: "!none!")
+    end
   end
 end

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

@@ -80,6 +80,33 @@ AhoyCaptain.configure do |config|
   #
   # 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/ahoy_captain/filter_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
@@ -135,4 +162,9 @@ AhoyCaptain.configure do |config|
   #     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_captain
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: 0.10.0
 platform: ruby
 authors:
 - joshmn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-03 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -151,35 +151,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sprockets-rails
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: better_errors
+  name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: binding_of_caller
+  name: better_errors
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +207,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sassc
+  name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -221,7 +221,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: sassc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -235,7 +235,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -249,7 +249,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pp_sql
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -278,23 +278,37 @@ files:
 - app/assets/images/ahoy_captain/logo.png
 - app/assets/images/ahoy_captain/safari-pinned-tab.svg
 - app/assets/javascript/ahoy_captain/application.js
+- app/assets/javascript/ahoy_captain/controllers/active_links_controller.js
 - app/assets/javascript/ahoy_captain/controllers/application.js
 - app/assets/javascript/ahoy_captain/controllers/application_controller.js
+- app/assets/javascript/ahoy_captain/controllers/combobox_controller.js
 - app/assets/javascript/ahoy_captain/controllers/details_modal_controller.js
 - app/assets/javascript/ahoy_captain/controllers/dropdown_label_controller.js
-- app/assets/javascript/ahoy_captain/controllers/filter_controller.js
-- app/assets/javascript/ahoy_captain/controllers/filter_tag_controller.js
+- app/assets/javascript/ahoy_captain/controllers/filter/item_controller.js
+- app/assets/javascript/ahoy_captain/controllers/filter_form_controller.js
+- app/assets/javascript/ahoy_captain/controllers/filter_modal_controller.js
 - app/assets/javascript/ahoy_captain/controllers/funnel_chart_controller.js
 - app/assets/javascript/ahoy_captain/controllers/index.js
 - app/assets/javascript/ahoy_captain/controllers/interval_controller.js
-- app/assets/javascript/ahoy_captain/controllers/link_controller.js
-- app/assets/javascript/ahoy_captain/controllers/navigation_controller.js
+- app/assets/javascript/ahoy_captain/controllers/line_chart_controller.js
+- app/assets/javascript/ahoy_captain/controllers/predicate_select_controller.js
+- app/assets/javascript/ahoy_captain/controllers/properties_controller.js
+- app/assets/javascript/ahoy_captain/controllers/property_filter_controller.js
 - app/assets/javascript/ahoy_captain/controllers/realtime_controller.js
+- app/assets/javascript/ahoy_captain/controllers/tile_controller.js
+- app/assets/javascript/ahoy_captain/controllers/toggle_controller.js
+- app/assets/javascript/ahoy_captain/helpers/chart_utils.js
+- app/assets/javascript/ahoy_captain/helpers/number_formatters.js
 - app/assets/manifest/ahoy_captain/manifest.js
+- app/components/ahoy_captain/combobox_component.html.erb
+- app/components/ahoy_captain/combobox_component.rb
+- app/components/ahoy_captain/comparison_link_component.rb
 - app/components/ahoy_captain/dropdown_button_component.html.erb
 - app/components/ahoy_captain/dropdown_button_component.rb
 - app/components/ahoy_captain/dropdown_link_component.html.erb
 - app/components/ahoy_captain/dropdown_link_component.rb
+- app/components/ahoy_captain/filter/dropdown_component.html.erb
+- app/components/ahoy_captain/filter/dropdown_component.rb
 - app/components/ahoy_captain/filter/modal_component.html.erb
 - app/components/ahoy_captain/filter/modal_component.rb
 - app/components/ahoy_captain/filter/select_component.html.erb
@@ -303,10 +317,26 @@ files:
 - app/components/ahoy_captain/filter/tag_component.rb
 - app/components/ahoy_captain/filter/tag_container_component.html.erb
 - app/components/ahoy_captain/filter/tag_container_component.rb
+- app/components/ahoy_captain/stats/comparable_container_component.html.erb
+- app/components/ahoy_captain/stats/comparable_container_component.rb
+- app/components/ahoy_captain/stats/container_component.html.erb
+- app/components/ahoy_captain/stats/container_component.rb
 - app/components/ahoy_captain/sticky_nav_component.html.erb
 - app/components/ahoy_captain/sticky_nav_component.rb
 - app/components/ahoy_captain/table_component.html.erb
 - app/components/ahoy_captain/table_component.rb
+- app/components/ahoy_captain/tables/devices_table_component.rb
+- app/components/ahoy_captain/tables/dynamic_table.rb
+- app/components/ahoy_captain/tables/dynamic_table_component.rb
+- app/components/ahoy_captain/tables/goals_table_component.rb
+- app/components/ahoy_captain/tables/header_component.html.erb
+- app/components/ahoy_captain/tables/header_component.rb
+- app/components/ahoy_captain/tables/headers/header_component.html.erb
+- app/components/ahoy_captain/tables/headers/header_component.rb
+- app/components/ahoy_captain/tables/properties_table_component.rb
+- app/components/ahoy_captain/tables/row_component.html.erb
+- app/components/ahoy_captain/tables/rows/row_component.html.erb
+- app/components/ahoy_captain/tables/rows/row_component.rb
 - app/components/ahoy_captain/tile_component.html.erb
 - app/components/ahoy_captain/tile_component.rb
 - app/components/ahoy_captain/tooltip_component.html.erb
@@ -318,18 +348,23 @@ files:
 - app/controllers/ahoy_captain/devices_controller.rb
 - app/controllers/ahoy_captain/entry_pages_controller.rb
 - app/controllers/ahoy_captain/exit_pages_controller.rb
+- app/controllers/ahoy_captain/exports_controller.rb
 - app/controllers/ahoy_captain/filters/base_controller.rb
+- app/controllers/ahoy_captain/filters/goals_controller.rb
 - app/controllers/ahoy_captain/filters/locations_controller.rb
 - app/controllers/ahoy_captain/filters/operating_systems/names_controller.rb
 - app/controllers/ahoy_captain/filters/operating_systems/versions_controller.rb
 - app/controllers/ahoy_captain/filters/pages/actions_controller.rb
 - app/controllers/ahoy_captain/filters/pages/entry_pages_controller.rb
 - app/controllers/ahoy_captain/filters/pages/exit_pages_controller.rb
+- app/controllers/ahoy_captain/filters/properties/names_controller.rb
+- app/controllers/ahoy_captain/filters/properties/values_controller.rb
 - app/controllers/ahoy_captain/filters/screens_controller.rb
 - app/controllers/ahoy_captain/filters/sources_controller.rb
 - app/controllers/ahoy_captain/filters/utms_controller.rb
 - app/controllers/ahoy_captain/funnels_controller.rb
 - app/controllers/ahoy_captain/goals_controller.rb
+- app/controllers/ahoy_captain/properties_controller.rb
 - app/controllers/ahoy_captain/realtimes_controller.rb
 - app/controllers/ahoy_captain/regions_controller.rb
 - app/controllers/ahoy_captain/roots_controller.rb
@@ -355,33 +390,49 @@ files:
 - app/decorators/ahoy_captain/source_decorator.rb
 - app/decorators/ahoy_captain/top_page_decorator.rb
 - app/helpers/ahoy_captain/application_helper.rb
-- app/models/ahoy_captain/current.rb
+- app/models/ahoy_captain/comparison_mode.rb
+- app/models/ahoy_captain/export.rb
+- app/models/ahoy_captain/filter_parser.rb
+- app/models/ahoy_captain/range_from_params.rb
 - app/models/ahoy_captain/rangeable.rb
-- app/models/ahoy_captain/url_helpers.rb
 - app/models/ahoy_captain/widget.rb
+- app/models/concerns/ahoy_captain/compare_mode.rb
+- app/models/concerns/ahoy_captain/limitable.rb
 - app/models/concerns/ahoy_captain/range_options.rb
 - app/presenters/ahoy_captain/dashboard_presenter.rb
 - app/presenters/ahoy_captain/funnel_presenter.rb
 - app/presenters/ahoy_captain/goals_presenter.rb
 - app/queries/ahoy_captain/application_query.rb
+- app/queries/ahoy_captain/campaign_query.rb
+- app/queries/ahoy_captain/city_query.rb
+- app/queries/ahoy_captain/country_query.rb
+- app/queries/ahoy_captain/device_query.rb
 - app/queries/ahoy_captain/entry_pages_query.rb
 - app/queries/ahoy_captain/event_query.rb
 - app/queries/ahoy_captain/exit_pages_query.rb
+- app/queries/ahoy_captain/region_query.rb
+- app/queries/ahoy_captain/source_query.rb
 - app/queries/ahoy_captain/stats/average_views_per_visit_query.rb
 - app/queries/ahoy_captain/stats/average_visit_duration_query.rb
+- app/queries/ahoy_captain/stats/base_query.rb
 - app/queries/ahoy_captain/stats/bounce_rates_query.rb
 - app/queries/ahoy_captain/stats/total_pageviews_query.rb
 - app/queries/ahoy_captain/stats/total_visitors_query.rb
 - app/queries/ahoy_captain/stats/unique_visitors_query.rb
 - app/queries/ahoy_captain/stats/views_per_visit_query.rb
 - app/queries/ahoy_captain/stats/visit_duration_query.rb
+- app/queries/ahoy_captain/top_page_query.rb
 - app/queries/ahoy_captain/visit_query.rb
+- app/queries/concerns/ahoy_captain/comparable_queries.rb
+- app/queries/concerns/ahoy_captain/comparable_query.rb
+- app/queries/concerns/ahoy_captain/lazy_comparable_query.rb
 - app/views/ahoy_captain/campaigns/index.html+details.erb
 - app/views/ahoy_captain/campaigns/index.html.erb
 - app/views/ahoy_captain/cities/index.html+details.erb
 - app/views/ahoy_captain/cities/index.html.erb
 - app/views/ahoy_captain/countries/index.html+details.erb
 - app/views/ahoy_captain/countries/index.html.erb
+- app/views/ahoy_captain/devices/_table.html.erb
 - app/views/ahoy_captain/devices/index.html+details.erb
 - app/views/ahoy_captain/devices/index.html.erb
 - app/views/ahoy_captain/entry_pages/index.html+details.erb
@@ -392,9 +443,13 @@ files:
 - app/views/ahoy_captain/funnels/show.html.erb
 - app/views/ahoy_captain/goals/index.html.erb
 - app/views/ahoy_captain/layouts/application.html.erb
+- app/views/ahoy_captain/properties/_form.html.erb
+- app/views/ahoy_captain/properties/index.html.erb
+- app/views/ahoy_captain/properties/show.html.erb
 - app/views/ahoy_captain/realtimes/show.html.erb
 - app/views/ahoy_captain/regions/index.html+details.erb
 - app/views/ahoy_captain/regions/index.html.erb
+- app/views/ahoy_captain/roots/_filters.html.erb
 - app/views/ahoy_captain/roots/show.html.erb
 - app/views/ahoy_captain/sources/index.html+details.erb
 - app/views/ahoy_captain/sources/index.html.erb
@@ -409,9 +464,13 @@ files:
 - lib/ahoy_captain/ahoy/visit_methods.rb
 - lib/ahoy_captain/configuration.rb
 - lib/ahoy_captain/engine.rb
+- lib/ahoy_captain/filter_configuration/filter.rb
+- lib/ahoy_captain/filter_configuration/filter_collection.rb
+- lib/ahoy_captain/filters_configuration.rb
 - lib/ahoy_captain/funnels.rb
 - lib/ahoy_captain/goals.rb
 - lib/ahoy_captain/period_collection.rb
+- lib/ahoy_captain/predicate_label.rb
 - lib/ahoy_captain/railtie.rb
 - lib/ahoy_captain/version.rb
 - lib/generators/ahoy_captain/install_generator.rb