spina-admin-journal 0.5.0 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c43ca7425af717514efb0bc6a142651eae11fd79446019ab19b87bb8c952f497
-  data.tar.gz: 3af013de932268d05fb32013c7d1f09a89166eedd43276ce73c1756819cdea75
+  metadata.gz: 6e696fd8633a8dc7ab2b57166808c7e989792307f0d3481a0eb5e73b0d05d175
+  data.tar.gz: bb15a7e5c115a2302e95f3224d85840dcfc6f46d8ec88b1c18bd67b4d0ba02b6
 SHA512:
-  metadata.gz: d792437f01a6474b290daa7deaea9232eb78892a77e08c877abbab9ce97221785c653eca15062b2656a70e155b74ad3ed77aae3e2a3260306c153bfb9c4401fc
-  data.tar.gz: 1ef7f100bd6d37727916951f588d4fcad17d4c896e3fab8c136f2ac663b0290afb3293adc3c6c1cb2d1e99f463363a4c352879a09d53df624e31403d1120a111
+  metadata.gz: 0e1f1e24116d3955595ef1fc705f4e93a25028daeaac15b42a147d4cadeec0b2bb5c6176d4d9c98dbb104f66dd325a006a156eea6d8afab270cb096cb386772f
+  data.tar.gz: d6541162de0b4e925c3c6dda25ac08d4e5292c6f3b2c8ac4306f933000aee56dfbc8cbcd2ee0704a0499a5a512e1179d429b47cbe8a17ea205a47324eaf2c382

data/app/assets/config/spina_admin_journal_manifest.js

@@ -1,3 +1,6 @@
-//= link spina/admin/journal/application.js
 //= link spina/admin/journal/application.css
-//= link spina_manifest.js
+
+//= link_directory ../javascripts/spina/admin/journal/controllers
+//= link_directory ../javascripts/spina/admin/journal/libraries
+
+//= link spina/admin/journal/application.js

data/app/components/spina/admin/journal/affiliations_list_component.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A list of licences. Not sortable.
+      class AffiliationsListComponent < ListComponent
+        def initialize(affiliations:)
+          @affiliations = affiliations
+        end
+
+        def before_render
+          @list_items = generate_list_items(@affiliations)
+        end
+
+        def call
+          render ListComponent.new(list_items: @list_items, sortable: false)
+        end
+
+        private
+
+        def generate_list_items(affiliations)
+          affiliations.map do |affiliation|
+            { id: affiliation.id,
+              label: affiliation.reversed_name,
+              path: helpers.spina.edit_admin_journal_author_path(affiliation.author) }
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/application_component.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Base class for components.
+      class ApplicationComponent < Spina::ApplicationComponent
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/articles_list_component.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A list of articles. Articles should only be sortable if presented within the contex of an
+      # issue.
+      class ArticlesListComponent < ListComponent
+        attr_reader :sortable
+
+        def initialize(articles:, sortable: false)
+          @articles = articles
+          @sortable = sortable
+        end
+
+        def before_render
+          @list_items = generate_list_items(@articles)
+        end
+
+        def call
+          render ListComponent.new(list_items: @list_items,
+                                   sortable: sortable?,
+                                   sort_path: generate_sort_path)
+        end
+
+        def sortable?
+          sortable
+        end
+
+        private
+
+        def generate_list_items(articles)
+          articles.map do |article|
+            { id: article.id,
+              label: generate_label(article),
+              path: helpers.spina.edit_admin_journal_article_path(article.id) }
+          end
+        end
+
+        def generate_label(article) # rubocop:disable Metrics/AbcSize
+          t('spina.admin.journal.articles.article_number', volume_number: article.issue.volume.number, # rubocop:disable Style/StringConcatenation
+                                                           issue_number: article.issue.number,
+                                                           article_number: article.number
+          ) + ' | ' + t('spina.admin.journal.articles.title_author', title: article.title, # rubocop:disable Layout/MultilineMethodCallBraceLayout Layout/SpaceInsideParens
+                                                                     author: article.authorships.sorted_within_article.map { |authorship| authorship.affiliation.surname }.join(', ')) # rubocop:disable Layout/LineLength
+        end
+
+        def generate_sort_path
+          @articles.any? ? helpers.spina.sort_admin_journal_issues_path(@articles.first.issue.id) : ''
+        end
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/authors_list_component.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A list of authors. Not sortable.
+      class AuthorsListComponent < ListComponent
+        def initialize(authors:)
+          @authors = authors
+        end
+
+        def before_render
+          @list_items = generate_list_items(@authors)
+        end
+
+        def call
+          render ListComponent.new(list_items: @list_items, sortable: false)
+        end
+
+        private
+
+        def generate_list_items(authors)
+          authors.map do |author|
+            { id: author.id,
+              label: generate_label(author),
+              path: helpers.spina.edit_admin_journal_author_path(author) }
+          end
+        end
+
+        def generate_label(author)
+          t 'spina.admin.journal.authors.name_institution', name: author.primary_affiliation.name,
+                                                            institution: author.primary_affiliation.institution.name
+        end
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/authorships_list_component.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A list of authorships. Sortable when displayed in their corresponding article.
+      class AuthorshipsListComponent < ListComponent
+        attr_reader :sortable
+
+        def initialize(authorships:, sortable: false)
+          @authorships = authorships
+          @sortable = sortable
+        end
+
+        def before_render
+          @list_items = generate_list_items(@authorships)
+        end
+
+        def call
+          render ListComponent.new(list_items: @list_items,
+                                   sortable: sortable?,
+                                   sort_path: generate_sort_path)
+        end
+
+        def sortable?
+          sortable
+        end
+
+        private
+
+        def generate_list_items(authorships)
+          authorships.map do |authorship|
+            { id: authorship.id,
+              label: authorship.affiliation.reversed_name,
+              path: helpers.spina.edit_admin_journal_author_path(authorship.affiliation.author) }
+          end
+        end
+
+        def generate_sort_path
+          @authorships.any? ? helpers.spina.sort_admin_journal_authors_path(@authorships.first.article.id) : ''
+        end
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/empty_list_component.html.haml

@@ -0,0 +1 @@
+= @message

data/app/components/spina/admin/journal/empty_list_component.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Displays a message indicating that a {ListComponent} has no items.
+      class EmptyListComponent < ApplicationComponent
+        def initialize(message: t('spina.admin.journal.empty_list'))
+          @message = message
+        end
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/institutions_list_component.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A list of institutions. Not sortable.
+      class InstitutionsListComponent < ListComponent
+        def initialize(institutions:)
+          @institutions = institutions
+        end
+
+        def before_render
+          @list_items = generate_list_items(@institutions)
+        end
+
+        def call
+          render ListComponent.new(list_items: @list_items, sortable: false)
+        end
+
+        private
+
+        def generate_list_items(institutions)
+          institutions.map do |institution|
+            { id: institution.id,
+              label: institution.name,
+              path: helpers.spina.edit_admin_journal_institution_path(institution.id) }
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/issues_list_component.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A list of issues. Issues should only be sortable if presented within the contex of a
+      # volume.
+      class IssuesListComponent < ListComponent
+        attr_reader :sortable
+
+        def initialize(issues:, sortable: false)
+          @issues = issues
+          @sortable = sortable
+        end
+
+        def before_render
+          @list_items = generate_list_items(@issues)
+        end
+
+        def call
+          render ListComponent.new(list_items: @list_items,
+                                   sortable: sortable?,
+                                   sort_path: generate_sort_path)
+        end
+
+        def sortable?
+          sortable
+        end
+
+        private
+
+        def generate_list_items(issues)
+          issues.map do |issue|
+            { id: issue.id,
+              label: t('spina.admin.journal.issues.volume_issue', volume_number: issue.volume.number,
+                                                                  issue_number: issue.number),
+              path: helpers.spina.edit_admin_journal_issue_path(issue.id) }
+          end
+        end
+
+        def generate_sort_path
+          @issues.any? ? helpers.spina.sort_admin_journal_issues_path(@issues.first.volume.id) : ''
+        end
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/licences_list_component.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A list of licences. Not sortable.
+      class LicencesListComponent < ListComponent
+        def initialize(licences:)
+          @licences = licences
+        end
+
+        def before_render
+          @list_items = generate_list_items(@licences)
+        end
+
+        def call
+          render ListComponent.new(list_items: @list_items, sortable: false)
+        end
+
+        private
+
+        def generate_list_items(licences)
+          licences.map do |licence|
+            { id: licence.id,
+              label: licence.name,
+              path: helpers.spina.edit_admin_journal_licence_path(licence) }
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/list_component.html.haml

@@ -0,0 +1,10 @@
+- if sortable?
+  .ml-8.mt-8.text-gray-600.text-sm= t 'spina.admin.journal.sort_info'
+.my-6.md:m-8.bg-white.md:rounded-lg.border-l-0.border-r-0.border.md:border-r.md:border-l.border-gray-200.border-b-0.shadow-sm{ data: { controller: 'sortable' } }
+  = form_with(url: @sort_path, data: { sortable_target: 'form' }) { |f| }
+  %ul{ data: { sortable_target: 'list' } }
+    - if @list_items.any?
+      - @list_items.each do |item|
+        = render Spina::Admin::Journal::ListItemComponent.new(id: item[:id], label: item[:label], path: item[:path], sortable: sortable?)
+    - else
+      = render Spina::Admin::Journal::EmptyListComponent.new

data/app/components/spina/admin/journal/list_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A generic implementation of a list, resembling Spina's page list.
+      class ListComponent < ApplicationComponent
+        attr_reader :sortable
+
+        def initialize(list_items:, sortable: false, sort_path: '')
+          @sortable = sortable
+          @list_items = list_items
+          @sort_path = sort_path
+        end
+
+        def sortable?
+          sortable
+        end
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/list_item_component.html.haml

@@ -0,0 +1,17 @@
+%li{data: { id: @id }}
+  .flex.items-center.border-gray-200.border-b.bg-opacity-50.w-full
+    - if sortable?
+      .p-4.text-gray-300.hover:text-gray-600.cursor-move{ data: { 'sortable-handle': true } }
+        = helpers.heroicon('menu-alt-4', style: :solid, class: 'w-4 h-4 -mr-4')
+
+    .flex-auto
+      .block.text-spina.font-medium.text-sm.p-4{class: 'hover:text-spina-dark' }
+        = link_to @path do
+          = @label
+
+    .flex-1
+
+    = link_to @path, class: 'btn btn-link mr-4' do
+      .flex.flex-nowrap.items-center.px-8.py-1
+        = helpers.heroicon 'pencil-alt', style: :outline, class: 'w-4 h-4'
+        .ml-2= t 'spina.admin.journal.edit'

data/app/components/spina/admin/journal/list_item_component.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A generic list item that is only intended to be called by {ListItemComponent}.
+      class ListItemComponent < ApplicationComponent
+        attr_reader :sortable
+
+        def initialize(id:, label:, path:, sortable: false)
+          @label = label
+          @id = id
+          @path = path
+          @sortable = sortable
+        end
+
+        def sortable?
+          sortable
+        end
+      end
+    end
+  end
+end

data/app/components/spina/admin/journal/volumes_list_component.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # A sortable list of volumes.
+      class VolumesListComponent < ListComponent
+        def initialize(volumes:)
+          @volumes = volumes
+        end
+
+        def before_render
+          @list_items = generate_list_items(@volumes)
+        end
+
+        def call
+          render ListComponent.new(list_items: @list_items,
+                                   sortable: true,
+                                   sort_path: helpers.spina.sort_admin_journal_volumes_path(Journal.instance.id))
+        end
+
+        private
+
+        def generate_list_items(volumes)
+          volumes.map do |volume|
+            { id: volume.id,
+              label: t('spina.admin.journal.volumes.volume_number', number: volume.number),
+              path: helpers.spina.edit_admin_journal_volume_path(volume.id) }
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spina/admin/journal/application_controller.rb

@@ -5,9 +5,11 @@ module Spina
     module Journal
       # Custom controller for journal plugin. Sets the layout and adds a flash type.
       class ApplicationController < AdminController
+        helper ::Spina::Engine.routes.url_helpers
+
         add_flash_types :success
 
-        layout :admin_layout, only: %i[new edit]
+        layout :admin_layout
 
         before_action :set_locale
 

data/app/controllers/spina/admin/journal/articles_controller.rb

