works_cited 0.1.11 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b6430ed9d0d1f18dc7bd27c9710815e90813925f19c88eebaf91e54509cef1f
-  data.tar.gz: 49fdafa4cb232c583ebe917ba1eb8bf33a007cf4cd66ef42734b91c0f03c0f34
+  metadata.gz: 033d5232ed69362edb7b0ab085c4c729375410926d86ede41585a409a82e83be
+  data.tar.gz: 54bb54fbfafa97b50e1485af06db35583ce20b8fa05bcc21738b73cd0a78cd36
 SHA512:
-  metadata.gz: 9c9ec53fc50ad5051abddc755a06c20260cf72b8534039699bbcb68e1a586f5d348dd54b0126a3a4e717fd0a31f9f09edafa5cdc943035cd7f56611737220918
-  data.tar.gz: 817041e6aff351dadc58f1ba2cc0b21a7b12e691e2b811268a5f17e1dee493b4fc6c555bb42e739a6274e27663ab079265f5cd3646defb1f552f3314ed804e1c
+  metadata.gz: d2d4d30e3e218374a33b2772117ecfa9b771eccb79f7e0e43a9d2b2e42b3fb2f5af47cd120de320852c9d757eb7bdd0f21c751520283f86c67e749c868d46ebe
+  data.tar.gz: 3cbab16a0fd3d123607e03a6b9dd5fd93938f1a5caa6bdbd34e77fd9b3f1a21411a393b7bb8581c4eedae271b4130596b9515e57893832bcc03781d38263307f

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 gem 'rails', '>= 6', '< 7'
 
 gem 'haml-rails', '>= 2.0', '< 3'
-gem 'sass-rails', '>= 6', '< 7'
+gem 'sass-rails', '>= 5', '< 7'
 
 gem 'cancancan', '>= 3.3', '< 4'
 
@@ -17,7 +17,7 @@ gem 'kaminari', '>= 1.2.1', '< 2'
 group :development, :test do
   gem 'database_cleaner', '>=1.8', '<2'
   gem 'devise', '>= 4.8', '< 5'
-  gem 'faker', '>=0'
+  gem 'faker', '>= 0.2.19', '< 1'
   gem 'sqlite3', '>= 1.4.2', '< 2'
 end
 
@@ -25,16 +25,16 @@ group :development do
   gem 'bundler', '>= 2', '< 3'
   gem 'factory_bot_rails', '>=5.1', '<6'
   gem 'juwelier', '~> 2.1.0'
-  gem 'rubocop', '>=0'
-  gem 'rubocop-rails', '>=0'
-  gem 'rubocop-rspec', '>=0'
+  gem 'rubocop', '>= 1.2.0', '<2'
+  gem 'rubocop-rails', '>=2.11.3', '<3'
+  gem 'rubocop-rspec', '>=2.4.0', '<3'
 end
 
 group :test do
   gem 'capybara', '>= 3.35', '< 4'
-  gem 'rspec-html-matchers', '>= 0'
+  gem 'rspec-html-matchers', '>= 0.9.4', '< 1'
   gem 'rspec-rails', '~> 5.0.0'
-  gem 'shoulda', '>= 0'
+  gem 'shoulda', '>= 4', '< 5'
   gem 'shoulda-matchers', '>=4.3', '<5'
-  gem 'simplecov', '>= 0'
+  gem 'simplecov', '>= 0.21.2', '< 1'
 end

data/Gemfile.lock

@@ -94,8 +94,7 @@ GEM
     factory_bot_rails (5.2.0)
       factory_bot (~> 5.2.0)
       railties (>= 4.2.0)
-    faker (2.19.0)
-      i18n (>= 1.6, < 2)
+    faker (0.3.1)
     faraday (1.7.1)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -342,21 +341,21 @@ DEPENDENCIES
   database_cleaner (>= 1.8, < 2)
   devise (>= 4.8, < 5)
   factory_bot_rails (>= 5.1, < 6)
