ga_events 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af13dc202f2b24f7fa7ba45345d90fea5158e4b50c5e55fbb6bbc68752c6083b
-  data.tar.gz: bbd3f2173bba05a2ce2d1dc4315a288b83b469810327dd2cbccd30799f6e595a
+  metadata.gz: b93d2ffe7308a325730dc5c73faf0765807c9a3c83aea96d911199044e73cf89
+  data.tar.gz: 044d35f5bba0adf9613e5886065cef5eadd38fded5957879b13ff16beb0dfb89
 SHA512:
-  metadata.gz: cb529a2794580ae3c52a2a226c620b94ba79b278dc1171fcda5a27bdc511901b95f2d9243028285484a2a8d66af2feeb6a40539e82e5def320ed0974bf62e74e
-  data.tar.gz: 9b9adf95d667f066198b222cb45e233b83b03420e84a6743cd93cfba70b90bbaed7982b070d552f37e69c148a21800159a18223af176d6dac955049fe8f02971
+  metadata.gz: e3ae1007735e30a3217f69fbbb026883eebb1096bb390ed831d855e9324b8444d5460b68842df05e9e5e0ffa5072d0f4ea4b7b09a95d63de8093f74f0c8f2212
+  data.tar.gz: 68ea2765ce64928d0b64bfebed5a9fdee2feffd4be04d22a31e3f6d40cd63584c60a576e6dce89809723f82f7c1b36263fa56f2a3af8e646c489e6755479c15f

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,8 +13,8 @@ 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
 * jQuery
 
 ## Installation
@@ -156,7 +156,7 @@ Yes please! Use pull requests.
 
 ### Credits
 
-* [danielbayerlein](https://github.com/danielbayerlein) former core committer
+* [danielbayerlein](https://github.com/danielbayerlein), [der-flo](https://github.com/der-flo), [svenwin](https://github.com/svenwin) former core committer
 * [jhilden](https://github.com/jhilden) for ideas and bug reports
 * [brain-geek](https://github.com/brain-geek) for bug fixes, specs, features
 

data/ga_events.gemspec

@@ -3,9 +3,8 @@
 require File.expand_path('lib/ga_events/version', __dir__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Florian Dütsch', 'Sven Winkler']
-  gem.email         = ['florian.duetsch@nix-wie-weg.de',
-                       'sven.winkler@nix-wie-weg.de']
+  gem.authors       = ['Nix-wie-weg Team']
+  gem.email         = ['admin@nix-wie-weg.de']
   gem.description   =
     "Google Analytics' Event Tracking everywhere in your Rails app)"
   gem.summary       = 'This gem allows you to annotate events everywhere in ' \
@@ -21,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,38 +1,49 @@
 # 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'
 
+    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
     end
 
     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
+        serialized_events = GaEvents::List.to_s
         if xhr_or_turbolinks?(request)
           # AJAX request
-          headers['x-ga-events'] = CGI.escapeURIComponent(serialized)
+          headers['x-ga-events'] = 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,28 +54,32 @@ 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)
-      [r.sub('</body>', "<div data-ga-events='#{serialized_data}'></div>\\0")]
+    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)
       !Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status.to_i) &&
-        headers.key?('Content-Type') &&
-        headers['Content-Type'].include?('text/html')
+        headers.key?('content-type') &&
+        headers['content-type'].start_with?('text/html')
     end
 
     def redirect?(status)

data/lib/ga_events/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GaEvents
-  VERSION = '4.0.0'
+  VERSION = '4.1.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

@@ -33,13 +33,18 @@ describe GaEvents::Middleware do
     context 'events present in GaEvents::List' do
       let(:app) do
         proc do |_|
-          GaEvents::Event.new('test', { 'cool' => 'stuff' })
-          [200, { 'Content-Type' => 'text/html' }, response_body]
+          GaEvents::Event.new(
+            'test',
+            'cool' => 'stuff',
+            'ding' => ["it's a bug", 'this is "fine"', 'x=1&y=2', '>:3<']
+          )
+          [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
@@ -52,7 +57,16 @@ describe GaEvents::Middleware do
         it 'injects data-ga-events' do
           expect(response.body).to eq(
             'something awesome!' \
-            "<div data-ga-events='[{\"__event__\":\"test\",\"cool\":\"stuff\"}]'></div></body>"
+            '<div data-ga-events="[{' \
+            '&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;' \
+            ']' \
+            '}]"></div></body>'
           )
         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,15 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ga_events
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
-- Florian Dütsch
-- Sven Winkler
-autorequire:
+- Nix-wie-weg Team
 bindir: bin
 cert_chain: []
-date: 2023-08-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,18 +15,17 @@ 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:
-- florian.duetsch@nix-wie-weg.de
-- sven.winkler@nix-wie-weg.de
+- admin@nix-wie-weg.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -56,8 +53,8 @@ files:
 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
@@ -65,15 +62,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
@@ -81,8 +77,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: []