environment_helpers 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdd872a3aa32975aeeb47dbe0236e1571c41c47632c0fcae86fea957f8c1eafa
-  data.tar.gz: d9f41beec0bba097c4bda2c0aa6c365c0967106843daeb79650e58b08c2e6a43
+  metadata.gz: c789efc6ec01f80dab6e39fcf2ae8c1941642b61751e8585ed4765e7679260c2
+  data.tar.gz: 29fab39b2237db66ef6d980880f606d4ec0ba4be4991ccb38a3aface1149d68f
 SHA512:
-  metadata.gz: 5a0adb44b8ce267e6e6d072c3f7e474c55fce9709bb924736b5f8abad59d54cd0e88d401892adbf850c589abfed455eec7925077fc2b62393984943c636c938b
-  data.tar.gz: c64a226be91f881470d39671fc8a559927c475ea9e32e347ad54a2dae02dc534190a743f1927601bd321e2acbe37d872c49c66251c1fad9be2f74e3586025894
+  metadata.gz: 617d37082c5f021bbf1691332e4cade122014508394c8f6f3a8b6e80e20847a57d41793a1fbb99ff3f9ca15bfd5f86666ff8b72883643681f72341757f88043e
+  data.tar.gz: 040fc4d6d63f5306c96bdf39fd4814608912c23063b9ced4f101b9250c39cbbf0ebf93626e47d41813e8872bebc946dfcbd54d4003fcf994b711ba820c201672

data/README.md

@@ -38,6 +38,7 @@ ENV.integer_range("ID_RANGE", default: (500..6000))
 ENV.integer("MAX_THREAD_COUNT", default: 5)
 ENV.file_path("FILE_PATH", default: "/some/path", required: true)
 ENV.date("SCHEDULED_DATE", required: true, format: "%Y-%m-%d")
+ENV.date_time("RUN_AT", required: true, default: DateTime.now)
 ```
 
 Each of the supplied methods takes a positional parameter for the name of the environment variable,
@@ -64,3 +65,8 @@ The available methods added to `ENV`:
   which would parse a date like `2023-12-25`. It will handle invalid values (or format strings) like
   the variable not being present, though if it's specified as `required`, you will see a different
   exception in each case.
+* `date_time` - produces a `DateTime` object, using either `DateTime.strptime` or `DateTime.iso8601`.
+  The default format is `:iso8601`, and `:unix` is also an allowed 'format'. But if it is supplied
+  as a _string_, it will be handled as a strptime format string (the `:unix` format is equivalent to
+  the format string `"%s"`). It handles invalid or unparseable values like `ENV.date` does, in that
+  they are treated as if not supplied.

data/lib/environment_helpers/datetime_helpers.rb

@@ -12,6 +12,16 @@ module EnvironmentHelpers
       fail(InvalidDateText, "Required date environment variable #{name} had inappropriate content '#{text}'")
     end
 
+    def date_time(name, format: :iso8601, default: nil, required: false)
+      check_default_type(:date_time, default, DateTime)
+      text = fetch_value(name, required: required)
+      dt = parse_date_time_from(text, format: format)
+
+      return dt if dt
+      return default unless required
+      fail(InvalidDateTimeText, "Require date_time environment variable #{name} had inappropriate content '#{text}'")
+    end
+
     private
 
     def parse_date_from(text, format:)
@@ -20,5 +30,37 @@ module EnvironmentHelpers
     rescue ArgumentError
       nil
     end
+
+    def parse_date_time_from(text, format:)
+      if text.nil?
+        nil
+      elsif format == :iso8601
+        iso8601_date_time(text)
+      elsif format == :unix
+        unix_date_time(text)
+      elsif format.is_a?(String)
+        strptime_date_time(text, format: format)
+      else
+        fail(BadFormat, "ENV.date_time requires either a strptime format string, :unix, or :iso8601")
+      end
+    end
+
+    def iso8601_date_time(text)
+      DateTime.iso8601(text)
+    rescue
+      nil
+    end
+
+    def unix_date_time(text)
+      DateTime.strptime(text, "%s")
+    rescue
+      nil
+    end
+
+    def strptime_date_time(text, format:)
+      DateTime.strptime(text, format)
+    rescue
+      nil
+    end
   end
 end

data/lib/environment_helpers/version.rb

@@ -1,3 +1,3 @@
 module EnvironmentHelpers
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/environment_helpers.rb

@@ -1,3 +1,7 @@
+# 'set' doesn't need requiring after ruby 3.2, but it won't hurt anything.
+# And we're compatible back to 2.6
+require "set" # rubocop:disable Lint/RedundantRequireStatement
+
 require_relative "./environment_helpers/access_helpers"
 require_relative "./environment_helpers/string_helpers"
 require_relative "./environment_helpers/boolean_helpers"
@@ -10,12 +14,14 @@ module EnvironmentHelpers
   Error = Class.new(::StandardError)
   MissingVariableError = Class.new(Error)
   BadDefault = Class.new(Error)
+  BadFormat = Class.new(Error)
 
   InvalidValue = Class.new(Error)
   InvalidBooleanText = Class.new(InvalidValue)
   InvalidRangeText = Class.new(InvalidValue)
   InvalidIntegerText = Class.new(InvalidValue)
   InvalidDateText = Class.new(InvalidValue)
+  InvalidDateTimeText = Class.new(InvalidValue)
 
   include AccessHelpers
   include StringHelpers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: environment_helpers
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec