citeproc 1.0.0.pre12 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53a6b76b4acbcdf2fbb930e63301e17562cbf864
+  data.tar.gz: 8d609c36df5cda49552269df91042682bc06e9a0
+SHA512:
+  metadata.gz: c4c3642540b8cf3af9fa23b1a8da4a08265da2795899ca4995eaf20b12d7c4814177bbafcd37b61c804b87f281b81d4f029bc1b81ff32c742bd92db72ccf95b2
+  data.tar.gz: 340736821671a7c6bd27e3326ff03f918feb95a54236e8a9c79b6e6c66085f0aa083cae02bd478a429eb594371ddb91954ed4b807bd2c4a77319cc3ca0b5a8de

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter 'spec/'
+  add_filter 'features/'
+end

data/AGPL

@@ -631,7 +631,7 @@ the "copyright" line and a pointer to where the full notice is found.
 
     CiteProc. A CSL Cite Processor API
 		Copyright 2012 President and Fellows of Harvard College.
-		Copyright 2009-2012 Sylvester Keil. All rights reserved.
+		Copyright 2009-2014 Sylvester Keil. All rights reserved.
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU Affero General Public License as published by

data/BSDL

@@ -1,5 +1,5 @@
 Copyright 2012 President and Fellows of Harvard College.
-Copyright 2009-2012 Sylvester Keil. All rights reserved.
+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:
@@ -24,4 +24,4 @@ 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.
+policies, either expressed or implied, of the copyright holder.

data/Gemfile

@@ -1,29 +1,49 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 
 group :debug do
-  gem 'debugger', '~>1.1.3', :platform => :mri_19
+  gem 'ruby-debug', :require => false, :platform => :jruby
+  gem 'debugger', '~>1.6', :require => false, :platform => :mri
+  gem 'rubinius-compiler', '~>2.0', :require => false, :platform => :rbx
+  gem 'rubinius-debugger', '~>2.0', :require => false, :platform => :rbx
 end
 
 group :optional do
-	gem 'chronic', '~>0.6'
-	gem 'edtf', '~>1.0.0'
-		
-	gem 'bibtex-ruby', '~>2.0.10', :require => 'bibtex'
-	
-  gem 'simplecov', '~>0.6.4'
-
-  gem 'guard', '~>1.2'
-  gem 'guard-rspec', '~>1.1'
-  gem 'guard-cucumber', '~>1.2'
-
-	gem 'yard', '~>0.8', :platforms => [:mri_19]
-	gem 'redcarpet', '~>2.1', :platforms => [:mri_19]
-  
-  gem 'unicode_utils', '~>1.3.0', :platform => :mri_19
-  gem 'unicode', '~>0.4.2', :platform => :mri_18
+  gem 'nokogiri', '~>1.6'
+  gem 'chronic', '~>0.10', :require => false
+  gem 'edtf', '~>2.1'
+
+  gem 'bibtex-ruby', '~>3.0', :require => 'bibtex'
+
+  gem 'guard', '~>2.2'
+  gem 'guard-rspec', '~>4.2'
+  gem 'guard-cucumber', '~>1.4'
+
+  gem 'pry'
+
+  gem 'unicode', '~>0.4', :platforms => [:ruby, :mswin, :mingw]
+
+  gem 'citeproc-ruby', :github => 'inukshuk/citeproc-ruby'
+  #gem 'csl', :github => 'inukshuk/csl-ruby'
+end
+
+group :development do
+  gem 'rake'
+  gem 'cucumber'
+  gem 'rspec'
+  gem 'simplecov', '~>0.8', :require => false
+  gem 'rubinius-coverage', :platform => :rbx
+  gem 'coveralls', :require => false
+  gem 'csl-styles', '~>1.0.1', :require => false
 end
 
 group :extra do
-  gem 'oniguruma', '~>1.1.0', :platform => :mri_18
+  gem 'yard', '~>0.8', :platforms => :ruby
+  gem 'redcarpet', '~>3.0', :platform => :mri
+end
+
+platform :rbx do
+  gem 'rubysl', '~>2.0'
+  gem 'json', '~>1.8'
+  gem 'racc'
 end

data/README.md

@@ -2,34 +2,143 @@ CiteProc
 ========
 CiteProc is a cite processor interface and citation data API based on the
 Citation Style Language (CSL) specifications. To actually process citations
-a dedicated processor engine is required; these can be installed as separate
-gems.
+a dedicated processor engine is required; a pure Ruby engine is available
+in the [citeproc-ruby](https://rubygems/gems/citeproc-ruby) gem.
 
-### A word of caution
-As work on this and on the related packages is still in progress, please
-be aware of the following caveats: the 0.0.x branch of citeproc-ruby is still
-a standalone package and will conflict with this release of citeproc; support
-will be added in future versions of the 1.x.x branch.
 
-[![Build Status](https://secure.travis-ci.org/berkmancenter/citeproc.png)](http://travis-ci.org/berkmancenter/citeproc)
+[![Build Status](https://secure.travis-ci.org/inukshuk/citeproc.png)](http://travis-ci.org/inukshuk/citeproc)
+[![Coverage Status](https://coveralls.io/repos/inukshuk/citeproc/badge.png?branch=master)](https://coveralls.io/r/inukshuk/citeproc?branch=master)
+[![Dependency Status](https://gemnasium.com/inukshuk/citeproc.png)](https://gemnasium.com/inukshuk/citeproc)
 
+[![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)
 
-Citation Data
+[![Build Status](https://secure.travis-ci.org/inukshuk/csl-ruby.png)](http://travis-ci.org/inukshuk/csl-ruby)
+[![Coverage Status](https://coveralls.io/repos/inukshuk/csl-ruby/badge.png?branch=master)](https://coveralls.io/r/inukshuk/csl-ruby?branch=master)
+[![Dependency Status](https://gemnasium.com/inukshuk/csl-ruby.png)](https://gemnasium.com/inukshuk/csl-ruby)
+
+Quickstart
+----------
+Install CiteProc-Ruby and all official CSL styles (optional).
+
+    $ [sudo] gem install citeproc-ruby
+    $ [sudo] gem install csl-styles
+
+Start rendering you references with any CSL style!
+
+    require 'citeproc'
+    require 'csl/styles'
+
+    # Create a new processor with the desired style,
+    # format, and locale.
+    cp = CiteProc::Processor.new style: 'apa', format: 'text'
+
+    # To see what styles are available in your current
+    # environment, run `CSL::Style.ls'; this also works for
+    # locales as `CSL::Locale.ls'.
+
+    # Tell the processor where to find your references. In this
+    # example we load them from a BibTeX bibliography using the
+    # bibtex-ruby gem.
+    cp.import BibTeX.open('./references.bib').to_citeproc
+
+    # Now you are ready for rendering; the processor API
+    # provides three main rendering methods: `process',
+    # `append', or `bibliography'.
+
+    # For simple one-off renditions, you can also call
+    # `render' in bibliography or citation mode:
+    cp.render :bibliography, id: 'knuth'
+
+    # This will return a rendered reference, like:
+    #-> Knuth, D. (1968). The art of computer programming. Boston: Addison-Wesley.
+
+    # CiteProc-Ruby exposes a full CSL API to you; this
+    # makes it possible to just alter CSL styles on the
+    # fly. For example, what if we want names not to be
+    # initialized even though APA style is configured to
+    # do so? We could change the CSL style itself, but
+    # we can also make a quick adjustment at runtime:
+    name = cp.engine.style.macros['author'] > 'names' > 'name'
+
+    # What just happened? We selected the current style's
+    # 'author' macro and then descended to the CSL name
+    # node via its parent names node. Now we can change
+    # this name node and the cite processor output will
+    # pick-up the changes right away:
+    name[:initialize] = 'false'
+
+    cp.render :bibliography, id: 'knuth'
+    #-> Knuth, Donald. (1968). The art of computer programming (Vol. 1). Boston: Addison-Wesley.
+
+    # Note that we have picked 'text' as the output format;
+    # if we want to make us of richer output formats we
+    # can switch to HTML instead:
+    cp.engine.format = 'html'
+
+    cp.render :bibliography, id: 'knuth'
+    #-> Knuth, Donald. (1968). <i>The art of computer programming</i> (Vol. 1). Boston: Addison-Wesley.
+
+    # You can also render citations on the fly.
+    cp.render :citation, id: 'knuth', locator: '23'
+    #-> (Knuth, 1968, p. 23)
+
+Documentation
 -------------
+* [CiteProc Documentation](http://rubydoc.info/gems/citeproc/)
+* [CiteProc-Ruby API Documentation](http://rubydoc.info/gems/citeproc-ruby/)
+* [CSL-Ruby API Documentation](http://rubydoc.info/gems/csl/)
+
+Optional Dependencies
+---------------------
+CiteProc-Ruby tries to minimize hard dependencies for increased compatibility.
+You can speed up the XML parsing by installing
+[Nokogiri](https://rubygems.org/gems/nokogiri); otherwise the REXML from the
+Ruby standard library will be used.
+
+Similarly, you can install either of the gems
+[EDTF](https://rubygems.org/gems/edtf) or
+[Chronic](https://rubygems.org/gems/chronic) to support a wide range of
+additional inputs for date variables.
+
+CSL Styles and Locales
+----------------------
+You can load CSL styles and locales by passing a respective XML string, file
+name, or URL. You can also load styles and locales by name if the
+corresponding files are installed in your local styles and locale directories.
+By default, CSL-Ruby looks for CSL styles and locale files in
 
-Processor Interface
--------------------
+    /usr/local/share/csl/styles
+    /usr/local/share/csl/locales
+
+You can change these locations by changing the value of `CSL::Style.root` and
+`CSL::Locale.root` respectively.
+
+Alternatively, you can `gem install csl-styles` to install all official CSL
+styles and locales. To make the styles and locales available, simply
+`require 'csl/styles`.
+
+Compatibility
+-------------
+The cite processor and the CSL API libraries have been developed for MRI,
+Rubinius, and JRuby. Please note that we try to support only Ruby versions
+1.9.3 and upwards.
 
 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/).
 
 Copyright
 ---------
-Copyright 2012 President and Fellows of Harvard College.
+Copyright 2009-2014 Sylvester Keil. All rights reserved.
 
-Copyright 2009-2012 Sylvester Keil. All rights reserved.
+Copyright 2012 President and Fellows of Harvard College.
 
 License
 -------
-CiteProc is dual licensed under the AGPL and the FreeBSD license.
+CiteProc is dual licensed under the AGPL and the FreeBSD license.

data/Rakefile

@@ -14,14 +14,18 @@ require 'citeproc/version'
 
 
 desc 'Run an IRB session with CiteProc loaded'
-task :console, [:script] do |t,args|
-  ARGV.clear
+task :console do
+  require 'pry'
+  require 'citeproc'
+
+  Pry.start
+end
 
-  require 'irb'
+task :check_warnings do
+  $VERBOSE = true
   require 'citeproc'
-  
-  IRB.conf[:SCRIPT] = args.script
-  IRB.start
+
+  puts CiteProc::VERSION
 end
 
 require 'rspec/core'
@@ -33,6 +37,10 @@ end
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:cucumber)
 
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+task :test_with_coveralls => [:spec, :cucumber, 'coveralls:push']
+
 task :release do |t|
   system "gem build citeproc.gemspec"
   system "git tag #{CiteProc::VERSION}"
@@ -42,5 +50,11 @@ end
 
 task :default => :spec
 
-require 'yard'
-YARD::Rake::YardocTask.new
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError => e
+  # ignore
+end
+
+require './tasks/testsuite'

data/cucumber.yml

@@ -1 +1 @@
-default: --format progress --require features --color
+default: --format progress --require features --color --tags ~@non-standard

data/features/step_definitions/processor.rb

@@ -0,0 +1,59 @@
+Given(/^the following style:$/) do |string|
+  @style = CSL::Style.parse!(string)
+end
+
+Given(/^the following input:$/) do |string|
+  @input = JSON.parse(string)
+  @input.should_not be_nil
+
+  processor.import @input
+end
+
+Given(/^the following abbreviations:$/) do |string|
+  processor.abbreviations = JSON.parse(string)
+  processor.abbreviations[:default].should_not be_empty
+end
+
+When(/^I render the entire bibliography$/) do
+  @bibliography = processor.bibliography
+  @bibliography.errors.should == []
+end
+
+When(/^I render the following bibliography selection:$/) do |string|
+  selection = JSON.parse(string)
+  selection.should_not be_nil
+
+  @bibliography = processor.bibliography(selection)
+  @bibliography.errors.should == []
+end
+
+Then(/^the bibliography should be:$/) do |string|
+  string.gsub!(/\n\s*/m, '') # strip newlines
+  @bibliography.join.should == string
+end
+
+When(/^I cite the following items:$/) do |string|
+  @results = JSON.parse(string).map do |item|
+    processor.process(item)
+  end
+end
+
+When(/^I cite all items$/) do
+  @result = processor.process @input.map { |i| { 'id' => i['id'] } }
+end
+
+Then(/^the bibliography's options should match:$/) do |table|
+  headers = table.headers.map(&:to_sym)
+  expected = table.rows[0]
+
+  @bibliography.options.values_at(*headers).should == expected
+end
+
+Then(/^the results should be:$/) do |table|
+  @results.should == table.raw.map(&:first)
+end
+
+Then(/^the result should be:$/) do |string|
+  @result.should == string
+end
+

data/features/support/env.rb

@@ -1,8 +1,51 @@
 begin
   require 'simplecov'
-  require 'debugger'
 rescue LoadError
   # ignore
 end
 
-require 'citeproc'
+begin
+  case
+  when RUBY_PLATFORM < 'java'
+    require 'debug'
+    Debugger.start
+  when defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+    require 'rubinius/debugger'
+  else
+    require 'debugger'
+  end
+rescue LoadError
+  # ignore
+end
+
+require 'nokogiri'
+require 'citeproc'
+require 'citeproc/ruby'
+require 'csl/styles'
+
+module MimicksCiteProcJS
+  def processor
+    @processor ||= CiteProc::Processor.new :style => @style,
+      :format => default_format, :locale => default_locale_path
+  end
+
+  def default_format
+    unless @format
+      @format = CiteProc::Ruby::Format.load('citeprocjs')
+      @format.config[:bib_indent] = nil
+    end
+
+    @format
+  end
+
+  def default_locale_path
+    File.expand_path('../../../spec/fixtures/locales/locales-en-US.xml', __FILE__)
+  end
+
+  def default_locale
+    @locale ||= CSL::Locale.load default_locale_path
+  end
+end
+
+World(MimicksCiteProcJS)
+

data/lib/citeproc.rb

@@ -4,7 +4,7 @@ require 'forwardable'
 require 'observer'
 require 'open-uri'
 
-require 'multi_json'
+require 'json'
 require 'namae'
 
 require 'citeproc/version'
@@ -14,13 +14,13 @@ require 'citeproc/version'
 # defined in CSL (Citation Style Language).
 #
 module CiteProc
-  
+
   module Converters
   end
-  
+
   module Utilities
   end
-  
+
 end
 
 require 'citeproc/compatibility'
@@ -62,14 +62,14 @@ CiteProc::Converters.class_eval do
   # Define all converters (all classes have been loaded at this point)
   CiteProc.constants.each do |name|
     klass = CiteProc.const_get(name)
-  
+
     if klass.instance_of?(Class) && klass.respond_to?(:create)
-      
+
       define_method(name) do |obj|
         obj.instance_of?(klass) ? obj : klass.create(obj)
       end
-      
+
     end
   end
-  
+
 end