ahoy_captain 0.83 → 0.91

data/lib/ahoy_captain/configuration.rb

@@ -1,9 +1,10 @@
 require 'ahoy_captain/period_collection'
+require 'ahoy_captain/filters_configuration'
 
 module AhoyCaptain
   class Configuration
     attr_accessor :view_name, :theme
-    attr_reader :goals, :funnels, :cache, :ranges, :disabled_widgets, :event, :models
+    attr_reader :goals, :funnels, :cache, :ranges, :disabled_widgets, :event, :models, :filters, :predicate_labels
     def initialize
       @goals = GoalCollection.new
       @funnels = FunnelCollection.new
@@ -14,15 +15,24 @@ module AhoyCaptain
         option.store = Rails.cache
         option.ttl = 1.minute
       end
-      @event = ActiveSupport::OrderedOptions.new.tap do |option|
-        option.view_name = "$view"
-        option.url_column = "CONCAT(ahoy_events.properties->>'controller', '#', ahoy_events.properties->>'action')"
-        option.url_exists = "JSONB_EXISTS(ahoy_events.properties, 'controller') AND JSONB_EXISTS(ahoy_events.properties, 'action')"
-      end
       @models = ActiveSupport::OrderedOptions.new.tap do |option|
         option.event = "::Ahoy::Event"
         option.visit = "::Ahoy::Visit"
       end
+      @event = ActiveSupport::OrderedOptions.new.tap do |option|
+        option.view_name = "$view"
+        option.url_column = "CONCAT(#{@models.event.parameterize.tableize}.properties->>'controller', '#', #{@models.event.parameterize.tableize}.properties->>'action')"
+        option.url_exists = "JSONB_EXISTS(#{@models.event.parameterize.tableize}.properties, 'controller') AND JSONB_EXISTS(#{@models.event.parameterize.tableize}.properties, 'action')"
+      end
+      @filters = FiltersConfiguration.load_default
+      @predicate_labels = {
+        eq: 'equals',
+        not_eq: 'not equals',
+        cont: 'contains',
+        in: 'in',
+        not_in: 'not in',
+      }
+
       @disabled_widgets = []
     end
 

data/lib/ahoy_captain/engine.rb

@@ -8,6 +8,23 @@ require 'groupdate'
 require 'pagy'
 require 'zip'
 
+module Ransack
+  module Nodes
+    class Condition
+
+      # allows for sql from a formatter
+      # see https://github.com/activerecord-hackery/ransack/issues/702
+      def casted_array?(predicate)
+        return unless predicate.is_a?(Arel::Nodes::Casted)
+
+        predicate.value.is_a?(Array)
+      end
+
+    end
+  end
+end
+
+
 module AhoyCaptain
   class Engine < Rails::Engine
     isolate_namespace ::AhoyCaptain

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,73 @@
+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 Tag") 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
+      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

@@ -33,7 +33,7 @@ module AhoyCaptain
     include Enumerable
 
     def initialize
-      @goals = {}
+      @goals = {}.with_indifferent_access
     end
 
     def register(goal)

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.83"
+  VERSION = "0.91"
 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'
 

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

@@ -81,6 +81,31 @@ AhoyCaptain.configure do |config|
   # Set to false to disable custom ranges
   # config.ranges.custom = true
 
+  # ==> 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
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_captain
 version: !ruby/object:Gem::Version
-  version: '0.83'
+  version: '0.91'
 platform: ruby
 authors:
 - joshmn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -283,6 +283,7 @@ files:
 - app/assets/javascript/ahoy_captain/controllers/application_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/item_controller.js
 - app/assets/javascript/ahoy_captain/controllers/filter_form_controller.js
 - app/assets/javascript/ahoy_captain/controllers/filter_tag_controller.js
 - app/assets/javascript/ahoy_captain/controllers/funnel_chart_controller.js
@@ -292,11 +293,14 @@ files:
 - app/assets/javascript/ahoy_captain/controllers/predicate_select_controller.js
 - app/assets/javascript/ahoy_captain/controllers/realtime_controller.js
 - app/assets/javascript/ahoy_captain/controllers/search_select_controller.js
+- app/assets/javascript/ahoy_captain/controllers/toggle_controller.js
 - app/assets/manifest/ahoy_captain/manifest.js
 - 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
@@ -305,6 +309,8 @@ 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/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
@@ -373,6 +379,7 @@ files:
 - app/decorators/ahoy_captain/top_page_decorator.rb
 - app/helpers/ahoy_captain/application_helper.rb
 - app/models/ahoy_captain/export.rb
+- app/models/ahoy_captain/filter_parser.rb
 - app/models/ahoy_captain/rangeable.rb
 - app/models/ahoy_captain/widget.rb
 - app/models/concerns/ahoy_captain/range_options.rb
@@ -419,6 +426,7 @@ files:
 - 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
@@ -433,9 +441,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