rails_local_analytics 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ffdaa293f22790a92032f05322b5ceec16f7fa5ca6fe0d853f7ee2c22cb43a7
-  data.tar.gz: 6d40a7a31467662aeda69cf7e2d6ad7f427c7cae14de922b70b8a0fc5003c7ce
+  metadata.gz: 6c1dffba4cbead6faa6192e3c1df830aa749f6f653bdc8f0eef6e9dbd3a2650b
+  data.tar.gz: b0b6a574e09786c7888c4e6194fff36616f9d0634d99773955e762417ee3c828
 SHA512:
-  metadata.gz: 5a3c7cd5cda651680348f9b6feaba06ca917e6b55380fc5b9ec26713391ead71dd89830b209435eff75a3021a624c93a82e69ae5a9173c05d3a4918646d014d7
-  data.tar.gz: e1eda84eff2b599049bd837c69de93bfcf58614d31b9f437233f6a6e0ac881b0112746ea515275d5dac98b3de0d66ee13524f1038dfed0b33c24c02a003cf018
+  metadata.gz: 021fcb8b029ce1d842415eb5a4a3ed39a433726851988891455f2aa1ec510a1f56acc9563bad3003b799624384a8ff74ef40183e0a81746df82bb1d3b68d2e24
+  data.tar.gz: 6c9d8b537f1de5f9b28b1b6e6baac6135a389a1ba65bb5dbc19a4ebdd7b73e1efaf855e6daaaa81b8b06b0a2d1913e0d0cdc97fd31635c794d545238751820c6

data/README.md

@@ -138,6 +138,9 @@ Some examples of additional things you may want to track:
   * You may not need to store this in a new column, one example pattern could be to store this data in the existing `platform` database field
 - Country detection
   * Country detection is difficult. As such we dont try to include it by default.
+  * Consider using language detection instead
+- Language detection
+  * You can gather the language from the `request.env["HTTP_ACCEPT_LANGUAGE"]` or `browser.accept_language.first.full`
 - Users or organizations
   * You may want to track your users or another model which is a core tenant to your particular application
 

data/app/assets/stylesheets/rails_local_analytics/application.css

@@ -2,6 +2,10 @@ body{
   padding-bottom: 20px;
 }
 
+table td{
+  overflow-wrap: anywhere;
+}
+
 input, select {
   border-radius: 5px;
   border: 1px solid #333;

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])
-        params[:group_by] = nil
-      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,36 +85,69 @@ 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))
-      end
 
-      if where_conditions
-        tracked_requests = tracked_requests.where(where_conditions)
+        if params[:filter].present?
+          col, val = params[:filter].split("==")
+
+          if display_columns.include?(col)
+            tracked_requests = tracked_requests.where(col => val)
+          else
+            raise ArgumentError
+          end
+        end
       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
 
