Merge pull request #906 from pulibrary/datatables_source

Load folder data asynchronously.

app/controllers/ephemera_boxes_controller.rb

@@ -10,6 +10,15 @@ class EphemeraBoxesController < BaseResourceController
   before_action :load_collections, only: [:new, :edit]
   before_action :cache_project, only: :destroy
 
+  def folders
+    authorize! :read, resource
+    render json: { data: datatables_folders }
+  end
+
+  def datatables_folders
+    FolderDataSource.new(resource: resource.decorate, helper: self).data
+  end
+
   def attach_drive
     edit
   end

app/controllers/ephemera_projects_controller.rb

@@ -14,6 +14,14 @@ def index
     render 'index'
   end
 
+  def folders
+    render json: { data: datatables_folders }
+  end
+
+  def datatables_folders
+    FolderDataSource.new(resource: resource.decorate, helper: self).data
+  end
+
   def manifest
     @resource = find_resource(params[:id])
     respond_to do |f|

app/decorators/ephemera_box_decorator.rb

@@ -24,6 +24,10 @@ def folders
     @folders ||= members.select { |r| r.is_a?(EphemeraFolder) }.map(&:decorate).to_a
   end
 
+  def folders_count
+    @folders_count ||= query_service.custom_queries.count_members(resource: model, model: EphemeraFolder)
+  end
+
   def ephemera_projects
     @ephemera_projects ||= query_service.find_parents(resource: model).map(&:decorate).to_a
   end

app/decorators/ephemera_project_decorator.rb

@@ -7,15 +7,19 @@ def members
   end
 
   def boxes
-    @boxes ||= members.select { |r| r.is_a?(EphemeraBox) }.map(&:decorate).to_a
+    @boxes ||= query_service.find_members(resource: model, model: EphemeraBox).map(&:decorate).to_a
   end
 
   def fields
-    @fields ||= members.select { |r| r.is_a?(EphemeraField) }.map(&:decorate).to_a
+    @fields ||= query_service.find_members(resource: model, model: EphemeraField).map(&:decorate).to_a
   end
 
   def folders
-    @folders ||= members.select { |r| r.is_a?(EphemeraFolder) }.map(&:decorate).to_a
+    @folders ||= query_service.find_members(resource: model, model: EphemeraFolder).map(&:decorate).to_a
+  end
+
+  def folders_count
+    @folders_count ||= query_service.custom_queries.count_members(resource: model, model: EphemeraFolder)
   end
 
   def templates

app/models/folder_data_source.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+class FolderDataSource
+  attr_reader :resource, :helper
+  delegate :folders, to: :resource
+  def initialize(resource:, helper:)
+    @resource = resource
+    @helper = helper
+  end
+
+  def data
+    @data ||= folders.map do |folder|
+      {
+        folder_number: folder.folder_number,
+        workflow_state: folder.rendered_state,
+        title: folder.title,
+        barcode: folder.barcode,
+        genre: folder.genre.try(:label) || folder.genre,
+        actions: helper.render_to_string(partial: "catalog/folder_actions", locals: { resource: resource, folder: folder }, formats: [:html])
+      }
+    end
+  end
+end

app/queries/count_members.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+class CountMembers
+  def self.queries
+    [:count_members]
+  end
+
+  attr_reader :query_service
+  delegate :orm_class, to: :resource_factory
+  delegate :resource_factory, to: :query_service
+  def initialize(query_service:)
+    @query_service = query_service
+  end
+
+  def count_members(resource:, model: nil)
+    if model
+      orm_class.connection.execute(find_members_with_resource_query(resource, model)).first["count"]
+    else
+      orm_class.connection.execute(find_members_query(resource)).first["count"]
+    end
+  end
+
+  def find_members_query(resource)
+    <<-SQL
+      SELECT COUNT(*) FROM orm_resources a,
+      jsonb_array_elements(a.metadata->'member_ids') AS b(member)
+      JOIN orm_resources member ON (b.member->>'id')::#{id_type} = member.id WHERE a.id = '#{resource.id}'
+    SQL
+  end
+
+  def find_members_with_resource_query(resource, model)
+    <<-SQL
+      SELECT COUNT(*) FROM orm_resources a,
+      jsonb_array_elements(a.metadata->'member_ids') AS b(member)
+      JOIN orm_resources member ON (b.member->>'id')::#{id_type} = member.id WHERE a.id = '#{resource.id}'
+      AND member.internal_resource = '#{model}'
+    SQL
+  end
+
+  def id_type
+    @id_type ||= orm_class.columns_hash["id"].type
+  end
+end

app/views/catalog/_folder_actions.html.erb

@@ -0,0 +1,5 @@
+          <td>
+            <% folder_url = parent_solr_document_path("#{resource.id}", "#{folder.id}") %>
+            <%= link_to 'View', folder_url, class: 'btn btn-default' %>
+            <%= link_to 'Edit', main_app.polymorphic_path([:edit, folder]), class: 'btn btn-default' %>
+          </td>

