environment_helpers 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 202ea78421b65c63b2d3151a55ddfc891aab67569d67dceba358939f0b89fcd7
-  data.tar.gz: 82344f0d77473dd80a467a915c33d5897ae763eaa8d9faa18e81b9b9c99e9774
+  metadata.gz: fdd872a3aa32975aeeb47dbe0236e1571c41c47632c0fcae86fea957f8c1eafa
+  data.tar.gz: d9f41beec0bba097c4bda2c0aa6c365c0967106843daeb79650e58b08c2e6a43
 SHA512:
-  metadata.gz: f7b0d5146de039a774301fb24266f4d2cdb467e095e0915121771b543aed10782c88e80f5c9c24e234b6cf9821e76637232f7220812061774599ec03b0f500b9
-  data.tar.gz: 3aa3c4435e7e7a9ebf83d1fbf9277e55a7fb12be6280119045ab2dbaf80f20715116a357f09dca9884a57772c889890defa509df7cf2a551ee3ecf8f8f8cbe9a
+  metadata.gz: 5a0adb44b8ce267e6e6d072c3f7e474c55fce9709bb924736b5f8abad59d54cd0e88d401892adbf850c589abfed455eec7925077fc2b62393984943c636c938b
+  data.tar.gz: c64a226be91f881470d39671fc8a559927c475ea9e32e347ad54a2dae02dc534190a743f1927601bd321e2acbe37d872c49c66251c1fad9be2f74e3586025894

data/README.md

@@ -30,12 +30,13 @@ methods onto `ENV` for your use.
 
 ## Usage
 
-```
+```shell
 ENV.string("APP_NAME", default: "local")
 ENV.symbol("BUSINESS_DOMAIN", default: :engineering, required: true)
 ENV.boolean("ENABLE_FEATURE_FOO", default: false)
 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")
 ```
 
@@ -46,6 +47,7 @@ isn't present in the environment. If `required` is set to a truthy value, then i
 present in the environment, an `EnvironmentHelpers::MissingVariableError` is raised.
 
 The available methods added to `ENV`:
+
 * `string` - environment values are already strings, so this is the simplest of the methods.
 * `symbol` - produces a symbol, and enforces that the default value is either `nil` or a Symbol.
 * `boolean` - produces `nil`, `true`, or `false` (and only allows those as defaults). Supports..
@@ -57,6 +59,7 @@ The available methods added to `ENV`:
 * `integer` - produces an integer from the environment variable, by calling `to_i` on it (if it's
   present). Note that this means that providing a value like "hello" means you'll get `0`, since
   that's what ruby does when you call `"hello".to_i`.
+* `file_path` - produces a `Pathname` initialized with the path specified by the environment variable.
 * `date` - produces a `Date` object, using `Date.strptime`. The default format string is `%Y-%m-%d`,
   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

data/lib/environment_helpers/file_helpers.rb

@@ -0,0 +1,12 @@
+require "pathname"
+
+module EnvironmentHelpers
+  module FileHelpers
+    def file_path(name, default: nil, required: false)
+      check_default_type(:file_path, default, String)
+      path = fetch_value(name, required: required) || default
+      return nil if path.nil?
+      Pathname.new(path)
+    end
+  end
+end

data/lib/environment_helpers/version.rb

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

data/lib/environment_helpers.rb

@@ -3,6 +3,7 @@ require_relative "./environment_helpers/string_helpers"
 require_relative "./environment_helpers/boolean_helpers"
 require_relative "./environment_helpers/range_helpers"
 require_relative "./environment_helpers/numeric_helpers"
+require_relative "./environment_helpers/file_helpers"
 require_relative "./environment_helpers/datetime_helpers"
 
 module EnvironmentHelpers
@@ -21,6 +22,7 @@ module EnvironmentHelpers
   include BooleanHelpers
   include RangeHelpers
   include NumericHelpers
+  include FileHelpers
   include DatetimeHelpers
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: environment_helpers
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Eric Mueller
@@ -102,6 +102,7 @@ files:
 - lib/environment_helpers/access_helpers.rb
 - lib/environment_helpers/boolean_helpers.rb
 - lib/environment_helpers/datetime_helpers.rb
+- lib/environment_helpers/file_helpers.rb
 - lib/environment_helpers/numeric_helpers.rb
 - lib/environment_helpers/range_helpers.rb
 - lib/environment_helpers/string_helpers.rb