easy_time 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14627cb45389f5f6d02c4018cd289ec5d395f333b4fc898065c3ac0309f245f4
-  data.tar.gz: 0e4cf658977e8c650a0210155e1e471eee52dae57340d12b04f85c23621c2e4e
+  metadata.gz: d4f0fb3fb88ee686970dd45f050f0552c21a5cbfa172d47a4e6efcdf49d315a1
+  data.tar.gz: bfd9fd1bf295831fa16c9aede647b3f8390af002937542a60b332893bf03f817
 SHA512:
-  metadata.gz: 6eb8d35eb1e50d9ead87c14e3cfb929fb5e1d9bd754b262151903e7525479af1cc2018c63cb1305778c69ccf370d6764f43ce7e4ae5e8d5e8399412ef68f50d2
-  data.tar.gz: 17425e181160189a63d2b51f101a8723eb4257bb07e6cc1d6112a07c6e512f4dba4c8ad8c66c3773a5a2b9e01156b04f7358c043b55b775b4727028207a636f3
+  metadata.gz: 00bc14c61c2759891507a8b777708b5fd667353adbcff8255c91870f85d6479fabef87fad4f30bd47d8ead3459173ae979f767b958e20f809fe6d455f6c08bcc
+  data.tar.gz: 1468b0315071178981d7013485c6dca6304a6165d4372c632f722644e3b1864de0c825a1d6356cda2fef07048dbbff0bfc6f0f2ed57f77c2d542778a3df7ec03

data/.circleci/config.yml

@@ -5,7 +5,7 @@ orbs:
 defaults: &DEFAULTS
   resource_class: small
   docker:
-    - image: cimg/ruby:2.7.7
+    - image: cimg/ruby:2.7.8
 
       environment:
         BUNDLE_JOBS: 3
@@ -17,7 +17,7 @@ defaults: &DEFAULTS
 jobs:
   build:
     docker:
-      - image: cimg/ruby:2.7.7
+      - image: cimg/ruby:2.7.8
     executor: ruby/default
     steps:
       - checkout

data/.rubocop.yml

@@ -5,6 +5,9 @@ Metrics/AbcSize:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
+
 Metrics/MethodLength:
   Enabled: false
 
@@ -18,10 +21,17 @@ Metrics/ClassLength:
 Layout/ExtraSpacing:
   Enabled: false
 
+Layout/HashAlignment:
+  Exclude:
+  - 'Guardfile'
+
 Layout/LineLength:
   Enabled: false
 
-Layout/SpacingAroundOperators:
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceInsideArrayLiteralBrackets:
   Enabled: false
 
 # Styles
@@ -36,3 +46,18 @@ Style/StringLiterals:
 
 Style/RescueModifier:
   Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+  - 'bin/*'
+
+# Lint
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+# Naming
+Naming/BinaryOperatorParameterName:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log for EasyTime
 
+## [1.0.0] - 2024-02-26
+
+### Changed
+
+Changed `convert` to use a named `coerce:` keyword parameter.
+Updated and modernized the specs.
+Rubocop complaints satisfied.
+Bypassed '/specs/' for SimplCov
+
+###
+
 ## [0.2.2] - 2024-01-18
 
 ### Added

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in easy_time.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy_time (0.2.2)
+    easy_time (1.0.0)
       activesupport
 
 GEM
@@ -116,6 +116,8 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     shellany (0.0.1)
@@ -134,6 +136,7 @@ GEM
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   activesupport (>= 6.1.4)
@@ -150,6 +153,7 @@ DEPENDENCIES
   rspec_junit
   rspec_junit_formatter
   rubocop (>= 0.82.0)
+  rubocop-rake
   simplecov
   terminal-notifier-guard
   yard (>= 0.9.24)

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Guardfile for easy_time gem
 
 begin
@@ -30,6 +32,6 @@ guard :rspec,
 end
 
 guard 'yard' do
-  watch(%r{lib\/.+\.rb})
+  watch(%r{lib/.+\.rb})
   watch('README.md')
 end

data/Rakefile

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop-rake"
+require "rubocop/rake_task"
 require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
 namespace :spec do
   desc "run tests with code coverage"
@@ -11,9 +16,19 @@ namespace :spec do
   end
 end
 
+task default: %i[spec rubocop]
+task build:   %i[bundle:add_linux]
+task install: %i[build spec bundle:add_linux]
+task release: %i[build spec install bundle:add_linux]
+
+namespace :bundle do
+  desc 'add linux platform to Gemfile.lock'
+  task :add_linux do
+    sh 'bundle lock --add-platform x86_64-linux'
+  end
+end
+
 YARD::Rake::YardocTask.new do |t|
   t.options += ['--title', "EasyTime #{EasyTime::VERSION} Documentation"]
   t.stats_options = ['--list-undoc']
 end
-
-task :default => :spec

data/easy_time.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/easy_time/version'
 
 Gem::Specification.new do |spec|
@@ -6,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Alan Stebbens"]
   spec.email         = ["aks@stebbens.org"]
 
