spina-admin-journal 0.1.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75a11c42a861742be9bee3d10d3a84f745f2d489b8a1ad61bf8e699f4f7fdc04
-  data.tar.gz: 343abc141c3af6b35492ec12a4c99325b116a3f63c5058fe7c61359cdfcd0da2
+  metadata.gz: cf3f41e632c032cf855ea7be3d2d6297e0f3d0eba015906afcb2c7497b8a0e16
+  data.tar.gz: 59e90ab32fa02f5400870002cffa3a0b7f7fe1f590ca03f8f2b22f008a72b074
 SHA512:
-  metadata.gz: 8209f366bfdd31dee8b559a9ca0c3966f3383687560b87a20cda19fbb198eb8faa5929d07e1b97b773464ab950fb5d2c298b4e168a22afacec726c7bb7fee2a4
-  data.tar.gz: 7182be875c118c6c59322b6e5a3fd51d81d5d51700be8db549ae48438df05bbb2fd9c290219cdbcae3d28b5530e172e5891ceb1636954c7aa36410406f96573b
+  metadata.gz: d8aebef70619bebbab5d5832639aa4dff527f909e4828a62aea7210eb69c0c2f0cddf2eb68871890457f751b3af00df686dbca919fedffb13276d89894b3b9ea
+  data.tar.gz: 1f1de9525d2e5ae4c57bdd9eeb55bfb106e3bcc3b9d32fcb1f8591820a89865a57311b65c7f57f48ca2a4ee95dcc219f4199ccd2354fdb11339accf1bf0dcc75

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

@@ -19,7 +19,7 @@ module Spina
         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
+        PARAMS = [:issue_id, :title, :url, :doi, :status, { affiliation_ids: [], **CONTENT_PARAMS }].freeze
         PARTS = %w[abstract attachment].freeze
 
         before_action :set_breadcrumb

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

@@ -46,6 +46,20 @@ module Spina
           end
         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
+          end
+          render json: { success: true, message: t('.sort_success') }
+        rescue ActiveRecord::RecordInvalid
+          render json: { success: false, message: t('.sort_error') }
+        end
+
         private
 
         def author_params
@@ -65,6 +79,10 @@ 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
@@ -77,6 +95,12 @@ 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

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

@@ -20,7 +20,7 @@ module Spina
           params.merge("#{locale}_content_attributes": [*PARTS_PARAMS])
         end
         PARAMS = [:volume_id, :title, :date, { **CONTENT_PARAMS }].freeze
-        PARTS = %w[cover_img description].freeze
+        PARTS = %w[cover_img description attachment].freeze
 
         before_action :set_breadcrumb
         before_action :set_tabs, except: %i[index destroy sort]

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

@@ -7,12 +7,13 @@ module Spina
       #
       # === Validators
       # Presence:: {#number}, {#title}
-      # Uniqueness:: {#number} (scope: issue)
+      # Uniqueness:: {#number} (scope: issue) {status}
       # URI:: {#url}
       #
       # === Scopes
       # sorted_asc:: sorted in order of increasing number
       # sorted_desc:: sorted highest number first
+      # visible:: articles that should be visible to the public
       #
       # @see Issue
       # @see Author
@@ -33,9 +34,6 @@ module Spina
         # @!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
@@ -43,12 +41,23 @@ module Spina
         #   @return [ActiveRecord::Relation] The authors of the article.
         has_many :affiliations, through: :authorships
 
+        # @!attribute [rw] status
+        #   @return [Integer] the current status of the article
+        enum status: { published: 0, draft: 1, meta: 2 }
+
         validates :number, presence: true, uniqueness: { scope: :issue_id }
         validates :title, presence: true
         validates :url, 'spina/admin/journal/uri': true
+        validates :status, presence: true
 
+        scope :visible, -> { where(status: %i[published meta]) }
         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) }
+
+        # Returns true if the article should be visible to end users (i.e. is not a draft).
+        def visible?
+          published? || meta?
+        end
       end
     end
   end

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

@@ -13,6 +13,12 @@ module Spina
         # @!attribute [rw] author_name
         #   @return [ActiveRecord::Relation] the associated affiliation of an author of the article
         belongs_to :affiliation
+        # @!attribute [rw] position
+        #   @return [Integer] used to order the affiliations for each article
+
+        validates :position, presence: true, uniqueness: { scope: :article_id }
+
+        scope :sorted_within_article, -> { order(position: :asc) }
       end
     end
   end

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

@@ -30,9 +30,6 @@ module Spina
         # @!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

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

@@ -20,9 +20,6 @@ module Spina
         #   @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

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

@@ -1,4 +1,4 @@
-%tr
+%tr{ data: { id: affiliation.id } }
   %td= affiliation.name
   %td= affiliation.institution.name
   %td= affiliation.articles.count

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

@@ -1,10 +1,15 @@
+.sort-message
 .table-container
   %table.table
     %thead
       %tr
+        %th= ::Spina::Admin::Journal::Affiliation.human_attribute_name :position
         %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')
+    %tbody.html5sortable{ data: { id: @article.id, sorted_collection: 'admin_journal_authorships', sort_url: !@article.id.nil? && sort_admin_journal_authors_url(@article) } }
+      - if @article.authorships.any?
+        = render @article.authorships.sorted_within_article
+      - else
+        = render 'empty_list', message: t('.no_authors')

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

@@ -15,6 +15,11 @@
       = ::Spina::Admin::Journal::Article.human_attribute_name :title
     .page-form-content
       = f.text_field :title
+  .page-form-group
+    .page-form-label
+      = Spina::Admin::Journal::Article.human_attribute_name :status
+    .page-form-content
+      = f.select :status, Spina::Admin::Journal::Article.statuses.keys.map { |key| [key.humanize, key] }
   .page-form-group
     .page-form-label
       = ::Spina::Admin::Journal::Author.model_name.human count: :many

data/app/views/spina/admin/journal/authorships/_authorship.html.haml

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

data/config/locales/en.yml

@@ -100,6 +100,9 @@ en:
             saved: Author saved.
           destroy:
             deleted: Author deleted.
+          sort:
+            sort_success: Sorted successfully!
+            sort_error: There was an error when sorting. Check the server logs for more information.
           form:
             save: Save author
           form_details:
@@ -145,12 +148,15 @@ en:
       spina/admin/journal/article:
         one: Article
         other: Articles
+      spina/admin/journal/authorship:
+        one: Authorship
+        other: Authorships
+      spina/admin/journal/affiliation:
+        one: Affiliation
+        other: Affiliations
       spina/admin/journal/author:
         one: Author
         other: Authors
-      spina/admin/journal/author_name:
-        one: Author name
-        other: Author names
       spina/admin/journal/institution:
         one: Institution
         other: Institutions
@@ -169,8 +175,9 @@ en:
         title: Title
         url: URL
         doi: DOI
+      spina/admin/journal/authorship:
+        position: Position
       spina/admin/journal/author:
-      spina/admin/journal/author_name:
       spina/admin/journal/institution:
         name: Institution Name
 

data/config/routes.rb

@@ -13,9 +13,11 @@ Spina::Engine.routes.draw do
       resources :articles, except: %i[show] do
         patch 'sort/:issue_id' => 'articles#sort', as: :sort, on: :collection
       end
+      resources :authors, except: %i[show] do
+        patch 'sort/:article_id' => 'authors#sort', as: :sort, on: :collection
+      end
 
       resources :institutions, except: %i[show]
-      resources :authors, except: %i[show]
     end
   end
 end

data/db/migrate/20201216152147_create_spina_admin_journal_journals.rb

@@ -4,7 +4,6 @@ class CreateSpinaAdminJournalJournals < ActiveRecord::Migration[6.0] # :nodoc:
   def change
     create_table :spina_admin_journal_journals do |t|
       t.string :name, null: false, default: 'Unnamed Journal'
-      t.references :logo, null: true, foreign_key: { to_table: :spina_images }
       t.integer :singleton_guard, null: false, index: { unique: true }
 
       t.timestamps

data/db/migrate/20201216155113_create_spina_admin_journal_issues.rb

@@ -7,7 +7,6 @@ class CreateSpinaAdminJournalIssues < ActiveRecord::Migration[6.0] # :nodoc:
       t.string :title, null: false, default: ''
       t.date :date, null: false
       t.references :volume, null: false, foreign_key: { to_table: :spina_admin_journal_volumes }
-      t.references :cover_img, null: true, foreign_key: { to_table: :spina_images }
 
       t.timestamps
     end

data/db/migrate/20201216161122_create_spina_admin_journal_articles.rb

@@ -8,7 +8,6 @@ class CreateSpinaAdminJournalArticles < ActiveRecord::Migration[6.0] # :nodoc:
       t.string :url, null: false, default: ''
       t.string :doi, null: false, default: ''
       t.references :issue, null: false, foreign_key: { to_table: :spina_admin_journal_issues }
-      t.references :file, null: true, foreign_key: { to_table: :spina_attachments, on_delete: :nullify }
 
       t.timestamps
     end

data/db/migrate/20210512122931_add_position_to_spina_admin_journal_authorships.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddPositionToSpinaAdminJournalAuthorships < ActiveRecord::Migration[6.1] # :nodoc:
+  def change
+    add_column :spina_admin_journal_authorships, :position, :integer, null: false, default: 0
+  end
+end

data/db/migrate/20210521121318_add_status_to_spina_admin_journal_articles.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddStatusToSpinaAdminJournalArticles < ActiveRecord::Migration[6.1] # :nodoc:
+  def change
+    add_column :spina_admin_journal_articles, :status, :integer, null: false, default: 0
+  end
+end

data/lib/spina/admin/journal/version.rb

@@ -3,7 +3,7 @@
 module Spina
   module Admin
     module Journal
-      VERSION = '0.1.0'
+      VERSION = '0.4.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spina-admin-journal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Louis Van Steene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: babel-transpiler
@@ -318,6 +318,7 @@ files:
 - app/views/spina/admin/journal/authors/edit.html.haml
 - app/views/spina/admin/journal/authors/index.html.haml
 - app/views/spina/admin/journal/authors/new.html.haml
+- app/views/spina/admin/journal/authorships/_authorship.html.haml
 - app/views/spina/admin/journal/institutions/_form.html.haml
 - app/views/spina/admin/journal/institutions/_form_details.html.haml
 - app/views/spina/admin/journal/institutions/_form_view_affiliations.html.haml
@@ -357,6 +358,8 @@ files:
 - db/migrate/20210424123450_add_json_attributes_to_spina_admin_journal_journals.rb
 - db/migrate/20210424123521_add_json_attributes_to_spina_admin_journal_issues.rb
 - db/migrate/20210424123555_add_json_attributes_to_spina_admin_journal_articles.rb
+- db/migrate/20210512122931_add_position_to_spina_admin_journal_authorships.rb
+- db/migrate/20210521121318_add_status_to_spina_admin_journal_articles.rb
 - lib/spina/admin/journal.rb
 - lib/spina/admin/journal/engine.rb
 - lib/spina/admin/journal/version.rb