theoj 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09237502c90ed400980274941c03683a2f5b33eaa911debc8b9d50d0747e5a91'
-  data.tar.gz: eb959c2aa0821a45246d3a7551f1fc265c0dc571c9ce791840e7465fc5bb6045
+  metadata.gz: e3393fdafdacce02e4613bb5b20b7ebc53f860a560f826ce4fcc695b808658d7
+  data.tar.gz: 2d3472010e8ad6ecd0c66b9fd68e4c47a176cbc12bd06efa0b5c041a2b21fdbe
 SHA512:
-  metadata.gz: 877313b88d2739e7076ec44b18e7efe50026f099f0e2a55e95919aa2af8ea8d72edbb35ee4882154c650b79134bbb72cdf2780f26e8daa64d06a7505ecd91e26
-  data.tar.gz: 54b6835727136c213a5339d303000bc6f2ee47e8ae24118a3577c2e70657a36613417397074bf7228ffd66a6b3949df0fd7b91649e06be4ba9bdb3b7664ec5b2
+  metadata.gz: f52232e14aa6bfd81afd4bc5a79e3ae02e1f439277597acbfee6b31048b58c8b0003816147ea296446cccebcecfd6c7d28009675d9981a50fa0675b4e1da4ec8
+  data.tar.gz: 6b8d060629fa1652ecd47bda9fc9869b21f4ffa3af8676569a8c7d7e481c572fcf369adcda6213eadc7d9a4594378d9d729af45f38715b96418a6cd9106eb5d5

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.0.1 (2021-09-22)
+
+- Gem created
+
+## 0.0.2 (2021-09-22)
+
+- Available objects: Theoj::Journal, Theoj::ReviewIssue and Theoj::Paper

data/README.md

@@ -2,3 +2,4 @@
 A library to manage editorial objects used by the open journals review process
 
 [![CI](https://github.com/xuanxu/theoj/actions/workflows/ci.yml/badge.svg)](https://github.com/xuanxu/theoj/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/theoj.svg)](https://badge.fury.io/rb/theoj)

data/lib/theoj/journal.rb

@@ -0,0 +1,59 @@
+module Theoj
+  class Journal
+    attr_accessor :data
+    attr_accessor :doi_prefix
+    attr_accessor :url
+    attr_accessor :name
+    attr_accessor :alias
+    attr_accessor :launch_date
+
+    def initialize(custom_data = {})
+      set_data custom_data
+    end
+
+    def current_year
+      data[:current_year] || Time.new.year
+    end
+
+    def current_volume
+      data[:current_volume] || (Time.new.year - (launch_year - 1))
+    end
+
+    def current_issue
+      data[:current_issue] || (1 + ((Time.new.year * 12 + Time.new.month) - (launch_year * 12 + launch_month)))
+    end
+
+    private
+
+    def set_data(custom_data)
+      @data = default_data.merge(custom_data)
+      @doi_prefix = data[:doi_prefix]
+      @url = data[:url]
+      @name = data[:name]
+      @alias = data[:alias]
+      @launch_date = data[:launch_date]
+    end
+
+    def default_data
+      {
+        doi_prefix: "10.21105",
+        url: "http://joss.theoj.org",
+        name: "Journal of Open Source Software",
+        alias: "joss",
+        launch_date: "2016-05-05",
+      }
+    end
+
+    def parsed_launch_date
+      @parsed_launch_date ||= Time.parse(data[:launch_date])
+    end
+
+    def launch_year
+      parsed_launch_date.year
+    end
+
+    def launch_month
+      parsed_launch_date.month
+    end
+  end
+end

data/lib/theoj/paper.rb

@@ -1,4 +1,5 @@
 require 'find'
+require 'yaml'
 
 module Theoj
   class Paper
@@ -7,21 +8,14 @@ module Theoj
     attr_accessor :review_issue
     attr_accessor :repository
     attr_accessor :paper_path
+    attr_accessor :branch
+    attr_accessor :paper_metadata
 
-    def initialize(repository, branch, path = nil)
-      @repository = repository
+    def initialize(repository_url, branch, path = nil)
+      @repository = repository_url
       @branch = branch
       find_paper path
-    end
-
-    def find_paper(path)
-      if path.to_s.strip.empty?
-        setup_local_repo
-        @paper_path = Theoj::Paper.find_paper_path(local_path)
-        cleanup
-      else
-        @paper_path = path
-      end
+      load_metadata
     end
 
     def authors
@@ -43,28 +37,46 @@ module Theoj
       paper_path
     end
 
-    def self.from_repo(repository, branch = "main")
-      Paper.new(repository, branch, nil)
+    def self.from_repo(repository_url, branch = "")
+      Paper.new(repository_url, branch, nil)
+    end
+
+    def cleanup
+      FileUtils.rm_rf(local_path) if Dir.exist?(local_path)
+    end
+
+    def local_path
+      @local_path ||= "tmp/#{SecureRandom.hex}"
     end
 
     private
+
+      def find_paper(path)
+        if path.to_s.strip.empty?
+          setup_local_repo
+          @paper_path = Theoj::Paper.find_paper_path(local_path)
+        else
+          @paper_path = path
+        end
+      end
+
       def setup_local_repo
         msg_no_repo = "Downloading of the repository failed. Please make sure the URL is correct."
-        msg_no_branch = "Couldn't check the bibtex because branch name is incorrect: #{paper_branch.to_s}"
+        msg_no_branch = "Couldn't check the bibtex because branch name is incorrect: #{branch.to_s}"
 
-        error = clone_repo(target_repository, local_path) ? nil : msg_no_repo
-        (error = change_branch(paper_branch, local_path) ? nil : msg_no_branch) unless error
+        error = clone_repo(repository, local_path) ? nil : msg_no_repo
+        (error = change_branch(branch, local_path) ? nil : msg_no_branch) unless error
 
         failure(error) if error
         error.nil?
       end
 
-      def local_path
-        @local_path ||= "tmp/#{SecureRandom.hex}"
-      end
-
-      def cleanup
-        FileUtils.rm_rf(local_path) if Dir.exist?(local_path)
+      def load_metadata
+        @paper_metadata ||= if paper_path.include?('.tex')
+          YAML.load_file(paper_path.gsub('.tex', '.yml'))
+        else
+          YAML.load_file(paper_path)
+        end
       end
 
       def failure(msg)

data/lib/theoj/review_issue.rb

@@ -20,6 +20,7 @@ module Theoj
     end
 
     def paper
+      @paper ||= Theoj::Paper.new(target_repository, paper_branch)
     end
 
     def target_repository

data/lib/theoj/version.rb

@@ -1,3 +1,3 @@
 module Theoj
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/theoj.rb

@@ -1,6 +1,7 @@
 require_relative "theoj/version"
 require_relative "theoj/git"
 require_relative "theoj/github"
+require_relative "theoj/journal"
 require_relative "theoj/review_issue"
 require_relative "theoj/paper"
 require_relative "theoj/author"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theoj
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Juanjo Bazán
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-22 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -59,12 +59,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/theoj.rb
 - lib/theoj/author.rb
 - lib/theoj/git.rb
 - lib/theoj/github.rb
+- lib/theoj/journal.rb
 - lib/theoj/paper.rb
 - lib/theoj/review_issue.rb
 - lib/theoj/version.rb