ahoy_captain 0.1.0 → 0.8

data/lib/ahoy_captain/funnels.rb

@@ -0,0 +1,44 @@
+module AhoyCaptain
+  class Funnel
+    attr_accessor :id
+    attr_reader :goals
+
+    def initialize
+      @id = nil
+      @label = nil
+      @goals = []
+    end
+
+    def goal(id)
+      @goals << AhoyCaptain.config.goals[id]
+    end
+
+    def label(value)
+      @label = value
+    end
+
+    def title
+      @label
+    end
+  end
+
+  class FunnelCollection
+    include Enumerable
+
+    def initialize
+      @funnels = {}
+    end
+
+    def register(funnel)
+      @funnels[funnel.id] = funnel
+    end
+
+    def each(&block)
+      @funnels.each(&block)
+    end
+
+    def [](value)
+      @funnels[value.to_sym]
+    end
+  end
+end

data/lib/ahoy_captain/goals.rb

@@ -0,0 +1,43 @@
+module AhoyCaptain
+  class Goal
+    attr_accessor :id
+    attr_reader :title, :event_query
+    def initialize
+      @id = nil
+      @title = nil
+      @event_query = nil
+    end
+
+    def label(value)
+      @title = value
+    end
+
+    def name(value)
+      @event_query = -> { AhoyCaptain.event.where(name: value) }
+    end
+
+    def query(&block)
+      @event_query = block
+    end
+  end
+
+  class GoalCollection
+    include Enumerable
+
+    def initialize
+      @goals = {}
+    end
+
+    def register(goal)
+      @goals[goal.id] = goal
+    end
+
+    def each(&block)
+      @goals.values.each(&block)
+    end
+
+    def [](value)
+      @goals[value]
+    end
+  end
+end

data/lib/ahoy_captain/period_collection.rb

@@ -0,0 +1,115 @@
+module AhoyCaptain
+  class PeriodCollection
+    class Period
+      attr_reader :param, :label, :range
+      def initialize(param:, label:, range:)
+        @param = param
+        @label = label
+        @range = range
+      end
+    end
+
+    def self.load_default
+      instance = new
+      {
+        realtime: {
+          label: "Realtime",
+          range: -> { [1.minute.ago] },
+        },
+        day: {
+          label: "Day",
+          range: -> { [Time.current.beginning_of_day, Time.current] },
+        },
+        '7d': {
+          label: "7 Days",
+          range: -> {  [7.days.ago, Time.current] },
+        },
+        '30d': {
+          label: "30 Days",
+          range: -> { [30.days.ago, Time.current] },
+        },
+        mtd: {
+          label: "Month-to-date",
+          range: -> { [Time.current.beginning_of_month, Time.current] },
+        },
+        lastmonth: {
+          label: "Last month",
+          range: -> { [1.month.ago.beginning_of_month, 1.month.ago.end_of_month] },
+        },
+        ytd: {
+          label: "This year",
+          range: -> { [Time.current.beginning_of_year, Time.current] },
+        },
+        '12mo': {
+          label: "12 months",
+          range: -> { [12.months.ago.to_datetime, Time.current] },
+        },
+        all: {
+          label: "All-time",
+          range: -> { [Date.new(2004, 8, 1).to_datetime, Time.current] },
+        },
+      }.each do |param, options|
+        instance.add(param, options[:label], options[:range])
+      end
+      instance.default = :mtd
+      instance
+    end
+
+    attr_reader :default, :max
+    def initialize
+      @periods = {}
+      @default = nil
+      @max = nil
+    end
+
+    def add(param, label, range_proc)
+      raise ArgumentError, "range must be a proc, or respond to .call" unless range_proc.respond_to?(:call)
+      raise ArgumentError, "range.call must return a range or an array" unless range_proc.call.is_a?(Range) || range_proc.call.is_a?(Array)
+
+      @periods[param.to_sym] = Period.new(param: param, label: label, range: range_proc)
+    end
+
+    def delete(param)
+      @periods.delete(param.to_sym)
+    end
+
+    def reset
+      @periods = {}
+      @default = nil
+    end
+
+    def each(&block)
+      @periods.each(&block)
+    end
+
+    def find(value)
+      @periods[value.try(:to_sym)]
+    end
+
+    def all
+      @periods
+    end
+
+    def default=(val)
+      @default = val.to_sym
+    end
+
+    def max=(amount)
+      @max = amount
+    end
+
+    def for(value)
+      if value.nil?
+        period = @periods[@default]
+      else
+        period = (@periods[value.to_sym] || @periods[@default])
+      end
+
+      if period
+        period.range.call
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/ahoy_captain/railtie.rb

