researchmap2bib 0.2.2 → 0.3.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDY5NTJhODIwMWM2NTkxYzhkOTI5YWMzODM4MzMyYTNhYmQzMWE4YQ==
-  data.tar.gz: !binary |-
-    NzNiZTQzZDU3NWFmNGQyN2Y0MmUwYTc0NTcyNTBiMGNkN2E1MmM2MA==
+SHA1:
+  metadata.gz: 1bf1c32cd1ffaa93eb5af908a81b3d973d24167d
+  data.tar.gz: 4c6fd7376fa440c7b92fd63f5a85e92c98374a74
 SHA512:
-  metadata.gz: !binary |-
-    NTZmOTY0NGM3NWU1YmVhN2JjOGNiNmI3Y2U4MzQxMTk2NGNiNjdmM2IwOWUw
-    ODBmYjIyNDg3ZDM3ZDIyYmVjOGM4NDY5YmVkNmI2MDAxMDVhYzM1ZWUzM2Zm
-    MjExOTJiM2U1YzA5MDZmYTNjNTc1ZGY2NWIzZjI0OTA3OWYxNzQ=
-  data.tar.gz: !binary |-
-    MDYyYmE5NTFhZGQ2YTg4YTdlMjU5ZDE2OTkxMTFjZjY0ZWMwYTU1NDJhZDA4
-    ZTdlZjQzZTBhNTJkMTAyMjBjZmI4ZDA5MThmZmY4NmRjNzZkZGM1ZTFlOGI3
-    MmMzNWY4ZTg2YzI5ZGE3ODczMWFmNWQxMzA1ZWRlNmRiYThjNGY=
+  metadata.gz: 3e98c445ac8cad83801523ab2ee1cfd3e533c3a93fbbfc3509171831db5785a1a4eec406d998d87f94624eec6c7a5e8497dc7726fbf4cbcbcfbadbfe922b16a1
+  data.tar.gz: a1f3c0c9827f44073cd6b401a21480389c8ab535b25bb6bea1a53bebc32f76c3cb0407b0244ae23b7b499cbed7216a228cb6702890253b1cf891938e904c6472

data/README.md

@@ -3,31 +3,31 @@
 
 # Researchmap2bib
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/researchmap2bib`. To experiment with that code, run `bin/console` for an interactive prompt.
+A script to generate LaTeX (BibTeX) bibliography file of your published papers list which is stored in the [researchmap](https://researchmap.jp/) database.
 
-TODO: Delete this and the text above, and describe your gem
+[researchmap](https://researchmap.jp/)のデータベースに登録された論文一覧からLaTeX（BibTeX）のbibliographyファイルを作成するスクリプトです．
 
 ## Installation
 
-Add this line to your application's Gemfile:
+コマンドのインストールの方法は次のとおりです．システムのRubyにインストールする場合，sudoが必要です．
 
 ```ruby
