environment_helpers 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 977bcb9a26d78cbddc4857274e59ed796d9454993fa5bc307c3643af08ed53e2
-  data.tar.gz: 4696a62fd389365b56c79e952a1f4ac947970483faf17122e21cc312a1eff2c4
+  metadata.gz: 5e1df5aabc663c1ed5969c56db3d1be35f6b329272718ce174b30260f4c2f1e8
+  data.tar.gz: 855f2cf510c568464310ef1bc30fb6115a6dff653618f25472a452fcf901cb77
 SHA512:
-  metadata.gz: 1fca3efa7549d3464b174bb84fdaab9d5f0a6c150121d50cf715891eafcca4f097f24c2624f8cab10812260e0c1358928eac811cf299b232afd0a4971641f084
-  data.tar.gz: 2240bb669c7d0852c581b4ab0c0c343cdc1c1dece4da9b8b1d34c2b08658c9aa4e5a8ddfb6e6c864751ee4f6fd82d1ad351721213b005270faa233aa0f957a79
+  metadata.gz: 2dcccd3be2e778d76ce595521efc58204b680acfbe3328c86e357946574c338e323ee7a4e479e39d768f97a67fb6ecb7bb2c7aad7c68db7ed2d6f30bd761f299
+  data.tar.gz: 6a9bccc3864329bf295f59c268d64bed2078d072f9eed08ce2ff3063ead716f2e3e5a14b333f710b01b6092ec3be595bb71e74548c83515f230dfb9306e51bd7

data/.github/workflows/quality.yml

@@ -7,7 +7,7 @@ jobs:
   check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 

data/.github/workflows/rspec.yml

@@ -9,9 +9,11 @@ jobs:
       fail-fast: false
       matrix:
         ruby-version: ['2.7', '3.0', '3.1', '3.2', 'head']
+    env:
+      NO_STEEP: "Because we need to test on versions that are older than steep supports"
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up ruby
         uses: ruby/setup-ruby@v1

data/.github/workflows/type_check.yml

@@ -0,0 +1,18 @@
+name: Steep Type Checking
+
+on: push
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+          bundler-cache: true
+
+      - name: Run Steep
+        run: bundle exec steep check

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## Release 1.5.0
+
+* Add rbs/steep, and enforce types in CI (.rbs file is exported as part
+  of the gem) (#28, resolves #21)
+* Support env-based customization of the truthy/falsey strings used by
+  `ENV.boolean` (#29, resolves #27)
+* Update github workflows to use checkout@v4 (which should have no real
+  impact on us, aside from staying current). (#30)
+* Update README to explain `ENV.array`
+
 ## Release 1.4.0
 
 * Drop support for ruby 2.6

data/Gemfile

@@ -1,3 +1,7 @@
 source "https://rubygems.org"
 
 gemspec
+
+unless ENV["NO_STEEP"]
+  gem "steep", "~> 1.6.0"
+end

data/README.md

@@ -43,6 +43,7 @@ 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)
+ENV.array("QUEUE_NAMES", of: :strings, required: false, default: ["high", "low"])
 ```
 
 Each of the supplied methods takes a positional parameter for the name of the
@@ -83,3 +84,17 @@ The available methods added to `ENV`:
   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.
+* `array` - produces an array of strings, symbols, or integers, depending on the
+  value of the `of` parameter. You can specify the delimiter using a `delimiter`
+  parameter (it defaults to a comma).
+
+## Configuration
+
+If you want to specify your own list of truthy/falsey strings, you can do that
+by setting either or both of these environment variables, supplying comma-
+separated (whitespace-free) strings:
+
+* `ENVIRONMENT_HELPERS_TRUTHY_STRINGS` - the default value used is
+  `true,yes,on,enabled,enable,allow,t,y,1,ok,okay`
+* `ENVIRONMENT_HELPERS_FALSEY_STRINGS` - the default value used is
+  `false,no,off,disabled,disable,deny,f,n,0,nope`

data/Steepfile

@@ -0,0 +1,17 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  check "lib"
+  configure_code_diagnostics(D::Ruby.default)
+  library "pathname"
+  library "date"
+end
+
+target :test do
+  signature "sig"
+  check "test"
+  configure_code_diagnostics(D::Ruby.default)
+  library "pathname"
+  library "date"
+end

data/lib/environment_helpers/boolean_helpers.rb

@@ -1,7 +1,5 @@
 module EnvironmentHelpers
   module BooleanHelpers
-    TRUTHY_STRINGS = %w[true yes on enabled enable allow t y 1 ok okay].to_set
-    FALSEY_STRINGS = %w[false no off disabled disable deny f n 0 nope].to_set
     BOOLEAN_VALUES = [true, false, nil].to_set
 
     def boolean(name, default: nil, required: false)
@@ -19,12 +17,26 @@ module EnvironmentHelpers
 
     def truthy_text?(text)
       return false if text.nil?
-      TRUTHY_STRINGS.include?(text.strip.downcase)
+      truthy_strings.include?(text.strip.downcase)
     end
 
     def falsey_text?(text)
       return false if text.nil?
-      FALSEY_STRINGS.include?(text.strip.downcase)
+      falsey_strings.include?(text.strip.downcase)
+    end
+
+    def truthy_strings
+      @_truthy_strings ||=
+        ENV.fetch("ENVIRONMENT_HELPERS_TRUTHY_STRINGS", "true,yes,on,enabled,enable,allow,t,y,1,ok,okay")
+          .split(",")
+          .to_set
+    end
+
+    def falsey_strings
+      @_falsey_strings ||=
+        ENV.fetch("ENVIRONMENT_HELPERS_FALSEY_STRINGS", "false,no,off,disabled,disable,deny,f,n,0,nope")
+          .split(",")
+          .to_set
     end
   end
 end

data/lib/environment_helpers/enumerable_helpers.rb

@@ -2,6 +2,18 @@ module EnvironmentHelpers
   module EnumerableHelpers
     VALID_TYPES = %i[strings symbols integers]
 
+    TYPE_HANDLERS = {
+      integers: :to_i,
+      strings: :to_s,
+      symbols: :to_sym
+    }
+
+    TYPE_MAP = {
+      integers: Integer,
+      strings: String,
+      symbols: Symbol
+    }
+
     def array(key, of: :strings, delimiter: ",", default: nil, required: false)
       check_default_type(:array, default, Array)
       check_valid_data_type!(of)
@@ -22,23 +34,12 @@ module EnvironmentHelpers
     end
 
     def check_default_data_types!(default, type)
+      return if default.nil?
       invalid = Array(default).reject { |val| val.is_a? TYPE_MAP[type] }
 
       unless invalid.empty?
         fail(BadDefault, "Default array contains values not of type `#{type}': #{invalid.join(", ")}")
       end
     end
-
-    TYPE_HANDLERS = {
-      integers: :to_i,
-      strings: :to_s,
-      symbols: :to_sym
-    }
-
-    TYPE_MAP = {
-      integers: Integer,
-      strings: String,
-      symbols: Symbol
-    }
   end
 end

data/lib/environment_helpers/range_helpers.rb

@@ -6,7 +6,7 @@ module EnvironmentHelpers
       check_range_endpoint(:integer_range, default.end) if default
 
       text = fetch_value(name, required: required)
-      range = parse_range_from(text)
+      range = text ? parse_range_from(text) : nil
       return range if range
       return default unless required
       fail(InvalidRangeText, "Required Integer Range environment variable #{name} had inappropriate content '#{text}'")

data/lib/environment_helpers/string_helpers.rb

@@ -6,7 +6,7 @@ module EnvironmentHelpers
 
     def symbol(name, default: nil, required: false)
       check_default_type(:symbol, default, Symbol)
-      string(name, default: default, required: required)&.to_sym
+      string(name, default: default&.to_s, required: required)&.to_sym
     end
   end
 end

data/lib/environment_helpers/version.rb

@@ -1,3 +1,3 @@
 module EnvironmentHelpers
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/environment_helpers.rb

@@ -2,14 +2,14 @@
 # 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"
-require_relative "./environment_helpers/range_helpers"
-require_relative "./environment_helpers/numeric_helpers"
-require_relative "./environment_helpers/file_helpers"
-require_relative "./environment_helpers/datetime_helpers"
-require_relative "./environment_helpers/enumerable_helpers"
+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"
+require_relative "environment_helpers/enumerable_helpers"
 
 module EnvironmentHelpers
   Error = Class.new(::StandardError)

data/sig/environment_helpers.rbs

@@ -0,0 +1,96 @@
+module EnvironmentHelpers
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class MissingVariableError < Error
+  end
+
+  class BadDefault < Error
+  end
+
+  class BadFormat < Error
+  end
+
+  class InvalidType < Error
+  end
+
+  class InvalidValue < Error
+  end
+
+  class InvalidBooleanText < InvalidValue
+  end
+
+  class InvalidRangeText < InvalidValue
+  end
+
+  class InvalidIntegerText < InvalidValue
+  end
+
+  class InvalidDateText < InvalidValue
+  end
+
+  class InvalidDateTimeText < InvalidValue
+  end
+
+  module AccessHelpers
+    # (Actually provided by ENV, which these are all extended onto)
+    def fetch: (String name) -> String?
+             | (String name, String? default) -> String?
+
+    private def fetch_value: (String name, required: bool) -> String?
+    private def check_default_type: (String | Symbol context, untyped value, *Class types) -> void
+    private def check_default_value: (String | Symbol context, untyped value, allow: Enumerable[untyped]) -> void
+  end
+
+  module FileHelpers : AccessHelpers
+    def file_path: (String name, default: String?, required: bool) -> Pathname?
+  end
+
+  module DatetimeHelpers : AccessHelpers
+    type date_time_result = DateTime? | Time?
+    def date: (String name, format: String, default: Date?, required: bool) -> Date?
+    def date_time: (String name, format: String | Symbol, default: date_time_result, required: bool) -> date_time_result
+    private def parse_date_from: (String? text, format: String) -> Date?
+    private def parse_date_time_from: (String? text, format: String | Symbol) -> DateTime?
+    private def iso8601_date_time: (String) -> DateTime?
+    private def unix_date_time: (String) -> DateTime?
+    private def strptime_date_time: (String, format: String) -> DateTime?
+  end
+
+  module NumericHelpers  : AccessHelpers
+    def integer: (String name, default: Integer?, required: bool) -> Integer?
+  end
+
+  module RangeHelpers : AccessHelpers
+    def integer_range: (String name, default: Range[Integer]?, required: bool) -> Range[Integer]?
+    private def check_range_endpoint: (String | Symbol context, untyped value) -> void
+    private def parse_range_bound_from: (String?) -> Integer?
+    private def parse_range_from: (String) -> Range[Integer]?
+  end
+
+  module BooleanHelpers : AccessHelpers
+    BOOLEAN_VALUES: Set[bool]
+    def boolean: (String name, default: bool?, required: bool) -> boolish
+    private def truthy_text?: (String?) -> boolish
+    private def falsey_text?: (String?) -> boolish
+    private def truthy_strings: () -> Set[String]
+    private def falsey_strings: () -> Set[String]
+  end
+
+  module EnumerableHelpers : AccessHelpers
+    VALID_TYPES: Array[Symbol]
+    TYPE_HANDLERS: Hash[Symbol, Symbol]
+    TYPE_MAP: Hash[Symbol, Class]
+    type arrayable = Integer | String | Symbol
+    def array: (String key, of: Symbol, delimiter: String, default: Array[arrayable]?, required: bool) -> Array[arrayable]?
+    private def check_valid_data_type!: (Symbol) -> void
+    private def check_default_data_types!: (Array[arrayable]?, Symbol) -> void
+  end
+
+  module StringHelpers : AccessHelpers
+    def string: (String name, default: String?, required: bool) -> String?
+    def symbol: (String name, default: Symbol?, required: bool) -> Symbol?
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: environment_helpers
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -133,6 +133,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/quality.yml"
 - ".github/workflows/rspec.yml"
+- ".github/workflows/type_check.yml"
 - ".gitignore"
 - ".mdl_rules.rb"
 - ".mdlrc"
@@ -144,6 +145,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Steepfile
 - environment_helpers.gemspec
 - lib/environment_helpers.rb
 - lib/environment_helpers/access_helpers.rb
@@ -155,6 +157,7 @@ files:
 - lib/environment_helpers/range_helpers.rb
 - lib/environment_helpers/string_helpers.rb
 - lib/environment_helpers/version.rb
+- sig/environment_helpers.rbs
 homepage: https://github.com/nevinera/environment_helpers
 licenses:
 - MIT