citeproc-ruby 2.1.8 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 310c28ad4f8db98a36c203d79fc7b8e5aa51367371f81daf6d4d6b03dc97888c
-  data.tar.gz: f2b7597549a33ca318635d0b54d1ff49179938e50f2b7f25c3cf596221519d05
+  metadata.gz: 1caf4a2b5f09b04fd3e6b5a8e7fbaf4c1e8e5b45d4c3c7ce8856eb79990f74ee
+  data.tar.gz: 38b1c2eeff222fb886cf2a95c146835fe72bdcb64aef5fd4bf8034c2113792d6
 SHA512:
-  metadata.gz: 6151f0f5f16d34b77c07627116baca5294ef8090a69051e0f353f521d63ad6a41cbf805e8bbc7679bfc8cec67f0fdb566b166fbab1c41adb472a6e3ccf53e45e
-  data.tar.gz: cc1e8d512be419a3e1ee6d46b7d3a5a79c9adb4b9a74796557abef3f93ea7d5221382565fdfcb1a54aaae4ae7bc4038cdc3a58c4169317d00ab81bcb701248c5
+  metadata.gz: cc45e7b4b001ce4caa03c7b16a039ffc0e141e99ee30758ffe230201f4671c7a3b6da05b342a503583f4f6668231bb22cad4780c688417d1e57b04bcbbc2278d
+  data.tar.gz: f2d8c8bc3919d4973335447ce04850902459ec625c236cdbdee02a9a285a9cbbbdd933ccc147edaf5032386900b39ed101680911411e8dd6a616e19a0d9bc748

data/.document

@@ -1,4 +1,5 @@
 lib/**/*.rb
 - 
 AGPL
+BSDL
 README.md

data/.github/workflows/ci.yml

@@ -10,23 +10,23 @@ jobs:
   build:
     runs-on: ubuntu-latest
     env:
-      BUNDLE_WITHOUT: debug:extra
+      BUNDLE_WITHOUT: debug
     strategy:
+      fail-fast: false
       matrix:
         ruby-version:
+          - '4.0'
           - '3.4'
           - '3.3'
-          - '3.2'
-          - '3.1'
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - 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'
+        if: matrix.ruby-version == '3.4'
         continue-on-error: true
         uses: coverallsapp/github-action@v2
         with:

data/Gemfile

@@ -18,14 +18,10 @@ end
 group :optional do
   gem 'edtf'
 	gem 'chronic'
-end
-
-group :extra do
-	gem 'yard', platforms: :mri
-	gem 'redcarpet', platforms: :mri
+	gem 'ffi-icu'
 end
 
 group :coverage do
-  gem 'simplecov', require: false
+  gem 'simplecov', '>= 1.3', require: false
   gem 'simplecov-lcov', require: false
 end

data/README.md

@@ -113,12 +113,6 @@ 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/Rakefile

@@ -12,7 +12,7 @@ end
 $:.unshift(File.join(File.dirname(__FILE__), './lib'))
 require 'citeproc/ruby/version'
 
-desc 'Run a Pry session with CiteProc-Ruby loaded'
+desc 'Run an IRB session with CiteProc-Ruby loaded'
 task :console do
   ARGV.clear
   require 'irb'
@@ -39,16 +39,9 @@ end
 
 task :release do |t|
   system "gem build citeproc-ruby.gemspec"
-  system "git tag #{CiteProc::Ruby::VERSION}"
+  system "git tag v#{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/lib/citeproc/ruby/formats/html.rb

@@ -162,7 +162,7 @@ module CiteProc
         private
 
         def content_tag(name, content, options = nil)
-          opening_tag(name, options) << content << closing_tag(name)
+          "#{opening_tag(name, options)}#{content}#{closing_tag(name)}"
         end
 
         def style_for(options)
@@ -177,7 +177,7 @@ module CiteProc
 
           return unless !options.empty?
 
-          ' ' << options.map { |k, v| [k, v.inspect].join('=') }.join(' ')
+          " #{options.map { |k, v| [k, v.inspect].join('=') }.join(' ')}"
         end
 
         def opening_tag(name, options = nil)