-  faker
+  faker (>= 0.2.19, < 1)
   haml-rails (>= 2.0, < 3)
   juwelier (~> 2.1.0)
   kaminari (>= 1.2.1, < 2)
   rails (>= 6, < 7)
-  rspec-html-matchers
+  rspec-html-matchers (>= 0.9.4, < 1)
   rspec-rails (~> 5.0.0)
-  rubocop
-  rubocop-rails
-  rubocop-rspec
-  sass-rails (>= 6, < 7)
-  shoulda
+  rubocop (>= 1.2.0, < 2)
+  rubocop-rails (>= 2.11.3, < 3)
+  rubocop-rspec (>= 2.4.0, < 3)
+  sass-rails (>= 5, < 7)
+  shoulda (>= 4, < 5)
   shoulda-matchers (>= 4.3, < 5)
   simple_form (>= 5.1, < 6)
-  simplecov
+  simplecov (>= 0.21.2, < 1)
   sqlite3 (>= 1.4.2, < 2)
   vanilla_nested (>= 1.3, < 2)
 

data/README.md

@@ -3,8 +3,6 @@ Works Cited allows you to add a list of the works cited in ActiveRecord objects,
 
 Works Cited uses CanCanCan to authorize the editing of citations. This makes it easy for you to control access.
 
