environment_helpers 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71bfb123e7f90d29f9e038849bc995207b9c11b166aae7e0938cf162e7ed70f5
-  data.tar.gz: bb88e8d31c0c343a54f7be6a6919af08446a2a9fff973868b9ba22a9f1fc3f9a
+  metadata.gz: 977bcb9a26d78cbddc4857274e59ed796d9454993fa5bc307c3643af08ed53e2
+  data.tar.gz: 4696a62fd389365b56c79e952a1f4ac947970483faf17122e21cc312a1eff2c4
 SHA512:
-  metadata.gz: f9adafc223d6c2edff2c4179bb86d172e2febe28d8761a2d55b9b76db02d6076ce981229cd8f758c905c4e4e524ad4b6b6e589ff55ced624fbc510ad8a183ed1
-  data.tar.gz: 7d6ae5d630de28a2d5db1776d06ed7d2a6117a905b66c12aa61b2b7fe5c4dd64dd8cd5e764c450fcf846b077ee23c7f74f6bd393d3cec8b161f6365a27cd498b
+  metadata.gz: 1fca3efa7549d3464b174bb84fdaab9d5f0a6c150121d50cf715891eafcca4f097f24c2624f8cab10812260e0c1358928eac811cf299b232afd0a4971641f084
+  data.tar.gz: 2240bb669c7d0852c581b4ab0c0c343cdc1c1dece4da9b8b1d34c2b08658c9aa4e5a8ddfb6e6c864751ee4f6fd82d1ad351721213b005270faa233aa0f957a79

data/.github/workflows/quality.yml

@@ -0,0 +1,29 @@
+name: Quiet Quality
+
+on: push
+permissions: write-all
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Show the merge-base
+        run: git merge-base origin/main ${{ github.sha }}
+        if: github.branch != 'main'
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+
+      - name: Install gems
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Run QuietQuality
+        run: |
+          gem install quiet_quality standard rubocop
+          qq -C .quiet_quality.ci-cd.yml

data/.github/workflows/rspec.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2', 'head']
+        ruby-version: ['2.7', '3.0', '3.1', '3.2', 'head']
 
     steps:
       - uses: actions/checkout@v3

data/.mdl_rules.rb

@@ -0,0 +1,2 @@
+all
+rule "MD013", ignore_code_blocks: true

data/.mdlrc

@@ -0,0 +1,2 @@
+style File.expand_path("../.mdl_rules.rb", __FILE__)
+git_recurse true

data/.quiet_quality.ci-cd.yml

@@ -0,0 +1,7 @@
+---
+default_tools: ["standardrb", "rubocop", "markdown_lint", "rspec"]
+executor: concurrent
+comparison_branch: origin/main
+annotator: github_stdout
+changed_files: false
+filter_messages: false

data/.quiet_quality.yml

@@ -0,0 +1,7 @@
+---
+default_tools: ["standardrb", "rubocop", "markdown_lint", "rspec"]
+executor: concurrent
+comparison_branch: origin/main
+logging: light
+changed_files: false
+filter_messages: false

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+## Release 1.4.0
+
+* Drop support for ruby 2.6
+* Setup `quiet_quality` through the gemspec
+* Setup `markdownlint` and comply with its rules (#25)
+* Setup `rspec-cover_it` to enforce test-coverage (#24)
+
+## Release 1.3.0
+
+* Support `ENV.date_time` (#19, resolves #6)
+
+## Release 1.2.1
+
+* Require `set` before loading the gem, since we support rubies before 3.2 (#18)
+
+## Release 1.2.0
+
+* Support `ENV.file_path` returning Pathname objects (#16, resolves #13)
+
+## Release 1.1.0
+
+* Support `ENV.integer_range` (#15, resolves #5)
+
+## Release 1.0.1
+
+* Specify dependencies more tightly (#14)
+
+## Release 1.0.0
+
+(Initial release)

data/README.md

@@ -1,36 +1,40 @@
 # EnvironmentHelpers
-This gem adds a set of convenience helpers to `ENV`, allowing you to access environment variables
-in a more structures and consistent way. Have you seen any line like these?
 
-```
+This gem adds a set of convenience helpers to `ENV`, allowing you to access
+environment variables in a more structures and consistent way. Have you seen
+any line like these?
+
+```ruby
 enable_bar = ENV.fetch("ENABLE_BAR", "false") == "true"
 foo_count = ENV.fetch("FOO_TOTAL", "100").to_i
 ```
 
-This works okay! And it's not really that complicated, working out what's going on here isn't
-that difficult. How about this?
+This works okay! And it's not really that complicated, working out what's going
+on here isn't that difficult. How about this?
 
-```
+```ruby
 enable_foo = ENV.fetch("ENABLE_FOO", "false") != "true"
 ```
 
-That.. looks very similar, but means the opposite thing. Also not that tricky. You don't start
-to _wish_ for a tool like EnvironmentHelpers until these constructions get complex and compounded.
-But.. if you're using a 12-factor style of configuration, you probably have these ENV-fetches
-sprinkled _everywhere_, so making them moderately clearer or simpler can pay off fairly quickly.
+That.. looks very similar, but means the opposite thing. Also not that tricky.
+You don't start to _wish_ for a tool like EnvironmentHelpers until these
+constructions get complex and compounded. But.. if you're using a 12-factor
+style of configuration, you probably have these ENV-fetches sprinkled
+_everywhere_, so making them moderately clearer or simpler can pay off fairly
+quickly.
 
 ## Installation
 
-```
+```ruby
 gem "environment_helper"
 ```
 
-There's not much to it - add the gem to your gemfile and when it's loaded it'll add some extra
-methods onto `ENV` for your use.
+There's not much to it - add the gem to your gemfile and when it's loaded it'll
+add some extra methods onto `ENV` for your use.
 
 ## Usage
 
-```shell
+```ruby
 ENV.string("APP_NAME", default: "local")
 ENV.symbol("BUSINESS_DOMAIN", default: :engineering, required: true)
 ENV.boolean("ENABLE_FEATURE_FOO", default: false)
@@ -38,29 +42,44 @@ 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,
-and then two optional named parameters `default` and `required` (there's no point in supplying
-both, but nothing stops you from doing so). The `default` value is the value used if the variable
-isn't present in the environment. If `required` is set to a truthy value, then if the variable isn't
-present in the environment, an `EnvironmentHelpers::MissingVariableError` is raised.
+Each of the supplied methods takes a positional parameter for the name of the
+environment variable, and then two optional named parameters `default` and
+`required` (there's no point in supplying both, but nothing stops you from doing
+so). The `default` value is the value used if the variable isn't present in the
+environment. If `required` is set to a truthy value, then if the variable isn't
+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
-  exception in each case.
+* `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 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/environment_helpers.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   DESC
   spec.homepage = "https://github.com/nevinera/environment_helpers"
   spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -30,7 +30,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "simplecov", "~> 0.22.0"
+  spec.add_development_dependency "rspec-cover_it", "~> 0.1.0"
   spec.add_development_dependency "pry", "~> 0.14"
   spec.add_development_dependency "standard", "~> 1.28"
   spec.add_development_dependency "rubocop", "~> 1.50"
+  spec.add_development_dependency "quiet_quality", "~> 1.3.0"
+  spec.add_development_dependency "mdl", "~> 0.12"
 end

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/enumerable_helpers.rb

@@ -0,0 +1,44 @@
+module EnvironmentHelpers
+  module EnumerableHelpers
+    VALID_TYPES = %i[strings symbols integers]
+
+    def array(key, of: :strings, delimiter: ",", default: nil, required: false)
+      check_default_type(:array, default, Array)
+      check_valid_data_type!(of)
+      check_default_data_types!(default, of)
+
+      values = fetch_value(key, required: required)
+      return default if values.nil?
+
+      values.split(delimiter).map { |value| value.send(TYPE_HANDLERS[of]) }
+    end
+
+    private
+
+    def check_valid_data_type!(type)
+      unless VALID_TYPES.include?(type)
+        fail(InvalidType, "Valid types: #{VALID_TYPES.join(", ")}. Got: #{type}.")
+      end
+    end
+
+    def check_default_data_types!(default, type)
+      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/version.rb

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

data/lib/environment_helpers.rb

@@ -9,17 +9,21 @@ 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)
   MissingVariableError = Class.new(Error)
   BadDefault = Class.new(Error)
+  BadFormat = Class.new(Error)
 
+  InvalidType = 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
@@ -28,6 +32,7 @@ module EnvironmentHelpers
   include NumericHelpers
   include FileHelpers
   include DatetimeHelpers
+  include EnumerableHelpers
 end
 
 ENV.extend(EnvironmentHelpers)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: environment_helpers
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-28 00:00:00.000000000 Z
+date: 2023-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: rspec-cover_it
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: quiet_quality
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 description: |
   Convenience helpers for more simply accessing data passed to applications through the
   environment that may have types and/or defaults
@@ -89,11 +131,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/lint.yml"
+- ".github/workflows/quality.yml"
 - ".github/workflows/rspec.yml"
 - ".gitignore"
+- ".mdl_rules.rb"
+- ".mdlrc"
+- ".quiet_quality.ci-cd.yml"
+- ".quiet_quality.yml"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -102,6 +149,7 @@ files:
 - lib/environment_helpers/access_helpers.rb
 - lib/environment_helpers/boolean_helpers.rb
 - lib/environment_helpers/datetime_helpers.rb
+- lib/environment_helpers/enumerable_helpers.rb
 - lib/environment_helpers/file_helpers.rb
 - lib/environment_helpers/numeric_helpers.rb
 - lib/environment_helpers/range_helpers.rb
@@ -121,14 +169,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A set of convenience methods for accessing environment data

data/.github/workflows/lint.yml

@@ -1,30 +0,0 @@
-name: Linters
-
-on: [push]
-
-jobs:
-  StandardRB:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.2
-
-      - name: Cache gems
-        uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-linters-${{ hashFiles('Gemfile.lock') }}
-          restore-keys:
-            ${{ runner.os }}-linters-
-      - name: Install gems
-        run: bundle install --jobs 4 --retry 3
-
-      - name: Run standard
-        run: bundle exec standardrb
-
-      - name: Run rubocop (complexity checks)
-        run: bundle exec rubocop --parallel