multi_range 0.0.2 → 1.2.0

data/.travis.yml

@@ -1,29 +1,29 @@
-sudo: false
-env:
-  global:
-    - CC_TEST_REPORTER_ID=a2bb1313ac63f7ae7a7f13ac962870e3cdb0c345b6c60d2857807cc5153d7c3b
-language: ruby
-rvm:
-  - 2.2
-  - 2.6
-  - 2.7
-gemfile:
-  - gemfiles/Gemfile
-matrix:
-  include:
-    - dist: trusty
-      rvm: 1.8.7
-      gemfile: gemfiles/ruby_1_8_7.gemfile
-before_install:
-  - if `ruby -e 'exit(RUBY_VERSION.to_f < 2.7)'`; then
-      gem i rubygems-update -v '< 3' && update_rubygems;
-      gem install bundler -v '< 2';
-    fi
-  - gem --version
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rake test
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=a2bb1313ac63f7ae7a7f13ac962870e3cdb0c345b6c60d2857807cc5153d7c3b
+language: ruby
+rvm:
+  - 2.2
+  - 2.6
+  - 2.7
+gemfile:
+  - gemfiles/Gemfile
+matrix:
+  include:
+    - dist: trusty
+      rvm: 1.8.7
+      gemfile: gemfiles/ruby_1_8_7.gemfile
+before_install:
+  - if `ruby -e 'exit(RUBY_VERSION.to_f < 2.7)'`; then
+      gem i rubygems-update -v '< 3' && update_rubygems;
+      gem install bundler -v '< 2';
+    fi
+  - gem --version
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake test
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 ## Change Log
 
-### v0.0.1 2020/03/01
+### [v1.1.0](https://github.com/khiav223577/multi_range/compare/v1.0.0...v1.1.0) 2020/10/15
+- [#13](https://github.com/khiav223577/multi_range/pull/13) Rename flatten => merge_overlaps (@khiav223577)
+
+### [v1.0.0](https://github.com/khiav223577/multi_range/compare/v0.0.4...v1.0.0) 2020/10/15
+- [#12](https://github.com/khiav223577/multi_range/pull/12) Implement #overlaps? (@khiav223577)
+- [#11](https://github.com/khiav223577/multi_range/pull/11) Support difference other multi_range object (@khiav223577)
+- [#10](https://github.com/khiav223577/multi_range/pull/10) Add frozen_string_literal (@khiav223577)
+- [#9](https://github.com/khiav223577/multi_range/pull/9) Implement range union (@khiav223577)
+- [#8](https://github.com/khiav223577/multi_range/pull/8) Support initializing a MultiRange object with unsorted ranges (@khiav223577)
+
+### [v0.0.4](https://github.com/khiav223577/multi_range/compare/v0.0.3...v0.0.4) 2020/03/26
+- [#7](https://github.com/khiav223577/multi_range/pull/7) Add flatten method (@khiav223577)
+
+### [v0.0.3](https://github.com/khiav223577/multi_range/compare/v0.0.2...v0.0.3) 2020/03/02
+- [#6](https://github.com/khiav223577/multi_range/pull/6) freeze internal ranges variable (@khiav223577)
+- [#5](https://github.com/khiav223577/multi_range/pull/5) Add min, max, to_a method (@khiav223577)
+
+### [v0.0.2](https://github.com/khiav223577/multi_range/compare/v0.0.1...v0.0.2) 2020/03/02
+- [#4](https://github.com/khiav223577/multi_range/pull/4) Add each, map, index_with methods (@khiav223577)
+- [#3](https://github.com/khiav223577/multi_range/pull/3) Support passing integer as range (@khiav223577)
+
+### [v0.0.1](https://github.com/khiav223577/multi_range/compare/v0.0.1...v0.0.1) 2020/03/01
 - [#2](https://github.com/khiav223577/multi_range/pull/2) Support Ruby 1.8.7 (@khiav223577)
 - [#1](https://github.com/khiav223577/multi_range/pull/1) Implement MultiRange (@khiav223577)

data/CODE_OF_CONDUCT.md

@@ -1,49 +1,49 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at mrtmrt15xn@yahoo.com.tw. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mrtmrt15xn@yahoo.com.tw. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Rumble Huang
-
-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.
+MIT License
+
+Copyright (c) 2020 Rumble Huang
+
+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

@@ -1,87 +1,202 @@
-# MultiRange
-
-[![Gem Version](https://img.shields.io/gem/v/multi_range.svg?style=flat)](http://rubygems.org/gems/multi_range)
-[![Build Status](https://travis-ci.org/khiav223577/multi_range.svg?branch=master)](https://travis-ci.org/khiav223577/multi_range)
-[![RubyGems](http://img.shields.io/gem/dt/multi_range.svg?style=flat)](http://rubygems.org/gems/multi_range)
-[![Code Climate](https://codeclimate.com/github/khiav223577/multi_range/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/multi_range)
-[![Test Coverage](https://codeclimate.com/github/khiav223577/multi_range/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/multi_range/coverage)
-
-## Supports
-- Ruby 1.8 ~ 2.7
-
-## Installation
-
-```ruby
-gem 'multi_range'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install multi_range
-
-## Usage
-
-Allow you to manipulate a group of ranges.
-
-### Sample a number
-```rb
-multi_range = MultiRange.new([1..5, 10..12])
-multi_range.sample
-# => equals to [1, 2, 3, 4, 5, 10, 11, 12].sample
-```
-
-### Range difference
-```rb
-multi_range = MultiRange.new([1..10])
-multi_range -= 5..7
-multi_range.ranges
-# => [1...5, 8..10]
-```
-
-```rb
-multi_range = MultiRange.new([1..10, 50..70, 80..100])
-multi_range -= 5..85
-multi_range.ranges
-# => [1...5, 86..100]
-```
-
-### Range-like interface
-
-#### each
-```rb
-MultiRange([1..3, 5..6]).each{|s| print s }
-# => 12356
-```
-
-#### map
-```rb
-MultiRange([1..3, 5..6]).map{|s| s * 2 }
-# => [2, 4, 6, 10, 12]
-```
-
-#### index_with
-```rb
-MultiRange([1..3, 5..6]).index_with(true)
-# => { 1 => true, 2 => true, 3 => true, 5 => true, 6 => true }
-```
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/khiav223577/multi_range. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+# MultiRange
+
+[![Gem Version](https://img.shields.io/gem/v/multi_range.svg?style=flat)](http://rubygems.org/gems/multi_range)
+[![Build Status](https://travis-ci.com/khiav223577/multi_range.svg?branch=master)](https://travis-ci.org/khiav223577/multi_range)
+[![RubyGems](http://img.shields.io/gem/dt/multi_range.svg?style=flat)](http://rubygems.org/gems/multi_range)
+[![Code Climate](https://codeclimate.com/github/khiav223577/multi_range/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/multi_range)
+[![Test Coverage](https://codeclimate.com/github/khiav223577/multi_range/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/multi_range/coverage)
+
+## Supports
+- Ruby 1.8 ~ 2.7
+
+## Installation
+
+```ruby
+gem 'multi_range'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multi_range
+
+## Usage
+
+Allow you to manipulate a group of ranges. Such as merging overlapping ranges, doing ranges union and difference.
+
+### Sample a number
+```rb
+multi_range = MultiRange.new([1..5, 10..12])
+multi_range.sample
+# => equals to [1, 2, 3, 4, 5, 10, 11, 12].sample
+```
+
+### Difference of ranges
+```rb
+multi_range = MultiRange.new([1..10])
+multi_range -= 5..7
+multi_range.ranges
+# => [1...5, 8..10]
+```
+
+```rb
+multi_range = MultiRange.new([1..10, 50..70, 80..100])
+multi_range -= 5..85
+multi_range.ranges
+# => [1...5, 86..100]
+```
+
+```rb
+multi_range = MultiRange.new([1..10, 50..70, 80..100])
+multi_range -= MultiRange.new([5..60, 75..85])
+multi_range.ranges
+# => [1...5, 61..70, 86..100] 
+```
+
+### Union ranges
+
+```rb
+multi_range = MultiRange.new([1..5])
+multi_range |= 3..8
+multi_range.ranges
+# => [1..8]
+```
+
+```rb
+multi_range = MultiRange.new([1..5, 10..15, 20..25])
+multi_range |= MultiRange.new([3..6, 14..22, 30])
+multi_range.ranges
+# => [1..6, 10..25, 30..30]
+```
+
+### Merge overlaps
+```rb
+multi_range = MultiRange.new([1, 2, 4..6, 7, 8..12])
+multi_range.merge_overlaps.ranges
+# => [1..2, 4..12]
+
+multi_range = MultiRange.new([1.2..1.5, 1.7..1.9, 1.8..2.2])
+multi_range.merge_overlaps.ranges
+# => [1.2..1.5, 1.7..2.2]
+```
+
+### Check if it overlaps with the other
+
+```rb
+multi_range = MultiRange.new([1..5, 10..15, 20..25])
+multi_range.overlaps?(7..8)
+# => false
+
+multi_range.overlaps?(3..8)
+# => true
+
+multi_range.overlaps?(7..12)
+# => true
+```
+
+```rb
+multi_range = MultiRange.new([1..5, 10..15, 20..25])
+multi_range.overlaps?(MultiRange.new([6..8, 18..22]))
+# => true
+```
+
+### Range-like interface
+
+#### each
+```rb
+MultiRange.new([1..3, 6, 8..9]).each{|s| print s }
+# => 123689
+```
+
+#### map
+```rb
+MultiRange.new([1..3, 6, 8..9]).map{|s| s * 2 }
+# => [2, 4, 6, 12, 16, 18]
+```
+
+#### index_with
+```rb
+MultiRange.new([1..3, 6, 8..9]).index_with(true)
+# => { 1 => true, 2 => true, 3 => true, 6 => true, 8 => true, 9 => true }
+```
+
+#### min
+```rb
+MultiRange.new([1..3, 6, 8..9]).min
+# => 1
+```
+
+#### max
+```rb
+MultiRange.new([1..3, 6, 8..9]).max
+# => 9
+```
+
+#### to_a
+```rb
+MultiRange.new([1..3, 6, 8..9]).to_a
+# => [1, 2, 3, 6, 8, 9]
+```
+
+
+#### size
+```rb
+MultiRange.new([1..3, 6, 8..9]).size
+# => 6
+```
+
+### Warning
+
+The return value may be different when there are some overlapped ranges.
+Call `merge_overlaps` if you want to merge overlapped ranges.
+
+```rb
+MultiRange.new([1..5, 3..6]).to_a
+# => [1, 2, 3, 4, 5, 3, 4, 5, 6] 
+
+MultiRange.new([1..5, 3..6]).merge_overlaps.to_a
+# => [1, 2, 3, 4, 5, 6]
+```
+
+```rb
+MultiRange.new([1..5, 3..6]).each{|s| print s }
+# => 123453456
+
+MultiRange.new([1..5, 3..6]).merge_overlaps.each{|s| print s }
+# => 123456
+```
+
+```rb
+MultiRange.new([1..5, 3..6]).map{|s| s * 2 }
+# => [2, 4, 6, 8, 10, 6, 8, 10, 12] 
+
+MultiRange.new([1..5, 3..6]).merge_overlaps.map{|s| s * 2 }
+# => [2, 4, 6, 8, 10, 12] 
+```
+
+```rb
+MultiRange.new([1..5, 3..6]).size
+# => 9
+
+MultiRange.new([1..5, 3..6]).merge_overlaps.size
+# => 6
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/khiav223577/multi_range. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+