spina-admin-journal 0.1.0

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Controller for {Institution} records
+      class InstitutionsController < ApplicationController
+        before_action :set_breadcrumb
+        before_action :set_tabs, except: %i[index destroy]
+        before_action :set_institution, only: %i[edit update destroy]
+
+        def index
+          @institutions = Institution.all
+        end
+
+        def new
+          @institution = Institution.new
+          add_breadcrumb t('.new')
+        end
+
+        def edit; end
+
+        def create
+          @institution = Institution.new(institution_params)
+
+          if @institution.save
+            redirect_to admin_journal_institutions_path, success: t('.saved')
+          else
+            render :new
+          end
+        end
+
+        def update
+          if @institution.update(institution_params)
+            redirect_to admin_journal_institutions_path, success: t('.saved')
+          else
+            render :edit
+          end
+        end
+
+        def destroy
+          @institution.destroy
+          respond_to do |format|
+            format.html do
+              redirect_to admin_journal_institutions_path, success: t('.deleted')
+            end
+          end
+        end
+
+        private
+
+        def institution_params
+          params.require(:admin_journal_institution).permit(:name)
+        end
+
+        def set_breadcrumb
+          add_breadcrumb Institution.model_name.human(count: :many), admin_journal_institutions_path
+        end
+
+        def set_tabs
+          @tabs = %w[details view_affiliations]
+        end
+
+        def set_institution
+          @institution = Institution.find(params[:id])
+          add_breadcrumb @institution.name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Controller for {Issue} records.
+      class IssuesController < 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 = [:volume_id, :title, :date, { **CONTENT_PARAMS }].freeze
+        PARTS = %w[cover_img description].freeze
+
+        before_action :set_breadcrumb
+        before_action :set_tabs, except: %i[index destroy sort]
+        before_action :set_issue, only: %i[edit update destroy]
+        before_action :set_parts_attributes, only: %i[new edit]
+        before_action :build_parts, only: %i[edit]
+
+        def index
+          @issues = Issue.sorted_desc
+        end
+
+        def new
+          @issue = Issue.new
+          build_parts
+          add_breadcrumb t('.new')
+        end
+
+        def edit
+          add_breadcrumb t('spina.admin.journal.volumes.volume_number', number: @issue.volume.number),
+                         edit_admin_journal_volume_path(@issue.volume)
+          add_breadcrumb t('spina.admin.journal.issues.issue_number', number: @issue.number)
+        end
+
+        def create
+          @issue = Issue.new(issue_params)
+          sister_issues = Issue.where(volume: @issue.volume_id)
+          @issue.number = sister_issues.any? ? sister_issues.sorted_desc.first.number + 1 : 1
+
+          if @issue.save
+            redirect_to admin_journal_issues_path, success: t('.saved')
+          else
+            render :new
+          end
+        end
+
+        def update
+          if @issue.update(issue_params)
+            redirect_to admin_journal_issues_path, success: t('.saved')
+          else
+            render :edit
+          end
+        end
+
+        def destroy
+          @issue.destroy
+          respond_to do |format|
+            format.html do
+              redirect_to admin_journal_issues_path, success: t('.deleted')
+            end
+          end
+        end
+
+        def sort
+          ActiveRecord::Base.transaction do
+            sort_params.each do |id, new_pos|
+              # ignore uniqueness validation for now
+              Issue.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 set_issue
+          @issue = Issue.find(params[:id])
+        end
+
+        def issue_params
+          params.require(:admin_journal_issue).permit(PARAMS)
+        end
+
+        def sort_params
+          params.require(:admin_journal_issues).require(:list).permit!
+        end
+
+        def validate_sort_order
+          Issue.where(volume_id: params[:volume_id]).each do |issue|
+            raise ActiveRecord::RecordInvalid if issue.invalid?
+          end
+        end
+
+        def set_breadcrumb
+          add_breadcrumb Issue.model_name.human(count: :many), admin_journal_issues_path
+        end
+
+        def set_tabs
+          @tabs = %w[details articles]
+        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| @issue.part(part_attributes) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Controller for {Journal} records.
+      # A site only ever has a single journal, so the index action is not needed.
+      class JournalsController < 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 = [:name, { **CONTENT_PARAMS }].freeze
+        PARTS = %w[logo description].freeze
+
+        before_action :set_journal
+        before_action :set_parts_attributes
+        before_action :build_parts, only: %i[edit]
+
+        def edit
+          add_breadcrumb @journal.name
+        end
+
+        def update
+          if @journal.update(journal_params)
+            redirect_to edit_admin_journal_journal_path(@journal), success: t('.saved')
+          else
+            render :edit
+          end
+        end
+
+        def destroy
+          @journal.destroy
+          respond_to do |format|
+            format.html do
+              redirect_to edit_admin_journal_journal_path(Journal.instance), success: t('.deleted')
+            end
+          end
+        end
+
+        private
+
+        def set_journal
+          @journal = Journal.instance
+        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| @journal.part(part_attributes) }
+        end
+
+        def journal_params
+          params.require(:admin_journal_journal).permit(PARAMS)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Controller for {Volume} records.
+      class VolumesController < ApplicationController
+        before_action :set_breadcrumb
+        before_action :set_tabs, except: %i[index destroy]
+        before_action :set_volume, only: %i[edit destroy]
+
+        def index
+          @volumes = Volume.sorted_asc
+        end
+
+        def edit; end
+
+        def create # rubocop:disable Metrics/AbcSize
+          @volume = Volume.new
+          @volume.journal_id = Journal.instance.id
+          @volume.number = Volume.any? ? Volume.sorted_desc.first.number + 1 : 1
+          @volume.save!
+          redirect_to admin_journal_volumes_path, success: t('.created', number: @volume.number)
+        rescue ActiveRecord::RecordNotUnique
+          # can only happen because of some race condition where two Volumes are created at the same time
+          logger.error 'Error when creating new volume. Retrying...'
+          retry
+        end
+
+        def destroy
+          @volume.destroy
+          respond_to do |format|
+            format.html do
+              redirect_to admin_journal_volumes_path, success: 'Volume deleted.'
+            end
+          end
+        end
+
+        def sort
+          ActiveRecord::Base.transaction do
+            sort_params.each do |id, new_pos|
+              # ignore uniqueness validation for now
+              Volume.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 sort_params
+          params.require(:admin_journal_volumes).require(:list).permit!
+        end
+
+        def validate_sort_order
+          Volume.where(journal_id: params[:journal_id]).each do |volume|
+            raise ActiveRecord::RecordInvalid if volume.invalid?
+          end
+        end
+
+        def set_breadcrumb
+          add_breadcrumb Volume.model_name.human(count: :many), admin_journal_volumes_path
+        end
+
+        def set_volume
+          @volume = Volume.find(params[:id])
+          add_breadcrumb t('spina.admin.journal.volumes.volume_number', number: @volume.number)
+        end
+
+        def set_tabs
+          @tabs = %w[details issues]
+        end
+      end
+    end
+  end
+end

