ahoy_captain 0.8 → 0.10.0

data/app/controllers/ahoy_captain/stats/total_visits_controller.rb

@@ -2,7 +2,8 @@ module AhoyCaptain
   module Stats
     class TotalVisitsController < BaseController
       def index
-        @stats = AhoyCaptain::Stats::TotalVisitorsQuery.call(params).group_by_period(selected_interval, :started_at).count
+        @stats = lazy_window(AhoyCaptain::Stats::TotalVisitorsQuery.call(params).with_lazy_comparison(compare_mode?).group_by_period(selected_interval, :started_at).count)
+        @label = "Visitors"
       end
     end
   end

data/app/controllers/ahoy_captain/stats/unique_visitors_controller.rb

@@ -2,7 +2,9 @@ module AhoyCaptain
   module Stats
     class UniqueVisitorsController < BaseController
       def index
-        @stats = AhoyCaptain::Stats::UniqueVisitorsQuery.call(params).group_by_period(selected_interval, :started_at).count
+        @stats = AhoyCaptain::Stats::UniqueVisitorsQuery.call(params).with_lazy_comparison(compare_mode?).group_by_period(selected_interval, :started_at).count
+        @stats = lazy_window(@stats)
+        @label = "Visitors"
       end
     end
   end

data/app/controllers/ahoy_captain/stats/views_per_visits_controller.rb

@@ -1,18 +1,10 @@
 module AhoyCaptain
   module Stats
     class ViewsPerVisitsController < BaseController
-      include Rangeable
-
-      # @todo: make me a window func
       def index
-        @stats = AhoyCaptain::Stats::ViewsPerVisitQuery.call(params).group_by_period(selected_interval, 'views_per_visit_table.started_at').average(:views_per_visit)
-        if range[1]
-          (range[0].to_date..range[1].to_date).to_a.each do |date|
-            unless @stats.key?(date.to_date)
-              @stats[date.to_date] = 2
-            end
-          end
-        end
+        @stats = lazy_window(AhoyCaptain::Stats::ViewsPerVisitQuery.call(params).with_lazy_comparison(compare_mode?).group_by_period(selected_interval, 'views_per_visit_table.started_at').average(:views_per_visit))
+
+        @label = "Views"
       end
     end
   end

data/app/controllers/ahoy_captain/stats/visit_durations_controller.rb

@@ -2,7 +2,8 @@ module AhoyCaptain
   module Stats
     class VisitDurationsController < BaseController
       def index
-        @stats = AhoyCaptain::Stats::VisitDurationQuery.call(params).group_by_period(selected_interval, 'started_at').average(:duration)
+        @stats = lazy_window(AhoyCaptain::Stats::VisitDurationQuery.call(params).with_lazy_comparison(compare_mode?).group_by_period(selected_interval, 'started_at').average(:duration))
+        @label = "Duration"
       end
     end
   end

data/app/controllers/ahoy_captain/top_pages_controller.rb

@@ -10,17 +10,11 @@ module AhoyCaptain
 
     def index
       results = cached(:top_pages) do
-        event_query.with_routes.select(
-          "#{AhoyCaptain.config.event[:url_column]} as url",
-          "count(*) as count",
-          "sum(count(*)) over() as total_count"
-        )
-                   .group(Arel.sql ("(#{AhoyCaptain.config.event[:url_column]})"))
-                   .order(Arel.sql("count(#{AhoyCaptain.config.event[:url_column]}) desc"))
+        TopPageQuery.call(params)
                    .limit(limit)
       end
 
-      @pages = paginate(results).map { |page| TopPageDecorator.new(page) }
+      @pages = paginate(results).map { |page| TopPageDecorator.new(page, self) }
     end
   end
 end

data/app/decorators/ahoy_captain/application_decorator.rb

@@ -1,15 +1,39 @@
+require 'csv'
+
 module AhoyCaptain
   class ApplicationDecorator
     attr_reader :object
 
