csl 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d0cf629adc60121035ae2b8b86b8042a2a3da87b264402fa93fdc7da093f709
-  data.tar.gz: 6d2c61c0e05a1214fcc8653142fcac1a45d63f357f24a434e453d7932caad645
+  metadata.gz: c0f6649dcc754264a3546a210a92cc4dd50ed8910ef011d61c0db3818cb1c576
+  data.tar.gz: 85ebc13c82b78cfefd1898c1e44380acea10fead06a1ac7bb4a34dc09b51d77b
 SHA512:
-  metadata.gz: 5fe9697ec7d2c7308397fe192e912542d255c4317a310f83c51a066463a2f4a3c80a346edf528ead70ae3c95487a40870bfedb7f6d6db23cc1e38d37a022b73a
-  data.tar.gz: 959edc27ca855e1083d4b2e2e23bde12607334d3d38647e0185753c584c10abbcecf48735f9f95e8e8b85db13acad20c405a3419c008f22d100291730ee75e42
+  metadata.gz: 1934e44e5893b200dc7ca55d522c3fc0024a0510e2a8d918bc5596f5249adad6c0357cae926ff2d47087404f9d3d58767a8448833d017bd47fbfcb8700922db6
+  data.tar.gz: cab29314253dd59ef4f669e3e649d6bf562eaa9799b8c6384e48a6d20bbc091b4d9a10079929ef960be2997c3879c775eb34c04faf73014693a3c0a0a0e6a080

data/README.md

@@ -1,48 +1,56 @@
 CSL-Ruby
 ========
 CSL-Ruby provides a Ruby parser and a comprehensive API for the
-[Citation Style Language](http://citationstyles.org) (CSL), an XML-based
-format to describe the formatting of citations, notes and bibliographies.
+[Citation Style Language](https://citationstyles.org) (CSL),
+an XML-based format to describe the formatting
+of citations, notes and bibliographies.
 
 Styles and Locales
 ------------------
-You can load CSL styles and locales by passing a respective XML string, file
-name, or URL. You can also load styles and locales by name if the
-corresponding files are installed in your local styles and locale directories.
+You can load CSL styles and locales
+by passing a respective XML string, file name, or URL.
+You can also load styles and locales by name
+if the corresponding files are installed
+in your local styles and locale directories.
 By default, CSL-Ruby looks for CSL styles and locale files in
 
     /usr/local/share/csl/styles
     /usr/local/share/csl/locales
 
-You can change these locations by changing the value of `CSL::Style.root` and
-`CSL::Locale.root` respectively.
+You can change these locations
+by changing the value of `CSL::Style.root` and `CSL::Locale.root` respectively.
 
-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`.
+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'`.
 
 Usage
 -----
-CSL-Ruby is broadly aimed at two very different usage scenarios: on the one
-hand, you can use the parser to load existing styles and locales and
-manipulate, query or otherwise work with them using a dedicated API: that is
-to say, you do not have to resort to XML-related methods of access, but can
-make use of a large set of library methods which are specific to CSL. This
-is useful, primarily, for citation processors like
-[CiteProc-Ruby](https://github.com/inukshuk/citeproc).
-
-On the other hand, CSL-Ruby makes it easy to create new styles and locales
-using Ruby; this is useful, for example, if you need to change or adapt
-styles on-the-fly or for writing an interactive style editor.
-
-To get you started, here are a few usage examples; for the full set of
-available features, please consult the
-[API documentation](http://rubydoc.info/gems/csl/).
+CSL-Ruby is broadly aimed at two very different usage scenarios:
+on the one hand,
+you can use the parser to load existing styles and locales
+and manipulate, query or otherwise work with them using a dedicated API:
+that is to say,
+you do not have to resort to XML-related methods of access,
+but can make use of a large set of library methods which are specific to CSL.
+This is useful, primarily, for citation processors like
+[CiteProc-Ruby](https://github.com/inukshuk/citeproc-ruby).
+
+On the other hand,
+CSL-Ruby makes it easy to create new styles and locales using Ruby;
+this is useful, for example,
+if you need to change or adapt styles on-the-fly
+or for writing an interactive style editor.
+
+To get you started, here are a few usage examples;
+for the full set of available features, please consult the
+[API documentation](https://rubydoc.info/gems/csl/).
 
     require 'csl'
 
     # Load a style from the Zotero style repository
-    jps = CSL::Style.load 'http://zotero.org/styles/american-journal-of-political-science'
+    jps = CSL::Style.load 'https://www.zotero.org/styles/american-journal-of-political-science'
 
     # Query style information
     jps.title #-> "American Journal of Political Science"
@@ -53,7 +61,7 @@ available features, please consult the
     jps.valid? #-> true
 
     # Load another style
-    amc = CSL::Style.load 'http://zotero.org/styles/applied-mathematics-and-computation'
+    amc = CSL::Style.load 'https://www.zotero.org/styles/applied-mathematics-and-computation'
 
     amc.independent? #-> false
 
@@ -68,9 +76,9 @@ available features, please consult the
     # Load a locally installed style
     apa = CSL::Style.load :apa
 
-    # Fetch the a macro
-    authors = apa.macros['authors'].children[0]
-    #-> #<CSL::Style::Names variable="author" children=[2]>
+    # Fetch the first child of a macro
+    authors = apa.macros['author-bib'].children[0]
+    #-> #<CSL::Style::Group delimiter=" " children=[2]>
 
     # Load a locally installed locale
     fr = CSL::Locale.load :fr
@@ -82,7 +90,7 @@ available features, please consult the
 
     # Ordinalize a number
     fr.ordinalize 42 #=> "42ᵉ"
-    fr.ordinalize 3, form: 'long' => "troisième"
+    fr.ordinalize 3, form: 'long' #=> "troisième"
 
     # Create a new style
     style = CSL::Style.new
@@ -101,11 +109,12 @@ available features, please consult the
 
 Dependencies
 ------------
-CSL-Ruby was written with portability in mind. For performance reasons it
-will use [Nokogiri ](http://nokogiri.org) for XML parsing and validation
-if available; however, CSL-Ruby will fallback to REXML from the Ruby standard
-library. In order to use Nokogiri, simply `gem install nokogiri` or add it
-to your Gemfile.
+CSL-Ruby was written with portability in mind.
+For performance reasons it will use [Nokogiri](https://nokogiri.org)
+for XML parsing and validation if available;
+however, CSL-Ruby will fallback to REXML from the Ruby standard library.
+In order to use Nokogiri,
+simply `gem install nokogiri` or add it to your Gemfile.
 
 Development
 -----------
@@ -114,28 +123,33 @@ You can check out a copy of the latest code using Git:
 
     $ git clone https://github.com/inukshuk/csl-ruby.git
 
-To get started, install the development dependencies and run all tests:
+To get started,
+install the development dependencies and run all tests:
 
     $ cd csl-ruby
     $ bundle install
     $ rake
 
-If you've found a bug or have a question, please open an issue on the
+If you've found a bug or have a question,
+please open an issue on the
 [issue tracker](https://github.com/inukshuk/csl-ruby/issues).
-Or, for extra credit, clone the CSL-Ruby repository, write a failing
-example, fix the bug and submit a pull request.
+Or, for extra credit, clone the CSL-Ruby repository,
+write a failing example, fix the bug and submit a pull request.
 
 Credits
 -------
 Thanks to Rintze M. Zelle, Sebastian Karcher, Frank G. Bennett, Jr.,
-and Bruce D'Arcus of CSL and citeproc-js fame for their support!
+and Bruce D'Arcus of CSL and citeproc-js fame
+for their support!
 
-Thanks to Google and the Berkman Center at Harvard University for supporting
-this project as part of [Google Summer of Code](https://developers.google.com/open-source/soc/).
+Thanks to Google and the Berkman Center at Harvard University
+for supporting this project as part of
+[Google Summer of Code](https://developers.google.com/open-source/soc/).
 
 Copyright
 ---------
-Copyright 2009-2025 Sylvester Keil. All rights reserved.
+Copyright 2009-2026 Sylvester Keil.
+All rights reserved.
 
 Copyright 2012 President and Fellows of Harvard College.
 

data/lib/csl/compatibility.rb

@@ -10,12 +10,8 @@ module CSL
 end
 
 class Module
-  if RUBY_VERSION < '1.9'
-    alias const? const_defined?
-  else
-    def const?(name)
-      const_defined?(name, false)
-    end
+  def const?(name)
+    const_defined?(name, false)
   end
 end
 
@@ -26,30 +22,11 @@ end unless Struct.instance_methods.include?(:__class__)
 module CSL
   module_function
 
-  if RUBY_VERSION < '1.9'
-
-    XML_ENTITY_SUBSTITUTION = Hash[*%w{
-     & &amp; < &lt; > &gt; ' &apos; " &quot;
-    }].freeze
-
-    def encode_xml_text(string)
-      string.gsub(/[&<>]/) { |match|
-        XML_ENTITY_SUBSTITUTION[match]
-      }
-    end
-
-    def encode_xml_attr(string)
-      string.gsub(/[&<>'"]/) { |match|
-        XML_ENTITY_SUBSTITUTION[match]
-      }.inspect
-    end
-  else
-    def encode_xml_text(string)
-      string.encode(string.encoding, :xml => :text)
-    end
+  def encode_xml_text(string)
+    string.encode(string.encoding, :xml => :text)
+  end
 
-    def encode_xml_attr(string)
-      string.encode(string.encoding, :xml => :attr)
-    end
+  def encode_xml_attr(string)
+    string.encode(string.encoding, :xml => :attr)
   end
 end

data/lib/csl/info.rb

@@ -85,18 +85,6 @@ module CSL
       end
     end
 
-    # Ruby 1.8 still has Object#id methods so the attr_children generator
-    # may not have created those; since #id is deprecated in 1.8.7 we're
-    # forcing the override anyway. Live dangerously!
-    remove_method :id
-
-    # @return [Id] the id text node
-    def id
-      children[:id]
-    end
-
-    alias id= set_child_id
-
     def self_link!
       return unless has_id?
       self.self_link = id

data/lib/csl/loader.rb

@@ -9,6 +9,12 @@ module CSL
   #   Base classes are exepcted to define a #parse method.
   module Loader
 
+    class << self
+      attr_accessor :allow_remote
+    end
+
+    @allow_remote = true
+
     attr_accessor :root, :prefix, :extension
 
     # @example
@@ -82,8 +88,11 @@ module CSL
           location = input
         end
 
-        Kernel.open(location, 'r:UTF-8') do |io|
-          io.read
+        if location =~ /\A\w+:\/\//
+          raise 'loading from URLs is disabled' unless Loader.allow_remote
+          URI.open(location, 'r:UTF-8') { |io| io.read }
+        else
+          File.open(location, 'r:UTF-8') { |io| io.read }
         end
       end
     rescue => e

data/lib/csl/locale.rb

@@ -15,7 +15,7 @@ module CSL
     @extension = '.xml'.freeze
     @prefix = 'locales-'.freeze
 
-    @tag_pattern = /^[a-z]{2,3}(-[a-z]{4})?(-[a-z]{2})?|-[a-z]{2}$/i
+    @tag_pattern = /\A(?:[a-z]{2,3}(-[a-z]{4})?(-[a-z]{2})?|-[a-z]{2})\z/i
 
     # Default languages/regions.
     # Auto-detection is based on these lists.
@@ -40,10 +40,27 @@ module CSL
       attr_accessor :default
       attr_reader :languages, :regions, :scripts
 
+      # Loads the locale. For IETF tags without a locale file, falls
+      # back to the language's primary dialect and to the default locale.
       def load(input = nil)
         input ||= Locale.default
-        input = normalize input if input.to_s =~ @tag_pattern
-        super(input)
+
+        # Drop extensions and private-use subtags (e.g. "-x-...")
+        tag = input.to_s.sub(/-[a-z0-9]-.*\z/i, '')
+        return super(input) unless tag =~ @tag_pattern
+
+        tag = normalize(tag)
+        candidates = [tag, normalize(tag.split('-')[0]), Locale.default].uniq
+
+        error = nil
+
+        candidates.each do |candidate|
+          return super(candidate)
+        rescue ParseError => e
+          error ||= e
+        end
+
+        raise error
       end
 
       # Normalizes an IETF tag; adds default language, region, script.
@@ -493,7 +510,7 @@ module CSL
     end
 
     def preamble
-      Schema.preamble.dup
+      Schema.preamble
     end
 
     # @param other [Locale] an other locale whose options should be merged

data/lib/csl/node.rb

@@ -131,8 +131,7 @@ module CSL
       def attr_struct(*attributes)
         const_set(:Attributes, Struct.new(*attributes) {
 
-          # 1.8 Compatibility
-          @keys = attributes.map(&:to_sym).freeze
+          @keys = members.freeze
 
           class << self
             attr_reader :keys

data/lib/csl/parser.rb

@@ -12,8 +12,7 @@ module CSL
       :nokogiri => lambda { |source|
         Nokogiri::XML::Document.parse(source, nil, nil,
           Nokogiri::XML::ParseOptions::DEFAULT_XML |
-          Nokogiri::XML::ParseOptions::NOBLANKS |
-          Nokogiri::XML::ParseOptions::NOENT)
+          Nokogiri::XML::ParseOptions::NOBLANKS)
       },
       :default  => lambda { |source|
         REXML::Document.new(source, :compress_whitespace => :all, :ignore_whitespace_nodes => :all)

data/lib/csl/pretty_printer.rb

@@ -10,7 +10,7 @@ module CSL
     end
 
     def pretty_print
-      preamble << tags.map { |t| pp t }.join("\n")
+      "#{preamble}#{tags.map { |t| pp t }.join("\n")}"
     end
 
     private

data/lib/csl/style/label.rb

@@ -16,7 +16,7 @@ module CSL
 
       has_no_children
 
-      @variables = [:locator, :page].concat(Schema.variables[:number]).freeze
+      @variables = ([:locator, :page] | Schema.variables[:number]).freeze
 
       @terms = Hash.new { |h,k| h[k] = k }
 

data/lib/csl/style.rb

@@ -80,20 +80,20 @@ module CSL
 
     remove_method :info # generated by struct_children
     def info
-      children[:info] ||= Info.new
+      children[:info] || add_child(Info.new)
     end
 
     alias_child :metadata, :info
 
     # @return [String] the style's id
     def id
-      return unless info.has_id?
+      return unless has_info? && info.has_id?
       info.id.to_s
     end
 
     # @return [String] the style's title
     def title
-      return unless info.has_title?
+      return unless has_info? && info.has_title?
       info.title.to_s
     end
 
@@ -141,7 +141,7 @@ module CSL
     private
 
     def preamble
-      Schema.preamble.dup
+      Schema.preamble
     end
 
     def load_related_style_from(uri)

data/lib/csl/treelike.rb

@@ -349,8 +349,7 @@ module CSL
 
         const_set(:Children, Struct.new(*names) {
 
-          # 1.8 Compatibility
-          @keys = members.map(&:to_sym).freeze
+          @keys = members.freeze
 
           class << self
             attr_reader :keys

data/lib/csl/version.rb

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

data/lib/csl.rb

@@ -1,5 +1,4 @@
 
-require 'enumerator'
 require 'forwardable'
 require 'open-uri'
 require 'singleton'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: csl
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Sylvester Keil
 bindir: bin
 cert_chain: []
-date: 2025-10-16 00:00:00.000000000 Z
+date: 2026-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: namae
@@ -117,17 +117,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".document"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".yardopts"
-- AGPL
 - BSDL
-- Gemfile
 - README.md
-- Rakefile
-- csl.gemspec
-- cucumber.yml
 - lib/csl.rb
 - lib/csl/compatibility.rb
 - lib/csl/date_part.rb
@@ -176,14 +167,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      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 Ruby CSL parser and library
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-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/.gitignore

@@ -1,13 +0,0 @@
-.DS_Store
-Gemfile.lock
-/coverage
-/pkg
-/doc
-/.yardoc
-/.rbx
-*.rbc
-*.swp
-*.gem
-.ruby-version
-.rvm
-.bundle

data/.yardopts

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