works_cited 0.1.11 → 0.1.16

data/app/models/works_cited/contributor.rb

@@ -57,28 +57,25 @@ module WorksCited
 
     def name_parts
       parts = []
-      parts << first_name_or_initial
-      parts << middle_initial
-      parts << if suffix.present? && last.present?
-                 "#{last}, #{suffix}"
-               else
-                 suffix.presence || last.presence
-               end
+      parts << first_name_or_initial.presence
+      parts << middle_initial.presence
+      parts << [last.presence, suffix.presence].compact.join(', ').presence
       parts
     end
 
     def name_parts_reversed
       parts = []
-      parts << "#{last}," if last.present?
-      parts << first_name_or_initial
-      parts << if suffix.present? && middle_initial.present?
-                 "#{middle_initial}, #{suffix}"
-               else
-                 suffix.presence || middle_initial
-               end
+      parts << [last.presence, name_other_parts.presence].compact.join(', ').presence
       parts
     end
 
+    def name_other_parts
+      other_parts = []
+      other_parts << first_name_or_initial.presence
+      other_parts << [middle_initial.presence, suffix.presence].compact.join(', ').presence
+      other_parts.compact.join(' ').presence
+    end
+
     def first_name_or_initial
       return nil unless first.present?
 
@@ -90,19 +87,5 @@ module WorksCited
 
       middle[0, 1]&.upcase
     end
-
-    if defined?(RailsAdmin)
-      rails_admin do
-        visible false
-        edit do
-          field :contributor_role, :enum do
-            enum do
-              WorksCited.configuration.valid_contributor_roles
-            end
-          end
-          include_all_fields
-        end
-      end
-    end
   end
 end

data/app/views/works_cited/citation_types/fields/_book.html.haml

@@ -1,4 +1,4 @@
-= f.input :url
+= f.input :url, as: :string
 = f.input :title
 = f.input :edition, hint: 'like "1st ed."'
 = f.input :volume, hint: 'like "vol. 1"'

data/app/views/works_cited/citation_types/fields/_electronic.html.haml

@@ -10,5 +10,5 @@
 = f.input :pages, hint: 'like "pp. 150-53"'
 = f.input :online_database
 = f.input :doi, label: 'Digital Object Identifier'
-= f.input :url
+= f.input :url, as: :string
 = f.input :accessed_at, as: :string, hint: 'Will be parsed and formatted', input_html: { value: f.object.accessed_at&.mla_date }

data/app/views/works_cited/citation_types/fields/_email.html.haml

@@ -10,4 +10,4 @@
 = f.input :pages, hint: 'like "pp. 150-53"'
 = f.input :online_database
 = f.input :doi, label: 'Digital Object Identifier'
-= f.input :url
+= f.input :url, as: :string

data/app/views/works_cited/citation_types/fields/_interview.html.haml

@@ -9,4 +9,4 @@
 = f.input :series
 = f.input :published_at, as: :string, hint: 'Will be parsed and formatted', input_html: { value: f.object.published_at&.mla_date }
 = f.input :pages, hint: 'like "pp. 150-53"'
-= f.input :url
+= f.input :url, as: :string

data/app/views/works_cited/citation_types/fields/_periodical.html.haml

@@ -7,4 +7,4 @@
 = f.input :year
 = f.input :published_at, as: :string, hint: 'Will be parsed and formatted', input_html: { value: f.object.published_at&.mla_date }
 = f.input :pages, hint: 'like "pp. 150-53"'
-= f.input :url
+= f.input :url, as: :string

data/app/views/works_cited/citation_types/fields/_tweet.html.haml

@@ -1,4 +1,4 @@
 = f.input :title, label: 'Tweet text'
 = f.input :publisher, default: 'Twitter'
 = f.input :published_at, label: 'Time posted', as: :string, hint: 'Will be parsed and formatted', input_html: { value: f.object.published_at&.mla_datetime }
