citeproc-ruby 0.0.6 → 1.0.0

data/BSDL

@@ -0,0 +1,29 @@
+CiteProc-Ruby. A Ruby CSL cite processor.
+
+Copyright 2012 President and Fellows of Harvard College.
+Copyright 2009-2014 Sylvester Keil. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are
+those of the authors and should not be interpreted as representing official
+policies, either expressed or implied, of the copyright holder.

data/Gemfile

@@ -0,0 +1,42 @@
+source 'https://rubygems.org'
+gemspec
+
+#gem 'citeproc', :github => 'inukshuk/citeproc.git'
+#gem 'csl', :github => 'inukshuk/csl-ruby.git'
+
+group :development, :test do
+  gem 'rake', '~>10.0'
+  gem 'rspec', '~>2.13'
+  gem 'cucumber', '~>1.2'
+  gem 'simplecov', '~>0.8'
+  gem 'rubinius-coverage', :platforms => [:rbx]
+  gem 'coveralls', :require => false
+end
+
+group :debug do
+  gem 'ruby-debug', :require => false, :platforms => [:jruby]
+  gem 'debugger', :require => false, :platforms => [:mri]
+  gem 'rubinius-debugger', :require => false, :platforms => [:rbx]
+  gem 'rubinius-compiler', :require => false, :platforms => [:rbx]
+end
+
+group :optional do
+	gem 'edtf'
+	gem 'chronic'
+end
+
+group :extra do
+  gem 'guard', '~>2.2'
+  gem 'guard-rspec'
+  gem 'guard-cucumber'
+  gem 'rb-fsevent', '~>0.9.1'
+  gem 'pry'
+	gem 'yard', '~>0.8', :platforms => [:mri]
+	gem 'redcarpet', '~>3.0', :platforms => [:mri]
+end
+
+platform :rbx do
+  gem 'rubysl'
+  gem 'racc'
+  gem 'json'
+end

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/README.md

@@ -1,92 +1,48 @@
 CiteProc-Ruby
 =============
+CiteProc-Ruby is a [Citation Style Language](http://citationstyles.org/) (CSL)
+1.0.1 cite processor written in pure Ruby. This Ruby gem contains the
+processor's rendering engine only; for more documentation on the whole
+cite processor, please refer to the documentation of the
+[citeproc](https://rubygems.org/gems/citeproc) gem instead.
 
-CiteProc-Ruby is a CSL 1.0 ([Citation Style Language](http://citationstyles.org/))
-Processor written in Ruby.
+[![Build Status](https://secure.travis-ci.org/inukshuk/citeproc-ruby.png)](http://travis-ci.org/inukshuk/citeproc-ruby)
+[![Coverage Status](https://coveralls.io/repos/inukshuk/citeproc-ruby/badge.png?branch=master)](https://coveralls.io/r/inukshuk/citeproc-ruby?branch=master)
+[![Dependency Status](https://gemnasium.com/inukshuk/citeproc-ruby.png)](https://gemnasium.com/inukshuk/citeproc-ruby)
 
-A word of caution: this release of CiteProc-Ruby is purely experimental; the API
-is not complete and liable to change frequently. This release is expected to
-work in Ruby version 1.9.2. only. CiteProc-Ruby currently passes approximately
-350 of the 550 tests in the citeproc-test suite.
+Development
+-----------
+The CiteProc-Ruby source code is
+[hosted on GitHub](https://github.com/inukshuk/citeproc-ruby).
+You can check out a copy of the latest code using Git:
 
-Note: the citeproc-ruby gem is going to be integrated with the separate `citeproc`
-and `citeproc-js` gems; meanwhile, however, these gems are not compatible, so if
-you want to use the current `citeproc-ruby` gem, make sure that neither of the
-other gems is installed.
+    $ git clone https://github.com/inukshuk/citeproc-ruby.git
 
-Unicode support may be provided by the `unicode-utils` gem (on Ruby 1.9 only),
-by ActiveSupport, by the `unicode` gem (on Ruby 1.8 only), by the Java-based
-support in JRuby, or naively by the `upcase` and `downcase` methods present
-in Ruby by default.  These gems are not installed automatically; install one
-manually if you want enhanced Unicode support.
+To get started, install the development dependencies and run all tests:
 
+    $ cd citeproc-ruby
+    $ bundle install
+    $ rake
 
-Quickstart
-----------
-
-		$ [sudo] gem install citeproc-ruby
-		$ [sudo] gem install unicode-utils # Ruby 1.9
-		$ [sudo] gem install unicode # Ruby 1.8
-		$ irb
-		>> require 'citeproc'
-		>> book = {
-			'author' => [{ 'given' => 'Edgar Allen', 'family' => 'Poe' }],
-			'title' => 'Poetry, Tales, and Selected Essays',
-			'type' => 'book',
-			'issued' => { 'date-parts' => [[1996]] },
-			'editor' => [{ 'family' => 'Quinn', 'given' => 'Patrick F.'}, { 'family' => 'Thompson', 'given' => 'G.R.' }],
-			'publisher' => 'Library of America',
-			'publisher-place' => 'New York'
-		}
-		>> CiteProc.process(book)
-		=> "Poe, E. A. (1996). Poetry, Tales, and Selected Essays.  (P. F. Quinn & G. R. Thompson, Eds.). New York: Library of America."
-		>> CiteProc.process(book, :format => :html)
-		=> "Poe, E. A. (1996). <i>Poetry, Tales, and Selected Essays</i>.  (P. F. Quinn &#38; G. R. Thompson, Eds.). New York: Library of America."
-		>> CiteProc.process(book, :mode => :citation)
-		=> ["(Poe, 1996)"]
-		>> CiteProc.process(book, :style => "https://github.com/citation-style-language/styles/raw/master/chicago-author-date.csl")
-		=> "Poe, Edgar Allen. 1996. Poetry, Tales, and Selected Essays. Ed. Patrick F. Quinn and G.R. Thompson. New York: Library of America."
-
-
-The RSpec examples are a valuable resource of usage examples.
-
+If you've found a bug or have a question, please open an issue on the
+[issue tracker](https://github.com/inukshuk/citeproc-ruby/issues).
+Or, for extra credit, clone the CiteProc-Ruby repository, write a failing
+example, fix the bug and submit a pull request.
 
 Credits
 -------
+Thanks to Rintze M. Zelle, Sebastian Karcher, Frank G. Bennett, Jr.,
+and Bruce D'Arcus of CSL and citeproc-js fame for their support!
+
+Thanks to Google and the Berkman Center at Harvard University for supporting
+this project as part of [Google Summer of Code](https://developers.google.com/open-source/soc/).
 
-CiteProc-Ruby was written by [Sylvester Keil](http://sylvester.keil.or.at);
-thanks to the excellent documentation and specifications of the
-[CSL](http://citationstyles.org), [citeproc-js](http://bitbucket.org/fbennett/citeproc-js/wiki/Home),
-the [citeproc-test suite](https://bitbucket.org/bdarcus/citeproc-test), and the
-kind feedback and support at the [xbiblio mailing list](http://sourceforge.net/mail/?group_id=117435).
+Copyright
+---------
+Copyright 2009-2014 Sylvester Keil. All rights reserved.
 
+Copyright 2012 President and Fellows of Harvard College.
 
 License
 -------
-
-Copyright 2009-2011 Sylvester Keil. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
- 1. Redistributions of source code must retain the above copyright notice,
-    this list of conditions and the following disclaimer.
-
- 2. Redistributions in binary form must reproduce the above copyright notice,
-    this list of conditions and the following disclaimer in the documentation
-    and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
-EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
-EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-The views and conclusions contained in the software and documentation are
-those of the authors and should not be interpreted as representing official
-policies, either expressed or implied, of the copyright holder.
+CiteProc-Ruby is dual licensed under the AGPL and the FreeBSD license.

data/Rakefile

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'bundler'
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), './lib'))
+require 'citeproc/ruby/version'
+
+
+desc 'Run a Pry session with CiteProc-Ruby loaded'
+task :console do
+  require 'pry'
+  require 'citeproc/ruby'
+
+  Pry.start
+end
+
+task :check_warnings do
+  $VERBOSE = true
+  require 'citeproc/ruby'
+
+  puts CiteProc::Ruby::VERSION
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.profile = 'default'
+end
+
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+task :test_with_coveralls => [:spec, :cucumber, 'coveralls:push']
+
+task :release do |t|
+  system "gem build citeproc-ruby.gemspec"
+  system "git tag #{CiteProc::Ruby::VERSION}"
+  system "git push --tags"
+  system "gem push citeproc-ruby-#{CiteProc::Ruby::VERSION}.gem"
+end
+
+task :default => [:spec, :cucumber]
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError => e
+  # ignore
+end

data/citeproc-ruby.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'citeproc/ruby/version'
+
+EXCLUDES = %w{
+  .coveralls.yml
+  .gitignore
+  .travis.yml
+  citeproc-ruby.gemspec
+}
+
+Gem::Specification.new do |s|
+  s.name        = 'citeproc-ruby'
+  s.version     = CiteProc::Ruby::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+
+  s.authors     = ['Sylvester Keil']
+  s.email       = ['http://sylvester.keil.or.at']
+
+  s.homepage    = 'https://github.com/inukshuk/citeproc-ruby'
+  s.summary     = 'A Citation Style Language (CSL) cite processor'
+  s.description =
+		"""
+    CiteProc-Ruby is a Citation Style Language (CSL) 1.0.1 compatible cite
+    processor implementation written in pure Ruby.
+		""".gsub(/^\s+/, '')
+
+  s.license     = 'AGPL'
+  s.date        = Time.now.strftime('%Y-%m-%d')
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'citeproc', '~> 1.0'
+  s.add_dependency 'csl', '~> 1.2'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables  = []
+  s.require_path = 'lib'
+
+  s.has_rdoc      = 'yard'
+end
+
+# vim: syntax=ruby

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress --require features --color

data/features/bibliography.feature

@@ -0,0 +1,25 @@
+Feature: Rendering bibliography nodes
+  As a hacker of cite processors
+  I want to render citation items
+  Using bibliography nodes
+
+  Scenario: Rendering APA style bibliographies as text
+    Given the "apa" style's bibliography node
+    When I render the following citation items as "text":
+      | type            | author           | title                 | issued           | publisher             | container-title     | page   | issue |
+      | book            | Thomas Pynchon   | The crying of lot 49  | November 7, 2006 | Harper Perennial      |                     |        |       |
+      | article-journal | Derrida, Jacques | The purveyor of truth | 1975             | Yale University Press | Yale French Studies | 31-113 | 52    |
+    Then the results should be:
+      | Pynchon, T. (2006). The crying of lot 49. Harper Perennial. |
+      | Derrida, J. (1975). The purveyor of truth. Yale French Studies, (52), 31–113. |
+
+  Scenario: Rendering APA style bibliographies as HTML
+    Given the "apa" style's bibliography node
+    When I render the following citation item as "html":
+      | type            | book             |
+      | author          | Vladimir Nabokov |
+      | title           | Pale fire        |
+      | issued          | April 23, 1989   |
+      | publisher       | Vintage          |
+      | publisher-place | London           |
+    Then the result should be: Nabokov, V. (1989). <i>Pale fire</i>. London: Vintage.

data/features/name_options.feature

@@ -0,0 +1,37 @@
+Feature: Inheritance of Name Options
+  As a style author
+  I want name nodes to inherit attributes
+  From the citation/bibliography and style nodes
+
+  Scenario: Name options from bibliography node
+    Given the following style node:
+      """
+      <bibliography name-form="short">
+        <layout>
+          <names variable="author">
+            <name />
+          </names>
+        </layout>
+      </bibliography>
+      """
+    When I render the following citation items as "html":
+      | author                  |
+      | John Doe                |
+    Then the results should be:
+      | Doe                     |
+
+    Given the following style node:
+      """
+      <bibliography name-form="short">
+        <layout>
+          <names variable="author"/>
+          <!--it works without a name node-->
+        </layout>
+      </bibliography>
+      """
+    When I render the following citation items as "html":
+      | author                  |
+      | John Doe                |
+    Then the results should be:
+      | Doe                     |
+

data/features/names.feature

@@ -0,0 +1,192 @@
+Feature: CSL Name Rendering
+  As a CSL hacker
+  I want to render names
+  Using names nodes
+
+  Scenario: Names Rendering
+    Given the following style node:
+      """
+      <names variable="translator" delimiter=", " prefix="(" suffix=")">
+        <name and="symbol" delimiter=", "/>
+        <label form="short" prefix=", " text-case="capitalize-first" suffix=""/>
+      </names>
+      """
+    When I render the following citation items as "text":
+      | translator                       |
+      | Romy Schneider and Peter Sellers |
+    Then the results should be:
+      | (Romy Schneider & Peter Sellers, Trans.) |
+
+
+  Scenario: Initials
+    Given the following style node:
+      """
+      <names variable="translator author" delimiter=", " prefix="(" suffix=")">
+        <name and="symbol" delimiter=", " initialize-with=". "/>
+        <label form="short" prefix=", " text-case="capitalize-first" suffix=""/>
+      </names>
+      """
+    When I render the following citation items as "text":
+      | translator                       | author  |
+      | Romy Schneider and Peter Sellers |         |
+    Then the results should be:
+      | (R. Schneider & P. Sellers, Trans.) |
+
+  Scenario: Initials when given part is uppercased
+    Given the following style node:
+      """
+      <names variable="author" suffix=".">
+        <name name-as-sort-order="all" sort-separator=", " initialize-with=". " delimiter="; " delimiter-precedes-last="always">
+          <name-part name="family" text-case="uppercase"/>
+          <name-part name="given" text-case="uppercase"/>
+        </name>
+        <et-al prefix=" " font-style="italic"/>
+        <label form="short" prefix=" (" suffix=".)" text-case="uppercase"/>
+      </names>
+      """
+    When I render the following citation items as "html":
+      | author                            |
+      | Cole, Steven J. and Moore, Robert |
+    Then the results should be:
+      | COLE, S. J.; MOORE, R.            |
+
+
+  Scenario: Name as sort order
+    Given the following style node:
+      """
+      <names variable="author">
+        <name and="text" delimiter=", " delimiter-precedes-last="always" name-as-sort-order="first" sort-separator=", " />
+      </names>
+      """
+    When I render the following citation items as "html":
+      | author                  |
+      | John Doe                |
+      | John Doe and Jane Doe   |
+    Then the results should be:
+      | Doe, John               |
+      | Doe, John, and Jane Doe |
+
+
+  Scenario: Substitutions
+    Given the following style node:
+      """
+      <names variable="author">
+        <name and="text" delimiter=", " delimiter-precedes-last="always" name-as-sort-order="first" sort-separator=", " />
+        <substitute>
+          <names variable="editor"/>
+          <text value="UNKNOWN"/>
+        </substitute>
+      </names>
+      """
+    When I render the following citation items as "html":
+      | editor                  |
+      | John Doe                |
+      |                         |
+      | John Doe and Jane Doe   |
+    Then the results should be:
+      | Doe, John               |
+      | UNKNOWN                 |
+      | Doe, John, and Jane Doe |
+
+  Scenario: Suppression after substitutions
+    Given the following style node:
+      """
+      <group delimiter=", ">
+        <names variable="author">
+          <name and="text" delimiter=", " delimiter-precedes-last="always" name-as-sort-order="first" sort-separator=", " />
+          <substitute>
+            <names variable="editor"/>
+            <text variable="title"/>
+          </substitute>
+        </names>
+        <names variable="editor">
+          <label prefix=" (" suffix=")"/>
+        </names>
+        <text variable="title" text-case="uppercase"/>
+      </group>
+      """
+    When I render the following citation items as "html":
+      | editor                  | author                  | title     |
+      | John Doe                | Jane Doe                | The Title |
+      | John Doe                |                         | The Title |
+      |                         |                         | The Title |
+    Then the results should be:
+      | Doe, Jane, John Doe (editor), THE TITLE           |
+      | Doe, John, THE TITLE                              |
+      | The Title                                         |
+
+  Scenario: Subsequent author substitutes complete-all with different roles
+    Given the following style node:
+      """
+      <bibliography subsequent-author-substitute="---">
+        <layout>
+          <group delimiter=" ">
+          <names variable="author" delimiter=", " suffix=".">
+              <name name-as-sort-order="first"/>
+              <substitute>
+                <names variable="editor">
+                  <name name-as-sort-order="first"/>
+                  <label form="short" prefix=" " suffix="."/>
+                </names>
+              </substitute>
+            </names>
+            <text variable="title" suffix="."/>
+          </group>
+        </layout>
+      </bibliography>
+      """
+    When I render the following citation items as "text":
+      | editor                  | author                  | title   |
+      |                         | Jane Doe                | Title A |
+      |                         | Jane Doe                | Title B |
+      |                         | John Doe                | Title C |
+      | John Doe                |                         | Title D |
+      |                         | Jane Doe and John Doe   | Title E |
+      |                         | Jane Doe and John Doe   | Title F |
+    Then the results should be:
+      | Doe, Jane. Title A.           |
+      | ---. Title B.                 |
+      | Doe, John. Title C.           |
+      | --- ed. Title D.              |
+      | Doe, Jane, John Doe. Title E. |
+      | ---. Title F.                 |
+
+  Scenario: Name / Label Order
+    Given the following style node:
+      """
+      <group delimiter=". ">
+        <names variable="author" delimiter=". ">
+          <name and="symbol" delimiter=", "/>
+          <label prefix=" (" suffix=")"/>
+        </names>
+        <names variable="translator" delimiter=". ">
+          <label form="verb-short" text-case="capitalize-first" suffix=" "/>
+          <name and="symbol" delimiter=", "/>
+        </names>
+      </group>
+      """
+    When I render the following citation items as "text":
+      | translator              | author                  |
+      | John Doe                | Jane Doe                |
+      | John Doe and Jack Doe   | Jane Doe and Jill Doe   |
+    Then the results should be:
+      | Jane Doe (author). Trans. John Doe                        |
+      | Jane Doe & Jill Doe (authors). Trans. John Doe & Jack Doe |
+
+  Scenario: EtAlUseFirst options
+    Given the following style node:
+      """
+      <group delimiter=" // ">
+        <names variable="author">
+          <name et-al-min="2" et-al-use-first="0"/>
+        </names>
+        <names variable="author">
+          <name et-al-min="2" et-al-use-first="1"/>
+        </names>
+      </group>
+      """
+    When I render the following citation item as "text":
+      | author | John Doe and Jane Roe |
+    Then the result should be: John Doe et al.
+
+