env_vars 0.7.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98c2331515d4258aaedc545a8ad0b0a07066cdde4a25acca769c63bf363f100b
-  data.tar.gz: 9f20421613e79218f8b9893573a6274bf7a0092465a6bed48c08508e368acfd7
+  metadata.gz: 55e64c1a12f68fdce3e66fbf0fe6206bf30d5efa934f79a813c83ad49d5642ba
+  data.tar.gz: 9fbc815998275bcdd4fc6a23f6fb7be0f856fdae42abe7b4795c56d46803c793
 SHA512:
-  metadata.gz: 4c1a8f444de98588e0557fb6e75f9cd1db98a710f003531009ead659c2258bb433527b9d509b20f0e42ba5993ca801a3cbcd124c88ee1e16c07d37af847e26f7
-  data.tar.gz: a731552d861def65acf523f384afefcf828c17d83e321123b8f1b143214436ba89329ac9533959892011001d4b71bc30c97834c3b26bc6b1022e4839fb4224aa
+  metadata.gz: c5bc9f04749be125c623730228c0ea332cb0645636a9f0c5415d32f02ba287970713b0cc3f03e582afaace73b7bd8721579b4f6caf2be629f1fe72b76f46f806
+  data.tar.gz: 2d2631747255512e9794a4fc3f3638622995e28a78d725fd31b4b2b3d1457bd4be2434aa0dde4bb286eca5dc6092dc8172759556184a469e8c902d61b195d007

data/.travis.yml

@@ -4,16 +4,13 @@ sudo: false
 notifications:
   email: false
 rvm:
-- 2.5.2
-- 2.4.2
-- 2.3.8
-before_install: gem install bundler
+- 2.5.3
 before_script:
 - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
 - chmod +x ./cc-test-reporter
 - "./cc-test-reporter before-build"
 after_script:
-- "./cc-test-reporter after-build --coverage-input-type simplecov --exit-code $TRAVIS_TEST_RESULT"
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 env:
   global:
-    secure: cdMMHvDQelzd4Z/7EMaC02s3Ef8TnEO3L6d4C/zfkJt7GjTJqptnqja+F2EcTmdSFs8zM0QHWgB3umfzBtiR2swXJ81c19owqdoxpmo2sOTJNQeRpfkRqngw7VW0RpoUQBWmrbPjK1xV6EJAM38U0TqhO5WR5uhKKNDJgnmWrIITaSkuo0r/b6Hia5iIIRCDqgXzuEYbx3wYKwn/7aYjpoXq3mPpS8L4AuzG2qjTTyLNBqhFPrhENuu4Hu9Bjj6ziyPUCM2cvrxP43smy7UvCmnr21hT9mDQnsaw6WvW4qReHgLtbckoK1Fky5YuU74R8JnYBqIi9sTjs19z10xdhxwJmCI1p4RaKsEoYWTV2geHK3rD0gXgtZqc8hWMfMmpz0U+TmVTuMmLatdaYglCUuSfgL7KPyCji9k1yMP4jEmjxYTukY9nwhAEvbSMBCiHadW1nEhffgYH2alZr1CxxRi/UKUTE10kxHni8OILuWP7VgFOs0qeS0HEmo+PYXQSOXMEBb76YtahmD+c4iPYJMA3wD6TR71MEvu+MIn3PLQcte2OWhoBsd+9knbus693Bb7MESCk857+vm3fwdbApC945ABGUTSfv2IR74nlNRY2I4fAcJCXhhsKyNh95QPa/sDoKnL2XgNlYsWYxBTa8h7ZxI0YVnlc13U4A1SaRLo=
+    secure: dXC3R4mvHkeXyhKskgf5/3/LUtBYKpDcTpNGbuOpnoXAaB87fHgjhDtwSazYERE5i0FYeMHWBWKUosQZkCOCydXCuZQ7Q1AnqjnouiCoaj675uvs/KamRAoknQVzxbSk5nxSiqth2fMDu6DTm8ZcbAXkCJj3JwNe0x/zZrx6ZfqEj928NdL2qxTbGLciFyovjhjwIx5ZNKJ+LlvwZ5uGdaGJvN1K7xuATcrRFyyPRzd0oPGFJb7pBwbkK0VxmdTMKcCnXmovoIIZPsXCMW1zvfE30McrCOyHrE/4OQWFI0FG7QJAzM3ekioWQj94JRkno3NPflTWBqn+tSQmjgKkSuooJQgbJ0eWAD0uU2JBebjrXx4/AvWlUiB4mG4u7OGUbq8TbY2EHhqb5JtTuAo3qy/D5xUtZaSISD70sQqfE6ZdjVlBaC9hDSATYXNyiUYGihslEUySmCqH94ZBkm1c5CKDPm1bnBs8eyzI2NqO6EA/yf8/U97fGKI1EmjNQm888MIgbgSeKlWfc6EonWMxlaZ8SG/J4cFx43nlUPPmP/q488wKz8qaCeVpvuX29mN+8LQmQT0zQlVNZIHfI64tIcdE8kvK/vu+9iq7UlPim2VPNf8B9aHX67NUli0FVo2acvCgivIcZ75YJFSCmy8IhNX/XaJD5AdQgVmwP0A/uk0=

