hour-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b037de6a208ce2bf419a9e1cf5558ecbfc8885e3ee28c58e0f958242c0a75764
+  data.tar.gz: eec358d6872bc3414c6a5789db74a688cc211381aead80b12cad3eca0601b57f
+SHA512:
+  metadata.gz: aa59a5c611500afb23db52439e8f43754f8e857f96dfd6b209352bb57328668421722e7be59268fd19fd6caa50b0d2b291bd5d3e7242555ff03a40885a7c82c5
+  data.tar.gz: c70a2bf14a4f3bddf1e3cdbb69a0c391041549b85d2b26a60806cdd94edbd73511e6629ebb94e740599ff610e1d078b4b5cb68d386a68f6f70d9ef6a6504f315

data/README.md

@@ -0,0 +1,34 @@
+# About
+[![Build status][BS img]][Build status]
+
+Hour class to work with hours, minutes and seconds, convert between various units and format the output.
+
+# Installation
+
+```yaml
+gem install hour-ruby
+```
+
+# Usage
+
+```crystal
+require "hour"
+
+hour = Hour.from(minutes: 85)
+puts "It's #{hour.hours.value}:#{hour.minutes.value}!"
+
+hour = Hour.new(1, 25) + Hour.new(s: 10)
+puts "It's #{hour.to_s}!"
+
+puts "The system time is #{Hour.now}!"
+```
+
+# TODO
+
+- Rubocop.
+- Travis.
+- Link hour-crystal.
+- Release version 0.1.
+
+[Build status]: https://travis-ci.org/botanicus/hour-ruby
+[BS img]: https://travis-ci.org/botanicus/hour-ruby.svg?branch=master

data/lib/hour.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+class Hour
+  # Abstract time unit class.
+  #
+  # Subclasses are decorating the `Hour` class with functionality
+  # specific for their particular type (hours, minutes and seconds).
+  #
+  # @api private
+  class Unit
+    def value
+      raise NotImplementedError.new("Override in subclasses.")
+    end
+
+    def initialize(hour)
+      @hour = hour
+    end
+  end
+
+  class HourUnit < Unit
+    def value
+      @hour.h
+    end
+
+    def round
+      self.value + ((0..29).include?(@hour.m) ? 0 : 1)
+    end
+  end
+
+  class MinuteUnit < Unit
+    def value
+      @hour.m
+    end
+
+    def round
+      self.value + ((0..29).include?(@hour.s) ? 0 : 1)
+    end
+
+    def total
+      @hour.h * 60 + self.value
+    end
+
+    def round_total
+      self.total + ((0..29).include?(@hour.s) ? 0 : 1)
+    end
+  end
+
+  class SecondUnit < Unit
+    def value
+      @hour.s
+    end
+
+    def total
+      @hour.h * 60 * 60 + @hour.m * 60 + self.value
+    end
+  end
+
+  # TODO: Test me and document me.
+  def self.now
+    self.from_time(Time.now)
+  end
+
+  # TODO: document and write tests.
+  def self.from_time(time)
+    self.new(h: time.hours, m: time.minutes, s: time.seconds)
+  end
+
+  # Build an hour instance from an hour string.
+  #
+  #     Hour.parse("1:00:00")
+  #     Hour.parse("1:00", "%h:%m?") # Will work with "1:00" or just "1".
+  #
+  # TODO: Implement me, test me and document me.
+  def self.parse(string, formatting_string = nil)
+    argument_array = serialised_hour.split(':').map(&:to_i)
+
+    case argument_array.size
+    when 3
+      self.new(*argument_array)
+    when (0..2)
+      # TODO: if formatting_string ...
+      raise ArgumentError.new("If format is not H:M:S, formatting string must be provided.")
+    when (4..Float::INFINITY) # Until we have infinite ranges like (4..) in Ruby 2.6.
+      raise ArgumentError, "Too many arguments."
+    end
+  end
+
+  # Build an hour instance from *either* **minutes** *or* **seconds**.
+  # Unlike `.new`, either of these values can be over 60.
+  #
+  #     Hour.from(minutes: 85)  # => Hour.new(h: 1, m: 25)
+  #     Hour.from(seconds: 120) # => Hour.new(m: 2)
+  def self.from(minutes: 0, seconds: 0)
+    if minutes != 0 && seconds != 0
+      raise ArgumentError.new("Use either minutes OR seconds, not both.")
+    end
+
+    if minutes > 0
+      self.new(h: minutes / 60, m: minutes % 60)
+    else
+      self.from(minutes: seconds / 60) + self.new(s: seconds % 60)
+    end
+  end
+
+  attr_reader :h, :m, :s
+
+  # Build an hour instance from *h*, *m* and *s*.
+  # Raises an argument error if *m* or *s* is a value over 60.
+  #
+  # For instantiating this class from a *minutes* or *seconds* value over 60, use `.from`.
+  def initialize(*args)
+    if args.length == 1 && args.first.is_a?(Hash)
+      initialize_from_keyword_args(**args.first)
+    else
+      # Pad with 0s.
+      args = args + Array.new(3 - args.length, 0)
+      @h, @m, @s = args
+    end
+
+    if @m > 60
+      raise ArgumentError.new("Minutes must be a number between 0 and 60.")
+    end
+
+    if @s > 60
+      raise ArgumentError.new("Seconds must be a number between 0 and 60.")
+    end
+  end
+
+  # Returns a new Hour instance returning the total time of the two hour instances.
+  #
+  #     Hour.new(m: 25, s: 10) + Hour.new(h: 1) # => Hour.new(1, 25, 10)
+  def +(other)
+    hours = @h + other.h + (@m + other.m + ((@s + other.s) / 60)) / 60
+    minutes = (@m + other.m + ((@s + other.s) / 60)) % 60
+    seconds = (@s + other.s) % 60
+    self.class.new(hours, minutes, seconds)
+  end
+
+  # Returns a decorator providing convenience methods for working with hours.
+  #
+  #     Hour.new(1, 25).hours.round # => 1
+  #     Hour.new(1, 45).hours.round # => 2
+  def hours
+    HourUnit.new(self)
+  end
+
+  # Returns a decorator providing convenience methods for working with minutes.
+  #
+  #     Hour.new(1, 25, 52).minutes.value       # => 25
+  #     Hour.new(1, 25, 52).minutes.round       # => 26
+  #     Hour.new(1, 25, 52).minutes.total       # => 85
+  #     Hour.new(1, 25, 52).minutes.round_total # => 86
+  def minutes
+    MinuteUnit.new(self)
+  end
+
+  # Returns a decorator providing convenience methods for working with seconds.
+  #
+  #     Hour.new(m: 1, s: 10).seconds.value # => 10
+  #     Hour.new(1, 45, 10  ).seconds.total # => (1 * 60 * 60) + (45 * 60) + 10
+  def seconds
+    SecondUnit.new(self)
+  end
+
+  # TODO: Add formatting string support.
+  # TODO: Pad 0s. I. e. "#{self.hours}:#{format('%02d', self.minutes_over_the_hour)}"
+  def to_s(format = nil)
+    "#{@h}:#{@m}:#{@s}"
+  end
+
+  alias_method :inspect, :to_s
+
+  def to_time(today = Time.now)
+    Time.new(today.year, today.month, today.day, self.hours, self.minutes_over_the_hour)
+  end
+
+  private
+  def initialize_from_keyword_args(h: 0, m: 0, s: 0)
+    @h, @m, @s = h, m, s
+  end
+end
+
+# https://github.com/botanicus/commonjs_modules
+export { Hour } if defined?(export)

