inline_forms_installer 8.1.8 → 8.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1db2a592daf12e0ddf1b93c67469f400540e58a81b8ca96ee516dccb7a03dc20
-  data.tar.gz: 4e5abd3355753c8f09d79e16431007a0b268066e1106330c4251649262f92fe2
+  metadata.gz: f4163e5ce8733e5d7f2226ce39f9a475a75860497da6d6d0ddf12575deaa661f
+  data.tar.gz: 42640181a8f3927a9e70ea3b536dfa3507eb21b0997b1fd5a4a5409668422002
 SHA512:
-  metadata.gz: 92c4c50ca28769e76767bcc11fc74c742520386cddf55c4559133b95251161dd71d28e2a9e8d3fbddde62b95d9adf6e72f5666b7893ae9f94374132d66af37b6
-  data.tar.gz: d71c002620d3959812057383f6714eb01f9863370351d4436cf419e4b7a2ece6f78a2848ca057209fe6b68956fe42e04bdcd1f75731d6880c06d06b960f358b2
+  metadata.gz: 7034b106b0c14b639fff1385ef6827f5e3431fe9209e978ea932a65e28a58c97ef8a45e9c66b6cac1bbd8a1c906d8628611127714716f954d75df28ac1c232aa
+  data.tar.gz: 70ac2e021ba10ffb43fbae4f7608134b1f25ad0583d6f92658166a963aadcc8a9d7deb25b8d3389cbd575224e95f0698ba470f3b7f26f016d0dc8a03e79542f8

data/lib/inline_forms_installer/installer_core.rb

@@ -431,7 +431,16 @@ END_INITIALIZER
 # Create Locales
 say "- Create locales"
 generate "inline_forms", "Locale name:string title:string #{user_cfg.table_name}:has_many _enabled:yes _list_order:title _presentation:\#{title}"
-append_to_file "db/seeds.rb", "Locale.create({ id: 1, name: 'en', title: 'English' })\n"
+# Seed four locales so the FormElementShowcase HABTM :locales demo
+# (added under --example) has something to check on/off. `id: 1` (en) is
+# the default the admin user is bound to in the line below; the other
+# three are inert until selected by the showcase rows.
+append_to_file "db/seeds.rb", <<~LOCALE_SEED
+  Locale.create({ id: 1, name: 'en', title: 'English' })
+  Locale.create({ id: 2, name: 'nl', title: 'Nederlands' })
+  Locale.create({ id: 3, name: 'de', title: 'Deutsch' })
+  Locale.create({ id: 4, name: 'fr', title: 'Français' })
+LOCALE_SEED
 
 # Create Roles
 say "- Create roles"
@@ -1056,7 +1065,7 @@ if ENV['install_example'] == 'true'
   # ---------------------------------------------------------------------
   say "- Generating FormElementShowcase (one resource per kept Tier 1 form_element)..."
   sleep 1
-  run %q{bundle exec rails g inline_forms FormElementShowcase title:string body_plain_area:plain_text_area count:integer_field price:decimal_field amount:money_field meeting_date:date_select meeting_time:time_select birth_month:month_select start_month:month_year_picker is_active:check_box gender:radio_button rating_int:dropdown_with_integers priority:dropdown_with_values priority2:dropdown_with_values stars:dropdown_with_values_with_stars scale_int:scale_with_integers scale_val:scale_with_values attachment:file_field jingle:audio_field cover:image_field description:rich_text roles:has_and_belongs_to_many _enabled:yes _list_order:title _list_search:title _presentation:'#{title}'}
+  run %q{bundle exec rails g inline_forms FormElementShowcase title:string body_plain_area:plain_text_area count:integer_field price:decimal_field amount:money_field meeting_date:date_select meeting_time:time_select birth_month:month_select start_month:month_year_picker is_active:check_box gender:radio_button rating_int:dropdown_with_integers priority:dropdown_with_values priority2:dropdown_with_values stars:dropdown_with_values_with_stars scale_int:scale_with_integers scale_val:scale_with_values attachment:file_field jingle:audio_field cover:image_field description:rich_text locales:has_and_belongs_to_many _enabled:yes _list_order:title _list_search:title _presentation:'#{title}'}
 
   say "- Generating Attachment + Jingle uploaders (Cover reuses ImageUploader)..."
   run "bundle exec rails generate uploader Attachment"