data/README.md

@@ -39,6 +39,16 @@ Config.timeout
 Config.force_ssl?
 ```
 
+You can specify the description for both `mandatory` and `optional` methods; this will be used in exceptions.
+
+```ruby
+Config = Env::Vars.new do
+  mandatory :missing_var, string, description: "this is important"
+end
+
+#=> Env::Vars::MissingEnvironmentVariable: MISSING_VAR (this is important) is not defined
+```
+
 If you're going to use `env_vars` as your main configuration object, you can also set arbitrary properties, like the following:
 
 ```ruby
@@ -61,6 +71,16 @@ Config = Env::Vars.new do
 end
 ```
 
+You may want to start a debug session without raising exceptions for missing variables. In this case, just pass `raise_exception: false` instead to log error messages to `$stderr`. This is especially great with Rails' credentials command (`rails credentials:edit`) when already defined the configuration.
+
+```ruby
+Config = Env::Vars.new(raise_exception: false) do
+  mandatory :database_url, string, description: "the leader database"
+end
+
+#=> [ENV_VARS] DATABASE_URL (the leader database) is not defined
+```
+
 ### Types
 
 You can coerce values to the following types:

data/env_vars.gemspec

@@ -16,8 +16,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "simplecov"
 end

data/env_vars.svg

@@ -1,22 +1,20 @@
 <svg xmlns="http://www.w3.org/2000/svg" width="300" height="300" viewBox="0 0 300 300">
   <g fill="none" fill-rule="evenodd">
     <rect width="155" height="63" x="73" y="92" fill="#9013FE"/>
+    <rect width="154.839" height="9.714" x="72.581" y="126.286" fill="#000"/>
+    <rect width="62.903" height="9.714" x="164.516" y="145.714" fill="#000"/>
+    <rect width="62.903" height="9.714" x="72.581" y="145.714" fill="#000"/>
+    <rect width="62.903" height="9.714" x="164.516" y="106.857" fill="#000"/>
+    <rect width="62.903" height="9.714" x="72.581" y="106.857" fill="#000"/>
+    <rect width="154.839" height="9.714" x="72.581" y="87.429" fill="#000"/>
+    <path fill="#000" fill-rule="nonzero" d="M283.483871,0 L14.516129,0 C6.51290323,0 0,6.53771429 0,14.5714286 L0,238 L217.741935,238 L217.741935,228.285714 L9.67741935,228.285714 L9.67741935,48.5714286 L290.322581,48.5714286 L290.322581,228.285714 L217.741935,228.285714 L217.741935,238 L300,238 L300,14.5714286 C300,6.53771429 291.487097,0 283.483871,0 Z M9.67741935,38.8571429 L9.67741935,14.5714286 C9.67741935,11.8951429 11.85,9.71428571 14.516129,9.71428571 L285.483871,9.71428571 C288.15,9.71428571 290.322581,11.8951429 290.322581,14.5714286 L290.322581,38.8571429 L9.67741935,38.8571429 Z"/>
     <path fill="#9013FE" d="M163.908393,300 L137.091607,300 L134.078214,287.931964 C130.211429,286.789286 126.479643,285.236786 122.92625,283.303393 L112.251607,289.70625 L93.29375,270.748393 L99.6966071,260.07375 C97.7632143,256.520357 96.2107143,252.78375 95.0680357,248.921786 L83,245.908393 L83,219.091607 L95.0680357,216.078214 C96.2107143,212.211429 97.7632143,208.479643 99.6966071,204.92625 L93.29375,194.251607 L112.251607,175.29375 L122.92625,181.696607 C126.479643,179.763214 130.21625,178.210714 134.078214,177.068036 L137.091607,165 L163.908393,165 L166.921786,177.068036 C170.788571,178.210714 174.520357,179.763214 178.07375,181.696607 L188.748393,175.29375 L207.70625,194.251607 L201.303393,204.92625 C203.236786,208.479643 204.789286,212.21625 205.931964,216.078214 L218,219.091607 L218,245.908393 L205.931964,248.921786 C204.789286,252.788571 203.236786,256.520357 201.303393,260.07375 L207.70625,270.748393 L188.748393,289.70625 L178.07375,283.303393 C174.520357,285.236786 170.78375,286.789286 166.921786,287.931964 L163.908393,300 Z"/>
-    <g fill="#000">
-      <rect width="154.839" height="9.714" x="72.581" y="126.286"/>
-      <rect width="62.903" height="9.714" x="164.516" y="145.714"/>
-      <rect width="62.903" height="9.714" x="72.581" y="145.714"/>
-      <rect width="62.903" height="9.714" x="164.516" y="106.857"/>
-      <rect width="62.903" height="9.714" x="72.581" y="106.857"/>
-      <rect width="154.839" height="9.714" x="72.581" y="87.429"/>
-      <path fill-rule="nonzero" d="M150,213.714286 C139.325806,213.714286 130.645161,222.428 130.645161,233.142857 C130.645161,243.857714 139.325806,252.571429 150,252.571429 C160.674194,252.571429 169.354839,243.857714 169.354839,233.142857 C169.354839,222.428 160.674194,213.714286 150,213.714286 Z M150,242.857143 C144.662903,242.857143 140.322581,238.500286 140.322581,233.142857 C140.322581,227.785429 144.662903,223.428571 150,223.428571 C155.337097,223.428571 159.677419,227.785429 159.677419,233.142857 C159.677419,238.500286 155.337097,242.857143 150,242.857143 Z"/>
-      <path d="M150 194.285714C143.574194 194.285714 137.201613 195.903143 131.579032 198.958286L136.190323 207.502C140.404839 205.214286 145.175806 204 150 204 166.01129 204 179.032258 217.070571 179.032258 233.142857 179.032258 237.985429 177.822581 242.774571 175.543548 247.005143L184.054839 251.634C187.098387 245.99 188.709677 239.593143 188.709677 233.142857 188.709677 211.718 171.343548 194.285714 150 194.285714zM150 262.285714C133.98871 262.285714 120.967742 249.215143 120.967742 233.142857 120.967742 228.300286 122.177419 223.511143 124.456452 219.280571L115.945161 214.651714C112.901613 220.295714 111.290323 226.692571 111.290323 233.142857 111.290323 254.567714 128.656452 272 150 272 156.425806 272 162.798387 270.382571 168.420968 267.327429L163.809677 258.783714C159.595161 261.071429 154.824194 262.285714 150 262.285714z"/>
-      <path fill-rule="nonzero" d="M285.483871,0 L14.516129,0 C6.51290323,0 0,6.53771429 0,14.5714286 L0,238 L82.2580645,238 L82.2580645,228.285714 L9.67741935,228.285714 L9.67741935,48.5714286 L290.322581,48.5714286 L290.322581,228.285714 L217.741935,228.285714 L217.741935,238 L300,238 L300,14.5714286 C300,6.53771429 293.487097,0 285.483871,0 Z M9.67741935,38.8571429 L9.67741935,14.5714286 C9.67741935,11.8951429 11.85,9.71428571 14.516129,9.71428571 L285.483871,9.71428571 C288.15,9.71428571 290.322581,11.8951429 290.322581,14.5714286 L290.322581,38.8571429 L9.67741935,38.8571429 Z"/>
-      <rect width="9.677" height="9.714" x="19.355" y="19.429"/>
-      <rect width="9.677" height="9.714" x="38.71" y="19.429"/>
-      <rect width="9.677" height="9.714" x="58.065" y="19.429"/>
-      <polygon points="45 187.289 45 60 68.99 60 68.99 73.227 58.504 73.694 58.504 173.439 68.99 174.062 68.99 187.289"/>
-      <polygon points="255.99 187.412 232 187.412 232 174.277 242.486 173.658 242.486 74.599 232 74.136 232 61 255.99 61"/>
-    </g>
+    <path fill="#000" fill-rule="nonzero" d="M150,213.714286 C139.325806,213.714286 130.645161,222.428 130.645161,233.142857 C130.645161,243.857714 139.325806,252.571429 150,252.571429 C160.674194,252.571429 169.354839,243.857714 169.354839,233.142857 C169.354839,222.428 160.674194,213.714286 150,213.714286 Z M150,242.857143 C144.662903,242.857143 140.322581,238.500286 140.322581,233.142857 C140.322581,227.785429 144.662903,223.428571 150,223.428571 C155.337097,223.428571 159.677419,227.785429 159.677419,233.142857 C159.677419,238.500286 155.337097,242.857143 150,242.857143 Z"/>
+    <path fill="#000" d="M150 194.285714C143.574194 194.285714 137.201613 195.903143 131.579032 198.958286L136.190323 207.502C140.404839 205.214286 145.175806 204 150 204 166.01129 204 179.032258 217.070571 179.032258 233.142857 179.032258 237.985429 177.822581 242.774571 175.543548 247.005143L184.054839 251.634C187.098387 245.99 188.709677 239.593143 188.709677 233.142857 188.709677 211.718 171.343548 194.285714 150 194.285714zM150 262.285714C133.98871 262.285714 120.967742 249.215143 120.967742 233.142857 120.967742 228.300286 122.177419 223.511143 124.456452 219.280571L115.945161 214.651714C112.901613 220.295714 111.290323 226.692571 111.290323 233.142857 111.290323 254.567714 128.656452 272 150 272 156.425806 272 162.798387 270.382571 168.420968 267.327429L163.809677 258.783714C159.595161 261.071429 154.824194 262.285714 150 262.285714z"/>
+    <rect width="9.677" height="9.714" x="19.355" y="19.429" fill="#000"/>
+    <rect width="9.677" height="9.714" x="38.71" y="19.429" fill="#000"/>
+    <rect width="9.677" height="9.714" x="58.065" y="19.429" fill="#000"/>
+    <polygon fill="#000" points="45 187.289 45 60 68.99 60 68.99 73.227 58.504 73.694 58.504 173.439 68.99 174.062 68.99 187.289"/>
+    <polygon fill="#000" points="255.99 187.412 232 187.412 232 174.277 242.486 173.658 242.486 74.599 232 74.136 232 61 255.99 61"/>
   </g>
 </svg>

data/lib/env_vars.rb

@@ -1,16 +1,16 @@
-# frozen_string_literal: true
-
 module Env
   class Vars
-    VERSION = "0.7.1"
+    VERSION = "1.0.0"
     BOOL_TRUE = ["yes", "true", "1", true]
     BOOL_FALSE = ["no", "false"]
 
     MissingEnvironmentVariable = Class.new(StandardError)
     MissingCallable = Class.new(StandardError)
 
-    def initialize(env = ENV, &block)
+    def initialize(env: ENV, raise_exception: true, stderr: $stderr, &block)
       @env = env
+      @raise_exception = raise_exception
+      @stderr = stderr
       @__cache__ = {}
       instance_eval(&block)
     end
@@ -20,12 +20,12 @@ module Env
     end
     alias_method :inspect, :to_s
 
-    def set(name, type, default = nil, required: false, aliases: [])
+    def set(name, type, default = nil, required: false, aliases: [], description: nil)
       name = name.to_s
       env_var = name.upcase
       name = "#{name}?" if type == bool
 
-      validate!(env_var, required)
+      validate!(env_var, required, description)
 
       define_singleton_method(name) do
         return default unless @env.key?(env_var)
@@ -37,20 +37,30 @@ module Env
       end
     end
 
-    def validate!(env_var, required)
+    def validate!(env_var, required, description)
       return unless required
-      raise MissingEnvironmentVariable, "#{env_var} is not defined" unless @env.key?(env_var)
+      return if @env.key?(env_var)
+
+      message = env_var.to_s
+      message << " (#{description})" if description
+      message << " is not defined."
+
+      raise MissingEnvironmentVariable, message if @raise_exception
+
+      message = "[ENV_VARS] #{message}"
+      message = "\e[31m#{message}\e[0m" if @stderr.tty?
+      @stderr << message << "\n"
     end
 
-    def mandatory(name, type, aliases: [])
-      set(name, type, required: true, aliases: aliases)
+    def mandatory(name, type, aliases: [], description: nil)
+      set(name, type, required: true, aliases: aliases, description: description)
     end
 
-    def optional(name, type, default = nil, aliases: [])
-      set(name, type, default, aliases: aliases)
+    def optional(name, type, default = nil, aliases: [], description: nil)
+      set(name, type, default, aliases: aliases, description: description)
     end
 
-    def property(name, func = nil, cache: true, &block)
+    def property(name, func = nil, cache: true, description: nil, &block)
       callable = (func || block)
       raise MissingCallable, "arg[1] must respond to #call or pass a block" unless callable
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_vars
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-utils
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="