range_list 0.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60084bab9a2a689bd360d45fbd94f6915159f20779edfa4137758f5c29bb6e89
-  data.tar.gz: 897265da656540c840314e498cc4bb792f0a384c54cc3f27f62a42506a8d5b1b
+  metadata.gz: c3bbec9e50fbfcf613d6371f9851c1410269819c738d362bbe0db73bf6ab1ed6
+  data.tar.gz: 48b42d5f37e67577cc92528b4f3e898b58f81f7781fa4ea388347572fb70d90a
 SHA512:
-  metadata.gz: db4e3df7dc8e9be8da2c490050d3fd8b9f4b0b58f88581a32ca788d54b53fdef9f2d4a1d1d4bacacc22f7bdcdf095e4749240afe8b6b25e69b5963f45cc76d2e
-  data.tar.gz: b8d0050152b5ac4221b41fc9223a845be3c8636d70a85a204c9e7bad455f155f3aa119ea0e635eb71982015918449de1da062d89ad8c8f30acf7e845769a3502
+  metadata.gz: c6f784320a3ab3b9b1c7714c9c7350aef3824b222a28ca0b1278722a728564b91c6c40faf3bbb8ea8a2926795daa56ca8f3db740cec6fd8833371bb60214ddd8
+  data.tar.gz: 98c20d0456e3c84432dfa9d3d09438c4887606dead589cfb1006407569b3c7f1330e0e3401fba5562b0c1c0c3dba408ad43fa0ea18f99232775ce7dcef69c3ee

data/Gemfile

@@ -8,3 +8,11 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.7"
+
+gem "yard", "~> 0.9.27"
+
+gem "simplecov", "~> 0.21.2"
+
+gem "simplecov-cobertura", "~> 2.1"

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    range_list (1.2.0)
+      rbtree (~> 0.4.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    docile (1.4.0)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbtree (0.4.5)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.7.2)
+      rubocop (= 1.25.1)
+      rubocop-performance (= 1.13.2)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-19
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  range_list!
+  simplecov (~> 0.21.2)
+  simplecov-cobertura (~> 2.1)
+  standard (~> 1.7)
+  yard (~> 0.9.27)
+
+BUNDLED WITH
+   2.3.8

data/README.md

@@ -1,28 +1,61 @@
 # RangeList
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/range_list`. To experiment with that code, run `bin/console` for an interactive prompt.
+RangeList is a library that can handle ranges quickly and appropriately.
 
-TODO: Delete this and the text above, and describe your gem
+A pair of integers define a range, for example: [1, 5), this range includes integers: 1, 2, 3, and 4.
+A range list is an aggregate of these ranges: [1, 5), [10, 11), [100, 201).
 
-## Installation
+RangeList use AVL Tree processing internally, so range operations are very fast.
 
-Add this line to your application's Gemfile:
+[![Gem Version](https://badge.fury.io/rb/range_list.svg)](https://rubygems.org/gems/range_list)
+[![Documentation](https://img.shields.io/badge/docs-YARD-blue.svg)](https://rubydoc.info/gems/range_list)
+[![pipeline status](https://gitlab.com/songhuangcn/range_list/badges/main/pipeline.svg)](https://gitlab.com/songhuangcn/range_list/-/commits/main)
+[![coverage report](https://gitlab.com/songhuangcn/range_list/badges/main/coverage.svg)](https://gitlab.com/songhuangcn/range_list/-/commits/main)
 
-```ruby
-gem 'range_list'
-```
+## Installation
 
-And then execute:
+Add gem to your application's Gemfile:
 
-    $ bundle install
+```shell
+bundle add range_list
+```
 
 Or install it yourself as:
 
-    $ gem install range_list
+```shell
+gem install range_list
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```shell
+range_list = RangeList.new
+range_list.add([1, 5]).add([10, 20])
+range_list.print # [1, 5) [10, 20)
+
+range_list.add([20, 20])
+range_list.print # [1, 5) [10, 20)
+
+range_list.add([15, 21])
+range_list.print # [1, 5) [10, 21)
+
+range_list.remove([15, 21])
+range_list.print # [1, 5) [10, 15)
+
+range_list.contains_any?([8, 10]) # false
+range_list.contains_any?([8, 11]) # true
+range_list.contains_all?([8, 11]) # false
+range_list.contains_all?([10, 11]) # true
+range_list.contains?(5) # false
+range_list.contains?(10) # true
+
+# RangeList has the `Enumerable` ability, feel free to use `each`, `map`, `to_a`, `min`, `max` etc. 
+range_list.each { |range_start, range_end| puts "#{range_start} <= x < #{range_end}" }
+
+range_list.remove([0, 100])
+range_list.print #
+range_list.to_a # []
+```
 
 ## Development
 
@@ -32,7 +65,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/range_list.
+Bug reports and Merge requests are welcome on GitLab at https://gitlab.com/songhuangcn/range_list.
 
 ## License
 

data/lib/range_list/errors.rb

@@ -0,0 +1,7 @@
+class RangeList
+  # RangeList base error.
+  class Error < StandardError; end
+
+  # When the error raised, you should see the doc and check your argument.
+  class ArgumentError < Error; end
+end

data/lib/range_list/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module RangeList
-  VERSION = "0.1.0"
+class RangeList
+  VERSION = "1.2.0"
 end

data/lib/range_list.rb

@@ -1,8 +1,155 @@
 # frozen_string_literal: true
 
+require "rbtree"
 require_relative "range_list/version"
+require_relative "range_list/errors"
 
-module RangeList
-  class Error < StandardError; end
-  # Your code goes here...
+class RangeList
+  include Enumerable
+
+  def initialize
+    @tree = RBTree.new
+  end
+
+  # Add range into current range list.
+  # @param range [Array<Integer>] the range, first element is range start, second is range end.
+  #   Range end need be greater or equal than range start.
+  # @return [RangeList]
+  # @raise [ArgumentError] when argement invalid
+  def add(range)
+    validate_range!(range)
+
+    # Return when range is empty.
+    return self if empty_range?(range)
+
+    # Get real range start.
+    start_floor_entry = tree.upper_bound(range[0])
+    range_start = if !start_floor_entry.nil? && start_floor_entry[1] >= range[0]
+      start_floor_entry[0]
+    else
+      range[0]
+    end
+
+    # Get real range end.
+    end_floor_entry = tree.upper_bound(range[1])
+    range_end = if !end_floor_entry.nil? && end_floor_entry[1] >= range[1]
+      end_floor_entry[1]
+    else
+      range[1]
+    end
+
+    # Insert or replace new range.
+    tree[range_start] = range_end
+
+    # Remove keys between range, exclude start, include end.
+    between_maps = tree.bound(range[0] + 1, range[1])
+    between_maps.to_a.each { |key, _value| tree.delete(key) }
+
+    self
+  end
+
+  # Remove range from current range list.
+  # @param (see #add)
+  # @return [RangeList]
+  # @raise (see #add)
+  def remove(range)
+    validate_range!(range)
+
+    # Return when range is empty.
+    return self if empty_range?(range)
+
+    # Insert end lower entry
+    end_lower_entry = tree.upper_bound(range[1] - 1)
+    if !end_lower_entry.nil? && end_lower_entry[1] > range[1]
+      tree[range[1]] = end_lower_entry[1]
+    end
+
+    # Relace start lower entry
+    start_lower_entry = tree.upper_bound(range[0] - 1)
+    if !start_lower_entry.nil? && start_lower_entry[1] > range[0]
+      tree[start_lower_entry[0]] = range[0]
+    end
+
+    # Remove keys between range, include start, exclude end
+    between_maps = tree.bound(range[0], range[1] - 1)
+    between_maps.to_a.each { |key, _value| tree.delete(key) }
+
+    self
+  end
+
+  # Print current range list.
+  # @return [void]
+  def print
+    puts map { |k, v| "[#{k}, #{v})" }.join(" ")
+  end
+
+  # Returns true if current ranges contains all elements of the range.
+  # @param (see #add)
+  # @return [Boolean]
+  # @note return false if the argument range is empty
+  # @raise (see #add)
+  def contains_all?(range)
+    validate_range!(range)
+
+    # Return false when range is empty.
+    return false if empty_range?(range)
+
+    start_floor_entry = tree.upper_bound(range[0])
+    !start_floor_entry.nil? && start_floor_entry[1] >= range[1]
+  end
+
+  # Returns true if current ranges contains any element of the range.
+  # @param (see #add)
+  # @return [Boolean]
+  # @note return false if the argument range is empty
+  # @raise (see #add)
+  def contains_any?(range)
+    validate_range!(range)
+
+    # Return false when range is empty.
+    return false if empty_range?(range)
+
+    end_lower_entry = tree.upper_bound(range[1] - 1)
+    !end_lower_entry.nil? && end_lower_entry[1] > range[0]
+  end
+
+  # Returns true if current ranges contains the element.
+  # @param element [Integer] the range element
+  # @return [Boolean]
+  # @raise (see #add)
+  def contains?(element)
+    raise ArgumentError, "`element` should be `Integer` type." unless element.is_a?(Integer)
+
+    floor_entry = tree.upper_bound(element)
+    !floor_entry.nil? && floor_entry[1] > element
+  end
+
+  # Give RangeList iterative ability.
+  # @yield [range_start, range_end] give the range element to the block
+  def each(&block)
+    if block
+      tree.each(&block)
+    else
+      enum_for(:each)
+    end
+  end
+
+  # @!visibility private
+  def inspect
+    to_a.inspect
+  end
+
+  private
+
+  attr_reader :tree
+
+  def validate_range!(range)
+    raise ArgumentError, "`range` should be `Array` type." unless range.is_a?(Array)
+    raise ArgumentError, "`range` size should be equal to 2." unless range.size == 2
+    raise ArgumentError, "All elements of `range` should be `Integer`." unless range.all? { |item| item.is_a?(Integer) }
+  end
+
+  def empty_range?(range)
+    range[0] >= range[1]
+  end
 end

data/range_list.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://gitlab.com/songhuangcn/range_list"
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/range_list"
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
@@ -33,6 +34,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "rbtree", "~> 0.4.5"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: range_list
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Song Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
-dependencies: []
+date: 2022-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbtree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
 description:
 email:
 - songhuangcn@gmail.com
@@ -18,19 +32,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/range_list.rb
+- lib/range_list/errors.rb
 - lib/range_list/version.rb
 - range_list.gemspec
-- sig/range_list.rbs
 homepage: https://gitlab.com/songhuangcn/range_list
 licenses:
 - MIT
 metadata:
   homepage_uri: https://gitlab.com/songhuangcn/range_list
   source_code_uri: https://gitlab.com/songhuangcn/range_list
+  documentation_uri: https://rubydoc.info/gems/range_list
 post_install_message:
 rdoc_options: []
 require_paths:

data/sig/range_list.rbs

@@ -1,4 +0,0 @@
-module RangeList
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end