-gem 'researchmap2bib'
+gem install researchmap2bib
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+[researchmap](https://researchmap.jp/)にログインしてXML形式で業績をダウンロードしてください．zipファイルが1つダウンロードされます．このファイル名がresearcher.zipならば，次のコマンドを実行してください．
 
-Or install it yourself as:
+```bash
+resarchmap2bib generate researcher.zip
+```
 
-    $ gem install researchmap2bib
+「researcher.bib」と「sample.tex」ができますのでご利用ください．
 
-## Usage
+sample.texは確認用のLaTeXファイルです．uplatex用のクラスファイルが設定してありますので，ご自身の環境にあわせて変更してください．
 
-```bash
-resarchmap2bib researcher.zip
-```
+なお，bibtexを走らせると，著者名の数が多すぎるなどのエラーになる場合があります．こちらについては手動でご修正してください．
 
 ## Development
 

data/exe/researchmap2bib

@@ -2,27 +2,5 @@
 # coding: utf-8
 
 require "researchmap2bib"
-require 'thor'
 
-class CLI < Thor
-  option 'newline', :type => :boolean
-  desc "generate ZIP_FILE", "researchmapの業績からbibliographyを作成"
-  def generate(file_name)
-    @s = Researchmap2bib::ResearchmapReader.new
-    entries = @s.read_researchmap(file_name)
-
-    results = Array.new
-    entries.each do |entry|
-      results.push(@s.write_bibliography_entry(entry))
-    end
-
-    puts options['newline'] == false ? results : results.join("\n")
-  end
-
-  desc "version", "バージョンを表示"
-  def version
-    puts "researchmap2bib version #{::Researchmap2bib::VERSION}"
-  end
-end
-
-CLI.start(ARGV)
+::Researchmap2bib::CLI.start(ARGV)

data/latexmkrc

@@ -0,0 +1,14 @@
+#!/usr/bin/env perl
+$latex            = 'uplatex -shell-escape';
+$bibtex           = 'upbibtex';
+$dvipdf           = 'dvipdfmx -o %D %S';
+$max_repeat       = 5;
+$pdf_mode	  = 3; # generates pdf via dvipdfmx
+
+# Prevent latexmk from removing PDF after typeset.
+# This enables Skim to chase the update in PDF automatically.
+$pvc_view_file_via_temporary = 0;
+
+# Use evince as a previewer
+$pdf_previewer    = "evince";
+$preview_continuous_mode = 1;

data/lib/researchmap2bib.rb

@@ -1,164 +1,15 @@
 # coding: utf-8
 require "researchmap2bib/version"
-
-require 'zip'
-require 'rexml/document'
-require 'pp'
-require 'erb'
+require 'researchmap2bib/utils'
+require 'researchmap2bib/unique_id'
+require 'researchmap2bib/cli'
+require 'researchmap2bib/generator'
 
 module Researchmap2bib
   Entry = Struct.new(
+    :id,
     :title, :author, :summary, :journal, :publisher, :publicationName,
     :volume, :number, :startingPage, :endingPage, :publicationDate,
     :referee, :language, :paperType,
   )
-
-  class ResearchmapReader
-    def read_researchmap(file_name)
-      entries = Zip::File.open(file_name) do |zip_file|
-        entry = zip_file.glob('*\/paper.xml').first
-        read_paper(entry.get_input_stream.read)
-      end
-    end
-
-    def read_paper(xml)
-      doc = REXML::Document.new(xml)
-      entries = Array.new
-      REXML::XPath.each(doc, '/feed/entry') do |entry|
-        entries.push(read_entry(entry))
-      end
-      entries
-    end
-
-    def read_entry(entry)
-      title           = entry.elements["title"].text
-      author          = entry.elements["author"].elements["name"].text
-      author          = to_hankaku(author)
-      summary         = entry.elements["summary"].text
-      journal         = entry.elements["rm:journal"].text
-      publisher       = entry.elements["rm:publisher"].text
-      publicationName = entry.elements["rm:publicationName"].text
-      volume          = entry.elements["rm:volume"].text
-      number          = entry.elements["rm:number"].text
-      startingPage    = entry.elements["rm:startingPage"].text
-      endingPage      = entry.elements["rm:endingPage"].text
-      publicationDate = entry.elements["rm:publicationDate"].text
-      referee         = entry.elements["rm:referee"] ? true : false
-      language        = entry.elements["rm:language"].text
-      paperType       = entry.elements["rm:paperType"].elements["id"].text
-        
-      Entry.new(
-        title, author, summary, journal, publisher, publicationName,
-        volume, number, startingPage, endingPage, publicationDate,
-        referee, language, paperType,
-      )
-    end
-
-#     0:未設定、1:研究論文(学術雑誌)、2:研究論文(国際会議プロシーディングス)、3:研究論文(大学,研究機関紀要)
-# 、
-# 4:研究論文(研究会,シンポジウム資料等)、5:研究論文(その他学術会議資料等)
-    def write_bibliography_entry(entry)
-      key = generate_key(entry.author, entry.publicationDate)
-      year, month = year_month(entry.publicationDate)
-      month = month.to_i
-      case entry.paperType.to_i
-      when 1, 3 then
-        record = <<EOS
-@Article{<%= key %>,
-  author = 	 {<%= entry.author %>},
-  title = 	 {<%= entry.title %>},
-  journal = 	 {<%= entry.journal %>},
-EOS
-        record += '  year      = <%= year %>'
-        if month > 0
-          record += ",\n  month     = <%= month %>"
-        end
-        if entry.volume
-          record += ",\n  volume    = <%= entry.volume %>"
-        end
-        if entry.number
-          record += ",\n  number    = <%= entry.number %>"
-        end
-        if entry.startingPage && entry.endingPage
-          record += ",\n  pages     = <%= entry.startingPage %>-<%= entry.endingPage %>"
-        elsif entry.startingPage
-          record += ",\n  pages     = <%= entry.startingPage %> %>"
-        end
-        record += "}\n"
-        if entry.summary
-          record += "% <%= entry.summary %>\n"
-        end
-      else
-        record = <<EOS
-@InProceedings{<%= key %>,
-  author    = {<%= entry.author %>},
-  title     = {<%= entry.title %>},
-  booktitle = {<%= entry.journal %>},
-EOS
-        record += '  year      = <%= year %>'
-        if month > 0
-          record += ",\n  month     = <%= month %>"
-        end
-        if entry.volume
-          record += ",\n  volume    = <%= entry.volume %>"
-        end
-        if entry.number
-          record += ",\n  number    = <%= entry.number %>"
-        end
-        if entry.startingPage && entry.endingPage
-          record += ",\n  pages     = <%= entry.startingPage %>-<%= entry.endingPage %>"
-        elsif entry.startingPage
-          record += ",\n  pages     = <%= entry.startingPage %> %>"
-        end
-        if entry.publisher
-          record += ",\n  publisher = {<%= entry.publisher %>}"
-        end
-        record += "}\n"
-        if entry.summary
-          record += "% <%= entry.summary %>\n"
-        end
-      end
-      erb = ERB.new(record)
-      erb.result(binding)
-    end
-
-    def to_hankaku(str)
-      str.tr('０-９ａ-ｚＡ-Ｚ，、　', '0-9a-zA-Z,, ')
-    end
-
-    def year_month(date)
-      /([0-9]{4})([0-9]{2})/.match(date).captures
-    end
-    
-    def concatenate_authors(authors)
-      authors.gsub(/ *, */, ' and ')
-    end
-
-    def first_author(authors)
-      r = /([^,]*)/.match(authors)
-      r == nil ? authors.strip : r.captures[0].strip
-    end
-
-    def family_name(author)
-      if /(^\w*) *(\w*)$/ =~ author
-        $2
-      elsif /(^\S*) *(\S*)$/ =~ author
-        $1
-      else
-        author
-      end
-    end
-
-    def generate_key(authors, date)
-      first_author = first_author(authors)
-      name = family_name(first_author)
-      year, month = year_month(date)
-      year = /[0-9][0-9]([0-9][0-9])/.match(year).captures[0]
-      if month.to_i >0
-        name + year + month
-      else
-        name + year
-      end
-    end
-  end
 end

data/lib/researchmap2bib/cli.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+require 'thor'
+
+module Researchmap2bib
+  class CLI < Thor
+    desc "generate ZIP_FILE", "researchmapの業績からbibliographyを作成"
+    def generate(file_name)
+      @s = Researchmap2bib::Generator.new
+      @s.generate(file_name)
+    end
+
+    desc "version", "バージョンを表示"
+    def version
+      puts "researchmap2bib version #{::Researchmap2bib::VERSION}"
+    end
+  end
+end

data/lib/researchmap2bib/generator.rb

@@ -0,0 +1,177 @@
+# coding: utf-8
+require 'researchmap2bib/utils'
+require 'researchmap2bib/unique_id'
+
+require 'pp'
+require 'zip'
+require 'rexml/document'
+require 'erb'
+
+module Researchmap2bib
+  class Generator
+    include Utils
+    include UniqueId
+
+    def generate(file_name)
+      bibliography =  make_bibliography(file_name)
+
+      base_name = File.basename(file_name, '.zip')
+      File.write(base_name + '.bib', bibliography)
+
+      ids = list_up_id
+      template = <<EOS
+\\documentclass[uplatex]{jsarticle}
+\\begin{document}
+文献\\cite{<%= ids.join(',') %>}
+\\bibliographystyle{junsrt}
+\\bibliography{<%= base_name %>}
+\\end{document}
+EOS
+      erb = ERB.new(template)
+      sample = erb.result(binding)
+      File.write('sample.tex', sample)
+    end
+
+    def list_up_id
+      ids = Array.new
+      @entries.each do |entry|
+        ids.push(entry.id)
+      end
+      ids
+    end
+
+    def make_bibliography(file_name)
+      @entries = read_researchmap(file_name)
+
+      results = Array.new
+      @entries.each do |entry|
+        results.push(make_bibliography_entry(entry))
+      end
+
+      results.join("\n")
+    end
+    
+    def read_researchmap(file_name)
+      entries = Zip::File.open(file_name) do |zip_file|
+        entry = zip_file.glob('*\/paper.xml').first
+        read_paper(entry.get_input_stream.read)
+      end
+    end
+
+    def read_paper(xml)
+      doc = REXML::Document.new(xml)
+      entries = Array.new
+      REXML::XPath.each(doc, '/feed/entry') do |entry|
+        entries.push(read_entry(entry))
+      end
+      entries
+    end
+
+    def read_entry(entry)
+      title           = entry.elements["title"].text
+      author          = entry.elements["author"].elements["name"].text
+      author          = to_hankaku(author)
+      summary         = entry.elements["summary"].text
+      journal         = entry.elements["rm:journal"].text
+      publisher       = entry.elements["rm:publisher"].text
+      publicationName = entry.elements["rm:publicationName"].text
+      volume          = entry.elements["rm:volume"].text
+      number          = entry.elements["rm:number"].text
+      startingPage    = entry.elements["rm:startingPage"].text
+      endingPage      = entry.elements["rm:endingPage"].text
+      publicationDate = entry.elements["rm:publicationDate"].text
+      referee         = entry.elements["rm:referee"] ? true : false
+      language        = entry.elements["rm:language"].text
+      paperType       = entry.elements["rm:paperType"].elements["id"].text
+
+      key = generate_key(author, publicationDate)
+      id = unique_id(key)
+
+      Entry.new(
+        id, # id
+        title, author, summary, journal, publisher, publicationName,
+        volume, number, startingPage, endingPage, publicationDate,
+        referee, language, paperType,
+      )
+    end
+
+    # 0:未設定、1:研究論文(学術雑誌)、2:研究論文(国際会議プロシーディングス)、
+    # 3:研究論文(大学,研究機関紀要)、
+    # 4:研究論文(研究会,シンポジウム資料等)、5:研究論文(その他学術会議資料等)
+    def make_bibliography_entry(entry)
+      year, month = year_month(entry.publicationDate)
+      month = month.to_i
+      case entry.paperType.to_i
+      when 1, 3 then
+        record = <<EOS
+@Article{<%= entry.id %>,
+  author  = {<%= entry.author %>},
+  title   = {<%= entry.title %>},
+  journal = {<%= entry.journal %>},
+EOS
+        record += '  year    = <%= year %>'
+        if month > 0
+           record += ",\n  month   = <%= month %>"
+        end
+        if entry.volume
+          record += ",\n  volume    = <%= entry.volume %>"
+        end
+        if entry.number
+          record += ",\n  number    = <%= entry.number %>"
+        end
+        if entry.startingPage && entry.endingPage
+          record += ",\n  pages     = {<%= entry.startingPage %>-<%= entry.endingPage %>}"
+        elsif entry.startingPage
+          record += ",\n  pages     = {<%= entry.startingPage %> %>}"
+        end
+        record += "}\n"
+        if entry.summary
+          record += "% <%= entry.summary %>\n"
+        end
+      else
+        record = <<EOS
+@InProceedings{<%= entry.id %>,
+  author    = {<%= entry.author %>},
+  title     = {<%= entry.title %>},
+  booktitle = {<%= entry.journal %>},
+EOS
+        record += '  year      = <%= year %>'
+        if month > 0
+          record += ",\n  month     = <%= month %>"
+        end
+        if entry.volume
+          record += ",\n  volume    = <%= entry.volume %>"
+        end
+        if entry.number
+          record += ",\n  number    = <%= entry.number %>"
+        end
+        if entry.startingPage && entry.endingPage
+          record += ",\n  pages     = {<%= entry.startingPage %>-<%= entry.endingPage %>}"
+        elsif entry.startingPage
+          record += ",\n  pages     = {<%= entry.startingPage %>}"
+        end
+        if entry.publisher
+          record += ",\n  publisher = {<%= entry.publisher %>}"
+        end
+        record += "}\n"
+        if entry.summary
+          record += "% <%= entry.summary %>\n"
+        end
+      end
+      erb = ERB.new(record)
+      erb.result(binding)
+    end
+
+    def generate_key(authors, date)
+      first_author = first_author(authors)
+      name = family_name(first_author)
+      year, month = year_month(date)
+      year = /[0-9][0-9]([0-9][0-9])/.match(year).captures[0]
+      if month.to_i >0
+        name + year + month
+      else
+        name + year
+      end
+    end
+  end
+end

data/lib/researchmap2bib/unique_id.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+module Researchmap2bib
+  module UniqueId
+    @@id_to_entry = Hash.new
+
+    def unique_id(key)
+      if @@id_to_entry[key]
+        i = 2
+        begin
+          new_key = key + ':' + i.to_s
+          i += 1
+        end while @@id_to_entry[new_key]
+        @@id_to_entry[new_key] = true
+        return new_key
+      else
+        @@id_to_entry[key] = true
+        return key
+      end
+    end
+  end
+end

data/lib/researchmap2bib/utils.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+module Researchmap2bib
+  module Utils
+    def to_hankaku(str)
+      str.tr('０-９ａ-ｚＡ-Ｚ，、　', '0-9a-zA-Z,, ')
+    end
+
+    def year_month(date)
+      /([0-9]{4})([0-9]{2})/.match(date).captures
+    end
+
+    def concatenate_authors(authors)
+      authors.gsub(/ *, */, ' and ')
+    end
+
+    def first_author(authors)
+      r = /([^,]*)/.match(authors)
+      r == nil ? authors.strip : r.captures[0].strip
+    end
+
+    def family_name(author)
+      if /(^\w*) +(\w*)$/ =~ author
+        $2
+      elsif /(^\S*) +(\S*)$/ =~ author
+        $1
+      else
+        author
+      end
+    end
+  end
+end

data/lib/researchmap2bib/version.rb

@@ -1,3 +1,3 @@
 module Researchmap2bib
-  VERSION = "0.2.2"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: researchmap2bib
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.2
 platform: ruby
 authors:
 - Yoshihide Chubachi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: This script creates bibliography files which can be used by LaTeX from
@@ -131,8 +131,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -141,7 +141,12 @@ files:
 - bin/console
 - bin/setup
 - exe/researchmap2bib
+- latexmkrc
 - lib/researchmap2bib.rb
+- lib/researchmap2bib/cli.rb
+- lib/researchmap2bib/generator.rb
+- lib/researchmap2bib/unique_id.rb
+- lib/researchmap2bib/utils.rb
 - lib/researchmap2bib/version.rb
 - researchmap2bib.gemspec
 homepage: https://github.com/ychubachi/researchmap2bib
@@ -154,17 +159,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Create LaTeX bibliography files from the XML exported file form researchmap.