RefParsers

Parser for various types of reference file formats. It currently supports RefMan (.ris), EndNote (.enw) and PubMed Summary (.nbib)

Installation

Add this line to your application's Gemfile:

gem 'ref_parsers'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ref_parsers

Usage

# creates a new parser of type RIS
parser = RefParsers::RISParser.new

# creates a new parser of type EndNote
parser = RefParsers::EndNoteParser.new

# opens filename and parses it
parser.open(filename)

# parses a string containing the reference source
parser.parse(string)

The parse method returns an array of entries, each is a Hash of fields -> values. For formats that enable multiline values, the parser will merge these lines in a single line separating them with an amount of spaces defined in RefParsers::NEWLINE_MERGER. This allows the value to be displayed normally in HTML elements because multiple spaces are collapsed, and also allows you to split back the lines, if needed. Example:

parser.parse(string).each do |entry|
  article['KW'].split(/#{RefParsers::NEWLINE_MERGER}/)
end

Development and Testing

To build for local development and testing (requires Docker):

docker build . -t ref_parsers:1

To run the tests:

docker run -it --rm -v $PWD:/home ref_parsers:1

This will allow you to edit files and re-run the tests without rebuilding the image.

Publishing the gem

docker build . -t ref_parsers:1
docker run -it --rm ref_parsers:1 /home/publish.sh

Enter your email and password when prompted. If you want to skip interactive login, supply RUBYGEMS_API_KEY as an additional argument:

docker run -it --rm -e RUBYGEMS_API_KEY=YOUR_RUBYGEMS_API_KEY ref_parsers:1 /home/publish.sh

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request