@@ -1101,8 +1110,24 @@ if ENV['install_example'] == 'true'
   # keeps PaperTrail revert paths (and the seeded second row, which leaves
   # count nil) valid. The integration test covers the explicit error
   # path by POSTing `count: "abc"` to /form_element_showcases.
+  #
+  # `locales_display` is a virtual alias for the HABTM :locales association
+  # so the same association can render twice in the attribute list: once
+  # editable (`[:locales, :check_list]`) and once read-only
+  # (`[:locales_display, :info_list]`). Inline-forms keys turbo frames by
+  # attribute name, so we need a distinct name for the second row — info_list
+  # has no `_update` method, hence the wrapper rather than a separate column.
+  #
+  # NOTE: this has to be `def locales_display; locales; end`, not
+  # `alias_method :locales_display, :locales`. `alias_method` resolves the
+  # source method at class-load time, but the `has_and_belongs_to_many
+  # :locales` declaration that defines `#locales` is injected lower in the
+  # file (line ~12), so an alias_method here raises
+  # `NameError: undefined method 'locales' for class 'FormElementShowcase'`.
+  # A `def` body is parsed but only resolved at call time, side-stepping
+  # the ordering hazard.
   inject_into_file "app/models/form_element_showcase.rb",
-                   "\n  validates :count, numericality: { only_integer: true }, allow_blank: true\n  mount_uploader :attachment, AttachmentUploader\n  monetize :amount_cents\n",
+                   "\n  validates :count, numericality: { only_integer: true }, allow_blank: true\n  mount_uploader :attachment, AttachmentUploader\n  monetize :amount_cents\n\n  def locales_display\n    locales\n  end\n",
                    after: "class FormElementShowcase < ApplicationRecord\n"
 
   # Value-bearing rows for every form_element that needs a values hash
@@ -1139,13 +1164,18 @@ if ENV['install_example'] == 'true'
     gsub_file "app/models/form_element_showcase.rb", from, to
   end
 
-  # Insert :roles (info_list), :header_meta, and the timestamps after
-  # the rich_text row. The generator does not emit a row for
-  # `roles:has_and_belongs_to_many` (relation? is true), so we add it
-  # manually here.
+  # Insert :locales (editable check_list), :locales_display (read-only
+  # info_list mirror of the same association — see the alias_method
+  # above), :header_meta, and the timestamps after the rich_text row.
+  # The generator does not emit a row for `locales:has_and_belongs_to_many`
+  # (relation? is true), so we add the rows manually here. Locale (not
+  # Role) was chosen because Role is reserved for the user/Member model
+  # in the inline_forms example app (the join sits under roles_users);
+  # Locale already has a `_presentation` returning `title`, which is
+  # exactly what `info_list_show` renders per row.
   gsub_file "app/models/form_element_showcase.rb",
             "[ :description, :rich_text ], \n",
-            "[ :description, :rich_text ], \n     [ :roles, :info_list ], \n     [ :header_meta, :header ], \n     [ :created_at, :info ], \n     [ :updated_at, :info ], \n"
+            "[ :description, :rich_text ], \n     [ :locales, :check_list ], \n     [ :locales_display, :info_list ], \n     [ :header_meta, :header ], \n     [ :created_at, :info ], \n     [ :updated_at, :info ], \n"
 
   # Locale keys for the showcase attributes. Headers + the timestamps
   # need explicit labels so `human_attribute_name` does not fall back to
@@ -1170,7 +1200,7 @@ if ENV['install_example'] == 'true'
           meeting_date: Meeting date
           meeting_time: Meeting time
           birth_month: Birth month
-          start_month: Start month
+          start_month: Start month and year
           is_active: Is active
           gender: Gender
           rating_int: Rating
@@ -1183,7 +1213,8 @@ if ENV['install_example'] == 'true'
           jingle: Jingle
           cover: Cover
           description: Description
-          roles: Roles
+          locales: Locales (editable)
+          locales_display: Locales (read-only)
           created_at: Created at
           updated_at: Updated at
   END_SHOWCASE_LOCALE
@@ -1199,22 +1230,36 @@ if ENV['install_example'] == 'true'
     copy_file src, File.join("app/assets/images", "#{n}stars.png") if File.exist?(src)
   end
 