-    def initialize(object)
+    def self.to_csv(collection, context)
+      rows = collection.map { |row| new(row, context) }
+      CSV.generate do |csv|
+        csv << csv_map(context.params).keys
+
+        rows.each do |row|
+          items = []
+          csv_map.values.each do |attr|
+            items << row.send(attr)
+          end
+
+          csv << items
+        end
+      end
+    end
+
+    def self.csv_map(params = {})
+      raise NotImplementedError
+    end
+
+    delegate_missing_to :object
+    def initialize(object, context)
       @object = object
+      @context = context
     end
 
     private
 
     def h
-      @h ||= Current.request.view_context
+      @h ||= @context.view_context
     end
 
     def params
@@ -28,7 +52,7 @@ module AhoyCaptain
     end
 
     def request
-      Current.request.request
+      @context.request
     end
   end
 end

data/app/decorators/ahoy_captain/campaign_decorator.rb

@@ -1,5 +1,13 @@
 module AhoyCaptain
   class CampaignDecorator < ApplicationDecorator
+
+    def self.csv_map(params = {})
+      {
+        params[:campaigns_type] => :label,
+        "Total" => :unit_amount
+      }
+    end
+
     def display_name
       if object.label == "Direct/None"
         value = ""

data/app/decorators/ahoy_captain/city_decorator.rb

@@ -1,10 +1,22 @@
 module AhoyCaptain
   class CityDecorator < CountryDecorator
+    def self.csv_map(params = {})
+      {
+        "Country" => :country,
+        "City" => :city,
+        "Total" => :unit_amount
+      }
+    end
+
     def display_name
       search = search_query(country_eq: object.country, city_eq: object.city)
       frame_link("#{country_emoji(object.country)} #{object.city}", search)
     end
 
+    def country
+      "#{country_emoji(object.country)} #{object.country}"
+    end
+
     def unit_amount
       object.count
     end

data/app/decorators/ahoy_captain/country_decorator.rb