@@ -0,0 +1,7 @@
+module AhoyCaptain
+  class Railtie < ::Rails::Railtie
+    initializer "ahoy_captain.assets.precompile" do |app|
+      app.config.assets.precompile += %w[ahoy_captain/manifest]
+    end
+  end
+end

data/lib/ahoy_captain/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module AhoyCaptain
-  VERSION = "0.1.0"
+  VERSION = "0.8"
 end

data/lib/ahoy_captain.rb

@@ -1,8 +1,54 @@
-# frozen_string_literal: true
+require "ahoy_captain/version"
+require "ahoy_captain/railtie"
+require "ahoy_captain/engine"
+require "ahoy_captain/goals"
+require "ahoy_captain/funnels"
+require "ahoy_captain/configuration"
+require 'ahoy_captain/ahoy/visit_methods'
+require 'ahoy_captain/ahoy/event_methods'
 
-require_relative "ahoy_captain/version"
+require 'importmap-rails'
 
 module AhoyCaptain
-  class Error < StandardError; end
-  # Your code goes here...
+  class << self
+    attr_accessor :configuration
+
+    def cache
+      @cache ||= if config.cache[:enabled]
+                   config.cache[:store]
+                 else
+                   ActiveSupport::Cache::NullStore.new
+                 end
+    end
+
+    def importmap
+      Importmap::Map.new.draw do
+        pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true
+        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_all_from AhoyCaptain::Engine.root.join("app/assets/javascript/ahoy_captain/controllers"), under: "controllers", to: "ahoy_captain/controllers"
+      end
+    end
+
+    def config
+      self.configuration ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    def event
+      @event ||= config.models[:event].constantize
+    end
+
+    def visit
+      @visit ||= config.models[:visit].constantize
+    end
+  end
 end

data/lib/generators/ahoy_captain/install_generator.rb

@@ -0,0 +1,18 @@
+require "rails/generators"
+
+module AhoyCaptain
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.join(__dir__, "templates")
+
+      def copy_templates
+        insert_into_file ::Rails.root.join("app/models/ahoy/event.rb").to_s, "  include AhoyCaptain::Ahoy::EventMethods\n", after: "class Ahoy::Event < ApplicationRecord\n"
+        insert_into_file ::Rails.root.join("app/models/ahoy/visit.rb").to_s, "  include AhoyCaptain::Ahoy::VisitMethods\n", after: "class Ahoy::Visit < ApplicationRecord\n"
+
+        template "config.rb", "config/initializers/ahoy_captain.rb"
+
+        route "mount AhoyCaptain::Engine => '/ahoy_captain'"
+      end
+    end
+  end
+end

