citeproc-ruby 2.1.8 → 2.3.0

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

@@ -20,14 +20,14 @@ module CiteProc
           self
         end
 
+        # A variable read more than once counts as non-empty
+        # if any of the reads was non-empty
         def update(method, key, value)
-          history[key] = value if method == :read
+          history[key] = value if method == :read && empty?(history[key])
         end
 
         def skip?
-          !history.empty? && history.values.all? { |v|
-            v.nil? || v.respond_to?(:empty?) && v.empty?
-          }
+          !history.empty? && history.values.all? { |v| empty?(v) }
         end
 
         def accessed
@@ -38,6 +38,12 @@ module CiteProc
           history.clear
           self
         end
+
+        private
+
+        def empty?(value)
+          value.nil? || value.respond_to?(:empty?) && value.empty?
+        end
       end
 
     end

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

@@ -30,6 +30,9 @@ module CiteProc
 
         attr_reader :history, :node, :item, :authors, :substitute
 
+        # @return [String, nil] the language of the item being rendered
+        attr_accessor :language
+
         def initialize
           @history, @authors = History.new(self, 3), []
           reset
@@ -55,7 +58,8 @@ module CiteProc
         end
 
         def reset
-          @item, @node, @substitute, @authors, @names = nil, nil, nil, [], nil
+          @item, @node, @substitute, @authors, @names, @language =
+            nil, nil, nil, [], nil, nil
           self
         ensure
           changed

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

@@ -16,7 +16,12 @@ module CiteProc
             # in item.data; there should be no locator there
             # either but the read access will be noticed by
             # observers (if any).
-            text = item.locator || item.data[:locator].to_s
+            text = (item.locator || item.data[:locator]).to_s
+
+          elsif node.variable == 'year-suffix'
+            # The year-suffix is set by the processor (for disambiguation)
+            # and does not count as a variable for group suppression
+            text = item.data.unobservable_read_attribute(:'year-suffix').to_s
 
           else
             text = item.data.variable(node.variable, node.variable_options).to_s
@@ -25,7 +30,8 @@ module CiteProc
             context, was_short_form = node.variable.split(/-short$/, 2)
 
             if !was_short_form.nil? || node[:form] == 'short'
-              if text.empty? && context != node.variable
+              # Only the short form falls back to the long form
+              if text.empty? && context != node.variable && node[:form] == 'short'
                 text = item.data.variable(context, node.variable_options).to_s
               end
 
@@ -36,7 +42,14 @@ module CiteProc
 
           case
           when node.variable == 'page'
-            format_page_range!(text, node.page_range_format)
+            text = format_page_range(text, node.page_range_format)
+
+          when node.variable == 'locator'
+            format = node.page_range_format if item.label == 'page'
+            text = format_page_range(text, format)
+
+            # Use the localized ampersand (e.g., in "213 & 235")
+            text = text.gsub(/\s*&\s*/, " #{ampersand} ")
 
           when node.variable == 'page-first' && text.empty?
             text = item.data[:'page'].to_s[/\d+/].to_s

data/lib/citeproc/ruby/renderer.rb

@@ -26,6 +26,15 @@ module CiteProc
       end
       alias abbrev abbreviate
 
+      # Clears the renderer's caches. Call this after changing styles or
+      # locales in place, or to free memory when using many different styles.
+      #
+      # @return [self]
+      def clear_cache!
+        clear_locale_cache!
+        self
+      end
+
       def allow_locale_overrides?
         return false unless engine
         engine.options[:allow_locale_overrides]
@@ -65,10 +74,14 @@ module CiteProc
       # @param node [CSL::Style::Layout]
       # @return [String] the rendered and string
       def render_single_citation(item, node)
+        state.language = language_of(item.data)
+
         # TODO author_only
         item.suppress! 'author' if item.suppress_author?
 
         join [item.prefix, render_layout(item, node), item.suffix].compact
+      ensure
+        state.language = nil
       end
 
       # @param item [CiteProc::CitationItem]
@@ -76,20 +89,37 @@ module CiteProc
       # @return [String] the rendered and formatted string
       def render_bibliography(item, node)
         state.store! item, node
+        state.language = language_of(item.data)
 
-        if allow_locale_overrides? && item.language != locale.language
+        language = item.language.to_s
+
+        if allow_locale_overrides? && !language.empty?
           begin
-            new_locale = CSL::Locale.load(item.language)
+            item_locale = locale_for(language)
 
-            unless new_locale.nil?
-              original_locale, @locale = @locale, new_locale
+            if item_locale != base_locale
+              original_locale, @locale = @locale, item_locale
             end
           rescue ParseError
             # locale not found
           end
         end
 
-        result = render item, node.layout
+        fields = node.layout.each_child.map { |child|
+          render item, child
+        }.reject(&:empty?)
+
+        # With second-field-align, the first field is rendered
+        # in the left margin and the other fields inline
+        # (without trailing whitespace)
+        if node.second_field_align? && fields.length > 1
+          fields = [
+            format!(fields[0], CSL::Style::Group.new(:display => 'left-margin')),
+            format!(join(fields[1..]).rstrip, CSL::Style::Group.new(:display => 'right-inline'))
+          ]
+        end
+
+        result = format! join(fields), node.layout
 
       ensure
         unless original_locale.nil?
@@ -99,26 +129,24 @@ module CiteProc
         state.clear! result
       end
 
-      def render_sort(a, b, node, key)
+      def render_sort(item, node, key)
         state.store! nil, key
+        state.language = language_of(item)
 
         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
-
-          b_rendered = render b.cite, node
-          b.suppressed.clear
+          rendered = render item.cite, node
+          item.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.3.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.3.0
 platform: ruby
 authors:
 - Sylvester Keil
 bindir: bin
 cert_chain: []
-date: 2025-12-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citeproc
@@ -15,34 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.9
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.9
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: csl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: observer
   requirement: !ruby/object:Gem::Requirement
@@ -58,24 +52,16 @@ 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
+- sylvester@keil.or.at
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".document"
-- ".github/workflows/ci.yml"
-- ".yardopts"
-- AGPL
 - BSDL
-- Gemfile
 - README.md
-- Rakefile
-- cucumber.yml
 - lib/citeproc/ruby.rb
 - lib/citeproc/ruby/engine.rb
 - lib/citeproc/ruby/format.rb
@@ -102,7 +88,10 @@ files:
 homepage: https://github.com/inukshuk/citeproc-ruby
 licenses:
 - BSD-2-Clause
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/inukshuk/citeproc-ruby
+  bug_tracker_uri: https://github.com/inukshuk/citeproc-ruby/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -110,14 +99,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.22
 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/

data/.document

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

data/.github/workflows/ci.yml

@@ -1,33 +0,0 @@
-name: CI
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_WITHOUT: debug:extra
-    strategy:
-      matrix:
-        ruby-version:
-          - '3.4'
-          - '3.3'
-          - '3.2'
-          - '3.1'
-    steps:
-      - 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/.yardopts

@@ -1,2 +0,0 @@
---no-private
---document