spina-admin-journal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75a11c42a861742be9bee3d10d3a84f745f2d489b8a1ad61bf8e699f4f7fdc04
+  data.tar.gz: 343abc141c3af6b35492ec12a4c99325b116a3f63c5058fe7c61359cdfcd0da2
+SHA512:
+  metadata.gz: 8209f366bfdd31dee8b559a9ca0c3966f3383687560b87a20cda19fbb198eb8faa5929d07e1b97b773464ab950fb5d2c298b4e168a22afacec726c7bb7fee2a4
+  data.tar.gz: 7182be875c118c6c59322b6e5a3fd51d81d5d51700be8db549ae48438df05bbb2fd9c290219cdbcae3d28b5530e172e5891ceb1636954c7aa36410406f96573b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Louis Van Steene
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# Spina::Admin::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)
+[![LGTM alerts](https://img.shields.io/lgtm/alerts/g/louis-vs/spina-admin-journal.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/louis-vs/spina-admin-journal/alerts/)
+[![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.
+
+The plugin does not provide any public-facing frontend. However, an example implementation can be found at **[TBC]**.
+
+**NB this plugin is currently a work in progress**: please wait until an official release to use this plugin in production.
+
+## 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
+```
+
+Add this line to your new application's Gemfile:
+
+```ruby
+gem 'spina', '~> 2.0'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Run the Spina install generator:
+
+```bash
+$ bin/rails g spina:install
+```
+
+And follow the prompts. Once this is complete, follow the instructions below.
+
+### For existing Spina installations
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spina-admin-journal', '~> 0.1'
+```
+
+And then execute:
+
+```bash
+$ 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 db:migrate
+```
+
+You can then start a local server to test that everything's working.
+
+```bash
+$ bin/rails s
+```
+
+You can manually populate the database from within the app, or alternatively you can use seed data for testing. A sample `seeds.rb` file can be found [here](../master/test/dummy/db/seeds.rb).
+
+## Contributing
+
+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!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'yard'
+
+YARD::Rake::YardocTask.new(:yardoc) do |t|
+  t.files = ['lib/**/*.rb', 'app/**/*.rb']
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |t|
+  t.options << '--parallel' if ENV['CI']
+end
+
+task default: :test

data/app/assets/config/spina_admin_journal_manifest.js

@@ -0,0 +1,3 @@
+//= link spina/admin/journal/application.js
+//= link spina/admin/journal/application.css
+//= link spina_manifest.js

data/app/assets/javascripts/spina/admin/journal/application.es6

@@ -0,0 +1,72 @@
+//= require spina/admin/journal/html5sortable
+/* global sortable */
+
+$(document).on('turbolinks:load', () => {
+  // html5sortable configuration
+  sortable('.html5sortable', {
+    items: 'tr',
+    itemSerializer: (serializedItem) => {
+      return {
+        position: serializedItem.index + 1,
+        id: serializedItem.node.getAttribute('data-id')
+      };
+    },
+    containerSerializer: (serializedContainer) => {
+      return {
+        name: serializedContainer.node.getAttribute('data-sorted-collection')
+      };
+    }
+  });
+
+  // add sorting event listener if there is a sortable container on the page
+  if(typeof sortable('.html5sortable')[0] !== 'undefined') {
+    sortable('.html5sortable')[0].addEventListener('sortupdate', e => {
+      let container = e.detail.destination.container;
+      let serialized = sortable('.html5sortable', 'serialize')[0];
+      let data = serialized.items.reduce((map, obj) => {
+        map[`${serialized.container.name}[list[${obj.id}]]`] = obj.position;
+        return map;
+      }, {});
+
+      let displayError = (...args) => {
+        let message = 'An unknown error occured.'; // not translateable (but should never happen)
+        if(typeof args[0] === 'string') {
+          message = args[0];
+        }
+        // display error message
+        $('.sort-message').html('');
+        $('.sort-message').removeClass('animate-fadein success');
+        $('.sort-message').width(); // trigger reflow
+        $('.sort-message').html(message).addClass('error animate-fadein');
+        // TODO: return element to its origin
+        // this needs to be done manually, but may not really be necessary since the displayed
+        // numbers won't change
+      };
+
+      // send sort request
+      $.ajax({
+        url: $('.html5sortable').eq(0).data('sort-url'),
+        type: 'PATCH',
+        dataType: 'json',
+        data: data,
+        success: (data) => {
+          if(data.success) {
+            // display success message
+            $('.sort-message').html(''); // clear message
+            $('.sort-message').removeClass('animate-fadein error');
+            $('.sort-message').width(); // trigger reflow (for animation to work)
+            $('.sort-message').html(data.message).addClass('success animate-fadein');
+            // update displayed position number
+            // NB this is done entirely clientside, so there is the potential for desync
+            for(let i = 0; i < container.children.length; i++) {
+              container.children[i].getElementsByClassName('position-display')[0].innerHTML = (i+1).toString();
+            }
+          } else {
+            displayError(data.message);
+          }
+        },
+        error: displayError
+      });
+    });
+  }
+});

data/app/assets/stylesheets/spina/admin/journal/application.css

@@ -0,0 +1,27 @@
+/* Completely overkill animated message for successful sorting */
+.sort-message {
+  padding-top: 10px;
+}
+
+.sort-message.success {
+  color: green;
+}
+
+.sort-message.error {
+  color: red;
+}
+
+.animate-fadein {
+  animation-name: fadein;
+  animation-duration: 500ms;
+  animation-timing-function: ease-out;
+}
+
+@keyframes fadein {
+  from {
+    opacity: 0.1;
+  }
+  to {
+    opacity: 1;
+  }
+}

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Custom controller for journal plugin. Sets the layout and adds a flash type.
+      class ApplicationController < AdminController
+        add_flash_types :success
+
+        layout :admin_layout, only: %i[new edit]
+
+        before_action :set_locale
+
+        private
+
+        def admin_layout
+          'spina/admin/admin'
+        end
+
+        def set_locale
+          @locale = params[:locale] || I18n.default_locale
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Controller for {Article} records.
+      class ArticlesController < ApplicationController
+        PARTS_PARAMS = [
+          :name, :title, :type, :content, :filename, :signed_blob_id, :alt, :attachment_id, :image_id,
+          { images_attributes: %i[filename signed_blob_id image_id alt],
+            content_attributes: [
+              :name, :title,
+              { parts_attributes: [
+                :name, :title, :type, :content, :filename, :signed_blob_id, :alt, :attachment_id, :image_id,
+                { images_attributes: %i[filename signed_blob_id image_id alt] }
+              ] }
+            ] }
+        ].freeze
+        CONTENT_PARAMS = Spina.config.locales.inject({}) do |params, locale|
+          params.merge("#{locale}_content_attributes": [*PARTS_PARAMS])
+        end
+        PARAMS = [:issue_id, :title, :url, :doi, { affiliation_ids: [], **CONTENT_PARAMS }].freeze
+        PARTS = %w[abstract attachment].freeze
+
+        before_action :set_breadcrumb
+        before_action :set_tabs, except: %i[index destroy sort]
+        before_action :set_article, only: %i[edit update destroy]
+        before_action :set_parts_attributes, only: %i[new edit]
+        before_action :build_parts, only: %i[edit]
+
+        def index
+          @articles = Article.sorted_desc
+        end
+
+        def new
+          @article = Article.new
+          build_parts
+          add_breadcrumb t('.new')
+        end
+
+        def edit; end
+
+        def create
+          @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')
+          else
+            render :new
+          end
+        end
+
+        def update
+          if @article.update(article_params)
+            redirect_to admin_journal_articles_path, success: t('.saved')
+          else
+            render :edit
+          end
+        end
+
+        def destroy
+          @article.destroy
+          respond_to do |format|
+            format.html do
+              redirect_to admin_journal_articles_path, success: t('.deleted')
+            end
+          end
+        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
+          end
+          render json: { success: true, message: t('.sort_success') }
+        rescue ActiveRecord::RecordInvalid
+          render json: { success: false, message: t('.sort_error') }
+        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
+        end
+
+        def set_breadcrumb
+          add_breadcrumb Article.model_name.human(count: :many), admin_journal_articles_path
+        end
+
+        def set_tabs
+          @tabs = %w[details authors]
+        end
+
+        def set_article
+          @article = Article.find(params[:id])
+          add_breadcrumb @article.title
+        end
+
+        def set_parts_attributes
+          @parts_attributes = current_theme.parts.select { |part| PARTS.include? part[:name] }
+        end
+
+        def build_parts
+          return unless @parts_attributes.is_a? Array
+
+          @parts = @parts_attributes.collect { |part_attributes| @article.part(part_attributes) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Controller for {Author} records and their corresponding {Affiliation}s.
+      class AuthorsController < ApplicationController
+        before_action :set_breadcrumb
+        before_action :set_tabs, except: %i[index destroy]
+        before_action :set_author, only: %i[edit update destroy]
+
+        def index
+          @authors = Author.all
+        end
+
+        def new
+          @author = Author.new
+          @author.affiliations << Affiliation.new(status: :primary)
+        end
+
+        def edit; end
+
+        def create
+          @author = Author.new(modified_params)
+          if @author.save
+            redirect_to admin_journal_authors_path, success: t('.saved')
+          else
+            render :new
+          end
+        end
+
+        def update
+          if @author.update(modified_params)
+            redirect_to admin_journal_authors_path, success: t('.saved')
+          else
+            render :edit
+          end
+        end
+
+        def destroy
+          @author.destroy
+          respond_to do |format|
+            format.html do
+              redirect_to admin_journal_authors_path, success: t('.deleted')
+            end
+          end
+        end
+
+        private
+
+        def author_params
+          params.require(:admin_journal_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]
+          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|
+              new_params[:affiliations_attributes][index][:status] = index == primary_affiliation_index ? 'primary' : 'other' # rubocop:disable Layout/LineLength
+            end
+          end
+          new_params
+        end
+
+        def set_breadcrumb
+          add_breadcrumb Author.model_name.human(count: :many), admin_journal_authors_path
+        end
+
+        def set_tabs
+          @tabs = %w[details articles]
+        end
+
+        def set_author
+          @author = Author.find(params[:id])
+          add_breadcrumb @author.primary_affiliation.name
+        end
+      end
+    end
+  end
+end