data/lib/citeproc/ruby/formats/latex.rb

@@ -93,7 +93,7 @@ module CiteProc
         private
 
         def content_tag(name, content, options = nil)
-          opening_tag(name, options) << content << closing_tag(name)
+          "#{opening_tag(name, options)}#{content}#{closing_tag(name)}"
         end
 
         def style_for(options)
@@ -108,7 +108,7 @@ module CiteProc
 
           return unless !options.empty?
 
-          ' ' << options.map { |k, v| [k, v.inspect].join('=') }.join(' ')
+          " #{options.map { |k, v| [k, v.inspect].join('=') }.join(' ')}"
         end
 
         def opening_tag(name, options = nil)

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

@@ -238,7 +238,7 @@ module CiteProc
           # Strip away some unusual characters to normalize
           # sort order for names.
           if sort_mode?
-            name.family = name.family.to_s.gsub(/[\[\]]|^\W+/, '')
+            name.family = name.family.to_s.gsub(/[\[\]]|^[^[:word:]]+/, '')
           end
 
           name.options.merge! node.name_options

data/lib/citeproc/ruby/renderer.rb

@@ -99,26 +99,23 @@ module CiteProc
         state.clear! result
       end
 
-      def render_sort(a, b, node, key)
+      def render_sort(item, node, key)
         state.store! nil, key
 
         original_format = @format
         @format = Formats::Sort.new
 
-        if a.is_a?(CiteProc::Names)
-          [render_name(a, node), render_name(b, node)]
+        if item.is_a?(CiteProc::Names)
+          render_name(item, node)
 
         else
           # We need to clear any items that are suppressed
           # because they were used as substitutes during
           # rendering for sorting purposes!
-          a_rendered = render a.cite, node
-          a.suppressed.clear
+          rendered = render item.cite, node
+          item.suppressed.clear
 
-          b_rendered = render b.cite, node
-          b.suppressed.clear
-
-          [a_rendered, b_rendered]
+          rendered
         end
 
       ensure

data/lib/citeproc/ruby/sort.rb

@@ -1,3 +1,9 @@
+begin
+  require 'ffi-icu'
+rescue LoadError
+  # ignore
+end
+
 module CiteProc
   module Ruby
 
@@ -6,24 +12,30 @@ module CiteProc
       def sort!(items, keys)
         return items unless !keys.nil? && !keys.empty?
 
+        # Sort values are computed only once per item
+        # and key for the duration of the sort.
+        cache = {}.compare_by_identity
+
         # TODO refactor
         if items.is_a?(CitationData)
           items.sort! do |a, b|
-            compare_items_by_keys(a.data, b.data, keys)
+            compare_items_by_keys(a.data, b.data, keys, cache)
           end
         else
           items.sort! do |a, b|
-            compare_items_by_keys(a, b, keys)
+            compare_items_by_keys(a, b, keys, cache)
           end
         end
       end
 
+      private
+
       # @returns [-1, 0, 1, nil]
-      def compare_items_by_keys(a, b, keys)
+      def compare_items_by_keys(a, b, keys, cache)
         result = 0
 
         keys.each do |key|
-          result = compare_items_by_key(a, b, key)
+          result = compare_items_by_key(a, b, key, cache)
           return result unless result.zero?
         end
 
@@ -31,52 +43,83 @@ module CiteProc
       end
 
       # @returns [-1, 0, 1, nil]
-      def compare_items_by_key(a, b, key)
-        if key.macro?
-          result = compare_items(*renderer.render_sort(a, b, key.macro, key))
+      def compare_items_by_key(a, b, key, cache)
+        va, vb = sort_value(a, key, cache), sort_value(b, key, cache)
 