@@ -7,6 +7,7 @@ module Spina
       class ArticlesController < ApplicationController
         PARTS_PARAMS = [
           :name, :title, :type, :content, :filename, :signed_blob_id, :alt, :attachment_id, :image_id,
+          :first_page, :last_page,
           { images_attributes: %i[filename signed_blob_id image_id alt],
             content_attributes: [
               :name, :title,
@@ -20,7 +21,7 @@ module Spina
           params.merge("#{locale}_content_attributes": [*PARTS_PARAMS])
         end
         PARAMS = [:issue_id, :licence_id, :title, :url, :doi, :status, { affiliation_ids: [], **CONTENT_PARAMS }].freeze
-        PARTS = %w[abstract attachment].freeze
+        PARTS = %w[abstract attachment page_range].freeze
 
         before_action :set_breadcrumb
         before_action :set_tabs, except: %i[index destroy sort]
@@ -40,23 +41,25 @@ module Spina
 
         def edit; end
 
-        def create
+        def create # rubocop:disable Metrics/AbcSize
           @article = Article.new(article_params)
           sister_articles = Article.where(issue: @article.issue_id)
           @article.number = sister_articles.any? ? sister_articles.sorted_desc.first.number + 1 : 1
 
           if @article.save
-            redirect_to admin_journal_articles_path, success: t('.saved')
+            redirect_to edit_admin_journal_article_path(@article), success: t('.saved')
           else
-            render :new
+            flash.now[:alert] = t('.failed')
+            render :new, status: :unprocessable_entity
           end
         end
 
         def update
           if @article.update(article_params)
-            redirect_to admin_journal_articles_path, success: t('.saved')
+            redirect_to edit_admin_journal_article_path(@article), success: t('.saved')
           else
-            render :edit
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 
@@ -70,31 +73,17 @@ module Spina
         end
 
         def sort
-          ActiveRecord::Base.transaction do
-            sort_params.each do |id, new_pos|
-              Article.find(id.to_i).update_attribute(:number, new_pos.to_i) # rubocop:disable Rails/SkipsModelValidations
-            end
-            validate_sort_order
+          params[:ids].each.with_index do |id, index|
+            Article.where(id: id).update_all(number: index + 1) # rubocop:disable Rails/SkipsModelValidations
           end
-          render json: { success: true, message: t('.sort_success') }
-        rescue ActiveRecord::RecordInvalid
-          render json: { success: false, message: t('.sort_error') }
+          flash.now[:info] = t('spina.pages.sorting_saved')
+          render_flash
         end
 
         private
 
         def article_params
-          params.require(:admin_journal_article).permit(PARAMS)
-        end
-
-        def sort_params
-          params.require(:admin_journal_articles).require(:list).permit!
-        end
-
-        def validate_sort_order
-          Article.where(issue_id: params[:issue_id]).each do |article|
-            raise ActiveRecord::RecordInvalid if article.invalid?
-          end
+          params.require(:article).permit(PARAMS)
         end
 
         def set_breadcrumb

data/app/controllers/spina/admin/journal/authors_controller.rb

@@ -16,6 +16,7 @@ module Spina
         def new
           @author = Author.new
           @author.affiliations << Affiliation.new(status: :primary)
+          add_breadcrumb t('.new')
         end
 
         def edit; end
@@ -23,17 +24,19 @@ module Spina
         def create
           @author = Author.new(modified_params)
           if @author.save
-            redirect_to admin_journal_authors_path, success: t('.saved')
+            redirect_to edit_admin_journal_author_path(@author), success: t('.saved')
           else
-            render :new
+            flash.now[:alert] = t('.failed')
+            render :new, status: :unprocessable_entity
           end
         end
 
         def update
           if @author.update(modified_params)
-            redirect_to admin_journal_authors_path, success: t('.saved')
+            redirect_to edit_admin_journal_author_path(@author), success: t('.saved')
           else
-            render :edit
+            flash.now[:alert] = t('.failed')
+            render :edit, status: :unprocessable_entity
           end
         end
 
@@ -47,29 +50,23 @@ module Spina
         end
 
         def sort
-          ActiveRecord::Base.transaction do
-            sort_params.each do |id, new_pos|
-              # ignore uniqueness validation for now
-              Authorship.find(id.to_i).update_attribute(:position, new_pos.to_i) # rubocop:disable Rails/SkipsModelValidations
-            end
-            # do validations after reordering is complete
-            validate_sort_order
+          params[:ids].each.with_index do |id, index|
+            Authorship.where(id: id).update_all(position: index + 1) # rubocop:disable Rails/SkipsModelValidations
           end
-          render json: { success: true, message: t('.sort_success') }
-        rescue ActiveRecord::RecordInvalid
-          render json: { success: false, message: t('.sort_error') }
+          flash.now[:info] = t('spina.pages.sorting_saved')
+          render_flash
         end
 
         private
 
         def author_params
-          params.require(:admin_journal_author).permit(:primary_affiliation_index,
-                                                       affiliations_attributes: %i[id institution_id first_name
-                                                                                   surname])
+          params.require(:author).permit(:primary_affiliation_index,
+                                         affiliations_attributes: %i[id institution_id first_name
+                                                                     surname])
         end
 
         def modified_params
-          primary_affiliation_index = params[:admin_journal_author][:primary_affiliation_index]
+          primary_affiliation_index = params[:author][:primary_affiliation_index]
           new_params = author_params.except :primary_affiliation_index
           unless new_params[:affiliations_attributes].nil? || primary_affiliation_index.nil?
             new_params[:affiliations_attributes].each_key do |index|
@@ -79,10 +76,6 @@ module Spina
           new_params
         end
 
-        def sort_params
-          params.require(:admin_journal_authorships).require(:list).permit!
-        end
-
         def set_breadcrumb
           add_breadcrumb Author.model_name.human(count: :many), admin_journal_authors_path
         end
@@ -95,12 +88,6 @@ module Spina
           @author = Author.find(params[:id])
           add_breadcrumb @author.primary_affiliation.name
         end
-
-        def validate_sort_order
-          Authorship.where(article_id: params[:article_id]).each do |authorship|
-            raise ActiveRecord::RecordInvalid if authorship.invalid?
-          end
-        end
       end
     end
   end