-  # Join table for has_and_belongs_to_many :roles. Mirrors the
-  # roles_users join migration created for the user model above.
-  say "- Creating form_element_showcases_roles join migration..."
+  # File/audio/image upload sample assets for the full-demo seed. Copied
+  # under db/seed_uploads so the seed migration can read them at
+  # db:migrate time and store them through CarrierWave. Mirrors the
+  # db/seed_images convention used for the Photo gallery seed above.
+  %w[sample.txt sample.wav sample_cover.png].each do |basename|
+    src = File.join(showcase_assets_root, basename)
+    copy_file src, File.join("db/seed_uploads", basename) if File.exist?(src)
+  end
+
+  # Join table for has_and_belongs_to_many :locales. Mirrors the
+  # roles_users join migration created for the user model above. Locale
+  # (not Role) was chosen because Role is reserved for the Member/User
+  # auth model; using it here would coincidentally share the same join
+  # row pool as roles_users which is confusing for the demo. The four
+  # locales seeded above (en/nl/de/fr) give the editable check_list
+  # something interesting to toggle.
+  say "- Creating form_element_showcases_locales join migration..."
   sleep 1
   habtm_ts = Time.now.utc.strftime("%Y%m%d%H%M%S")
-  create_file "db/migrate/#{habtm_ts}_create_join_table_form_element_showcases_roles.rb", <<-HABTM_MIGRATION.strip_heredoc
-    class CreateJoinTableFormElementShowcasesRoles < ActiveRecord::Migration[8.1]
+  create_file "db/migrate/#{habtm_ts}_create_join_table_form_element_showcases_locales.rb", <<-HABTM_MIGRATION.strip_heredoc
+    class CreateJoinTableFormElementShowcasesLocales < ActiveRecord::Migration[8.1]
       def self.up
-        create_table :form_element_showcases_roles, id: false, force: true do |t|
+        create_table :form_element_showcases_locales, id: false, force: true do |t|
           t.integer :form_element_showcase_id
-          t.integer :role_id
+          t.integer :locale_id
         end
       end
 
       def self.down
-        drop_table :form_element_showcases_roles
+        drop_table :form_element_showcases_locales
       end
     end
   HABTM_MIGRATION
@@ -1249,9 +1294,30 @@ if ENV['install_example'] == 'true'
           s.scale_val       = 2
           s.description     = "<p>A rich-text paragraph for the showcase.</p>"
         end
-        if defined?(Role) && Role.exists?(1) && full.roles.empty?
-          full.roles << Role.find(1)
+        # Attach the default locale (en) so the editable check_list and the
+        # paired read-only info_list both have something to show. The other
+        # seeded locales (nl/de/fr) stay unchecked so the toggle UX is
+        # exercised when the user opens the check_list.
+        if defined?(Locale) && Locale.exists?(1) && full.locales.empty?
+          full.locales << Locale.find(1)
+        end
+
+        # File/audio/image uploads for the full demo. The asset files are
+        # copied into db/seed_uploads/ from lib/installer_templates/example_app_assets/
+        # at install time (see the asset-copy block above), so this
+        # migration can open them at db:migrate time and hand File handles
+        # to CarrierWave for storage in public/uploads/.
+        seed_uploads = Rails.root.join("db", "seed_uploads")
+        {
+          attachment: seed_uploads.join("sample.txt"),
+          jingle:     seed_uploads.join("sample.wav"),
+          cover:      seed_uploads.join("sample_cover.png"),
+        }.each do |attr, path|
+          next unless path.file?
+          next if full.public_send(attr).present?
+          File.open(path, "rb") { |io| full.public_send("\#{attr}=", io) }
         end
+        full.save! if full.changed?
 
         # "Empty" refers to the role and uploader fields (their empty
         # branches need to render). The other fields keep valid values

data/lib/inline_forms_installer/version.rb

@@ -1,6 +1,6 @@
 # -*- encoding : utf-8 -*-
 module InlineFormsInstaller
-  VERSION = "8.1.8"
+  VERSION = "8.1.9"
 
   # Written into generated apps' `.ruby-version` (must match gemspec `required_ruby_version`).
   TARGET_RUBY_VERSION = "ruby-4.0.4"

data/lib/installer_templates/example_app_assets/sample.txt

@@ -0,0 +1 @@
+Sample attachment file generated by inline_forms_installer for the FormElementShowcase demo. You can replace this with any file.

data/lib/installer_templates/example_app_tests/test/integration/example_app_showcase_locales_associations_test.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "../example_app/example_integration_test_case"
+
+# HABTM helpers on FormElementShowcase:
+#   check_list  (locales)          -- editable multi-select
+#   info_list   (locales_display)  -- read-only mirror of the same association
+#                                     via `alias_method :locales_display, :locales`
+#
+# Locale (not Role) is the showcase association because Role is reserved
+# for the auth Member/User model in this example app; reusing it on
+# FormElementShowcase would coincidentally share rows with roles_users
+# which is confusing.
+class ExampleAppShowcaseLocalesAssociationsTest < ExampleAppIntegrationTestCase
+  setup do
+    @en = Locale.find_or_create_by!(name: "en") { |l| l.title = "English"    }
+    @nl = Locale.find_or_create_by!(name: "nl") { |l| l.title = "Nederlands" }
+    @de = Locale.find_or_create_by!(name: "de") { |l| l.title = "Deutsch"    }
+
+    @showcase = FormElementShowcase.find_or_create_by!(title: "Locales demo")
+    @showcase.locales.clear
+  end
+
+  def field_frame(attr)
+    "form_element_showcase_#{@showcase.id}_#{attr}"
+  end
+
+  def field_headers(attr)
+    { "Turbo-Frame" => field_frame(attr), "Accept" => "text/html" }
+  end
+
+  test "check_list locales toggles the HABTM association" do
+    frame = field_frame(:locales)
+
+    # Initially empty; PUT with two locales checked.
+    put form_element_showcase_path(
+      @showcase,
+      attribute: "locales",
+      form_element: "check_list",
+      update: frame
+    ), params: { locales: { @en.id.to_s => 1, @de.id.to_s => 1 } }, headers: field_headers(:locales)
+
+    assert_response :success
+    assert_equal [@en.id, @de.id].sort, @showcase.reload.locale_ids.sort
+
+    # PUT again with only one locale; the missing one is uncoupled.
+    put form_element_showcase_path(
+      @showcase,
+      attribute: "locales",
+      form_element: "check_list",
+      update: frame
+    ), params: { locales: { @nl.id.to_s => 1 } }, headers: field_headers(:locales)
+
+    assert_response :success
+    assert_equal [@nl.id], @showcase.reload.locale_ids
+  end
+
+  test "info_list locales_display mirrors the locales association read-only" do
+    @showcase.locales << @en unless @showcase.locales.where(id: @en.id).exists?
+
+    row_frame = "form_element_showcase_#{@showcase.id}"
+    get form_element_showcase_path(@showcase, update: row_frame),
+        headers: { "Turbo-Frame" => row_frame, "Accept" => "text/html" }
+
+    assert_response :success
+    info_frame = field_frame(:locales_display)
+    assert_includes @response.body, %(<turbo-frame id="#{info_frame}">),
+      "expected info_list frame for :locales_display"
+    # info_list_show renders each item's `_presentation`. Locale's is `title`.
+    assert_match(/<turbo-frame id="#{info_frame}">.*#{Regexp.escape(@en.title)}/m, @response.body,
+      "expected #{@en.title.inspect} inside the locales_display info_list frame")
+  end
+
+  test "info_list locales_display empty-state renders the -- placeholder" do
+    @showcase.locales.clear
+
+    row_frame = "form_element_showcase_#{@showcase.id}"
+    get form_element_showcase_path(@showcase, update: row_frame),
+        headers: { "Turbo-Frame" => row_frame, "Accept" => "text/html" }
+
+    assert_response :success
+    info_frame = field_frame(:locales_display)
+    assert_match(/<turbo-frame id="#{info_frame}">[^<]*<div class='row [^']+'>--<\/div>/m, @response.body,
+      "expected empty `--` placeholder inside the locales_display frame")
+  end
+end

data/lib/installer_templates/example_app_tests/test/integration/example_app_showcase_page_render_test.rb

@@ -30,7 +30,8 @@ class ExampleAppShowcasePageRenderTest < ExampleAppIntegrationTestCase
     jingle
     cover
     description
-    roles
+    locales
+    locales_display
     created_at
     updated_at
   ].freeze
@@ -46,8 +47,7 @@ class ExampleAppShowcasePageRenderTest < ExampleAppIntegrationTestCase
   ].freeze
 
   setup do
-    locale = Locale.find_or_create_by!(name: "en") { |l| l.title = "English" }
-    @role = Role.find_or_create_by!(name: "superadmin") { |r| r.description = "Super Admin" }
+    @locale = Locale.find_or_create_by!(name: "en") { |l| l.title = "English" }
 
     @full = FormElementShowcase.find_or_create_by!(title: "Full demo") do |s|
       s.body_plain_area = "Plain text body"
