theoj 1.3.6 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c515c77887a35b68e134958d1fc4e3b5c7f3fe0f49857ce6588840b78c066082
-  data.tar.gz: 9ff11bb419fde2feea92704ad61435f74fa7353e5a69ab042fd6b1a43c18da91
+  metadata.gz: 8e40a25606ae1f2aaadf5e1459e1d9711b4c2650faa57cea6132a35d5c20cb8a
+  data.tar.gz: f84ded3ac7b898a5fe25cd469d6c559ad6aa57a38c293fc948cfa01604c0de89
 SHA512:
-  metadata.gz: 9a6436cde4cf744a217527d0000d7ef222735d769db36539874f9c98ddef6c8f4e16b57bcc7b69a6a380e1557d46faf9a96c71f6a7006bd904e6e47d4f968a08
-  data.tar.gz: 12b3e3893b21fa461b40fabcea661be6b43965fa92b6d02f8554f2dc079d6b209e924d34935ddbb8451590812c5fb62a84891e6f599844c40fbb43d8c6b5e2a4
+  metadata.gz: 140741757c989ae514fad023fffd967b5f7ad90a7c94b800aa9c8aa7aeb9af9eccfdf4ce111fa35f2f916e83a1baff945e87a49c74f226fd76eb5739535a58ed
+  data.tar.gz: e8ab0f0e2dbd6da6a81ef08b824cb7accaaa8dd9e9b378dbd72671528a774deb5f72c48465412c2d74ad1367ed680f21da852280f56dd991996692ae6b66b738

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.4.0 (2022-08-01)
+
+- Added method to Journal to get year/volume/issue information for any date
+- Submission metadata now takes into account published paper status
+
 ## 1.3.6 (2022-07-11)
 
 - Improve parsing os author names

data/lib/theoj/journal.rb

@@ -42,6 +42,15 @@ module Theoj
       reviews_url
     end
 
+    def year_volume_issue_for_date(d)
+      d = Date.parse(d) if d.is_a? String
+      year = d.year
+      volume = year - (launch_year - 1)
+      issue = (1 + ((year * 12 + d.month) - (launch_year * 12 + launch_month)))
+
+      [year, volume, issue]
+    end
+
     private
 
     def set_data(custom_data)

data/lib/theoj/journals_data.rb

