spina-admin-journal 0.6.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afadf6fe1f99997005bc61d4c3d31b6a1fd02ea35e400539a6e3f3806010910a
-  data.tar.gz: 7a4375228d01fa343613e8978860ff64c4ba8b1d3232d439efc71e150cab6d93
+  metadata.gz: 6a0055e328c3ad9ed3d723edb02c58062caf6621d4dd0a286021930957f42dd1
+  data.tar.gz: 303734e1e4dc5d2c90b45e24d2399872ada559e50ed60571316d35a48fbbd363
 SHA512:
-  metadata.gz: 63d5deaf2bc734aafefcbd7ddb814f1593ab18ea6a3653beeadfede9ddb386579107f87147a78d036d9e95e5f1fd868f088a03352de57652b9a30afcc3a2fa58
-  data.tar.gz: ad6606f902897fc5ffa29d00241c89c1c4cb68a666313e53bc21227e357dd06e760a9d7e011c7f6e1870b6f872327f4052ceacc77c63fbd5745d8ba10bda1800
+  metadata.gz: 8efcbe772ec874d7c1c5359b2ae00b62a9fba78af47a270371d3120f2845e11df8c808c3d7d3928ac97682dabb8d6cd5f365dbac94e4989c5da49f825e0c0a86
+  data.tar.gz: 0b2012a0505383c60e5fbd92c1c4718f76258032a7d428c0a6292f75dc9d87710fe43cf54ee1cb68fcf0164a8c1592df511174a2102cfb429ff1251ce6d1334d

data/README.md

@@ -1,5 +1,9 @@
 # Spina::Admin::Journal
 
