spina-admin-journal 0.1.0

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Authors are collections of {Affiliation}s.
+      #
+      # Since people can have multiple names, titles, institutions, etc., these details are all
+      # handled by the {Affiliation} record. This record groups said records together, in order
+      # that a coherent oeuvre of a single author be identified, which is more user-friendly.
+      #
+      # @note An author must have at least one Affiliation with +status: primary+, else validation
+      #       will fail.
+      #
+      # @see Affiliation
+      class Author < ApplicationRecord
+        # @!attribute [rw] affiliations
+        #   @return [ActiveRecord::Relation] Directly associated {Affiliation}s.
+        has_many :affiliations, inverse_of: :author, dependent: :destroy
+        accepts_nested_attributes_for :affiliations
+        # @!attribute [rw] institutions
+        #   @return [ActiveRecord::Relation] The {Institution}s corresponding to this Author's affiliations.
+        has_many :institutions, through: :affiliations
+        # @!attribute [rw] articles
+        #   @return [ActiveRecord::Relation] {Article}s associated through authorships.
+        has_many :articles, through: :affiliations
+
+        validate :must_have_one_primary_affiliation
+
+        # @!attribute [r] primary_affiliation
+        #   @return [ActiveRecord::Relation] The author's primary affiliation.
+        def primary_affiliation
+          affiliations.primary.first || Affiliation.new(status: :primary)
+        end
+
+        private
+
+        def must_have_one_primary_affiliation
+          return if !affiliations.nil? && affiliations.any? \
+            && (affiliations.count { |affiliation| affiliation.status == 'primary' } == 1)
+
+          errors.add :affiliations, 'must have at least one primary affiliation'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Joins Articles and Affiliations
+      # @see Article
+      # @see Affiliation
+      class Authorship < ApplicationRecord
+        # @!attribute [rw] article
+        #   @return [ActiveRecord::Relation] the associated article
+        belongs_to :article
+        # @!attribute [rw] author_name
+        #   @return [ActiveRecord::Relation] the associated affiliation of an author of the article
+        belongs_to :affiliation
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Record for an institution. Associated with {Author}s via {Affiliation}s.
+      #
+      # === Validators
+      # Presence:: {#name}
+      # Uniqueness:: {#name}
+      #
+      # === Scopes
+      # sorted:: sort institutions in alphabetical order
+      #
+      # @see Affiliation
+      class Institution < ApplicationRecord
+        # @!attribute [rw] name
+        #   @return [String]
+        # @!attribute [rw] affiliations
+        #   @return [ActiveRecord::Relation] the affiliations held at the institution
+        has_many :affiliations, dependent: :destroy
+        # @!attribute [rw] authors
+        #   @return [ActiveRecord::Relation] associated authors
+        has_many :authors, through: :affiliations
+
+        validates :name, presence: true, uniqueness: { case_sensitive: false }
+
+        scope :sorted, -> { order(name: :asc) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Record for an issue of a journal.
+      # Belongs to a particular volume of a journal. Has many articles.
+      #
+      # === Validators
+      # Presence:: {#number}, {#date}
+      # Uniqueness:: {#number} (scope: volume)
+      #
+      # === Scopes
+      # sorted_asc:: sorted in order of increasing number
+      # sorted_desc:: sorted highest number first
+      #
+      # @see Article
+      # @see Volume
+      class Issue < ApplicationRecord
+        include AttrJson::Record
+        include AttrJson::NestedAttributes
+        include Spina::Partable
+        include Spina::TranslatedContent
+        # @!attribute [rw] number
+        #   @return [Integer] The number
+        # @!attribute [rw] title
+        #   @return [String] The title of the issue (optional)
+        # @!attribute [rw] date
+        #   @return [Date] The (planned) publication date of the issue.
+        # @!attribute [rw] volume
+        #   @return [ActiveRecord::Relation] the volume that contains this issue
+        belongs_to :volume
+        # @!attribute [rw] cover_img
+        #   @return [Spina::Image, nil] the issue's cover image
+        belongs_to :cover_img, class_name: 'Spina::Image', optional: true
+
+        # @!attribute [rw] issue
+        #   @return [ActiveRecord::Relation] the articles within this issue
+        has_many :articles, dependent: :destroy
+
+        validates :number, presence: true, uniqueness: { scope: :volume_id }
+        validates :date, presence: true
+
+        scope :sorted_asc, -> { includes(:volume).order('spina_admin_journal_volumes.number ASC', number: :asc) }
+        scope :sorted_desc, -> { includes(:volume).order('spina_admin_journal_volumes.number DESC', number: :desc) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Journal records. The top level of the database hierarchy.
+      #
+      # There should only ever be a single Journal record, which must always be accessed
+      # using {Journal.instance}
+      #
+      # === Validatorss
+      # Presence:: {#name}, {#singleton_guard}
+      # Uniqueness:: {#name}, {#singleton_guard}
+      class Journal < ApplicationRecord
+        include AttrJson::Record
+        include AttrJson::NestedAttributes
+        include Spina::Partable
+        include Spina::TranslatedContent
+        # @!attribute [rw] name
+        #   @return [String] The name of the journal.
+        # @!attribute [rw] singleton_guard
+        #   @return [Integer] Used to guarantee that a record is unique.
+        # @!attribute [rw] logo
+        #   @return [Spina::Image, nil] The Spina::Image representing the logo of the journal.
+        belongs_to :logo, class_name: 'Spina::Image', optional: true
+
+        # @!attribute [rw] volumes
+        #   @return [ActiveRecord::Relation] directly associated volumes
+        has_many :volumes, dependent: :destroy
+
+        validates :name, presence: true, uniqueness: true
+        validates :singleton_guard, presence: true, uniqueness: true
+
+        # Access the journal record.
+        #
+        # It is possible that Journal.instance gets called from two threads simultaneously.
+        # If this occurs, +Journal.create!+ will throw a validation error, since both records will
+        # be assigned the same value for +singleton_guard+. This is handled automatically, guaranteeing
+        # that there only ever be a single record.
+        def self.instance
+          Journal.first || Journal.create!(name: I18n.t('spina.admin.journal.unnamed_journal'), singleton_guard: 0)
+        rescue ActiveRecord::RecordNotUnique
+          # prevent race conditions leading to multiple records being created
+          logger.error 'Error when retrieving Journal instance. Retrying...'
+          retry
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Journal
+      # Volumes of a journal.
+      # A journal has multiple volumes, a volume can have multiple issues.
+      #
+      # === Validators
+      # Presence:: {#number}
+      # Uniqueness:: {#number} (scope: journal)
+      #
+      # === Scopes
+      # sorted_asc:: sorted in order of increasing number
+      # sorted_desc:: sorted highest number first
+      #
+      # @see Issue
+      # @see Journal
+      class Volume < ApplicationRecord
+        # @!attribute [rw] number
+        #   @return [Integer]
+        # @!attribute [rw] journal
+        #   @return [ActiveRecord::Relation] the journal that contains this volume
+        belongs_to :journal
+
+        # @!attribute [rw] journal
+        #   @return [ActiveRecord::Relation] the issues that comprise this volume
+        has_many :issues, dependent: :destroy
+
+        validates :number, presence: true, uniqueness: { scope: :journal_id }
+
+        scope :sorted_asc, -> { order(number: :asc) }
+        scope :sorted_desc, -> { order(number: :desc) }
+      end
+    end
+  end
+end

data/app/validators/spina/admin/journal/uri_validator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module Spina
+  module Admin
+    module Journal
+      # A simple validator for URIs.
+      class UriValidator < ActiveModel::EachValidator
+        def validate_each(record, attribute, value)
+          return if value == '' || value.nil?
+
+          uri = URI.parse(value)
+
+          return if uri.is_a?(URI::HTTP) && !uri.host.nil?
+
+          record.errors.add attribute, :invalid_uri
+        rescue URI::InvalidURIError
+          record.errors.add attribute, :invalid_uri
+        end
+      end
+    end
+  end
+end

data/app/views/layouts/spina/admin/journal/articles.html.haml

@@ -0,0 +1,10 @@
+- content_for :application do
+  %header#header
+    #header_actions
+      = yield :header_actions
+  
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+  = yield
+
+= render template: 'layouts/spina/admin/admin'

data/app/views/layouts/spina/admin/journal/authors.html.haml

@@ -0,0 +1,10 @@
+- content_for :application do
+  %header#header
+    #header_actions
+      = yield :header_actions
+  
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+  = yield
+
+= render template: 'layouts/spina/admin/admin'

data/app/views/layouts/spina/admin/journal/institutions.html.haml

@@ -0,0 +1,10 @@
+- content_for :application do
+  %header#header
+    #header_actions
+      = yield :header_actions
+  
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+  = yield
+
+= render template: 'layouts/spina/admin/admin'

data/app/views/layouts/spina/admin/journal/issues.html.haml

@@ -0,0 +1,10 @@
+- content_for :application do
+  %header#header
+    #header_actions
+      = yield :header_actions
+  
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+  = yield
+
+= render template: 'layouts/spina/admin/admin'

data/app/views/layouts/spina/admin/journal/journals.html.haml

@@ -0,0 +1,10 @@
+- content_for :application do
+  %header#header
+    #header_actions
+      = yield :header_actions
+  
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+  = yield
+
+= render template: 'layouts/spina/admin/admin'

data/app/views/layouts/spina/admin/journal/volumes.html.haml

@@ -0,0 +1,10 @@
+- content_for :application do
+  %header#header
+    #header_actions
+      = yield :header_actions
+  
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+  = yield
+
+= render template: 'layouts/spina/admin/admin'

data/app/views/spina/admin/hooks/journal/_head.html.haml

@@ -0,0 +1,2 @@
+= stylesheet_link_tag 'spina/admin/journal/application', media: 'all', data: { turbolinks_track: true }
+= javascript_include_tag 'spina/admin/journal/application'

data/app/views/spina/admin/hooks/journal/_primary_navigation.html.haml

@@ -0,0 +1,27 @@
+%li{ class: ('active' if %w[articles issues volumes].include? controller_name) }
+  = link_to admin_journal_volumes_path do
+    = icon 'pages'
+    = ::Spina::Admin::Journal::Journal.instance.name
+    = icon 'caret-right'
+
+    %ul
+      %li{ class: ('active' if %w[volumes].include? controller_name) }
+        = link_to ::Spina::Admin::Journal::Volume.model_name.human(count: :many), admin_journal_volumes_path
+      %li{ class: ('active' if %w[issues].include? controller_name) }
+        = link_to ::Spina::Admin::Journal::Issue.model_name.human(count: :many), admin_journal_issues_path
+      %li{ class: ('active' if %w[articles].include? controller_name) }
+        = link_to ::Spina::Admin::Journal::Article.model_name.human(count: :many), admin_journal_articles_path
+
+%li{ class: ('active' if %w[journals authors institutions].include? controller_name) }
+  = link_to edit_admin_journal_journal_path(::Spina::Admin::Journal::Journal.instance.id) do
+    = icon 'dots'
+    = t 'spina.admin.journal.navigation_title'
+    = icon 'caret-right'
+
+    %ul
+      %li{ class: ('active' if %w[journals].include? controller_name) }
+        = link_to ::Spina::Admin::Journal::Journal.model_name.human(count: :one), edit_admin_journal_journal_path(::Spina::Admin::Journal::Journal.instance.id)
+      %li{ class: ('active' if %w[authors].include? controller_name) }
+        = link_to ::Spina::Admin::Journal::Author.model_name.human(count: :many), admin_journal_authors_path
+      %li{ class: ('active' if %w[institutions].include? controller_name) }
+        = link_to ::Spina::Admin::Journal::Institution.model_name.human(count: :many), admin_journal_institutions_path

data/app/views/spina/admin/journal/affiliations/_affiliation.html.haml

@@ -0,0 +1,8 @@
+%tr
+  %td= affiliation.name
+  %td= affiliation.institution.name
+  %td= affiliation.articles.count
+  %td.nowrap.align-right
+    = link_to edit_admin_journal_author_path(affiliation.author.id), class: 'button button-link' do
+      = icon 'pencil-outline'
+      = t '.view'

data/app/views/spina/admin/journal/application/_empty_list.html.haml

@@ -0,0 +1,3 @@
+%tr
+  %td.align-center{ colspan: 1000 }
+    %em= message

data/app/views/spina/admin/journal/articles/_article.html.haml

@@ -0,0 +1,10 @@
+%tr{ data: { id: article.id } }
+  %td= article.issue.volume.number
+  %td= article.issue.number
+  %td.position-display= article.number
+  %td= time_tag article.issue.date, format: :iso8601
+  %td= article.title
+  %td.nowrap.align-right
+    = link_to edit_admin_journal_article_path(article.id), class: 'button button-link' do
+      = icon 'pencil-outline'
+      = t '.view'

data/app/views/spina/admin/journal/articles/_form.html.haml

@@ -0,0 +1,29 @@
+- if @article.errors.any?
+  - content_for :notifications do
+    .notification.notification-danger.animated.fadeInRight
+      = icon 'exclamation'
+      .notification-message
+        = t 'spina.notifications.alert'
+        %small= @article.errors.full_messages.join('<br />').html_safe
+      = link_to '#', data: { close_notification: true } do
+        = icon 'cross'
+
+= form_for @article, html: { autocomplete: "off" } do |f|
+  %header#header
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+    #header_actions
+      %button.button.button-primary{ type: 'submit', style: 'margin-right: 0', data: { disable_with: t('spina.pages.saving') } }
+        = icon 'check'
+        = t '.save'
+
+      = link_to t('spina.cancel'), admin_journal_articles_path, class: 'button', style: 'margin-right: 0;'
+
+    %nav#secondary.tabs
+      %ul
+        - @tabs.each_with_index do |tab, i|
+          %li{ class: ('active' if i == 0) }
+            = link_to t(".#{tab}"), "##{tab}"
+
+  #details.tab-content.active= render 'form_details', f: f
+  #authors.tab-content= render 'form_authors', f: f

data/app/views/spina/admin/journal/articles/_form_authors.html.haml

@@ -0,0 +1,10 @@
+.table-container
+  %table.table
+    %thead
+      %tr
+        %th= ::Spina::Admin::Journal::Affiliation.human_attribute_name :name
+        %th= ::Spina::Admin::Journal::Affiliation.human_attribute_name :institution
+        %th= t '.number_of_articles'
+        %th
+    %tbody
+      = render @article.affiliations.any? ? @article.affiliations : 'empty_list', message: t('.no_authors')