csl 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f6649dcc754264a3546a210a92cc4dd50ed8910ef011d61c0db3818cb1c576
-  data.tar.gz: 85ebc13c82b78cfefd1898c1e44380acea10fead06a1ac7bb4a34dc09b51d77b
+  metadata.gz: e483c629270cabba02a203aba157f855f758ee6a479bd3fe609749dbbc5ca4dd
+  data.tar.gz: b12ab1cfcb7d80659cd248d490f1ed5a55c628c6c9ef007207a97046a9788c54
 SHA512:
-  metadata.gz: 1934e44e5893b200dc7ca55d522c3fc0024a0510e2a8d918bc5596f5249adad6c0357cae926ff2d47087404f9d3d58767a8448833d017bd47fbfcb8700922db6
-  data.tar.gz: cab29314253dd59ef4f669e3e649d6bf562eaa9799b8c6384e48a6d20bbc091b4d9a10079929ef960be2997c3879c775eb34c04faf73014693a3c0a0a0e6a080
+  metadata.gz: 3a7ab825b430ba85795216742d476bccab2bab9d38f038f383d0c496b61cd0ffdd1d4f17cd2119e87f011b99a509fd06b8a0869f7734904a8705287117867881
+  data.tar.gz: d5e3fe727078cfd20acbfd7ca3de9ae1d1dc59cd8f259cf90f69245e139f10460553ede8a96f76e7850d105e5542dea3bf78c17cce3a630b1fafa6e03fd9cae2

data/lib/csl/locale/term.rb

@@ -80,10 +80,11 @@ module CSL
         return unless has_ordinals?
 
         options = Term.specialize(options)
+        form, options = options[:form], options.except(:form)
         number = number.to_i.abs
 
         # try to match long-ordinals first
-        if options.delete(:form).to_s =~ /^long/i
+        if form.to_s =~ /^long/i
           ordinal = lookup_long_ordinal_for number, options
           return ordinal unless ordinal.nil?
         end
@@ -94,9 +95,9 @@ module CSL
         ordinal = send algorithm, number, options
         return ordinal unless ordinal.nil?
 
-        # fallback to non-gendered version
-        if options.delete(:'gender-form')
-          ordinal = send algorithm, number, options
+        # fallback to neuter
+        if options.key?(:'gender-form')
+          ordinal = send algorithm, number, options.merge(:'gender-form' => nil)
         end
 
         ordinal
@@ -342,14 +343,14 @@ module CSL
 
       def singularize
         return text if textnode?
-        children.single.to_s
+        children.single&.text.to_s.strip
       end
 
       alias singular singularize
 
       def pluralize
         return text if textnode?
-        children.multiple.to_s
+        children.multiple&.text.to_s.strip
       end
 
       alias plural pluralize

data/lib/csl/locale.rb

@@ -55,7 +55,7 @@ module CSL
         error = nil
 
         candidates.each do |candidate|
-          return super(candidate)
+          return super(candidate).tap { |locale| locale.requested = tag }
         rescue ParseError => e
           error ||= e
         end
@@ -119,6 +119,10 @@ module CSL
 
     attr_accessor :region, :script
 
+    # @return [String, nil] the IETF tag the locale was loaded for;
+    #   this differs from the locale's own tag if the locale is a fallback
+    attr_accessor :requested
+
     alias_child :metadata, :info
     alias_child :dates, :date
     alias_child :options, :style_options
@@ -171,6 +175,7 @@ module CSL
     def initialize_copy(other)
       @parent, @ancestors, @descendants, @siblings, @root, @depth = nil
       initialize(other.attributes.to_hash.merge(:lang => other.to_s))
+      @requested = other.requested
     end
 
     def added_to(node)
@@ -266,8 +271,9 @@ module CSL
     #   de.ordinalize(13)
     #   #-> "13."
     #
-    #   de.ordinalize(3, :form => :long, :gender => :feminine)
-    #   #-> "dritte"
+    #   fr = Locale.load('fr')
+    #   fr.ordinalize(1, :'gender-form' => 'feminine')
+    #   #-> "1ʳᵉ"
     #
     # @note
     #   For CSL 1.0 (and older) locales that do not define an "ordinal-00"
