hmtime 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 26115554c68d76501a954c09f822ad0d2e06909e157c49eba2a2ab50fa8612cc
+  data.tar.gz: 42f74999f738324ff5d34fd9410b2177673abcbc37b6dd9ad84ea9b9bcdf738d
+SHA512:
+  metadata.gz: '059ea557563ed3db743a51d81b22128b789e5474083b9155b05562c75fd8fcd4b06afd68d5f0fc3f98dedd122590e7df5df39a811addfa88721e6219fc6a1dbc'
+  data.tar.gz: 8eb2e324b51e6342799c9f94c15790e1b875926f1439cdcf79f4c00b6c77d8873b023168078c743f0f2ee675452d96d54120c8efb481e44b009f42380a22455b

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.2] - 2024-03-14
+
+### Added
+
+- Packaged this gem as a proper gem using a proper gemspec
+- Added unit tests using minitest
+- LICENSE.txt MIT License file
+- README.md file
+
+### Removed
+
+- The ability to multiply and divide -- in future, must be thoughtful about how these functions work if reimplemented
+
+### Changed
+
+- HMTime#== only compares two HMTime objects based upon their @minutes variable
+- Released as version 0.1.2
+
+### Fixed
+
+- Handle negative time in HMTime#hours, HMTime#minutes, and HMTime#time

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Andrew Dvorak
+
+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,46 @@
+# HMTime
+
+A simple HMTime object for representing and performing simple math on hours and minutes. HHH:MM
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add hmtime
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install hmtime
+
+## Usage
+
+```ruby
+require 'hmtime'
+
+HMTime.new #=> 0:00
+HMTime.new('') #=> 0:00
+HMTime.new(0) #=> 0:00
+HMTime.new('123:35') #=> 123:35
+HMTime.new(61) #=> 1:01
+HMTime.new(-61) #=> -1:01
+'1:33'.to_hmtime #=> 1:33
+'-1:33'.to_hmtime #=> -1:33
+HMTime.new(61) + 1 #=> 1:02
+HMTime.new('-2:01') + '2:00' #=> -0:01
+HMTime.new(61) == '1:01'.to_hmtime  #=> true
+HMTime.new(-61) == '1:01'.to_hmtime #=> false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/advorak/hmtime.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,14 +1,8 @@
-require 'rubygems'
-require 'rake'
-require 'echoe'
+# frozen_string_literal: true
 
-Echoe.new('hmtime','0.1.1') do |p|
-  p.description     = "A simple HMTime object for representing and performing math on hours and minutes. HHH:MM"
-  p.url             = "http://github.com/advorak/hmtime"
-  p.author          = "Andrew Dvorak"
-  p.email           = "advorak@gmail.com"
-  p.ignore_pattern  = ["tmp/*", "script/*"]
-  p.development_dependencies = []
-end
+require "bundler/gem_tasks"
+require "minitest/test_task"
 
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+Minitest::TestTask.create
+
+task default: :test

data/hmtime.gemspec

@@ -1,29 +1,39 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name = "hmtime"
-  s.version = "0.1.1"
+require_relative "lib/hmtime/version"
+require 'uri'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Andrew Dvorak"]
-  s.date = "2012-04-09"
-  s.description = "A simple HMTime object for representing and performing math on hours and minutes. HHH:MM"
-  s.email = "advorak@gmail.com"
-  s.extra_rdoc_files = ["README", "README.rdoc", "lib/hmtime.rb"]
-  s.files = ["Manifest", "README", "README.rdoc", "Rakefile", "lib/hmtime.rb", "hmtime.gemspec"]
-  s.homepage = "http://github.com/advorak/hmtime"
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Hmtime", "--main", "README"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = "hmtime"
-  s.rubygems_version = "1.8.11"
-  s.summary = "A simple HMTime object for representing and performing math on hours and minutes. HHH:MM"
+Gem::Specification.new do |spec|
+  spec.name = "hmtime"
+  spec.version = HMTime::VERSION
+  spec.authors = ["Andrew Dvorak"]
+  spec.email = ["advorak@gmail.com"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  spec.summary = "A simple HMTime object for representing and performing simple math on hours and minutes. HHH:MM"
+  # spec.description = "TODO: Write a longer description or delete this line."
+  spec.homepage = "http://github.com/advorak/hmtime"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = URI.join(spec.homepage, "CHANGELOG.md").to_s
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
     end
-  else
   end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
 end

data/lib/hmtime/string.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class String
+  def to_hmtime
+    HMTime.new self
+  end
+end

data/lib/hmtime/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class HMTime
+  VERSION = "0.2.0"
+end

data/lib/hmtime.rb

@@ -1,10 +1,13 @@
-class String
-  def to_hmtime
-    HMTime.new self
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'hmtime/version'
+require_relative 'hmtime/string'
 
 class HMTime
+  class Error < StandardError; end
+  class ArgumentError < Error; end
+  class TypeError < Error; end
+  
   ERROR_MESSAGE_1 = 'Must specify String in format of: `hhh:mm`, where h=Hours and m=Minutes; or integer in the form of #####'
 
   def initialize(value=0)
@@ -15,21 +18,12 @@ class HMTime
     time
   end
   
-  def time
-    my_time = [hours, minutes.to_s.rjust(2,"0")].join(":")
-    if @minutes < 0
-      "-" + my_time
-    else
-      my_time
-    end
-  end
-  
   def hours
-    @minutes.abs / 60
+    (@minutes.negative? ? -1 : 1) * (@minutes.abs / 60)
   end
   
   def minutes
-    @minutes.abs % 60
+    (@minutes.negative? ? -1 : 1) * (@minutes.abs % 60)
   end
   
   def to_s
@@ -48,7 +42,6 @@ class HMTime
     end
   end
   
-  # BUG: Doesn't work if value < 0
   def -(value)
     if value.is_a?(self.class)
       self.class.new(@minutes - value.to_i)
@@ -57,26 +50,25 @@ class HMTime
     end
   end
   
-  def /(value)
-    if value.is_a?(self.class)
-      self.class.new(@minutes / value.to_i)
-    else
-      self.class.new(@minutes / check_arguments(value))
-    end
-  end
+  # def /(value)
+  #   if value.is_a?(self.class)
+  #     self.class.new(@minutes / value.to_i)
+  #   else
+  #     self.class.new(@minutes / check_arguments(value))
+  #   end
+  # end
   
-  
-  # BUG: Doesn't work if value < 0
-  def *(value)
-    if value.is_a?(self.class)
-      self.class.new(@minutes * value.to_i)
-    else
-      self.class.new(@minutes * check_arguments(value))
-    end
-  end
+  # # BUG: Doesn't work if value < 0
+  # def *(value)
+  #   if value.is_a?(self.class)
+  #     self.class.new(@minutes * value.to_i)
+  #   else
+  #     self.class.new(@minutes * check_arguments(value))
+  #   end
+  # end
   
   def ==(value)
-      @minutes == value.to_i
+      value.is_a?(HMTime) && @minutes == value.to_i
   end
   
   # For Comparison
@@ -96,28 +88,36 @@ class HMTime
   
   private
   
-  def check_arguments(value)
-    if(value == nil)
-      value
+  def time
+    my_time = [hours.abs, minutes.abs.to_s.rjust(2,"0")].join(":")
+    if @minutes < 0
+      "-" + my_time
     else
-      if(value.is_a?(Fixnum))
-        arguments = [value / 60, value % 60]
-      elsif (!value.is_a?(String))
-        raise TypeError, ERROR_MESSAGE_1
+      my_time
+    end
+  end
+  
+  def check_arguments(value)
+    if(value.is_a?(Integer))
+      arguments = ['', value / 60, value % 60]
+    elsif (!value.is_a?(String))
+      raise TypeError, ERROR_MESSAGE_1
 
-      # Is the argument a string of format ("hhh:mm" or " ".strip.empty?)?  If not, raise an error.
-      elsif !value.strip.empty? && !(arguments = value.strip.match(/^(\d+|\s+)?:(\d{2})$/).to_a[1..2])
-        raise ArgumentError, ERROR_MESSAGE_1
-      elsif value.strip.empty?
-        arguments = [0,0]
-      end
+    # Is the argument a string of format ("hhh:mm" or " ".strip.empty?)?  If not, raise an error.
+    elsif !value.strip.empty? && !(arguments = value.strip.match(/^(-?)(\d+|\s+)?:(\d{2})$/).to_a[1..3])
+      raise ArgumentError, ERROR_MESSAGE_1
+    elsif value.strip.empty?
+      arguments = ['',0,0]
+    end
 
-      ### How to do a warning??  Is this correct?
-      if arguments[1].to_i > 59
-        warn "Warning: The mm (minutes) field of `hhh:mm` should be no greater than 59."
-      end
-      hours, minutes = arguments.collect{|arg| arg.to_i}
-      return (hours * 60) + minutes
+    ### How to do a warning??  Is this correct?
+    if arguments[1].to_i > 59
+      warn "Warning: The mm (minutes) field of `hhh:mm` should be no greater than 59."
     end
+
+    is_negative = arguments[0] == '-'
+    hours, minutes = arguments[1,2].collect{|arg| arg.to_i}
+    
+    return (is_negative ? -1 : 1) * ((hours * 60) + minutes)
   end
-end
+end

data/sig/hmtime.rbs

@@ -0,0 +1,4 @@
+class HMTime
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,61 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: hmtime
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Dvorak
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2012-04-09 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies: []
-description: A simple HMTime object for representing and performing math on hours
-  and minutes. HHH:MM
-email: advorak@gmail.com
+description: 
+email:
+- advorak@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- README.rdoc
-- lib/hmtime.rb
+extra_rdoc_files: []
 files:
-- Manifest
-- README
-- README.rdoc
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 - Rakefile
-- lib/hmtime.rb
 - hmtime.gemspec
+- lib/hmtime.rb
+- lib/hmtime/string.rb
+- lib/hmtime/version.rb
+- sig/hmtime.rbs
 homepage: http://github.com/advorak/hmtime
-licenses: []
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/advorak/hmtime
+  source_code_uri: http://github.com/advorak/hmtime
+  changelog_uri: http://github.com/advorak/CHANGELOG.md
 post_install_message: 
-rdoc_options:
-- --line-numbers
-- --inline-source
-- --title
-- Hmtime
-- --main
-- README
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '1.2'
+      version: '0'
 requirements: []
-rubyforge_project: hmtime
-rubygems_version: 1.8.11
+rubygems_version: 3.5.3
 signing_key: 
-specification_version: 3
-summary: A simple HMTime object for representing and performing math on hours and
-  minutes. HHH:MM
+specification_version: 4
+summary: A simple HMTime object for representing and performing simple math on hours
+  and minutes. HHH:MM
 test_files: []

data/Manifest

@@ -1,5 +0,0 @@
-Manifest
-README
-README.rdoc
-Rakefile
-lib/hmtime.rb