time-interval 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc282ee85bc8d071ecadb4f82421d905378b1232
+  data.tar.gz: 3772192417d37d39090ca4ecff853f8656a67596
+SHA512:
+  metadata.gz: 67679c5a9f001e9935f823fd96b831e1e67e5491d00ac357eb0a846092f8058814020e12fbb3680bb1364be80cd9044298d85931146589324be4efee8135b2cc
+  data.tar.gz: 1dc99d30fd7a1dd70faf76af7ece40524f46e59765d07eab40ff7390813ad60343044c6d34618a32ab0f6309419fa907742673af4f66f42949fcf3edcbdd05a1

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sebastian Edwards
+
+MIT License
+
+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,31 @@
+# TimeInterval
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'time_interval'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install time_interval
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/time_interval/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/time-interval.rb

@@ -0,0 +1 @@
+require_relative 'time_interval'

data/lib/time_interval/duration.rb

@@ -0,0 +1,78 @@
+module TimeInterval
+  class Duration
+    def self.parse(duration_str)
+      y = duration_str['Y'] ? duration_str.match(/(\d+)Y/)[1].to_i : 0
+      m = duration_str['M'] ? duration_str.match(/(\d+)M/)[1].to_i : 0
+      w = duration_str['W'] ? duration_str.match(/(\d+)W/)[1].to_i : 0
+      d = duration_str['D'] ? duration_str.match(/(\d+)D/)[1].to_i : 0
+      if duration_str['T']
+        h = duration_str['H'] ? duration_str.match(/T.*(\d+)H/)[1].to_i : 0
+        mi = duration_str['M'] ? duration_str.match(/T.*(\d+)M/)[1].to_i : 0
+        s = duration_str['S'] ? duration_str.match(/T.*(\d+)S/)[1].to_i : 0
+      else
+        h = mi = s = 0
+      end
+
+      new(years: y, months: m, weeks: w, days: d, hours: h, minutes: mi,
+      seconds: s)
+    end
+
+    attr_reader :years, :months, :weeks, :days, :hours, :minutes, :seconds
+
+    def initialize(years: 0, months: 0, weeks: 0, days: 0, hours: 0, minutes: 0,
+      seconds: 0)
+      @years = years
+      @months = months
+      @weeks = weeks
+      @days = days
+      @hours = hours
+      @minutes = minutes
+      @seconds = seconds
+    end
+
+    def add_to(time)
+      time + total_seconds
+    end
+
+    def iso8601
+      string = 'P' + iso8601_date
+      string += iso8601_time unless iso8601_time == 'T'
+
+      string
+    end
+
+    def subtract_from(time)
+      time - total_seconds
+    end
+
+    def present?
+      total_seconds > 0
+    end
+
+    def total_seconds
+      years.years + months.months + weeks.weeks + days.days + hours.hours +
+        minutes.minutes + seconds.seconds
+    end
+
+    private
+
+    def iso8601_date
+      string = ''
+      string += "#{years}Y" if years > 0
+      string += "#{months}M" if months > 0
+      string += "#{weeks}W" if weeks > 0
+      string += "#{days}D" if days > 0
+
+      string
+    end
+
+    def iso8601_time
+      string = 'T'
+      string += "#{hours}H" if hours > 0
+      string += "#{minutes}M" if minutes > 0
+      string += "#{seconds}S" if seconds > 0
+
+      string
+    end
+  end
+end

data/lib/time_interval/repeating_interval.rb

@@ -0,0 +1,48 @@
+module TimeInterval
+  class RepeatingInterval
+    def self.parse(iso8601)
+      recurrence, time_with_duration_string = iso8601.split('/', 2)
+
+      times = if recurrence.match(/^R(\d+)/)
+                Regexp.last_match[1].to_i
+              else
+                Float::INFINITY
+              end
+
+      fail ArgumentError if times == 0
+
+      new TimeWithDuration.parse(time_with_duration_string), times
+    end
+
+    include Enumerable
+
+    attr_reader :length
+
+    def initialize(time_with_duration, times)
+      @time_with_duration = time_with_duration
+      @length = times
+
+      @enumerator = Enumerator::Lazy.new(0...times) do |yielder, i|
+        if i == 0
+          yielder.yield time_with_duration
+        else
+          interval = time_with_duration
+          i.times { interval = interval.step }
+          yielder.yield interval
+        end
+      end
+    end
+
+    def each(&block)
+      @enumerator.each(&block)
+    end
+
+    def iso8601
+      if length == Float::INFINITY
+        "R/#{@time_with_duration.iso8601}"
+      else
+        "R#{length}/#{@time_with_duration.iso8601}"
+      end
+    end
+  end
+end

data/lib/time_interval/time_pair.rb

@@ -0,0 +1,25 @@
+module TimeInterval
+  class TimePair
+    def self.parse(iso8601)
+      halves = iso8601.split('/')
+
+      fail ArgumentError unless halves.length == 2
+
+      start_time, end_time = halves.map { |time| Time.parse time }
+
+      new start_time, end_time
+    end
+
+    attr_reader :start_time
+    attr_reader :end_time
+
+    def initialize(start_time, end_time)
+      @start_time = start_time
+      @end_time = end_time
+    end
+
+    def iso8601
+      "#{start_time.iso8601}/#{end_time.iso8601}"
+    end
+  end
+end

data/lib/time_interval/time_with_duration.rb

@@ -0,0 +1,60 @@
+module TimeInterval
+  class TimeWithDuration
+    UNITS = %w(years months weeks days hours minutes seconds).freeze
+
+    def self.parse(iso8601)
+      halves = iso8601.split('/')
+
+      fail ArgumentError unless halves.length == 2
+
+      if halves[0]['P']
+        forwards = false
+        duration = Duration.parse(halves[0])
+        time = halves[1]
+      elsif halves[1]['P']
+        forwards = true
+        duration = Duration.parse(halves[1])
+        time = halves[0]
+      else
+        fail ArgumentError
+      end
+
+      new Time.parse(time), duration, forwards
+    end
+
+    attr_reader :start_time
+    attr_reader :duration
+
+    def initialize(time, duration, forwards = true)
+      @start_time = time
+      @duration = duration
+      @forwards = forwards
+    end
+
+    def end_time
+      if forwards?
+        duration.add_to start_time
+      else
+        duration.subtract_from start_time
+      end
+    end
+
+    def iso8601
+      if forwards?
+        "#{start_time.iso8601}/#{duration.iso8601}"
+      else
+        "#{duration.iso8601}/#{start_time.iso8601}"
+      end
+    end
+
+    def step
+      TimeWithDuration.new end_time, duration, forwards?
+    end
+
+    private
+
+    def forwards?
+      @forwards == true
+    end
+  end
+end

data/lib/time_interval/version.rb

@@ -0,0 +1,3 @@
+module TimeInterval
+  VERSION = '0.0.1'
+end

data/lib/time_interval.rb

@@ -0,0 +1,38 @@
+require 'time_interval/version'
+
+require 'active_support/all'
+
+require 'time_interval/duration'
+require 'time_interval/repeating_interval'
+require 'time_interval/time_pair'
+require 'time_interval/time_with_duration'
+
+module TimeInterval
+  module_function
+
+  def interval?(iso8601)
+    iso8601['/'] == '/'
+  end
+
+  def repeating?(iso8601)
+    !iso8601.match(/^R/).nil?
+  end
+
+  def duration?(iso8601)
+    iso8601['P'] == 'P'
+  end
+
+  def parse(iso8601)
+    if interval? iso8601
+      if repeating?(iso8601) && duration?(iso8601)
+        RepeatingInterval.parse iso8601
+      elsif duration? iso8601
+        TimeWithDuration.parse iso8601
+      else
+        TimePair.parse iso8601
+      end
+    else
+      Time.parse iso8601
+    end
+  end
+end

data/spec/lib/time_interval/repeating_interval_spec.rb

@@ -0,0 +1,46 @@
+RSpec.describe RepeatingInterval do
+  describe '.parse' do
+    let(:iso8601) { 'R2/2007-03-01T13:00:00Z/P1M' }
+
+    it 'should create a RepeatingInterval' do
+      result = RepeatingInterval.parse iso8601
+
+      expect(result).to be_a RepeatingInterval
+    end
+
+    context 'iso8601 has a set number of repetitions' do
+      it 'should have correct length' do
+        result = RepeatingInterval.parse iso8601
+
+        expect(result.length).to eq 2
+      end
+
+      it 'should enumerate over the repetitions' do
+        result = RepeatingInterval.parse iso8601
+
+        expect(result.first).to be_a TimeWithDuration
+      end
+
+      it 'should have correct repetitions' do
+        repeating = RepeatingInterval.parse(iso8601)
+        repetitions = repeating.take(3)
+
+        expect(repetitions[0].start_time).to eq '2007-03-01T13:00:00Z'
+        expect(repetitions[1].start_time).to eq '2007-04-01T13:00:00Z'
+        expect(repetitions[2]).to eq nil
+      end
+    end
+  end
+
+  describe '#iso8601' do
+    let(:time) { Time.parse('2007-03-01T13:00:00Z') }
+    let(:duration) { Duration.new(months: 2) }
+    let(:time_with_duration) { TimeWithDuration.new time, duration }
+
+    let(:repeating_interval) { RepeatingInterval.new time_with_duration, 4 }
+
+    it 'should return a valid iso8601 time with duration' do
+      expect(repeating_interval.iso8601).to eq 'R4/2007-03-01T13:00:00Z/P2M'
+    end
+  end
+end

data/spec/lib/time_interval/time_pair_spec.rb