@@ -279,8 +285,12 @@ module CSL
     # @param options [Hash] formatting options
     #
     # @option options [:short,:long] :form (:short) which ordinals form to use
-    # @option options [:feminine,:masculine,:neutral] :gender (:neutral)
-    #   which ordinals gender-form to use
+    # @option options ['feminine','masculine',nil] :'gender-form' (nil)
+    #   which ordinals gender-form to use; falls back to the neuter
+    #   ordinals (without gender-form)
+    # @option options [String] :noun the name of the term accompanied by
+    #   the ordinal (e.g., "edition" or "month-01"); the ordinal uses the
+    #   gender of the term unless a gender-form is given
     #
     # @raise [ArgumentError] if number cannot be converted to an integer
     #
@@ -290,6 +300,12 @@ module CSL
         number.respond_to?(:to_i)
 
       number = number.to_i
+
+      noun = terms.lookup(options[:noun]) if options.key?(:noun)
+      if noun&.gendered? && !options.key?(:'gender-form')
+        options = options.merge(:'gender-form' => noun.gender)
+      end
+
       ordinal = terms.ordinalize number, options
 
       return number.to_s if ordinal.nil?
@@ -300,8 +316,7 @@ module CSL
 
     # @return [Boolean] true when the option limit-day-ordinals-to-day-1 is true
     def limit_day_ordinals?
-      return false unless has_options? && options.attribute?(:'limit-day-ordinals-to-day-1')
-      !!(options[:'limit-day-ordinals-to-day-1'].to_s =~ /^true$/i)
+      has_options? && options.boolean_attribute(:'limit-day-ordinals-to-day-1')
     end
 
     def limit_day_ordinals!
@@ -314,8 +329,7 @@ module CSL
 
     # @return [Boolean] true when the option punctuation-in-quote is true
     def punctuation_in_quote?
-      return false unless has_options? && options.attribute?(:'punctuation-in-quote')
-      !!(options[:'punctuation-in-quote'].to_s =~ /^true$/i)
+      has_options? && options.boolean_attribute(:'punctuation-in-quote')
     end
     alias punctuation_in_quotes? punctuation_in_quote?
 
@@ -399,13 +413,13 @@ module CSL
 
     # @returns [Boolean] whether or not the Locale is the default locale
     def default?
-      to_s == Locale.default
+      default_tag?(language, script, region)
     end
 
     # @return [Boolean] whehter or not the Locale's region is the default
     #   region for its language
     def default_region?
-      region && region == Locale.regions[language]
+      default_region_for?(language, region)
     end
 
     # @return [Boolean] whether or not the Locale's language is the default
@@ -414,11 +428,25 @@ module CSL
       language && language == Locale.languages[region]
     end
 
+    # Whether or not the passed-in locale (e.g., an in-style locale)
+    # matches this locale. This is the case for universal locales and
+    # for locales of the language this locale was requested for.
     def like?(other)
       return false unless other.is_a? Locale
       return true  if other.universal?
 
-      language == other.language
+      requested_language == other.language
+    end
+
+    # @return [Symbol, nil] the language this locale was requested for
+    def requested_language
+      requested.nil? ? language : requested.split('-')[0].to_sym
+    end
+
+    # @return [Boolean] whether or not the locale was loaded as a
+    #   fallback for a different locale
+    def fallback?
+      !requested.nil? && requested != to_s
     end
 
     def universal?
@@ -461,44 +489,76 @@ module CSL
     # de-DE will come before de-AT even though the alphabetical order
     # would be different).
     #
+    # Fallback locales are compared as the locale they were requested
+    # for (see #requested); locale data (terms, dates, and options) is
+    # not compared.
+    #
     # @param other [Locale] the locale used for comparison
     # @return [1,0,-1,nil] the result of the comparison
     def <=>(other)
