positionrange 0.6.2 → 0.6.4

data/CHANGELOG

@@ -0,0 +1,25 @@
+*0.6.4* (May 2009)
+
+* Fixed bug in translate_to/from_view
+* Added non-'!' alternatives to methods
+* Changed license to LGPL v3
+
+
+*0.6.3* (4 February 2009)
+
+* Updated README
+
+
+*0.6.2* (20 January 2009)
+
+* Updated link to docs in README.txt
+
+
+*0.6.1* (31 December 2008)
+
+* Updated README
+
+
+*0.6.0* (28 December 2008)
+
+* First release as a gem

data/LICENSE

@@ -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/{README.txt → README}

@@ -1,4 +1,6 @@
-= Position Range -- Ranges with attributes that can be juggled
+= Position Range Gem documentation
+
+-- Ranges with attributes that can be juggled
 
 Allows you to assign random attributes to ranges and juggle them in
 lists. Also adds parsing from string, but most intereting when used in
@@ -65,31 +67,19 @@ Clustering overlaps maintains attributes.
   > l.cluster_overlaps == output
   => true
 
-== Download
-
-The latest version of Position Range can be found at:
-
-* http://rubyforge.org/frs/?group_id=7564
-
-Documentation can be found at:
-
-* http://positionrange.rubyforge.org
-
 == Installation
 
 You can install Position Range with the following command:
 
   % [sudo] gem install positionrange
 
-Or from its distribution directory with:
-
-  % [sudo] ruby install.rb
+The latest version of Diff LCS can also be downloaded at:
 
-== License
+* http://rubyforge.org/frs/?group_id=7564
 
-Position Range is released under the GNU Affero GPL licence.
+And then from its distribution directory installed with:
 
-* http://www.fsf.org/licensing/licenses/agpl-3.0.html
+  % [sudo] ruby install.rb
 
 == Support
 
@@ -101,3 +91,22 @@ For the latest news on Position Range:
 
 Feel free to submit commits or feature requests. If you send a patch,
 remember to update the corresponding unit tests.
