citation 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 8a8c7aa9c394ffdb644be48a0fa90776834eda38
4
+ data.tar.gz: 22e186c3ff80d1669d407c27f81abea2b2b431d4
5
+ SHA512:
6
+ metadata.gz: d9b83c79fc97e7357c234f349f05a9be5d6e17c471503be84ebd80378cc22bfec466efdf43875391c167b7b55479990dc6decf758a9337b1060d973b0e0c94ae
7
+ data.tar.gz: 700489a43b29ddcc4726d1eab6c351c3deff177b3baebf7dd629a44c26d868c98998f3e966d1cf106088156fd7fb349d02eea536e9b62931f6d6b3b4eec73ce9
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ vendor
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.2.3
5
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at takahiro_nishimura@r.recruit.co.jp. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in citation.gemspec
4
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Takahiro Nishimura
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Takahiro Nishimura
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # Citation
2
+
3
+ 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/citation`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'citation'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install citation
22
+
23
+ ## Usage
24
+
25
+ ### Command line
26
+ `cite instr \<citation string\> `
27
+
28
+ ### in Ruby code
29
+
30
+ ```
31
+ require 'citation/citation'
32
+ citation = Citation.parse(citation string in paper)
33
+
34
+ citation.out('bibtex') #=> Convert bibtex format
35
+ citation.out('MLA') #=> Convert MLA format
36
+ citation.out('APA') #=> Convert APA format
37
+ citation.out('ISO') #=> Convert ISO 690 format
38
+
39
+ ```
40
+
41
+ ## Development
42
+
43
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
44
+
45
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
46
+
47
+ ## Contributing
48
+
49
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/citation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
50
+
51
+
52
+ ## License
53
+
54
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
55
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "citation"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/citation.gemspec ADDED
@@ -0,0 +1,34 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'citation/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "citation"
8
+ spec.version = Citation::VERSION
9
+ spec.authors = ["Takahiro Nishimura"]
10
+ spec.email = ["tkhr.nishimura@gmail.com"]
11
+
12
+ spec.summary = %q{Parse citation in paper}
13
+ spec.description = %q{For fetching citation list in paper, it is very exhausted process; open pdf file, scroll page harder, copy and paste google scholar. This gem library is specify to parse flat-citation list to strucutured format such as BiBTex to easy to refer to your paper, survey paper and so on. }
14
+ spec.homepage = "https://github.com/nishimuuu/citation"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ if spec.respond_to?(:metadata)
20
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
21
+ else
22
+ raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_development_dependency "bundler", "~> 1.12"
31
+ spec.add_development_dependency "rake", "~> 10.0"
32
+ spec.add_development_dependency "rspec", "~> 3.0"
33
+ spec.add_dependency 'thor', '~> 0.19'
34
+ end
data/exe/cite ADDED
@@ -0,0 +1,5 @@
1
+ require 'pathname'
2
+ lib = Pathname.new(__FILE__).dirname.join('..', 'lib').expand_path.to_s
3
+ $:.unshift lib
4
+ require 'citation'
5
+ EntryPoint::CLI.start
@@ -0,0 +1,147 @@
1
+ require 'pathname'
2
+ lib = Pathname.new(__FILE__).dirname.join().expand_path.to_s
3
+ $:.unshift lib
4
+ require 'uri'
5
+ require 'time'
6
+
7
+ module Citation
8
+ class Base
9
+ attr_accessor :year, :sq, :desc, :url, :author, :title, :type
10
+ def initialize
11
+ @year = ''
12
+ @sq = ''
13
+ @url = ''
14
+ @desc = ''
15
+ @author = ''
16
+ @title = ''
17
+ @type = ''
18
+ end
19
+
20
+ def puts
21
+ return {year: @year, sq: @sq, desc: @desc, author: @author, title: @title, type: @type}
22
+ end
23
+
24
+ def out(format)
25
+ str = ''
26
+ case format.downcase
27
+ when 'MLA'
28
+ str = "#{@author} \"#{@title}\" #{@desc} (#{@year})"
29
+ when 'APA'
30
+ str = "#{@author} (#{@year}) #{@title} #{@desc}"
31
+ when 'ISO'
32
+ str = "#{@author} #{@title} #{@desc}, #{@year}."
33
+ when 'bibtex'
34
+
35
+ str = "@article{#{@author.gsub(' ','').gsub(/( |\.|,)/,'').downcase[0..5]}#{@year}#{@title.split.select{|i| i.length >3 }[0].downcase},
36
+ title={#{@title}},
37
+ author={#{@author.gsub(', and ',', ')}},
38
+ year={#{@year}},
39
+ journal={#{@desc}}
40
+ }"
41
+ end
42
+ str
43
+ end
44
+ end
45
+
46
+ def self.parse(str, recursive=false)
47
+ base = Base.new
48
+ string = str.dup
49
+ urls = URI.extract(string, %w(http https))
50
+ urls.each do | url |
51
+ string.slice!(url)
52
+ end
53
+ base.url = urls
54
+
55
+ # fetch square bracket
56
+ bracket_matcher = string.match(/\[([\w\d_ ]).+\]/)
57
+ base.sq = bracket_matcher[0] unless bracket_matcher.nil?
58
+ string.slice!(base.sq)
59
+
60
+ # fetch year
61
+ year_matcher = string.scan(/\d{4}/)
62
+ base.year = year_matcher.
63
+ map(&:to_i).
64
+ select{|i| i > 1970 and i < Time.now.year}.
65
+ shift.to_s unless year_matcher.nil?
66
+ string.slice!(base.year)
67
+
68
+ # fetch title if format is MLA
69
+ title_matcher = string.match(/".+"/)
70
+ unless title_matcher.nil?
71
+ base.title = title_matcher[0] unless title_matcher.nil?
72
+ s = string.split(base.title)
73
+ string.slice!(base.title)
74
+ string.slice!('()')
75
+ base.title.gsub!('"','')
76
+
77
+ author = s.shift
78
+ base.author = author
79
+ base.desc = s.shift
80
+ base.type = 'MLA'.to_sym
81
+
82
+ string.slice!(base.author)
83
+ string.slice!(base.desc)
84
+ end
85
+
86
+ # fetch title if format is APA
87
+ title_matcher = string.match(/\(\)\. .+\. /)
88
+ if base.type.empty? and not title_matcher.nil?
89
+ base.title = title_matcher[0] unless title_matcher.nil?
90
+ base.title.gsub!(/"|\(\)\. /,'')
91
+
92
+ string.slice!(base.title)
93
+ s = string.split('(). ')
94
+ author = s.shift
95
+ base.author = author
96
+ base.desc = s.shift
97
+ base.type = 'APA'.to_sym
98
+ string.slice!(base.author)
99
+ string.slice!(base.desc)
100
+ end
101
+
102
+
103
+ # fetch title if format is ISO 690
104
+ iso_matcher = string.match(/, \.$/)
105
+ if base.type.empty? and not iso_matcher.nil?
106
+ s = string.gsub(/ ([A-Z]). /,'_\1_ ')
107
+ arr = s.split('. ')
108
+ base.author = arr.shift.gsub(/_([A-Z])_ /,' \1. ')
109
+ base.title = arr.shift if base.title == ''
110
+ base.desc = arr.shift
111
+ base.type = 'ISO 6900'.to_sym
112
+ end
113
+
114
+
115
+ # fetch other
116
+ if base.type.empty?
117
+ s = string.gsub(/ ([A-Z]). /,'_\1_ ')
118
+ arr = s.split('. ')
119
+ base.author = arr.shift.gsub(/_([A-Z])_ /,' \1. ')
120
+ base.title = arr.shift if base.title == ''
121
+ base.desc = arr
122
+ end
123
+ return base
124
+
125
+ end
126
+
127
+ end
128
+
129
+ if __FILE__ == $0
130
+ test = '[B ́at09] Norbert B ́atfai. On the Running Time of the Shortest Programs. CoRR, abs/0908.1159, 2009. http://arxiv.org/abs/0908.1159.'
131
+ puts Citation.parse(test, false)
132
+ # MLA
133
+ test = 'Bátfai, Norbert. "A disembodied developmental robotic agent called Samu B\'atfai." arXiv preprint arXiv:1511.02889 (2015).'
134
+ puts Citation.parse(test, false)
135
+
136
+ # APA
137
+ test = 'Bátfai, N. (2015). A disembodied developmental robotic agent called Samu B\'atfai. arXiv preprint arXiv:1511.02889.'
138
+ puts Citation.parse(test, false)
139
+
140
+ # ISO 690
141
+ test = 'BÁTFAI, Norbert. A disembodied developmental robotic agent called Samu B\'atfai. arXiv preprint arXiv:1511.02889, 2015.'
142
+ puts Citation.parse(test, false)
143
+ test = 'MacKay, D. J. C., & Peto, L. C. B. (1995). A hierarchical Dirichlet language model. Natural Language Engineer- ing, 1, 289–307.'
144
+ puts Citation.parse(test, false)
145
+ test = '[20] Y. Teh, M. Jordan, M. Beal, and D. Blei. Hierarchical Dirichlet processes. Journal of the American Statistical Association, 101(476):1566–1581, 2007.'
146
+ puts Citation.parse(test,false).out('bibtex')
147
+ end
@@ -0,0 +1,22 @@
1
+ # coding: utf-8
2
+ #
3
+
4
+ require 'thor'
5
+ require 'pathname'
6
+ lib = Pathname.new(__FILE__).dirname.join().expand_path.to_s
7
+ $:.unshift lib
8
+ require 'citation'
9
+ require 'json'
10
+
11
+ module EntryPoint
12
+ class CLI < Thor
13
+ include Citation
14
+ class_option 'f', type: :string, aliases: 'Output format', desc: 'Set outputformat(default: "bibtex")', default: 'bibtex'
15
+ class_option 'r', type: :boolean, aliases: 'Recursive', desc: 'Turn on recursive mode(default: false)' , default: false
16
+
17
+ desc 'instr', 'set citation string'
18
+ def instr(s)
19
+ puts Citation.parse(s, options[:r]).out(options[:f])
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,3 @@
1
+ module Citation
2
+ VERSION = "0.1.0"
3
+ end
data/lib/citation.rb ADDED
@@ -0,0 +1,10 @@
1
+ require "citation/version"
2
+ require 'pathname'
3
+ lib = Pathname.new(__FILE__).dirname.join().expand_path.to_s
4
+ $:.unshift lib
5
+
6
+ require 'citation/version'
7
+ require 'citation/entrypoint'
8
+ module Citation
9
+ # Your code goes here...
10
+ end
metadata ADDED
@@ -0,0 +1,122 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: citation
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Takahiro Nishimura
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-06-11 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: thor
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.19'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.19'
69
+ description: 'For fetching citation list in paper, it is very exhausted process; open
70
+ pdf file, scroll page harder, copy and paste google scholar. This gem library is
71
+ specify to parse flat-citation list to strucutured format such as BiBTex to easy
72
+ to refer to your paper, survey paper and so on. '
73
+ email:
74
+ - tkhr.nishimura@gmail.com
75
+ executables:
76
+ - cite
77
+ extensions: []
78
+ extra_rdoc_files: []
79
+ files:
80
+ - ".gitignore"
81
+ - ".rspec"
82
+ - ".travis.yml"
83
+ - CODE_OF_CONDUCT.md
84
+ - Gemfile
85
+ - LICENSE
86
+ - LICENSE.txt
87
+ - README.md
88
+ - Rakefile
89
+ - bin/console
90
+ - bin/setup
91
+ - citation.gemspec
92
+ - exe/cite
93
+ - lib/citation.rb
94
+ - lib/citation/citation.rb
95
+ - lib/citation/entrypoint.rb
96
+ - lib/citation/version.rb
97
+ homepage: https://github.com/nishimuuu/citation
98
+ licenses:
99
+ - MIT
100
+ metadata:
101
+ allowed_push_host: https://rubygems.org
102
+ post_install_message:
103
+ rdoc_options: []
104
+ require_paths:
105
+ - lib
106
+ required_ruby_version: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ required_rubygems_version: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - ">="
114
+ - !ruby/object:Gem::Version
115
+ version: '0'
116
+ requirements: []
117
+ rubyforge_project:
118
+ rubygems_version: 2.4.5.1
119
+ signing_key:
120
+ specification_version: 4
121
+ summary: Parse citation in paper
122
+ test_files: []