+      return nil unless other.is_a?(Locale)
+      compare(identity, other.identity)
+    end
+
+    # @return [String] the Locale's IETF tag
+    def to_s
+      [language, script, region].compact.join('-')
+    end
+
+    # @return [String] a string representation of the Locale
+    def inspect
+      "#<#{self.class.name} #{to_s}>"
+    end
+
+    protected
+
+    # @return [Array<Symbol, nil>] language, script, and region of the
+    #   locale or, for fallback locales, of the requested tag
+    def identity
+      return [language, script, region] unless fallback?
+
+      language, *rs = requested.split('-').map(&:to_sym)
+      region, script = rs.reverse
+
+      [language, script, region]
+    end
+
+    private
+
+    # Compares two locale identities (see #identity).
+    def compare(a, b)
+      language, script, region = a
+      other_language, other_script, other_region = b
+
       case
-      when !other.is_a?(Locale)
-        nil
-      when [language, region] == [other.language, other.region]
-        script <=> other.script
-      when default?
+      when [language, region] == [other_language, other_region]
+        script <=> other_script
+      when default_tag?(*a)
         -1
-      when other.default?
+      when default_tag?(*b)
         1
-      when language == other.language
+      when language == other_language
         case
-        when default_region?
+        when default_region_for?(language, region)
           -1
-        when other.default_region?
+        when default_region_for?(other_language, other_region)
           1
         else
-          region.to_s <=> other.region.to_s
+          region.to_s <=> other_region.to_s
         end
       else
-        language.to_s <=> other.language.to_s
+        language.to_s <=> other_language.to_s
       end
     end
 
-    # @return [String] the Locale's IETF tag
-    def to_s
-      [language, script, region].compact.join('-')
+    def default_tag?(language, script, region)
+      [language, script, region].compact.join('-') == Locale.default
     end
 
-    # @return [String] a string representation of the Locale
-    def inspect
-      "#<#{self.class.name} #{to_s}>"
+    def default_region_for?(language, region)
+      region && region == Locale.regions[language]
     end
 
-    private
-
     alias original_locale_attribute_assignments attribute_assignments
 
     def attribute_assignments
@@ -549,6 +609,9 @@ module CSL
     def merge_terms(other)
       return self unless other.has_terms?
 
+      # Ordinals are replaced as a set
+      terms.drop_ordinals if has_terms? && other.terms.has_ordinals?
+
       other.each_term do |term|
         store term.deep_copy
       end

data/lib/csl/node.rb

@@ -168,13 +168,10 @@ module CSL
           end
 
           def fetch(key, default = nil)
-            value = keys.include?(key.to_sym) && send(:'[]', key)
+            value = send(:'[]', key) if keys.include?(key.to_sym)
+            return value unless value.nil?
 
-            if block_given?
-              value || yield(key)
-            else
-              value || default
-            end
+            block_given? ? yield(key) : default
           end
 
           # Merges the current with the passed-in attributes.
@@ -307,6 +304,17 @@ module CSL
       attributes.fetch(name, false)
     end
 
+    # @param name [Symbol] the name of an xsd:boolean attribute
+    # @param default [Boolean] the value if the attribute is not set
+    # @return [Boolean] the value of the boolean attribute
+    def boolean_attribute(name, default = false)
+      case attributes.fetch(name, nil).to_s
+      when 'true', '1' then true
+      when 'false', '0' then false
+      else default
+      end
+    end
+
     # @param [[String]] names list of attribute names
     # @return [Boolean] true if the node contains attributes for all
     #   passed-in names; false otherwise.
@@ -466,11 +474,11 @@ module CSL
     end
 
     def strip_periods?
-      attribute?(:'strip-periods') && !!(attributes[:'strip-periods'].to_s =~ /^true$/i)
+      boolean_attribute(:'strip-periods')
     end
 
     def quotes?
-      attribute?(:'quotes') && !!(attributes[:'quotes'].to_s =~ /^true$/i)
+      boolean_attribute(:quotes)
     end
 
 
@@ -573,17 +581,6 @@ module CSL
       CSL.encode_xml_text text.to_s.strip
     end
 
-    # TextNodes quack like a string.
-    # def_delegators :to_s, *String.instance_methods(false).reject do |m|
-    #   m.to_s =~ /^\W|!$|(?:^(?:hash|eql?|to_s|length|size|inspect)$)/
-    # end
-    #
-    # String.instance_methods(false).select { |m| m.to_s =~ /!$/ }.each do |m|
-    #   define_method(m) do
-    #     content.send(m) if content.respond_to?(m)
-    #   end
-    # end
-
     def initialize(argument = '')
       case
       when argument.respond_to?(:each_pair)

