epub-cfi 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7bd4bcf31dae58b934393de702fb036186b950bbeb72d065931d0406506c2be
-  data.tar.gz: 5820d5272ed8c29790c69e959c1e4b140eae9e567182b2c5929dbbcff41efc0e
+  metadata.gz: 3a79486ec6d7e2a618cfba25b35658411424f08ed77384025174935d8cbc8127
+  data.tar.gz: e5cbd477b9b7ebdc0850d428b2494e795fddb0208a209e6969f5ff2adea4ec95
 SHA512:
-  metadata.gz: 83d606fc2a8321349c6b055df31610bbc384b7c42e620ee01ec6b1461b2c6a51534327c70442894a70f8faf6c0cee0a0506e84b55c5765a25a97d2ae6548ac7e
-  data.tar.gz: 8b950b018d6bde45b2c1107ab2c19048c4e05e06cc49c4cd59c4c77a5b4b706228bc2268b65eebbb91314a51104b5fa48ddf5371c202c187bda1faf023fbccab
+  metadata.gz: c9434ba31524411d771d7abe463294f5154da32707ce640539e3dcb6f9e0c9d1507ee23e638cb746d22b97fd59ad885b190fed0c16943610c0ab1f99215bf30f
+  data.tar.gz: d6b2a08aa5c7ca1d622e884645dd8a90eaf1bd4392f3a1d761f4976a0e5fa0a497e974bf940fecad7b3b20fe7976ad8e49d68fb3ad5be8bb276b0796b99aa96d

data/.gitlab-ci.yml

@@ -1,24 +1,24 @@
 before_script:
   - ruby -v
   - which ruby
-  - gem install --no-document racc rake rubygems-tasks yard test-unit test-unit-notify pretty_backtrace simplecov
+  - gem install --no-document racc rake rubygems-tasks yard test-unit test-unit-notify simplecov steep
 
-test:2.3:
-  image: ruby:2.3
+test:3.0:
+  image: ruby:3.0
   script:
     rake test
 
-test:2.4:
-  image: ruby:2.4
+test:3.1:
+  image: ruby:3.1
   script:
     rake test
 
-test:2.5:
-  image: ruby:2.5
+test:3.2:
+  image: ruby:3.2
   script:
-    rake test
+    rake test typecheck
 
-test:2.6:
-  image: ruby:2.6
+test:3.3:
+  image: ruby:3.3
   script:
-    rake test
+    rake test typecheck

data/ChangeLog.adoc

@@ -1,3 +1,10 @@
+=== 0.1.3 / 2023-12-28
+
+* Suppress warning on unused variable
+* Include RBS file
+* [BUG FIX]Include strscan
+* Add Racc to runtime dependencies
+
 === 0.1.2 / 2019-05-19
 
 * Scan CFI string on demand to reduce memory footprint

data/Rakefile

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require 'rake'
 
-task :default => "lib/epub/cfi/parser.tab.rb"
+task :default => [:test, :typecheck]
 
 desc "Build EPUB CFI parser"
 file "lib/epub/cfi/parser.tab.rb" => "lib/epub/cfi/parser.y" do |task|
@@ -18,10 +18,15 @@ task :build => "lib/epub/cfi/parser.tab.rb"
 require 'rake/testtask'
 Rake::TestTask.new do |test|
   test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
 task :test => "lib/epub/cfi/parser.tab.rb"
 
 require 'yard'
 YARD::Rake::YardocTask.new
+
+require "steep"
+desc "Check type"
+task typecheck: "lib/epub/cfi/parser.tab.rb" do
+  Steep::Drivers::Check.new(stdout: $stdout, stderr: $stderr).run
+end

data/Steepfile

@@ -0,0 +1,30 @@
+# D = Steep::Diagnostic
+#
+target :lib do
+  signature "sig"
+
+  check "lib"                       # Directory name
+  # check "Gemfile"                   # File name
+  # check "app/models/**/*.rb"        # Glob
+  ignore "lib/shims"
+
+  # library "pathname"              # Standard libraries
+  # library "strong_json"           # Gems
+  library "strscan"
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end
+
+target :test do
+  signature "sig", "sig-private"
+
+  check "test"
+
+  # library "pathname"              # Standard libraries
+end

data/epub-cfi.gemspec

@@ -29,12 +29,13 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_development_dependency "racc"
+  gem.add_runtime_dependency "racc"
+
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rubygems-tasks'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency "test-unit"
   gem.add_development_dependency "test-unit-notify"
-  gem.add_development_dependency "pretty_backtrace"
   gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "steep"
 end

data/lib/epub/cfi/parser.rb

