citeproc 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9053957ce407de4b219008b6f732e9037a6bdec99dc4e04792bb8ca4f46f9f42
-  data.tar.gz: 96e2cbde7609f0fc9aa2c52d972a7ab51e16bce2cb3412d7042c02f32a47c08f
+  metadata.gz: 8708658d44ed66deb17744c846697187edbcd1f6dc308c4bf3bc69933ede3e7e
+  data.tar.gz: 1d1af4037b6dae14f20adffdbb7e51b35ecd02728586f95932348416788347c1
 SHA512:
-  metadata.gz: b2e50088fd201c2546614cb5e90e6862d4b4b07ec3b5a87262b9bd70cfd453e1dc051ffaaa02379e10b709da5f5c455eca61b003b31049165a9ebf8f79f7ba63
-  data.tar.gz: 636492e1a454f7f6a3ade9c30c1346cd036df0067be69b3d4102cf0b590df0959aa6dab6a619bd17333512ab6723c4d3a6823bc66fe6b334c2e9a001e5fffcae
+  metadata.gz: 4dc2d276583d4071cf17459265a3c706f8eb4091c59527a80506241e8f5187de4eba9f6cb140e560327fde38f8e8225348818dfeda0e1b2b98ef53acb67c5064
+  data.tar.gz: 33de631e29bd0e3484a0509e4f61bfb4e2b59fe87aeb8e7cbd25c1d9065ce20588637725f00d9f88ab2e19bcee765d3a19bc71d25adced9135d6a74627018279

data/README.md

@@ -86,10 +86,9 @@ 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.
+Similarly, you can install the
+[EDTF](https://rubygems.org/gems/edtf)
+gem to support a wide range of additional inputs for date variables.
 
 CSL Styles and Locales
 ----------------------

data/lib/citeproc/attributes.rb

@@ -37,7 +37,7 @@ module CiteProc
       return false if value.nil?
       return false if value.respond_to?(:empty?) && value.empty?
 
-      value.to_s !~ /^(false|no|never)$/i
+      value.to_s !~ /^(false|no|never|0)$/i
     end
 
     def filter_key(key)
@@ -108,7 +108,7 @@ module CiteProc
       case
       when equal?(other)
         true
-      when self.class != other.class, length != other.length
+      when self.class != other.class, attributes.length != other.attributes.length
         false
       else
         other.attributes.each_pair do |key, value|

data/lib/citeproc/bibliography.rb

@@ -193,7 +193,7 @@ module CiteProc
     end
 
     def hanging_indent?
-      options[:'hanging_indent']
+      CiteProc.boolean(options[:'hanging-indent'])
     end
 
     def join()

data/lib/citeproc/citation_data.rb

@@ -11,12 +11,72 @@ module CiteProc
     include Comparable
 
     @labels = [
-      :book, :chapter, :column, :figure, :folio, :issue, :line, :note, :opus,
-      :page, :paragraph, :part, :section, :'sub-verbo', :verse, :volume
+      :act,
+      :appendix,
+      :'article-locator',
+      :book,
+      :canon,
+      :chapter,
+      :column,
+      :elocation,
+      :equation,
+      :figure,
+      :folio,
+      :issue,
+      :line,
+      :note,
+      :opus,
+      :page,
+      :paragraph,
+      :part,
+      :rule,
+      :scene,
+      :section,
+      :'sub-verbo',
+      :supplement,
+      :table,
+      :timestamp,
+      :'title-locator',
+      :verse,
+      :version,
+      :volume
     ].freeze
 
+    # Abbreviations of locator labels (for extraction)
+    @locator_abbreviations = {
+      'app.' => 'appendix',
+      'art.' => 'article-locator',
+      'bk.' => 'book',
+      'ch.' => 'chapter',
+      'col.' => 'column',
+      'fig.' => 'figure',
+      'fol.' => 'folio',
+      'l.' => 'line',
+      'n.' => 'note',
+      'no.' => 'issue',
+      'op.' => 'opus',
+      'p.' => 'page',
+      'pp.' => 'page',
+      'para.' => 'paragraph',
+      'pt.' => 'part',
+      'r.' => 'rule',
+      'sec.' => 'section',
+      'supp.' => 'supplement',
+      'sv.' => 'sub-verbo',
+      'tbl.' => 'table',
+      'tit.' => 'title-locator',
+      'vol.' => 'volume',
+      'vrs.' => 'verse'
+    }.freeze
+
     class << self
-      attr_reader :labels
+      attr_reader :labels, :locator_abbreviations
+
+      # @param abbreviations [Hash<String,String>] label abbreviations
+      # @return [Regexp] a pattern matching any of the abbreviations
+      def locator_label_pattern(abbreviations = locator_abbreviations)
+        Regexp.union(abbreviations.keys.sort_by { |abbr| -abbr.length })
+      end
     end
 
     # @!attribute id
@@ -66,6 +126,32 @@ module CiteProc
       yield self if block_given?
     end
 
+    # @return [String, nil] the locator label;
+    #   defaults to "page" if there is a locator
+    def label
+      read_attribute(:label) || ('page' if locator?)
+    end
+
+    # Moves a label at the start of the locator into the label
+    # (e.g., "vol. 1" becomes "1" with the label "volume") unless
+    # the item has a label other than "page".
+    #
+    # @param abbreviations [Hash<String,String>] label abbreviations
+    # @return [self]
+    def parse_locator!(abbreviations = CitationItem.locator_abbreviations)
+      return self unless locator? && label.to_s == 'page'
+
+      pattern = CitationItem.locator_label_pattern(abbreviations)
+      match = /\A(#{pattern})\s+(.+)\z/m.match(locator.to_s)
+
+      unless match.nil?
+        self.label = abbreviations[match[1]]
+        self.locator = match[2]
+      end
+
+      self
+    end
+
     def initialize_copy(other)
       @attributes = other.attributes.deep_copy
     end
@@ -83,8 +169,6 @@ module CiteProc
   end
 
 
-
-
   class CitationData
 
     extend Forwardable

data/lib/citeproc/date.rb

@@ -7,8 +7,8 @@ module CiteProc
   #
   # {Date Dates} can be constructed from a wide range of input values,
   # including Ruby date objects, integers, date ranges, ISO 8601 and
-  # CiteProc JSON strings or hashes, and - provided you have the respective
-  # gems installed - EDTF strings all strings supported by Chronic.
+  # CiteProc JSON strings or hashes, and - provided you have the EDTF gem
+  # installed - EDTF strings.
   #
   # @example Initialization
   #   CiteProc::Date.new
@@ -17,9 +17,6 @@ module CiteProc
   #   CiteProc::Date.today
   #   #-> #<CiteProc::Date "[2012, 6, 10]">
   #
-  #   CiteProc::Date.new('Yesterday')
-  #   #-> #<CiteProc::Date "[[2012, 6, 9]]">
-  #
   #   CiteProc::Date.new(1966)
   #   #-> #<CiteProc::Date "[1966]">
   #
@@ -129,6 +126,18 @@ module CiteProc
         !bc? && year < 1000
       end
 
+      # Seasons may be encoded as months 21 to 24 (Spring to Winter).
+      # @return [Integer, nil] the season (1 to 4) or nil if the
+      #   month does not encode a season
+      def season
+        month - 20 if month && month.between?(21, 24)
+      end
+
+      # @return [Boolean] whether or not the month encodes a season
+      def season?
+        !season.nil?
+      end
+
       # Formats the date parts according to the passed-in format string.
       # @param format [String] a format string
       # @return [String,nil] the formatted date string; nil if the date
@@ -148,8 +157,10 @@ module CiteProc
       # @return [Fixnum,nil] the result of the comparison (-1, 0, 1 or nil)
       def <=>(other)
         case
+        when other.is_a?(DateParts) && season? && other.season?
+          [year, season] <=> [other.year, other.season]
         when other.is_a?(DateParts)
-          to_citeproc <=> other.to_citeproc
+          comparable <=> other.comparable
         when other.respond_to?(:to_date)
           to_date <=> other.to_date
         else
@@ -192,6 +203,14 @@ module CiteProc
       def inspect
         "#<DateParts #{to_s}>"
       end
+
+      protected
+
+      # Seasons are compared like dates without month.
+      # @return [Array<Fixnum>] the date parts used for comparison
+      def comparable
+        season? ? to_citeproc.take(1) : to_citeproc
+      end
     end
 
     #
@@ -210,13 +229,11 @@ module CiteProc
     # List of date parsers (must respond to #parse)
     @parsers = []
 
-    [%w{ edtf EDTF }, %w{ chronic Chronic }].each do |date_parser, module_id|
-      begin
-        require date_parser
-        @parsers << ::Object.const_get(module_id)
-      rescue LoadError
-        # warn "failed to load `#{date_parser}' gem"
-      end
+    begin
+      require 'edtf'
+      @parsers << ::EDTF
+    rescue LoadError
+      # warn "failed to load `edtf' gem"
     end
 
     @parsers << ::Date
@@ -229,9 +246,8 @@ module CiteProc
       # A list of available date parsers. Each parser must respond to a
       # #parse method that converts a date string into a Ruby date object.
       # By default, the list will include Ruby's date parser from the
-      # standard library, as well as the parsers of the Chronic and EDTF
-      # gems if they are available; to install the latter on your system
-      # make sure to `gem install chronic edtf`.
+      # standard library, as well as the parser of the EDTF gem if it is
+      # available; to install it on your system run `gem install edtf`.
       #
       # @return [Array] the available date parsers
       attr_reader :parsers
@@ -276,12 +292,44 @@ module CiteProc
     end
 
 
-    # Make Date behave like a regular Ruby Date
-    def_delegators :to_ruby, *::Date.instance_methods(false).reject { |m|
-      m.to_s =~ /^[\W_]|[!=_]$|^(to_s|inspect|dup|clone|change)$|^(marshal|season|year|month|day|certain|uncertain)/
-    }
+    def_delegators :to_ruby, :strftime
+
+    attr_predicates :circa, :literal, :'date-parts'
+
+    # @return [Boolean] whether or not the date has a season field
+    def has_season?
+      attribute?(:season)
+    end
+
+    def season=(season)
+      write_attribute :season, season
+    end
+
+    # Season names recognized in the season field
+    SEASONS = {
+      'spring' => 1, 'summer' => 2, 'autumn' => 3, 'fall' => 3, 'winter' => 4
+    }.freeze
+
+    # A season takes the place of the month. If the (start) date has a
+    # month, the season is encoded by the month (21 to 24); otherwise
+    # the season field is used. Season numbers (1 to 4) and names in
+    # the season field are converted to integers.
+    #
+    # @return [Integer, String, nil] the season (1 to 4), the season
+    #   field as a string if it is not a season number or name, or nil
+    def season
+      return parts[0].season if month
 
-    attr_predicates :circa, :season, :literal, :'date-parts'
+      value = read_attribute(:season) or return
+      name = value.to_s.strip.downcase
+
+      SEASONS[name] || (name.match?(/\A[1-4]\z/) ? name.to_i : value.to_s)
+    end
+
+    # @return [Boolean] whether or not the date has a season (see #season)
+    def season?
+      !season.nil?
+    end
 
     def initialize(value = {})
       super
@@ -321,11 +369,15 @@ module CiteProc
       when value.is_a?(Hash)
         attributes = value.symbolize_keys
 
-        if attributes.has_key?(:raw)
-          @value = Date.parse(attributes.delete(:raw)).value
+        if attributes.has_key?(:raw) && Array(attributes[:'date-parts']).empty?
+          raw = attributes.delete(:raw)
+          attributes.delete(:'date-parts')
+          date = Date.parse(raw)
+
+          @value = date.nil? ? { :literal => raw } : date.value
           @value.merge!(attributes)
         else
-          @value = attributes.deep_copy
+          @value = attributes.except(:raw).deep_copy
         end
         convert_parts!
 
@@ -397,34 +449,16 @@ module CiteProc
       d
     end
 
-    # @return [::Date,nil] the date (start date if this instance is a range); or nil
-    def start_date
-      d = parts[0] and d.to_date
-    end
-
-    def start_date=(date)
-      parts[0] = DateParts.new(date.strftime('%Y-%m-%d').split(/-/))
-    end
-
-    def end_date=(date)
-      parts[1] = DateParts.new(date.nil? ? 0 : date.strftime('%Y-%m-%d').split(/-/))
-    end
-
-    # @return [Date,Range] the date as a Ruby date object or as a Range if
-    #   this instance is closed range
+    # @return [::Date, Range, nil] the date as a Ruby date object or as
+    #   a Range if this instance is closed range
     def to_ruby
       if closed_range?
-        start_date..end_date
+        parts[0].to_date..parts[1].to_date
       else
-        start_date
+        d = parts[0] and d.to_date
       end
     end
 
-    # @return [::Date,nil] the range's end date; or nil
-    def end_date
-      d = parts[1] and d.to_date
-    end
-
     # @return [Boolean] whether or not the date-parts contain an end date
     def has_end_date?
       parts[1] && !parts[1].empty?
@@ -506,7 +540,7 @@ module CiteProc
       case
       when literal?
         literal
-      when season?
+      when has_season?
         season
       else
         parts.map(&:to_citeproc).inspect
@@ -516,8 +550,14 @@ module CiteProc
     def <=>(other)
       case other
       when CiteProc::Date
-        return nil if season? || other.season?
-        parts <=> other.parts
+        result = parts <=> other.parts
+
+        # Seasons are ordered among themselves only
+        if result == 0 && season? && other.season?
+          result = season.to_i <=> other.season.to_i
+        end
+
+        result
       when ::Date
         parts <=> [other]
       else

data/lib/citeproc/names.rb

@@ -92,20 +92,19 @@ module CiteProc
     end
 
     # Names quack sorta like a String
-    def_delegators :to_s, :=~, :===, *String.instance_methods(false).reject { |m|
-      m.to_s =~ /^[\W_]|[!=_]$|^(to_s|inspect|replace|first|last|dup|clone)$/
-    }
+    def_delegators :to_s,
+      :to_str,
+      :=~, :===, :match, :match?, :start_with?, :end_with?, :include?,
+      :upcase, :downcase, :capitalize, :sub, :gsub, :split, :strip
 
-    # Delegate bang! methods to each field's value
-    String.instance_methods(false).each do |m|
-      if m.to_s.end_with?('!')
-        define_method(m) do |*arguments, &block|
-          Name.parts.each do |part|
-            p = attributes[part]
-            p.send(m, *arguments, &block) if p.respond_to?(m)
-          end
-          self
+    # Delegate in-place transformations to each field's value
+    [:gsub!, :sub!, :upcase!, :downcase!, :capitalize!, :strip!].each do |m|
+      define_method(m) do |*arguments, &block|
+        Name.parts.each do |part|
+          p = attributes[part]
+          p.send(m, *arguments, &block) if p.respond_to?(m)
         end
+        self
       end
     end
 
@@ -236,7 +235,7 @@ module CiteProc
 
     # @return [Boolean] whether or not initials will be used for printing
     def initials?
-      !!options[:'initialize-with'] && personal? && romanesque?
+      !!options[:'initialize-with'] && personal? && family? && romanesque?
     end
 
     def initialize_with
@@ -244,7 +243,7 @@ module CiteProc
     end
 
     def initialize_existing_only?
-      options[:initialize].to_s == 'false'
+      !CiteProc.boolean(options[:initialize], true)
     end
 
     def initialize_without_hyphen?
@@ -259,8 +258,6 @@ module CiteProc
       case
       when !initials?
         given
-      when initialize_existing_only?
-        existing_initials_of given
       else
         initials_of given
       end
@@ -321,7 +318,7 @@ module CiteProc
       when literal?
         literal.to_s
       when static_order?
-        [family, initials].compact.join(' ')
+        [family, initials].compact.join(romanesque? ? ' ' : '')
       when !short_form?
         case
         when !sort_order?
@@ -356,7 +353,7 @@ module CiteProc
 
     # @return [String] the name as a string stripped off all markup
     def strip_markup
-      gsub(Variable.markup, '')
+      to_s.gsub(Variable.markup, '')
     end
 
     # @return [self] the name with all parts stripped off markup
@@ -384,36 +381,30 @@ module CiteProc
 
     def initials_of(string)
       return unless string
-      string = string.dup
-
-      string.gsub!(/([[:upper:]])[^[:upper:]\s-]*\s*/, "\\1#{initialize_with}")
 
-      initialize_hyphen!(string)
-
-      string.strip!
-      string
-    end
-
-    def initialize_hyphen!(string)
-      if initialize_without_hyphen?
-        string.tr!('-', '')
-      else
-        string.gsub!(/\s*-/, '-')
+      # Split abbreviations like "M.E" into "M. E"
+      string = string.gsub(/\.(?=[[:alpha:]])/, '. ')
+      string = string.tr('-', ' ') if initialize_without_hyphen?
+
+      string.scan(/([^\s-]+)\s*(-)?\s*/).map { |part, hyphen|
+        part = initial_of(part) || " #{part} "
+        hyphen ? "#{part.rstrip}-" : part
+      }.join.gsub(/-\s+/, '-').squeeze(' ').strip
+    end
+
+    # @return [String, nil] the initial for the given part of a name
+    #   or nil if the part should not be initialized
+    def initial_of(part)
+      case part
+      when /\A([[:upper:]])\z/, /\A(.+)\.\z/
+        "#{$1}#{initialize_with}"
+      when /\A[[:upper:]]{2}[[:lower:]]/
+        # Two letter initials like "Ts" for "TSerendorjiin"
+        "#{part[0, 2].capitalize}#{initialize_with}" unless initialize_existing_only?
+      when /\A[[:upper:]]/
+        "#{part[0]}#{initialize_with}" unless initialize_existing_only?
       end
     end
-
-    def existing_initials_of(string)
-      return unless string
-      string = string.dup
-
-      string.gsub!(/([[:upper:]])([[:upper:]])/, '\1 \2')
-      string.gsub!(/\b([[:upper:]])\b[^[:alpha:]-]*/, "\\1#{initialize_with}")
-
-      initialize_hyphen!(string)
-
-      string.strip!
-      string
-    end
   end
 
 

data/lib/citeproc/number.rb

@@ -13,9 +13,15 @@ module CiteProc
       ['i',    1]
     ].freeze
 
+    # Numbers (with optional prefixes and suffixes) or roman numerals
+    RANGE_BOUND = /(?:[[:alnum:]]*\d[[:alnum:]]*|[ivxlcdm]+)/i
+
+    # Ranges between numbers; escaped hyphens are not range delimiters
+    RANGE = /(?<![[:alnum:]])#{RANGE_BOUND}\s*[–-]\s*#{RANGE_BOUND}(?![[:alnum:]])/
+
     class << self
       def pluralize?(string)
-        /\S[\s,&–-]\S|\df/ === string
+        /\S[\s,&]\S|\df/.match?(string) || RANGE.match?(string)
       end
 
       # @param number [#to_i] the number to convert

data/lib/citeproc/selector.rb

@@ -19,11 +19,12 @@ module CiteProc
 
     attr_reader :type, :conditions, :skip_conditions, :custom_matcher
 
-    def initialize(attributes = nil)
+    def initialize(attributes = nil, &block)
       @conditions, @skip_conditions = {}, {}
 
       if block_given?
         @type = :ruby
+        @custom_matcher = block
 
       else
         unless attributes.nil? || attributes.empty?
@@ -54,12 +55,12 @@ module CiteProc
       @type = other.type
       @conditions = other.conditions.deep_copy
       @skip_conditions = other.skip_conditions.deep_copy
-      @custom_matcher = other
+      @custom_matcher = other.custom_matcher
     end
 
     def type=(type)
       raise TypeError, "failed to set selector type to #{type.inspect}" unless
-        type.respond_to(:to_sym) && Selector.types.include?(type.to_sym)
+        type.respond_to?(:to_sym) && Selector.types.include?(type.to_sym)
 
       @type = type.to_sym
     end
@@ -69,7 +70,7 @@ module CiteProc
     end
 
     def custom_matcher?
-      defined?(@custom_matcher)
+      !custom_matcher.nil?
     end
 
     alias ruby? custom_matcher?

data/lib/citeproc/utilities.rb

@@ -15,6 +15,17 @@ module CiteProc
       process(:bibliography, items, options)
     end
 
+    # @param value [String, Boolean, nil] an xsd:boolean value
+    # @param default [Boolean] the value if the value is not set
+    # @return [Boolean] the boolean value
+    def boolean(value, default = false)
+      case value.to_s
+      when 'true', '1' then true
+      when 'false', '0' then false
+      else default
+      end
+    end
+
   end
 
 end

data/lib/citeproc/variable.rb

@@ -131,12 +131,15 @@ module CiteProc
     # @return [Object] the value wrapped by this variable
     attr_accessor :value
 
+    # In-place transformations of the value
     def_delegators :@value, :to_s,
-      *::String.instance_methods(false).select {|m| m.to_s =~ /!$/ }
+      :gsub!, :sub!, :upcase!, :downcase!, :capitalize!, :strip!
 
-    def_delegators :to_s, :=~, :===, *String.instance_methods(false).reject { |m|
-      m.to_s =~ /^[\W_]|[!=_]$|^(to_s|inspect|replace|first|last|dup|clone|to_f|to_i)$/
-    }
+    # Variables quack sorta like a String
+    def_delegators :to_s,
+      :to_str, :empty?,
+      :=~, :===, :match, :match?, :start_with?, :end_with?, :include?,
+      :upcase, :downcase, :capitalize, :sub, :gsub, :split, :strip
 
 
     # Creates new Variable for the passed-in value
@@ -226,7 +229,7 @@ module CiteProc
 		#
     # @return [Boolean] whether or not the variable's value is numeric
     def numeric?
-      !!match(/^[\w\.:;]*\d+[\w\.:;]*(\s*[,&-]\s*[\w\.:;]*\d+[\w\.:;]*)*$/i)
+      !!to_s.match(/^[\w\.:;]*\d+[\w\.:;]*(\s*[,&-]\s*[\w\.:;]*\d+[\w\.:;]*)*$/i)
     end
 
     def date?
@@ -247,7 +250,7 @@ module CiteProc
 
     # @return [String] the variable's value stripped of markup
     def strip_markup
-      gsub(Variable.markup, '')
+      to_s.gsub(Variable.markup, '')
     end
 
     # Strips markup off the variable's value.
@@ -274,6 +277,20 @@ module CiteProc
       end
     end
 
+    # Variables are equal (in the sense of eql?) if they are of
+    # the same type and have the same value.
+    #
+    # @param other [Object] the object used for comparison
+    # @return [Boolean]
+    def eql?(other)
+      other.instance_of?(self.class) && value.eql?(other.value)
+    end
+
+    # @return [Integer] a hash value based on the type and value
+    def hash
+      [self.class, value].hash
+    end
+
     # @!method to_s
     # @return [String] the variable's value as a string
     alias to_citeproc to_s

data/lib/citeproc/version.rb

@@ -1,3 +1,3 @@
 module CiteProc
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: citeproc
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sylvester Keil
 bindir: bin
 cert_chain: []
-date: 2026-10-05 00:00:00.000000000 Z
+date: 2026-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: namae