rails_analytics 1.0.3 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f985132b2aa456db104a03635f1d8334772e8a5c8e3902319d111082d7a5f5b5
4
- data.tar.gz: 8b4b04a1bab3a4c15b0cff8f44892146f5469713e325266054e8e23131937c8e
3
+ metadata.gz: e3c81421bd38061c3f25577abd64335008fdd4789e6b25d3081445d3b90c46f6
4
+ data.tar.gz: 85d5e60a3a0148be7252252528cca77f736e03839897d97a78df0c34fd299200
5
5
  SHA512:
6
- metadata.gz: 277a1e2be087cae4e5f511af0c3f3d56051ad625fadfe643356ae0697fbe6f353c8eef2a9e59c842899d051abdc232a93eea22f1faa4e631fb8fbe4ee0e29a1f
7
- data.tar.gz: c1968ddf6c68fc5dee7856f61ffc94345da3855ee2d0d4188ca04756802ca47afbb252770014e96c567490180be008dedd87244e7c980b669f507c53c44e519a
6
+ metadata.gz: ffe8c9ed37fa8188b6b6f4ba200208e7d7657d98d2f564523d291ed0164c0ab5caf7edc4f18cabd95b581129a26e254771bb9d4d7f6929d943712e17de5be28e
7
+ data.tar.gz: 5819b81fc445fbc5d0dfc876f0e128d69685c40137668662895cf452b172e7ada08e88748c983a6363a83ce360b51a58f670929017b38a329ae3c73c1af92832
data/README.md CHANGED
@@ -5,6 +5,10 @@ third-party analytics dependencies — it collects traffic **server-side**, stor
5
5
  your own database, and renders an aggregated dashboard with zero client-side JS
6
6
  dependencies.
7
7
 
8
+ The dashboard's chart shows CSS-only tooltips: hover (or keyboard-focus) any
9
+ data point to see its date and visit count — labels on the x-axis mark first,
10
+ last and month boundaries. No JavaScript anywhere.
11
+
8
12
  ## Screenshots
9
13
 
10
14
  | Dashboard — aggregated overview | Dashboard — events & visits |
@@ -88,20 +92,25 @@ Done — collection is automatic and the dashboard lives at **`/analytics`** (or
88
92
 
89
93
  ## Mounting
90
94
 
91
- You can mount the engine at any path:
95
+ The engine's mount point is **a single configuration** — the `mount` line in
96
+ `config/routes.rb`. There is no separate `mount_path` to keep in sync: the tracker tag,
97
+ the dashboard CSS and the collect endpoint all derive their URLs from the engine's own
98
+ route helpers at runtime, so they follow whatever path you mount the engine at.
92
99
 
93
100
  ```ruby
94
101
  # config/routes.rb
95
- mount RailsAnalytics::Engine => "/analytics"
102
+ mount RailsAnalytics::Engine => "/analytics" # default
103
+ # mount RailsAnalytics::Engine => "/admin/analytics" # any custom path works
96
104
  ```
97
105
 
98
106
  ```erb
99
107
  <!-- layout -->
100
- <%= rails_analytics_tracker_tag endpoint: "/analytics" %>
108
+ <%= rails_analytics_tracker_tag %>
101
109
  ```
102
110
 
103
- > The `endpoint:` passed to the helper must match the path the engine is mounted at.
104
- > You can also set a global default via `RailsAnalytics.configure { |c| c.mount_path = "/analytics" }`.
111
+ > No need to pass an `endpoint:` to the helper — it resolves the mount automatically.
112
+ > The only exception is serving the tracker from a CDN:
113
+ > `<%= rails_analytics_tracker_tag endpoint: "/cdn/path" %>`.
105
114
 
106
115
  ## Authentication
107
116
 
@@ -66,6 +66,32 @@ body {
66
66
  .ra-chart rect { fill: var(--ra-accent); opacity: 0.85; }
67
67
  .ra-chart rect:hover { opacity: 1; }
68
68
 
69
+ /* Chart nodes: CSS-only tooltip (no JS). The tooltip is an SVG group
70
+ revealed on :hover/:focus-within of its parent .ra-dot group. */
71
+ .ra-chart .ra-dot { cursor: pointer; outline: none; }
72
+ .ra-chart .ra-dot:focus-visible .ra-dot-circle,
73
+ .ra-chart .ra-dot:focus .ra-dot-circle { stroke: var(--ra-text); stroke-width: 2; }
74
+
75
+ .ra-chart .ra-tooltip { opacity: 0; pointer-events: none; transition: opacity 0.12s ease; }
76
+ .ra-chart .ra-dot:hover .ra-tooltip,
77
+ .ra-chart .ra-dot:focus .ra-tooltip,
78
+ .ra-chart .ra-dot:focus-within .ra-tooltip { opacity: 1; }
79
+
80
+ .ra-chart .ra-tooltip rect { fill: var(--ra-text); opacity: 1; stroke: none; }
81
+ .ra-chart .ra-tooltip text {
82
+ fill: var(--ra-card);
83
+ font-size: 12px;
84
+ font-weight: 600;
85
+ font-variant-numeric: tabular-nums;
86
+ }
87
+
88
+ /* X-axis date labels */
89
+ .ra-chart .ra-axis-label {
90
+ fill: var(--ra-muted);
91
+ font-size: 10px;
92
+ font-variant-numeric: tabular-nums;
93
+ }
94
+
69
95
  .ra-grid {
70
96
  display: grid;
71
97
  grid-template-columns: repeat(auto-fit, minmax(320px, 1fr));
@@ -2,9 +2,15 @@
2
2
 
3
3
  module RailsAnalytics
4
4
  module ApplicationHelper
5
+ # Single source of truth: the engine's mount point is whatever the host
6
+ # declared in routes.rb (`mount RailsAnalytics::Engine => "/..."`). We derive
7
+ # the tracker endpoint from the engine's own route helper, so there is no
8
+ # separate `mount_path` to keep in sync. `options[:endpoint]` still allows an
9
+ # explicit override (e.g. when serving the tracker from a CDN).
5
10
  def rails_analytics_tracker_tag(options = {})
6
- endpoint = options[:endpoint] || RailsAnalytics.config.mount_path
7
- tag.script(src: "#{endpoint}/tracker.js",
11
+ tracker = options[:tracker] || rails_analytics.tracker_path
12
+ endpoint = options[:endpoint] || rails_analytics.root_path.chomp("/")
13
+ tag.script(src: tracker,
8
14
  data: { rails_analytics: true, endpoint: endpoint },
9
15
  defer: true)
10
16
  end
@@ -2,11 +2,29 @@
2
2
 
3
3
  module RailsAnalytics
4
4
  # SVG line chart. Server-rendered, zero JS.
5
+ #
6
+ # Each data point renders as a focusable group containing the visible dot,
7
+ # a larger invisible hit area and a CSS-only tooltip (shown on :hover and
8
+ # :focus). X-axis labels mark the first and last point plus month boundaries.
5
9
  class ChartBuilder
6
10
  WIDTH = 800
7
11
  HEIGHT = 220
8
12
  PAD = 8
9
13
  RIGHT_PAD = 40
14
+ DOT_RADIUS = 3
15
+ HIT_RADIUS = 12
16
+
17
+ # Tooltip geometry. The tooltip is part of the SVG (server-computed),
18
+ # revealed purely with CSS on :hover/:focus — no JavaScript involved.
19
+ TOOLTIP_WIDTH = 130
20
+ TOOLTIP_HEIGHT = 30
21
+ TOOLTIP_OFFSET = 10
22
+
23
+ # Plot area keeps HEIGHT; the viewBox gains a strip for x-axis labels.
24
+ AXIS_PAD = 20
25
+
26
+ # Minimum horizontal gap (px) between x-axis labels.
27
+ AXIS_MIN_GAP = 70
10
28
 
11
29
  def initialize(series)
12
30
  @series = series # Array<Hash> with :date and :count
@@ -16,31 +34,96 @@ module RailsAnalytics
16
34
  return empty_chart if @series.empty?
17
35
 
18
36
  max = [@series.map { |s| s[:count] }.max.to_f, 1].max
19
- points = @series.map.with_index do |s, i|
20
- x = pad(i)
21
- y = HEIGHT - PAD - ((s[:count] / max) * (HEIGHT - PAD * 2)).round
22
- "#{x.round(2)},#{y.round(2)}"
23
- end.join(" ")
37
+ nodes = @series.map.with_index { |s, i| dot_node(s, i, max) }.join("\n")
24
38
 
25
39
  <<~SVG
26
- <svg viewBox="0 0 #{WIDTH + RIGHT_PAD} #{HEIGHT}" role="img" aria-label="#{I18n.t('rails_analytics.chart.visits_per_day')}" xmlns="http://www.w3.org/2000/svg">
27
- <polyline points="#{points}" fill="none" stroke="var(--ra-accent, #3b82f6)" stroke-width="2" stroke-linejoin="round" stroke-linecap="round" />
28
- #{dots(points)}
40
+ <svg viewBox="0 0 #{WIDTH + RIGHT_PAD} #{HEIGHT + AXIS_PAD}" role="img" aria-label="#{I18n.t('rails_analytics.chart.visits_per_day')}" xmlns="http://www.w3.org/2000/svg">
41
+ <polyline points="#{points(max)}" fill="none" stroke="var(--ra-accent, #3b82f6)" stroke-width="2" stroke-linejoin="round" stroke-linecap="round" />
42
+ #{axis_labels}
43
+ #{nodes}
29
44
  </svg>
30
45
  SVG
31
46
  end
32
47
 
33
48
  private
34
49
 
35
- def pad(index)
50
+ def points(max)
51
+ @series.each_with_index.map do |s, i|
52
+ "#{x(i).round(2)},#{y(s[:count], max).round(2)}"
53
+ end.join(" ")
54
+ end
55
+
56
+ def dot_node(series, index, max)
57
+ cx = x(index).round(2)
58
+ cy = y(series[:count], max).round(2)
59
+ label = tooltip_text(series)
60
+
61
+ <<~NODE.strip
62
+ <g class="ra-dot" tabindex="0" role="img" aria-label="#{label}">
63
+ <circle cx="#{cx}" cy="#{cy}" r="#{HIT_RADIUS}" fill="transparent" />
64
+ <circle cx="#{cx}" cy="#{cy}" r="#{DOT_RADIUS}" class="ra-dot-circle" />
65
+ #{tooltip(cx, cy, label)}
66
+ </g>
67
+ NODE
68
+ end
69
+
70
+ def tooltip(cx, cy, label)
71
+ # Above the dot; flips to the far side when it would clip the top edge.
72
+ tx = (cx - TOOLTIP_WIDTH / 2).clamp(0, WIDTH + RIGHT_PAD - TOOLTIP_WIDTH)
73
+ ty = cy - DOT_RADIUS - TOOLTIP_OFFSET - TOOLTIP_HEIGHT
74
+ ty = cy + DOT_RADIUS + TOOLTIP_OFFSET if ty < 0
75
+
76
+ <<~TOOLTIP.strip
77
+ <g class="ra-tooltip">
78
+ <rect x="#{tx}" y="#{ty}" width="#{TOOLTIP_WIDTH}" height="#{TOOLTIP_HEIGHT}" rx="6" />
79
+ <text x="#{tx + TOOLTIP_WIDTH / 2}" y="#{ty + TOOLTIP_HEIGHT / 2 + 4}" text-anchor="middle">#{label}</text>
80
+ </g>
81
+ TOOLTIP
82
+ end
83
+
84
+ def tooltip_text(series)
85
+ I18n.t("rails_analytics.chart.tooltip", count: series[:count],
86
+ date: series[:date].strftime(I18n.t("rails_analytics.chart.date_format")),
87
+ formatted_count: ActiveSupport::NumberHelper.number_to_delimited(series[:count]))
88
+ end
89
+
90
+ def x(index)
36
91
  PAD + index * ((WIDTH - PAD) / [@series.length - 1, 1].max.to_f)
37
92
  end
38
93
 
39
- def dots(points_str)
40
- points_str.split(" ").map do |pt|
41
- x, y = pt.split(",")
42
- %(<circle cx="#{x}" cy="#{y}" r="3" fill="var(--ra-accent, #3b82f6)" />)
43
- end.join
94
+ def y(count, max)
95
+ HEIGHT - PAD - ((count / max) * (HEIGHT - PAD * 2))
96
+ end
97
+
98
+ # X-axis labels: first and last point always; month boundaries in between
99
+ # only when far enough from the neighbouring label to avoid collision.
100
+ def axis_labels
101
+ return "" if @series.length < 2
102
+
103
+ axis_indices.map do |i|
104
+ anchor = "start" if i.zero?
105
+ anchor = "end" if i == @series.length - 1
106
+ anchor ||= "middle"
107
+ %(<text x="#{x(i).round(2)}" y="#{HEIGHT + 13}" class="ra-axis-label" text-anchor="#{anchor}">#{write_date(@series[i][:date])}</text>)
108
+ end.join("\n")
109
+ end
110
+
111
+ def axis_indices
112
+ last = @series.length - 1
113
+ kept = [0]
114
+ (1...last).each do |i|
115
+ next unless @series[i][:date].day == 1 # month boundary
116
+
117
+ left_gap = x(i) - x(kept.last)
118
+ right_gap = x(last) - x(i)
119
+ kept << i if left_gap >= AXIS_MIN_GAP && right_gap >= AXIS_MIN_GAP
120
+ end
121
+ kept << last
122
+ kept.uniq
123
+ end
124
+
125
+ def write_date(date)
126
+ date.strftime(I18n.t("rails_analytics.chart.date_format"))
44
127
  end
45
128
 
46
129
  def empty_chart
@@ -51,4 +134,4 @@ module RailsAnalytics
51
134
  SVG
52
135
  end
53
136
  end
54
- end
137
+ end
@@ -14,6 +14,10 @@ en:
14
14
  chart:
15
15
  visits_per_day: "Visits per day"
16
16
  no_data: "No data"
17
+ date_format: "%m/%d"
18
+ tooltip:
19
+ one: "%{date} — 1 visit"
20
+ other: "%{date} — %{formatted_count} visits"
17
21
  tables:
18
22
  top_sources: "Traffic sources"
19
23
  top_events: "Top events"
@@ -14,6 +14,10 @@ pt-BR:
14
14
  chart:
15
15
  visits_per_day: "Visitas por dia"
16
16
  no_data: "Sem dados"
17
+ date_format: "%d/%m"
18
+ tooltip:
19
+ one: "%{date} — 1 visita"
20
+ other: "%{date} — %{formatted_count} visitas"
17
21
  tables:
18
22
  top_sources: "Origem do tráfego"
19
23
  top_events: "Clics por botão"
data/config/routes.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  RailsAnalytics::Engine.routes.draw do
4
- get "tracker.js" => "analytics#tracker"
4
+ get "tracker.js" => "analytics#tracker", as: "tracker"
5
5
  get "dashboard.css" => "analytics#dashboard_css", as: "dashboard_css"
6
6
  post "collect" => "analytics#collect"
7
7
  get "token" => "analytics#token"
@@ -6,6 +6,11 @@ module RailsAnalytics
6
6
  source_root File.expand_path("templates", __dir__)
7
7
  desc "Instala o rails_analytics: copia migrations, monta engine, cria initializer e pina tracker no importmap."
8
8
 
9
+ # The only mount configuration that matters is the `mount` line this generator
10
+ # writes into config/routes.rb. Changing that line is enough — the tracker and
11
+ # dashboard derive their URLs from the engine's route helpers at runtime.
12
+ DEFAULT_MOUNT_PATH = "/analytics"
13
+
9
14
  def copy_migrations
10
15
  migrations_dir = RailsAnalytics::Engine.root.join("db/migrate")
11
16
  Dir["#{migrations_dir}/*.rb"].sort.each do |migration|
@@ -21,20 +26,20 @@ module RailsAnalytics
21
26
  end
22
27
 
23
28
  def mount_engine
24
- route %(mount RailsAnalytics::Engine => RailsAnalytics.config.mount_path)
25
- say_status :ok, "Engine montada em config/routes.rb"
29
+ route %(mount RailsAnalytics::Engine => "#{DEFAULT_MOUNT_PATH}")
30
+ say_status :ok, "Engine montada em config/routes.rb (montada em #{DEFAULT_MOUNT_PATH})"
26
31
  end
27
32
 
28
33
  def pin_tracker
29
34
  importmap_path = "config/importmap.rb"
30
35
  if File.exist?(importmap_path)
31
36
  unless File.read(importmap_path).include?("rails_analytics/tracker")
32
- append_to_file importmap_path, %(\npin "rails_analytics/tracker", to: RailsAnalytics.config.mount_path + "/tracker.js"\n)
37
+ append_to_file importmap_path, %(\npin "rails_analytics/tracker", to: "#{DEFAULT_MOUNT_PATH}/tracker.js"\n)
33
38
  say_status :ok, "Tracker pinado em config/importmap.rb"
34
39
  end
35
40
  else
36
41
  say_status :skipped, "config/importmap.rb não encontrado — adicione manualmente:", :yellow
37
- say %( Adicione ao seu layout: <script src="<%= RailsAnalytics.config.mount_path %>/tracker.js" defer></script>), :yellow
42
+ say %( Adicione ao seu layout: <script src="#{DEFAULT_MOUNT_PATH}/tracker.js" defer></script>), :yellow
38
43
  end
39
44
  end
40
45
 
@@ -42,7 +47,7 @@ module RailsAnalytics
42
47
  say "\n✅ rails_analytics instalado! Próximos passos:", :green
43
48
  say " 1. bin/rails db:migrate"
44
49
  say " 2. Configure a autenticação no initializer: config/initializers/rails_analytics.rb"
45
- say " 3. Acesse o dashboard em #{RailsAnalytics.config.mount_path}"
50
+ say " 3. Acesse o dashboard em #{DEFAULT_MOUNT_PATH} (se quiser outro path, edite o mount em config/routes.rb)"
46
51
  say ""
47
52
  end
48
53
  end
@@ -5,10 +5,6 @@ RailsAnalytics.configure do |config|
5
5
  # Pode ser um Symbol (ex: :authenticate_admin!) ou um callable (ex: -> { current_user&.admin? }).
6
6
  config.auth_callback = :authenticate_admin!
7
7
 
8
- # Caminho onde o engine é montado (debe coincidir com el mount en config/routes.rb).
9
- # Padrão: "/analytics". Puedes cambiarlo libremente (ex: "/admin/analytics").
10
- config.mount_path = "/analytics"
11
-
12
8
  # Período padrão para as consultas do dashboard (ex: 30.days).
13
9
  config.since_default = 30.days
14
10
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module RailsAnalytics
4
- VERSION = "1.0.3"
4
+ VERSION = "1.1.0"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rails_analytics
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.3
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - br4zz4
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-09-07 00:00:00.000000000 Z
11
+ date: 2026-10-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rails