+
+== This Documentation
+
+This documentation can be browsed online at:
+
+* http://positionrange.rubyforge.org
+
+== Copyrights
+
+Position Range and these docs are Copyright (c) 2006-2009 The LogiLogi
+Foundation. Position Range is licensed under the {Affero General Public
+License}[http://www.fsf.org/licensing/licenses/agpl-3.0.html].
+These docs are available under the {Creative Commons Attribution-Share
+Alike License}[http://creativecommons.org/licenses/by-sa/3.0/].
+
+If you want to use Position Range in a publicly accessable application
+that is not Free Software (that means not Affero GPLed), then please
+{contact us}[mailto:foundation@logilogi.org] for single server
+licenses or special arrangements.

data/Rakefile

@@ -34,7 +34,7 @@ Rake::RDocTask.new { |rdoc|
   rdoc.title    = "Position Range -- Ranges with attributes that can be juggled"
   rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
   rdoc.options << '--charset' << 'utf-8'
-  rdoc.rdoc_files.include('README.txt', 'CHANGELOG.txt')
+  rdoc.rdoc_files.include('README', 'CHANGELOG')
   rdoc.rdoc_files.include('lib/position_range.rb')
   rdoc.rdoc_files.include('lib/position_range/*.rb')
 }
@@ -56,7 +56,7 @@ spec = Gem::Specification.new do |s|
   s.requirements << 'none'
   s.require_path = 'lib'
 
-  s.files = [ "Rakefile", "install.rb", "README.txt", "CHANGELOG.txt", "LICENSE.txt" ]
+  s.files = [ "Rakefile", "install.rb", "README", "CHANGELOG", "LICENSE" ]
   s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
   s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
 end

data/lib/position_range/list.rb

@@ -57,7 +57,7 @@ class PositionRange::List < Array
   # Returns a new PositionRangeList for the provided string, covering
   # it from start to end (the 'string' can also be an array).
   #
-  def self.new_around(string)
+  def self.around(string)
     if string.size > 0
       return PositionRange::List.new([PositionRange.new(0,string.size)])
     else
@@ -97,7 +97,7 @@ class PositionRange::List < Array
   # Attributes are ignored.
   #
   def within?(other)
-    if (self.dup.substract!(other, :ignore_attributes => true)).empty?
+    if (self.substract(other, :ignore_attributes => true)).empty?
       return true
     else
       return false
@@ -134,16 +134,16 @@ class PositionRange::List < Array
   # 1,5:7,8:10,12' becomes '2,5:11,12' after limiting to '2,6:11,40'
   #
   def &(other)
-    substraction_list = other.dup.invert!
-    return self.dup.substract!(substraction_list,:ignore_attributes => true)
+    substraction_list = other.invert
+    return self.substract(substraction_list, :ignore_attributes => true)
   end
 
   # Applies a substraction in the sense of Set theory.
   #
-  # See substract!
+  # See substract
   #
   def -(other)
-    self.dup.substract!(other)
+    self.substract(other)
   end
 
   # Applies a substraction in the sense of Set theory.
@@ -160,7 +160,7 @@ class PositionRange::List < Array
   # Options
   # <tt>:ignore_attributes</tt> => Ignores attributes
   #
-  def substract!(other,options = {})
+  def substract!(other, options = {})
     ignore_attributes = options[:ignore_attributes]
 
     sorted_self = self.sort
@@ -201,12 +201,28 @@ class PositionRange::List < Array
     return self
   end
 
+  # Substraction returning a new list.
+  #
+  # See substract!
+  #
+  def substract(other, options = {})
+    self.dup.substract!(other)
+  end
+
   # Deletes the position_range that is specified.
   #
-  def delete(p_r)
+  def delete!(p_r)
     self.substract!(PositionRange::List.new([p_r]))
   end
 
+  # Deletion returning a new list.
+  #
+  # See delete!
+  #
+  def delete(p_r)
+    self.substract(PositionRange::List.new([p_r]))
+  end
+
   # Results in all positions being included, being excluded now, and
   # all positions that were excluded, being included now, upto the
   # range below maximum_size.
@@ -246,6 +262,14 @@ class PositionRange::List < Array
     return self
   end
 
+  # Inversion returning a new list.
+  #
+  # See invert!
+  #
+  def invert(maximum_size = PositionRange::MaximumSize)
+    self.dup.invert!
+  end
+
   # Makes sure that there are no non-overlapping borders between
   # PositionRanges.
   #
@@ -297,6 +321,14 @@ class PositionRange::List < Array
     return self
   end
 
+  # Lining up overlaps returning a new list.
+  #
+  # See line_up_overlaps!
+  #
+  def line_up_overlaps
+    self.dup.line_up_overlaps!
+  end
+
   # Simplifies the PositionRange::List by merging adjacent PositionRanges.
   #
   # Example:
@@ -322,6 +354,14 @@ class PositionRange::List < Array
     return self
   end
 
+  # Merging adjacents returning a new list.
+  #
+  # See merge_adjacents!
+  # 
+  def merge_adjacents(options = {})
+    self.dup.merge_adjacents!(options)
+  end
+
   # Translates the PositionRange::List in space, along the given vector.
   #
   def translate!(integer)
@@ -334,6 +374,14 @@ class PositionRange::List < Array
     return self
   end
 
+  # Translation returning a new list.
+  #
+  # See translate!
+  #
+  def translate(integer)
+    self.dup.translate!(integer)
+  end
+
   # The ranges_to_insert are inserted at the ranges_at_which_to_insert
   # of this list, counted in range_size from it's beginning, and inter-
   # luded with ranges_to_skip.
@@ -385,6 +433,16 @@ class PositionRange::List < Array
     return self
   end
 
+  # Inserting at ranges returning a new list.
+  #
+  # See insert_at_ranges!
+  #
+  def insert_at_ranges(ranges_to_insert, ranges_at_which_to_insert,
+      ranges_to_skip = [])
+    return self.dup.insert_at_ranges!(ranges_to_insert, ranges_at_which_to_insert,
+        ranges_to_skip)
+  end
+
   ### Highlevel methods
 
   # Translates the PositionRange::List into the relative space defined
@@ -392,13 +450,16 @@ class PositionRange::List < Array
   #
   def translate_to_view(view_position_range_list)
     relative = PositionRange::List.new
-    view_p = 0
-    view_position_range_list.each {|snippet_p_r|
-      translate_list = self & PositionRange::List.new([snippet_p_r])
-      vector = view_p - snippet_p_r.first
-      relative.concat(translate_list.translate!(vector))
-      view_p += snippet_p_r.size
-    }
+    self.each do |p_r|
+      view_p = 0
+      p_r_list = PositionRange::List.new([p_r])
+      view_position_range_list.each do |snippet_p_r|
+        translate_list = p_r_list & PositionRange::List.new([snippet_p_r])
+        vector = view_p - snippet_p_r.first
+        relative.concat(translate_list.translate!(vector))
+        view_p += snippet_p_r.size
+      end
+    end
     relative.merge_adjacents!
     return relative
   end
@@ -407,14 +468,17 @@ class PositionRange::List < Array
   #
   def translate_from_view(view_position_range_list)
     absolute = PositionRange::List.new
-    view_p = 0
-    view_position_range_list.each {|snippet_p_r|
-      translate_list = self & PositionRange::List.new(
-          [PositionRange.new(view_p,view_p + snippet_p_r.size)])
-      vector = snippet_p_r.first - view_p
-      absolute.concat(translate_list.translate!(vector))
-      view_p += snippet_p_r.size
-    }
+    self.each do |p_r|
+      view_p = 0
+      p_r_list = PositionRange::List.new([p_r])
+      view_position_range_list.each do |snippet_p_r|
+        translate_list = p_r_list & PositionRange::List.new(
+            [PositionRange.new(view_p,view_p + snippet_p_r.size)])
+        vector = snippet_p_r.first - view_p
+        absolute.concat(translate_list.translate!(vector))
+        view_p += snippet_p_r.size
+      end
+    end
     absolute.merge_adjacents!
     return absolute
   end
@@ -454,7 +518,7 @@ class PositionRange::List < Array
   #
   def cluster_overlaps
     if !self.empty?
-      lined_up_self = self.dup.line_up_overlaps!
+      lined_up_self = self.line_up_overlaps
       clusters = [PositionRange::List.new().push(lined_up_self.shift)]
       lined_up_self.each {|p_r|
         if p_r == clusters.last[0]

data/lib/position_range/version.rb

@@ -2,7 +2,7 @@ module PositionRange
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 6
-    TINY  = 2
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/position_range_list_test.rb

@@ -37,13 +37,13 @@ class PositionRangeListTest < Test::Unit::TestCase
     }
   end
 
-  def test_new_around
+  def test_around
     assert_equal PositionRange::List.from_s('0,5'),
-        PositionRange::List.new_around('12345')
+        PositionRange::List.around('12345')
     assert_equal PositionRange::List.from_s('0,3'),
-        PositionRange::List.new_around([1,2,3])
+        PositionRange::List.around([1,2,3])
     assert_equal PositionRange::List.new,
-        PositionRange::List.new_around('')
+        PositionRange::List.around('')
   end
 
   ### Getters
@@ -184,11 +184,30 @@ class PositionRangeListTest < Test::Unit::TestCase
     old = PositionRange::List.from_s('5,15:16,25')
     new = old.dup << PositionRange.new(10,20, :attr => 5)
     assert_equal PositionRange::List.new, old - new
+
+    # dup-alternatives
+    p = PositionRange::List.from_s('1,15')
+    to_p = PositionRange::List.from_s('2,6:7,12')
+
+    assert_equal to_p, p.substract(
+        PositionRange::List.from_s('1,2:6,7:12,20'))
+    assert p != to_p
+
+    assert_equal to_p, p.substract!(
+        PositionRange::List.from_s('1,2:6,7:12,20'))
+    assert_equal p, to_p
   end
 
   def test_delete
-    assert_equal PositionRange::List.from_s('1,3:6,8'),
-        PositionRange::List.from_s('1,5:4,8').delete(PositionRange.new(3,6))
+    # dup-alternatives
+    p = PositionRange::List.from_s('1,5:4,8')
+    to_p = PositionRange::List.from_s('1,3:6,8')
+
+    assert_equal to_p, p.delete(PositionRange.new(3,6))
+    assert p != to_p
+    
+    assert_equal to_p, p.delete!(PositionRange.new(3,6))
+    assert_equal p, to_p
   end
 
   def test_invert
@@ -211,6 +230,16 @@ class PositionRangeListTest < Test::Unit::TestCase
         PositionRange::List.new.invert!(55)
     assert_equal PositionRange::List.new,
         PositionRange::List.new.invert!(0)
+
+    # dup-alternatives
+    p = PositionRange::List.from_s('5,15')
+    to_p = PositionRange::List.from_s('0,5:15,' + PositionRange::MaximumSize.to_s)
+
+    assert_equal to_p, p.invert
+    assert p != to_p
+
+    assert_equal to_p, p.invert!
+    assert_equal p, to_p
   end
 
   def test_line_up_overlaps
@@ -272,6 +301,16 @@ class PositionRangeListTest < Test::Unit::TestCase
     # empty
     assert_equal PositionRange::List.new,
         PositionRange::List.new.line_up_overlaps!
+
+    # dup-alternatives
+    p = PositionRange::List.from_s('2,6:0,8')
+    to_p = PositionRange::List.from_s('0,2:2,6:2,6:6,8')
+
+    assert_equal to_p, p.line_up_overlaps
+    assert p != to_p
+
+    assert_equal to_p, p.line_up_overlaps!
+    assert_equal p, to_p
   end
 
   def test_merge_adjacents
@@ -300,6 +339,16 @@ class PositionRangeListTest < Test::Unit::TestCase
     # empty
     assert_equal PositionRange::List.new,
         PositionRange::List.new.merge_adjacents!
+
+    # dup-alternatives
+    p = PositionRange::List.from_s('2,4:4,8')
+    to_p = PositionRange::List.from_s('2,8')
+
+    assert_equal to_p, p.merge_adjacents
+    assert p != to_p
+
+    assert_equal to_p, p.merge_adjacents!
+    assert_equal p, to_p
   end
 
   def test_translate
@@ -314,6 +363,16 @@ class PositionRangeListTest < Test::Unit::TestCase
     # empty
     assert_equal PositionRange::List.new,
         PositionRange::List.new.translate!(5)
+
+    # dup-alternatives
+    p = PositionRange::List.from_s('10,13:16,18')
+    to_p = PositionRange::List.from_s('13,16:19,21')
+
+    assert_equal to_p, p.translate(3)
+    assert p != to_p
+
+    assert_equal to_p, p.translate!(3)
+    assert_equal p, to_p
   end
 
   def test_insert_at_ranges
@@ -353,6 +412,20 @@ class PositionRangeListTest < Test::Unit::TestCase
         PositionRange::List.from_s('0,750:100,250').insert_at_ranges!(
             PositionRange::List.from_s('20,30:40,50'),
             PositionRange::List.from_s('800,810:850,860'))
+
+    # dup-alternatives
+    p = PositionRange::List.from_s('0,10:15,20')
+    to_p = PositionRange::List.from_s('0,10:50,59:15,20')
+
+    assert_equal to_p, p.insert_at_ranges(
+        PositionRange::List.from_s('50,59'),
+        PositionRange::List.from_s('11,20'))
+    assert p != to_p
+
+    assert_equal to_p, p.insert_at_ranges!(
+        PositionRange::List.from_s('50,59'),
+        PositionRange::List.from_s('11,20'))
+    assert_equal p, to_p
   end
 
   ### Highlevel methods
@@ -372,9 +445,14 @@ class PositionRangeListTest < Test::Unit::TestCase
     assert_equal PositionRange::List.from_s('2,7'),
         p.translate_to_view(PositionRange::List.from_s('1,5:10,13'))
     # last before the first
-    assert_equal PositionRange::List.from_s('3,9:16,18'),
+    assert_equal PositionRange::List.from_s('16,18:3,9'),
         p.translate_to_view(PositionRange::List.from_s('7,20:0,6'))
 
+    # interrupted
+    p = PositionRange::List.from_s('10,20:90,100:20,30')
+    assert_equal PositionRange::List.from_s('0,10:70,80:10,20'),
+        p.translate_to_view(PositionRange::List.from_s('10,50:60,100'))
+
     # empty
     assert_equal PositionRange::List.new,
         PositionRange::List.new.translate_to_view(
@@ -400,6 +478,10 @@ class PositionRangeListTest < Test::Unit::TestCase
     p = PositionRange::List.from_s('5,6:1,2')
     assert_equal PositionRange::List.from_s('6,7:2,3'),
       p.translate_from_view(PositionRange::List.from_s('1,8'))
+    # interrupted
+    p = PositionRange::List.from_s('0,10:70,80:10,20')
+    assert_equal PositionRange::List.from_s('10,20:90,100:20,30'),
+        p.translate_from_view(PositionRange::List.from_s('10,50:60,100'))
 
     # empty
     assert_equal PositionRange::List.new,