citeproc-ruby 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9f9a8160c37669047e06dbeb5659056f96da25971415f2137aba6dd897f2b36
-  data.tar.gz: 5b896f34ed9b437a08e7fe00fa0b1de64d8f7195a83f1d53591512411be46a83
+  metadata.gz: 4638485de31e2e8c4ab29c0ded3c7f2d26c603164ab801df2259248c20c4fd70
+  data.tar.gz: b5f8fef7bc32f342ae20934a658c60e41bda292ffd881e10a356e2dd419a8f66
 SHA512:
-  metadata.gz: f65a5e51302e839f5ec13ba8a5a2fd743127305a70a1f94c4cfbc457157ba3eb3382e883475a710f04abad8f18f11296713c4b5c7235271fb2f31b9297e8dc15
-  data.tar.gz: 3fc95092334d3f3a10bb6e626d98c4d6e4d4fdd875c95cb6189b7394d65a61b0ca6d2ab367cced0cfb78c93c38920562706c727c5a8d263c1e4dfbeb2ef6e0af
+  metadata.gz: d14b3342bbaec986311bdf311170a7a88c5a183fcaaf7e8481a675f1a2f0a032c56ddde863d57c6baf7dd23bb944bac00be9079788661a0d9a04db5dcd33b302
+  data.tar.gz: 3b7fc32415189849122d64d1c6256125f68f4b00321b84230a4ba7adf3b2564c055ff0a08c846ecd3c152488dc4c9bce8c0c74d7f87fa964a9d3afb5e8833b45

data/.github/workflows/ci.yml

@@ -10,18 +10,23 @@ jobs:
   build:
     runs-on: ubuntu-latest
     env:
-      RUBYOPT: W2
       BUNDLE_WITHOUT: debug:extra
     strategy:
       matrix:
         ruby-version:
-          - 3.0
-          - 2.7
-          - 2.6
+          - '3.3'
+          - '3.2'
+          - '3.1'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
       - run: bundle exec rake
+      - name: Upload coverage results
+        if: matrix.ruby-version == '3.3'
+        continue-on-error: true
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ github.token }}

data/BSDL

@@ -1,7 +1,7 @@
 CiteProc-Ruby. A Ruby CSL cite processor.
 
 Copyright 2012 President and Fellows of Harvard College.
-Copyright 2009-2020 Sylvester Keil. All rights reserved.
+Copyright 2009-2024 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:

data/Gemfile

@@ -8,12 +8,11 @@ group :development, :test do
   gem 'rake'
   gem 'rspec'
   gem 'cucumber'
-  gem 'unicode_utils', require: false unless RUBY_VERSION >= '2.4'
 end
 
 group :debug do
-  gem 'byebug', :require => false, :platforms => :mri
-  gem 'ruby-debug', :require => false, :platforms => :jruby
+  gem 'debug', '>= 1.0.0', require: false, platforms: :mri
+  gem 'ruby-debug', require: false, platforms: :jruby
 end
 
 group :optional do
@@ -22,11 +21,11 @@ group :optional do
 end
 
 group :extra do
-  gem 'pry'
 	gem 'yard', platforms: :mri
 	gem 'redcarpet', platforms: :mri
 end
 
 group :coverage do
   gem 'simplecov', require: false
+  gem 'simplecov-lcov', require: false
 end

data/README.md

@@ -15,66 +15,68 @@ Install CiteProc-Ruby and all official CSL styles (optional).
 
 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)
-    
-    # Pass an array if you want to render multiple citations:
-    cp.render :citation, [{ id: 'knuth' }, { id: 'perez' }]
-    #-> (Knuth, 1968; Perez, 1989)
+```ruby
+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)
+
+# Pass an array if you want to render multiple citations:
+cp.render :citation, [{ id: 'knuth' }, { id: 'perez' }]
+#-> (Knuth, 1968; Perez, 1989)
+```
 
 Documentation
 -------------
@@ -146,7 +148,7 @@ this project as part of [Google Summer of Code](https://developers.google.com/op
 
 Copyright
 ---------
-Copyright 2009-2020 Sylvester Keil. All rights reserved.
+Copyright 2009-2024 Sylvester Keil. All rights reserved.
 
 Copyright 2012 President and Fellows of Harvard College.
 

data/Rakefile

@@ -12,19 +12,17 @@ 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'
+  ARGV.clear
+  require 'irb'
   require 'citeproc/ruby'
-
-  Pry.start
+  IRB.start
 end
 
 task :check_warnings do
   $VERBOSE = true
   require 'citeproc/ruby'
-
   puts CiteProc::Ruby::VERSION
 end
 

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

@@ -24,9 +24,12 @@ module CiteProc
 
         join node.each_child.map { |child|
           render item, child
-        }
+        }, closest_delimiter_for(node)
       end
 
+      def closest_delimiter_for(node)
+        node.closest(/^group|layout$/)&.delimiter || ''
+      end
 
       # Evaluates the conditions of the passed-in Choose::Block
       # against the passed-in CitationItem using the Block's matcher.
@@ -101,6 +104,5 @@ module CiteProc
         end
       end
     end
-
   end
 end

data/lib/citeproc/ruby/version.rb

@@ -1,5 +1,5 @@
 module CiteProc
   module Ruby
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: citeproc-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-01 00:00:00.000000000 Z
+date: 2024-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citeproc
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: observer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |
   CiteProc-Ruby is a Citation Style Language (CSL) 1.0.1 compatible cite
   processor implementation written in pure Ruby.
@@ -88,7 +102,6 @@ files:
 - lib/citeproc/ruby/version.rb
 homepage: https://github.com/inukshuk/citeproc-ruby
 licenses:
-- AGPL-3.0
 - BSD-2-Clause
 metadata: {}
 post_install_message:
@@ -106,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: A Citation Style Language (CSL) cite processor