environment_helpers 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b923675b4ed251cc3ffe498b480923619622e9cb7a1ebbf2e3bde6bbae036e84
-  data.tar.gz: 63a23ba984f9f1e67c2e01651cc6d6d73538fc7e8eda26516b56e748209b2bd8
+  metadata.gz: 8909c0a7ad45e4fc50777d074086126849b1b9a3907ecae5f5b6c5fafd547c3a
+  data.tar.gz: 59f2b7b8cd84a28cc24b545fc240f5145a38b4d445a60f63ef35b881d6ee2c50
 SHA512:
-  metadata.gz: 7113d4d1727c3ffe4a1311c588105f5ebec6a9d877da6341ee4d5e12b998fbbb03bfd0543736dbacbdcb3fe38ebd19c4eb3eae5efe5b4352a86086dfadf47e53
-  data.tar.gz: 35228c708df18bce2b56c6779f6047da0c3eaf62d922010136779e9e5c958ae66a5002006f2888ebc25be014448ff6515311811f692a498c95075941fadc298e
+  metadata.gz: 744fa0ee02661aa41df2a0bee2b88af5402d0ab5dfefa77e93aeabfccb44186c68e79da151ea926b85a0608c9c903f1925e877362d6d7cfad43f5d3172b3dbdb
+  data.tar.gz: 56099bbc01ff6226b63fedab0ed108eccb65775550782e1635ece461985ad1817e99340a2cedd01be724ee50bbf2d9def8e2cad005d2ae7299750cd418fd9e3c

data/.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+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

data/.github/workflows/rspec.yml

@@ -0,0 +1,33 @@
+name: RSpec
+
+on: [push]
+
+jobs:
+  RSpec:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2', 'head']
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Cache gems
+        uses: actions/cache@v3
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-rspec-${{ matrix.ruby-version }}-${{ hashFiles('Gemfile.lock') }}
+          restore-keys:
+            ${{ runner.os }}-rspec-${{ matrix.ruby-version }}-
+
+      - name: Install gems
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Run RSpec
+        run: bundle exec rspec

data/.gitignore

@@ -1,3 +1,5 @@
 .ruby-version
 .ruby-gemset
 Gemfile.lock
+*.gem
+coverage/

data/.rubocop.yml

@@ -0,0 +1,21 @@
+---
+AllCops:
+  SuggestExtensions: false
+  DisabledByDefault: true
+
+Metrics/AbcSize:
+  Max: 15
+Metrics/CyclomaticComplexity:
+  Max: 8
+Metrics/PerceivedComplexity:
+  Max: 7
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 150
+Metrics/MethodLength:
+  CountComments: false
+  Max: 15
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Eric Mueller
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -35,6 +35,7 @@ ENV.string("APP_NAME", default: "local")
 ENV.symbol("BUSINESS_DOMAIN", default: :engineering, required: true)
 ENV.boolean("ENABLE_FEATURE_FOO", default: false)
 ENV.integer("MAX_THREAD_COUNT", default: 5)
+ENV.date("SCHEDULED_DATE", required: true, format: "%Y-%m-%d")
 ```
 
 Each of the supplied methods takes a positional parameter for the name of the environment variable,
@@ -53,3 +54,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`.
+* `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.

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.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -28,8 +28,9 @@ Gem::Specification.new do |spec|
   spec.executables = []
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rspec", ">= 3.10"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "standard"
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "simplecov", "~> 0.22.0"
+  spec.add_development_dependency "pry", "~> 0.14"
+  spec.add_development_dependency "standard", "~> 1.28"
+  spec.add_development_dependency "rubocop", "~> 1.50"
 end

data/lib/environment_helpers/boolean_helpers.rb

@@ -1,5 +1,3 @@
-require "set"
-
 module EnvironmentHelpers
   module BooleanHelpers
     TRUTHY_STRINGS = %w[true yes on enabled enable allow t y 1 ok okay].to_set
@@ -7,10 +5,9 @@ module EnvironmentHelpers
     BOOLEAN_VALUES = [true, false, nil].to_set
 
     def boolean(name, default: nil, required: false)
-      check_default_value(:boolean, default, allow: [nil, true, false])
+      check_default_value(:boolean, default, allow: BOOLEAN_VALUES)
       text = fetch_value(name, required: required)
 
-      return default if text.nil?
       return true if truthy_text?(text)
       return false if falsey_text?(text)
 

data/lib/environment_helpers/datetime_helpers.rb

@@ -0,0 +1,24 @@
+require "date"
+
+module EnvironmentHelpers
+  module DatetimeHelpers
+    def date(name, format: "%Y-%m-%d", default: nil, required: false)
+      check_default_type(:date, default, Date)
+      text = fetch_value(name, required: required)
+      date = parse_date_from(text, format: format)
+
+      return date if date
+      return default unless required
+      fail(InvalidDateText, "Required date environment variable #{name} had inappropriate content '#{text}'")
+    end
+
+    private
+
+    def parse_date_from(text, format:)
+      return nil if text.nil?
+      Date.strptime(text, format)
+    rescue ArgumentError
+      nil
+    end
+  end
+end

data/lib/environment_helpers/version.rb

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

data/lib/environment_helpers.rb

@@ -2,6 +2,7 @@ require_relative "./environment_helpers/access_helpers"
 require_relative "./environment_helpers/string_helpers"
 require_relative "./environment_helpers/boolean_helpers"
 require_relative "./environment_helpers/numeric_helpers"
+require_relative "./environment_helpers/datetime_helpers"
 
 module EnvironmentHelpers
   Error = Class.new(::StandardError)
@@ -11,11 +12,13 @@ module EnvironmentHelpers
   InvalidValue = Class.new(Error)
   InvalidBooleanText = Class.new(InvalidValue)
   InvalidIntegerText = Class.new(InvalidValue)
+  InvalidDateText = Class.new(InvalidValue)
 
   include AccessHelpers
   include StringHelpers
   include BooleanHelpers
   include NumericHelpers
+  include DatetimeHelpers
 end
 
 ENV.extend(EnvironmentHelpers)

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: environment_helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Eric Mueller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.50'
 description: |
   Convenience helpers for more simply accessing data passed to applications through the
   environment that may have types and/or defaults
@@ -75,14 +89,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/lint.yml"
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
+- LICENSE
 - README.md
 - environment_helpers.gemspec
 - lib/environment_helpers.rb
 - lib/environment_helpers/access_helpers.rb
 - lib/environment_helpers/boolean_helpers.rb
+- lib/environment_helpers/datetime_helpers.rb
 - lib/environment_helpers/numeric_helpers.rb
 - lib/environment_helpers/string_helpers.rb
 - lib/environment_helpers/version.rb
@@ -100,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="