identifiers 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4546231ed2288fa0d807ac0fc71f268f92de75dbc38fb057410441b3b77ca4c
-  data.tar.gz: b55eaf0b183185203c0957faf86335ac3b1996ed7312692d92daf013162798ff
+  metadata.gz: f0cc5842531ab0baf207b1aba207fa1fc89e338b3bb6a36c689346e7b473fdd6
+  data.tar.gz: bba49e3c29eeb837cf62f0dcc20256d024ee2690e65ce1df36d7f619a4afc25f
 SHA512:
-  metadata.gz: 81cfdbbd15e12d7394deeaf45463837ecb01a995fe9bc713736578153f1725d0a6cb71913453d918ad2a1d2cd5970caa6d18656df70f3b175628c4f753f07c37
-  data.tar.gz: 5472c1c3f7b4c04d6a51f4d6fddfd476d3c8823d6c98a74de295cc730fe72bfb637b88e9c9f606d0144418a3d2b7828faf5ca145c1b53b19d8691c937fcc600f
+  metadata.gz: b629b7898e27360f8b0b45c537b735f9e3a2cfaa37cb0c8a4b00b226af0d16c861fefd00c3d630658c38447d05aa2e25dcd6b4f8a52e257762b3ed3469c53b73
+  data.tar.gz: ea4edebb501806152ac4affc90d766bd31b93526606cbd90c64c1c8fa62722da45ca40514e6ade5229878390ab857390d8f4502cb87b27ab6390561e7ec98a1c

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.15.0] - 2026-06-12
+### Added
+- Extract ISBNs that mix different dash characters, including the U+2212 minus
+  sign, within a single ISBN (#31)
+
+### Fixed
+- Stop extracting spurious ISBNs from a long run of digits separated by hyphens (#34)
+
+## [0.14.0] - 2024-07-30
+### Added
+- Added optional prefixes argument to ISBNs extraction.
+  If passed `.extract` will only match series of numbers that are preceded by any of the passed prefixes
+
 ## [0.13.0] - 2019-09-04
 ### Added
 - Added new mode to the DOI extraction, so that it doesn't strip trailing

data/README.md

@@ -1,4 +1,4 @@
-# Identifiers [![Build Status](https://travis-ci.org/altmetric/identifiers.svg?branch=master)](https://travis-ci.org/altmetric/identifiers) [![Gem Version](https://badge.fury.io/rb/identifiers.svg)](https://badge.fury.io/rb/identifiers)
+# Identifiers [![Gem Version](https://badge.fury.io/rb/identifiers.svg)](https://badge.fury.io/rb/identifiers)
 
 Collection of utilities related to the extraction, validation and normalization of various scholarly identifiers. The supported list is:
 
@@ -13,6 +13,8 @@ Collection of utilities related to the extraction, validation and normalization
 - [URNs](https://en.wikipedia.org/wiki/Uniform_Resource_Name)
 - [ORCID identifiers](http://orcid.org/)
 
+**Supported Ruby versions**: >= 2.7
+
 ## Installation
 
 Add this line to your application's `Gemfile`:
@@ -77,6 +79,17 @@ Identifiers::RepecId.extract('')
 Identifiers::URN.extract('')
 ```
 
+For `ISBN`s `.extract`, you can pass an array of prefixes as an optional parameter when you want to exclude matches that are not preceded by those prefixes (it is case insensitive and ignores ':' and extra whitespaces):
+
+```ruby
+Identifiers::ISBN.extract(
+  "IsBN:9789992158104  \n isbn-10 9789971502102 \n ISBN-13: 9789604250592 \n 9788090273412",
+  ["ISBN", "ISBN-10"]
+)
+# => ["9789992158104", "9789971502102"]
+```
+
+
 But for some identifiers might have more. Check [their implementation](https://github.com/altmetric/identifiers/tree/master/lib/identifiers) to see all the methods available.
 
 For `URN`s, please check the [URN gem documentation](https://github.com/altmetric/urn) to see all the available options.
@@ -95,6 +108,6 @@ We also maintain [a version of this library for PHP](https://github.com/altmetri
 
 ## License
 
-Copyright © 2016-2018 Altmetric LLP
+Copyright © 2016-2024 Altmetric LLP
 
 Distributed under the [MIT License](http://opensource.org/licenses/MIT).

data/lib/identifiers/isbn.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Identifiers
   class ISBN
     ISBN_13_REGEXP = /
+      (?<!\p{Pd})         # Not part of a longer hyphen-separated run of digits
       \b
       (
         97[89]            # ISBN (GS1) Bookland prefix
@@ -12,12 +15,14 @@ module Identifiers
         \d                # Check digit
       )
       \b
-    /x
+      (?!\p{Pd})          # Not part of a longer hyphen-separated run of digits
+    /x.freeze
     ISBN_10_REGEXP = /
       (?<!              # Don't match a hyphenated or spaced ISBN-13
         97[89]
         [\p{Pd}\p{Zs}]
       )
+      (?<!\p{Pd})         # Not part of a longer hyphen-separated run of digits
       \b
       (
         \d{1,5}           # Registration group identifier
@@ -29,7 +34,8 @@ module Identifiers
         [\dX]             # Check digit
       )
       \b
-    /x
+      (?!\p{Pd})          # Not part of a longer hyphen-separated run of digits
+    /x.freeze
     ISBN_A_REGEXP = %r{
       \b
       (?<=10\.) # Directory indicator (always 10)
@@ -38,12 +44,28 @@ module Identifiers
       /         # Prefix/suffix divider
       \d{1,7}   # ISBN title enumerator and check digit
       \b
-    }x
+    }x.freeze
+    # Dashes other than the ASCII hyphen we normalise to, including U+2212
+    # MINUS SIGN, which is not part of \p{Pd}
+    NON_CANONICAL_DASHES_REGEXP = /[[\p{Pd}−]&&[^-]]/.freeze
+
+    def self.extract(str, prefixes = [])
+      str = str.to_s
+      # Normalise dashes to a single ASCII hyphen so one ISBN can mix them
+      str = str.gsub(NON_CANONICAL_DASHES_REGEXP, '-') if str.match?(NON_CANONICAL_DASHES_REGEXP)
+      return extract_with_prefix(str, prefixes) if prefixes.any?
 
-    def self.extract(str)
       extract_isbn_as(str) + extract_thirteen_digit_isbns(str) + extract_ten_digit_isbns(str)
     end
 
+    def self.extract_with_prefix(str, prefixes)
+      prefix_regexp = generate_prefix_regexp(prefixes)
+
+      [isbn_a_candidate_matcher, ISBN_13_REGEXP, ISBN_10_REGEXP].inject([]) do |matches, isbn_regexp|
+        matches | isbn_with_prefix_candidates(str, prefix_regexp, isbn_regexp)
+      end
+    end
+
     def self.extract_isbn_as(str)
       extract_thirteen_digit_isbns(str.to_s.scan(ISBN_A_REGEXP).join("\n").tr('/.', ''))
     end
@@ -64,13 +86,13 @@ module Identifiers
         .select { |isbn, hyphen| !hyphen || isbn.count(hyphen) == 3 }
         .map { |isbn, hyphen| isbn.delete(hyphen.to_s) }
         .select { |isbn| valid_isbn_10?(isbn) }
-        .map { |isbn|
+        .map do |isbn|
           isbn.chop!
           isbn.prepend('978')
           isbn << isbn_13_check_digit(isbn).to_s
 
           isbn
-        }
+        end
     end
 
     def self.isbn_13_check_digit(isbn)
@@ -103,5 +125,34 @@ module Identifiers
     def self.digits_of(isbn)
       isbn.to_s.each_char.map { |char| char == 'X' ? 10 : Integer(char) }.to_enum
     end
+
+    def self.isbn_with_prefix_candidates(str, prefix_regexp, isbn_regexp)
+      regexp = Regexp.new("#{prefix_regexp}#{isbn_regexp}", Regexp::IGNORECASE | Regexp::EXTENDED)
+
+      str
+        .to_s
+        .scan(regexp)
+        .filter_map do |match|
+          extract(Array(match).first)&.first
+        end
+    end
+
+    def self.generate_prefix_regexp(prefixes)
+      joined_prefixes = Regexp.union(prefixes).source
+
+      Regexp.new(
+        "(?<=                 # Lookbehind for a prefix
+           #{joined_prefixes} # ie:p1|p2|p3
+         )
+         :?                   # Optional colon. If you want to use a different separator, you can add it as a prefix
+         \\s*                 # Optional whitespaces
+         ", Regexp::IGNORECASE | Regexp::EXTENDED
+      )
+    end
+
+    def self.isbn_a_candidate_matcher
+      # We capture the ISBN-A prefix for the ISBN-A regexp to work correctly when extracting ISBN-As
+      Regexp.new(ISBN_A_REGEXP.source.gsub('(?<=10\\.)', '10\.'), Regexp::IGNORECASE | Regexp::EXTENDED)
+    end
   end
 end

data/spec/identifiers/isbn_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'identifiers/isbn'
 
 RSpec.describe Identifiers::ISBN do
@@ -31,6 +33,10 @@ RSpec.describe Identifiers::ISBN do
     expect(described_class.extract('ISBN: 978–0–80–506909–9')).to contain_exactly('9780805069099')
   end
 
+  it 'extracts ISBNs that mix different dash characters' do
+    expect(described_class.extract('978–3−200–01908–9')).to contain_exactly('9783200019089')
+  end
+
   it 'extracts ISBNs with spaces' do
     expect(described_class.extract('ISBN: 978 0 80 506909 9')).to contain_exactly('9780805069099')
   end
@@ -119,8 +125,82 @@ RSpec.describe Identifiers::ISBN do
     expect(described_class.extract('0-80506909-7')).to be_empty
   end
 
+  it 'does not extract ISBNs from a long run of digits separated by hyphens' do
+    expect(described_class.extract('0-1884-0-3140-0-4396-0-5652-0-4396-0-2826')).to be_empty
+  end
+
+  it 'does not extract ISBNs joined to other digits by a hyphen' do
+    expect(described_class.extract('9780805069099-9780671879198')).to be_empty
+  end
+
   it 'extracts ISBN-10s with variable width registration group identifiers' do
     expect(described_class.extract('99921-58-10-7 9971-5-0210-0 960-425-059-0 80-902734-1-6'))
       .to contain_exactly('9789992158104', '9789971502102', '9789604250592', '9788090273412')
   end
+
+  context 'when passing prefixes' do
+    it 'extracts only prefixed ISBNs' do
+      text = "ISBN:9789992158104  ISBN-10 9789971502102 \n IsbN-13: 9789604250592 \n 9788090273412"
+      prefixes = %w[IsBn ISBN-10 ISBN-13]
+
+      expect(described_class.extract(text, prefixes))
+        .to contain_exactly('9789992158104', '9789971502102', '9789604250592')
+    end
+
+    it 'extracts ISBNs with special characters in the prefixes' do
+      text = 'ISB*N:99921-58-10-7 IS?BN-10 9971-5-0210-0 Is$bN-13: 978-0-80-506909-9 80-902734-1-6'
+      prefixes = ['IsB*n', 'IS?BN-10', 'IS$BN-13']
+
+      expect(described_class.extract(text, prefixes))
+        .to contain_exactly('9789992158104', '9789971502102', '9780805069099')
+    end
+
+    it 'extracts ISBNs with Unicode dashes' do
+      text = 'ISB*N:99921-58-10-7 IS?BN-10 9971-5-0210-0 Is$bN-13: 978–0–80–506909–9 80-902734-1-6'
+      prefixes = ['IsB*n', 'IS?BN-10', 'IS$BN-13']
+
+      expect(described_class.extract(text, prefixes))
+        .to contain_exactly('9789992158104', '9789971502102', '9780805069099')
+    end
+
+    it 'extracts ISBNs with Unicode spaces' do
+      text = 'ISBN-13: 978 0 80 506909 9'
+      prefixes = ['ISBN-13']
+
+      expect(described_class.extract(text, prefixes)).to contain_exactly('9780805069099')
+    end
+
+    it 'normalizes 10-digit ISBNs with hyphens and a check digit of X' do
+      expect(described_class.extract('ISBN:2-7594-0269-X', ['ISBN'])).to contain_exactly('9782759402694')
+    end
+
+    it 'normalizes 10-digit ISBNs with spaces and a check digit of X' do
+      text = 'ISBN-10 2 7594 0269 X'
+      prefixes = ['ISBN-10']
+
+      expect(described_class.extract(text, prefixes)).to contain_exactly('9782759402694')
+    end
+
+    it 'extracts ISBN-13s from ISBN-As' do
+      text = 'ISBN 10.978.8898392/315'
+      prefixes = %w[ISBN ISBN-10]
+
+      expect(described_class.extract(text, prefixes)).to contain_exactly('9788898392315')
+    end
+
+    it 'does not extract ISBNs with different prefixes' do
+      text = "ISBN:9789992158104 \n ISBN-10 9789971502102  IsbN-13: 9789604250592  9788090273412"
+      prefixes = %w[IsBn ISBN-10]
+
+      expect(described_class.extract(text, prefixes))
+        .to contain_exactly('9789992158104', '9789971502102')
+    end
+
+    it 'does not extract ISBNs without prefixes' do
+      text = "9789992158104 9789971502102 9789604250592 \n 9788090273412"
+      prefixes = %w[IsBn ISBN-10 ISBN-13]
+
+      expect(described_class.extract(text, prefixes)).to be_empty
+    end
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: identifiers
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Jonathan Hernandez
 - Paul Mucur
-autorequire: 
+- PatoSoft
 bindir: exe
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: urn
@@ -31,29 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-description: 
+        version: '3.13'
 email:
 - support@altmetric.com
 executables: []
@@ -89,7 +88,6 @@ homepage: https://github.com/altmetric/identifiers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -104,19 +102,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Utilities library for various scholarly identifiers used by Altmetric
 test_files:
-- spec/spec_helper.rb
-- spec/identifiers/repec_id_spec.rb
-- spec/identifiers/pubmed_id_spec.rb
+- spec/identifiers/ads_bibcode_spec.rb
 - spec/identifiers/arxiv_id_spec.rb
-- spec/identifiers/urn_spec.rb
+- spec/identifiers/doi_spec.rb
 - spec/identifiers/handle_spec.rb
-- spec/identifiers/ads_bibcode_spec.rb
 - spec/identifiers/isbn_spec.rb
-- spec/identifiers/doi_spec.rb
 - spec/identifiers/national_clinical_trial_id_spec.rb
 - spec/identifiers/orcid_spec.rb
+- spec/identifiers/pubmed_id_spec.rb
+- spec/identifiers/repec_id_spec.rb
+- spec/identifiers/urn_spec.rb
+- spec/spec_helper.rb