app/views/catalog/_members_ephemera_box.html.erb

@@ -2,38 +2,21 @@
   <%# DataTable looks for certain data attributes on initialization
     # https://datatables.net/examples/advanced_init/html5-data-options.html
     # here we sort descending by folder number %>
-  <table id="members" class="table table-striped datatable" data-order='[[0, "desc"]]'>
+  <table id="members" class="table table-striped datatable" data-ajax='<%= polymorphic_path([:folders, resource], format: :json) %>' data-order='[[0, "desc"]]'>
     <thead>
     <tr>
       <% if decorated_resource.is_a?(EphemeraBox) %>
-        <th>Folder Number</th>
+        <th data-data="folder_number">Folder Number</th>
       <% end %>
-      <th>Workflow State</th>
-      <th>Title</th>
-      <th>Barcode</th>
-      <th>Genre</th>
-      <th>Actions</th>
+      <th data-data="workflow_state">Workflow State</th>
+      <th data-data="title">Title</th>
+      <th data-data="barcode">Barcode</th>
+      <th data-data="genre">Genre</th>
+      <th data-data="actions">Actions</th>
     </tr>
     </thead>
     <tbody>
-    <% unless decorated_resource.folders.empty? %>
-      <% decorated_resource.folders.each do |folder| %>
-        <% folder_url = parent_solr_document_path("#{resource.id}", "#{folder.id}") %>
-        <tr>
-          <% if decorated_resource.is_a?(EphemeraBox) %>
-            <td class="folder_number"><%= link_to folder.folder_number, folder_url %></td>
-          <% end %>
-          <td><%= folder.rendered_state %></td>
-          <td><%= folder.header %></td>
-          <td class="barcode"><%= folder.barcode %></td>
-          <td class="genre"><%= folder.genre %></td>
-          <td>
-            <%= link_to 'View', folder_url, class: 'btn btn-default' %>
-            <%= link_to 'Edit', main_app.polymorphic_path([:edit, folder]), class: 'btn btn-default' %>
-          </td>
-        </tr>
-      <% end %>
-    <% else %>
+    <% if decorated_resource.folders_count == 0 %>
       <td>This work has no folders attached.  Click "Attach Folder" to attach folders.</td>
     <% end %>
     </tbody>

config/initializers/valkyrie.rb

@@ -181,7 +181,8 @@
     FindProjectFolders,
     FindIdentifiersToReconcile,
     FileSetsSortedByUpdated,
-    FindFixityFailures
+    FindFixityFailures,
+    CountMembers
   ].each do |query_handler|
     Valkyrie.config.metadata_adapter.query_service.custom_queries.register_query_handler(query_handler)
   end

config/routes.rb

@@ -94,6 +94,9 @@
     resources :ephemera_projects do
       resources :templates, only: [:new, :create, :destroy]
       resources :ephemera_fields
+      member do
+        get :folders, defaults: { format: :json }
+      end
       member do
         get :manifest, defaults: { format: :json }
       end
@@ -106,6 +109,9 @@
       member do
         get :attach_drive
       end
+      member do
+        get :folders, defaults: { format: :json }
+      end
     end
 
     resources :ephemera_folders do

spec/controllers/ephemera_boxes_controller_spec.rb

@@ -27,6 +27,38 @@
     end
   end
 
+  describe "folders" do
+    context "when not logged in" do
+      let(:user) { nil }
+      it "redirects CanCan::AccessDenied error to login" do
+        box = FactoryBot.create_for_repository(:private_ephemera_box)
+        get :folders, params: { id: box.id }
+        expect(response).to redirect_to('/users/auth/cas')
+      end
+    end
+    context "when they have permission" do
+      let(:user) { FactoryBot.create(:admin) }
+      render_views
+      it "renders a JSON list of a project's folders" do
+        folder = FactoryBot.create_for_repository(:ephemera_folder)
+        box = FactoryBot.create_for_repository(:ephemera_box, member_ids: folder.id)
+
+        get :folders, params: { id: box.id.to_s, formats: :json }
+
+        json = JSON.parse(response.body)
+        expect(json["data"].length).to eq 1
+        expect(json["data"][0]["folder_number"]).to eq folder.folder_number.first
+        expect(json["data"][0]["workflow_state"]).to eq "<span class=\"label label-info\">Needs QA</span>"
+        expect(json["data"][0]["title"]).to eq folder.title
+        expect(json["data"][0]["barcode"]).to eq folder.barcode.first
+        expect(json["data"][0]["genre"]).to eq folder.genre.first
+        expect(json["data"][0]["actions"]).to have_link "View", href: "/catalog/parent/#{box.id}/#{folder.id}"
+        expect(json["data"][0]["actions"]).to have_link "Edit", href: "/concern/ephemera_folders/#{folder.id}/edit"
+        expect(json["data"][0]["actions"]).not_to have_link "Delete"
+      end
+    end
+  end
+
   describe "create" do
     let(:user) { FactoryBot.create(:admin) }
     let(:valid_params) do