-= f.input :url
+= f.input :url, as: :string

data/app/views/works_cited/citations/_citation_fields.html.haml

@@ -0,0 +1,28 @@
+:ruby
+  preview_path = f.object.new_record? ? works_cited.preview_citation_url : works_cited.preview_citation_url(f.object.id)
+%fieldset.nested-fields{id: "citation-#{f.index}"}
+  %legend
+    %h4 Citation
+  = f.hidden_field :_destroy
+  = f.hidden_field :record, value: "#{f.object.record_type}:#{f.object.record_id}"
+  = f.input :citation_type, as: :select, collection: WorksCited.configuration.valid_citation_types, :input_html => {:onchange => "showFields('#{citation_id}', this.options[this.selectedIndex].value);"}
+  - WorksCited.configuration.valid_citation_types.each do |citation_type|
+    .fields{ class: "fields-#{citation_type}", style: 'display: none;' }
+      = works_cited_type_fields f, citation_type
+  %fieldset.works_cited_contributors
+    %legend
+      %h3 Contributors
+    %div#works_cited_contributors
+      = f.simple_fields_for :works_cited_contributors do |g|
+        = render 'works_cited/contributors/contributor_fields', f: g
+    = works_cited_link_to_add_fields 'Add Contributor', f, :works_cited_contributors, 'works_cited/contributors/contributor_fields'
+  %fieldset#preview{ style: 'display: none;' }
+    %legend
+      %h2
+        Preview
+        %small (Real-time)
+    .preview-html#preview-html
+  = link_to "Remove", '#', class: 'remove_fields button button-danger'
+:javascript
+  showFields('#{f.index}', '#{f.object.citation_type || 'book'}')
+  startPreview('#{preview_path}', 'citation-#{f.index}',  '#{record.class.table_name.singularize}[works_cited_citations_attributes][#{f.index}]')

data/app/views/works_cited/citations/_fields.html.haml

@@ -0,0 +1,14 @@
+- if cannot?(:manage, WorksCited::Citation)
+  Not authorized for citations.
+- else
+  = stylesheet_link_tag 'works_cited/application'
+  = javascript_include_tag 'works_cited/application'
+  %fieldset.citations
+    %legend
+      %h3 Works Cited
+    %div#citations
+      = form.simple_fields_for :works_cited_citations do |g|
+        = render 'works_cited/citations/citation_fields', f: g, record: form.object
+    = works_cited_link_to_add_fields "Add Citation", form, :works_cited_citations, 'works_cited/citations/citation_fields'
+:javascript
+  addFilterToSubmit()

data/app/views/works_cited/citations/_form.html.haml

@@ -1,6 +1,9 @@
+:ruby
+  preview_path = @citation.new_record? ? works_cited.preview_citations_url : works_cited.preview_citation_url(@citation.id)
+  citation_id = @citation.new_record? ? 'new' : @citation.id
 = stylesheet_link_tag 'works_cited/application'
 = javascript_include_tag 'works_cited/application'
-= simple_form_for @citation, html: { id: 'WorksCitedForm'} do |f|
+= simple_form_for @citation, html: { id: "citation-#{citation_id}"} do |f|
   - if @citation.errors.any?
     #error_explanation
       %h2= "#{pluralize(@citation.errors.count, "error")} prohibited this citation from being saved:"
@@ -10,17 +13,17 @@
   .shared-field
     = f.hidden_field :id
     = f.input :record, collection: @records, as: :grouped_select, group_method: :records, group_label_method: :record_type, label_method: :name, value_method: :id, selected: "#{@citation.record_type}:#{@citation.record_id}", include_blank: 'Select a Record'
-    = f.input :citation_type, as: :select, collection: WorksCited.configuration.valid_citation_types, :input_html => {:onchange => "showFields(this.options[this.selectedIndex].value);"}
+    = f.input :citation_type, as: :select, collection: WorksCited.configuration.valid_citation_types, :input_html => {:onchange => "showFields('#{citation_id}', this.options[this.selectedIndex].value);"}
   - WorksCited.configuration.valid_citation_types.each do |citation_type|
