audiences 1.5.4 → 1.6

data/docs/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+# Version 1.6 (2025-03-19)
+
+- Prepackaged audiences-react in UJS [#510](https://github.com/powerhome/audiences/pull/510)
+
 # Version 1.5.4 (2024-12-19)
 
 - Fix `authenticate` / `authentication` configuration [#481](https://github.com/powerhome/audiences/pull/481)

data/docs/README.md

@@ -26,12 +26,19 @@ $ gem install audiences
 
 ### Creating/Managing Audiences
 
-An audience is tied to an owning model within your application. In this document, we'll use a `Team` model as an example. To create audiences for a team using `audiences-react`, render an audiences editor for your model.
+An audience is tied to an owning model within your application. In this document, we'll use a `Team` model as an example. To create audiences for a team use the `audiences-ujs` package bundled with the gem. Render the audiences editor in your view as follows:
 
-This can be done with an unobtrusive JS renderer like `react-rails` or a custom one as shown in [our dummy app](../audiences/spec/dummy/app/frontend/entrypoints/application.js). The editor requires two arguments:
+```erb
+<%= javascript_include_tag "audiences-ujs", defer: true %>
+<%= render_audiences_editor(@example_owner.members_context) %>
+```
+
+This eliminates the need for `audiences-react` as a separate dependency.
+
+### Required Arguments:
+- **Context**: Example: `owner.members_context`
 
-- The audiences mount point: `audiences.root_url` URL helper
-- The context signed key: I.e.: `owner.members_signed_key` or `Audiences::Context.for(owner, relation:).signed_key`
+For more details, refer to [editor_helper](../lib/audiences/editor_helper.rb).
 
 ### Configuring Audiences
 

data/lib/audiences/editor_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Audiences
+  module EditorHelper
+    def render_audiences_editor(context, html_class: "audiences-editor",
+                                uri: Audiences::Engine.routes.url_helpers.root_path)
+      content_tag(:div, "",
+                  data: {
+                    react_class: "AudiencesEditor",
+                    audiences_uri: uri,
+                    audiences_context: context.signed_key,
+                  },
+                  class: html_class)
+    end
+  end
+end

data/lib/audiences/engine.rb

@@ -10,6 +10,10 @@ module Audiences
   class Engine < ::Rails::Engine
     isolate_namespace Audiences
 
+    initializer "audiences.assets.precompile" do |app|
+      app.config.assets.precompile += %w[audiences-ujs.js] if app.config.respond_to?(:assets)
+    end
+
     initializer "audiences.model" do
       if Audiences.config.identity_class
         ActiveSupport.on_load(:active_record) do

data/lib/audiences/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Audiences
+  class Railtie < Rails::Railtie
+    initializer "audiences.editor_helper" do
+      ActiveSupport.on_load(:action_view) do
+        require "audiences/editor_helper"
+        include Audiences::EditorHelper
+      end
+    end
+  end
+end

data/lib/audiences/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Audiences
-  VERSION = "1.5.4"
+  VERSION = "1.6"
 end

data/lib/audiences.rb

@@ -36,3 +36,4 @@ module_function
 end
 
 require "audiences/configuration"
+require "audiences/railtie"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audiences
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: '1.6'
 platform: ruby
 authors:
 - Carlos Palhares
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -33,6 +33,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
+- app/assets/builds/audiences-ujs.js
 - app/controllers/audiences/application_controller.rb
 - app/controllers/audiences/contexts_controller.rb
 - app/controllers/audiences/scim_proxy_controller.rb
@@ -61,9 +62,11 @@ files:
 - docs/README.md
 - lib/audiences.rb
 - lib/audiences/configuration.rb
+- lib/audiences/editor_helper.rb
 - lib/audiences/engine.rb
 - lib/audiences/model.rb
 - lib/audiences/notifications.rb
+- lib/audiences/railtie.rb
 - lib/audiences/scim.rb
 - lib/audiences/scim/client.rb
 - lib/audiences/scim/resource.rb
@@ -93,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Audiences system