@@ -1,6 +1,16 @@
 module AhoyCaptain
   class CountryDecorator < ApplicationDecorator
     EMOJI_MAP = { "AD": "🇦🇩", "AE": "🇦🇪", "AF": "🇦🇫", "AG": "🇦🇬", "AI": "🇦🇮", "AL": "🇦🇱", "AM": "🇦🇲", "AO": "🇦🇴", "AQ": "🇦🇶", "AR": "🇦🇷", "AS": "🇦🇸", "AT": "🇦🇹", "AU": "🇦🇺", "AW": "🇦🇼", "AX": "🇦🇽", "AZ": "🇦🇿", "BA": "🇧🇦", "BB": "🇧🇧", "BD": "🇧🇩", "BE": "🇧🇪", "BF": "🇧🇫", "BG": "🇧🇬", "BH": "🇧🇭", "BI": "🇧🇮", "BJ": "🇧🇯", "BL": "🇧🇱", "BM": "🇧🇲", "BN": "🇧🇳", "BO": "🇧🇴", "BQ": "🇧🇶", "BR": "🇧🇷", "BS": "🇧🇸", "BT": "🇧🇹", "BV": "🇧🇻", "BW": "🇧🇼", "BY": "🇧🇾", "BZ": "🇧🇿", "CA": "🇨🇦", "CC": "🇨🇨", "CD": "🇨🇩", "CF": "🇨🇫", "CG": "🇨🇬", "CH": "🇨🇭", "CI": "🇨🇮", "CK": "🇨🇰", "CL": "🇨🇱", "CM": "🇨🇲", "CN": "🇨🇳", "CO": "🇨🇴", "CR": "🇨🇷", "CU": "🇨🇺", "CV": "🇨🇻", "CW": "🇨🇼", "CX": "🇨🇽", "CY": "🇨🇾", "CZ": "🇨🇿", "DE": "🇩🇪", "DJ": "🇩🇯", "DK": "🇩🇰", "DM": "🇩🇲", "DO": "🇩🇴", "DZ": "🇩🇿", "EC": "🇪🇨", "EE": "🇪🇪", "EG": "🇪🇬", "EH": "🇪🇭", "ER": "🇪🇷", "ES": "🇪🇸", "ET": "🇪🇹", "FI": "🇫🇮", "FJ": "🇫🇯", "FK": "🇫🇰", "FM": "🇫🇲", "FO": "🇫🇴", "FR": "🇫🇷", "GA": "🇬🇦", "GB": "🇬🇧", "GD": "🇬🇩", "GE": "🇬🇪", "GF": "🇬🇫", "GG": "🇬🇬", "GH": "🇬🇭", "GI": "🇬🇮", "GL": "🇬🇱", "GM": "🇬🇲", "GN": "🇬🇳", "GP": "🇬🇵", "GQ": "🇬🇶", "GR": "🇬🇷", "GS": "🇬🇸", "GT": "🇬🇹", "GU": "🇬🇺", "GW": "🇬🇼", "GY": "🇬🇾", "HK": "🇭🇰", "HM": "🇭🇲", "HN": "🇭🇳", "HR": "🇭🇷", "HT": "🇭🇹", "HU": "🇭🇺", "ID": "🇮🇩", "IE": "🇮🇪", "IL": "🇮🇱", "IM": "🇮🇲", "IN": "🇮🇳", "IO": "🇮🇴", "IQ": "🇮🇶", "IR": "🇮🇷", "IS": "🇮🇸", "IT": "🇮🇹", "JE": "🇯🇪", "JM": "🇯🇲", "JO": "🇯🇴", "JP": "🇯🇵", "KE": "🇰🇪", "KG": "🇰🇬", "KH": "🇰🇭", "KI": "🇰🇮", "KM": "🇰🇲", "KN": "🇰🇳", "KP": "🇰🇵", "KR": "🇰🇷", "KW": "🇰🇼", "KY": "🇰🇾", "KZ": "🇰🇿", "LA": "🇱🇦", "LB": "🇱🇧", "LC": "🇱🇨", "LI": "🇱🇮", "LK": "🇱🇰", "LR": "🇱🇷", "LS": "🇱🇸", "LT": "🇱🇹", "LU": "🇱🇺", "LV": "🇱🇻", "LY": "🇱🇾", "MA": "🇲🇦", "MC": "🇲🇨", "MD": "🇲🇩", "ME": "🇲🇪", "MF": "🇲🇫", "MG": "🇲🇬", "MH": "🇲🇭", "MK": "🇲🇰", "ML": "🇲🇱", "MM": "🇲🇲", "MN": "🇲🇳", "MO": "🇲🇴", "MP": "🇲🇵", "MQ": "🇲🇶", "MR": "🇲🇷", "MS": "🇲🇸", "MT": "🇲🇹", "MU": "🇲🇺", "MV": "🇲🇻", "MW": "🇲🇼", "MX": "🇲🇽", "MY": "🇲🇾", "MZ": "🇲🇿", "NA": "🇳🇦", "NC": "🇳🇨", "NE": "🇳🇪", "NF": "🇳🇫", "NG": "🇳🇬", "NI": "🇳🇮", "NL": "🇳🇱", "NO": "🇳🇴", "NP": "🇳🇵", "NR": "🇳🇷", "NU": "🇳🇺", "NZ": "🇳🇿", "OM": "🇴🇲", "PA": "🇵🇦", "PE": "🇵🇪", "PF": "🇵🇫", "PG": "🇵🇬", "PH": "🇵🇭", "PK": "🇵🇰", "PL": "🇵🇱", "PM": "🇵🇲", "PN": "🇵🇳", "PR": "🇵🇷", "PS": "🇵🇸", "PT": "🇵🇹", "PW": "🇵🇼", "PY": "🇵🇾", "QA": "🇶🇦", "RE": "🇷🇪", "RO": "🇷🇴", "RS": "🇷🇸", "RU": "🇷🇺", "RW": "🇷🇼", "SA": "🇸🇦", "SB": "🇸🇧", "SC": "🇸🇨", "SD": "🇸🇩", "SE": "🇸🇪", "SG": "🇸🇬", "SH": "🇸🇭", "SI": "🇸🇮", "SJ": "🇸🇯", "SK": "🇸🇰", "SL": "🇸🇱", "SM": "🇸🇲", "SN": "🇸🇳", "SO": "🇸🇴", "SR": "🇸🇷", "SS": "🇸🇸", "ST": "🇸🇹", "SV": "🇸🇻", "SX": "🇸🇽", "SY": "🇸🇾", "SZ": "🇸🇿", "TC": "🇹🇨", "TD": "🇹🇩", "TF": "🇹🇫", "TG": "🇹🇬", "TH": "🇹🇭", "TJ": "🇹🇯", "TK": "🇹🇰", "TL": "🇹🇱", "TM": "🇹🇲", "TN": "🇹🇳", "TO": "🇹🇴", "TR": "🇹🇷", "TT": "🇹🇹", "TV": "🇹🇻", "TW": "🇹🇼", "TZ": "🇹🇿", "UA": "🇺🇦", "UG": "🇺🇬", "UM": "🇺🇲", "US": "🇺🇸", "UY": "🇺🇾", "UZ": "🇺🇿", "VA": "🇻🇦", "VC": "🇻🇨", "VE": "🇻🇪", "VG": "🇻🇬", "VI": "🇻🇮", "VN": "🇻🇳", "VU": "🇻🇺", "WF": "🇼🇫", "WS": "🇼🇸", "YE": "🇾🇪", "YT": "🇾🇹", "ZA": "🇿🇦", "ZM": "🇿🇲", "ZW": "🇿🇼" }
+    def self.csv_map(params = {})
+      {
+        "Country" => :label,
+        "Total" => :unit_amount
+      }
+    end
+
+    def label
+      "#{country_emoji(country)} #{country}"
+    end
 
     def display_name
       search = search_query(country_eq: object.label)

data/app/decorators/ahoy_captain/device_decorator.rb

@@ -1,8 +1,19 @@
 module AhoyCaptain
   class DeviceDecorator < ApplicationDecorator
+    def self.csv_map(params = {})
+      {
+        "#{params[:devices_type]}" => :label,
+        "Total" => :unit_amount
+      }
+    end
+
     def display_name
-      search = search_query("#{params[:devices_type]}_eq" => object.label)
-      frame_link(object.label, search)
+      search = search_query("#{params[:devices_type]}_eq" => label)
+      frame_link(label, search)
+    end
+
+    def label
+      object.label
     end
 
     def unit_amount

data/app/decorators/ahoy_captain/page_decorator.rb

@@ -1,5 +1,16 @@
 module AhoyCaptain
   class PageDecorator < ApplicationDecorator
+    def self.csv_map(params = {})
+      {
+        "URL" => :label,
+        "Total" => :unit_amount
+      }
+    end
+
+    def label
+      object.url
+    end
+
     def display_name
       search = search_query(type => object.url)
       frame_link(object.url, search)

data/app/decorators/ahoy_captain/region_decorator.rb

@@ -1,10 +1,26 @@
 module AhoyCaptain
   class RegionDecorator < CountryDecorator
+    def self.csv_map(params = {})
+      {
+        "Country" => :country,
+        "Region" => :region,
+        "Total" => :unit_amount
+      }
+    end
+
     def display_name
       search = search_query(region_eq: object.region, country_eq: object.country)
       frame_link("#{country_emoji(object.country)} #{object.region}", search)
     end
 
+    def country
+      "#{country_emoji(object.country)} #{object.country}"
+    end
+
+    def region
+      object.region
+    end
+
     def unit_amount
       object.count
     end

data/app/decorators/ahoy_captain/source_decorator.rb

@@ -1,5 +1,12 @@
 module AhoyCaptain
   class SourceDecorator < ApplicationDecorator
