ga_events 4.0.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08583d04c842b3ab9c4efa4df756662a83b04dfe3fba2d979dd7d1be3426d173'
-  data.tar.gz: 1bab40e8a318ca3b540430ab69734960f97dac17a6b250df2b95c5f32378e64d
+  metadata.gz: 83fd5b6e15c900730f8f41e03ade3efab0b619a7c4e9e67074db8730ac0701db
+  data.tar.gz: e866ec33593b82a6f826004c4c03486203963be5eae9e534ed6be0cad9a3e626
 SHA512:
-  metadata.gz: a3a07495ef1e66b621c4bf3e3d8d06ba22add1965003148a53a50ac31bb256ea5faa9519b706c36e568099f0dbf1e4a8929012966b6378c416f58562bfa137b1
-  data.tar.gz: 066c9032ada9d87d16202bf00fb435b0420a0ae247f1f21cf22bb6ddece372380c2bd5a2bec1532ffdc3d1972b84a084c38b588c48a6a551a3f74f3a925da8c3
+  metadata.gz: 0345da75e6b2500c22ef51b72823c3eaf42e71a0e57c9e617119dcacfa4a2aed07ea4120fb25db030d2c3394c322cfce44bdcd44c300ef0deaf275e36b9d5613
+  data.tar.gz: d2c2449b6117600eebd172680950a5e42c98f2669c75bb6eda9651d1e1dda0a8da731881b78d205236bedb17130f046a6df500cefd56641667e1c39bc9af35a3

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  SuggestExtensions: false
+  NewCops: enable
+  TargetRubyVersion: 3.4
   Exclude:
     - 'vendor/bundle/**/*'
   DisplayCopNames: true

data/Gemfile

@@ -5,7 +5,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in ga_events.gemspec
 gemspec
 
-gem 'pry'
 gem 'rake'
 gem 'rspec', '~> 3.12.0'
-gem 'rubocop', '~> 0.79.0', require: false
+gem 'rubocop', '~> 1.80.2', require: false

data/README.md

@@ -13,9 +13,13 @@ pushes it to Google Analytics via gtag.js or Google Tag Manager.
 
 ## Dependencies
 
-* Ruby >= 3.2
-* Rails 4.2 onwards
+* Ruby >= 3.4
+* Rails 7.2 onwards
+
+## Optional dependencies
+
 * jQuery
+* Turbolinks or Hotwire Turbo
 
 ## Installation
 
@@ -27,7 +31,7 @@ gem 'ga_events'
 
 Run the `bundle` command to install it.
 