@@ -141,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,31 +1,76 @@
-<% data_columns = params[:group_by].present? ? [params[:group_by]] : @klass.display_columns %>
-
-<%= form_tag url_for(params.except(:start_date, :to).to_unsafe_hash), method: "get", class: "well well-sm", 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;">From: <%= date_field_tag :start_date, @start_date %></label>
-    <label style="margin-right: 10px;">To: <%= date_field_tag :end_date, @end_date %></label>
+<%
+  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(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>
+
+      <label style="margin-right: 10px;">Search: <%= text_field_tag :search, params[:search] %></label>
+  <% end %>
 
-    <label style="margin-right: 10px;">Search: <%= text_field_tag :search, params[:search] %></label>
-  </div>
+  <% if params[:filter] %>
+    <div>
+      <label>Active Filter:</label>
+      <div class="badge badge-primary" style="margin-top: 5px; margin-bottom: 10px;">
+        <% filter_col, filter_val = params[:filter].split("==") %>
+        <%= filter_col.titleize.sub("Url ", "URL ") %> = "<%= filter_val %>"
+      </div>
+      <%= link_to "Remove Filter", url_for(params.to_unsafe_h.merge(filter: nil)) %>
+    </div>
+  <% end %>
 
   <div>
-    <%= link_to "Today", url_for(params.merge(start_date: Date.today, end_date: Date.today).to_unsafe_hash) %>
+    <%= link_to "Today", url_for(params.merge(start_date: Date.today, end_date: Date.today).to_unsafe_hash), style: ("font-weight: bold;" if @start_date == Date.today && @end_date == Date.today) %>
     |
-    <%= link_to "Yesterday", url_for(params.merge(start_date: (Date.today - 1.day), end_date: (Date.today - 1.day)).to_unsafe_hash) %>
+    <% yesterday = Date.today - 1.day %>
+    <%= link_to "Yesterday", url_for(params.merge(start_date: yesterday, end_date: yesterday).to_unsafe_hash), style: ("font-weight: bold;" if @start_date == yesterday && @end_date == yesterday) %>
     |
-    <%= link_to "Last 7 days", url_for(params.merge(start_date: 7.days.ago.to_date, end_date: Date.today).to_unsafe_hash) %>
+    <%= link_to "Last 7 days", url_for(params.merge(start_date: 7.days.ago.to_date, end_date: Date.today).to_unsafe_hash), style: ("font-weight: bold;" if @start_date == 7.days.ago.to_date && @end_date == Date.today) %>
     |
-    <%= link_to "Last 30 days", url_for(params.merge(start_date: 30.days.ago.to_date, end_date: Date.today).to_unsafe_hash) %>
+    <%= link_to "Last 30 days", url_for(params.merge(start_date: 30.days.ago.to_date, end_date: Date.today).to_unsafe_hash), style: ("font-weight: bold;" if @start_date == 30.days.ago.to_date && @end_date == Date.today) %>
     |
-    <%= link_to "Last 3 Months", url_for(params.merge(start_date: 3.months.ago.to_date, end_date: Date.today).to_unsafe_hash) %>
+    <%= link_to "Last 3 Months", url_for(params.merge(start_date: 3.months.ago.to_date, end_date: Date.today).to_unsafe_hash), style: ("font-weight: bold;" if @start_date == 3.months.ago.to_date && @end_date == Date.today) %>
     |
-    <%= link_to "Last 6 Months", url_for(params.merge(start_date: 6.months.ago.to_date, end_date: Date.today).to_unsafe_hash) %>
+    <%= link_to "Last 6 Months", url_for(params.merge(start_date: 6.months.ago.to_date, end_date: Date.today).to_unsafe_hash), style: ("font-weight: bold;" if @start_date == 6.months.ago.to_date && @end_date == Date.today) %>
     |
-    <%= link_to "Last Year", url_for(params.merge(start_date: 1.year.ago.to_date, end_date: Date.today).to_unsafe_hash) %>
+    <%= link_to "Last Year", url_for(params.merge(start_date: 1.year.ago.to_date, end_date: Date.today).to_unsafe_hash), style: ("font-weight: bold;" if @start_date == 1.year.ago.to_date && @end_date == Date.today) %>
   </div>
-<% end %>
+</div>
 
 <h2>Requests by <%= params[:type].titleize %></h2>
 
@@ -33,7 +78,7 @@
   <thead>
     <% data_columns.each do |header| %>
       <th>
-        <%= header.sub("Url ", "URL ") %>
+        <%= header.titleize.sub("Url ", "URL ") %>
       </th>
     <% end %>
 
@@ -42,22 +87,23 @@
     </th>
 
     <th>
-      Difference from previous period
+      Prev Period Difference
     </th>
   </thead>
 
   <tbody>
     <% @results.each_with_index do |row, row_index| %>
       <tr>
-        <% row[0..-2].each do |value| %>
+        <% row[0..-2].each_with_index do |value, col_index| %>
           <td>
-            <%= value %>
+            <% filter_param = "#{data_columns[col_index]}==#{value}" %>
+            <%= link_to (value || ""), url_for(params.to_unsafe_h.merge(filter: filter_param)), title: "Filter" %>
           </td>
         <% end %>
 
         <td>
           <% total = row.last %>
-          <%= total.to_fs(:delimited) %>
+          <%= number_with_delimiter(total) %>
         </td>
 
         <td>
@@ -85,7 +131,7 @@
             <% prev_period_row_index = @prev_period_results.index{|prev_period_row| row[0..-2] == prev_period_row[0..-2] } %>
 
             <% if prev_period_row_index.nil? %>
-              +<%= total.to_fs(:delimited) %>
+              +<%= number_with_delimiter(total) %>
             <% else %>
               <% prev_period_row = @prev_period_results.delete_at(prev_period_row_index) %>
 
@@ -93,9 +139,9 @@
               <% diff = total - prev_period_total %>
 
               <% if diff >= 0 %>
-                +<%= diff.to_fs(:delimited) %>
+                +<%= number_with_delimiter(diff) %>
               <% else %>
-                <%= diff.to_fs(:delimited) %>
+                <%= number_with_delimiter(diff) %>
               <% end %>
             <% end %>
           <% end %>

data/lib/rails_local_analytics/version.rb

@@ -1,3 +1,3 @@
 module RailsLocalAnalytics
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_local_analytics
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Weston Ganger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2024-12-12 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
@@ -97,7 +111,6 @@ files:
 - app/controllers/rails_local_analytics/dashboard_controller.rb
 - app/jobs/rails_local_analytics/application_job.rb
 - app/jobs/rails_local_analytics/record_request_job.rb
-- app/lib/rails_local_analytics/histogram.rb
 - app/models/rails_local_analytics/application_record.rb
 - app/models/tracked_requests_by_day_page.rb
 - app/models/tracked_requests_by_day_site.rb

data/app/lib/rails_local_analytics/histogram.rb

@@ -1,47 +0,0 @@
-module RailsLocalAnalytics
-  class Histogram
-    attr_reader :bars, :from_date, :to_date
-
-    def initialize(scope, from_date, to_date)
-      @scope = scope
-      @from_date, @to_date = from_date, to_date
-      @bars = scope.map { |record| Bar.new(record.date, record.total, self) }
-      fill_missing_days(@bars, @from_date, @to_date)
-    end
-
-    def fill_missing_days(bars, from, to)
-      i = 0
-      while (day = from + i) <= to
-        if !@bars[i] || @bars[i].label != day
-          @bars.insert(i, Bar.new(day, 0, self))
-        end
-        i += 1
-      end
-      @bars
-    end
-
-    def max_value
-      @max_total ||= bars.map(&:value).max
-    end
-
-    def total
-      @bars.reduce(0) { |sum, bar| sum += bar.value }
-    end
-
-    class Bar
-      attr_reader :label, :value, :histogram
-
-      def initialize(label, value, histogram)
-        @label, @value, @histogram = label, value, histogram
-      end
-
-      def height
-        if histogram.max_value > 0
-          (value.to_f / histogram.max_value).round(2)
-        else
-          0
-        end
-      end
-    end
-  end
-end