-Works Cited is compatible with, but does not require, Rails Admin.
-
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -85,6 +83,33 @@ Add the helpers to the relevant views
 = works_cited_list @record
 ```
 
+To add routes so that you can edit citations on their own pages:
+
+```ruby
+  mount WorksCited::Engine => '/works_cited'
+```
+
+To add the fields, nested inside your forms
+
+```haml
+= form_for(@doodad) do |f|
+  = works_cited_citations_fields f
+```
+
+Don't forget to add the controller concern to enable nested attributes with strong parameters
+
+```ruby
+class RecipesController < ApplicationController
+  include Cookbook::Params
+
+  #...
+    
+  def recipe_params
+    params.require(:doodad).permit(:name, :description, works_cited_params)
+  end
+end
+```
+
 ## Contributing
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.

data/VERSION

@@ -1 +1 @@
-0.1.11
+0.1.16

data/app/assets/javascripts/works_cited/addFields.js

@@ -0,0 +1,44 @@
+class addFields {
+  // This executes when the function is instantiated.
+  constructor() {
+    this.links = document.querySelectorAll('.add_fields')
+    this.iterateLinks()
+    const event = new Event('works_cited:load')
+    window.dispatchEvent(event);
+  }
+
+  iterateLinks() {
+    // If there are no links on the page, stop the function from executing.
+    if (this.links.length === 0) return
+    // Loop over each link on the page. A page could have multiple nested forms.
+    this.links.forEach(link => {
+      link.addEventListener('click', e => {
+        this.handleClick(link, e)
+      })
+    })
+  }
+
+  handleClick(link, e) {
+    // Stop the function from executing if a link or event were not passed into the function.
+    if (!link || !e) return
+    // Prevent the browser from following the URL.
+    e.preventDefault()
+    // Save a unique timestamp to ensure the key of the associated array is unique.
+    let time = new Date().getTime()
+    // Save the data id attribute into a variable. This corresponds to `new_object.object_id`.
+    let linkId = link.dataset.id
+    // Create a new regular expression needed to find any instance of the `new_object.object_id` used in the fields data attribute if there's a value in `linkId`.
+    let regexp = linkId ? new RegExp(linkId, 'g') : null
+    // Replace all instances of the `new_object.object_id` with `time`, and save markup into a variable if there's a value in `regexp`.
+    let newFields = regexp ? link.dataset.fields.replace(regexp, time) : null
+    // Add the new markup to the form if there are fields to add.
+    newFields ? link.insertAdjacentHTML('beforebegin', newFields) : null
+    // Tell it new fields are there
+    const event = new Event('works_cited:add_fields')
+    window.dispatchEvent(event);
+  }
+}
+
+// Wait for turbolinks to load, otherwise `document.querySelectorAll()` won't work
+window.addEventListener('load', () => new addFields())
+window.addEventListener('works_cited:add_fields', () => new addFields())

data/app/assets/javascripts/works_cited/application.js

@@ -1 +1,6 @@
-//= require vanilla_nested
+//= require works_cited/shared.js
+//= require works_cited/addFields.js
+//= require works_cited/removeFields.js
+//= require works_cited/showFields.js
+//= require works_cited/loadPreview.js
+//= require works_cited/submitForm.js

data/app/assets/javascripts/works_cited/loadPreview.js

@@ -0,0 +1,45 @@
+function startPreview(url, id, citationLocator) {
+  var element = document.getElementById(id)
+  var fields = element.querySelectorAll('input, select');
+  var index = 0;
+
+  for (index = 0; index < fields.length; ++index) {
+    var textField = fields[index];
+    textField.addEventListener('change', (e) => loadPreview(url, citationLocator))
+  }
+  loadPreview(url, citationLocator)
+}
+
+function loadPreview(url, locator) {
+  // Build formData object.
+  var formData = new FormData(document.querySelector('form'))
+  var data = {}
+  data.citation = getFieldByLocator(formData, locator)
+  var authenticity_token = document.head.querySelector('meta[name="csrf-token"]').content
+  var preview = document.getElementById('preview')
+  var container = document.getElementById('preview-html')
+
+  fetch(url + '.json',
+    {
+      method: 'post',
+      headers: {
+        'X-Requested-With': 'XMLHttpRequest',
+        'X-CSRF-Token': authenticity_token,
+        'Content-type': 'application/json'
+      },
+      body: JSON.stringify(data),
+      credentials: 'same-origin'
+    })
+    .then(function(response) {
+      // When the page is loaded convert it to json
+      return response.json()
+    })
+    .then(function(json) {
+      // get the html value for it
+      return json.html
+    })
+    .then((html) => {
+      preview.style.display = 'block'
+      container.innerHTML = html
+    })
+}

data/app/assets/javascripts/works_cited/removeFields.js

@@ -0,0 +1,37 @@
+class removeFields {
+  // This executes when the function is instantiated.
+  constructor() {
+    this.iterateLinks()
+  }
+
+  iterateLinks() {
+    document.querySelectorAll('.remove_fields').forEach(link => {
+      link.addEventListener('click', e => {
+        this.handleClick(link, e)
+      })
+    })
+  }
+
+  handleClick(link, e) {
+    // Stop the function from executing if a link or event were not passed into the function.
+    if (!link || !e) return
+    // Prevent the browser from following the URL.
+    e.preventDefault()
+    // Find the parent wrapper for the set of nested fields.
+    let fieldParent = link.closest('.nested-fields')
+    // If there is a parent wrapper, find the hidden delete field.
+    let deleteField = fieldParent
+      ? fieldParent.querySelector('input[type="hidden"]')
+      : null
+    // If there is a delete field, update the value to `1` and hide the corresponding nested fields.
+    if (deleteField) {
+      deleteField.value = 1
+      fieldParent.style.display = 'none'
+    }
+  }
+}
+
+// Wait for turbolinks to load, otherwise `document.querySelectorAll()` won't work
+window.addEventListener('load', () => new removeFields())
+window.addEventListener('works_cited:load', () => new removeFields())
+window.addEventListener('works_cited:add_fields', () => new removeFields())

data/app/assets/javascripts/works_cited/shared.js

@@ -0,0 +1,59 @@
+function packInContainer(container, keyParts, value) {
+  var part = keyParts.shift()
+  var packed = value
+  if(keyParts.length > 0) {
+    var previous = container[part] || {}
+    packed = packInContainer(previous, keyParts, value)
+  }
+
+  return {...container, [part]: packed}
+}
+
+function getWritableField(key) {
+  var fields = document.getElementsByName(key)
+  var found
+
+  fields.forEach((field) => {
+    if(field.readonly === undefined || !field.readonly) {
+      if(field.value) {
+        found = field.value
+        return
+      }
+    }
+  })
+
+  return found || ''
+}
+
+function getFieldByLocator(data, locator) {
+  var regex = /^\[(.*)\]$/
+  var container = {}
+
+  // Display the key/value pairs
+  for(var pair of data.entries()) {
+    // We want to avoid using pair[1] even though it's there because some fields are readonly
+    var key = pair[0]
+    if(key.startsWith(locator)) {
+      var strippedKeyString = key.replace(locator, '').replace(regex, "$1")
+      var keyParts = strippedKeyString.split('][')
+      var value = getWritableField(key)
+      console.warn(strippedKeyString)
+      container = packInContainer(container, keyParts, value)
+    }
+  }
+
+  return container
+}
+
+function getFormDataPacked(data) {
+  var container = {}
+
+  // Display the key/value pairs
+  for(var pair of data.entries()) {
+    // We want to avoid using pair[1] even though it's there because some fields are readonly
+    var key = pair[0]
+    container[key] = getWritableField(key)
+  }
+
+  return container
+}

data/app/assets/javascripts/works_cited/showFields.js

@@ -0,0 +1,9 @@
+function showFields(citation_id, citation_type) {
+  citation = document.getElementById(`citation-${citation_id}`)
+  for (let element of citation.getElementsByClassName('fields')){
+    element.style.display='none'
+    element.readonly=true
+  }
+  console.warn(citation.getElementsByClassName(`fields-${citation_type}`)[0])
+  citation.getElementsByClassName(`fields-${citation_type}`)[0].style.display = 'block'
+}

data/app/assets/javascripts/works_cited/submitForm.js

@@ -0,0 +1,33 @@
+function post(path, params, method = 'post') {
+
+  // The rest of this code assumes you are not using a library.
+  // It can be made less verbose if you use one.
+  const form = document.createElement('form')
+  form.method = method
+  form.action = path
+
+  for (const key in params) {
+    if (params.hasOwnProperty(key)) {
+      const hiddenField = document.createElement('input')
+      hiddenField.type = 'hidden'
+      hiddenField.name = key
+      hiddenField.value = params[key]
+
+      form.appendChild(hiddenField)
+    }
+  }
+
+  document.body.appendChild(form)
+  form.submit()
+}
+
+function addFilterToSubmit() {
+  var form = document.querySelector('form')
+
+  form.onsubmit = function (e) {
+    e.preventDefault()
+    var formData = new FormData(form)
+    var revisedData = getFormDataPacked(formData)
+    return post(form.action, revisedData)
+  }
+}

data/app/controllers/concerns/works_cited/params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module WorksCited
+  # Concern to allow strong parameters when using accepts_nested_attributes_for to edit Cookbook Uses
+  module Params
+    extend ActiveSupport::Concern
+
+    included do
+      # rescue_from Pundit::NotAuthorizedError, with: :authorization_error
+      # include Pundit
+    end
+
+    def works_cited_params
+      {
+        works_cited_citations_attributes: [
+          :id, :citation_type, :title, :container_title, :publisher, :city, :edition, :volume,
+          :number, :series, :year, :record, :media, :url, :pages, :published_at, :online_database, :doi,
+          :accessed_at, :_destroy,
+          { works_cited_contributors_attributes: %i[id contributor_role first middle last suffix handle _destroy] }
+        ]
+      }
+    end
+  end
+end

data/app/controllers/works_cited/citations_controller.rb

@@ -16,11 +16,10 @@ module WorksCited
 
     # GET /citations/preview
     def preview
-      @citation = Citation.new(citation_params)
-      authorize! :preview, @citation
-
-      @contributors = contributors_from_params
-      render :preview, layout: false
+      authorize! :preview, Citation
+      locals = { citation: citation_for_preview, contributors: contributors_for_preview }
+      html = render_to_string('preview', formats: [:html], layout: false, locals: locals)
+      render json: { html: html }
     end
 
     # GET /citations/new
@@ -55,9 +54,15 @@ module WorksCited
 
     private
 
-    def contributors_from_params
+    def citation_for_preview
+      return Citation.new(preview_params) unless params[:id].present?
+
+      Citation.find(params[:id]).assign_attributes(preview_params)
+    end
+
+    def contributors_for_preview
       contributors_array = []
-      raw_contributors = citation_params[:works_cited_contributors_attributes]
+      raw_contributors = preview_params[:works_cited_contributors_attributes]
       raw_contributors&.each do |_index, contributor|
         destroy = contributor.delete(:_destroy)
         next if destroy == '1'
@@ -92,12 +97,8 @@ module WorksCited
 
     def model_option_group(items, model)
       model_name = model.model_name
-      OpenStruct.new(
-        {
-          record_type: model_name,
-          records: items.map { |item| item_option(item, model_name) }
-        }
-      )
+      records = items.map { |item| item_option(item, model_name) }
+      OpenStruct.new({ record_type: model_name, records: records })
     end
 
     def set_records
@@ -109,6 +110,18 @@ module WorksCited
       end.compact
     end
 
+    # Only allow a list of trusted parameters through.
+    def preview_params
+      json = JSON.parse(request.raw_post)
+      json_params = ActionController::Parameters.new(json)
+      json_params.require(:citation).permit(
+        :id, :citation_type, :title, :container_title, :publisher, :city, :edition, :volume,
+        :number, :series, :year, :record, :media, :url, :pages, :published_at, :online_database, :doi,
+        :accessed_at,
+        works_cited_contributors_attributes: %i[id contributor_role first middle last suffix handle _destroy]
+      )
+    end
+
     # Only allow a list of trusted parameters through.
     def citation_params
       params.require(:citation).permit(

data/app/helpers/works_cited/application_helper.rb

@@ -18,11 +18,15 @@ module WorksCited
       render path, citation: citation, contributors: contributors
     end
 
-    def works_cited_citation_fields(form, citation_type)
+    def works_cited_type_fields(form, citation_type)
       path = partial_path_or_default('fields', citation_type)
       render path, f: form, citation_type: citation_type
     end
 
+    def works_cited_citations_fields(form)
+      render 'works_cited/citations/fields', form: form
+    end
+
     def list_names(names)
       first = first_contributor(names)
       first_contributor_name = first&.full_name(first.name_order)
@@ -36,6 +40,47 @@ module WorksCited
       end
     end
 
+    # This method creates a link with `data-id` `data-fields` attributes. These attributes are
+    # used to create new instances of the nested fields through Javascript.
+    def works_cited_link_to_add_fields(name, form, association, partial = nil)
+      # Takes an object (@person) and creates a new instance of its associated model (:addresses)
+      # To better understand, run the following in your terminal:
+      # rails c --sandbox
+      # @person = Person.new
+      # new_object = @person.send(:addresses).klass.new
+      new_object = form.object.send(association).klass.new
+
+      # Saves the unique ID of the object into a variable.
+      # This is needed to ensure the key of the associated array is unique. This is makes
+      # parsing the content in the `data-fields` attribute easier through Javascript.
+      # We could use another method to achive this.
+      id = new_object.object_id
+
+      # https://api.rubyonrails.org/ fields_for(record_name, record_object = nil, fields_options = {}, &block)
+      # record_name = :addresses
+      # record_object = new_object
+      # fields_options = { child_index: id }
+      # child_index` is used to ensure the key of the associated array is unique, and that it
+      # matched the value in the `data-id` attribute.
+      # `person[addresses_attributes][child_index_value][_destroy]`
+      fields = form.simple_fields_for(association, new_object, child_index: id) do |builder|
+        # `association.to_s.singularize + "_fields"` ends up evaluating to `address_fields`
+        # The render function will then look for `views/people/_address_fields.html.erb`
+        # The render function also needs to be passed the value of 'builder', because
+        # `views/people/_address_fields.html.erb` needs this to render the form tags.
+        partial ||= "#{association.to_s.singularize}_fields"
+        render(partial, record: new_object, f: builder)
+      end
+
+      # This renders a simple link, but passes information into `data` attributes.
+      # This info can be named anything we want, but in this case we chose `data-id:` and `data-fields:`.
+      # The `id:` is from `new_object.object_id`.
+      # The `fields:` are rendered from the `fields` blocks.
+      # We use `gsub("\n", "")` to remove anywhite space from the rendered partial.
+      # The `id:` value needs to match the value used in `child_index: id`.
+      link_to(name, '#', class: 'add_fields button button-action', data: { id: id, fields: fields.gsub("\n", '') })
+    end
+
     private
 
     def partial_path_or_default(purpose, citation_type)

data/app/models/works_cited/citation.rb

@@ -17,16 +17,24 @@ module WorksCited
 
     # Relationships
     belongs_to :record, polymorphic: true
-    has_many :works_cited_contributors, -> { order(:last, :first, :middle, :suffix, :handle) }, inverse_of: :works_cited_citation, class_name: 'WorksCited::Contributor',
-             foreign_key: :works_cited_citation_id
-    has_many :works_cited_authors, -> { authors.order(:last, :first, :middle, :suffix, :handle) }, inverse_of: :works_cited_citation, class_name: 'WorksCited::Contributor',
-             foreign_key: :works_cited_citation_id
-    accepts_nested_attributes_for :works_cited_contributors, allow_destroy: true
+    has_many :works_cited_contributors, lambda {
+                                          order(:last, :first, :middle, :suffix, :handle)
+                                        }, inverse_of: :works_cited_citation, class_name: 'WorksCited::Contributor',
+                                           foreign_key: :works_cited_citation_id, dependent: :destroy
+    has_many :works_cited_authors, lambda {
+                                     authors.order(:last, :first, :middle, :suffix, :handle)
+                                   }, inverse_of: :works_cited_citation, class_name: 'WorksCited::Contributor',
+                                      foreign_key: :works_cited_citation_id
+    accepts_nested_attributes_for :works_cited_contributors, reject_if: :all_blank, allow_destroy: true
 
     # Scopes
     scope :ordered_by_author, (lambda do
       joins(:works_cited_authors)
-        .order('MIN(works_cited_contributors.last) ASC')
+        .order('MIN(works_cited_contributors.last) ASC, '\
+               'MIN(works_cited_contributors.first) ASC, '\
+               'MIN(works_cited_contributors.middle) ASC, '\
+               'MIN(works_cited_contributors.suffix) ASC, '\
+               'MIN(works_cited_contributors.handle) ASC')
         .group(:id)
     end)
 