@@ -68,12 +68,12 @@ class ExampleAppShowcasePageRenderTest < ExampleAppIntegrationTestCase
       s.amount          = Money.from_amount(99.95, "USD") if s.respond_to?(:amount=) && defined?(Money)
       s.description     = "<p>A rich-text body.</p>"
     end
-    @full.roles << @role unless @full.roles.where(id: @role.id).exists?
+    @full.locales << @locale unless @full.locales.where(id: @locale.id).exists?
 
     @empty = FormElementShowcase.find_or_create_by!(title: "Empty demo") do |s|
       # Keep dropdown/scale integers at valid indices so the show helpers
-      # do not crash on nil. The point of "empty demo" is that roles and
-      # uploads are blank, not every integer attribute.
+      # do not crash on nil. The point of "empty demo" is that locales
+      # and uploads are blank, not every integer attribute.
       s.gender     = 1
       s.rating_int = 1
       s.priority   = 1
@@ -103,22 +103,21 @@ class ExampleAppShowcasePageRenderTest < ExampleAppIntegrationTestCase
         "expected header label for #{attr} (#{label.inspect})"
     end
 
-    assert_includes @response.body, @role.name,
-      "expected info_list to render the role's _presentation"
+    assert_includes @response.body, @locale.title,
+      "expected info_list to render the locale's _presentation"
   end
 
-  test "empty showcase info_list renders the no-roles placeholder" do
+  test "empty showcase info_list renders the no-locales placeholder" do
     row_frame = "form_element_showcase_#{@empty.id}"
     get form_element_showcase_path(@empty, update: row_frame),
         headers: { "Turbo-Frame" => row_frame, "Accept" => "text/html" }
 
     assert_response :success
-    frame = "form_element_showcase_#{@empty.id}_roles"
+    frame = "form_element_showcase_#{@empty.id}_locales_display"
     body = @response.body
     assert_includes body, %(<turbo-frame id="#{frame}">)
-    frame_block = body[body.index(%(<turbo-frame id="#{frame}">"))..-1] rescue nil
     # info_list_show emits a `--` placeholder for empty associations.
     assert_match(/<turbo-frame id="#{frame}">[^<]*<div class='row [^']+'>--<\/div>/m, body,
-      "expected info_list empty placeholder `--` inside roles frame")
+      "expected info_list empty placeholder `--` inside locales_display frame")
   end
 end

data/lib/installer_templates/example_app_tests/test/models/example_app_form_element_showcase_test.rb

@@ -36,7 +36,8 @@ class ExampleAppFormElementShowcaseTest < ActiveSupport::TestCase
     cover
     header_rich
     description
-    roles
+    locales
+    locales_display
     header_meta
     created_at
     updated_at

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inline_forms_installer
 version: !ruby/object:Gem::Version
-  version: 8.1.8
+  version: 8.1.9
 platform: ruby
 authors:
 - Ace Suares
@@ -94,6 +94,9 @@ files:
 - lib/installer_templates/example_app_assets/3stars.png
 - lib/installer_templates/example_app_assets/4stars.png
 - lib/installer_templates/example_app_assets/5stars.png
+- lib/installer_templates/example_app_assets/sample.txt
+- lib/installer_templates/example_app_assets/sample.wav
+- lib/installer_templates/example_app_assets/sample_cover.png
 - lib/installer_templates/example_app_tests/test/example_app/example_integration_test_case.rb
 - lib/installer_templates/example_app_tests/test/integration/example_app_apartment_field_turbo_test.rb
 - lib/installer_templates/example_app_tests/test/integration/example_app_apartment_name_list_test.rb
@@ -111,6 +114,7 @@ files:
 - lib/installer_templates/example_app_tests/test/integration/example_app_routing_test.rb
 - lib/installer_templates/example_app_tests/test/integration/example_app_showcase_choice_scale_fields_test.rb
 - lib/installer_templates/example_app_tests/test/integration/example_app_showcase_date_time_fields_test.rb
+- lib/installer_templates/example_app_tests/test/integration/example_app_showcase_locales_associations_test.rb
 - lib/installer_templates/example_app_tests/test/integration/example_app_showcase_numeric_fields_test.rb
 - lib/installer_templates/example_app_tests/test/integration/example_app_showcase_page_render_test.rb
 - lib/installer_templates/example_app_tests/test/integration/example_app_showcase_text_fields_test.rb