data/lib/generators/ahoy_captain/migration_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module AhoyCaptain
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
+
+      def copy_templates
+        migration_template "migration.rb", "db/migrate/create_ahoy_captain_indexes.rb", migration_version: migration_version
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,138 @@
+AhoyCaptain.configure do |config|
+  # ==> Event tracking
+  #
+  # View name
+  # The event you use to dictate if a page view occurred
+  # config.event.view_name = "$view"
+  #
+  # URL column
+  # The properties that indicate what URL was viewed. Ahoy suggested tracking the
+  # controller and action for each view by default, so we use that here.
+  # config.event.url_column = "CONCAT(properties->>'controller', '#', properties->>'action')"
+  #
+  # If you have a `url` key in your `properties`, you could:
+  # config.event.url_column = "properties->>'url'"
+  #
+  # URL exists
+  # A query that indicates if a view event has the correct properties for a page view.
+  # config.event.url_exists = "JSONB_EXISTS(properties, 'controller') AND JSONB_EXISTS(properties, 'action')"
+  #
+  # ==> Models
+  #
+  # Ahoy::Event model
+  # config.models.event = '::Ahoy::Event'
+  #
+  # Ahoy::Visit model
+  # config.models.visit = '::Ahoy::Visit'
+  #
+  #
+  # ==> Theme
+  #
+  # https://daisyui.com/docs/themes/
+  # config.theme = "dark"
+
+  # ==> Disabled widgets
+  # Some widgets are more expensive than others. You can disable them here.
+  #
+  # Here's the list of widgets:
+  #   * sources
+  #   * campaigns.utm_medium
+  #   * campaigns.utm_source
+  #   * campaigns.utm_term
+  #   * campaigns.utm_content
+  #   * campaigns.utm_campaign
+  #   * top_pages
+  #   * entry_pages
+  #   * landing_pages
+  #   * locations.countries
+  #   * locations.regions
+  #   * locations.cities
+  #   * devices.browsers
+  #   * devices.operating_systems
+  #   * devices.device_types
+  #
+  # config.disabled_widgets = []
+
+  # ==> Time periods
+  #
+  # Defaults come from lib/ahoy_captain/period_collection.rb
+  #
+  # If you want your own entirely, first call reset.
+  # config.ranges.reset
+  #
+  # Then you can add your own.
+  # config.ranges.add :param_name, "Label", -> { [3.days.ago, Date.today] }
+  #
+  # You can also remove an existing one:
+  # config.ranges.delete(:mtd)
+  #
+  # Or add to the defaults:
+  # config.ranges.add :custom, "Custom", -> { [6.hours.ago, 2.minutes.ago] }
+  #
+  # Or overwrite the defaults:
+  # config.ranges.add :mtd, "Custom MTD", -> { [2.weeks.ago, Time.current] }
+  #
+  # And handle the default range, which will be used if no range is given:
+  # config.ranges.default = '3d'
+  #
+  # The max range if a custom range is sent
+  # config.ranges.max = 180.days
+  #
+  # Set to false to disable custom ranges
+  # config.ranges.custom = true
+
+  # ==> Caching
+  # config.cache.enabled = false
+  #
+  # Cache store should be an ActiveSupport::Cache::Store instance
+  # config.cache.store = Rails.cache
+  #
+  # TTL
+  # config.cache.ttl = 1.minute
+
+  #==> Goal tracking
+  # Your mother told you to have goals. Track those goals.
+  #
+  # Basically:
+  #
+  #   config.goal :unique_id do
+  #     label "Some label here"
+  #     name "The event name you're tracking in your Ahoy::Event table"
+  #   end
+  #
+  # Real-world example:
+  #
+  #   config.goal :appointment_paid do
+  #     label "Appointment Paid"
+  #     name "$appointment.paid"
+  #   end
+  #
+  # You can also use queries:
+  #
+  #   config.goal :appointment_paid do
+  #     label "Appointment Paid"
+  #     query do
+  #       ::Ahoy::Event.where(...)
+  #     end
+  #   end
+
+  # ==> Funnels
+  # Your mother definitely didn't tell you about conversation rate.
+  # Except, you're here, so...
+  #
+  # Basically:
+  #
+  #   config.funnel :id do
+  #     label "Some label"
+  #     goal :goal_id_1
+  #     goal :goal_id_2
+  #   end
+  #
+  # Real-world example:
+  #
+  #   config.funnel :appointments do
+  #     label "Appointment Workflow"
+  #     goal :appointment_created
+  #     goal :appointment_paid
+  #   end
+end

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

@@ -0,0 +1,7 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_index :<%= ::AhoyCaptain.visit.table_name %>, :started_at unless index_exists?(:<%= ::AhoyCaptain.visit.table_name %>, :started_at)
+    add_index :<%= ::AhoyCaptain.event.table_name %>, :visit_id unless index_exists?(:<%= ::AhoyCaptain.event.table_name %>, :visit_id)
+    add_index :<%= ::AhoyCaptain.event.table_name %>, :time unless index_exists?(:<%= ::AhoyCaptain.event.table_name %>, :time)
+  end
+end