@@ -1,10 +1,13 @@
+require "strscan"
 require "epub/cfi/parser.tab"
 
 class EPUB::CFI::Parser
   include Comparable
 
   UNICODE_CHARACTER_EXCLUDING_SPECIAL_CHARS_AND_SPACE_AND_DOT_AND_COLON_AND_TILDE_AND_ATMARK_AND_SOLIDUS_AND_EXCLAMATION_MARK_PATTERN = /\u0009|\u000A|\u000D|[\u0022-\u0027]|[\u002A-\u002B]|\u002D|[\u0030-\u0039]|\u003C|[\u003E-\u0040]|[\u0041-\u005A]|\u005C|[\u005F-\u007D]|[\u007F-\uD7FF]|[\uE000-\uFFFD]|[\u10000-\u10FFFF]/ # excluding special chars and space(\u0020) and dot(\u002E) and colon(\u003A) and tilde(\u007E) and atmark(\u0040) and solidus(\u002F) and exclamation mark(\u0021)
-  UNICODE_CHARACTER_PATTERN = Regexp.union(UNICODE_CHARACTER_EXCLUDING_SPECIAL_CHARS_AND_SPACE_AND_DOT_AND_COLON_AND_TILDE_AND_ATMARK_AND_SOLIDUS_AND_EXCLAMATION_MARK_PATTERN, Regexp.new(Regexp.escape(EPUB::CFI::SPECIAL_CHARS), / \.:~@!/))
+  FRAGMENT_PREFIX = "epubcfi("
+  FRAGMENT_PREFIX_LENGTH = FRAGMENT_PREFIX.length
+  FRAGMENT_SUFFIX_LENGTH = ")".length
 
   class << self
     def parse(string, debug: $DEBUG)
@@ -18,8 +21,9 @@ class EPUB::CFI::Parser
   end
 
   def parse(string)
-    if string.start_with? 'epubcfi('
-      string = string['epubcfi('.length .. -2]
+    if string.start_with? FRAGMENT_PREFIX
+      string = string[FRAGMENT_PREFIX_LENGTH .. -(FRAGMENT_SUFFIX_LENGTH + 1)]
+      # @type var string: String
     end
     @scanner = StringScanner.new(string, true)
     do_parse
@@ -107,7 +111,10 @@ end
 # @raise [Racc::ParseError] if given string is invalid
 # @see CFI.parse
 def EPUB::CFI(string)
-  string.kind_of?(EPUB::CFI::Location) || string.kind_of?(EPUB::CFI::Range) ?
-    string :
+  case string
+  when EPUB::CFI::Location, EPUB::CFI::Range
+    string
+  else
     EPUB::CFI.parse(string)
+  end
 end

data/lib/epub/cfi/parser.tab.rb

@@ -1,7 +1,7 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.14
-# from Racc grammer file "".
+# This file is automatically generated by Racc 1.7.3
+# from Racc grammar file "parser.y".
 #
 
 require 'racc/parser.rb'
@@ -12,53 +12,53 @@ module EPUB
 
 racc_action_table = [
     44,    61,    60,    57,    58,    59,    32,    31,    56,    47,
-   110,    49,     4,    22,    24,    25,    54,    62,    61,    60,
-    57,    58,    59,    32,    31,    56,    39,    40,    49,    32,
-    31,    72,    75,    54,    62,    61,    60,    57,    58,    59,
-    32,    31,    56,    32,    31,    49,   100,    31,    14,    13,
-    54,    62,    61,    60,    57,    58,    59,    32,    31,    56,
-   107,    31,    49,    20,     4,    22,    24,    25,    62,    61,
-    60,    57,    58,    59,    32,    31,    56,   -63,   -63,    49,
-    14,    13,    32,    31,    54,    62,    61,    60,    57,    58,
-    59,    32,    31,    56,   -63,   -63,    49,    39,    40,    39,
-    40,    54,    62,    61,    60,    57,    58,    59,    32,    31,
-    56,    32,    31,    49,     5,     8,     4,    15,    54,    62,
-    61,    60,    57,    58,    59,    32,    31,    56,    90,     4,
-    49,    28,    33,    28,     4,    28,    62,    91,    92,    87,
-    28,    75,    95,    96,    25,    72,    73,     4,    47,    47,
-    80,    28,    47,    47,    47,   105,    47 ]
+     4,    49,     4,    22,    24,    25,    54,    62,    61,    60,
+    57,    58,    59,    32,    31,    56,    14,    13,    49,    32,
+    31,    72,     5,    54,    62,    61,    60,    57,    58,    59,
+    32,    31,    56,    32,    31,    49,    20,     4,    22,    24,
+    25,    62,    61,    60,    57,    58,    59,    32,    31,    56,
+    14,    13,    49,    39,    40,    39,    40,    54,    62,    61,
+    60,    57,    58,    59,    32,    31,    56,    32,    31,    49,
+    32,    31,   100,    31,    54,    62,    61,    60,    57,    58,
+    59,    32,    31,    56,    39,    40,    49,   107,    31,   -63,
+   -63,     8,    62,    61,    60,    57,    58,    59,    32,    31,
+    56,   -63,   -63,    49,     4,    15,     4,    28,    54,    62,
+    61,    60,    57,    58,    59,    32,    31,    56,    90,    33,
+    49,    28,     4,    28,    25,    54,    62,    91,    92,    87,
+    28,    75,    95,    96,    72,    73,    75,    47,    47,    80,
+    28,    47,    47,    47,   105,    47,   110 ]
 
 racc_action_check = [
     27,    27,    27,    27,    27,    27,    27,    27,    27,    27,
-   108,    27,    20,    20,    20,    20,    27,    27,    44,    44,
-    44,    44,    44,    44,    44,    44,    25,    25,    44,    69,
-    69,    69,    42,    44,    44,   110,   110,   110,   110,   110,
-   110,   110,   110,    39,    39,   110,    72,    72,    22,    22,
-   110,   110,    47,    47,    47,    47,    47,    47,    47,    47,
-    99,    99,    47,    10,    10,    10,    10,    10,    47,    48,
-    48,    48,    48,    48,    48,    48,    48,   100,   100,    48,
-     4,     4,    14,    14,    48,    48,    80,    80,    80,    80,
-    80,    80,    80,    80,   107,   107,    80,    24,    24,    73,
-    73,    80,    80,   105,   105,   105,   105,   105,   105,   105,
-   105,    29,    29,   105,     1,     2,     3,     5,   105,   105,
-    82,    82,    82,    82,    82,    82,    82,    82,    49,     8,
-    82,    12,    16,    23,    33,    36,    82,    49,    49,    49,
-    49,    49,    49,    49,    38,    40,    41,     0,    43,    45,
-    46,    67,    76,    78,    79,    81,   103 ]
+     0,    27,    20,    20,    20,    20,    27,    27,    44,    44,
+    44,    44,    44,    44,    44,    44,     4,     4,    44,    69,
+    69,    69,     1,    44,    44,    47,    47,    47,    47,    47,
+    47,    47,    47,    14,    14,    47,    10,    10,    10,    10,
+    10,    47,    48,    48,    48,    48,    48,    48,    48,    48,
+    22,    22,    48,    24,    24,    25,    25,    48,    48,    80,
+    80,    80,    80,    80,    80,    80,    80,    29,    29,    80,
+    39,    39,    72,    72,    80,    80,    82,    82,    82,    82,
+    82,    82,    82,    82,    73,    73,    82,    99,    99,   100,
+   100,     2,    82,   105,   105,   105,   105,   105,   105,   105,
+   105,   107,   107,   105,     3,     5,     8,    12,   105,   105,
+   110,   110,   110,   110,   110,   110,   110,   110,    49,    16,
+   110,    23,    33,    36,    38,   110,   110,    49,    49,    49,
+    49,    49,    49,    49,    40,    41,    42,    43,    45,    46,
+    67,    76,    78,    79,    81,   103,   108 ]
 
 racc_action_pointer = [
-   143,   114,   113,   112,    72,   117,   nil,   nil,   125,   nil,
-    60,   nil,   117,   nil,    74,   nil,   130,   nil,   nil,   nil,
-     8,   nil,    40,   119,    89,    18,   nil,    -2,   nil,   103,
-   nil,   nil,   nil,   130,   nil,   nil,   121,   nil,   137,    35,
-   135,   141,    17,   137,    15,   138,   148,    49,    66,   126,
+     6,    32,    99,   110,    18,   115,   nil,   nil,   112,   nil,
+    43,   nil,   103,   nil,    35,   nil,   127,   nil,   nil,   nil,
+     8,   nil,    52,   117,    55,    57,   nil,    -2,   nil,    69,
+   nil,   nil,   nil,   128,   nil,   nil,   119,   nil,   127,    72,
+   134,   140,   131,   136,    15,   137,   147,    32,    49,   126,
    nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
-   nil,   nil,   nil,   nil,   nil,   nil,   nil,   137,   nil,    21,
-   nil,   nil,    38,    91,   nil,   nil,   141,   nil,   142,   143,
-    83,   143,   117,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
-   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,    52,
-    69,   nil,   nil,   145,   nil,   100,   nil,    86,     8,   nil,
-    32,   nil ]
+   nil,   nil,   nil,   nil,   nil,   nil,   nil,   136,   nil,    21,
+   nil,   nil,    74,    86,   nil,   nil,   140,   nil,   141,   142,
+    66,   142,    83,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
+   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,    89,
+    91,   nil,   nil,   144,   nil,   100,   nil,   103,   154,   nil,
+   117,   nil ]
 
 racc_action_default = [
    -81,   -81,    -3,   -10,   -81,   -81,    -1,    -2,   -10,    -4,
@@ -75,32 +75,32 @@ racc_action_default = [
    -81,   -44 ]
 
 racc_goto_table = [
-    30,    46,    29,    85,    45,    83,    26,    84,    38,    41,
-    76,     9,    79,     3,    70,    64,    16,    37,    78,     2,
-     6,    21,    74,    19,    42,    30,    12,    69,    93,    94,
-    66,    34,    43,     3,    67,    68,    18,    81,    85,    35,
-   106,    65,    84,    98,    36,   103,   108,    82,    17,    88,
-    89,    86,     7,   102,   104,    64,   102,   101,    30,     1,
+    30,    46,    29,    76,    45,    79,    26,    85,    38,    41,
+    83,    84,    70,     2,     9,    64,     3,    37,    78,    16,
+     1,    12,    21,     6,    74,    30,    19,    69,     7,    17,
+    66,    94,    34,    35,    18,    68,     3,    67,   103,    36,
+    93,    98,    85,    42,    65,   106,    84,    43,    81,   108,
+    82,    88,    89,   102,   104,    64,   102,   101,    30,    86,
     99,    97,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
    nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   109,
    102,   nil,   nil,   nil,   111,    64 ]
 
 racc_goto_check = [
-    22,    25,    19,    31,    26,    36,    12,    37,    14,    14,
-    24,     6,    24,     5,    20,    22,     6,    12,    25,     2,
-     3,    10,    18,     5,    17,    22,    11,    19,    16,    18,
-    12,    10,    23,     5,    15,    13,     9,    27,    31,     2,
-    36,     6,    37,    20,    11,    24,    28,    30,     8,    32,
-    33,    34,     4,    26,    25,    22,    26,    14,    22,     1,
+    22,    25,    19,    24,    26,    24,    12,    31,    14,    14,
+    36,    37,    20,     2,     6,    22,     5,    12,    25,     6,
+     1,    11,    10,     3,    18,    22,     5,    19,     4,     8,
+    12,    18,    10,     2,     9,    13,     5,    15,    24,    11,
+    16,    20,    31,    17,     6,    36,    37,    23,    27,    28,
+    30,    32,    33,    26,    25,    22,    26,    14,    22,    34,
     19,    12,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
    nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,    25,
     26,   nil,   nil,   nil,    25,    22 ]
 
 racc_goto_pointer = [
-   nil,    59,    19,    18,    50,    13,     8,   nil,    38,    26,
-    11,    22,    -6,    -3,   -16,    -4,   -21,    -3,   -20,   -12,
-   -26,   nil,   -14,     5,   -33,   -26,   -23,   -10,   -59,   nil,
-     0,   -44,     0,     1,     3,   nil,   -42,   -40,   nil ]
+   nil,    20,    13,    21,    26,    16,    11,   nil,    19,    24,
+    12,    17,    -6,    -3,   -16,    -1,    -9,    16,   -18,   -12,
+   -28,   nil,   -14,    20,   -40,   -26,   -23,     1,   -56,   nil,
+     3,   -40,     2,     3,    11,   nil,   -37,   -36,   nil ]
 
 racc_goto_default = [
    nil,   nil,   nil,   nil,   nil,    11,   nil,    10,   nil,   nil,
@@ -236,6 +236,7 @@ Racc_arg = [
   racc_shift_n,
   racc_reduce_n,
   racc_use_result_var ]
+Ractor.make_shareable(Racc_arg) if defined?(Ractor)
 
 Racc_token_to_s_table = [
   "$end",
@@ -297,6 +298,7 @@ Racc_token_to_s_table = [
   "character_escaped_special_excluding_space",
   "character_excluding_special_chars_and_space",
   "character_excluding_special_chars_and_space_and_dot_and_colon_and_tilde_and_atmark_and_solidus_and_exclamation_mark" ]
+Ractor.make_shareable(Racc_token_to_s_table) if defined?(Ractor)
 
 Racc_debug_parser = false
 
@@ -311,7 +313,7 @@ module_eval(<<'.,.,', 'parser.y', 5)
                  else
                    result = CFI::Location.new(val[0])
                  end
-               
+
     result
   end
 .,.,
@@ -322,10 +324,10 @@ module_eval(<<'.,.,', 'parser.y', 5)
 
 module_eval(<<'.,.,', 'parser.y', 17)
   def _reduce_4(val, _values, result)
-                 path, redirected_path = *val[1]
+                 path, _redirected_path = *val[1]
              path.steps.unshift val[0]
              result = val[1]
-           
+
     result
   end
 .,.,
@@ -390,7 +392,7 @@ module_eval(<<'.,.,', 'parser.y', 44)
   def _reduce_13(val, _values, result)
                  assertion = val[2] ? CFI::IDAssertion.new(val[2][0], val[2][2]) : nil
              result = CFI::Step.new(val[1].to_i, assertion)
-           
+
     result
   end
 .,.,
@@ -403,7 +405,7 @@ module_eval(<<'.,.,', 'parser.y', 53)
   def _reduce_16(val, _values, result)
                    assertion = val[2] ? CFI::TextLocationAssertion.new(*val[2]) : nil
                result = CFI::CharacterOffset.new(val[1].to_i, assertion)
-             
+
     result
   end
 .,.,
@@ -420,7 +422,7 @@ module_eval(<<'.,.,', 'parser.y', 60)
                    x = val[2] ? val[2][0].to_f : nil
                y = val[2] ? val[2][1].to_f : nil
                result = CFI::TemporalSpatialOffset.new(val[1].to_f, x, y, val[3])
-             
+
     result
   end
 .,.,
@@ -694,5 +696,5 @@ def _reduce_none(val, _values, result)
 end
 
     end   # class Parser
-    end   # module CFI
-  end   # module EPUB
+  end   # module CFI
+end   # module EPUB

data/lib/epub/cfi/parser.y

@@ -15,7 +15,7 @@ rule
 
   path : step local_path
            {
-             path, redirected_path = *val[1]
+             path, _redirected_path = *val[1]
              path.steps.unshift val[0]
              result = val[1]
            }

data/lib/epub/cfi/version.rb

@@ -18,6 +18,6 @@
 module EPUB
   module CFI
     # epub-cfi version
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/lib/epub/cfi.rb

@@ -221,7 +221,7 @@ module EPUB
       end
 
       def to_s
-        return @string_cache if @string_cache
+        return @string_cache if @string_cache # @type ivar @string_cache: String
         string_cache = '['
         string_cache << CFI.escape(id) if id
         parameters.each_pair do |key, values|
@@ -242,7 +242,7 @@ module EPUB
       end
 
       def to_s
-        return @string_cache if @string_cache
+        return @string_cache if @string_cache # @type ivar @string_cache: String
         string_cache = '['
         string_cache << CFI.escape(preceded) if preceded
         string_cache << ',' << CFI.escape(followed) if followed
@@ -279,13 +279,13 @@ module EPUB
       def initialize(temporal=nil, x=nil, y=nil, assertion=nil)
         raise RangeError, "dimension must be in 0..100 but passed #{x}" unless (0.0..100.0).cover?(x) if x
         raise RangeError, "dimension must be in 0..100 but passed #{y}" unless (0.0..100.0).cover?(y) if y
-        warn "Assertion is passed to #{__class__} but cannot know how to handle with it: #{assertion}" if assertion
+        warn "Assertion is passed to #{self.class} but cannot know how to handle with it: #{assertion}" if assertion
         @temporal, @x, @y, @assertion = temporal, x, y, assertion
         @string_cache = nil
       end
 
       def to_s
-        return @string_cache if @string_cache
+        return @string_cache if @string_cache # @type ivar @string_cache: String
         string_cache = ''
         string_cache << "~#{temporal}" if temporal
         string_cache << "@#{x}:#{y}" if x or y

data/sig/epub-cfi.rbs

@@ -0,0 +1,132 @@
+# TypeProf 0.21.8
+
+# Classes
+module EPUB
+  def self.CFI: (String | CFI::Location | CFI::Range) -> (CFI::Location | CFI::Range)
+
+  module CFI
+    VERSION: String
+    SPECIAL_CHARS: "^[](),;="
+    RE_ESCAPED_SPECIAL_CHARS: String
+
+    def self.escape: (String string) -> String
+    def self.unescape: (String string) -> String
+    def self.parse: (String) -> (Location | Range)
+
+    class Location
+      include Comparable
+
+      attr_reader paths: NonEmptyArray[Path]
+      def self.from_parent_and_subpath: (NonEmptyArray[Path] parent_path, (NonEmptyArray[Path]?) subpath) -> Location
+      def self.resolve_path: (NonEmptyArray[Path] parent_path, (NonEmptyArray[Path]?) subpath) -> NonEmptyArray[Path]
+      def initialize: (?NonEmptyArray[Path] paths) -> void
+      def initialize_copy: (self original) -> void
+      def <=>: (self other) -> Integer?
+      def path_string: -> String
+      def to_s: -> String
+      def inspect: -> String
+      def join: (*Path other_paths) -> Location
+    end
+
+    class Path
+      @string_cache: String
+
+      attr_reader steps: Array[Path | Step]
+      attr_reader offset: (CharacterOffset | TemporalSpatialOffset)?
+      def initialize: (?Array[Path | Step] steps, ?nil offset) -> void
+      def initialize_copy: (self original) -> void
+      def to_s: -> String
+      def <=>: (self other) -> Integer?
+    end
+
+    class Range < ::Range[Location]
+      @string_cache: String
+
+      attr_accessor parent_path: Location
+      attr_accessor start_subpath: String
+      attr_accessor end_subpath: String
+      def self.from_parent_and_start_and_end: (NonEmptyArray[Path] parent_path, NonEmptyArray[Path] start_subpath, NonEmptyArray[Path] end_subpath) -> Range
+      def to_s: -> String
+    end
+
+    class Step
+      @string_cache: String?
+
+      attr_reader value: Integer
+      attr_reader assertion: (IDAssertion | String)?
+      alias step value
+      def initialize: (Integer value, ?(IDAssertion | String)? assertion) -> void
+      def initialize_copy: (self original) -> void
+      def to_s: -> String
+      def <=>: (self other) -> Integer?
+      def element?: -> bool
+      def character_data?: -> bool
+    end
+
+    class IDAssertion
+      @string_cache: String?
+
+      attr_reader id: String
+      attr_reader parameters: Hash[String, [String]]
+      def initialize: (String id, ?Hash[String, [String]] parameters) -> void
+      def to_s: -> String
+    end
+
+    class TextLocationAssertion
+      @string_cache: String?
+
+      attr_reader preceded: String?
+      attr_reader followed: String?
+      attr_reader parameters: Hash[String, [String]]
+      def initialize: (?String? preceded, ?String? followed, ?Hash[String, [String]] parameters) -> void
+      def to_s: -> String
+    end
+
+    class CharacterOffset
+      @string_cache: String?
+
+      attr_reader value: Integer
+      attr_reader assertion: TextLocationAssertion?
+      alias offset value
+      def initialize: (Integer value, ?TextLocationAssertion? assertion) -> void
+      def to_s: -> String
+      def <=>: (self other) -> Integer?
+    end
+
+    class TemporalSpatialOffset
+      @string_cache: String?
+
+      attr_reader temporal: (Float | Integer)?
+      attr_reader x: (Float | Integer)?
+      attr_reader y: (Float | Integer)?
+      attr_reader assertion: nil
+      def initialize: (?(Float | Integer)? temporal, ?(Float | Integer)? x, ?(Float | Integer)? y, ?nil assertion) -> void
+      def to_s: -> String
+      def <=>: (self other) -> Integer?
+    end
+
+    class Parser < Racc::Parser
+      Racc_arg: [[Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer], [Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer], [Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer], [Integer, Integer, Integer, Integer, Integer, Integer, nil, nil, Integer, nil, Integer, nil, Integer, nil, Integer, nil, Integer, nil, nil, nil, Integer, nil, Integer, Integer, Integer, Integer, nil, Integer, nil, Integer, nil, nil, nil, Integer, nil, nil, Integer, nil, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, Integer, nil, Integer, nil, nil, Integer, Integer, nil, nil, Integer, nil, Integer, Integer, Integer, Integer, Integer, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, Integer, Integer, nil, nil, Integer, nil, Integer, nil, Integer, Integer, nil, Integer, nil], [Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, Integer, Integer, nil, nil, nil, Integer, Integer], [Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, Integer, Integer, nil, nil, nil, Integer, Integer], [nil, nil, nil, nil, nil, Integer, nil, Integer, nil, nil, nil, nil, nil, Integer, nil, nil, Integer, nil, nil, nil, nil, Integer, Integer, nil, nil, nil, Integer, nil, nil, Integer, nil, Integer, nil, nil, Integer, Integer, nil, Integer, Integer], [nil, Integer, Integer, Integer, Integer, Integer, Integer, nil, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, nil, Integer, Integer, Integer, Integer, Integer, Integer, Integer, nil, Integer, Integer, Integer, Integer, Integer, nil, Integer, Integer, nil], Integer, [Integer, Integer, :racc_error, Integer, Integer, :_reduce_1, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_4, Integer, Integer, :_reduce_5, Integer, Integer, :_reduce_6, Integer, Integer, :_reduce_7, Integer, Integer, :_reduce_8, Integer, Integer, :_reduce_9, Integer, Integer, :_reduce_10, Integer, Integer, :_reduce_11, Integer, Integer, :_reduce_12, Integer, Integer, :_reduce_13, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_16, Integer, Integer, :_reduce_17, Integer, Integer, :_reduce_18, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_21, Integer, Integer, :_reduce_22, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_24, Integer, Integer, :_reduce_25, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_28, Integer, Integer, :_reduce_29, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_31, Integer, Integer, :_reduce_32, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_35, Integer, Integer, :_reduce_36, Integer, Integer, :_reduce_37, Integer, Integer, :_reduce_38, Integer, Integer, :_reduce_39, Integer, Integer, :_reduce_40, Integer, Integer, :_reduce_41, Integer, Integer, :_reduce_42, Integer, Integer, :_reduce_43, Integer, Integer, :_reduce_44, Integer, Integer, :_reduce_45, Integer, Integer, :_reduce_46, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_48, Integer, Integer, :_reduce_49, Integer, Integer, :_reduce_50, Integer, Integer, :_reduce_51, Integer, Integer, :_reduce_52, Integer, Integer, :_reduce_53, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_56, Integer, Integer, :_reduce_57, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none, Integer, Integer, :_reduce_none], Hash[:ATMARK | :CIRCUMFLEX | :CLOSING_PARENTHESIS | :CLOSING_SQUARE_BRACKET | :COLON | :COMMA | :DIGIT_NON_ZERO | :DOT | :EQUAL | :EXCLAMATION_MARK | :OPENING_PARENTHESIS | :OPENING_SQUARE_BRACKET | :SEMICOLON | :SOLIDUS | :SPACE | :TILDE | :UNICODE_CHARACTER_EXCLUDING_SPECIAL_CHARS_AND_SPACE_AND_DOT_AND_COLON_AND_TILDE_AND_ATMARK_AND_SOLIDUS_AND_EXCLAMATION_MARK | :ZERO | :error | false, Integer], Integer, Integer, true]
+      Racc_token_to_s_table: [String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String]
+      Racc_debug_parser: false
+      UNICODE_CHARACTER_EXCLUDING_SPECIAL_CHARS_AND_SPACE_AND_DOT_AND_COLON_AND_TILDE_AND_ATMARK_AND_SOLIDUS_AND_EXCLAMATION_MARK_PATTERN: Regexp
+      FRAGMENT_PREFIX: "epubcfi("
+      FRAGMENT_PREFIX_LENGTH: 8
+      FRAGMENT_SUFFIX_LENGTH: 1
+      include Comparable
+
+      def _reduce_none: (untyped val, untyped _values, untyped result) -> untyped
+      def self.parse: (String string, ?debug: boolish) -> (Location | Range)
+      def initialize: (?debug: boolish) -> void
+      def parse: (String string) -> (Location | Range)
+      def next_token: -> ([:ATMARK | :CIRCUMFLEX | :CLOSING_PARENTHESIS | :CLOSING_SQUARE_BRACKET | :COLON | :COMMA | :DIGIT_NON_ZERO | :DOT | :EQUAL | :EXCLAMATION_MARK | :OPENING_PARENTHESIS | :OPENING_SQUARE_BRACKET | :SEMICOLON | :SOLIDUS | :SPACE | :TILDE | :UNICODE_CHARACTER_EXCLUDING_SPECIAL_CHARS_AND_SPACE_AND_DOT_AND_COLON_AND_TILDE_AND_ATMARK_AND_SOLIDUS_AND_EXCLAMATION_MARK | :ZERO, String] | [bool, bool])
+    end
+  end
+end
+
+# Just for type checking
+class NonEmptyArray[T] < Array[T]
+  def last: -> T
+  def shift: -> T
+  def collect: { (T) -> untyped } -> NonEmptyArray[untyped]
+end

data/sig/shims/racc.rbs

@@ -0,0 +1,8 @@
+module Racc
+  class Parser
+    private def do_parse: () -> untyped
+  end
+
+  class ParseError < StandardError
+  end
+end

data/sig-private/shims/simplecov.rbs

@@ -0,0 +1,7 @@
+module SimpleCov
+  def self.start: { [self: Configuration] -> void } -> void
+
+  module Configuration
+    def add_filter: (string) -> void
+  end
+end

data/sig-private/shims/test-unit.rbs

@@ -0,0 +1,31 @@
+module Test
+  module Unit
+    class TestCase
+      include Assertions
+      extend Data::ClassMethods
+
+      def self.data: (untyped) -> untyped
+    end
+
+    module Assertions
+      def assert_equal: (untyped, untyped) -> void
+      def assert_not_same: (untyped, untyped) -> void
+      def assert_nil: (untyped) -> void
+      def assert_true: (untyped) -> void
+      def assert_block: (string?) { -> void } -> void
+      def assert_raise: (singleton(Exception)?) { -> void } -> void
+      def assert_nothing_raised: { -> void } -> void
+      def build_message: (string, string?, *string) -> String
+
+      class AssertionMessage
+        def self.delayed_diff: (string? from, string? to) -> String
+      end
+    end
+
+    module Data
+      module ClassMethods
+        def data: (untyped) -> untyped
+      end
+    end
+  end
+end

data/sig-private/test.rbs

@@ -0,0 +1,39 @@
+class TestCFI < Test::Unit::TestCase
+  private
+
+  def epubcfi: (String string) -> (EPUB::CFI::Location | EPUB::CFI::Range)
+  def assert_equal_node: (untyped expected, untyped actual, ?String message) -> void
+
+  class TestLocation < TestCFI
+  end
+
+  class TestPath < TestCFI
+  end
+
+  class TestRange < TestCFI
+  end
+
+  class TestStep < TestCFI
+  end
+
+  class TestIDAssertion < TestCFI
+  end
+
+  class TestTextLocationAssertion < TestCFI
+  end
+
+  class TestCharacterOffset < TestCFI
+  end
+
+  class TestSpatialOffset < TestCFI
+  end
+
+  class TestTemporalOffset < TestCFI
+  end
+
+  class TestTemporalSpatialOffset < TestCFI
+  end
+end
+
+class TestParserCFI < Test::Unit::TestCase
+end

data/test/helper.rb

@@ -5,9 +5,3 @@ end
 
 require 'test/unit'
 require "test/unit/notify"
-
-require "pretty_backtrace"
-PrettyBacktrace.enable
-
-class Test::Unit::TestCase
-end

data/test/test_cfi.rb

@@ -21,13 +21,14 @@ class TestCFI < Test::Unit::TestCase
 
     def test_join
       location = EPUB::CFI::Parser.parse('epubcfi(/6/14[chap05ref])')
+      # @type var location: EPUB::CFI::Location
       other_path = EPUB::CFI::Path.new([EPUB::CFI::Path.new([
         EPUB::CFI::Step.new(4, EPUB::CFI::IDAssertion.new('body01')),
         EPUB::CFI::Step.new(10),
         EPUB::CFI::Step.new(2),
         EPUB::CFI::Step.new(1)
       ])])
-      joined = location.join([other_path])
+      joined = location.join(other_path)
 
       assert_equal 'epubcfi(/6/14[chap05ref]!/4[body01]/10/2/1)', joined.to_s
     end
@@ -81,6 +82,7 @@ class TestCFI < Test::Unit::TestCase
       first = epubcfi('/6/4[chap01ref]!/4[body01]/10[para05]/2/1:1')
       last = epubcfi('/6/4[chap01ref]!/4[body01]/10[para05]/3:4')
       range = epubcfi('/6/4[chap01ref]!/4[body01]/10[para05],/2/1:1,/3:4')
+      # @type var range: EPUB::CFI::Range
       assert_equal 0, first <=> range.first
       assert_equal 0, last <=> range.last
 
@@ -93,7 +95,9 @@ class TestCFI < Test::Unit::TestCase
     end
 
     def test_cover
-      assert_true epubcfi('/6/4[chap01ref]!/4[body01]/10[para05],/2/1:1,/3:4').cover? epubcfi('/6/4[chap01ref]!/4[body01]/10[para05]/2/2/4')
+      range = epubcfi('/6/4[chap01ref]!/4[body01]/10[para05],/2/1:1,/3:4')
+      # @type var range: EPUB::CFI::Range
+      assert_true range.cover? epubcfi('/6/4[chap01ref]!/4[body01]/10[para05]/2/2/4')
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epub-cfi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - KITAITI Makoto
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-19 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
@@ -17,7 +17,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pretty_backtrace
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: steep
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,13 +136,18 @@ files:
 - ChangeLog.adoc
 - README.adoc
 - Rakefile
-- appveyor.yml
+- Steepfile
 - epub-cfi.gemspec
 - lib/epub/cfi.rb
 - lib/epub/cfi/parser.rb
 - lib/epub/cfi/parser.tab.rb
 - lib/epub/cfi/parser.y
 - lib/epub/cfi/version.rb
+- sig-private/shims/simplecov.rbs
+- sig-private/shims/test-unit.rbs
+- sig-private/test.rbs
+- sig/epub-cfi.rbs
+- sig/shims/racc.rbs
 - test/helper.rb
 - test/test_cfi.rb
 - test/test_parser.rb
@@ -150,7 +155,7 @@ homepage: https://gitlab.com/KitaitiMakoto/epub-cfi
 licenses:
 - LGPL
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: EPUB CFI parser and builder
 test_files:

data/appveyor.yml

@@ -1,21 +0,0 @@
-version: 1.0.{build}-{branch}
-
-environment:
-  matrix:
-    - RUBY_VERSION: 23
-    - RUBY_VERSION: 24
-    - RUBY_VERSION: 25
-    - RUBY_VERSION: 26
-
-install:
-  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  - gem install --no-document racc rake rubygems-tasks yard test-unit test-unit-notify pretty_backtrace simplecov
-
-build: off
-
-before_test:
-  - ruby -v
-  - gem -v
-
-test_script:
-  - rake test