data/lib/csl/style/bibliography.rb

@@ -25,6 +25,10 @@ module CSL
         children[:sort].sort_keys
       end
 
+      def second_field_align?
+        attribute?(:'second-field-align')
+      end
+
       def substitute_subsequent_authors?
         attribute?(:'subsequent-author-substitute')
       end

data/lib/csl/style/date.rb

@@ -64,6 +64,49 @@ module CSL
       def has_overrides?
         localized? && has_parts?
       end
+
+      # Localized dates use the date parts of the locale's date in the
+      # same form, filtered by the date-parts attribute; the date parts of
+      # this date override their attributes, except for the affixes.
+      #
+      # @param locale [CSL::Locale]
+      # @raise [CSL::Error] if the locale has no date in the same form
+      # @return [Array<CSL::Style::DatePart, CSL::Locale::DatePart>]
+      #   the date parts to use
+      def parts_for(locale)
+        return parts unless localized?
+
+        filter = parts_filter
+
+        localized_date_for(locale).parts
+          .select { |part| filter.include?(part.name) }
+          .map { |part| override(part) }
+      end
+
+      # @param locale [CSL::Locale]
+      # @raise [CSL::Error] if the locale has no date in the same form
+      # @return [String] the delimiter to use
+      def delimiter_for(locale)
+        localized? ? localized_date_for(locale).delimiter : delimiter
+      end
+
+      private
+
+      def localized_date_for(locale)
+        locale.each_date.detect { |date| date.form == form } or
+          raise Error, "no localized date for form #{form} found"
+      end
+
+      # @return [CSL::Locale::DatePart] the part or a copy
+      #   with the attributes of the matching date part
+      def override(part)
+        override = parts.detect { |p| p.name == part.name }
+        return part if override.nil?
+
+        copy = part.deep_copy
+        copy.merge! override.attributes.to_hash.except(:prefix, :suffix)
+        copy
+      end
     end
 
     class DatePart < Node

data/lib/csl/style/names.rb

@@ -181,8 +181,11 @@ module CSL
         self
       end
 
+      # @param names [#to_i, Enumerable] the list of names (or its length)
+      # @return [Boolean] whether or not the delimiter will be inserted
+      #   before et-al
       def delimiter_precedes_et_al?(names)
-        names = names.length if names.respond_to?(:length)
+        count = names.respond_to?(:length) ? names.length : names.to_i
 
         case
         when delimiter_never_precedes_et_al?
@@ -190,9 +193,9 @@ module CSL
         when delimiter_always_precedes_et_al?
           true
         when delimiter_precedes_et_al_after_inverted_name?
-          name_as_sort_order_at?(names.to_i)
+          inverted_at?(names, count)
         else
-          names.to_i > 1
+          count > 1
         end
       end
 
@@ -229,7 +232,7 @@ module CSL
       #   be inserted between before et-al depending on the
       #   number of names rendered
       def delimiter_contextually_precedes_et_al?
-        return true unless attribute?[:'delimiter-precedes-et-al']
+        return true unless attribute?(:'delimiter-precedes-et-al')
         !!(attributes[:'delimiter-precedes-et-al'].to_s =~ /^contextual/i)
       end
 
@@ -253,7 +256,7 @@ module CSL
       # @return [Boolean] whether or not the delimiter will be inserted between
       #   the penultimate and the last name
       def delimiter_precedes_last?(names)
-        names = names.length if names.respond_to?(:length)
+        count = names.respond_to?(:length) ? names.length : names.to_i
 
         case
         when !attribute?(:and)
@@ -263,14 +266,9 @@ module CSL
         when delimiter_always_precedes_last?
           true
         when delimiter_precedes_last_after_inverted_name?
-          if name_as_sort_order?
-            all_names_as_sort_order? || names.to_i == 2
-          else
-            false
-          end
-
+          inverted_at?(names, count - 1)
         else
-          names.to_i > 2
+          count > 2
         end
       end
 
@@ -327,7 +325,7 @@ module CSL
       end
 
       def ellipsis?
-        attributes[:'et-al-use-last'].to_s =~ /^true$/
+        boolean_attribute(:'et-al-use-last')
       end
 
       def ellipsis