@@ -0,0 +1,37 @@
+RSpec.describe TimePair do
+  describe '.parse' do
+    context 'iso8601 is a valid time pair' do
+      let(:iso8601) { '2007-03-01T13:00:00Z/2008-05-11T15:30:00Z' }
+
+      it 'should create a TimePair' do
+        result = TimePair.parse iso8601
+
+        expect(result).to be_a TimePair
+      end
+
+      it 'should have correct start_time' do
+        result = TimePair.parse iso8601
+
+        expect(result.start_time).to eq Time.parse('2007-03-01T13:00:00Z')
+      end
+
+      it 'should have correct end_time' do
+        result = TimePair.parse iso8601
+
+        expect(result.end_time).to eq Time.parse('2008-05-11T15:30:00Z')
+      end
+    end
+  end
+
+  describe '#iso8601' do
+    let(:first_time) { Time.parse('2007-03-01T13:00:00Z') }
+    let(:last_time) { Time.parse('2008-05-11T15:30:00Z') }
+    let(:time_pair) { TimePair.new first_time, last_time }
+
+    it 'should return a valid iso8601 time pair' do
+      expected = '2007-03-01T13:00:00Z/2008-05-11T15:30:00Z'
+
+      expect(time_pair.iso8601).to eq expected
+    end
+  end
+end

data/spec/lib/time_interval/time_with_duration_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe TimeWithDuration do
+  describe '.parse' do
+    context 'iso8601 is a valid time and duration' do
+      let(:iso8601) { '2007-03-01T13:00:00Z/P1M' }
+
+      it 'should create a TimeWithDuration' do
+        result = TimeWithDuration.parse iso8601
+
+        expect(result).to be_a TimeWithDuration
+      end
+
+      it 'should have correct start_time' do
+        result = TimeWithDuration.parse iso8601
+
+        expect(result.start_time).to eq Time.parse('2007-03-01T13:00:00Z')
+      end
+
+      it 'should have correct end_time' do
+        result = TimeWithDuration.parse iso8601
+
+        expect(result.end_time).to eq Time.parse('2007-04-01T13:00:00Z')
+      end
+    end
+  end
+
+  describe '#iso8601' do
+    let(:time) { Time.parse('2007-03-01T13:00:00Z') }
+    let(:duration) { Duration.new(months: 2) }
+    let(:time_with_duration) { TimeWithDuration.new time, duration }
+
+    it 'should return a valid iso8601 time with duration' do
+      expect(time_with_duration.iso8601).to eq '2007-03-01T13:00:00Z/P2M'
+    end
+  end
+end

data/spec/lib/time_interval_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe TimeInterval do
+  describe '.parse' do
+    context 'iso8601 is a valid time and duration' do
+      let(:iso8601) { '2007-03-01T13:00:00Z/P1M' }
+
+      it 'should return a TimeWithDuration' do
+        expect(TimeInterval.parse(iso8601)).to be_a TimeWithDuration
+      end
+    end
+
+    context 'iso8601 is a valid time pair' do
+      let(:iso8601) { '2007-03-01T13:00:00Z/2008-05-11T15:30:00Z' }
+
+      it 'should return a TimePair' do
+        expect(TimeInterval.parse(iso8601)).to be_a TimePair
+      end
+    end
+
+    context 'iso8601 is a valid repeating interval' do
+      let(:iso8601) { 'R/2007-03-01T13:00:00Z/P1M' }
+
+      it 'should return a RepeatingInterval' do
+        expect(TimeInterval.parse(iso8601)).to be_a RepeatingInterval
+      end
+    end
+
+    context 'iso8601 is not an interval' do
+      let(:iso8601) { '2007-03-01T13:00:00Z' }
+
+      it 'should return a RepeatingInterval' do
+        expect(TimeInterval.parse(iso8601)).to be_a Time
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end
+
+require 'time-interval'
+
+TimeInterval.constants.each do |const|
+  eval "#{const} = TimeInterval::#{const}"
+end

data/time_interval.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'time_interval/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'time-interval'
+  spec.version       = TimeInterval::VERSION
+  spec.authors       = ['Sebastian Edwards']
+  spec.email         = ['me@sebastianedwards.co.nz']
+  spec.summary       = 'Simple library to handle ISO8601 time intervals.'
+  spec.description   = ''
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+
+  spec.add_runtime_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: time-interval
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sebastian Edwards
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- me@sebastianedwards.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/time-interval.rb
+- lib/time_interval.rb
+- lib/time_interval/duration.rb
+- lib/time_interval/repeating_interval.rb
+- lib/time_interval/time_pair.rb
+- lib/time_interval/time_with_duration.rb
+- lib/time_interval/version.rb
+- spec/lib/time_interval/repeating_interval_spec.rb
+- spec/lib/time_interval/time_pair_spec.rb
+- spec/lib/time_interval/time_with_duration_spec.rb
+- spec/lib/time_interval_spec.rb
+- spec/spec_helper.rb
+- time_interval.gemspec
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple library to handle ISO8601 time intervals.
+test_files:
+- spec/lib/time_interval/repeating_interval_spec.rb
+- spec/lib/time_interval/time_pair_spec.rb
+- spec/lib/time_interval/time_with_duration_spec.rb
+- spec/lib/time_interval_spec.rb
+- spec/spec_helper.rb