+*Journal* is a plugin for [Spina](https://www.spinacms.com/) that provides a fully-fledged journal management package, intended to provide a more streamlined, easy-to-use, modern alternative to [OJS](https://pkp.sfu.ca/ojs/).
+
+Spina is a content management system built in [Ruby on Rails](http://rubyonrails.org/). *Journal* augments Spina by providing an admin interface for managing an academic journal.
+
 ![Rails tests](https://github.com/louis-vs/spina-admin-journal/workflows/Verify/badge.svg?branch=master&event=push)
 [![codecov](https://codecov.io/gh/louis-vs/spina-admin-journal/branch/master/graph/badge.svg?token=9TZ9QGGLAH)](https://codecov.io/gh/louis-vs/spina-admin-journal)
 [![CodeFactor](https://www.codefactor.io/repository/github/louis-vs/spina-admin-journal/badge)](https://www.codefactor.io/repository/github/louis-vs/spina-admin-journal)
@@ -7,69 +11,48 @@
 [![Code quality: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/louis-vs/spina-admin-journal.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/louis-vs/spina-admin-journal/context:javascript)
 [![Inline docs](http://inch-ci.org/github/louis-vs/spina-admin-journal.svg?branch=master)](http://inch-ci.org/github/louis-vs/spina-admin-journal)
 
-*Journal* is a plugin for [Spina](https://www.spinacms.com/), a content management system built in [Ruby on Rails](http://rubyonrails.org/). *Journal* augments Spina by providing an admin interface for managing an academic journal.
-
-## Usage
-
-The plugin adds two menus to Spina's primary navigation:
-
-* **Journal settings** provides access to global properties of the journal. It is divided into 3 submenus:
-  * **Journal** allows you to change the name of the journal.
-  * **Institutions** allows you to add institutions, to which authors can be affiliated.
-  * **Authors** allows you to add authors, who can then be added to articles.
-* The **journal content** menu will be named after the journal as specified in Journal Settings. It provides a means of editing the content of the journal and is divided into three submenus:
-  * **Volumes** allows you to add and remove volumes of the journal, and edit their respective issues.
-  * **Issues** allows you to add, edit and remove issues of particular volumes of the journal, and edit their respective articles.
-  * **Articles** allows you to add, edit and remove articles belonging to particular issues.
+## Features
 
-The plugin does not provide any public-facing frontend. However, an example implementation can be found at **[TBC]**.
+The journal plugin covers many of the needs of a professional online journal publication, including:
 
-**NB this plugin is currently a work in progress**: please wait until an official release to use this plugin in production.
+- Simple, responsive, intuitive interface that builds upon Spina's own.
+- Seamlessly integrate published content with other information about the journal.
+- Manage volumes, issues, articles and authors in a highly structured and organised manner.
+- Keep track of individual authors with multiple affiliations, e.g. if they change name or institution, connecting with [ORCID](https://orcid.org/).
 
-## Installation
-
-### From scratch
-
-Make sure you have a working installation of Ruby on Rails 6.1. You can find a setup guide [here](https://guides.rubyonrails.org/getting_started.html).
-
-Then run:
-
-```bash
-$ rails new your-app --database=postgresql
-$ cd your-app
-$ bin/rails db:create
-$ bin/rails active_storage:install
-```
+Currently, a submissions management system is not included, but this is planned for a future release. This will allow you to manage the submissions process for the journal in a streamlined manner in parallel to publication.
 
-Add this line to your new application's Gemfile:
+## Usage
 
-```ruby
-gem 'spina', '~> 2.0'
-```
+The plugin adds two menus to Spina's primary navigation:
 
-And then execute:
+- **Journal settings** provides access to global properties of the journal. It is divided into 3 submenus:
+  - **Journal** allows you to change metadata such as the name of the journal, as well as content that will appear on the journal homepage.
+  - **Institutions** allows you to add institutions, to which authors can be affiliated.
+  - **Authors** allows you to add authors and their affiliations, which can then be added to articles.
+  - **Licences** allows you to add licences and association information, which can be associated with individual articles, representing the licence under which the content is released.
+- The **journal content** menu will be named after the journal as specified in Journal Settings. It provides a means of editing the content of the journal and is divided into three submenus:
+  - **Volumes** allows you to add and remove volumes of the journal, and edit their respective issues.
+  - **Issues** allows you to add, edit and remove issues of particular volumes of the journal, and edit their respective articles.
+  - **Articles** allows you to add, edit and remove articles belonging to particular issues.
 
-```bash
-$ bundle install
-```
+**NB:** This release of the plugin does not provide any public-facing frontend or Spina theme. An example implementation can be found within the [Conferences Primer Theme](https://github.com/louis-vs/spina-conferences-primer_theme-fork). Note that this theme also contains frontends for two other Spina plugins, [Spina Conferences Blog](https://github.com/louis-vs/spina-admin-conferences-blog) and [Spina Admin Conferences](https://github.com/louis-vs/spina-admin-conferences-fork/). You can use the theme in your project as is, or copy whichever parts of the code you need.
 
-Run the Spina install generator:
+A dedicated journal theme, coupled with an automatic installer, is being planned. A system to manage submissions is also on the roadmap.
 
-```bash
-$ bin/rails g spina:install
-```
+## Installation
 
-And follow the prompts. Once this is complete, follow the instructions below.
+Make sure you have a working installation of Ruby on Rails 7. You can find a setup guide [here](https://guides.rubyonrails.org/getting_started.html).
 
-### For existing Spina installations
+You then need to install Spina, following the guide [on the Spina website](https://spinacms.com/docs).
 
-Add this line to your application's Gemfile:
+To install the plugin, add this line to your application's Gemfile:
 
 ```ruby
-gem 'spina-admin-journal', '~> 0.1'
+gem 'spina-admin-journal', '~> 1.0'
 ```
 
-And then execute:
+Then execute:
 
 ```bash
 $ bundle install
@@ -78,7 +61,7 @@ $ bundle install
 You'll then need to install and run the migrations for the journal:
 
 ```bash
-$ bin/rails spina_admin_journal_engine:install:migrations
+$ bin/rails spina_admin_journal:install:migrations
 $ bin/rails db:migrate
 ```
 
@@ -94,6 +77,11 @@ You can manually populate the database from within the app, or alternatively you
 
 Bug reports and feature requests are welcome in the [Issues](https://github.com/louis-vs/spina-admin-journal/issues) section. Translations are also very welcome!
 
+### Planned features
+
+- [ ] Submissions management
+- [ ] Translations
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/config/spina_admin_journal_manifest.js

@@ -1,3 +1,2 @@
-//= link spina/admin/journal/application.js
 //= link spina/admin/journal/application.css
-//= link spina_manifest.js
+//= 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/form_group_component.html.haml

@@ -0,0 +1,4 @@
+.mt-6
+  %label.block.text-sm.leading-5.font-medium.text-gray-700= label
+  .text-gray-400.text-sm= description
+  .mt-1= content

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Correctly styles label, description and content of form fields.
+      class FormGroupComponent < ApplicationComponent
+        attr_reader :label, :description
+
+        def initialize(label:, description: '')
+          @label = label
+          @description = description
+        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,11 @@
+.my-6.md:m-8
+  - if sortable?
+    .mb-4.text-gray-600.text-sm= t 'spina.admin.journal.sort_info'
+  .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

@@ -9,7 +9,7 @@ module Spina
 
         add_flash_types :success
 
-        layout :admin_layout, only: %i[new edit]
+        layout :admin_layout
 
         before_action :set_locale