-Add to the top of your `application.js` (but after requiring jQuery):
+Add to the top of your `application.js`
 
 ```javascript
 //= require ga_events.js

data/app/assets/javascripts/ga_events.js.coffee

@@ -16,24 +16,33 @@ class GaEvents.Event
   # Decompose an event-string (ruby side) into an event object.
   @from_json: (string) ->
     events = JSON.parse(string)
-
-    $.map events, (event) =>
+    events.map((event) ->
       if event_name = event.__event__
         delete event.__event__
         new @(event_name, event)
+    , @)
 
   @from_dom: ->
     data_attribute = "data-#{@html_key}"
-    dom_events = $("div[#{data_attribute}]").attr data_attribute
-    @from_json dom_events if dom_events?
+    dom_events = document
+      .querySelector("div[#{data_attribute}]")
+      ?.getAttribute(data_attribute)
+
+    @from_json(dom_events) if dom_events?
 
   # Events should not be sent to an adapter unless the DOM has finished loading.
   @flush: ->
     return if @require_user_consent && !@user_consent_given
 
-    if @list.length > 0 and @may_flush
-      $.map @list, (event) -> event.push_to_adapter()
-      @list = []
+    push_events = =>
+      if @list.length > 0 and @may_flush
+        @list.forEach((event) -> event.push_to_adapter())
+        @list = []
+
+    if window.requestIdleCallback
+      requestIdleCallback(push_events, timeout: 250)
+    else
+      setTimeout(push_events, 1)
 
   # Add all events to a queue to flush them later
   constructor: (@event_name, @options = {}) ->
@@ -49,21 +58,44 @@ class GaEvents.Event
   # https://support.google.com/analytics/answer/13316687?hl=en#zippy=%2Cweb
   is_valid_event_name: -> /^[a-z]+[a-z0-9_]*$/i.test(@event_name)
 
-  jQuery =>
+
+  start = ->
     @may_flush = true
     @flush()
 
+    addEventListener = document.addEventListener
+
     process_xhr = (xhr) =>
       xhr_events = xhr.getResponseHeader @header_key
       @from_json decodeURIComponent(xhr_events) if xhr_events?
 
-    $(document).ajaxComplete((_, xhr) -> process_xhr(xhr))
-    $(document).on "turbolinks:request-end", (event) ->
-      xhr = event.originalEvent.data.xhr
-      process_xhr(xhr)
+    process_fetch = (response) =>
+      events = response.headers.get @header_key
+      @from_json decodeURIComponent(events) if events?
+
+    # jQuery $.ajax
+    if window.jQuery && jQuery.ajax
+      # This event can only be caught on the jQuery event bus.
+      jQuery(document).on("ajaxComplete",  (_, xhr) -> process_xhr(xhr))
+
+
+    # classic Turbolinks
+    addEventListener("turbolinks:request-end", (event) ->
+      process_xhr(event.originalEvent.data.xhr)
+    )
+
+    # Hotwire/Turbo
+    addEventListener("turbo:before-fetch-response", (event) ->
+      process_fetch(event.detail.fetchResponse.response)
+    )
 
     @from_dom()
 
+  if document.readyState == "loading"
+    addEventListener("DOMContentLoaded", start.bind(@), once: true)
+  else
+    start.call(@)
+
 
 class GaEvents.GTagAdapter
   constructor: (options) ->

data/ga_events.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |gem|
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'ga_events'
   gem.require_paths = ['lib']
   gem.version       = GaEvents::VERSION
   gem.licenses      = ['MIT']
 
-  gem.required_ruby_version = '>= 3.2'
-  gem.add_dependency 'rails', '>= 4.2'
+  gem.required_ruby_version = '>= 3.4'
+  gem.add_dependency 'rails', '>= 7.2'
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/ga_events/list.rb

@@ -9,6 +9,7 @@ module GaEvents
   module List
     class << self
       extend Forwardable
+
       def_delegators :data, :<<, :present?
 
       def to_s

data/lib/ga_events/middleware.rb

@@ -1,10 +1,22 @@
 # frozen_string_literal: true
 
 require 'rack/utils'
+require 'rack/request'
+require 'rack/headers'
+require 'cgi'
+require 'rubygems'
 
 module GaEvents
   class Middleware
     SESSION_GA_EVENTS_KEY = 'ga_events.events'
+    RESPONSE_HEADER = 'x-ga-events'
+
+    HEADERS_KLASS = if Gem::Version.new(Rack.release) < Gem::Version.new('3.0')
+                      Rack::Utils::HeaderHash
+                    else
+                      Rack::Headers
+                    end
+    private_constant :HEADERS_KLASS
 
     def initialize(app)
       @app = app
@@ -12,27 +24,27 @@ module GaEvents
 
     def call(env)
       init_event_list(env)
-      status, headers, response = @app.call(env)
+      status, headers, body = @app.call(env)
 
-      headers = Rack::Utils::HeaderHash.new(headers)
       if GaEvents::List.present?
+        headers = HEADERS_KLASS.new.merge(headers)
         request = Rack::Request.new(env)
 
         # Can outgrow, headers might get too big
-        serialized = GaEvents::List.to_s
-        if xhr_or_turbolinks?(request)
+        serialized_events = GaEvents::List.to_s
+        if xhr_or_turbo?(request)
           # AJAX request
-          headers['x-ga-events'] = CGI.escapeURIComponent(serialized)
+          headers[RESPONSE_HEADER] = CGI.escapeURIComponent(serialized_events)
         elsif redirect?(status)
           # 30x/redirect? Then add event list to rack session to survive the
           # redirect.
-          add_events_to_session(env, serialized)
+          add_events_to_session(env, serialized_events)
         elsif html?(status, headers)
-          response = inject_div(response, serialized)
+          body = inject_div(body, serialized_events)
         end
       end
 
-      [status, headers, response]
+      [status, headers, body]
     end
 
     private
@@ -43,41 +55,42 @@ module GaEvents
     end
 
     def add_events_to_session env, serialized_data
-      if session = env.dig('rack.session')
+      if session = env['rack.session']
         session[SESSION_GA_EVENTS_KEY] = serialized_data
       end
     end
 
-    def normalize_response(response)
-      response = response.body if response.respond_to?(:body)
-      response = response.join if response.respond_to?(:join)
-      response
-    end
-
-    def inject_div(response, serialized_data)
-      r = normalize_response(response)
-      serialized_data = CGI.escapeHTML(serialized_data)
-      [
-        r.sub('</body>') do |body|
+    def inject_div(body, serialized_data)
+      if body.respond_to?(:to_ary)
+        html = +''
+        body.to_ary.each { |chunk| html << chunk }
+        html.sub!(%r{</body>}i) do |body|
+          serialized_data = CGI.escapeHTML(serialized_data)
           "<div data-ga-events=\"#{serialized_data}\"></div>#{body}"
         end
-      ]
+        body = [html]
+      end
+      body
+    ensure
+      body.close if body.respond_to?(:close)
     end
 
     # Taken from:
     # https://github.com/rack/rack-contrib/blob/master/lib/rack/contrib/jsonp.rb
-    def html?(status, headers)
+    def html?(status, response_headers)
       !Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status.to_i) &&
-        headers.key?('Content-Type') &&
-        headers['Content-Type'].include?('text/html')
+        response_headers.key?('content-type') &&
+        response_headers['content-type'].start_with?('text/html')
     end
 
     def redirect?(status)
       (300..399).cover?(status)
     end
 
-    def xhr_or_turbolinks?(request)
-      request.xhr? || request.env['HTTP_TURBOLINKS_REFERRER']
+    def xhr_or_turbo?(request)
+      request.xhr? ||
+        request.env['HTTP_TURBOLINKS_REFERRER'] ||
+        request.env['HTTP_X_TURBO_REQUEST_ID']
     end
   end
 end

data/lib/ga_events/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GaEvents
-  VERSION = '4.0.1'
+  VERSION = '4.2.0'
 end

data/spec/event_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe GaEvents::Event do

data/spec/list_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'GaEvents::List' do
@@ -22,7 +24,7 @@ RSpec.describe 'GaEvents::List' do
     JSON
 
     expect(
-      GaEvents::List.send(:data).to_h { [_1.event_name, _1.event_params] }
+      GaEvents::List.send(:data).to_h { [it.event_name, it.event_params] }
     ).to eq({ 'clicked' => { 'a' => 'a' } })
   end
 
@@ -34,7 +36,7 @@ RSpec.describe 'GaEvents::List' do
     JSON
 
     expect(
-      GaEvents::List.send(:data).to_h { [_1.event_name, _1.event_params] }
+      GaEvents::List.send(:data).to_h { [it.event_name, it.event_params] }
     ).to be_empty
   end
 end

data/spec/middleware_spec.rb

@@ -38,12 +38,13 @@ describe GaEvents::Middleware do
             'cool' => 'stuff',
             'ding' => ["it's a bug", 'this is "fine"', 'x=1&y=2', '>:3<']
           )
-          [200, { 'Content-Type' => 'text/html' }, response_body]
+          [200, { 'Content-Type' => 'text/html' }, [response_body]]
         end
       end
 
-      context 'when no body closing tag exists' do
+      context 'when no closing body tag exists' do
         let(:response) { request.get('/') }
+
         it 'leaves everything as it was' do
           expect(response.body).to eq response_body
         end
@@ -60,12 +61,12 @@ describe GaEvents::Middleware do
             '&quot;__event__&quot;:&quot;test&quot;,' \
             '&quot;cool&quot;:&quot;stuff&quot;,' \
             '&quot;ding&quot;:[' \
-              '&quot;it&#39;s a bug&quot;,' \
-              '&quot;this is \&quot;fine\&quot;&quot;,' \
-              '&quot;x=1&amp;y=2&quot;,' \
-              '&quot;&gt;:3&lt;&quot;' \
+            '&quot;it&#39;s a bug&quot;,' \
+            '&quot;this is \&quot;fine\&quot;&quot;,' \
+            '&quot;x=1&amp;y=2&quot;,' \
+            '&quot;&gt;:3&lt;&quot;' \
             ']' \
-          '}]"></div></body>'
+            '}]"></div></body>'
           )
         end
       end

data/spec/middlware_event_placement_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe GaEvents::Middleware do
+  let(:app) do
+    lambda do |env|
+      status_code = env.delete('app_status_code').to_i
+
+      GaEvents::Event.new('test', 'event' => 'stuff')
+      [status_code, { 'content-type' => 'text/html' }, [<<~HTML]]
+        <!doctype html>
+        <html lang=en>
+          <head>
+            <meta charset=utf-8>
+            <title>ABC</title>
+          </head>
+          <body>
+            <p>I'm the content</p>
+          </body>
+        </html>
+      HTML
+    end
+  end
+
+  describe 'html requests' do
+    it 'adds events in an injected div' do
+      response = make_request
+      expect(response.body).to include('<div data-ga-events="[{')
+    end
+
+    it 'does no write to rack ression or response headers' do
+      session = {}
+      response = make_request('rack.session' => session)
+      expect(session[GaEvents::Middleware::SESSION_GA_EVENTS_KEY]).to be_nil
+      expect(response.headers).not_to have_key(
+        GaEvents::Middleware::RESPONSE_HEADER
+      )
+    end
+  end
+
+  describe 'non xhr/fetch redirects' do
+    it 'writes to session' do
+      session = {}
+      make_request('app_status_code' => '302', 'rack.session' => session)
+      expect(session[GaEvents::Middleware::SESSION_GA_EVENTS_KEY]).to be_present
+    end
+
+    it 'does not inject html or add response headers' do
+      response = make_request('app_status_code' => '302', 'rack.session' => {})
+      expect(response.body).not_to include('<div data-ga-events="[{')
+      expect(response.headers).not_to have_key(
+        GaEvents::Middleware::RESPONSE_HEADER
+      )
+    end
+  end
+
+  describe 'xhr requests' do
+    it 'adds events as response header' do
+      response = make_request('HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest')
+      expect(
+        response.headers[GaEvents::Middleware::RESPONSE_HEADER]
+      ).to include('__event__')
+    end
+
+    it 'does not inject a div or writes to session' do
+      session = {}
+      response =
+        make_request(
+          'HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest',
+          'rack.session' => session
+        )
+      expect(response.body).not_to include('<div data-ga-events')
+      expect(session[GaEvents::Middleware::SESSION_GA_EVENTS_KEY]).to be_nil
+    end
+  end
+
+  describe 'turbolink requests' do
+    it 'adds events as response header' do
+      response = make_request('HTTP_TURBOLINKS_REFERRER' => '...')
+      expect(
+        response.headers[GaEvents::Middleware::RESPONSE_HEADER]
+      ).to include('__event__')
+    end
+
+    it 'does not inject a div with events' do
+      response = make_request('HTTP_TURBOLINKS_REFERRER' => '...')
+      expect(response.body).not_to include('<div data-ga-events')
+    end
+  end
+
+  describe 'turbo requests' do
+    it 'adds events as response header' do
+      response = make_request('HTTP_X_TURBO_REQUEST_ID' => '...')
+      expect(
+        response.headers[GaEvents::Middleware::RESPONSE_HEADER]
+      ).to include('__event__')
+    end
+
+    it 'does not inject a div with events' do
+      response = make_request('HTTP_X_TURBO_REQUEST_ID' => '...')
+      expect(response.body).not_to include('<div data-ga-events')
+    end
+  end
+
+  private
+
+  def make_request(options = nil)
+    middleware = described_class.new(app)
+    options = {
+      'app_status_code' => '200',
+      :lint => true,
+      :fatal => true,
+      **options
+    }
+    r = Rack::MockRequest.new(middleware)
+    r.get('/', options)
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'pry'
 require 'rspec'
 require 'rails'
 require 'ga_events'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ga_events
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Nix-wie-weg Team
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.2'
 description: Google Analytics' Event Tracking everywhere in your Rails app)
 email:
 - admin@nix-wie-weg.de
@@ -50,12 +49,13 @@ files:
 - spec/event_spec.rb
 - spec/list_spec.rb
 - spec/middleware_spec.rb
+- spec/middlware_event_placement_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Nix-wie-weg/ga_events
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -63,15 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: This gem allows you to annotate events everywhere in the code of your Rails
   app. A rack middleware is automatically inserted into the stack. It transports the
@@ -79,8 +78,4 @@ summary: This gem allows you to annotate events everywhere in the code of your R
   a data-pounded custom HTTP header appended.  The asset pipeline-ready CoffeeScript
   extracts this data on the client side and pushes it to Google Analytics via ga.js
   or Google Tag Manager.
-test_files:
-- spec/event_spec.rb
-- spec/list_spec.rb
-- spec/middleware_spec.rb
-- spec/spec_helper.rb
+test_files: []