data/app/models/spina/admin/journal.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal # rubocop:disable Style/Documentation
+      def self.table_name_prefix
+        'spina_admin_journal_'
+      end
+    end
+  end
+end

data/app/models/spina/admin/journal/affiliation.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Rich join between an Institution and an Author. Associated with Articles via Authorships.
+      #
+      # Since authors can in principle use different names in different articles, names are associated
+      # with affiilations, rather than with authors directly.
+      #
+      # === Validators
+      # Presence:: {#first_name}, {#surname}
+      #
+      # === Scopes
+      # sorted:: sorted by surname in alphabetical order
+      #
+      # @see Institution
+      # @see Author
+      # @see Article
+      # @see Authorship
+      class Affiliation < ApplicationRecord
+        # @!attribute [rw] first_name
+        #   @return [String] the first name(s) of the author
+        # @!attribute [rw] surname
+        #   @return [String] the last name(s) of the author
+        # @!attribute [rw] status
+        #   @return [Integer] the status of the author, which can be either primary (1) or other (0)
+        # @!attribute [rw] author
+        #   @return [ActiveRecord::Relation] the {Author} whose affiliation this record holds
+        belongs_to :author
+        # @!attribute [rw] institution
+        #   @return [ActiveRecord::Relation] the {Institution} to which the author is affiliated
+        belongs_to :institution
+        # @!attribute [rw] authorships
+        #   @return [ActiveRecord::Relation] directly associated {Authorship}s
+        has_many :authorships, dependent: :destroy
+        # @!attribute [rw] articles
+        #   @return [ActiveRecord::Relation] {Article}s associated through {Authorship}s
+        has_many :articles, through: :authorships
+
+        validates :first_name, presence: true
+        validates :surname, presence: true
+
+        enum status: { primary: 1, other: 0 }
+
+        scope :sorted, -> { order(surname: :asc) }
+
+        # @!attribute [r] name
+        #   @return [String] The full name of the author.
+        def name
+          "#{first_name} #{surname}"
+        end
+
+        # @!attribute [r] reversed_name
+        #   @return [String] The full name of the author, surname first.
+        def reversed_name
+          "#{surname}, #{first_name}"
+        end
+      end
+    end
+  end
+end

data/app/models/spina/admin/journal/article.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Record for an individual article.
+      #
+      # === Validators
+      # Presence:: {#number}, {#title}
+      # Uniqueness:: {#number} (scope: issue)
+      # URI:: {#url}
+      #
+      # === Scopes
+      # sorted_asc:: sorted in order of increasing number
+      # sorted_desc:: sorted highest number first
+      #
+      # @see Issue
+      # @see Author
+      # @see Authorship
+      class Article < ApplicationRecord
+        include AttrJson::Record
+        include AttrJson::NestedAttributes
+        include Spina::Partable
+        include Spina::TranslatedContent
+        # @!attribute [rw] number
+        #   @return [Integer] The position of the article within its issue.
+        # @!attribute [rw] title
+        #   @return [String] The article's title.
+        # @!attribute [rw] url
+        #   @return [String] An external link to the article.
+        # @!attribute [rw] doi
+        #   @return [String] A digital object intentifier for the article.
+        # @!attribute [rw] issue
+        #   @return [Issue] The issue that contains this article.
+        belongs_to :issue
+        # @!attribute [rw] file
+        #   @return [Spina::Attachment] The attached file
+        belongs_to :file, class_name: 'Spina::Attachment', optional: true
+
+        # @!attribute [rw] authorships
+        has_many :authorships, dependent: :destroy
+        # @!attribute [rw] affiliations
+        #   @return [ActiveRecord::Relation] The authors of the article.
+        has_many :affiliations, through: :authorships
+
+        validates :number, presence: true, uniqueness: { scope: :issue_id }
+        validates :title, presence: true
+        validates :url, 'spina/admin/journal/uri': true
+
+        scope :sorted_asc, -> { includes(:issue).order('spina_admin_journal_issues.number ASC', number: :asc) }
+        scope :sorted_desc, -> { includes(:issue).order('spina_admin_journal_issues.number DESC', number: :desc) }
+      end
+    end
+  end
+end