Herbarium form modal (reusable Location-creation UI)

app/assets/stylesheets/Admin.scss

@@ -9,7 +9,7 @@ $LOGO_BG_COLOR:               yellow;
 $LOGO_HOVER_FG_COLOR:         purple;
 $LOGO_HOVER_BG_COLOR:         yellow;
 
-$LEFT_BAR_BORDER_COLOR:       #535454; // gray
+$LEFT_BAR_BORDER_COLOR:       #535354; // gray
 $LEFT_BAR_BORDER_RADIUS:      0px;
 $LEFT_BAR_HEADER_FG_COLOR:    black;
 $LEFT_BAR_HEADER_BG_COLOR:    yellow;

app/assets/stylesheets/Agaricus.scss

@@ -1,7 +1,7 @@
 @import "defaults";
 
 $augustus_cap:         #ECCF95;
-$brasiliensis_gills_1: #BF6362; // #A06463
+$brasiliensis_gills_1: #BF6262; // #A06463
 $brasiliensis_gills_2: #743931;
 $campestris_cap:       #F6F0F2;
 $cupreobrunneus_gills: #3B2821;

app/assets/stylesheets/Amanita.scss

@@ -13,7 +13,7 @@ $calyptroderma_middle_cap:        #c18346;
 $muscaria_background:             #cc2616;
 $muscaria_foreground:             #fff8c6;
 $velosa_background:               #dd9d5f;
-$velosa_light_veil:               #f9e9d3; // faebd4
+$velosa_light_veil:               #f9e8d3; // faebd4
 $velosa_dark_veil:                #f4d5a6;
 $novinupta_background:            #d1afa5;
 $pachycolea_background:           #383138;

app/assets/stylesheets/BlackOnWhite.scss

@@ -4,7 +4,7 @@
 
 $LOGO_BORDER_COLOR:                 #DDDDDD;
 $LEFT_BAR_BORDER_COLOR:             #DDDDDD;
-$TOP_BAR_BORDER_COLOR:              #D9D9Da;
+$TOP_BAR_BORDER_COLOR:              #D9D9D9;
 $LIST_BORDER_COLOR:                 #DDDDDD;
 $BUTTON_HOVER_BORDER_COLOR:         #CCCCCC;
 $BUTTON_BG_COLOR:                   #CCCCCC;

app/assets/stylesheets/Cantharellaceae.scss

@@ -11,7 +11,7 @@ $tubaeformis_hymenium:          #c2914c;
 $tubaeformis_bright_stipe:      #ffb230;
 $tubaeformis_dark_stipe:        #4b2e0c;
 $tubaeformis_light_stipe:       #e5bb67;
-$cornucopioides_dark_hymenium:  #12120d; // image 465 #10110b
+$cornucopioides_dark_hymenium:  #13120d; // image 465 #10110b
 $cornucopioides_light_hymenium: #9b9690;
 $cornucopioides_dark_cap:       #4f4337;
 $cornucopioides_light_cap:      #826c57;

app/assets/stylesheets/Hygrocybe.scss

@@ -1,6 +1,6 @@
 @import "defaults";
 
-$conica_stain:          #34342d; // #37372f
+$conica_stain:          #34342c; // #37372f
 $conica_cap_red:        #a31404;
 $conica_cap_orange:     #dd6226;
 $conica_cap_yellow:     #ffbf01;

app/assets/stylesheets/Sudo.scss

@@ -1,6 +1,6 @@
 @import "defaults";
 
-$BODY_BG_COLOR:               #DE7200; // #DD7700
+$BODY_BG_COLOR:               #DE7201; // #DD7700
 
 $LOGO_BORDER_COLOR:           black;
 $LOGO_BORDER_WIDTH:           2px; // vs 1px in default

app/assets/stylesheets/mo/_autocomplete.scss

@@ -12,6 +12,15 @@
   }
 }
 