spec/controllers/ephemera_projects_controller_spec.rb

@@ -98,6 +98,28 @@
     end
   end
 
+  describe "folders" do
+    context "when they have permission" do
+      let(:user) { FactoryBot.create(:admin) }
+      render_views
+      it "renders a JSON list of a project's folders" do
+        folder = FactoryBot.create_for_repository(:ephemera_folder)
+        project = FactoryBot.create_for_repository(:ephemera_project, member_ids: folder.id)
+
+        get :folders, params: { id: project.id.to_s, formats: :json }
+
+        json = JSON.parse(response.body)
+        expect(json["data"].length).to eq 1
+        expect(json["data"][0]["folder_number"]).to eq folder.folder_number.first
+        expect(json["data"][0]["workflow_state"]).to eq "<span class=\"label label-info\">Needs QA</span>"
+        expect(json["data"][0]["title"]).to eq folder.title
+        expect(json["data"][0]["barcode"]).to eq folder.barcode.first
+        expect(json["data"][0]["genre"]).to eq folder.genre.first
+        expect(json["data"][0]["actions"]).not_to be_blank
+      end
+    end
+  end
+
   describe "destroy" do
     let(:user) { FactoryBot.create(:admin) }
     context "access control" do

spec/queries/count_members_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'rails_helper'
+
+RSpec.describe CountMembers do
+  subject(:query) { described_class.new(query_service: query_service) }
+  let(:box) { FactoryBot.create_for_repository(:ephemera_box, member_ids: folder.id) }
+  let(:folder) { FactoryBot.create_for_repository(:ephemera_folder) }
+  let(:query_service) { Valkyrie.config.metadata_adapter.query_service }
+
+  describe "#count_members" do
+    it "can give a count of all members" do
+      expect(query.count_members(resource: box)).to eq 1
+    end
+    it "can give a count of all members of a specific type" do
+      expect(query.count_members(resource: box, model: EphemeraFolder)).to eq 1
+      expect(query.count_members(resource: box, model: ScannedResource)).to eq 0
+    end
+  end
+end

spec/views/catalog/_members_ephemera_box.html.erb_spec.rb

@@ -15,16 +15,7 @@
     it 'shows them' do
       expect(rendered).to have_selector 'h2', text: 'Folders'
       expect(rendered).to have_selector 'th', text: 'Folder Number'
-      expect(rendered).to have_selector 'td.folder_number', text: "one"
-      expect(rendered).to have_link "one", href: "/catalog/parent/#{parent.id}/#{child.id}"
-      expect(rendered).not_to have_selector 'td.folder_number', text: "[\"one\"]"
-      expect(rendered).to have_selector 'td.barcode', text: child.barcode.first
-      expect(rendered).not_to have_selector 'td.barcode', text: "[\"#{child.barcode.first}\"]"
-      expect(rendered).to have_selector 'td.genre', text: child.genre.first
-      expect(rendered).not_to have_selector 'td.genre', text: "[\"#{child.genre.first}\"]"
-      expect(rendered).to have_link "View", href: "/catalog/parent/#{parent.id}/#{child.id}"
-      expect(rendered).to have_link "Edit", href: "/concern/ephemera_folders/#{child.id}/edit"
-      expect(rendered).not_to have_link "Delete", href: "/concern/ephemera_folders/#{child.id}"
+      expect(rendered).to have_selector "table.datatable[data-ajax='/concern/ephemera_boxes/#{parent.id}/folders']"
     end
   end
   context "when it's a project with folders" do
@@ -40,10 +31,7 @@
     it 'shows them' do
       expect(rendered).to have_selector 'h2', text: 'Folders'
       expect(rendered).not_to have_selector 'th', text: 'Folder Number'
-      expect(rendered).to have_selector 'td', text: 'test folder'
-      expect(rendered).to have_link "View", href: "/catalog/parent/#{parent.id}/#{child.id}"
-      expect(rendered).to have_link "Edit", href: "/concern/ephemera_folders/#{child.id}/edit"
-      expect(rendered).not_to have_link "Delete", href: "/concern/ephemera_folders/#{child.id}"
+      expect(rendered).to have_selector "table.datatable[data-ajax='/concern/ephemera_projects/#{parent.id}/folders']"
     end
   end
 end

spec/views/catalog/_members_ephemera_project.html.erb_spec.rb

@@ -23,11 +23,6 @@
       expect(rendered).to have_link 'Edit', href: edit_ephemera_box_path(child.id)
 
       expect(rendered).to have_selector 'h2', text: 'Folders'
-      expect(rendered).to have_selector 'span.label-info', text: 'Needs QA'
-      expect(rendered).to have_selector 'td', text: 'test folder'
-      expect(rendered).to have_selector 'td', text: '12345678901234'
-      expect(rendered).to have_link 'View', href: parent_solr_document_path(parent.id, child_folder.id)
-      expect(rendered).to have_link 'Edit', href: edit_ephemera_folder_path(child_folder.id)
     end
   end
   context "when it's a project with templates" do