react-email-rails 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf2e6b94aa19f4ccec30037d5eefb38b1b98ba2f070ede1a89c99818e47b2eec
-  data.tar.gz: 26710f44d94a84d1df7a73a0759973c37fc9b3ec031c143ae902aed890ebb2d2
+  metadata.gz: 2d0666badbedb79a20a1fec50afc5aedde5398a3777620f5c2f6c2e080a2a5e2
+  data.tar.gz: f19f1dba07f2ad62bf5737e3fab859c33a526305963ee239a1eb63d3048cc7f9
 SHA512:
-  metadata.gz: 911446dcf37e32e420bef4e0f02cdf8c30c6076854dba593737ae552138e139473f355d1ef14328bf50cf77943e5b376e82300185b8d23ea34fb41a1a3deaaaf
-  data.tar.gz: 708ac8a7339f5133be74caccce59a1f30dc890f6da95adeb5385a5117b894295fd8e3e5748a50e8a46d0cdd6bcc1abc6d3943abf9bf146dd2b57163c3d0c94a5
+  metadata.gz: 3905f2042d9932512be861bd7bf0be13f7dde1e9f481dae3ebbbe36f676f8562ecc29532a91649e1e64102454427057599d10baa47866ed9bbab6699163546a8
+  data.tar.gz: 6236d1b78f000473a2bb696bbf204ce72143bd62abdc1008a0ce0fa05be88777ca2416101107894f92feaea79d16fbc7f9fc4e13d4c00e8b52ca31dff289fa64

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.10.0
+
+- **Breaking:** Remove the instance-level `react_share` helper (calling `react_share` from within an action before `mail`). Pass per-mail props directly in the `react:` hash instead; use the class-level `react_share` (with `only`/`except`/`if`/`unless`) for conditional sharing.
+
+## 0.9.0
+
+- **Breaking:** Rename `react_email_share` to `react_share`, matching the `react:` key used in `mail`. Update any `react_email_share` calls in your mailers to `react_share`.
+
 ## 0.8.0
 
 - **Breaking:** Remove `@react-email/editor` document rendering to focus the library on component-based Action Mailer emails. `ReactEmailRails.compose`, `ReactEmailRails.parse`, the `documents` Vite plugin option, and the `react-email-rails/document` module are gone, along with the `@react-email/editor`, `@tiptap/core`, `@tiptap/html`, `happy-dom`, and `marked` optional peer dependencies.

data/README.md

@@ -280,15 +280,15 @@ To change naming globally, override `component_path_resolver` in your [Rails con
 
 ### Shared Props
 
-Use `react_email_share` to merge props into every `react:` email for a mailer and its subclasses:
+Use `react_share` to merge props into every `react:` email for a mailer and its subclasses:
 
 ```ruby
 class MarketingMailer < ApplicationMailer
-  react_email_share app_name: "Acme"
+  react_share app_name: "Acme"
 
-  react_email_share unread_count: -> { params[:account]&.unread_count }
+  react_share unread_count: -> { params[:account]&.unread_count }
 
-  react_email_share do
+  react_share do
     { brand: { name: "Acme", url: marketing_url } }
   end
 end
@@ -310,34 +310,18 @@ Shared props work with `react:` hashes, `react: true`, and explicit `react: "com
 
 ### Conditional Shared Props
 
-`react_email_share` accepts the same filter options as `before_action`: `only`, `except`, `if`, and `unless`.
+`react_share` accepts the same filter options as `before_action`: `only`, `except`, `if`, and `unless`.
 
 ```ruby
-react_email_share only: [:welcome, :reactivation] do
+react_share only: [:welcome, :reactivation] do
   { promotion: params.fetch(:promotion) }
 end
 
-react_email_share if: :account_active? do
+react_share if: :account_active? do
   { account: { name: params.fetch(:account).name } }
 end
 ```
 
-You can also share props inside an action before calling `mail`:
-
-```ruby
-def welcome
-  account = params.fetch(:account)
-
-  react_email_share notice: "Thanks for joining!"
-
-  mail(
-    to: account.email,
-    subject: "Welcome",
-    react: { account: account.as_json(only: [:name]) },
-  )
-end
-```
-
 ### Deep Merging Shared Props
 
 Shared props are merged shallowly by default. That means a per-mail prop replaces a shared prop with the same name.
@@ -345,7 +329,7 @@ Shared props are merged shallowly by default. That means a per-mail prop replace
 Pass `deep_merge: true` to merge nested hashes instead:
 
 ```ruby
-react_email_share do
+react_share do
   { settings: { theme: "light", locale: "en" } }
 end
 

data/lib/react_email_rails/action_mailer.rb

@@ -12,7 +12,7 @@ module ReactEmailRails::ActionMailer
       self.react_email_use_instance_props = true
     end
 
-    def react_email_share(hash = nil, **props, &block)
+    def react_share(hash = nil, **props, &block)
       options = props.slice(*SHARED_FILTER_OPTIONS)
       data = hash || props.except(*SHARED_FILTER_OPTIONS)
 
@@ -22,10 +22,6 @@ module ReactEmailRails::ActionMailer
     end
   end
 
-  def react_email_share(hash = nil, **props, &block)
-    react_email_append_shared(hash || props, block)
-  end
-
   def mail(headers = {}, &block)
     return super unless headers.is_a?(Hash)
     return super if headers.empty? && @_mail_was_called

data/lib/react_email_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactEmailRails
-  VERSION = "0.8.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react-email-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Supertape