time_intervals 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69b4cc127773810eb273ecac77dcbd394c1b6824ebfadb89e29ed04be5225af2
+  data.tar.gz: 13c841569f5cd527baacd07b2d90479c9630064014e10af5d273506fe24c26f8
+SHA512:
+  metadata.gz: d2fe45965ef0568c4b7acec42fffd0a47b199ea4d0f21fecb31f7ec321d7b38a1d413a4c9146abd11321d802d2dea28241e8dc6265e280e0f334c8adf925479d
+  data.tar.gz: 4fd36047bfecce978595fe9c8f369cdd8d9daa3429c8e2d21c07ccb95c2d1c6e7cf2864124eb25a413102d25cd7c835ca1bb5a2ae168ea282c08ba5517bcad18

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alistairm@nulogy.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in time_intervals.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alistair McKinnell
+
+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,33 @@
+# TimeIntervals
+
+Library for doing operations on collections of time intervals.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'time_intervals'
+```
+
+And then execute:
+
+    $ bundle
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/nulogy/time_intervals. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TimeIntervals project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nulogy/time_intervals/blob/master/CODE_OF_CONDUCT.md).

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "time_intervals"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/time_intervals.rb

@@ -0,0 +1,6 @@
+require "time_intervals/version"
+require "time_intervals/interval"
+require "time_intervals/collection"
+
+module TimeIntervals
+end

data/lib/time_intervals/collection.rb

@@ -0,0 +1,192 @@
+require "forwardable"
+
+#
+# Represents an ordered collection of TimeIntervals::Intervals.
+#
+module TimeIntervals
+  class Collection
+    include Enumerable
+    extend Forwardable
+
+    ONE_HOUR_IN_SECONDS = 60 * 60
+
+    def_delegators :time_intervals, :[], :each, :empty?, :hash, :length, :size, :to_ary
+
+    attr_reader :time_intervals
+
+    def self.wrap(intervals)
+      time_intervals = intervals.map { |interval| Interval.new(interval.started_at, interval.ended_at) }
+      new(time_intervals)
+    end
+
+    def initialize(time_intervals = [])
+      @time_intervals = Array(time_intervals).sort
+    end
+
+    # Returns true if all of the contained TimeIntervals::Intervals are wholly contained
+    # within the bounding interval.
+    def all_intervals_within?(bounding_interval)
+      length_in_seconds == intersect(bounding_interval).length_in_seconds
+    end
+
+    # Returns true if any of the contained TimeIntervals::Intervals overlap.
+    def has_overlapping_intervals?
+      length_in_seconds != coalesce.length_in_seconds
+    end
+
+    # Returns a new coalesced collection of TimeIntervals::Intervals where any that
+    # overlap or are adjacent are combined into a single TimeIntervals::Interval.
+    #
+    # Given these TimeIntervals::Intervals in the collection:
+    #
+    # [--------)
+    #       [------)
+    #              [-----)   [-------)
+    #                             [-------)
+    #
+    # Calling #coalesce returns a TimeIntervals::Collection containing
+    # these TimeIntervals::Intervals:
+    #
+    # [------------------)   [------------)
+    #
+    def coalesce
+      return self if empty?
+
+      coalescing = Interval.create(first)
+
+      result = each_with_object([]) do |current, memo|
+        if coalescing.ended_at < current.started_at
+          memo << coalescing
+          coalescing = Interval.create(current)
+        else
+          coalescing = Interval.new(
+            coalescing.started_at,
+            [coalescing.ended_at, current.ended_at].max
+          )
+        end
+      end
+
+      result << Interval.create(coalescing)
+
+      Collection.new(result)
+    end
+
+    # Returns a new collection of TimeIntervals::Intervals that contains only
+    # intersections with the specified intersections: either a nil,
+    # a single TimeIntervals::Interval, or a TimeIntervals::Collection.
+    #
+    # Note: the intersections are assumed to be disjoint. That is,
+    # none of the TimeIntervals::Intervals in intersections overlap.
+    #
+    # Given these TimeIntervals::Intervals in the collection:
+    #
+    # [--------)
+    #       [------)
+    #              [-----)   [-------)
+    #                             [-------)
+    #
+    # Calling #intersect with these TimeIntervals::Intervals
+    #
+    #           [--------------) [------)
+    #
+    # returns a TimeIntervals::Collection containing these TimeIntervals::Intervals:
+    #
+    #           [--)
+    #              [-----)   [-) [---)
+    #                             [-----)
+    #
+    def intersect(intersections)
+      result = Array(intersections).each_with_object([]) do |intersection, memo|
+        memo.concat(intersect_with_time_interval(intersection))
+      end
+
+      Collection.new(result)
+    end
+
+    def partition_count
+      partition_intervals = partition
+
+      intersect_count(partition_intervals)
+    end
+
+    # Returns a new collection of TimeIntervals::Intervals that are partitions of
+    # the original collection.
+    #
+    # Given the upper TimeIntervals::Intervals, #partition returns the lower TimeIntervals::Intervals:
+    #
+    # [--------)   [-----)   [---)
+    # |     [------)     |   |   |
+    # |     |  | [----)  |   |   |
+    # |     |  | | |  |  |   |   |
+    # |     |  | | |  |  |   |   |
+    # [-----)  [-) [--)  [---)   |
+    #       [--) [-)  [--)   [---)
+    #
+    def partition
+      time_points = @time_intervals.flat_map { |i| [i.started_at, i.ended_at] }.uniq.sort
+      start_time_points = time_points[0..-2]
+      end_time_points = time_points[1..-1]
+      raw_intervals = start_time_points.zip(end_time_points)
+      Collection.new(raw_intervals.map { |r| Interval.new(*r) })
+    end
+
+    # Counts the number of TimeIntervals::Intervals that intersect with the given
+    # collection of TimeIntervals::Intervals.
+    #
+    # Returns a list of [TimeIntervals::Interval, count] tuples. The TimeIntervals::Intervals in the result are
+    # the TimeIntervals::Intervals from the argument.
+    def intersect_count(intersections)
+      counts = intersections.map { |slice| intersect_with_time_interval(slice).length }
+      intersections.zip(counts)
+    end
+
+    # The sum of the lengths of the TimeIntervals::Intervals in the collection as hours.
+    #
+    def length_in_hours
+      length_in_seconds.to_f / ONE_HOUR_IN_SECONDS
+    end
+
+    # The sum of the lengths of the TimeIntervals::Intervals in the collection as seconds.
+    #
+    def length_in_seconds
+      time_intervals.reduce(0) { |total, time_intervals| total + time_intervals.length_in_seconds }
+    end
+
+    def ==(other)
+      other.class == self.class && other.time_intervals == time_intervals
+    end
+    alias_method :eql?, :==
+
+    private
+
+    # Returns an array of TimeIntervals::Intervals that contains only intersections
+    # with the specified intersecting TimeIntervals::Interval.
+    #
+    # Given these TimeIntervals::Intervals in the collection:
+    #
+    # [--------)
+    #       [------)
+    #              [-----)   [-------)
+    #                             [-------)
+    #
+    # Calling #intersect_with_time_interval with this TimeIntervals::Interval
+    #
+    #           [---------------)
+    #
+    # returns this array of TimeIntervals::Intervals:
+    #
+    #           [--)
+    #              [-----)   [--)
+    #
+    def intersect_with_time_interval(intersecting)
+      each_with_object([]) do |current, memo|
+        next unless intersecting.overlaps?(current)
+
+        memo << Interval.new(
+          [intersecting.started_at, current.started_at].max,
+          [intersecting.ended_at, current.ended_at].min
+        )
+      end
+    end
+  end
+end

data/lib/time_intervals/interval.rb

@@ -0,0 +1,97 @@
+#
+# Represents an interval in time.
+#
+# Each TimeIntervals is interpreted as: [started_at, ended_at). That is, include
+# the started_at time and exclude the ended_at time.
+#
+# Note: both started_at and ended_at are values in seconds without the fractional
+# part that represents microseconds.
+#
+
+module TimeIntervals
+  class Interval
+    include Comparable
+
+    attr_reader :started_at, :ended_at
+    alias_method :start_at, :started_at
+    alias_method :end_at, :ended_at
+
+    def self.create(interval)
+      new(interval.started_at, interval.ended_at)
+    end
+
+    def initialize(started_at, ended_at)
+      raise "Invalid interval" if started_at.nil? || ended_at.nil?
+
+      @started_at = as_seconds(started_at)
+      @ended_at = as_seconds(ended_at)
+
+      raise "Invalid interval: #{self}" if @ended_at < @started_at
+    end
+
+    def length_in_seconds
+      ended_at - started_at
+    end
+
+    def after?(other)
+      other.ended_at <= started_at
+    end
+
+    def before?(other)
+      ended_at <= other.started_at
+    end
+
+    def disjoint?(other)
+      before?(other) || after?(other)
+    end
+
+    def overlaps?(other)
+      !disjoint?(other)
+    end
+
+    def overlap_duration_in_seconds(other)
+      return 0 if disjoint?(other)
+      [other.ended_at, ended_at].min - [other.started_at, started_at].max
+    end
+
+    def include?(time)
+      started_at <= time && time < ended_at
+    end
+
+    def to_s
+      "[#{format(started_at)}, #{format(ended_at)}]"
+    end
+
+    def <=>(other)
+      comparison = started_at <=> other.started_at
+      comparison.zero? ? (other.ended_at <=> ended_at) : comparison
+    end
+
+    def ==(other)
+      other.class == self.class && other.state == state
+    end
+    alias_method :eql?, :==
+
+    def hash
+      state.hash
+    end
+
+    protected
+
+    def state
+      [started_at, ended_at]
+    end
+
+    private
+
+    # Round any fractional seconds.
+    #
+    def as_seconds(time_value)
+      time_value.round
+    end
+
+    def format(time_value)
+      time_value.strftime("%Y-%m-%d %H:%M:%S")
+    end
+  end
+end

data/lib/time_intervals/version.rb

@@ -0,0 +1,3 @@
+module TimeIntervals
+  VERSION = "0.1.0"
+end

data/time_intervals.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "time_intervals/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "time_intervals"
+  spec.version       = TimeIntervals::VERSION
+  spec.authors       = ["Alistair McKinnell"]
+  spec.email         = ["alistairm@nulogy.com"]
+
+  spec.summary       = "Library for doing operations on collections of time intervals."
+  spec.homepage      = "https://github.com/nulogy/time_intervals"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(/^spec\//) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: time_intervals
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alistair McKinnell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: 
+email:
+- alistairm@nulogy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/time_intervals.rb
+- lib/time_intervals/collection.rb
+- lib/time_intervals/interval.rb
+- lib/time_intervals/version.rb
+- time_intervals.gemspec
+homepage: https://github.com/nulogy/time_intervals
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Library for doing operations on collections of time intervals.
+test_files: []