@@ -342,6 +340,21 @@ module CSL
       def connector=(c)
         attributes[:and] = c
       end
+
+      private
+
+      # @param names [#to_i, Enumerable] the list of names (or its length)
+      # @param position [Integer] the position of the name (starting at 1)
+      # @return [Boolean] whether or not the name at the position is
+      #   inverted; names which are not invertible (e.g., literal names)
+      #   never are
+      def inverted_at?(names, position)
+        return false unless name_as_sort_order_at?(position)
+        return true unless names.is_a?(Enumerable)
+
+        name = names.to_a[position - 1]
+        !name.respond_to?(:invertible?) || name.invertible?
+      end
     end
 
     class NamePart < Node

data/lib/csl/style.rb

@@ -74,6 +74,15 @@ module CSL
       @errors = Schema.validate self
     end
 
+    # Merges the style's overrides into the given locale. 
+    #
+    # @param locale [Locale]
+    # @return [Locale]
+    def localize(locale)
+      overrides = locales.sort.reverse.select { |other| locale.like?(other) }
+      overrides.empty? ? locale : locale.merge(*overrides)
+    end
+
     def valid?
       validate.empty?
     end
@@ -127,7 +136,7 @@ module CSL
     alias demote_particle? demote_non_dropping_particle?
 
     def initialize_without_hyphen?
-      attribute?(:'initialize-with-hyphen') && !attributes[:'initialize-with-hyphen']
+      !boolean_attribute(:'initialize-with-hyphen', true)
     end
 
     def has_page_range_format?

data/lib/csl/treelike.rb

@@ -33,12 +33,17 @@ module CSL
     end
     alias delete delete_children
 
-    # Deletes child nodes that are equal to the passed-in node. Returns all
-    # deleted children. If no children were deleted, returns nil. If the
-    # optional block is given, returns the result block if no children were
-    # deleted.
+    # Deletes the passed-in child node.
+    # Returns the deleted child.
+    # If the node is not a child, returns nil or,
+    # if the optional block is given, the result of the block.
     def delete_child(child)
-      deleted = children.delete child
+      deleted = if children.is_a?(Array)
+        index = children.index { |node| node.equal?(child) }
+        children.delete_at(index) unless index.nil?
+      else
+        children.delete child
+      end
 
       case
       when deleted.nil? && block_given?
@@ -423,18 +428,19 @@ module CSL
 
           alias << push
 
-          # Delete items from self that are equal to node. If any items are
-          # found, returns the deleted items. If the items is not found,
-          # returns nil. If the optional code block is given, returns the
-          # result og block if the item is not found.
+          # Deletes the passed-in node; other, equal nodes are not deleted.
+          # Returns the deleted node or nil if the node is not found.
+          # If the optional code block is given,
+          # returns the result of the block if the node is not found.
           def delete(node)
             return nil unless node.respond_to?(:nodename)
 
             deleted = resolve(node.nodename)
             if deleted.kind_of?(Array)
-              deleted = deleted.delete(node)
+              index = deleted.index { |other| other.equal?(node) }
+              deleted = index.nil? ? nil : deleted.delete_at(index)
             else
-              if deleted == node
+              if deleted.equal?(node)
                 self[node.nodename] = nil
               else
                 deleted = nil
@@ -442,7 +448,7 @@ module CSL
             end
 
             # Delete node from ordered list as well
-            @order.delete(node)
+            @order.delete_if { |other| other.equal?(node) }
 
             if deleted.nil? && block_given?
               yield

data/lib/csl/version.rb

@@ -1,3 +1,3 @@
 module CSL
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.5.0'.freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: csl
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Sylvester Keil
 bindir: bin
 cert_chain: []
-date: 2026-10-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: namae
@@ -112,7 +112,7 @@ description: |
   an open XML-based language to describe the formatting of citations
   and bibliographies.
 email:
-- http://sylvester.keil.or.at
+- sylvester@keil.or.at
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -159,7 +159,10 @@ files:
 homepage: https://github.com/inukshuk/csl-ruby
 licenses:
 - BSD-2-Clause
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/inukshuk/csl-ruby
+  bug_tracker_uri: https://github.com/inukshuk/csl-ruby/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib