environment_helpers 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8909c0a7ad45e4fc50777d074086126849b1b9a3907ecae5f5b6c5fafd547c3a
-  data.tar.gz: 59f2b7b8cd84a28cc24b545fc240f5145a38b4d445a60f63ef35b881d6ee2c50
+  metadata.gz: 202ea78421b65c63b2d3151a55ddfc891aab67569d67dceba358939f0b89fcd7
+  data.tar.gz: 82344f0d77473dd80a467a915c33d5897ae763eaa8d9faa18e81b9b9c99e9774
 SHA512:
-  metadata.gz: 744fa0ee02661aa41df2a0bee2b88af5402d0ab5dfefa77e93aeabfccb44186c68e79da151ea926b85a0608c9c903f1925e877362d6d7cfad43f5d3172b3dbdb
-  data.tar.gz: 56099bbc01ff6226b63fedab0ed108eccb65775550782e1635ece461985ad1817e99340a2cedd01be724ee50bbf2d9def8e2cad005d2ae7299750cd418fd9e3c
+  metadata.gz: f7b0d5146de039a774301fb24266f4d2cdb467e095e0915121771b543aed10782c88e80f5c9c24e234b6cf9821e76637232f7220812061774599ec03b0f500b9
+  data.tar.gz: 3aa3c4435e7e7a9ebf83d1fbf9277e55a7fb12be6280119045ab2dbaf80f20715116a357f09dca9884a57772c889890defa509df7cf2a551ee3ecf8f8f8cbe9a

data/README.md

@@ -34,6 +34,7 @@ methods onto `ENV` for your use.
 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.date("SCHEDULED_DATE", required: true, format: "%Y-%m-%d")
 ```
@@ -51,6 +52,8 @@ The available methods added to `ENV`:
   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`.

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.1.0"
 end

data/lib/environment_helpers.rb

@@ -1,6 +1,7 @@
 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/datetime_helpers"
 
@@ -11,12 +12,14 @@ 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 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.1.0
 platform: ruby
 authors:
 - Eric Mueller
@@ -103,6 +103,7 @@ files:
 - lib/environment_helpers/boolean_helpers.rb
 - lib/environment_helpers/datetime_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