range_operations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 151469217bcab499d774198202933bfbb3f3ac2c
+  data.tar.gz: 5828f8c69737037af2f0b64eb5db233f90192042
+SHA512:
+  metadata.gz: 4bc6e584bf60cae31a73fb10ff1526eefdb188ee0cb527cf964f3cc331f053f3bfb5e5a07bcec809dce3e3733edac7ee0ccb78f9339bdddd58f0a415cd0fccc3
+  data.tar.gz: 7a64d0dbe0066b9f8c14ea57f8edf5d27056033dc207ee7e97d4dcc0bc29ecc3bd6a60134b57726488aabb510fddfa4e99cb09f54fdaa44703d414dcfa989d3a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +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 joe.g.yates@gmail.com. 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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in range_operations.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joe Yates
+
+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,60 @@
+# RangeOperations
+
+Perform operations on arrays of ranges.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'range_operations'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install range_operations
+```
+
+# Usage
+
+This library offers 3 modules: Single, Pair and Array.
+
+See [the documentation for details][range_operations_documentation].
+
+[range_operations_documentation] https://??
+
+# Notes
+
+Currently, this library only handles `..` Ranges, i.e. Ranges that include
+their endpoint.
+
+# Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+
+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/cantierecreativo/range_operations. 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/range_operations.rb

@@ -0,0 +1,3 @@
+require "range_operations/single"
+require "range_operations/pair"
+require "range_operations/array"

data/lib/range_operations/array.rb

@@ -0,0 +1,54 @@
+module RangeOperations; end
+
+module RangeOperations::Array
+  # Returns a new array with the ranges sorted by their .begin value
+  def self.sort(ranges)
+    ranges.sort_by(&:begin)
+  end
+
+  # Returns a sorted array with overlapping and contiguous items merged
+  def self.simplify(ranges)
+    straight = ranges.map { |r| RangeOperations::Single.straighten(r) }
+    sorted = straight.sort_by(&:begin)
+
+    [].tap do |acc|
+      sorted.each do |r|
+        if acc.empty?
+          acc << r
+        else
+          if acc[-1].end < r.begin
+            acc << r
+          else
+            acc << RangeOperations::Pair.merge(acc.pop, r)
+          end
+        end
+      end
+    end
+  end
+
+  # Returns an array of ranges resulting from removing from `range`
+  # any parts overlapped by any of `subranges`.
+  def self.subtract(range, subranges)
+    simple = simplify(subranges)
+
+    [].tap do |acc|
+      start = range.begin
+
+      simple.each do |sr|
+        next if sr.end < start
+
+        if sr.begin > start
+          finish = [sr.begin, range.end].min
+          acc << (start .. finish)
+        end
+
+        start = sr.end
+        break if start > range.end
+      end
+
+      if start < range.end
+        acc << (start .. range.end)
+      end
+    end
+  end
+end

data/lib/range_operations/pair.rb

@@ -0,0 +1,23 @@
+module RangeOperations; end
+
+module RangeOperations::Pair
+  # True if sections of the two ranges overlap
+  def self.overlap?(a, b)
+    a && b && (a.cover?(b.begin) || b.cover?(a.begin))
+  end
+
+  # True if the extremeties of the two ranges touch
+  def self.contiguous?(a, b)
+    a && b && (a.end == b.begin || b.end == a.begin)
+  end
+
+  # True if the ranges do not overlap and do not touch
+  def self.disjoint?(a, b)
+    a && b && !a.cover?(b) && !b.cover?(a)
+  end
+
+  # Make a Range form a's begin and b's end
+  def self.merge(a, b)
+    a.begin .. b.end
+  end
+end

data/lib/range_operations/single.rb

@@ -0,0 +1,13 @@
+module RangeOperations; end
+
+module RangeOperations::Single
+  # True if begin is greater than end
+  def self.backwards?(r)
+    r && r.begin > r.end
+  end
+
+  # Inverts backwards Ranges, leaves others unchanged
+  def self.straighten(r)
+    r.begin <= r.end ? r : r.end .. r.begin
+  end
+end

data/lib/range_operations/version.rb

@@ -0,0 +1,9 @@
+module RangeOperations
+  module Version #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join(".")
+  end
+end

data/range_operations.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "range_operations/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "range_operations"
+  spec.version       = RangeOperations::Version::STRING
+  spec.authors       = ["Joe Yates"]
+  spec.email         = ["joe.g.yates@gmail.com"]
+
+  spec.summary       = %q{Perform operations on arrays of ranges.}
+  spec.homepage      = "https://github.com/cantierecreativo/range_operations"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: range_operations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Yates
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+description: 
+email:
+- joe.g.yates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- lib/range_operations.rb
+- lib/range_operations/array.rb
+- lib/range_operations/pair.rb
+- lib/range_operations/single.rb
+- lib/range_operations/version.rb
+- range_operations.gemspec
+homepage: https://github.com/cantierecreativo/range_operations
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Perform operations on arrays of ranges.
+test_files: []