environment_helpers 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8909c0a7ad45e4fc50777d074086126849b1b9a3907ecae5f5b6c5fafd547c3a
-  data.tar.gz: 59f2b7b8cd84a28cc24b545fc240f5145a38b4d445a60f63ef35b881d6ee2c50
+  metadata.gz: fdd872a3aa32975aeeb47dbe0236e1571c41c47632c0fcae86fea957f8c1eafa
+  data.tar.gz: d9f41beec0bba097c4bda2c0aa6c365c0967106843daeb79650e58b08c2e6a43
 SHA512:
-  metadata.gz: 744fa0ee02661aa41df2a0bee2b88af5402d0ab5dfefa77e93aeabfccb44186c68e79da151ea926b85a0608c9c903f1925e877362d6d7cfad43f5d3172b3dbdb
-  data.tar.gz: 56099bbc01ff6226b63fedab0ed108eccb65775550782e1635ece461985ad1817e99340a2cedd01be724ee50bbf2d9def8e2cad005d2ae7299750cd418fd9e3c
+  metadata.gz: 5a0adb44b8ce267e6e6d072c3f7e474c55fce9709bb924736b5f8abad59d54cd0e88d401892adbf850c589abfed455eec7925077fc2b62393984943c636c938b
+  data.tar.gz: c64a226be91f881470d39671fc8a559927c475ea9e32e347ad54a2dae02dc534190a743f1927601bd321e2acbe37d872c49c66251c1fad9be2f74e3586025894

data/README.md

@@ -30,11 +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")
 ```
 
@@ -45,15 +47,19 @@ 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..
   a fair variety of strings to map onto those boolean value, though you should probably just use
   "true" and "false" really. If you specify `required: true` and get a value like "maybe?", it'll
   raise an `EnvironmentHelpers::InvalidBooleanText` exception.
+* `integer_range` - produces an integer Range object. It accepts `N-N`, `N..N`, or `N...N`, (the
+  latter means 'excluding the upper bound, as in ruby).
 * `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/range_helpers.rb

@@ -0,0 +1,42 @@
+module EnvironmentHelpers
+  module RangeHelpers
+    def integer_range(name, default: nil, required: false)
+      check_default_type(:integer_range, default, Range)
+      check_range_endpoint(:integer_range, default.begin) if default
+      check_range_endpoint(:integer_range, default.end) if default
+
+      text = fetch_value(name, required: required)
+      range = parse_range_from(text)
+      return range if range
+      return default unless required
+      fail(InvalidRangeText, "Required Integer Range environment variable #{name} had inappropriate content '#{text}'")
+    end
+
+    private
+
+    def check_range_endpoint(context, value)
+      return if value.is_a?(Integer)
+      fail(BadDefault, "Invalid endpoint for default range of #{context} - must be Integer")
+    end
+
+    def parse_range_bound_from(text)
+      return nil if text.nil?
+      return nil if text.empty?
+      text.to_i
+    end
+
+    def parse_range_from(text)
+      text =~ /\A(\d*)(-|\.\.|\.\.\.)(\d*)\z/
+      lower_bound = parse_range_bound_from($1)
+      separator = $2
+      upper_bound = parse_range_bound_from($3)
+
+      return nil if lower_bound.nil? || upper_bound.nil?
+      if separator == "..."
+        (lower_bound...upper_bound)
+      else
+        (lower_bound..upper_bound)
+      end
+    end
+  end
+end

data/lib/environment_helpers/version.rb

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

data/lib/environment_helpers.rb

@@ -1,7 +1,9 @@
 require_relative "./environment_helpers/access_helpers"
 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
@@ -11,13 +13,16 @@ module EnvironmentHelpers
 
   InvalidValue = Class.new(Error)
   InvalidBooleanText = Class.new(InvalidValue)
+  InvalidRangeText = Class.new(InvalidValue)
   InvalidIntegerText = Class.new(InvalidValue)
   InvalidDateText = Class.new(InvalidValue)
 
   include AccessHelpers
   include StringHelpers
   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.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Eric Mueller
@@ -102,7 +102,9 @@ 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
 - lib/environment_helpers/version.rb
 homepage: https://github.com/nevinera/environment_helpers