day_time 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 234dac2965a6a05a5d77af3cee675150d82d6d7d
+  data.tar.gz: 37adfab09cc9bead706eb5be4c6cb30864d4c0bb
+SHA512:
+  metadata.gz: 638877ffbbdf94eb69378f67222ae6ff60f2db77f83456ce5fdec6f70e5fa1a896601b9995342286c4717dca8dc9c8dbd184b7ddb59986218799e64a26dd1780
+  data.tar.gz: 822d289367830714c8d5ab7e8b0e9475edb790b6d4fb1e6dbe66fc480248d8664b2364a2e04bc64273abea3528128975c6d4315a43690dc69fd941a810371849

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    day_time (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  day_time!
+  rspec (~> 3.1)
+
+BUNDLED WITH
+   1.10.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dominic Bauer
+
+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,45 @@
+# day_time
+24-hour time representation with no dates attached
+
+## Installation
+Install with Bundler by adding the following line to your `Gemfile`:
+
+```
+gem "day_time"
+```
+Or install via RubyGems:
+
+```
+% gem install day_time
+```
+
+## Usage
+```ruby
+require "day_time"
+
+morning    = DayTime.new("08:00")
+breakfast  = DayTime.new("08:45:00")
+noon       = DayTime.new(hours: 12, minutes: 15)
+dinner     = DayTime.new(hours: 12, minutes: 15, seconds: 30)
+bedtime    = DayTime.new(h: 22, m: 15, s: 30)
+end_of_day = DayTime("23:59:59")
+
+foo = DayTime.new(Time.new(...))
+bar = DayTime.new(DateTime.new(...))
+
+morning + DayTime.new("00:45") == breakfast
+morning + 45 * 60 == breakfast
+morning + "00:45" == breakfast
+
+dinner < bedtime
+end_of_day > bedtime
+
+(noon..bedtime).include?(dinner) # => true
+
+enum = end_of_day.to_enum
+enum.next == DayTime.new("00:00")
+enum.next == DayTime.new("00:00:01")
+
+opens, closes = DayTime("10:00"), DayTime("17:00")
+(opens..closes).step(60).map { |day_time| day_time.to_s }
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Build the RubyGem"
+task :build do
+  sh "gem build day_time.gemspec --verbose"
+end

data/day_time.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = "day_time"
+  s.version     = "0.0.1"
+
+  s.summary = <<-summary
+    Day time calculations
+  summary
+
+  s.authors     = ["Dominic Bauer"]
+  s.email       = "bauerdominic@gmail.com"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+
+  s.homepage    = "https://github.com/bauerd/day_time"
+  s.license     = "MIT"
+
+  s.add_development_dependency "rspec", "~> 3.1"
+end

data/lib/day_time.rb

@@ -0,0 +1,124 @@
+require "date"
+
+class DayTime
+  include Enumerable
+  include Comparable
+
+  SECONDS_PER_DAY = 86_399
+
+  HM_REGEXP  = /^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$/i
+  HMS_REGEXP = /^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$/i
+
+  attr_reader :seconds_since_midnight
+
+  def initialize(arg)
+    @seconds_since_midnight = case arg
+                              when self.class
+                                arg.seconds_since_midnight
+                              when Time
+                                seconds_from_time(arg)
+                              when DateTime
+                                seconds_from_time(arg.to_time)
+                              when Integer
+                                seconds_from_integer(arg)
+                              when String
+                                seconds_from_time_string(arg)
+                              when Hash
+                                seconds_from_hash(arg)
+                              else
+                                raise ArgumentError
+                              end
+  end
+
+  def hours
+    @seconds_since_midnight / (60 ** 2)
+  end
+
+  def minutes
+    (@seconds_since_midnight % 60 ** 2) / 60
+  end
+
+  def seconds
+    @seconds_since_midnight % 60
+  end
+
+  def <=>(other)
+    seconds_since_midnight <=> other.seconds_since_midnight
+  end
+
+  def succ
+    self + 1
+  end
+
+  def each
+    1.upto(Float::INFINITY) { |i| yield self + i }
+  end
+
+  def +(obj)
+    other = DayTime.new(obj)
+    DayTime.new(@seconds_since_midnight + other.seconds_since_midnight)
+  end
+
+  def -(obj)
+    other = DayTime.new(obj)
+    DayTime.new((@seconds_since_midnight - other.seconds_since_midnight).abs)
+  end
+
+  def to_s
+    [hours, minutes, seconds].map { |int| int.to_s.rjust(2, "0") }.join(":")
+  end
+
+  def to_i
+    @seconds_since_midnight
+  end
+
+  private
+
+  def seconds_from_integer(seconds_since_midnight)
+    if seconds_since_midnight > SECONDS_PER_DAY
+      (seconds_since_midnight % SECONDS_PER_DAY) - 1
+    else
+      seconds_since_midnight
+    end
+  end
+
+  def seconds_from_time_string(str)
+    h, m, s = if match = str.match(HMS_REGEXP)
+                match.captures.map(&:to_i)
+              elsif match = str.match(HM_REGEXP)
+                match.captures.map(&:to_i) << 0
+              else
+                raise ArgumentError
+              end
+
+    seconds_from_hash(h: h, m: m, s: s)
+  end
+
+  def seconds_from_hash(hash)
+    [[:hours, :h], [:minutes, :m]].each do |keys|
+      unless keys.any? { |key| hash.key?(key) }
+        raise ArgumentError(
+          "Either a `#{keys[0]}` or `#{keys[2]} key is required"
+        )
+      end
+    end
+
+    h = hash[:hours]   || hash[:h]
+    m = hash[:minutes] || hash[:m]
+    s = hash[:seconds] || hash[:s] || 0
+
+    seconds_from_integer(h * 60 ** 2 + m * 60 + s)
+  end
+
+  def seconds_from_time(time)
+    seconds_from_hash(
+      h: time.hour,
+      m: time.min,
+      s: time.sec
+    )
+  end
+end
+
+def DayTime(*argv)
+  DayTime.new(*argv)
+end