@@ -1,3 +1,5 @@
+require "date"
+
 module Theoj
   JOURNALS_DATA = {
     joss: {

data/lib/theoj/submission.rb

@@ -20,58 +20,105 @@ module Theoj
     # Create the payload to use to post for depositing with Open Journals
     def deposit_payload
       {
-        id: review_issue.issue_id,
+        id: metadata_info[:review_issue_id],
         metadata: Base64.encode64(metadata_payload),
-        doi: paper_doi,
-        archive_doi: review_issue.archive,
+        doi: metadata_info[:doi],
+        archive_doi: metadata_info[:archive_doi],
         citation_string: citation_string,
-        title: paper.title
+        title: metadata_info[:title]
       }
     end
 
     # Create a metadata json payload
     def metadata_payload
-      metadata = {
+      {
         paper: {
-          title: paper.title,
-          tags: paper.tags,
-          languages: paper.languages,
-          authors: paper.authors.collect { |a| a.to_h },
-          doi: paper_doi,
-          archive_doi: review_issue.archive,
-          repository_address: review_issue.target_repository,
-          editor: review_issue.editor,
-          reviewers: review_issue.reviewers.collect(&:strip),
-          volume: journal.current_volume,
-          issue: journal.current_issue,
-          year: journal.current_year,
-          page: review_issue.issue_id,
+          title: metadata_info[:title],
+          tags: metadata_info[:tags],
+          languages: metadata_info[:languages],
+          authors: metadata_info[:authors],
+          doi: metadata_info[:doi],
+          archive_doi: metadata_info[:archive_doi],
+          repository_address: metadata_info[:software_repository_url],
+          editor: metadata_info[:review_editor],
+          reviewers: metadata_info[:reviewers].collect(&:strip),
+          volume: metadata_info[:volume],
+          issue: metadata_info[:issue],
+          year: metadata_info[:year],
+          page: metadata_info[:page]
         }
-      }
-
-      metadata.to_json
+      }.to_json
     end
 
     # Create metadata used to generate PDF/JATS outputs
     def article_metadata
-        metadata = {
-          title: paper.title,
-          tags: paper.tags,
-          authors: paper.authors.collect { |a| a.to_h },
-          doi: paper_doi,
-          software_repository_url: review_issue.target_repository,
-          reviewers: review_issue.reviewers.collect{|r| user_login(r)},
-          volume: journal.current_volume,
-          issue: journal.current_issue,
-          year: journal.current_year,
-          page: review_issue.issue_id,
-          journal_alias: journal.alias,
-          software_review_url: journal.reviews_repository_url(review_issue.issue_id),
-          archive_doi: review_issue.archive,
-          citation_string: citation_string
-        }
+      {
+        title: metadata_info[:title],
+        tags: metadata_info[:tags],
+        authors: metadata_info[:authors],
+        doi: metadata_info[:doi],
+        software_repository_url: metadata_info[:software_repository_url],
+        reviewers: metadata_info[:reviewers].collect{|r| user_login(r)},
+        volume: metadata_info[:volume],
+        issue: metadata_info[:issue],
+        year: metadata_info[:year],
+        page: metadata_info[:page],
+        journal_alias: metadata_info[:journal_alias],
+        software_review_url: metadata_info[:software_review_url],
+        archive_doi: metadata_info[:archive_doi],
+        citation_string: metadata_info[:citation_string],
+        editor: metadata_info[:editor],
+        submitted_at: metadata_info[:submitted_at],
+        published_at: metadata_info[:published_at]
+      }
+    end
+
+    def metadata_info
+      @metadata_info ||= all_metadata
+    end
+
+    def deposit!(secret)
+      parameters = deposit_payload.merge(secret: secret)
+      Faraday.post(journal.data[:deposit_url], parameters.to_json, {"Content-Type" => "application/json"})
+    end
+
+    def citation_string
+      metadata_info[:citation_string]
+    end
+
+    def paper_id
+      journal.paper_id_from_issue(review_issue.issue_id)
+    end
+
+    def paper_doi
+      journal.paper_doi_for_id(paper_id)
+    end
 
-        metadata.merge(editor_info, dates_info)
+    def all_metadata
+      metadata = {
+        title: paper.title,
+        tags: paper.tags,
+        languages: paper.languages,
+        authors: paper.authors.collect { |a| a.to_h },
+        doi: paper_doi,
+        software_repository_url: review_issue.target_repository,
+        review_issue_id: review_issue.issue_id,
+        review_editor: review_issue.editor,
+        reviewers: review_issue.reviewers,
+        volume: journal.current_volume,
+        issue: journal.current_issue,
+        year: journal.current_year,
+        page: review_issue.issue_id,
+        journal_alias: journal.alias,
+        journal_name: journal.name,
+        software_review_url: journal.reviews_repository_url(review_issue.issue_id),
+        archive_doi: review_issue.archive,
+        citation_author: paper.citation_author
+      }
+
+      metadata.merge!(editor_info, dates_info)
+      metadata[:citation_string] = build_citation_string(metadata)
+      metadata
     end
 
     def editor_info
@@ -106,30 +153,24 @@ module Theoj
           dates_info[:submitted_at] = format_date(info[:submitted]) if info[:submitted]
           dates_info[:published_at] = format_date(info[:accepted]) if info[:accepted]
         end
+
+        if dates_info[:published_at]
+          yvi = journal.year_volume_issue_for_date(Date.parse(dates_info[:published_at]))
+          dates_info[:year] = yvi[0]
+          dates_info[:volume] = yvi[1]
+          dates_info[:issue] = yvi[2]
+        end
       end
 
       dates_info
     end
 
-    def deposit!(secret)
-      parameters = deposit_payload.merge(secret: secret)
-      Faraday.post(journal.data[:deposit_url], parameters.to_json, {"Content-Type" => "application/json"})
-    end
-
-    def citation_string
-      paper_year = Time.now.strftime('%Y')
-      "#{paper.citation_author}, (#{paper_year}). #{paper.title}. #{journal.name}, #{journal.current_volume}(#{journal.current_issue}), #{review_issue.issue_id}, https://doi.org/#{paper_doi}"
-    end
-
-    def paper_id
-      journal.paper_id_from_issue(review_issue.issue_id)
-    end
+    private
 
-    def paper_doi
-      journal.paper_doi_for_id(paper_id)
+    def build_citation_string(metadata)
+      "#{metadata[:citation_author]}, (#{metadata[:year]}). #{metadata[:title]}. #{metadata[:journal_name]}, #{metadata[:volume]}(#{metadata[:issue]}), #{metadata[:review_issue_id]}, https://doi.org/#{metadata[:doi]}"
     end
 
-    private
     def format_date(date_string)
       Date.parse(date_string.to_s).strftime("%Y-%m-%d")
     rescue Date::Error

data/lib/theoj/version.rb

@@ -1,3 +1,3 @@
 module Theoj
-  VERSION = "1.3.6"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theoj
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.4.0
 platform: ruby
 authors:
 - Juanjo Bazán
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.25'
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.25'
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: openjournals-nameable
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.3
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.3
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement