ahoy_email 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 238e4d5f6eb74588ea6d9d628cce5b7c69fa584741280c9d766fa13c5ef8164a
-  data.tar.gz: 3dedf13c78c400d139bb9450fc01ceb1a56c844b463ff0cafdf12fc7f6553573
+  metadata.gz: e11cd64d52d35113df4fe7e29042683f3f5de6aa256ef75ae8f8455d2d1eec1f
+  data.tar.gz: f38baf49086ddaa1759243644074da6486cddbb0793c1d71e93e352228f12b66
 SHA512:
-  metadata.gz: 4cc75f90c29e23f1c4dc5e87cfa626cbff9a6a0f3c23850f5813bb3890f1afbc72912e94bc8fb5f15f87c0f32794c7031f5559d0255d52065412e73dba793985
-  data.tar.gz: 559b2bec029c2d659c10799ff38453b939ff615f84a7a4041670badf3b96c8faa91d9f6037f9147d0003422197bdc430ddd2e075f391391c01905cb522abc2f6
+  metadata.gz: dd32bc570175e43d4b601d1b6bf7289f44c51912fe3b5f3fafc86cfbd505a4aa40b8c7ea224cfa0c29d790d0d9994acc92d0d143d4a482152539fec1904cce9b
+  data.tar.gz: 81e1d2e90a4a82621b5fb3b755653f6536cc755f3702c9d89a57e0be90b6ea1111b6cf5b737093f37e859c1c5742f137492b1ee41841125b6504623c6bd830da

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.4.0 (2024-11-11)
+
+- Added `html5` option
+- Improved generator for Active Record encryption and MySQL
+- Removed support for Ruby < 3.1 and Rails < 7
+- Removed support for Mongoid < 8
+
 ## 2.3.1 (2024-09-09)
 
 - Fixed deprecation warning with Rails 7.1
@@ -180,4 +187,14 @@ Breaking changes
 
 ## 0.1.0 (2014-04-29)
 
-- First major release
+- Changed option names
+
+## 0.0.2 (2014-04-29)
+
+- Added open and click tracking
+- Added UTM parameters
+- Rescue errors
+
+## 0.0.1 (2014-04-28)
+
+- First release

data/README.md

@@ -33,7 +33,7 @@ rails generate ahoy:messages --encryption=lockbox
 rails db:migrate
 ```
 
-To use Active Record encryption (Rails 7+, experimental), run:
+To use Active Record encryption, run:
 
 ```sh
 rails generate ahoy:messages --encryption=activerecord
@@ -106,7 +106,7 @@ user.messages
 Add extra data to messages. Create a migration like:
 
 ```ruby
-class AddCouponIdToAhoyMessages < ActiveRecord::Migration[7.2]
+class AddCouponIdToAhoyMessages < ActiveRecord::Migration[8.0]
   def change
     add_column :ahoy_messages, :coupon_id, :integer
   end
@@ -324,6 +324,16 @@ Get stats for a campaign
 AhoyEmail.stats("my-campaign")
 ```
 
+## HTML Parsing
+
+By default, Nokogiri’s default HTML parser is used to rewrite links for UTM tagging and click analytics. This currently uses HTML4, which [only allows inline elements inside links](https://github.com/sparklemotion/nokogiri/issues/1876#issuecomment-468276937).
+
+To use HTML5 parsing, create `config/initializers/ahoy_email.rb` with:
+
+```ruby
+AhoyEmail.default_options[:html5] = true
+```
+
 ## History
 
 View the [changelog](https://github.com/ankane/ahoy_email/blob/master/CHANGELOG.md)

data/app/controllers/ahoy/messages_controller.rb

@@ -25,7 +25,7 @@ module Ahoy
       end
 
       redirect_options = {}
-      redirect_options[:allow_other_host] = true if ActionPack::VERSION::MAJOR >= 7
+      redirect_options[:allow_other_host] = true
 
       if AhoyEmail::Utils.signature_verified?(legacy: legacy, token: token, campaign: campaign, url: url, signature: signature)
         data = {}

data/lib/ahoy_email/mailer.rb

@@ -63,6 +63,9 @@ module AhoyEmail
       # only call other options if needed
       if options[key]
         AhoyEmail::Utils::OPTION_KEYS[key].each do |k|
+          # make sure html5 only called once
+          next if options.key?(k)
+
           v = ahoy_options[k]
           options[k] = v.respond_to?(:call) ? instance_exec(&v) : v
         end

data/lib/ahoy_email/processor.rb

@@ -53,7 +53,7 @@ module AhoyEmail
       if html_part?
         part = message.html_part || message
 
-        doc = Nokogiri::HTML::Document.parse(part.body.raw_source)
+        doc = parser_class.parse(part.body.raw_source)
         doc.css("a[href]").each do |link|
           uri = parse_uri(link["href"])
           next unless trackable?(uri)
@@ -92,6 +92,19 @@ module AhoyEmail
       end
     end
 
+    # use document instead of fragment
+    # https://github.com/ankane/ahoy_email/pull/150
+    def parser_class
+      case options[:html5]
+      when true
+        Nokogiri::HTML5::Document
+      when false
+        Nokogiri::HTML4::Document
+      else
+        Nokogiri::HTML::Document
+      end
+    end
+
     def html_part?
       (message.html_part || message).content_type =~ /html/
     end

data/lib/ahoy_email/utils.rb

@@ -2,8 +2,8 @@ module AhoyEmail
   class Utils
     OPTION_KEYS = {
       message: %i(message mailer user extra),
-      utm_params: %i(utm_source utm_medium utm_term utm_content utm_campaign),
-      click: %i(campaign url_options unsubscribe_links)
+      utm_params: %i(utm_source utm_medium utm_term utm_content utm_campaign html5),
+      click: %i(campaign url_options unsubscribe_links html5)
     }
 
     class << self

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "2.3.1"
+  VERSION = "2.4.0"
 end

data/lib/ahoy_email.rb

@@ -48,7 +48,10 @@ module AhoyEmail
     click: false,
     campaign: nil,
     url_options: {},
-    unsubscribe_links: false
+    unsubscribe_links: false,
+
+    # utm params and click analytics
+    html5: nil
   }
 
   self.track_method = lambda do |data|

data/lib/generators/ahoy/messages/activerecord_generator.rb

@@ -34,8 +34,11 @@ module Ahoy
           when "lockbox"
             "t.text :to_ciphertext\n      t.string :to_bidx, index: true"
           else
-            # TODO add limit: 510 for Active Record encryption + MySQL?
-            "t.string :to, index: true"
+            if encryption == "activerecord" && mysql?
+              "t.string :to, limit: 510, index: true"
+            else
+              "t.string :to, index: true"
+            end
           end
         end
 
@@ -63,6 +66,14 @@ module Ahoy
             "has_encrypted"
           end
         end
+
+        def mysql?
+          adapter =~ /mysql|trilogy/i
+        end
+
+        def adapter
+          ActiveRecord::Base.connection_db_config.adapter.to_s
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-09 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -116,14 +116,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: First-party email analytics for Rails