data/spec/day_time_spec.rb

@@ -0,0 +1,240 @@
+require "day_time"
+
+describe DayTime do
+  describe "Kernel#DayTime" do
+    it "proxies calls" do
+      expect(DayTime("08:00")).to eq DayTime.new("08:00")
+    end
+  end
+
+  describe "#initialize" do
+    context "with other DayTime" do
+      it "returns a new DayTime" do
+        day_time = DayTime.new("08:00")
+        expect(DayTime.new(day_time)).to eq day_time
+      end
+    end
+
+    context "with seconds since midnight" do
+      it "sets hours, minutes and seconds" do
+        day_time = DayTime.new(20_066) # 05:34:25
+
+        expect(day_time.hours).to eq 5
+        expect(day_time.minutes).to eq 34
+        expect(day_time.seconds).to eq 26
+
+        expect(day_time.seconds_since_midnight).to be 20_066
+      end
+
+      it "sets hours, minutes and seconds" do
+        day_time = DayTime.new(0) # 00:00:00
+
+        expect(day_time.hours).to eq 0
+        expect(day_time.minutes).to eq 0
+        expect(day_time.seconds).to eq 0
+
+        expect(day_time.seconds_since_midnight).to be 0
+      end
+
+      it "sets hours, minutes and seconds" do
+        day_time = DayTime.new(86_399) # 23:59:59
+
+        expect(day_time.hours).to eq 23
+        expect(day_time.minutes).to eq 59
+        expect(day_time.seconds).to eq 59
+
+        expect(day_time.seconds_since_midnight).to be 86_399
+      end
+
+      it "sets hours, minutes and seconds" do
+        day_time = DayTime.new(86_400) # 00:00:00
+
+        expect(day_time.hours).to eq 0
+        expect(day_time.minutes).to eq 0
+        expect(day_time.seconds).to eq 0
+
+        expect(day_time.seconds_since_midnight).to be 0
+      end
+
+      context "with overflowing seconds" do
+        it "starts over at midnight" do
+          day_time = DayTime.new(96_685) # 26:51:25 <-> 02:51:25
+
+          expect(day_time.hours).to eq 2
+          expect(day_time.minutes).to eq 51
+          expect(day_time.seconds).to eq 25
+
+          expect(day_time.seconds_since_midnight).to be 10_285
+        end
+      end
+    end
+
+    context "with hh:mm string" do
+      it "sets hours and minutes" do
+        day_time = DayTime.new("12:31")
+
+        expect(day_time.hours).to be 12
+        expect(day_time.minutes).to be 31
+        expect(day_time.seconds).to be 0
+      end
+    end
+
+    context "with hh:mm:ss string" do
+      it "sets hours, minutes and seconds" do
+        day_time = DayTime.new("12:31:22")
+
+        expect(day_time.hours).to be 12
+        expect(day_time.minutes).to be 31
+        expect(day_time.seconds).to be 22
+      end
+    end
+
+    context "with malformed string" do
+      it "raises an ArgumentError" do
+        expect {
+          DayTime.new("Y2:X1")
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "with hours-minutes-keyed Hash" do
+      it "sets hours and minutes" do
+        day_time = DayTime.new(hours: 13, minutes: 55)
+
+        expect(day_time.hours).to be 13
+        expect(day_time.minutes).to be 55
+        expect(day_time.seconds).to be 00
+      end
+    end
+
+    context "with hours-minutes-seconds-keyed Hash" do
+      it "sets hours, minutes and seconds" do
+        day_time = DayTime.new(hours: 13, minutes: 55, seconds: 45)
+
+        expect(day_time.hours).to be 13
+        expect(day_time.minutes).to be 55
+        expect(day_time.seconds).to be 45
+      end
+    end
+
+    context "with Time" do
+      it "sets hours, minutes and seconds" do
+        time = Time.new(2020, 10, 10, 18, 30, 45) # 18:30:45
+        day_time = DayTime.new(time)
+
+        expect(day_time.hours).to be 18
+        expect(day_time.minutes).to be 30
+        expect(day_time.seconds).to be 45
+      end
+    end
+
+    context "with DateTime" do
+      it "sets hours, minutes and seconds" do
+        date_time = DateTime.new(2020, 10, 10, 18, 30, 45, "+2") # 18:30:45
+        day_time = DayTime.new(date_time)
+
+        expect(day_time.hours).to be 18
+        expect(day_time.minutes).to be 30
+        expect(day_time.seconds).to be 45
+      end
+    end
+  end
+
+  describe "#==" do
+    it "compares by seconds since midnight" do
+      a = DayTime.new("08:00")
+      b = DayTime.new("08:00")
+
+      expect(a == b).to be true
+    end
+  end
+
+  describe "#seconds_since_midnight" do
+    it "returns the seconds since midnight" do
+      day_time = DayTime.new("04:22:44")
+      expect(day_time.seconds_since_midnight).to be 15_764
+    end
+  end
+
+  describe "#<=>" do
+    let(:morning) { DayTime.new("08:00") }
+    let(:noon)    { DayTime.new("12:00") }
+    let(:evening) { DayTime.new("20:00") }
+
+    it "compares by seconds since midnight" do
+      expect(morning < evening).to be true
+    end
+
+    it "supports ranges" do
+      expect(morning..evening).to include noon
+    end
+  end
+
+  describe "#succ" do
+    it "returns a DayTime advanced by a second" do
+      expect(DayTime.new("08:00").succ).to eq DayTime.new("08:00:01")
+    end
+
+    context "with overflowing seconds" do
+      it "starts over at midnight" do
+        expect(DayTime.new("23:59:59").succ).to eq DayTime.new("00:00:00")
+      end
+    end
+  end
+
+  describe "#each" do
+    it "returns DayTimes advanced by a second" do
+      enum = DayTime.new("23:59:59").to_enum
+
+      expect(enum.next).to eq DayTime.new("00:00:00")
+      expect(enum.next).to eq DayTime.new("00:00:01")
+    end
+  end
+
+  describe "#+" do
+    let(:morning) { DayTime.new("08:00") }
+    let(:noon)    { DayTime.new("12:00") }
+
+    context "with other DayTime" do
+      it "adds seconds since midnight" do
+        expect(morning + noon).to eq DayTime.new("20:00")
+      end
+    end
+
+    context "with other object" do
+      it "adds seconds since midnight" do
+        expect(morning + "00:00:15").to eq DayTime.new("08:00:15")
+      end
+    end
+  end
+
+  describe "#-" do
+    let(:noon)    { DayTime.new("12:00") }
+    let(:morning) { DayTime.new("08:00") }
+
+    context "with other DayTime" do
+      it "subtracts seconds since midnight" do
+        expect(morning - noon).to eq DayTime.new("04:00")
+      end
+    end
+
+    context "with other object" do
+      it "adds seconds since midnight" do
+        expect(morning - 15).to eq DayTime.new("07:59:45")
+      end
+    end
+  end
+
+  describe "#to_s" do
+    it "returns a HH:MM:SS formatted string" do
+      expect(DayTime.new("04:22:44").to_s).to eq "04:22:44"
+    end
+  end
+
+  describe "#to_i" do
+    it "returns the seconds since midnight" do
+      day_time = DayTime.new("05:34:25")
+      expect(day_time.to_i).to eq day_time.seconds_since_midnight
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: day_time
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dominic Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email: bauerdominic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- day_time.gemspec
+- lib/day_time.rb
+- spec/day_time_spec.rb
+homepage: https://github.com/bauerd/day_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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Day time calculations
+test_files:
+- spec/day_time_spec.rb
+has_rdoc: