rails_local_analytics 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbb7ca6534efc3666a302a04271092906ec9b2fc65a316d82b7811e2dd962668
-  data.tar.gz: 2cc17d06cf61d6b4b7fd2c559079965fa6c250b12d901b05a3317389e2d5b69d
+  metadata.gz: f0a0bf463e77ac16f76c751e5664ae847146c8e2e7b2fbbef76093512d966af1
+  data.tar.gz: d5c9028dcf9cc3307bb39441f107a0a07afa8f115c013b0edc9512d9ccc0d7e8
 SHA512:
-  metadata.gz: 8d9e8dea022bb79486a8bc6395106841a4f9d056accf68f3534072bac1e205f40df426664ed071abd54715d38b0a00ef879aaa080b4a0a51f6ba3e31b207101e
-  data.tar.gz: e249aa1fb3f83ccaf75ffdb774192de6549889b8fb38b3537f5a99cc5edc6aab7da7d1b01caccb6012ffa4c4695739f2a15107ecbc49804db9e3e61c856ea13f
+  metadata.gz: faa7bf7a4c0ee569aae5873e93358cea48ff0060b9caf14c9b7516390a71698bd42b2308233b87438fce0d85d3804990ee0254bb66090024394caf674c5e0f79
+  data.tar.gz: 71662ed4b26b97d416d9dd8341ccc3576f0e6725af6ece920adef1727fd276871cac65023d8d5d2279d734ce3ee6a6d2f32c0e2c7f75b92856d157d4fe2c8112

data/README.md

@@ -73,6 +73,7 @@ class CreateAnalyticsTables < ActiveRecord::Migration[6.0]
   end
 end
 ```
+The reason we store our anayltics in two separate tables to keep the cardinality of our data low. You may use only a single table but I recommend you try the 2 table approach first and see if it meets your needs. See the performance optimization section for more details.
 
 Add the route for the analytics dashboard at the desired endpoint:
 
@@ -81,11 +82,11 @@ Add the route for the analytics dashboard at the desired endpoint:
 mount RailsLocalAnalytics::Engine, at: "/admin/analytics"
 ```
 
-Its generally recomended to use a background job (especially since we now have [`solid_queue`](https://github.com/rails/solid_queue/)). If you would like to disable background jobs you can use the following config:
+Its generally recomended to use a background job (especially since we now have [`solid_queue`](https://github.com/rails/solid_queue/)). If you would like to disable background jobs you can use the following config option:
 
 ```ruby
 # config/initializers/rails_local_analytics.rb
-RailsLocalAnalytics.config.background_jobs = false # defaults to true
+# RailsLocalAnalytics.config.background_jobs = false # defaults to true
 ```
 
 The next step is to collect traffic.
@@ -157,6 +158,7 @@ There are a few techniques that you can use to tailor the database for your part
   *  Consider just storing "local" or nil instead if the request originated from your website
 - `platform` and `browser_engine` columns
   * Consider dropping either of these if you do not need this information
+- If you want to store everything in one table (which I dont think most people actually need) then you can simply only create one table (I recommend `tracked_requests_by_day_page`) with all of the fields from both tables. This gem will automatically populate all the same fields. You should NOT need to use `:custom_attributes` in this scenario.
 
 ## Usage where a request object is not available
 

data/app/controllers/rails_local_analytics/dashboard_controller.rb

@@ -3,6 +3,7 @@ module RailsLocalAnalytics
     PER_PAGE_LIMIT = 1000
 
     helper_method :pagination_page_number
+    helper_method :display_columns
 
     def index
       params[:type] ||= "page"
@@ -17,17 +18,13 @@ module RailsLocalAnalytics
         return
       end
 
-      if params[:group_by].present? && !@klass.display_columns.include?(params[:group_by])
-        raise ArgumentError
-      end
-
       if params[:start_date].present?
         @start_date = Date.parse(params[:start_date])
       else
         @start_date = Date.today
       end
 
-      if params[:end_date]
+      if params[:end_date].present?
         @end_date = Date.parse(params[:end_date])
       else
         @end_date = Date.today
@@ -63,20 +60,18 @@ module RailsLocalAnalytics
 
       prev_start_date, prev_end_date = get_prev_dates(start_date, end_date)
 
-      where_conditions = params.require(:conditions).permit(*@klass.display_columns)
+      difference_where_conditions = params.require(:conditions).permit(*display_columns)
 
       current_total = fetch_records(
         start_date,
         end_date,
-        where_conditions: where_conditions,
-        pluck_columns: ["SUM(total)"],
+        difference_where_conditions: difference_where_conditions,
       ).first
 
       prev_total = fetch_records(
         prev_start_date,
         prev_end_date,
-        where_conditions: where_conditions,
-        pluck_columns: ["SUM(total)"],
+        difference_where_conditions: difference_where_conditions,
       ).first
 
       if prev_total
@@ -90,13 +85,17 @@ module RailsLocalAnalytics
 
     private
 
-    def fetch_records(start_date, end_date, where_conditions: nil, pluck_columns: nil)
+    def fetch_records(start_date, end_date, difference_where_conditions: nil)
+      aggregate_sql_field = "SUM(total)"
+
       tracked_requests = @klass
         .where("day >= ?", start_date)
         .where("day <= ?", end_date)
-        .order(total: :desc)
+        .order("#{aggregate_sql_field} DESC")
 
-      if where_conditions.nil? && pluck_columns.nil?
+      if difference_where_conditions
+        tracked_requests = tracked_requests.where(difference_where_conditions)
+      else
         tracked_requests = tracked_requests
           .limit(PER_PAGE_LIMIT)
           .offset(PER_PAGE_LIMIT * (pagination_page_number-1))
@@ -104,7 +103,7 @@ module RailsLocalAnalytics
         if params[:filter].present?
           col, val = params[:filter].split("==")
 
-          if @klass.display_columns.include?(col)
+          if display_columns.include?(col)
             tracked_requests = tracked_requests.where(col => val)
           else
             raise ArgumentError
@@ -112,24 +111,43 @@ module RailsLocalAnalytics
         end
       end
 
-      if where_conditions
-        tracked_requests = tracked_requests.where(where_conditions)
-      end
-
       if params[:search].present?
         tracked_requests = tracked_requests.multi_search(params[:search])
       end
 
-      if params[:group_by].present?
-        group_by_columns = [params[:group_by]]
-        pluck_columns = [params[:group_by], "SUM(total)"]
+      if params[:group_by].blank?
+        pluck_columns = display_columns.dup
       else
-        group_by_columns = @klass.display_columns
-        pluck_columns ||= @klass.display_columns + ["SUM(total)"]
+        case params[:group_by]
+        when "url_hostname_and_path"
+          if display_columns.include?("url_hostname") && display_columns.include?("url_path")
+            pluck_columns = [:url_hostname, :url_path]
+          else
+            raise ArgumentError
+          end
+        when "referrer_hostname_and_path"
+          if display_columns.include?("referrer_hostname") && display_columns.include?("referrer_path")
+            pluck_columns = [:referrer_hostname, :referrer_path]
+          else
+            raise ArgumentError
+          end
+        when *display_columns
+          pluck_columns = [params[:group_by]]
+        else
+          raise ArgumentError
+        end
+      end
+
+      group_by = pluck_columns.dup
+
+      if difference_where_conditions
+        pluck_columns = [aggregate_sql_field]
+      else
+        pluck_columns << aggregate_sql_field
       end
 
       tracked_requests
-        .group(*group_by_columns)
+        .group(*group_by)
         .pluck(*pluck_columns)
     end
 
@@ -151,5 +169,9 @@ module RailsLocalAnalytics
       return [prev_start_date, prev_end_date]
     end
 
+    def display_columns
+      @display_columns ||= @klass.display_columns
+    end
+
   end
 end

data/app/views/rails_local_analytics/dashboard/index.html.erb

@@ -1,9 +1,41 @@
-<% data_columns = params[:group_by].present? ? [params[:group_by]] : @klass.display_columns %>
+<%
+  data_columns = params[:group_by].present? ? [params[:group_by]] : display_columns
+
+  if data_columns.first == "url_hostname_and_path"
+    data_columns = ["URL Hostname", "URL Path"]
+  elsif data_columns.first == "referrer_hostname_and_path"
+    data_columns = ["Referrer Hostname", "Referrer Path"]
+  end
+%>
+
+<%
+  group_by_opts = [
+    ["All", nil],
+  ]
+
+  group_by_opts += display_columns.map{|x| [x.titleize.sub("Url ", "URL "), x] }
+
+  if display_columns.include?("url_hostname") && display_columns.include?("url_path")
+    index = group_by_opts.index(["URL Hostname", "url_hostname"])
+    group_by_opts.insert(
+      index,
+      ["URL Hostname and Path", "url_hostname_and_path"],
+    )
+  end
+
+  if display_columns.include?("referrer_hostname") && display_columns.include?("referrer_path")
+    index = group_by_opts.index(["Referrer Hostname", "referrer_hostname"])
+    group_by_opts.insert(
+      index,
+      ["Referrer Hostname and Path", "referrer_hostname_and_path"],
+    )
+  end
+%>
 
 <div class="well well-sm">
   <%= form_tag url_for(params.except(:start_date, :to).to_unsafe_hash), method: "get", id: "search-form" do %>
     <div>
-      <label style="margin-right: 10px;">Group By: <%= select_tag :group_by, options_for_select([["All", nil]] + @klass.display_columns.map{|x| [x.titleize.sub("Url ", "URL "), x]} , params[:group_by]) %></label>
+      <label style="margin-right: 10px;">Group By: <%= select_tag :group_by, options_for_select(group_by_opts, params[:group_by]) %></label>
 
       <label style="margin-right: 10px;">From: <%= date_field_tag :start_date, @start_date %></label>
       <label style="margin-right: 10px;">To: <%= date_field_tag :end_date, @end_date %></label>

data/lib/rails_local_analytics/version.rb

@@ -1,3 +1,3 @@
 module RailsLocalAnalytics
-  VERSION = "0.2.1".freeze
+  VERSION = "0.2.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_local_analytics
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Weston Ganger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +106,8 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/rails_local_analytics_manifest.js
+- app/assets/images/rails_local_analytics/.keep
+- app/assets/javascripts/rails_local_analytics/.keep
 - app/assets/stylesheets/rails_local_analytics/application.css
 - app/controllers/rails_local_analytics/application_controller.rb
 - app/controllers/rails_local_analytics/dashboard_controller.rb