infinite_time 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed911579f92e11434eb1dc9571f440039f99acb9
+  data.tar.gz: d4ab5b1acba42309f0d0203cbb3361bda6983b06
+SHA512:
+  metadata.gz: e91c24535500d61408012dd8cd4e1347398b0652a9042d2ecf10f97a666534c2a50449a246caad0b1c095c7274396f9ae53d95ac425d55e29abf9db03aab0bbf
+  data.tar.gz: 287f71c2e8bfc8a95b7168ee77ab6ee103b1812f193841261f9373681d6b7bfedd17dd66e649cbe7ee207074d9d41405ac78f117246ddcd9c4c7ee4625dae65c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 J. Andrew Marshall <http://johnandrewmarshall.com/>
+
+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,38 @@
+# InfiniteTime
+
+[![Build Status](https://secure.travis-ci.org/amarshall/infinite_time.png?branch=master)](http://travis-ci.org/amarshall/infinite_time)
+
+Provides a representation of a (positively or negatively) infinite time. This allows easier comparison with times when, for instance, you have an end date for an object but it is not yet known. Using `nil` would cause TypeErrors everywhere and you must then guard against that, this avoids that issue.
+
+Many judgement calls were made in how to best reimplement methods that exist on Time but don’t really make sense on an infinite time. Comments and suggestions on how the behavior of any method on InfiniteTime could be improved is welcome. Open an issue or submit a pull request.
+
+## Installation
+
+Install as usual: `gem install infinite_time` or add `gem 'infinite_time'` to your Gemfile. Note that Ruby 2.0 is required.
+
+## Usage
+
+Simply create a new positive or negative infinite time:
+
+```ruby
+positive = InfiniteTime.new :+
+negative = InfiniteTime.new :-
+
+positive == InfiniteTime.new  #=> true
+```
+
+Feel free to read the specs for more details.
+
+## Contributing
+
+Contributions are welcome. Please be sure that your pull requests are atomic so they can be considered and accepted separately.
+
+1. Fork it
+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 new Pull Request
+
+## Credits & License
+
+Copyright © 2013 J. Andrew Marshall. License is available in the LICENSE file.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = '-w' unless ENV['TRAVIS']
+end
+
+task :default => :spec

data/infinite_time.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'infinite_time/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'infinite_time'
+  spec.version       = InfiniteTime::VERSION
+  spec.authors       = ['Andrew Marshall']
+  spec.email         = ['andrew@johnandrewmarshall.com']
+  spec.description   = %q{Provides a representation of a (positively or negatively) infinite time.}
+  spec.summary       = %q{Provides a representation of a (positively or negatively) infinite time.}
+  spec.homepage      = 'http://johnandrewmarshall.com/projects/infinite_time'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/infinite_time.rb

@@ -0,0 +1,114 @@
+require 'infinite_time/version'
+require 'infinite_time/core_ext'
+
+class InfiniteTime < Time
+  class << self
+    undef at
+    undef gm
+    undef local
+    undef mktime
+    undef now
+    undef utc
+  end
+
+  def initialize sign = :+
+    sign = sign.to_sym
+    raise InvalidSign unless [:+, :-].include? sign
+    @sign = sign
+  end
+
+  def positive?
+    @sign == :+
+  end
+
+  def negative?
+    !positive?
+  end
+
+  def <=> other
+    case other
+    when InfiniteTime
+      if positive? && other.negative?
+        1
+      elsif negative? && other.positive?
+        -1
+      else
+        0
+      end
+    when Time then (positive?) ? 1 : -1
+    else raise ArgumentError, "comparison of InfiniteTime with #{other.inspect} failed"
+    end
+  end
+
+  def + _; self; end
+  def - _; self; end
+
+  def hash
+    self.class.hash ^ @sign.hash
+  end
+
+  def to_i; raise TypeError, 'InfiniteTime has no Integer representation'; end
+  def to_r; raise TypeError, 'InfiniteTime has no Rational representation'; end
+
+  def to_s
+    "#{@sign}∞"
+  end
+  alias_method :asctime, :to_s
+  alias_method :ctime, :to_s
+  alias_method :inspect, :to_s
+
+  def strftime _; to_s; end
+
+  private
+
+  def signed_float
+    (positive?) ? Float::INFINITY : -Float::INFINITY
+  end
+
+  class InvalidSign < StandardError; end
+
+  module TimeCompatability
+    def self.define_method name, arity = 0, &block
+      super name do |*args|
+        unless arity === args.length
+          raise ArgumentError, "wrong number of arguments (#{args.length} for #{arity})"
+        end
+        instance_exec(*args, &block)
+      end
+    end
+
+    def self.nil_method name, arity = 0
+      define_method(name, arity) { nil }
+    end
+    def self.nil_methods names
+      names.each { |name| nil_method name }
+    end
+
+    def self.signed_method name, arity = 0
+      define_method(name, arity) { signed_float }
+    end
+    def self.signed_methods names
+      names.each { |name| signed_method name }
+    end
+
+    def self.self_method name, arity = 0
+      define_method(name, arity) { self }
+    end
+    def self.self_methods names
+      names.each { |name| self_method name }
+    end
+
+    signed_methods %i[year month day yday wday hour minute second subsec nsec usec]
+    nil_methods %i[monday? tuesday? wednesday? thursday? friday? saturday? sunday?]
+    nil_methods %i[dst? isdst gmt? gmt_offset gmtoff utc? utc_offset zone]
+    self_method :round, 0..1
+    self_method :succ
+    alias_method :mday, :day
+    alias_method :mon, :month
+    alias_method :sec, :second
+    alias_method :tv_nsec, :nsec
+    alias_method :tv_usec, :usec
+  end
+  private_constant :TimeCompatability
+  include TimeCompatability
+end

data/lib/infinite_time/core_ext.rb

@@ -0,0 +1,6 @@
+require 'infinite_time/time_extension'
+
+class Time
+  Infinity = InfiniteTime
+  prepend InfiniteTime::TimeExtension
+end

data/lib/infinite_time/time_extension.rb

@@ -0,0 +1,15 @@
+class InfiniteTime
+  module TimeExtension
+    def infinite?
+      is_a? InfiniteTime
+    end
+
+    def <=> other
+      if other.infinite?
+        (other.positive?) ? -1 : 1
+      else
+        super
+      end
+    end
+  end
+end

data/lib/infinite_time/version.rb

@@ -0,0 +1,3 @@
+class InfiniteTime < Time
+  VERSION = '0.0.1'
+end

data/spec/infinite_time/core_ext_spec.rb

@@ -0,0 +1,17 @@
+describe Time do
+  describe "#infinite?" do
+    it "is true when an infinite time" do
+      InfiniteTime.new.infinite?.should == true
+    end
+
+    it "is false when not an infinite time" do
+      Time.new.infinite?.should == false
+    end
+  end
+
+  describe "comparison" do
+    it "still works against other times" do
+      (Time.now < Time.now).should be_true
+    end
+  end
+end

data/spec/infinite_time_spec.rb

@@ -0,0 +1,224 @@
+require './lib/infinite_time'
+
+describe InfiniteTime do
+  it "behaves like a Time" do
+    InfiniteTime.new.is_a?(Time).should == true
+  end
+
+  it "is positively infinite by default" do
+    itime = InfiniteTime.new
+    itime.positive?.should == true
+    itime.negative?.should == false
+  end
+
+  it "raises InvalidSign when given anything other than :+ or :-" do
+    expect { InfiniteTime.new }.to_not raise_error InfiniteTime::InvalidSign
+    expect { InfiniteTime.new :+ }.to_not raise_error InfiniteTime::InvalidSign
+    expect { InfiniteTime.new :- }.to_not raise_error InfiniteTime::InvalidSign
+    expect { InfiniteTime.new :~ }.to raise_error InfiniteTime::InvalidSign
+  end
+
+  it "returns an unchanged self when math is performed on it" do
+    itime = InfiniteTime.new
+    (itime + 1).should eql itime
+    (itime + 1).should equal itime
+    (itime - 1).should eql itime
+    (itime - 1).should equal itime
+    itime.round.should eql itime
+    itime.round.should equal itime
+    itime.round(0).should eql itime
+    itime.round(0).should equal itime
+    itime.succ.should eql itime
+    itime.succ.should equal itime
+  end
+
+  it "returns an unchanged self when timezone conversion is performed on it" do
+    itime = InfiniteTime.new
+    itime.getgm.should eql itime
+    itime.getutc.should eql itime
+    itime.getlocal.should eql itime
+    itime.getlocal('+01:00').should eql itime
+    itime.localtime.should eql itime
+    itime.localtime('+01:00').should eql itime
+
+    itime.gmtime.should eql itime
+    itime.utc.should eql itime
+  end
+
+  it "cannot be compared against anything but Time objects" do
+    expect { InfiniteTime.new <=> Object.new }.to raise_error ArgumentError
+    expect { InfiniteTime.new <=> Date.new }.to raise_error ArgumentError
+    expect { InfiniteTime.new <=> 321 }.to raise_error ArgumentError
+  end
+
+  describe "time compatibility" do
+    it "returns nil for all day of the week predicate methods" do
+      positive = InfiniteTime.new :+
+      negative = InfiniteTime.new :-
+
+      [positive, negative].each do |itime|
+        itime.monday?.should == nil
+        itime.tuesday?.should == nil
+        itime.wednesday?.should == nil
+        itime.thursday?.should == nil
+        itime.friday?.should == nil
+        itime.saturday?.should == nil
+        itime.sunday?.should == nil
+      end
+    end
+
+    it "returns nil for all time zone inquiry methods" do
+      positive = InfiniteTime.new :+
+      negative = InfiniteTime.new :-
+
+      [positive, negative].each do |itime|
+        itime.dst?.should == nil
+        itime.isdst.should == nil
+
+        itime.gmt?.should == nil
+        itime.utc?.should == nil
+        itime.zone.should == nil
+
+        itime.gmt_offset.should == nil
+        itime.gmtoff.should == nil
+        itime.utc_offset.should == nil
+      end
+    end
+
+    it "returns the appropriate infinity for time/date inquiry methods" do
+      positive = InfiniteTime.new :+
+      negative = InfiniteTime.new :-
+
+      positive.year.should    == +Float::INFINITY
+      positive.month.should   == +Float::INFINITY
+      positive.mon.should     == +Float::INFINITY
+      positive.day.should     == +Float::INFINITY
+      positive.yday.should    == +Float::INFINITY
+      positive.mday.should    == +Float::INFINITY
+      positive.wday.should    == +Float::INFINITY
+      positive.hour.should    == +Float::INFINITY
+      positive.minute.should  == +Float::INFINITY
+      positive.second.should  == +Float::INFINITY
+      positive.sec.should     == +Float::INFINITY
+      positive.subsec.should  == +Float::INFINITY
+      positive.nsec.should    == +Float::INFINITY
+      positive.usec.should    == +Float::INFINITY
+      positive.tv_nsec.should == +Float::INFINITY
+      positive.tv_usec.should == +Float::INFINITY
+
+      negative.year.should    == -Float::INFINITY
+      negative.month.should   == -Float::INFINITY
+      negative.mon.should     == -Float::INFINITY
+      negative.day.should     == -Float::INFINITY
+      negative.yday.should     == -Float::INFINITY
+      negative.mday.should    == -Float::INFINITY
+      negative.wday.should    == -Float::INFINITY
+      negative.hour.should    == -Float::INFINITY
+      negative.minute.should  == -Float::INFINITY
+      negative.second.should  == -Float::INFINITY
+      negative.sec.should     == -Float::INFINITY
+      negative.subsec.should  == -Float::INFINITY
+      negative.nsec.should    == -Float::INFINITY
+      negative.usec.should    == -Float::INFINITY
+      negative.tv_nsec.should == -Float::INFINITY
+      negative.tv_usec.should == -Float::INFINITY
+    end
+
+    it "returns a TypeError for impossible numeric conversions" do
+      itime = InfiniteTime.new
+
+      expect { itime.to_i }.to raise_error TypeError
+      expect { itime.to_r }.to raise_error TypeError
+    end
+
+    it "has sensible string representations" do
+      positive = InfiniteTime.new :+
+      negative = InfiniteTime.new :-
+
+      plus_∞ = '+∞'
+      minus_∞ = '-∞'
+
+      positive.asctime.should      == plus_∞
+      positive.ctime.should        == plus_∞
+      positive.inspect.should      == plus_∞
+      positive.strftime('').should == plus_∞
+      positive.to_s.should         == plus_∞
+
+      negative.asctime.should      == minus_∞
+      negative.ctime.should        == minus_∞
+      negative.inspect.should      == minus_∞
+      negative.strftime('').should == minus_∞
+      negative.to_s.should         == minus_∞
+    end
+
+    (Time.methods - Time.superclass.methods).each do |method|
+      it "undefines the class method '#{method}' since it makes no sense" do
+        expect { InfiniteTime.public_send method }.to raise_error NoMethodError
+      end
+    end
+  end
+
+  describe "a positively infinite time" do
+    it "is created by passing :+ to #new" do
+      itime = InfiniteTime.new :+
+      itime.positive?.should == true
+      itime.negative?.should == false
+    end
+
+    it "is greater than all non-infinite times" do
+      itime = InfiniteTime.new :+
+      time = Time.now + 10000
+
+      (itime > time).should == true
+      (itime <= time).should == false
+      (time < itime).should == true
+      (time >= itime).should == false
+    end
+
+    it "is equal to another positively infinite time" do
+      a, b = InfiniteTime.new(:+), InfiniteTime.new(:+)
+      (a == b).should == true
+      (a.eql? b).should == true
+      (a.equal? b).should == false
+    end
+
+    it "is greater than a negatively infinite time" do
+      positive = InfiniteTime.new :+
+      negative = InfiniteTime.new :-
+
+      (positive > negative).should == true
+    end
+  end
+
+  describe "a negatively infinite time" do
+    it "is created by passing :- to #new" do
+      itime = InfiniteTime.new :-
+      itime.positive?.should == false
+      itime.negative?.should == true
+    end
+
+    it "is less than all non-infinite times" do
+      itime = InfiniteTime.new :-
+      time = Time.now - 10000
+
+      (itime < time).should == true
+      (itime >= time).should == false
+      (time > itime).should == true
+      (time <= itime).should == false
+    end
+
+    it "is equal to another negatively infinite time" do
+      a, b = InfiniteTime.new(:-), InfiniteTime.new(:-)
+      (a == b).should == true
+      (a.eql? b).should == true
+      (a.equal? b).should == false
+    end
+
+    it "is less than a positively infinite time" do
+      positive = InfiniteTime.new :+
+      negative = InfiniteTime.new :-
+
+      (negative < positive).should == true
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: infinite_time
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Marshall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
+description: Provides a representation of a (positively or negatively) infinite time.
+email:
+- andrew@johnandrewmarshall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- infinite_time.gemspec
+- lib/infinite_time.rb
+- lib/infinite_time/core_ext.rb
+- lib/infinite_time/time_extension.rb
+- lib/infinite_time/version.rb
+- spec/infinite_time/core_ext_spec.rb
+- spec/infinite_time_spec.rb
+homepage: http://johnandrewmarshall.com/projects/infinite_time
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Provides a representation of a (positively or negatively) infinite time.
+test_files:
+- spec/infinite_time/core_ext_spec.rb
+- spec/infinite_time_spec.rb
+has_rdoc: