range_utils 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1af9e6d4733a5b64c0f6f44036636c215b1708f
+  data.tar.gz: 7c74535167ad2a1ab35b63dff3c27dc4c9112a31
+SHA512:
+  metadata.gz: 84ee08a6267adbf7e1922e172ed0e12648f3a816255f410162fae6fa31dc9b4eba82568618bb73b7c76b444a3604cca4014e360c5791c41a6e50f70039e2c6bb
+  data.tar.gz: f2af9fa0b3678920c1b1fa0315bc3e57871dc4c8b14ad6f0edf61901e6a16e2ec78b8bcf9ee6cf672397fa36a8e6374b58aef819a10a270aa532a60e5c0ac387

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - 2.1.2
+  - jruby
+cache: bundler
+sudo: false

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 3.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Julik Tarkhanov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# range_utils
+
+There is more to a Range than meets the eye. Or more to the eye than meets the Range. Or whatever.
+`RangeUtils` is a non-intrusive module for doing useful things to Range objects.
+
+It is mainly useful for working with batches of IDs and HTTP content ranges.
+
+## Usage
+
+Combine consecutive Range objects:
+
+    RangeUtils.splice([0..0, 0..4, 5..14, 16..20]) #=> [0..14, 16..20]
+
+Get the range for a given size of the collection:
+
+    RangeUtils.range_for_size(14) #=> 0..13
+
+Get the Ranges of maximum size for a given number of elements:
+
+    RangeUtils.ranges_of_offfsets_for_size(3, 1) #=> [0..0, 1..1, 2..2]
+
+Split a large Range into smaller ranges of given maximum size:
+
+    RangeUtils.split_range_into_subranges_of(0..7, 3) #=> [0..2, 3..5, 5..7]
+
+Prepare a number of HTTP Range headers (each request will be 1 byte):
+
+    RangeUtils.http_ranges_for_size(3, 1) #=> [0..0, 1..1, 2..2]
+
+## Contributing to range_utils
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2015 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require File.dirname(__FILE__) + '/lib/range_utils'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.version = RangeUtils::VERSION
+  gem.name = "range_utils"
+  gem.homepage = "http://github.com/julik/range_utils"
+  gem.license = "MIT"
+  gem.summary = %Q{There is a whole range of things you can do with a Range}
+  gem.description = %Q{Range splice, split and other niceties}
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "range_utils #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/range_utils.rb

@@ -0,0 +1,87 @@
+module RangeUtils
+  VERSION = '1.0.0'
+  
+  # Tells whether the +item+ is included in the +range+, without enumerating
+  # through the +range+ (performing a quick bounds check).
+  # The first value of the range and the +item+ have to support +<=>+
+  def range_includes_item?(range, item)
+    range.begin <= item && item <= range.end
+  end
+  
+  # Splits the given Range into subranges of +size+.
+  #
+  #   split_range_into_subranges_of(0..7, 3) #=> [0..2, 3..5, 5..7]
+  # 
+  # Range members must support +<=>+ and aruthmetic with integers.
+  # +size+ has to be > 0.
+  def split_range_into_subranges_of(range, size)
+    raise ArgumentError, "Chunk size should be > 0, was #{size}" unless size > 0
+    
+    num_values = range.end - range.begin + 1
+    ranges = []
+    at = range.begin
+    loop do
+      if at > range.end
+        return ranges
+      else
+        end_of_chunk = (at + size - 1)
+        current = at..(end_of_chunk > range.end ? range.end : end_of_chunk)
+        at = (at + size)
+        ranges << current
+        yield(current) if block_given?
+      end
+    end
+  end
+  
+  # Returns ranges for the given size. The returned ranges start at zero.
+  # Can be used to split a Content-Length of an HTTP resource into
+  # ranges usable in Range: header for instance.
+  #
+  # Since the initial offset is 0 the resulting ranges will always end at
+  # +size - 1+
+  #
+  #   ranges_of_offfsets_for_size(3, 1) #=> [0..0, 1..1, 2..2]
+  #   ranges_of_offfsets_for_size(3, 2) #=> [0..1, 2..2]
+  # 
+  # Range members must support +<=>+ and aruthmetic with integers.
+  # +size+ has to be > 0.
+  def ranges_of_offfsets_for_size(number_of_items, chunk_size)
+    raise ArgumentError, "Chunk size should be > 0, was #{chunk_size}" unless chunk_size > 0
+    split_range_into_subranges_of(range_for_size_of(number_of_items), chunk_size)
+  end
+  
+  # Creates a Range that can be used to grab N first elements from, say,
+  # an Array or a String.
+  #   range_for_size(14) #=> 0..13
+  #   "abcd"[range_for_size(2)] #=> "ab"
+  #
+  # +number_of_items+ should be >= 0. For the +number_of_items+
+  # a special Range of 0..-1 will be returned (note that this Range cannot fetch anything).
+  def range_for_size_of(number_of_items)
+    raise ArgumentError, "Number of items should be at least 0, was #{number_of_items}"  if number_of_items < 0
+    (0..(number_of_items - 1))
+  end
+  
+  # Combine ranges with adjacent or overlapping values (create a union range).
+  #   splice([0..0, 0..4, 5..14, 16..20]) #=> [0..14, 16..20]
+  # Range members must support +<=>+ and aruthmetic with integers.
+  def splice(ranges)
+    ranges.sort_by(&:begin).inject([]) do | spliced, r |
+      if spliced.empty?
+        spliced + [r]
+      else
+        last = spliced.pop
+        if last.end >= (r.begin - 1)
+          ends = [last.end, last.begin, r.begin, r.end].sort
+          new_end, new_begin = ends.shift, ends.pop
+          spliced + [(new_end..new_begin)]
+        else
+          spliced + [last, r]
+        end
+      end
+    end
+  end
+  
+  alias_method :http_ranges_for_size, :ranges_of_offfsets_for_size
+  extend self
+end

data/spec/range_utils_spec.rb

@@ -0,0 +1,125 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'range_utils'
+
+RSpec.configure {|c| c.order = 'random' }
+
+describe "RangeUtils" do
+  let(:subject) { RangeUtils }
+  
+  context '.range_includes_item?' do
+    it 'properly detects inclusion' do
+      range = 5..98
+      expect(subject.range_includes_item?(range, 5)).to eq(true)
+      expect(subject.range_includes_item?(range, 98)).to eq(true)
+      expect(subject.range_includes_item?(range, 97)).to eq(true)
+      
+      expect(subject.range_includes_item?(range, 1)).to eq(false)
+      expect(subject.range_includes_item?(range, 4)).to eq(false)
+    end
+  end
+  
+  context '.split_range_into_subranges_of' do
+    it 'raises an ArgumentError when the size is < 1' do
+      expect {
+        subject.split_range_into_subranges_of(15..456, -2)
+      }.to raise_error(ArgumentError, 'Chunk size should be > 0, was -2')
+      
+      expect {
+        subject.split_range_into_subranges_of(15..456, 0)
+      }.to raise_error(ArgumentError, 'Chunk size should be > 0, was 0')
+    end
+    
+    it 'splits a range into ranges' do
+      expect(subject.split_range_into_subranges_of(0..7, 3)).to eq([0..2, 3..5, 6..7])
+      expect(subject.split_range_into_subranges_of(0..786, 324)).to eq([0..323, 324..647, 648..786])
+      expect(subject.split_range_into_subranges_of(245..786, 324)).to eq([245..568, 569..786])
+    end
+    
+    it 'yields each subrange in succession' do
+      expect { |b|
+        subject.split_range_into_subranges_of(0..786, 324, &b)
+      }.to yield_successive_args(0..323, 324..647, 648..786)
+    end
+    
+    it 'splits a range that spans 1 item' do
+      expect(subject.split_range_into_subranges_of(0..0, 1)).to eq([0..0])
+      expect(subject.split_range_into_subranges_of(0..0, 15)).to eq([0..0])
+    end
+    
+    it 'handles all division cases without raising exceptions' do
+      (1..300).each do | chunk_size |
+        subject.split_range_into_subranges_of(0..786, chunk_size)
+      end
+    end
+    
+    it 'is usable for HTTP ranges' do
+      bytes_total = 3087
+      chunk_size = 991
+      range = 128..(bytes_total + 128)
+      
+      ranges = subject.split_range_into_subranges_of(range, chunk_size)
+      expect(ranges).to eq([128..1118, 1119..2109, 2110..3100, 3101..3215])
+    end
+  end
+  
+  context '.splice' do
+    it 'splices adjacent and overlapping ranges, regardless of their ordering in the argument array' do
+      expect( subject.splice([500..600, 601..999]) ).to eq([500..999])
+      expect( subject.splice([601..999, 500..600]) ).to eq([500..999])
+      expect( subject.splice([500..700, 601..999]) ).to eq([500..999])
+    end
+    
+    it 'creates gaps when the ranges cannot be spliced' do
+      expect( subject.splice([500..600, 602..999]) ).to eq([500..600, 602..999])
+      expect( subject.splice([601..999, 500..600, 10..44]) ).to eq([10..44, 500..999])
+    end
+  end
+  
+  context '.ranges_of_offfsets_for_size' do
+    it 'raises with a size < 1' do
+      expect {
+        subject.ranges_of_offfsets_for_size(3, 0)
+      }.to raise_error(ArgumentError, 'Chunk size should be > 0, was 0')
+      
+      expect {
+        subject.ranges_of_offfsets_for_size(3, -1)
+      }.to raise_error(ArgumentError, 'Chunk size should be > 0, was -1')
+    end
+    
+    it 'creates the ranges that cover the given number of elements' do
+      expect(subject.ranges_of_offfsets_for_size(3, 1)).to eq([0..0, 1..1, 2..2])
+      expect(subject.ranges_of_offfsets_for_size(3, 2)).to eq([0..1, 2..2])
+    end
+    
+    it 'splits a bigger size' do
+      bytes_total = 3087
+      chunk_size = 991
+      ranges = subject.ranges_of_offfsets_for_size(bytes_total, chunk_size)
+      expect(ranges).to eq([0..990, 991..1981, 1982..2972, 2973..3086])
+    end
+  end
+  
+  context '.range_for_size_of' do
+    it 'raises on size being < 0' do
+      expect {
+        subject.range_for_size_of(-4)
+      }.to raise_error(ArgumentError)
+    end
+    
+    it 'returns a special range for size 0 case' do
+      expect(subject.range_for_size_of(0)).to eq(0..-1)
+    end
+    
+    it 'returns the right range for the size' do
+      expect(subject.range_for_size_of(456)).to eq(0..455)
+    end
+  end
+  
+  context '.http_ranges_for_resource_size' do
+    it 'get returned without including the last value' do
+      expect(subject.http_ranges_for_size(785, 324)).to eq([0..323, 324..647, 648..784])
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: range_utils
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Range splice, split and other niceties
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/range_utils.rb
+- spec/range_utils_spec.rb
+homepage: http://github.com/julik/range_utils
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: There is a whole range of things you can do with a Range
+test_files: []