@@ -40,17 +48,31 @@ module WorksCited
     end
 
     # Instance Methods
+    def works_cited_contributors_attributes=(raw_contributors)
+      array = []
+      raw_contributors&.each do |_index, contributor|
+        destroy = contributor.delete(:_destroy)
+        if destroy == '1'
+          Contributor.find(contributor[:id]).destroy if contributor[:id]
+          next
+        end
+
+        array << contributor
+      end
+      super array
+    end
+
     def record=(value)
       unless value.is_a? String
         super(value)
         return
       end
 
-      model_name, id = value.split(':')
-      return unless model_name.present? && id.present?
+      model_name, my_id = value.split(':')
+      return unless model_name.present? && my_id.present?
 
       model = model_name.constantize
-      super model.find(id)
+      super model.find(my_id)
     end
 
     def periodical?
@@ -72,27 +94,5 @@ module WorksCited
     def email?
       citation_type == 'email'
     end
-
-    if defined?(RailsAdmin)
-      rails_admin do
-        visible false
-        edit do
-          field :citation_type, :enum do
-            enum do
-              WorksCited.configuration.valid_citation_types
-            end
-          end
-          field :works_cited_contributors do
-            label 'Contributors'
-          end
-          include_all_fields
-          field :media
-          field :record do
-            # Can't remove this using :inverse_of because it's polymorphic
-            visible false
-          end
-        end
-      end
-    end
   end
 end