theoj 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5653737d1c10e9d0ab340155ea60bc4dfd9740032450d4bab4fe028fbd65cd1
-  data.tar.gz: b0a4b24d0906bfaf9d3416f561df03f5d080236891cf9fff4d462858b3cfd897
+  metadata.gz: fe52209e20cb13390a2b85343485fc01a6251c7e98ceafc3eef6c9eed5aa4aa2
+  data.tar.gz: 2730c6f27f95b3c5175219241c415d8502e5f0631609cc5f2bd5a70f189f0838
 SHA512:
-  metadata.gz: '00090ef1f10e4021b09983fa5542f8771515c392a12d4e95e976179d59ea73fac73fc2b65109b81b7f1ee0ffe98eed080e0c75b0e609b88a629e3a86fcb9a02c'
-  data.tar.gz: 131043601a4dc77c11019e77e2c9fcd705b2f693108139a12964299f931d25ae5e31dda2c11f297c7b0ded9fd12b4bf6008e7e27fb61b94b247568fc0fbe7bdb
+  metadata.gz: b5979b4c89efbf24baa9a4ab03edb8d9f3d988ebedc75d262f573c4b64a55b37418211b8f162246aa8155859470e4d058fe08bbcddde417a7b3a9baa93542d8c
+  data.tar.gz: 2212d66e3d45784799c99681a01e75b45d1bae74152a04342abf499103082e4d13f142a51d006a92ac6a5388bbd184dec6de46eb801ba27f8a256f52d2a681f6

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 1.3.0 (2022-03-02)
+
+- Change branches using git-switch instead of git-checkout to remove ambiguaties. Requires Git >= 2.23
+
+## 1.2.1 (2021-11-30)
+
+- Changed metadata dates format to ISO
+- Changed editor and reviewers metadata values to github login
+- Removed languages from article metadata
+
+## 1.2.0 (2021-11-23)
+
+- Added reviews_repository_url to Journal
+- Added article_metadata to Submission
+- Added editor and paper dates lookup information in Submission
+- Fixed error reading reviewers list from issue body
+
 ## 1.1.1 (2021-11-05)
 
 - Added support for test-journal

data/lib/theoj/git.rb

@@ -14,7 +14,7 @@ module Theoj
 
     def change_branch(branch, local_path)
       return true if (branch.nil? || branch.strip.empty?)
-      stdout, stderr, status = Open3.capture3 "git -C #{local_path} checkout #{branch}"
+      stdout, stderr, status = Open3.capture3 "git -C #{local_path} switch #{branch}"
       status.success?
     end
   end

data/lib/theoj/github.rb

@@ -52,7 +52,7 @@ module Theoj
 
     # Returns the user login (removes the @ from the username)
     def user_login(username)
-      username.strip.sub(/^@/, "").downcase
+      username.to_s.strip.sub(/^@/, "").downcase
     end
 
     # Returns true if the string is a valid GitHub isername (starts with @)

data/lib/theoj/journal.rb

@@ -34,6 +34,14 @@ module Theoj
       "#@doi_prefix/#{paper_id}"
     end
 
+    def reviews_repository_url(issue_id=nil)
+      reviews_url = "https://github.com/#{data[:reviews_repository]}"
+      if issue_id
+        reviews_url += "/issues/" + issue_id.to_s
+      end
+      reviews_url
+    end
+
     private
 
     def set_data(custom_data)

data/lib/theoj/published_paper.rb

@@ -35,7 +35,7 @@ module Theoj
     end
 
     def yaml_metadata
-      metadata.to_yaml
+      metadata.transform_keys(&:to_s).to_yaml
     end
 
     def json_metadata

data/lib/theoj/review_issue.rb

@@ -28,7 +28,7 @@ module Theoj
     end
 
     def reviewers
-      @reviewers ||= read_value_from_body("reviewers").split(",").map{|r| r.strip} - ["Pending", "TBD"]
+      @reviewers ||= read_value_from_body("reviewers-list").split(",").map{|r| r.strip} - ["Pending", "TBD"]
     end
 
     def editor

data/lib/theoj/submission.rb

@@ -1,9 +1,12 @@
 require "json"
+require "date"
 require "base64"
 require "faraday"
 
 module Theoj
   class Submission
+    include Theoj::GitHub
+
     attr_accessor :journal
     attr_accessor :review_issue
     attr_accessor :paper
@@ -49,6 +52,65 @@ module Theoj
       metadata.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
+        }
+
+        metadata.merge(editor_info, dates_info)
+    end
+
+    def editor_info
+      editor_info = { editor: {
+                        github_user: user_login(review_issue.editor),
+                        name: nil,
+                        url: nil,
+                        orcid: nil
+                        }
+                    }
+
+      if review_issue.editor
+        editor_lookup = Faraday.get(journal.url + "/editors/lookup/" + user_login(review_issue.editor))
+        if editor_lookup.status == 200
+          info = JSON.parse(editor_lookup.body, symbolize_names: true)
+          editor_info[:editor][:name] = info[:name]
+          editor_info[:editor][:url] = info[:url]
+          editor_info[:editor][:orcid] = info[:orcid]
+        end
+      end
+
+      editor_info
+    end
+
+    def dates_info
+      dates_info = { submitted_at: nil, published_at: nil }
+
+      if review_issue.issue_id
+        paper_lookup = Faraday.get(journal.url + "/papers/lookup/" + review_issue.issue_id.to_s)
+        if paper_lookup.status == 200
+          info = JSON.parse(paper_lookup.body, symbolize_names: true)
+          dates_info[:submitted_at] = format_date(info[:submitted]) if info[:submitted]
+          dates_info[:published_at] = format_date(info[:accepted]) if info[:accepted]
+        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"})
@@ -66,5 +128,12 @@ module Theoj
     def paper_doi
       journal.paper_doi_for_id(paper_id)
     end
+
+    private
+    def format_date(date_string)
+      Date.parse(date_string.to_s).strftime("%Y-%m-%d")
+    rescue Date::Error
+      nil
+    end
   end
 end

data/lib/theoj/version.rb

@@ -1,3 +1,3 @@
 module Theoj
-  VERSION = "1.1.1"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theoj
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Juanjo Bazán
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit