citeproc-ruby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a49591a9c8da3f7b39735dafb3f856f8b1d2dc9
-  data.tar.gz: 484c4cb981f1f20d7db2eb0e17eb6e6e1716c107
+  metadata.gz: 2433b5b1f4dd36a3d56c7faf79dd6052699b98ec
+  data.tar.gz: 7b10890a22be22daa7592c8ce3eff268f9988f38
 SHA512:
-  metadata.gz: 1a976cd92d8adcaf507f9dad08877476c3662cdac64ca79ce5ed598ab6841a7a673477003479277c16b639c5891c9d623862ccdec3c7cf66fb9b7d5611147fc7
-  data.tar.gz: 8568d601396504c8b6fe8ab3b11e5b4caca5cdabe720e43c62f2776b8430edd775374d58256937693da324f9e594e64daeb49ffcfa7d474ca46cfca1df21c024
+  metadata.gz: 13ecf2f3659e060df54a32acd0aa0518fb2fc21e724a12938bb6988687457a43e3d4af249a5ef4a5784af38f50e56771aa4fe5fc7474b09f7e94cfa8e10800b6
+  data.tar.gz: 961189fe7024379256a8480f0db3aa1acb42bf9cd0b0bc772d2d2972591edb5b289a8fad6a6ed0f36d53aed2dc5850f16ead12d0abe7ca1bad800393a699584f

data/README.md

@@ -10,6 +10,113 @@ cite processor, please refer to the documentation of the
 [![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)
 
+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
+
+    /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.
+
 Development
 -----------
 The CiteProc-Ruby source code is

data/lib/citeproc/ruby/renderer/text.rb

@@ -22,10 +22,10 @@ module CiteProc
             text = item.data.variable(node.variable, node.variable_options).to_s
 
             # Check for abbreviations or short-form fallbacks!
-            context, was_short_form = node.variable.split(/-short/, 2)
+            context, was_short_form = node.variable.split(/-short$/, 2)
 
-            if was_short_form || node[:form] == 'short'
-              if text.empty?
+            if !was_short_form.nil? || node[:form] == 'short'
+              if text.empty? && context != node.variable
                 text = item.data.variable(context, node.variable_options).to_s
               end
 

data/lib/citeproc/ruby/version.rb

@@ -1,5 +1,5 @@
 module CiteProc
   module Ruby
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/spec/citeproc/ruby/renderer/text_spec.rb

@@ -58,7 +58,7 @@ module CiteProc
         describe 'when the form attribute is set to :short' do
           before(:each) {
             item.data.title = 'the full title'
-            node[:form] = :short
+            node[:form] = 'short'
           }
 
           it "prefers the short version if available" do
@@ -69,6 +69,11 @@ module CiteProc
           it "falls back to the variable if unavailable" do
             renderer.render_text(item, node).should == 'the full title'
           end
+
+          it "falls back to the long form if the short form variable is not present" do
+            node[:variable] = 'title-short'
+            renderer.render_text(item, node).should == 'the full title'
+          end
         end
       end
 

data/spec/spec_helper.rb

@@ -16,9 +16,9 @@ end
 
 begin
   case
-  when RUBY_PLATFORM < 'java'
-    require 'debug'
-    Debugger.start
+  when RUBY_PLATFORM == 'java'
+    # require 'debug'
+    # Debugger.start
   when defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
     require 'rubinius/debugger'
   else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: citeproc-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citeproc
@@ -47,12 +47,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
 - .document
-- .gitignore
 - .rspec
 - .simplecov
-- .travis.yml
 - .yardopts
 - AGPL
 - BSDL
@@ -60,7 +57,6 @@ files:
 - Guardfile
 - README.md
 - Rakefile
-- citeproc-ruby.gemspec
 - cucumber.yml
 - features/bibliography.feature
 - features/name_options.feature
@@ -131,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Citation Style Language (CSL) cite processor

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.gitignore

@@ -1,10 +0,0 @@
-Gemfile.lock
-.DS_Store
-doc
-.yardoc
-.rbx
-*.rbc
-coverage
-.bundle
-.ruby-version
-*.swp

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-bundler_args: --without debug extra
-script: bundle exec rake test_with_coveralls
-rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode
-#  - jruby-head
-  - rbx
-  - rbx-2.2.3
-notifications:
-  email:
-    recipients:
-      - sylvester@keil.or.at
-    on_success: change
-    on_failure: always

data/citeproc-ruby.gemspec

@@ -1,46 +0,0 @@
-# -*- 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