file handling: core files, html, and image files

[candyhazlett]

task

refactor database table structure and associations for user-provided records within a collection. proposed new structure, outlined below after discussion with data engineer Joel, will do the following:

• reintroduce image files and html files as distinct but related entities
• add four new tables
  • document
  • document_core_file
  • document_image_file
  • document_html_file
• replace direct habtm association between core_file and collection with direct association between core_files, html, and image files with document association through which each of these entities is indirectly associated with collection(s)

proposed structural refactor

• document
  • belongs to many collections
  • represents what a core file is (supposed to be) now, just simpler; a grouping of individual attachments assembled and presented to the user
    • in the future, whenever a new ‘core file’ would have been created, a document is created instead
    • columns
      • id
      • title
      • depositor_id
      • description
      • visibility (public or private)
    • document_collection
    • belongs_to document
    • belongs_to collection
    • columns
    • document_id
    • collection_id
    • core_file
    • attached tei
    • xml files exclusively
    • belongs to many documents, through document_core_files
    • belongs_to depositor
    • add’l columns
      • ography_type
    • document_core_file
  • belongs_to document
  • belongs_to core_file
  • columns
    • document_id
    • core_file_id
      • image_file (formerly image_master)
  • attached image file
  • .jpeg, .jpg, .gif, or .png format exclusively
  • belongs to many documents, through document_images
  • belongs_to depositor
  • add’l columns
    • image_type
      • thumbnail
      • page_image
      • other_image
• document_image
  • belongs_to document
  • belongs_to image
  • columns
    • document_id
    • image_file_id
      • html_file
  • attached html file
  • belongs_to depositor
  • belongs_to_many documents, through document_html
    • document_html
    • belongs_to_document
    • belongs_to html
    • columns
    • document_id
    • html_file_id

[amclark42]

I keep getting stuck in the "System Dependencies" section. There isn't enough detail to walk a novice through set-up, and pretty much all of the linked sites are either lacking documentation, or full of gotchas. 😣 I've done this in the past, but even with my fuzzy memories it's been frustrating.

Here's what I got so far, for a MacOS installation. I used Homebrew as my package manager.

0. Start in the tapas_rails directory.
1. Install Ruby Version Manager (RVM)
2. Install Xcode from the Mac App Store a. Install the Command Line Tools package with xcode-select --install
3. Install or make sure the automake package is installed (with Homebrew)
4. Install or make sure the openssl@3 (v3.4.0) package is installed (with Homebrew)
5. Install Ruby v2.7.7 a. Figure out where openssl was installed with which openssl b. Try RVM's default install, rvm install ruby-2.7.7 (or the shorthand rvm install 2.7.7) c. If the installation failed because the ruby source couldn't be compiled, provide the OpenSSL path: rvm install ruby-2.7.7 -C --with-openssl-dir='/opt/homebrew/bin/openssl'
6. Install Rails v5.2.6: gem install rails -v 5.2.6
7. Install or make sure the mysql package is installed (with Homebrew) a. If on a fresh install, run brew services start mysql b. If on a fresh install, configure the root password with mysql_secure_installation c. I don't think I'm done with this step because...
8. Install gems needed for TAPAS Rails: bundle install a. This fails on the mysql2 gem.

I remember that the mysql2 gem is really tricky to set up (see the old dev installation notes), and I may end up needing to uninstall and reinstall a different version of MySQL to get things working.

I don't have the patience to do that today. I'll come back to this in a day or two.