-        else
-          va, vb = a[key.variable], b[key.variable]
-
-          # Return early if one side is nil. In this
-          # case ascending/descending is irrelevant!
-          return  1 if va.nil? || va.empty?
-          return -1 if vb.nil? || vb.empty?
-
-          result = case CiteProc::Variable.types[key.variable]
-            when :names
-              node = CSL::Style::Name.new(key.name_options)
-              node.all_names_as_sort_order!
-
-              compare_items(*renderer.render_sort(va, vb, node, key))
-
-            when :date
-              va <=> vb
-            when :number
-              va <=> vb
-            else
-              compare_items(va, vb)
-            end
-        end
+        # Return early if either side is nil.
+        # In this case ascending/descending is irrelevant!
+        return  0 if va.nil? && vb.nil?
+        return  1 if va.nil?
+        return -1 if vb.nil?
 
+        result = va <=> vb
         result = -result unless key.ascending?
         result
       end
 
-      def compare_items(a, b)
-        if sort_case_sensitively?
-          a <=> b
+      def sort_value(item, key, cache)
+        values = (cache[item] ||= {})
+        values.fetch(key) { values[key] = compute_sort_value(item, key) }
+      end
+
+      def compute_sort_value(item, key)
+        if key.macro?
+          return sort_key(renderer.render_sort(item, key.macro, key))
+        end
+
+        value = item[key.variable]
+        return if value.nil? || value.empty?
+
+        case CiteProc::Variable.types[key.variable]
+        when :names
+          node = CSL::Style::Name.new(key.name_options)
+          node.all_names_as_sort_order!
+
+          sort_key(renderer.render_sort(value, node, key))
+
+        when :date, :number
+          value
         else
-          a.to_s.downcase <=> b.to_s.downcase
+          sort_key(value)
         end
       end
 
+      def sort_key(string)
+        string = string.to_s
+
+        collator = self.collator
+        return collator.collation_key(string) unless collator.nil?
+
+        folded = string.downcase(:fold)
+        key = [folded.unicode_normalize(:nfd).gsub(/\p{Mn}/, ''), folded]
+        sort_case_sensitively? ? key << string : key
+      end
+
+      def collator
+        return unless defined?(ICU::Collation::Collator)
+
+        lc = renderer.locale.to_s
+        cs = sort_case_sensitively?
+
+        @collators ||= {}
+        @collators[[lc, cs]] ||= create_collator(lc, cs)
+      end
+
+      def create_collator(locale, case_sensitive)
+        collator = ICU::Collation::Collator.new(locale)
+        collator.case_first = :upper_first
+
+        # Secondary strength compares letters and diacritics
+        # but ignores case; tertiary strength considers case too.
+        collator.strength = case_sensitive ? :tertiary : :secondary
+
+        collator
+      end
+
       def sort_case_sensitively?
         return false unless processor && processor.options
         processor.options[:sort_case_sensitively]
       end
-
     end
-
   end
 end

data/lib/citeproc/ruby/version.rb

@@ -1,5 +1,5 @@
 module CiteProc
   module Ruby
-    VERSION = '2.1.8'
+    VERSION = '2.2.0'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: citeproc-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.8
+  version: 2.2.0
 platform: ruby
 authors:
 - Sylvester Keil
 bindir: bin
 cert_chain: []
-date: 2025-12-04 00:00:00.000000000 Z
+date: 2026-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citeproc
@@ -58,7 +58,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 description: |
-  CiteProc-Ruby is a Citation Style Language (CSL) 1.0.1 compatible cite
+  CiteProc-Ruby is a Citation Style Language (CSL) 1.0.2 compatible cite
   processor implementation written in pure Ruby.
 email:
 - http://sylvester.keil.or.at
@@ -66,7 +66,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".document"
 - ".github/workflows/ci.yml"
 - ".yardopts"
@@ -110,14 +109,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A Citation Style Language (CSL) cite processor
 test_files: []

data/.codeclimate.yml

@@ -1,17 +0,0 @@
----
-engines:
-  duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
-  fixme:
-    enabled: true
-  rubocop:
-    enabled: true
-ratings:
-  paths:
-  - "**.rb"
-exclude_paths:
-- features/
-- spec/