+.keep-btn {
+  display: none;
+}
+.create {
+  .keep-btn {
+    display: inline-block;
+  }
+}
+
 // initially we may not have id, but we also don't offer create
 // until they've typed something
 .create-button {

app/controllers/application_controller.rb

@@ -788,7 +788,12 @@ def flash_object_errors(obj)
   def save_with_log(obj)
     type_sym = obj.class.to_s.underscore.to_sym
     if obj.save
-      flash_notice(:runtime_created_at.t(type: type_sym))
+      notice = if obj.respond_to?(:text_name) && (name = obj.text_name)
+                 :runtime_created_name.t(type: type_sym, value: name)
+               else
+                 :runtime_created_at.t(type: type_sym)
+               end
+      flash_notice(notice)
       true
     else
       flash_error(:runtime_no_save.t(type: type_sym))

app/controllers/herbaria_controller.rb

@@ -45,7 +45,10 @@
 # See https://tinyurl.com/ynapvpt7
 
 # View and modify Herbaria (displayed as "Fungaria")
+# rubocop:disable Metrics/ClassLength
 class HerbariaController < ApplicationController
+  include ::Locationable
+
   before_action :login_required
   # only: [:create, :destroy, :edit, :new, :update]
   before_action :store_location, only: [:create, :edit, :new, :show, :update]
@@ -99,24 +102,69 @@ def show
 
   def new
     @herbarium = Herbarium.new
+    respond_to do |format|
+      format.turbo_stream { render_modal_herbarium_form }
+      format.html
+    end
   end
 
   def edit
     @herbarium = find_or_goto_index(Herbarium, params[:id])
-    return unless @herbarium
-    return unless make_sure_can_edit!
+    return unless @herbarium && make_sure_can_edit!
+
+    set_up_herbarium_for_edit
+    respond_to do |format|
+      format.turbo_stream { render_modal_herbarium_form }
+      format.html
+    end
+  end
 
+  def set_up_herbarium_for_edit
     @herbarium.place_name         = @herbarium.location.try(&:name)
     @herbarium.personal           = @herbarium.personal_user_id.present?
     @herbarium.personal_user_name = @herbarium.personal_user.try(&:login)
   end
 
+  def render_modal_herbarium_form
+    render(partial: "shared/modal_form",
+           locals: { title: modal_title, action: modal_form_action,
+                     identifier: modal_identifier, local: false,
+                     form: "herbaria/form" }) and return
+  end
+
+  def modal_identifier
+    case action_name
+    when "new", "create"
+      "herbarium"
+    when "edit", "update"
+      "herbarium_#{@herbarium.id}"
+    end
+  end
+
+  def modal_title
+    case action_name
+    when "new", "create"
+      :create_herbarium_title.l
+    when "edit", "update"
+      :edit_herbarium_title.l
+    end
+  end
+
+  def modal_form_action
+    case action_name
+    when "new", "create" then :create
+    when "edit", "update" then :update
+    end
+  end
+
   # ---------- Actions to Modify data: (create, update, destroy, etc.) ---------
 
   def create
     @herbarium = Herbarium.new(herbarium_params)
     normalize_parameters
-    return render(:new) unless validate_herbarium!
+    create_location_object_if_new(@herbarium)
+    try_to_save_location_if_new(@herbarium)
+    return render(:new) unless validate_herbarium! && !@any_errors
 
     @herbarium.save
     @herbarium.add_curator(@user) if @herbarium.personal_user
@@ -130,7 +178,9 @@ def update
 
     @herbarium.attributes = herbarium_params
     normalize_parameters
-    return unless validate_herbarium!
+    create_location_object_if_new(@herbarium)
+    try_to_save_location_if_new(@herbarium)
+    return unless validate_herbarium! && !@any_errors
 
     @herbarium.save
     redirect_to_create_location_or_referrer_or_show_location
@@ -265,6 +315,10 @@ def validate_admin_personal_user!
     flash_notice(
       :edit_herbarium_successfully_made_personal.t(user: user.login)
     )
+    update_personal_herbarium(user)
+  end
+
+  def update_personal_herbarium(user)
     @herbarium.curators.clear
     @herbarium.add_curator(user)
     @herbarium.personal_user_id = user.id
@@ -326,7 +380,7 @@ def user_can_destroy_herbarium?
 
   def redirect_to_create_location_or_referrer_or_show_location
     redirect_to_create_location || redirect_to_referrer ||
-      redirect_with_query(herbarium_path(@herbarium))
+      show_modal_flash_or_show_herbarium
   end
 
   def redirect_to_create_location
@@ -339,11 +393,39 @@ def redirect_to_create_location
     true
   end
 
+  # this updates both the form and the flash
+  def reload_herbarium_modal_form_and_flash
+    render(
+      partial: "shared/modal_form_reload",
+      locals: { identifier: modal_identifier, form: "herbaria/form" }
+    ) and return true
+  end
+
+  # What to do if the save succeeds
+  def show_modal_flash_or_show_herbarium
+    respond_to do |format|
+      format.html do
+        redirect_with_query(herbarium_path(@herbarium)) and return
+      end
+      format.turbo_stream do
+        # Context here is the obs form.
+        flash_notice(
+          :runtime_created_name.t(type: :herbarium, value: @herbarium.name)
+        )
+        flash_notice(
+          :runtime_added_to.t(type: :herbarium, name: :observation)
+        )
+        render(partial: "herbaria/update_observation") and return
+      end
+    end
+  end
+
   def herbarium_params
     return {} unless params[:herbarium]
 
     params.require(:herbarium).
-      permit(:name, :code, :email, :mailing_address, :description,
+      permit(:name, :code, :email, :mailing_address, :description, :location_id,
              :place_name, :personal, :personal_user_name)
   end
 end
+# rubocop:enable Metrics/ClassLength

app/extensions/string_extensions.rb

@@ -23,6 +23,8 @@
 #  gsub_html_special_chars:: auxiliary to html_to_ascii
 #  unescape_html::      Render special encoded characters as regular characters
 #  as_displayed::       Render everything humanly legible, for integration tests
+#  id_of_nested_field:: Rails generates `observation_notes` for the ID of a
+#                       nested field like `observation[notes]`
 #  ---
 #  break_name::         Break a taxon name at the author
 #  small_author::       Wrap the author in a <small> span
@@ -546,6 +548,12 @@ def as_displayed
     strip_html.unescape_html.strip_squeeze
   end
 
+  # Rails generates an id for a nested field like "foo[bar]" that's snake_case
+  # - no brackets. This gets you that string. (used in forms_helper)
+  def id_of_nested_field
+    gsub(/[\[\]]+/, "_").chop
+  end
+
   # Insert a line break between the scientific name and the author
   # (for styling taxonomic names legibly)
   def break_name

app/helpers/autocompleter_helper.rb

@@ -25,7 +25,7 @@ def autocompleter_field(**args)
     ac_args[:wrap_data] = { autocompleter_target: "wrap" }
     ac_args[:label_after] = autocompleter_label_after(args)
     ac_args[:label_end] = autocompleter_label_end(args)
-    ac_args[:append] = autocompleter_dropdown
+    ac_args[:append] = autocompleter_append(args)
 
     tag.div(id: args[:controller_id],
             data: autocompleter_controller_data(args)) do
@@ -61,8 +61,8 @@ def autocompleter_label_after(args)
       [
         autocompleter_has_id_indicator,
         autocompleter_find_button(args),
-        autocompleter_keep_button(args),
-        autocompleter_hidden_field(**args)
+        autocompleter_keep_box_button(args),
+        autocompleter_edit_box_button(args)
       ].safe_join
     end
   end
@@ -85,8 +85,9 @@ def autocompleter_create_button(args)
 
     icon_link_to(
       args[:create_text], "#",
+      id: "create_#{args[:type]}_btn", class: "ml-3 create-button",
       icon: :plus, show_text: true, icon_class: "text-primary",
-      name: "create_#{args[:type]}", class: "ml-3 create-button",
+      name: "create_#{args[:type]}",
       data: { autocompleter_target: "createBtn",
               action: "autocompleter#swapCreate:prevent" }
     )
@@ -110,22 +111,33 @@ def autocompleter_find_button(args)
     icon_link_to(
       args[:find_text], "#",
       icon: :find_on_map, show_text: false, icon_class: "text-primary",
-      name: "find_#{args[:type]}", class: "ml-3 d-none",
+      name: "find_#{args[:type]}", class: "ml-3 find-btn d-none",
       data: { map_target: "showBoxBtn",
               action: "map#showBox:prevent" }
     )
   end
 
-  def autocompleter_keep_button(args)
+  def autocompleter_keep_box_button(args)
     return unless args[:keep_text]
 
     icon_link_to(
       args[:keep_text], "#",
       icon: :apply, show_text: false, icon_class: "text-primary",
-      active_icon: :edit, active_content: args[:edit_text],
-      name: "keep_#{args[:type]}", class: "ml-3 d-none",
+      name: "keep_#{args[:type]}", class: "ml-3 keep-btn d-none",
       data: { autocompleter_target: "keepBtn", map_target: "lockBoxBtn",
-              action: "map#toggleBoxLock:prevent" }
+              action: "map#toggleBoxLock:prevent form-exif#showFields" }
+    )
+  end
+
+  def autocompleter_edit_box_button(args)
+    return unless args[:keep_text]
+
+    icon_link_to(
+      args[:edit_text], "#",
+      icon: :edit, show_text: false, icon_class: "text-primary",
+      name: "edit_#{args[:type]}", class: "ml-3 edit-btn d-none",
+      data: { autocompleter_target: "editBtn", map_target: "editBoxBtn",
+              action: "map#toggleBoxLock:prevent form-exif#showFields" }
     )
   end
 
@@ -150,6 +162,11 @@ def autocompleter_type_to_model(type)
     end
   end
 
+  def autocompleter_append(args)
+    [autocompleter_dropdown,
+     autocompleter_hidden_field(**args)].safe_join
+  end
+
   def autocompleter_dropdown
     tag.div(class: "auto_complete dropdown-menu",
             data: { autocompleter_target: "pulldown",

app/helpers/forms_helper.rb

@@ -503,7 +503,11 @@ def check_for_help_block(args)
       return args
     end
 
-    id = "#{args[:form].object_name}_#{args[:field]}_help"
+    id = [
+      args[:form].object_name.to_s.id_of_nested_field,
+      args[:field].to_s,
+      "help"
+    ].join("_")
     args[:between] = capture do
       concat(args[:between])
       concat(collapse_info_trigger(id))

app/helpers/panel_helper.rb

@@ -168,7 +168,7 @@ def help_block(element = :div, string = "", **args, &block)
 
   # draw a help block with an arrow
   def help_block_with_arrow(direction = nil, **args, &block)
-    div_class = "well well-sm help-block position-relative"
+    div_class = "well well-sm mb-3 help-block position-relative"
     div_class += " mt-3" if direction == "up"
 
     tag.div(class: div_class, id: args[:id]) do
@@ -182,7 +182,7 @@ def help_block_with_arrow(direction = nil, **args, &block)
   end
 
   def collapse_help_block(direction = nil, string = nil, **args, &block)
-    div_class = "well well-sm help-block position-relative"
+    div_class = "well well-sm mb-3 help-block position-relative"
     div_class += " mt-3" if direction == "up"
     content = block ? capture(&block) : string
 

app/helpers/tabs/herbaria_helper.rb

@@ -71,12 +71,12 @@ def herbaria_curator_request_tabs(herbarium:)
     end
 
     def new_herbarium_tab
-      [:create_herbarium.t, add_query_param(new_herbarium_path),
+      [:create_herbarium.l, add_query_param(new_herbarium_path),
        { class: tab_id(__method__.to_s) }]
     end
 
     def edit_herbarium_tab(herbarium)
-      [:edit_herbarium.t,
+      [:edit_herbarium.l,
        add_query_param(edit_herbarium_path(herbarium.id)),
        { class: tab_id(__method__.to_s) }]
     end