-    .fields{ id: "fields-#{citation_type}", style: 'display: none;' }
-      = works_cited_citation_fields f, citation_type
-  %fieldset#contributors
+    .fields{ class: "fields-#{citation_type}", style: 'display: none;' }
+      = works_cited_type_fields f, citation_type
+  %fieldset.works_cited_contributors
     %legend
-      %h2 Contributors
-    .links
-      = link_to_add_nested f, :works_cited_contributors, '#contributors', link_text: 'Add Contributor', link_classes: 'button button-action', partial: 'works_cited/contributors/fields'
-    = f.simple_fields_for :works_cited_contributors do |contributor|
-      = render 'works_cited/contributors/fields', form: contributor
+      %h3 Contributors
+    %div#works_cited_contributors
+      = f.simple_fields_for :works_cited_contributors do |g|
+        = render 'works_cited/contributors/contributor_fields', f: g
+    = works_cited_link_to_add_fields 'Add Contributor', f, :works_cited_contributors, 'works_cited/contributors/contributor_fields'
   %fieldset#preview{ style: 'display: none;' }
     %legend
       %h2
@@ -30,46 +33,6 @@
   .actions
     .button-wrapper= f.submit 'Save', class: 'button-large button-action'
 :javascript
-  var fields = document.querySelectorAll('input, select');
-  var index = 0;
-
-  for (index = 0; index < fields.length; ++index) {
-    var textField = fields[index];
-    textField.addEventListener('change', loadPreview)
-  }
-
-  function loadPreview() {
-    // Build formData object.
-    var formData = new FormData(document.querySelector('form'))
-    var authenticity_token = document.head.querySelector('meta[name="csrf-token"]').content
-    var preview = document.getElementById('preview')
-    var container = document.getElementById('preview-html')
-
-    fetch('#{preview_citation_url}',
-      {
-        method: 'post',
-        headers: {
-          'X-Requested-With': 'XMLHttpRequest',
-          'X-CSRF-Token': authenticity_token
-        },
-        body: formData,
-        credentials: 'same-origin'
-      })
-      .then(function(response) {
-        // When the page is loaded convert it to text
-        return response.text()
-      })
-      .then((html) => {
-        preview.style.display = 'block'
-        container.innerHTML = html
-      })
-  }
-  function showFields(citation_type) {
-    for (let element of document.getElementsByClassName('fields')){
-      element.style.display='none'
-    }
-    document.getElementById(`fields-${citation_type}`).style.display = 'block'
-  }
-
-  showFields('#{@citation.citation_type || 'book'}')
-  loadPreview()
+  showFields('#{citation_id}', '#{@citation.citation_type || 'book'}')
+  startPreview('#{preview_path}', 'citation-#{citation_id}', 'citation')
+  addFilterToSubmit()

data/app/views/works_cited/citations/preview.html.haml

@@ -1 +1 @@
-= works_cited_preview @citation, @contributors
+= works_cited_preview citation, contributors

data/app/views/works_cited/contributors/_contributor_fields.html.haml

@@ -0,0 +1,11 @@
+%fieldset.nested-fields
+  %legend
+    %h4 Contributor
+  = f.hidden_field :_destroy
+  = f.input :contributor_role, collection: WorksCited.configuration.valid_contributor_roles.map { |x| [x, x] }
+  = f.input :first
+  = f.input :middle, hint: 'Only the initial is used'
+  = f.input :last
+  = f.input :suffix
+  = f.input :handle
+  = link_to "Remove", '#', class: 'remove_fields button button-danger'

data/config/routes.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 WorksCited::Engine.routes.draw do
-  patch 'preview', to: 'citations#preview', as: 'preview_citation'
-  resources :citations
+  resources :citations do
+    member do
+      post 'preview', defaults: { format: :json }
+    end
+    collection do
+      post 'preview', defaults: { format: :json }
+    end
+  end
 end

data/db/migrate/20210915160902_add_index_to_works_cited_contributors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Contributors need to be indexed on their name
+class AddIndexToWorksCitedContributors < ActiveRecord::Migration[6.1]
+  def change
+    add_index :works_cited_contributors, %i[last first middle suffix handle], name: :index_citation_name,
+                                                                              length: 100
+  end
+end

data/lib/works_cited/mixins/has_works_cited.rb

@@ -12,7 +12,7 @@ module WorksCited
         include InstanceMethods
 
         has_many :works_cited_citations, as: :record, class_name: 'WorksCited::Citation'
-        accepts_nested_attributes_for :works_cited_citations, allow_destroy: true
+        accepts_nested_attributes_for :works_cited_citations, reject_if: :all_blank, allow_destroy: true
       end
       # rubocop:enable Naming/PredicateName
 
@@ -22,6 +22,19 @@ module WorksCited
 
       # Included by has_works_cited mixin
       module InstanceMethods
+        def works_cited_citations_attributes=(raw_citations)
+          array = []
+          raw_citations&.each do |_index, citation|
+            destroy = citation.delete(:_destroy)
+            if destroy == '1'
+              Citation.find(citation[:id]).destroy if citation[:id]
+              next
+            end
+
+            array << citation
+          end
+          super array
+        end
       end
     end
   end

data/spec/dummy/app/controllers/doodads_controller.rb

@@ -3,6 +3,7 @@
 # :nocov:
 # Super basic controller for Doodads
 class DoodadsController < ApplicationController
+  include WorksCited::Params
   before_action :set_doodad, only: %i[show edit update destroy]
 
   # GET /doodads
@@ -56,7 +57,7 @@ class DoodadsController < ApplicationController
 
   # Only allow a list of trusted parameters through.
   def doodad_params
-    params.require(:doodad).permit(:name, :description)
+    params.require(:doodad).permit(:name, :description, works_cited_params)
   end
 end
 # :nocov:

data/spec/dummy/app/controllers/things_controller.rb

@@ -56,7 +56,7 @@ class ThingsController < ApplicationController
 
   # Only allow a list of trusted parameters through.
   def thing_params
-    params.require(:thing).permit(:name, :description)
+    params.require(:thing).permit(:name, :description, works_cited_params)
   end
 end
 # :nocov:

data/spec/dummy/app/views/doodads/_form.html.haml

@@ -12,5 +12,7 @@
   .field
     = f.label :description
     = f.text_area :description
+
+  = works_cited_citations_fields f
   .actions
     = f.submit 'Save'

data/spec/dummy/db/migrate/20210915161013_add_index_to_works_cited_contributors.works_cited.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This migration comes from works_cited (originally 20210915160902)
+class AddIndexToWorksCitedContributors < ActiveRecord::Migration[6.1]
+  def change
+    add_index :works_cited_contributors, %i[last first middle suffix handle], name: :index_citation_name,
+                                                                              length: 100
+  end
+end

data/spec/dummy/db/schema.rb

@@ -12,7 +12,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20_210_907_170_207) do
+ActiveRecord::Schema.define(version: 20_210_915_161_013) do
   create_table 'doodads', force: :cascade do |t|
     t.string 'name'
     t.text 'description'
@@ -75,6 +75,7 @@ ActiveRecord::Schema.define(version: 20_210_907_170_207) do
     t.string 'handle'
     t.datetime 'created_at', precision: 6, null: false
     t.datetime 'updated_at', precision: 6, null: false
+    t.index %w[last first middle suffix handle], name: 'index_citation_name'
     t.index ['works_cited_citation_id'], name: 'index_works_cited_contributors_on_works_cited_citation_id'
   end