epub-cfi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8aca7ef76271077d0c4026b20d05df02926a9ca
+  data.tar.gz: 14dabd7b660a4047585ffa63cb2ac31bd109125f
+SHA512:
+  metadata.gz: 8eb1f1a5a5a5ba3e6fca187ffcadad7b796bc0ea680b5a2ef5b2659a4c5ed95986b57593c9622a0450033d084e00cf3ef6bef36c9e73ea15cf2b80ab4a011502
+  data.tar.gz: 213f294bb142f9ef4dd5402d0d3d8a702cdca7156d0cd7b298a0d0f512b1ac239593f9908b12d1b9235fc5b24205237c557308b81d8c702726c382104814b9d0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+COPYING.txt

data/.gitignore

@@ -0,0 +1,8 @@
+/lib/epub/cfi/parser.tab.rb
+/.bundle
+/.yardoc/
+/Gemfile.lock
+/doc/
+/pkg/
+/vendor/cache/*.gem
+/coverage/

data/.gitlab-ci.yml

@@ -0,0 +1,19 @@
+before_script:
+  - ruby -v
+  - which ruby
+  - gem install racc rake rubygems-tasks yard test-unit test-unit-notify pretty_backtrace simplecov
+
+test:2.2:
+  image: ruby:2.2
+  script:
+    rake test
+
+test:2.3:
+  image: ruby:2.3
+  script:
+    rake test
+
+test:2.4:
+  image: ruby:2.4
+  script:
+    rake test

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "EPUB CFI Documentation" --protected

data/COPYING.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2017-03-12
+
+* Initial release:
+

data/README.md

@@ -0,0 +1,85 @@
+EPUB CFI
+========
+
+* [Homepage](https://gitlab.com/KitaitiMakoto/epub-cfi)
+* [Documentation](http://rubydoc.info/gems/epub-cfi/frames)
+* [Email](mailto:KitaitiMakoto at gmail.com)
+
+Description
+-----------
+
+Parser and builder implementation for EPUB CFI defined at http://www.idpf.org/epub/linking/cfi/
+
+Extracted from [EPUB Parser][].
+
+[EPUB Parser]: http://www.rubydoc.info/gems/epub-parser/file/docs/Home.markdown
+
+Features
+--------
+
+* Parses EPUB CFI string.
+* Builds EPUB CFI(implemented but currently useless).
+* Converts EPUB CFI object to a string.
+
+Examples
+--------
+
+    require 'epub/cfi'
+    
+    location = EPUB::CFI.parse("epubcfi(/6/14[chap05ref]!/4[body01]/10/2/1:3[2^[1^]])")
+    # Or location = EPUB::CFI("epubcfi(/6/14[chap05ref]!/4[body01]/10/2/1:3[2^[1^]])")
+    # => #<EPUB::CFI::Location:/6/14[chap05ref]!/4[body01]/10/2/1:3[2^[1^]]>
+    location.to_s # => "epubcfi(/6/14[chap05ref]!/4[body01]/10/2/1:3[2^[1^]])"
+    
+    location1 = EPUB::CFI("/6/4[chap01ref]!/4[body01]/10[para05]/1:3[xx,y]")
+    location2 = EPUB::CFI("/6/4[chap01ref]!/4[body01]/10[para05]/2/1:3[yyy]")
+    location1 < location2 # => true
+    location1 <=> location1 # => -1
+    # location2 appears earlier than location1
+    
+    range = EPUB::CFI("/6/4[chap01ref]!/4[body01]/10[para05],/2/1:1,/3:4")
+    # => #<EPUB::CFI::Location:/6/4[chap01ref]!/4[body01]/10[para05]/2/1:1>..#<EPUB::CFI::Location:/6/4[chap01ref]!/4[body01]/10[para05]/3:4>
+    range.kind_of? ::Range # => true
+    range.begin
+    # => #<EPUB::CFI::Location:/6/4[chap01ref]!/4[body01]/10[para05]/2/1:1>
+    range.end
+    # => #<EPUB::CFI::Location:/6/4[chap01ref]!/4[body01]/10[para05]/3:4>
+    range.start_subpath
+    # => "/2/1:1"
+    range.end_subpath
+    # => "/3:4"
+    range.parent_path
+    # => #<EPUB::CFI::Location:/6/4[chap01ref]!/4[body01]/10[para05]>
+    range.to_s # => "epubcfi(/6/4[chap01ref]!/4[body01]/10[para05],/2/1:1,/3:4)"
+    
+    builtin_range = location2..location1
+    # => #<EPUB::CFI::Location:/6/4[chap01ref]!/4[body01]/10[para05]/2/1:3[yyy]>..#<EPUB::CFI::Location:/6/4[chap01ref]!/4[body01]/10[para05]/1:3[xx,y]>
+    builtin_range.to_s
+    # => "epubcfi(/6/4[chap01ref]!/4[body01]/10[para05]/2/1:3[yyy])..epubcfi(/6/4[chap01ref]!/4[body01]/10[para05]/1:3[xx,y])"
+    builtin_range.kind_of? ::Range # => true
+    builtin_range.kind_of? EPUB::CFI::Range # => false
+    cfi_range = EPUB::CFI::Range.new(location2, location1)
+    # => #<EPUB::CFI::Location:/6/4[chap01ref]!/4[body01]/10[para05]/2/1:3[yyy]>..#<EPUB::CFI::Location:/6/4[chap01ref]!/4[body01]/10[para05]/1:3[xx,y]>
+    cfi_range.kind_of? ::Range # => true
+    cfi_range.kind_of? EPUB::CFI::Range # => true
+
+Install
+-------
+
+    $ gem install epub-cfi
+
+See also
+--------
+
+* [EPUB Canonical Fragment Identifiers 1.1][spec]
+* [EPUB Parser][]
+
+[spec]: http://www.idpf.org/epub/linking/cfi/
+[EPUB Parser]: http://www.rubydoc.info/gems/epub-parser/file/docs/Home.markdown
+
+Copyright
+---------
+
+Copyright (c) 2017 KITAITI Makoto
+
+See {file:COPYING.txt} for details.

data/Rakefile

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'rake'
+
+task :default => "lib/epub/cfi/parser.tab.rb"
+
+file "lib/epub/cfi/parser.tab.rb" do |target|
+  sh "racc #{target.name.sub("tab.rb", "y")}"
+end
+
+require "rake/clean"
+CLEAN.include "lib/epub/cfi/parser.tab.rb"
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+task :build => [:clean, "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
+task :doc => :yard

data/epub-cfi.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'epub/cfi/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "epub-cfi"
+  gem.version       = EPUB::CFI::VERSION
+  gem.summary       = %q{EPUB CFI parser and builder}
+  gem.description   = %q{Parser and builder implementation for EPUB CFI defined at http://www.idpf.org/epub/linking/cfi/}
+  gem.license       = "LGPL"
+  gem.authors       = ["KITAITI Makoto"]
+  gem.email         = "KitaitiMakoto@gmail.com"
+  gem.homepage      = "https://gitlab.com/KitaitiMakoto/epub-cfi"
+
+  gem.files         = `git ls-files`.split($/) << "lib/epub/cfi/parser.tab.rb"
+
+  `git submodule --quiet foreach --recursive pwd`.split($/).each do |submodule|
+    submodule.sub!("#{Dir.pwd}/",'')
+
+    Dir.chdir(submodule) do
+      `git ls-files`.split($/).map do |subpath|
+        gem.files << File.join(submodule,subpath)
+      end
+    end
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  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"
+end

data/lib/epub/cfi.rb

@@ -0,0 +1,309 @@
+require 'epub/cfi/version'
+
+module EPUB
+  module CFI
+    SPECIAL_CHARS = '^[](),;=' # "5E", "5B", "5D", "28", "29", "2C", "3B", "3D"
+    RE_ESCAPED_SPECIAL_CHARS = Regexp.escape(SPECIAL_CHARS)
+
+    class << self
+      def escape(string)
+        string.gsub(/([#{RE_ESCAPED_SPECIAL_CHARS}])/o, '^\1')
+      end
+
+      def unescape(string)
+        string.gsub(/\^([#{RE_ESCAPED_SPECIAL_CHARS}])/o, '\1')
+      end
+    end
+
+    class Location
+      include Comparable
+
+      attr_reader :paths
+
+      def initialize(paths=[])
+        @paths = paths
+      end
+
+      def initialize_copy(original)
+        @paths = original.paths.collect(&:dup)
+      end
+
+      def <=>(other)
+        index = 0
+        other_paths = other.paths
+        cmp = nil
+        paths.each do |path|
+          other_path = other_paths[index]
+          return 1 unless other_path
+          cmp = path <=> other_path
+          break unless cmp == 0
+          index += 1
+        end
+
+        unless cmp == 0
+          if cmp == 1 and paths[index].offset and other_paths[index + 1]
+            return nil
+          else
+            return cmp
+          end
+        end
+
+        return nil if paths.last.offset && other_paths[index]
+
+        return -1 if other_paths[index]
+
+        0
+      end
+
+      def path_string
+        paths.join('!')
+      end
+
+      def to_s
+       "epubcfi(#{path_string})"
+      end
+
+      def inspect
+        "#<#{self.class}:#{path_string}>"
+      end
+
+      def join(*other_paths)
+        new_paths = paths.dup
+        other_paths.each do |path|
+          new_paths << path
+        end
+        self.class.new(new_paths)
+      end
+    end
+
+    class Path
+      attr_reader :steps, :offset
+
+      def initialize(steps=[], offset=nil)
+        @steps, @offset = steps, offset
+      end
+
+      def initialize_copy(original)
+        @steps = original.steps.collect(&:dup)
+        @offset = original.offset.dup if original.offset
+      end
+
+      def to_s
+        @string_cache ||= (steps.join + offset.to_s)
+      end
+
+      def <=>(other)
+        other_steps = other.steps
+        index = 0
+        steps.each do |step|
+          other_step = other_steps[index]
+          return 1 unless other_step
+          cmp = step <=> other_step
+          return cmp unless cmp == 0
+          index += 1
+        end
+
+        return -1 if other_steps[index]
+
+        other_offset = other.offset
+        if offset
+          if other_offset
+            offset <=> other_offset
+          else
+            1
+          end
+        else
+          if other_offset
+            -1
+          else
+            0
+          end
+        end
+      end
+
+      def each_step_with_instruction
+        yield [step, nil]
+        local_path.each_step_with_instruction do |s, instruction|
+          yield [s, instruction]
+        end
+        self
+      end
+    end
+
+    class Range < ::Range
+      attr_accessor :parent_path, :start_subpath, :end_subpath
+
+      # @todo consider the case subpaths are redirected path
+      # @todo FIXME: too dirty
+      class << self
+        def from_parent_and_start_and_end(parent_path, start_subpath, end_subpath)
+          start_str = start_subpath.join
+          end_str = end_subpath.join
+
+          first_paths = parent_path.collect(&:dup)
+          if start_subpath
+            offset_of_first = start_subpath.last.offset
+            offset_of_first = offset_of_first.dup if offset_of_first
+            last_of_first_paths = first_paths.pop
+            first_paths << last_of_first_paths
+            last_of_first_paths.steps.concat start_subpath.shift.steps
+            first_paths.concat start_subpath
+            first_paths.last.instance_variable_set :@offset, offset_of_first
+          end
+          offset_of_last = end_subpath.last.offset
+          offset_of_last = offset_of_last.dup if offset_of_last
+          last_paths = parent_path.collect(&:dup)
+          last_of_last_paths = last_paths.pop
+          last_paths << last_of_last_paths
+          last_of_last_paths.steps.concat end_subpath.shift.steps
+          last_paths.concat end_subpath
+          last_paths.last.instance_variable_set :@offset, offset_of_last
+
+          first = CFI::Location.new(first_paths)
+          last = CFI::Location.new(last_paths)
+
+          new_range = new(first, last)
+
+          new_range.parent_path = Location.new(parent_path)
+          new_range.start_subpath = start_str
+          new_range.end_subpath = end_str
+
+          new_range
+        end
+      end
+
+      def to_s
+        @string_cache ||= "epubcfi(#{@parent_path.path_string},#{@start_subpath},#{@end_subpath})"
+      end
+    end
+
+    class Step
+      attr_reader :value, :assertion
+      alias step value
+
+      def initialize(value, assertion=nil)
+        @value, @assertion = value, assertion
+        @string_cache = nil
+      end
+
+      def initialize_copy(original)
+        @value = original.value
+        @assertion = original.assertion.dup if original.assertion
+      end
+
+      def to_s
+        @string_cache ||= "/#{value}#{assertion}" # need escape?
+      end
+
+      def <=>(other)
+        value <=> other.value
+      end
+
+      def element?
+        value.even?
+      end
+
+      def character_data?
+        value.odd?
+      end
+    end
+
+    class IDAssertion
+      attr_reader :id, :parameters
+
+      def initialize(id, parameters={})
+        @id, @parameters = id, parameters
+        @string_cache = nil
+      end
+
+      def to_s
+        return @string_cache if @string_cache
+        string_cache = '['
+        string_cache << CFI.escape(id) if id
+        parameters.each_pair do |key, values|
+          value = values.join(',')
+          string_cache << ";#{CFI.escape(key)}=#{CFI.escape(value)}"
+        end
+        string_cache << ']'
+        @string_cache = string_cache
+      end
+    end
+
+    class TextLocationAssertion
+      attr_reader :preceded, :followed, :parameters
+
+      def initialize(preceded=nil, followed=nil, parameters={})
+        @preceded, @followed, @parameters = preceded, followed, parameters
+        @string_cache = nil
+      end
+
+      def to_s
+        return @string_cache if @string_cache
+        string_cache = '['
+        string_cache << CFI.escape(preceded) if preceded
+        string_cache << ',' << CFI.escape(followed) if followed
+        parameters.each_pair do |key, values|
+          value = values.join(',')
+          string_cache << ";#{CFI.escape(key)}=#{CFI.escape(value)}"
+        end
+        string_cache << ']'
+        @string_cache = string_cache
+      end
+    end
+
+    class CharacterOffset
+      attr_reader :value, :assertion
+      alias offset value
+
+      def initialize(value, assertion=nil)
+        @value, @assertion = value, assertion
+        @string_cache = nil
+      end
+
+      def to_s
+        @string_cache ||= ":#{value}#{assertion}" # need escape?
+      end
+
+      def <=>(other)
+        value <=> other.value
+      end
+    end
+
+    class TemporalSpatialOffset
+      attr_reader :temporal, :x, :y, :assertion
+
+      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
+        @temporal, @x, @y, @assertion = temporal, x, y, assertion
+        @string_cache = nil
+      end
+
+      def to_s
+        return @string_cache if @string_cache
+        string_cache = ''
+        string_cache << "~#{temporal}" if temporal
+        string_cache << "@#{x}:#{y}" if x or y
+        @string_cache = string_cache
+      end
+
+      # @note should split the class to spatial offset and temporal-spatial offset?
+      def <=>(other)
+        return -1 if temporal.nil? and other.temporal
+        return 1 if temporal and other.temporal.nil?
+        cmp = temporal <=> other.temporal
+        return cmp unless cmp == 0
+        return -1 if y.nil? and other.y
+        return 1 if y and other.y.nil?
+        cmp = y <=> other.y
+        return cmp unless cmp == 0
+        return -1 if x.nil? and other.x
+        return 1 if x and other.x.nil?
+        cmp = x <=> other.x
+      end
+    end
+  end
+end
+
+require "epub/cfi/parser"