data/spec/hour_spec.rb

@@ -0,0 +1,110 @@
+require "hour"
+
+describe Hour do
+  describe ".parse" do
+    pending "implement me" #do
+      # TODO
+      # p Hour.parse("1:02:30")
+    #end
+  end
+
+  describe ".now" do
+    pending "implement me" #do
+      # TODO
+    #end
+  end
+
+  describe "#to_s" do
+    pending "implement me" #do
+      # TODO
+    #end
+  end
+
+  describe "#+" do
+    it "returns a new Hour instance returning the total time of the two hour instances" do
+      hour = Hour.new(m: 25, s: 10) + Hour.new(h: 1)
+      expect(hour.hours.value).to eq(1)
+      expect(hour.minutes.value).to eq(25)
+      expect(hour.seconds.value).to eq(10)
+    end
+  end
+
+  describe ".from" do
+    context "minutes" do
+      it "returns a new Hour instance" do
+        hour = Hour.from(minutes: 85)
+        expect(hour.hours.value).to eq(1)
+        expect(hour.minutes.value).to eq(25)
+        expect(hour.seconds.value).to eq(0)
+      end
+    end
+
+    context "seconds" do
+      it "returns a new Hour instance" do
+        hour = Hour.from(seconds: 2 * 60 * 60 + 25 * 60 + 5)
+        expect(hour.hours.value).to eq(2)
+        expect(hour.minutes.value).to eq(25)
+        expect(hour.seconds.value).to eq(5)
+      end
+    end
+  end
+
+  describe "#hours" do
+    describe "#value" do
+      it "returns the exact hour value" do
+        expect(Hour.new(1, 10).hours.value).to eq(1)
+        expect(Hour.new(1, 59).hours.value).to eq(1)
+      end
+    end
+
+    describe "#round" do
+      it "returns the rounded hour" do
+        expect(Hour.new(1, 10).hours.round).to eq(1)
+        expect(Hour.new(1, 29, 59).hours.round).to eq(1)
+        expect(Hour.new(1, 30).hours.round).to eq(2)
+        expect(Hour.new(1, 59).hours.round).to eq(2)
+      end
+    end
+  end
+
+  describe "#minutes" do
+    describe "#value" do
+      it "returns the exact minute value" do
+        expect(Hour.new(1, 25, 52).minutes.value).to eq(25)
+      end
+    end
+
+    describe "#round" do
+      it "returns the rounded minutes" do
+        expect(Hour.new(1, 25, 52).minutes.round).to eq(26)
+      end
+    end
+
+    describe "#total" do
+      it "returns the total number of minutes" do
+        expect(Hour.new(1, 25, 52).minutes.total).to eq(85)
+      end
+    end
+
+    describe "#round_total" do
+      it "returns the rounded total number of minutes" do
+        expect(Hour.new(1, 25, 52).minutes.round_total).to eq(86)
+      end
+    end
+  end
+
+  describe "#seconds" do
+    describe "#value" do
+      it "returns the exact second value" do
+        expect(Hour.new(m: 1, s: 25).seconds.value).to eq(25)
+      end
+    end
+
+    describe "#total" do
+      it "returns the exact total number of seconds" do
+        expect(Hour.new(m: 1, s: 25).seconds.total).to eq(85)
+        expect(Hour.new(1, 10, 25).seconds.total).to eq(1 * 60 * 60 + 10 * 60 + 25)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: hour-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James C Russell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-21 00:00:00.000000000 Z
+dependencies: []
+description: "."
+email: james@101ideas.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/hour.rb
+- spec/hour_spec.rb
+homepage: http://github.com/botanicus/hour-ruby
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+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.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []