multi_range 0.0.2 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,29 +1,29 @@
1
- sudo: false
2
- env:
3
- global:
4
- - CC_TEST_REPORTER_ID=a2bb1313ac63f7ae7a7f13ac962870e3cdb0c345b6c60d2857807cc5153d7c3b
5
- language: ruby
6
- rvm:
7
- - 2.2
8
- - 2.6
9
- - 2.7
10
- gemfile:
11
- - gemfiles/Gemfile
12
- matrix:
13
- include:
14
- - dist: trusty
15
- rvm: 1.8.7
16
- gemfile: gemfiles/ruby_1_8_7.gemfile
17
- before_install:
18
- - if `ruby -e 'exit(RUBY_VERSION.to_f < 2.7)'`; then
19
- gem i rubygems-update -v '< 3' && update_rubygems;
20
- gem install bundler -v '< 2';
21
- fi
22
- - gem --version
23
- - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
24
- - chmod +x ./cc-test-reporter
25
- - ./cc-test-reporter before-build
26
- script:
27
- - bundle exec rake test
28
- after_script:
29
- - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
1
+ sudo: false
2
+ env:
3
+ global:
4
+ - CC_TEST_REPORTER_ID=a2bb1313ac63f7ae7a7f13ac962870e3cdb0c345b6c60d2857807cc5153d7c3b
5
+ language: ruby
6
+ rvm:
7
+ - 2.2
8
+ - 2.6
9
+ - 2.7
10
+ gemfile:
11
+ - gemfiles/Gemfile
12
+ matrix:
13
+ include:
14
+ - dist: trusty
15
+ rvm: 1.8.7
16
+ gemfile: gemfiles/ruby_1_8_7.gemfile
17
+ before_install:
18
+ - if `ruby -e 'exit(RUBY_VERSION.to_f < 2.7)'`; then
19
+ gem i rubygems-update -v '< 3' && update_rubygems;
20
+ gem install bundler -v '< 2';
21
+ fi
22
+ - gem --version
23
+ - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
24
+ - chmod +x ./cc-test-reporter
25
+ - ./cc-test-reporter before-build
26
+ script:
27
+ - bundle exec rake test
28
+ after_script:
29
+ - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
@@ -1,5 +1,26 @@
1
1
  ## Change Log
2
2
 
3
- ### v0.0.1 2020/03/01
3
+ ### [v1.1.0](https://github.com/khiav223577/multi_range/compare/v1.0.0...v1.1.0) 2020/10/15
4
+ - [#13](https://github.com/khiav223577/multi_range/pull/13) Rename flatten => merge_overlaps (@khiav223577)
5
+
6
+ ### [v1.0.0](https://github.com/khiav223577/multi_range/compare/v0.0.4...v1.0.0) 2020/10/15
7
+ - [#12](https://github.com/khiav223577/multi_range/pull/12) Implement #overlaps? (@khiav223577)
8
+ - [#11](https://github.com/khiav223577/multi_range/pull/11) Support difference other multi_range object (@khiav223577)
9
+ - [#10](https://github.com/khiav223577/multi_range/pull/10) Add frozen_string_literal (@khiav223577)
10
+ - [#9](https://github.com/khiav223577/multi_range/pull/9) Implement range union (@khiav223577)
11
+ - [#8](https://github.com/khiav223577/multi_range/pull/8) Support initializing a MultiRange object with unsorted ranges (@khiav223577)
12
+
13
+ ### [v0.0.4](https://github.com/khiav223577/multi_range/compare/v0.0.3...v0.0.4) 2020/03/26
14
+ - [#7](https://github.com/khiav223577/multi_range/pull/7) Add flatten method (@khiav223577)
15
+
16
+ ### [v0.0.3](https://github.com/khiav223577/multi_range/compare/v0.0.2...v0.0.3) 2020/03/02
17
+ - [#6](https://github.com/khiav223577/multi_range/pull/6) freeze internal ranges variable (@khiav223577)
18
+ - [#5](https://github.com/khiav223577/multi_range/pull/5) Add min, max, to_a method (@khiav223577)
19
+
20
+ ### [v0.0.2](https://github.com/khiav223577/multi_range/compare/v0.0.1...v0.0.2) 2020/03/02
21
+ - [#4](https://github.com/khiav223577/multi_range/pull/4) Add each, map, index_with methods (@khiav223577)
22
+ - [#3](https://github.com/khiav223577/multi_range/pull/3) Support passing integer as range (@khiav223577)
23
+
24
+ ### [v0.0.1](https://github.com/khiav223577/multi_range/compare/v0.0.1...v0.0.1) 2020/03/01
4
25
  - [#2](https://github.com/khiav223577/multi_range/pull/2) Support Ruby 1.8.7 (@khiav223577)
5
26
  - [#1](https://github.com/khiav223577/multi_range/pull/1) Implement MultiRange (@khiav223577)
@@ -1,49 +1,49 @@
1
- # Contributor Code of Conduct
2
-
3
- As contributors and maintainers of this project, and in the interest of
4
- fostering an open and welcoming community, we pledge to respect all people who
5
- contribute through reporting issues, posting feature requests, updating
6
- documentation, submitting pull requests or patches, and other activities.
7
-
8
- We are committed to making participation in this project a harassment-free
9
- experience for everyone, regardless of level of experience, gender, gender
10
- identity and expression, sexual orientation, disability, personal appearance,
11
- body size, race, ethnicity, age, religion, or nationality.
12
-
13
- Examples of unacceptable behavior by participants include:
14
-
15
- * The use of sexualized language or imagery
16
- * Personal attacks
17
- * Trolling or insulting/derogatory comments
18
- * Public or private harassment
19
- * Publishing other's private information, such as physical or electronic
20
- addresses, without explicit permission
21
- * Other unethical or unprofessional conduct
22
-
23
- Project maintainers have the right and responsibility to remove, edit, or
24
- reject comments, commits, code, wiki edits, issues, and other contributions
25
- that are not aligned to this Code of Conduct, or to ban temporarily or
26
- permanently any contributor for other behaviors that they deem inappropriate,
27
- threatening, offensive, or harmful.
28
-
29
- By adopting this Code of Conduct, project maintainers commit themselves to
30
- fairly and consistently applying these principles to every aspect of managing
31
- this project. Project maintainers who do not follow or enforce the Code of
32
- Conduct may be permanently removed from the project team.
33
-
34
- This code of conduct applies both within project spaces and in public spaces
35
- when an individual is representing the project or its community.
36
-
37
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
- reported by contacting a project maintainer at mrtmrt15xn@yahoo.com.tw. All
39
- complaints will be reviewed and investigated and will result in a response that
40
- is deemed necessary and appropriate to the circumstances. Maintainers are
41
- obligated to maintain confidentiality with regard to the reporter of an
42
- incident.
43
-
44
- This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
- version 1.3.0, available at
46
- [http://contributor-covenant.org/version/1/3/0/][version]
47
-
48
- [homepage]: http://contributor-covenant.org
49
- [version]: http://contributor-covenant.org/version/1/3/0/
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at mrtmrt15xn@yahoo.com.tw. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2020 Rumble Huang
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2020 Rumble Huang
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md CHANGED
@@ -1,87 +1,202 @@
1
- # MultiRange
2
-
3
- [![Gem Version](https://img.shields.io/gem/v/multi_range.svg?style=flat)](http://rubygems.org/gems/multi_range)
4
- [![Build Status](https://travis-ci.org/khiav223577/multi_range.svg?branch=master)](https://travis-ci.org/khiav223577/multi_range)
5
- [![RubyGems](http://img.shields.io/gem/dt/multi_range.svg?style=flat)](http://rubygems.org/gems/multi_range)
6
- [![Code Climate](https://codeclimate.com/github/khiav223577/multi_range/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/multi_range)
7
- [![Test Coverage](https://codeclimate.com/github/khiav223577/multi_range/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/multi_range/coverage)
8
-
9
- ## Supports
10
- - Ruby 1.8 ~ 2.7
11
-
12
- ## Installation
13
-
14
- ```ruby
15
- gem 'multi_range'
16
- ```
17
-
18
- And then execute:
19
-
20
- $ bundle
21
-
22
- Or install it yourself as:
23
-
24
- $ gem install multi_range
25
-
26
- ## Usage
27
-
28
- Allow you to manipulate a group of ranges.
29
-
30
- ### Sample a number
31
- ```rb
32
- multi_range = MultiRange.new([1..5, 10..12])
33
- multi_range.sample
34
- # => equals to [1, 2, 3, 4, 5, 10, 11, 12].sample
35
- ```
36
-
37
- ### Range difference
38
- ```rb
39
- multi_range = MultiRange.new([1..10])
40
- multi_range -= 5..7
41
- multi_range.ranges
42
- # => [1...5, 8..10]
43
- ```
44
-
45
- ```rb
46
- multi_range = MultiRange.new([1..10, 50..70, 80..100])
47
- multi_range -= 5..85
48
- multi_range.ranges
49
- # => [1...5, 86..100]
50
- ```
51
-
52
- ### Range-like interface
53
-
54
- #### each
55
- ```rb
56
- MultiRange([1..3, 5..6]).each{|s| print s }
57
- # => 12356
58
- ```
59
-
60
- #### map
61
- ```rb
62
- MultiRange([1..3, 5..6]).map{|s| s * 2 }
63
- # => [2, 4, 6, 10, 12]
64
- ```
65
-
66
- #### index_with
67
- ```rb
68
- MultiRange([1..3, 5..6]).index_with(true)
69
- # => { 1 => true, 2 => true, 3 => true, 5 => true, 6 => true }
70
- ```
71
-
72
-
73
- ## Development
74
-
75
- 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.
76
-
77
- 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).
78
-
79
- ## Contributing
80
-
81
- 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.
82
-
83
-
84
- ## License
85
-
86
- The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
87
-
1
+ # MultiRange
2
+
3
+ [![Gem Version](https://img.shields.io/gem/v/multi_range.svg?style=flat)](http://rubygems.org/gems/multi_range)
4
+ [![Build Status](https://travis-ci.com/khiav223577/multi_range.svg?branch=master)](https://travis-ci.org/khiav223577/multi_range)
5
+ [![RubyGems](http://img.shields.io/gem/dt/multi_range.svg?style=flat)](http://rubygems.org/gems/multi_range)
6
+ [![Code Climate](https://codeclimate.com/github/khiav223577/multi_range/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/multi_range)
7
+ [![Test Coverage](https://codeclimate.com/github/khiav223577/multi_range/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/multi_range/coverage)
8
+
9
+ ## Supports
10
+ - Ruby 1.8 ~ 2.7
11
+
12
+ ## Installation
13
+
14
+ ```ruby
15
+ gem 'multi_range'
16
+ ```
17
+
18
+ And then execute:
19
+
20
+ $ bundle
21
+
22
+ Or install it yourself as:
23
+
24
+ $ gem install multi_range
25
+
26
+ ## Usage
27
+
28
+ Allow you to manipulate a group of ranges. Such as merging overlapping ranges, doing ranges union and difference.
29
+
30
+ ### Sample a number
31
+ ```rb
32
+ multi_range = MultiRange.new([1..5, 10..12])
33
+ multi_range.sample
34
+ # => equals to [1, 2, 3, 4, 5, 10, 11, 12].sample
35
+ ```
36
+
37
+ ### Difference of ranges
38
+ ```rb
39
+ multi_range = MultiRange.new([1..10])
40
+ multi_range -= 5..7
41
+ multi_range.ranges
42
+ # => [1...5, 8..10]
43
+ ```
44
+
45
+ ```rb
46
+ multi_range = MultiRange.new([1..10, 50..70, 80..100])
47
+ multi_range -= 5..85
48
+ multi_range.ranges
49
+ # => [1...5, 86..100]
50
+ ```
51
+
52
+ ```rb
53
+ multi_range = MultiRange.new([1..10, 50..70, 80..100])
54
+ multi_range -= MultiRange.new([5..60, 75..85])
55
+ multi_range.ranges
56
+ # => [1...5, 61..70, 86..100]
57
+ ```
58
+
59
+ ### Union ranges
60
+
61
+ ```rb
62
+ multi_range = MultiRange.new([1..5])
63
+ multi_range |= 3..8
64
+ multi_range.ranges
65
+ # => [1..8]
66
+ ```
67
+
68
+ ```rb
69
+ multi_range = MultiRange.new([1..5, 10..15, 20..25])
70
+ multi_range |= MultiRange.new([3..6, 14..22, 30])
71
+ multi_range.ranges
72
+ # => [1..6, 10..25, 30..30]
73
+ ```
74
+
75
+ ### Merge overlaps
76
+ ```rb
77
+ multi_range = MultiRange.new([1, 2, 4..6, 7, 8..12])
78
+ multi_range.merge_overlaps.ranges
79
+ # => [1..2, 4..12]
80
+
81
+ multi_range = MultiRange.new([1.2..1.5, 1.7..1.9, 1.8..2.2])
82
+ multi_range.merge_overlaps.ranges
83
+ # => [1.2..1.5, 1.7..2.2]
84
+ ```
85
+
86
+ ### Check if it overlaps with the other
87
+
88
+ ```rb
89
+ multi_range = MultiRange.new([1..5, 10..15, 20..25])
90
+ multi_range.overlaps?(7..8)
91
+ # => false
92
+
93
+ multi_range.overlaps?(3..8)
94
+ # => true
95
+
96
+ multi_range.overlaps?(7..12)
97
+ # => true
98
+ ```
99
+
100
+ ```rb
101
+ multi_range = MultiRange.new([1..5, 10..15, 20..25])
102
+ multi_range.overlaps?(MultiRange.new([6..8, 18..22]))
103
+ # => true
104
+ ```
105
+
106
+ ### Range-like interface
107
+
108
+ #### each
109
+ ```rb
110
+ MultiRange.new([1..3, 6, 8..9]).each{|s| print s }
111
+ # => 123689
112
+ ```
113
+
114
+ #### map
115
+ ```rb
116
+ MultiRange.new([1..3, 6, 8..9]).map{|s| s * 2 }
117
+ # => [2, 4, 6, 12, 16, 18]
118
+ ```
119
+
120
+ #### index_with
121
+ ```rb
122
+ MultiRange.new([1..3, 6, 8..9]).index_with(true)
123
+ # => { 1 => true, 2 => true, 3 => true, 6 => true, 8 => true, 9 => true }
124
+ ```
125
+
126
+ #### min
127
+ ```rb
128
+ MultiRange.new([1..3, 6, 8..9]).min
129
+ # => 1
130
+ ```
131
+
132
+ #### max
133
+ ```rb
134
+ MultiRange.new([1..3, 6, 8..9]).max
135
+ # => 9
136
+ ```
137
+
138
+ #### to_a
139
+ ```rb
140
+ MultiRange.new([1..3, 6, 8..9]).to_a
141
+ # => [1, 2, 3, 6, 8, 9]
142
+ ```
143
+
144
+
145
+ #### size
146
+ ```rb
147
+ MultiRange.new([1..3, 6, 8..9]).size
148
+ # => 6
149
+ ```
150
+
151
+ ### Warning
152
+
153
+ The return value may be different when there are some overlapped ranges.
154
+ Call `merge_overlaps` if you want to merge overlapped ranges.
155
+
156
+ ```rb
157
+ MultiRange.new([1..5, 3..6]).to_a
158
+ # => [1, 2, 3, 4, 5, 3, 4, 5, 6]
159
+
160
+ MultiRange.new([1..5, 3..6]).merge_overlaps.to_a
161
+ # => [1, 2, 3, 4, 5, 6]
162
+ ```
163
+
164
+ ```rb
165
+ MultiRange.new([1..5, 3..6]).each{|s| print s }
166
+ # => 123453456
167
+
168
+ MultiRange.new([1..5, 3..6]).merge_overlaps.each{|s| print s }
169
+ # => 123456
170
+ ```
171
+
172
+ ```rb
173
+ MultiRange.new([1..5, 3..6]).map{|s| s * 2 }
174
+ # => [2, 4, 6, 8, 10, 6, 8, 10, 12]
175
+
176
+ MultiRange.new([1..5, 3..6]).merge_overlaps.map{|s| s * 2 }
177
+ # => [2, 4, 6, 8, 10, 12]
178
+ ```
179
+
180
+ ```rb
181
+ MultiRange.new([1..5, 3..6]).size
182
+ # => 9
183
+
184
+ MultiRange.new([1..5, 3..6]).merge_overlaps.size
185
+ # => 6
186
+ ```
187
+
188
+ ## Development
189
+
190
+ 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.
191
+
192
+ 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).
193
+
194
+ ## Contributing
195
+
196
+ 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.
197
+
198
+
199
+ ## License
200
+
201
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
202
+