+    def self.csv_map(params = {})
+      {
+        "Domain" => :referring_domain,
+        "Total" => :unit_amount
+      }
+    end
+
     def display_name
       display = %Q(
         <div class='flex justify-start space-x-8 col-span-1 items-center'>

data/app/helpers/ahoy_captain/application_helper.rb

@@ -2,7 +2,36 @@ module AhoyCaptain
   module ApplicationHelper
     include Pagy::Frontend
 
-    SPECIAL_PARAMS = [:campaigns_type, :devices_type]
+    def current_property_filter
+      return nil unless params[:q]
+
+      prop = params[:q].to_unsafe_h.detect { |key, _| key.starts_with?("properties.") }
+      if prop
+        key = prop[0].dup
+        Ransack::Predicate.detect_and_strip_from_string!(key)
+        { key: key, value: prop[1] }
+
+      else
+        nil
+      end
+    end
+
+    def stats_container(value, url, label, formatter, selected = false)
+      if value.is_a?(AhoyCaptain::ComparableQuery::Comparison)
+        ::AhoyCaptain::Stats::ComparableContainerComponent.new(url, label, value, formatter, selected, compare_mode?)
+      else
+        ::AhoyCaptain::Stats::ContainerComponent.new(url, label, value, formatter, selected)
+      end
+    end
+
+    def number_to_duration(duration)
+      if duration
+        "#{duration.in_minutes.to_i}M #{duration.parts[:seconds].to_i}S"
+      else
+        "0M 0S"
+      end
+    end
+
     def ahoy_captain_importmap_tags(entry_point = "application", shim: true)
       safe_join [
         (javascript_importmap_shim_tag if shim),
@@ -17,8 +46,38 @@ module AhoyCaptain
       request.query_parameters
     end
 
-    def special_params
-      params.to_unsafe_h.slice(*SPECIAL_PARAMS)
+    # gets put into the form as a hidden field
+    #
+    def non_filter_ransack_params
+      other_params = {}
+      map = [
+        :start_date,
+        :end_date,
+        :period,
+        :interval,
+        :comparison,
+        :compare_to_start_date,
+        :compare_to_end_date
+      ]
+
+      # properties stuff falls into current_property_filter
+      ransack = [:goal]
+
+      map.each do |key|
+        if params[key]
+          other_params[key] = params[key]
+        end
+      end
+
+      ransack.each do |key|
+        Ransack.predicates.keys.each do |predicate|
+          if value = params.dig(:q, "#{key}_#{predicate}")
+            other_params["q[#{key}_#{predicate}]"] = value
+          end
+        end
+      end
+
+      other_params
     end
 
     def render_pagination

data/app/models/ahoy_captain/comparison_mode.rb

@@ -0,0 +1,72 @@
+module AhoyCaptain
+  class ComparisonMode
+    VALID_COMPARISONS = %w{previous year true}
+
+    include RangeOptions
+    include Rangeable
+
+    attr_reader :params
+    def initialize(params)
+      @params = params
+    end
+
+    # can't compare realtime
+    def enabled?(strict = true)
+      comparing = (params[:comparison].in?(VALID_COMPARISONS) || custom_compare?)
+      if strict
+        comparing && !range.realtime?
+      else
+        comparing
+      end
+    end
+
+    def label
+      if custom_compare?
+        return "Custom period"
+      end
+
+      if type == :true || type == :previous
+        "Previous period"
+      elsif type == :year
+        "Year-over-year"
+      else
+        raise ArgumentError
+      end
+    end
+
+    def compared_to_range
+      return custom_compare if custom_compare?
+
+      if type == :true || type == :previous
+        RangeFromParams.new(period: nil, start_date: (range[0] - (range[1] - range[0])).utc.to_s, end_date: range[0].utc.to_s).build
+      elsif type == :year
+        RangeFromParams.new(period: nil, start_date: range[0].change(year: range[0].year - 1).utc.to_s, end_date: range[1].change(year: range[1].year - 1).utc.to_s).build
+      else
+        raise ArgumentError
+      end
+    end
+
+    def type
+      return params[:comparison].to_sym if params[:comparison].in?(VALID_COMPARISONS)
+      return :custom if custom_compare?
+
+      nil
+    end
+
+    def match_to
+      return params[:compare_to].to_sym if params[:compare_to].in?(%w{dow date})
+
+      nil
+    end
+
+    def custom_compare
+      return nil unless (params[:compare_to_start_date].present? && params[:compare_to_end_date].present?)
+
+      RangeFromParams.new(period: nil, start_date: params[:compare_to_start_date], end_date: params[:compare_to_end_date]).build
+    end
+
+    def custom_compare?
+      custom_compare
+    end
+  end
+end

data/app/models/ahoy_captain/export.rb

@@ -0,0 +1,48 @@
+module AhoyCaptain
+  class Export
+    def initialize(params, context)
+      @params = params
+      @context = context
+      @files = {}
+    end
+
+    def build
+      @files["browsers.csv"] = to_csv(DeviceQuery.call(merged_params(devices_type: "browser")), DeviceDecorator)
+      @files["cities.csv"] = to_csv(CityQuery.call(merged_params), CityDecorator)
+      @files["countries.csv"] = to_csv(CountryQuery.call(merged_params), CountryDecorator)
+      @files["devices.csv"] = to_csv(DeviceQuery.call(merged_params(devices_type: :device_type)), DeviceDecorator)
+      @files["entry_pages.csv"] = to_csv(EntryPagesQuery.call(merged_params), EntryPageDecorator)
+      @files["exit_pages.csv"] = to_csv(ExitPagesQuery.call(merged_params), ExitPageDecorator)
+      @files["operating_systems.csv"] = to_csv(DeviceQuery.call(merged_params(devices_type: "os")), DeviceDecorator)
+      @files["top_pages.csv"] = to_csv(TopPageQuery.call(merged_params), TopPageDecorator)
+      @files["regions.csv"] = to_csv(RegionQuery.call(merged_params), RegionDecorator)
+      @files["sources.csv"] = to_csv(SourceQuery.call(merged_params), SourceDecorator)
+      ["campaign", "content", "medium", "source", "term"].each do |utm|
+        @files["utm_#{utm.pluralize}.csv"] = to_csv(CampaignQuery.call(merged_params(campaigns_type: "utm_#{utm}")), CampaignDecorator)
+      end
+      self
+    end
+
+    def to_zip
+      zip_stream = Zip::OutputStream.write_buffer do |zip|
+        @files.each do |filename, csv|
+          zip.put_next_entry(filename)
+          zip.write(csv)
+        end
+      end
+
+      zip_stream.rewind
+      zip_stream
+    end
+
+    private
+
+    def to_csv(query, decorator)
+      decorator.to_csv(query, @context)
+    end
+
+    def merged_params(params_to_merge = {})
+      @params.dup.merge(params_to_merge)
+    end
+  end
+end

data/app/models/ahoy_captain/filter_parser.rb

@@ -0,0 +1,82 @@
+module AhoyCaptain
+  class FilterParser
+    FILTER_MENU_MAX_SIZE = 2
+    class Item
+      attr_accessor :name, :column, :description, :values, :predicate, :url, :modal, :label
+
+      def title
+        column.titleize
+      end
+    end
+
+    def self.parse(request)
+      new(request).tap do |instance|
+        instance.parse
+      end
+    end
+
+    delegate_missing_to :@items
+
+    def initialize(request)
+      @request = request
+      @params = @request.params
+      @filter_params = @request.params[:q] || {}
+      @items = {}
+    end
+
+    def parse
+      @filter_params.each do |key, values|
+        next if ::AhoyCaptain.event.ransackable_scopes.include?(key.to_sym)
+
+        item = build_item(key, values)
+        @items[key] = item
+      end
+
+      @items
+    end
+
+    private
+
+    def build_item(key, values)
+      item = Item.new
+      item.values = Array(values)
+
+      item.predicate = Ransack::Predicate.detect_and_strip_from_string!(key.dup)
+      item.column = key.delete_suffix("_#{item.predicate}")
+      modal_name = AhoyCaptain.config.filters.detect { |_, filters| filters.include?(item.column) }
+      if modal_name
+        item.modal = modal_name[1].modal_name
+      end
+
+      label = if item.column == "goal"
+                item.values.map { |value| AhoyCaptain.config.goals[value].title }
+              else
+                item.values
+              end.to_sentence(last_word_connector: " or ")
+
+      item.label = if key.start_with?("properties.")
+                           item.modal = "customPropertyFilterModal"
+                           item.column = item.column.dup.delete_prefix("properties.")
+                           label
+                         else
+                           label
+                          end
+
+      item.description = "#{item.label} #{::AhoyCaptain::PredicateLabel[item.predicate]} #{label}"
+      item.url = build_url(key, values)
+      item
+    end
+
+    def build_url(name, values)
+      search_params = @request.query_parameters.deep_dup
+      if search_params["q"][name].is_a?(Array)
+        search_params["q"][name] = search_params["q"][name] - Array(values)
+      else
+        search_params["q"].delete(name)
+      end
+
+      @request.path + "?" + search_params.to_query
+    end
+
+  end
+end

data/app/models/ahoy_captain/range_from_params.rb

@@ -0,0 +1,75 @@
+module AhoyCaptain
+  class RangeFromParams
+    def self.from_params(params)
+
+      compare = ComparisonMode.new(params)
+      new(period: params[:period], start_date: params[:start_date], end_date: params[:end_date], date: params[:date], comparison: compare.enabled?(false), raw: params).tap { |instance| instance.build }
+    end
+
+    attr_reader :params, :range
+    def initialize(period: AhoyCaptain.config.ranges.default, start_date: nil, end_date: nil, date: nil, comparison: false, raw: {})
+      @period = period || AhoyCaptain.config.ranges.default
+      @start_date = start_date
+      @end_date = end_date
+      @date = date
+      @range = nil
+      @comparison = comparison
+      @raw = raw
+    end
+
+    def build
+      if (@start_date.present? && @end_date.present?) || @date.present?
+        if @date
+          @start_date ||= @date.to_datetime.beginning_of_day
+          @end_date ||= @date.to_datetime.end_of_day
+        end
+
+        custom = [@start_date.to_datetime, @end_date.to_datetime].sort
+        duration = (custom[1].to_date -  custom[0].to_date)
+
+        #   if AhoyCaptain.config.ranges.max && (duration.days <= AhoyCaptain.config.ranges.max)
+          @range = Range.new(custom[0].utc, custom[1].utc)
+          return self
+        #   end
+      end
+
+      @range = Range.new(selected_period[0], selected_period[1])
+      self
+    end
+
+    def starts_at
+      Time.at(@range.min)
+    end
+
+    def ends_at
+      if realtime?
+        Time.current
+      else
+        Time.at(@range.max)
+      end
+    end
+
+    def realtime?
+      @range.end.nil?
+    end
+
+    def [](value)
+      if value == 0
+        starts_at
+      elsif value == 1
+        ends_at
+      else
+        raise NoMethodError
+      end
+    end
+
+    # return an integer-based range which works with step
+    def numeric
+      @numeric ||= Range.new(starts_at.to_i, ends_at.to_i)
+    end
+
+    def selected_period
+      AhoyCaptain.config.ranges.for(@period) || AhoyCaptain.config.ranges.default
+    end
+  end
+end

data/app/models/ahoy_captain/rangeable.rb

@@ -1,10 +1,7 @@
 module AhoyCaptain
   module Rangeable
-    include AhoyCaptain::RangeOptions
-
     def period
       params[:period] || AhoyCaptain.config.ranges.default
     end
-
   end
 end

data/app/models/concerns/ahoy_captain/compare_mode.rb

@@ -0,0 +1,19 @@
+module AhoyCaptain
+  module CompareMode
+    def self.included(klass)
+      if klass < ActionController::Base
+        klass.helper_method :compare_mode?
+        klass.helper_method :comparison_label
+      end
+    end
+
+    # doesn't work for realtime and realtime doesn't need a secondary range
+    def compare_mode?
+      comparison_mode.enabled?
+    end
+
+    def comparison_mode
+      @comparison_mode ||= ComparisonMode.new(params)
+    end
+  end
+end