-  spec.summary       = %q{Easy auto-conversion of most date and time values with tolerant-comparisons}
+  spec.summary       = "Easy auto-conversion of most date and time values with tolerant-comparisons"
   spec.description   =
     <<~'DESC'
 
@@ -26,7 +28,7 @@ Gem::Specification.new do |spec|
     DESC
   spec.homepage      = 'https://github.com/aks/easy_time'
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
   # spec.metadata["allowed_push_host"] = "https://rubygems.pkg.github.com/aks"
@@ -38,7 +40,7 @@ Gem::Specification.new do |spec|
 
   # 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(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "bin"
@@ -53,11 +55,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-yard"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "redcarpet"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec_junit"
   spec.add_development_dependency "rspec_junit_formatter"
-  spec.add_development_dependency "redcarpet"
   spec.add_development_dependency "rubocop", ">= 0.82.0"
+  spec.add_development_dependency "rubocop-rake"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "terminal-notifier-guard" if /Darwin/.match?(`uname -a`.strip)
   spec.add_development_dependency "yard", ">= 0.9.24"

data/lib/easy_time/convert.rb

@@ -41,7 +41,7 @@ class EasyTime
     #             various kinds of date and time values
     # @param coerce [Boolean] if true, coerce the `arg` into a Time object _(default: true)_
     # @return [Time]
-    def convert(arg, coerce = true)
+    def convert(arg, coerce: true)
       case arg
       when String
         parse_string(arg)              # parse the string value into an EasyTime object

data/lib/easy_time/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class EasyTime
-  VERSION = "0.2.2"
+  VERSION = "1.0.0"
 end

data/lib/easy_time.rb

@@ -138,7 +138,6 @@ class EasyTime
       compare(time1, time2, tolerance: tolerance).zero?
     end
 
-
     # @overload between?(time1, t_min, t_max, tolerance: nil)
     #   @param time1 [Date,Time,DateTime,EasyTime,Duration,String,Array<Integer>] a time value
     #   @param t_min [Date,Time,DateTime,EasyTime,Duration,String,Array<Integer>] the minimum time
@@ -150,7 +149,7 @@ class EasyTime
     #   @param time_range [Range] a range `(t_min..t_max)` of time values
     #   @return [Boolean] true if `time_range.min <= time1 <= time_range.max`, using tolerant comparisons
 
-    def between?(time1, t_arg, t_max=nil, tolerance: nil)
+    def between?(time1, t_arg, t_max = nil, tolerance: nil)
       if t_arg.is_a?(Range)
         t_min = t_arg.min
         t_max = t_arg.max
@@ -221,13 +220,13 @@ class EasyTime
       end
     end
 
-    def respond_to_missing?(symbol, include_all=false)
+    def respond_to_missing?(symbol, include_all = false)
       Time.respond_to?(symbol, include_all)
     end
 
     # @param value [Anything] value to test as a time-like object
     # @return [Boolean] true if value is one the known Time classes, or responds to :acts_like_time?
-    def is_a_time?(value)
+    def a_time?(value)
       case value
       when Integer, ActiveSupport::Duration
         false
@@ -237,6 +236,7 @@ class EasyTime
         value.respond_to?(:acts_like_time?) && value.acts_like_time?
       end
     end
+    alias is_a_time? a_time?
   end
 
   attr_accessor :time
@@ -318,7 +318,7 @@ class EasyTime
   # @return [Integer] one of [-1, 0, 1] or nil
 
   def <=>(other)
-    diff = self - other  # note: this has a side-effect of setting @other_time
+    diff = self - other  # NOTE: this has a side-effect of setting @other_time
     if diff && diff.to_i.abs <= comparison_tolerance.to_i
       0
     elsif diff
@@ -362,7 +362,7 @@ class EasyTime
   #        a date/time value, a duration, or an Integer
   # @return [EasyTime,Integer] updated time _(time - duration)_ or duration _(time - time)_
   def -(other)
-    @other_time = convert(other, false)
+    @other_time = convert(other, coerce: false)
     if is_a_time?(other_time)
       time - other_time
     elsif other_time
@@ -376,8 +376,8 @@ class EasyTime
 
   private
 
-  def convert(datetime, coerce = true)
-    self.class.convert(datetime, coerce)
+  def convert(datetime, coerce: true)
+    self.class.convert(datetime, coerce: coerce)
   end
 
   # intercept any time methods so they can wrap the time-like result in a new EasyTime object.
@@ -390,13 +390,14 @@ class EasyTime
     end
   end
 
-  def respond_to_missing?(symbol, include_all=false)
+  def respond_to_missing?(symbol, include_all = false)
     time.respond_to?(symbol, include_all)
   end
 
-  def is_a_time?(value)
+  def a_time?(value)
     self.class.is_a_time?(value)
   end
+  alias is_a_time? a_time?
 end
 
 # Extend the known date and time classes _(including EasyTime itself!)_

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_time
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Alan Stebbens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec_junit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -306,7 +320,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="