ruby-time_range 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45e5f5852c51c527ddf7bb104cde7a94db2b30f6
+  data.tar.gz: b51a31525db80a2daf5bb256d9c5c7ae9ed4b9b4
+SHA512:
+  metadata.gz: 39f152da5800d47cc91c6db98ef3156a0447ac2e8a90878c672478420d649beb2d16b7606bbf6fc6c6027f641a87016a9e9e0971cc73231fdbde762556b51be1
+  data.tar.gz: ae499f4e9b52467e83466b3edae7fd173c4f720962858eb35f77dc8cc5895b093c2f4975cdc052a2a80548561d9586aabd8f7580361a4d335670b89e8d0e0e5b

data/.gitignore

@@ -0,0 +1,2 @@
+notes.txt
+.yardoc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/Lambda:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+ruby-timerange

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.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 john.hope@storyful.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,10 @@
+# frozen_string_literal: true
+
+gemspec
+
+source 'https://rubygems.org'
+
+group :development do
+  gem 'rspec'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    ruby-time_range (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.2.5)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (10.4.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unicode-display_width (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  rake (~> 10.0)
+  rspec
+  rubocop
+  ruby-time_range!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jon Hope
+
+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/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ruby/time_range'
+
+require 'irb'
+IRB.start

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_range.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require_relative 'time_range/core_ext/range.rb'
+require 'date'
+
+# An enhanced, Range-type class that provides useful methods that apply to
+# time-based objects.
+#
+# @since 0.0.1
+class TimeRange < Range
+  def initialize(b, e, exclude_end = false)
+    raise TypeError unless [b, e].all? { |arg| arg.is_a?(Time) }
+
+    valid_time = if exclude_end
+                   (e - 1) >= b
+                 else
+                   e >= b
+                 end
+
+    raise ArgumentError unless valid_time
+
+    super
+  end
+
+  # Reimplementation of Range#== to account for time ranges excluding end being
+  # one second shorter than their end implies.
+  #
+  # @param [TimeRange] time_range time range to compare for equality
+  # @return [Boolean] whether contents of two TimeRanges match
+  def ==(other)
+    return false unless other.is_a?(self.class)
+
+    if exclude_end? || other.exclude_end?
+      return self.begin == other.begin && max == other.max
+    end
+
+    super
+  end
+
+  alias eql? ==
+
+  # Reimplementation of Range#max. TimeRange makes one assumption; that ranges
+  # excluding end should be one second shorter than those that don't.
+  #
+  # Normal Ranges simply TypeError when excluding_end is true. However, since
+  # Ruby's Time methods assume seconds anyway, it is reasonable to use seconds
+  # here.
+  #
+  # Doing so enables the implementation of a number of useful TimeRange methods.
+  #
+  # @return [Time] the highest time included in the range
+  def max
+    return self.end - 1 if exclude_end?
+
+    super
+  end
+
+  # The duration of the time range in seconds.
+  #
+  # @return [Float] the number of seconds in the time range
+  def duration
+    max - self.begin
+  end
+
+  # Compares another time range for any kind of overlap; partial or complete.
+  #
+  # @param [TimeRange] time_range time range to compare for overlap
+  # @return [Boolean] whether contents of two TimeRanges overlap
+  def overlaps?(time_range)
+    raise TypeError unless time_range.is_a?(TimeRange)
+
+    %w(begins_within? ends_within? encapsulates?).any? do |condition|
+      send(condition, time_range)
+    end
+  end
+
+  # Compares another time range for complete encapsulation. A time range is
+  # considered encapsulated if it begins and ends within this one, including if
+  # the ranges match exactly.
+  #
+  # @param [TimeRange] time_range time range to compare for encapsulation
+  # @return [Boolean] whether the target range is encapsulated
+  def encapsulates?(time_range)
+    raise TypeError unless time_range.is_a?(TimeRange)
+
+    self.begin <= time_range.begin && max >= time_range.max
+  end
+
+  # Reverse of #encapsulates?, checks if the current time range is encapsulated
+  # by another.
+  #
+  # @param [TimeRange] time_range time range to compare against encapsulation
+  # @return [Boolean] whether the target range encapsulates this one
+  def encapsulated_by?(time_range)
+    raise TypeError unless time_range.is_a?(TimeRange)
+
+    time_range.encapsulates?(self)
+  end
+
+  # Returns the overlap between this and the argument as a new time range.
+  #
+  # @param [TimeRange] time_range time range to compare for encapsulation
+  # @return [TimeRange, nil] the overlap in a TimeRange or nil if none occurs
+  def overlap_with(time_range)
+    raise TypeError unless time_range.is_a?(TimeRange)
+
+    self.class.new(
+      [self.begin, time_range.begin].max,
+      [max, time_range.max].min
+    ) if overlaps?(time_range)
+  end
+
+  # Returns the dates in the current TimeRange as a Range of Dates.
+  #
+  # @return [Range] the dates in the current time range
+  def dates
+    b_date = Date.civil(self.begin.year, self.begin.month, self.begin.day)
+    e_date = Date.civil(max.year, max.month, max.day)
+
+    b_date..e_date
+  end
+
+  private
+
+  def begins_within?(time_range)
+    self.begin >= time_range.begin && self.begin <= time_range.max
+  end
+
+  def ends_within?(time_range)
+    max <= time_range.max && max >= time_range.begin
+  end
+end

data/lib/time_range/core_ext/range.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Reopens the Range class from the core lib to include methods to converting to
+# TimeRange.
+#
+# @since 0.0.1
+class Range
+  # Converts a Range of Times into a TimeRange.
+  #
+  # @return [TimeRange]
+  def to_time_range
+    TimeRange.new(self.begin, self.end, exclude_end?)
+  end
+end

data/lib/time_range/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class TimeRange < Range
+  VERSION = '0.1.0'
+end

data/readme.md

@@ -0,0 +1,59 @@
+## TimeRange
+
+Enhance your Ruby project with time-based ranges.
+
+## Installation
+
+Install the `time_range` gem and require it in your project.
+
+```shell
+gem install ruby-time_range
+```
+
+or include the gem in your Gemfile and `bundle install`.
+
+```ruby
+gem 'ruby-time_range'
+```
+
+## About
+
+`TimeRange` extends the regular `Range` with useful methods that apply to time-based objects. Where appropriate, it reimplements `Range` methods as they should apply to Time-based ranges.
+
+`TimeRange`s can be compared and examined in useful ways.
+
+- `TimeRange#duration` The duration of the TimeRange in seconds.
+- `TimeRange#encapsulates?` Check if one TimeRange encapsulates another entirely.
+- `TimeRange#encapsulated_by?` Check if one TimeRange is encapsulated by another entirely...
+- `TimeRange#overlaps?` Check if one TimeRange overlaps another in any way.
+- `TimeRange#overlap_with` Returns the overlap between two TimeRanges, as a new TimeRange.
+- `TimeRange#dates` Returns a range of dates in the TimeRange.
+
+Existing Range methods; such as `#max`, `#min`, `#cover?`, `#==`, etc, are still available, having been reimplemented where appropriate to maintain consistency in a temporal context.
+
+TimeRanges can be easily created by calling `#to_time_range` on any normal Range of Times.
+
+```ruby
+  (Time.now .. (Time.now + 60)).to_time_range
+```
+
+For full API documentation see the YARD docs.
+
+## Contributing
+- Fork and clone the project.
+- `git checkout master`.
+- `git checkout -b ` a topic branch for your fix/addition.
+- Run `bundle`.
+- Make and commit your changes.
+- Push to your fork and pull request against master.
+
+#### Note:
+- Contributions will not be accepted without tests.
+- Please read and check Github issues and pending pull requests before submitting new code.
+- If adding a feature please post a new issue for discussion first.
+
+Thanks for taking the time to contribute!
+
+## License
+
+ruby-time_range is Copyright ©2016 Jon Hope. It is free software, and may be redistributed under the terms specified in the [LICENSE](https://github.com/jonmidhir/ruby-time_range/blob/master/LICENSE) file.

data/ruby-time_range.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'time_range/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby-time_range'
+  spec.version       = TimeRange::VERSION
+  spec.authors       = ['Jon Hope']
+  spec.email         = ['me@jhope.ie']
+
+  spec.summary       = 'Enhance your Ruby project with time-based ranges.'
+  spec.description   = 'Enhance your Ruby project with time-based ranges.'
+  spec.homepage      = 'https://github.com/jonmidhir/ruby-time_range'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  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.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: ruby-time_range
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Hope
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-31 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'
+description: Enhance your Ruby project with time-based ranges.
+email:
+- me@jhope.ie
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- bin/console
+- bin/setup
+- lib/time_range.rb
+- lib/time_range/core_ext/range.rb
+- lib/time_range/version.rb
+- readme.md
+- ruby-time_range.gemspec
+homepage: https://github.com/jonmidhir/ruby-time_range
+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: Enhance your Ruby project with time-based ranges.
+test_files: []