env_vars 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55e64c1a12f68fdce3e66fbf0fe6206bf30d5efa934f79a813c83ad49d5642ba
-  data.tar.gz: 9fbc815998275bcdd4fc6a23f6fb7be0f856fdae42abe7b4795c56d46803c793
+  metadata.gz: e32d97f4e650d16b8c82ec8dd85bc19112788797262c00425e83a1d8594678f3
+  data.tar.gz: ebec12747a93d37dbeadf026ec1140dbcb1122eca498db9db7f5612221868cc4
 SHA512:
-  metadata.gz: c5bc9f04749be125c623730228c0ea332cb0645636a9f0c5415d32f02ba287970713b0cc3f03e582afaace73b7bd8721579b4f6caf2be629f1fe72b76f46f806
-  data.tar.gz: 2d2631747255512e9794a4fc3f3638622995e28a78d725fd31b4b2b3d1457bd4be2434aa0dde4bb286eca5dc6092dc8172759556184a469e8c902d61b195d007
+  metadata.gz: c6822500b56e48d42f508d128e505b288133724996a926dab44ecb6e43b8373ee6ea177faa6b30a21e48a3e2e2f9eb980d950140f1beca0447d6475aa1ce48ea
+  data.tar.gz: b4240b420772985e2c3403a7a5abd047b0b8bc8dfc0500340ef3a1e187dea6e181df0bbb4cea52652603c3bc04046b2cde98e85dda48d888067c8305070f1370

data/.rubocop.yml

@@ -0,0 +1,15 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false

data/.travis.yml

@@ -4,13 +4,15 @@ sudo: false
 notifications:
   email: false
 rvm:
-- 2.5.3
+  - 2.7.1
 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"
+  - "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 --exit-code $TRAVIS_TEST_RESULT"
+  - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 env:
   global:
     secure: dXC3R4mvHkeXyhKskgf5/3/LUtBYKpDcTpNGbuOpnoXAaB87fHgjhDtwSazYERE5i0FYeMHWBWKUosQZkCOCydXCuZQ7Q1AnqjnouiCoaj675uvs/KamRAoknQVzxbSk5nxSiqth2fMDu6DTm8ZcbAXkCJj3JwNe0x/zZrx6ZfqEj928NdL2qxTbGLciFyovjhjwIx5ZNKJ+LlvwZ5uGdaGJvN1K7xuATcrRFyyPRzd0oPGFJb7pBwbkK0VxmdTMKcCnXmovoIIZPsXCMW1zvfE30McrCOyHrE/4OQWFI0FG7QJAzM3ekioWQj94JRkno3NPflTWBqn+tSQmjgKkSuooJQgbJ0eWAD0uU2JBebjrXx4/AvWlUiB4mG4u7OGUbq8TbY2EHhqb5JtTuAo3qy/D5xUtZaSISD70sQqfE6ZdjVlBaC9hDSATYXNyiUYGihslEUySmCqH94ZBkm1c5CKDPm1bnBs8eyzI2NqO6EA/yf8/U97fGKI1EmjNQm888MIgbgSeKlWfc6EonWMxlaZ8SG/J4cFx43nlUPPmP/q488wKz8qaCeVpvuX29mN+8LQmQT0zQlVNZIHfI64tIcdE8kvK/vu+9iq7UlPim2VPNf8B9aHX67NUli0FVo2acvCgivIcZ75YJFSCmy8IhNX/XaJD5AdQgVmwP0A/uk0=

data/Gemfile

@@ -1,2 +1,4 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -39,7 +39,8 @@ Config.timeout
 Config.force_ssl?
 ```
 
-You can specify the description for both `mandatory` and `optional` methods; this will be used in exceptions.
+You can specify the description for both `mandatory` and `optional` methods;
+this will be used in exceptions.
 
 ```ruby
 Config = Env::Vars.new do
@@ -49,7 +50,8 @@ 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:
+If you're going to use `env_vars` as your main configuration object, you can
+also set arbitrary properties, like the following:
 
 ```ruby
 Config = Env::Vars.new do
@@ -63,7 +65,8 @@ Config.redis.get("key")
 #=> "value"
 ```
 
-Values are cached by default. If you want to dynamically generate new values, set `cache: false`.
+Values are cached by default. If you want to dynamically generate new values,
+set `cache: false`.
 
 ```ruby
 Config = Env::Vars.new do
@@ -71,7 +74,10 @@ 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.
+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
@@ -89,13 +95,20 @@ You can coerce values to the following types:
 - `int`: E.g. `optional :timeout, int`.
 - `float`: E.g. `optional :wait, float`.
 - `bigdecimal`: E.g. `optional :fee, bigdecimal`.
-- `bool`: E.g. `optional :force_ssl, bool`. Any of `yes`, `true` or `1` is considered as `true`. Any other value will be coerced to `false`.
+- `bool`: E.g. `optional :force_ssl, bool`. Any of `yes`, `true` or `1` is
+  considered as `true`. Any other value will be coerced to `false`.
 - `symbol`: E.g. `optional :app_name, symbol`.
-- `array`: E.g. `optional :chars, array` or `optional :numbers, array(int)`. The environment variable must be something like `a,b,c`.
+- `array`: E.g. `optional :chars, array` or `optional :numbers, array(int)`. The
+  environment variable must be something like `a,b,c`.
+- `json`: E.g. `mandatory :keyring, json`. The environment variable must be
+  parseable by `JSON.parse(content)`.
 
 ### Dotenv integration
 
-If you're using [dotenv](https://rubygems.org/gems/dotenv), you can simply require `env_vars/dotenv`. This will load environment variables from `.env.local.%{environment}`, `.env.local`, `.env.%{environment}` and `.env` files, respectively. You _must_ add `dotenv` to your `Gemfile`.
+If you're using [dotenv](https://rubygems.org/gems/dotenv), you can simply
+require `env_vars/dotenv`. This will load environment variables from
+`.env.local.%{environment}`, `.env.local`, `.env.%{environment}` and `.env`
+files, respectively. You _must_ add `dotenv` to your `Gemfile`.
 
 ```ruby
 require "env_vars/dotenv"
@@ -103,7 +116,9 @@ require "env_vars/dotenv"
 
 ### Configuring Rails
 
-If you want to use `env_vars` even on your Rails configuration files like `database.yml` and `secrets.yml`, you must load it from `config/boot.rb`, right after setting up Bundler.
+If you want to use `env_vars` even on your Rails configuration files like
+`database.yml` and `secrets.yml`, you must load it from `config/boot.rb`, right
+after setting up Bundler.
 
 ```ruby
 ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
@@ -118,18 +133,29 @@ require File.expand_path("../config", __FILE__)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/env_vars. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/fnando/env_vars. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
 
 ## Icon
 
-Icon made by [eucalyp](https://www.flaticon.com/authors/eucalyp) from [Flaticon](https://www.flaticon.com/) is licensed by Creative Commons BY 3.0.
+Icon made by [eucalyp](https://www.flaticon.com/authors/eucalyp) from
+[Flaticon](https://www.flaticon.com/) is licensed by Creative Commons BY 3.0.

data/Rakefile

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -7,4 +10,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/env_vars.gemspec

@@ -1,4 +1,6 @@
-require File.expand_path("../lib/env_vars", __FILE__)
+# frozen_string_literal: true
+
+require_relative "./lib/env_vars"
 
 Gem::Specification.new do |spec|
   spec.name          = "env_vars"
@@ -6,12 +8,15 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Nando Vieira"]
   spec.email         = ["fnando.vieira@gmail.com"]
 
-  spec.summary       = "Access environment variables. Also includes presence validation, type coercion and default values."
+  spec.summary       = "Access environment variables. Also includes presence " \
+                       "validation, type coercion and default values."
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/fnando/env_vars"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject {|f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 

data/lib/env_vars.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Env
   class Vars
-    VERSION = "1.0.0"
-    BOOL_TRUE = ["yes", "true", "1", true]
-    BOOL_FALSE = ["no", "false"]
+    VERSION = "1.1.0"
+    BOOL_TRUE = ["yes", "true", "1", true].freeze
+    BOOL_FALSE = %w[no false].freeze
 
     MissingEnvironmentVariable = Class.new(StandardError)
     MissingCallable = Class.new(StandardError)
@@ -18,9 +20,16 @@ module Env
     def to_s
       "#<Env::Vars>"
     end
-    alias_method :inspect, :to_s
+    alias inspect to_s
 
-    def set(name, type, default = nil, required: false, aliases: [], description: nil)
+    def set(
+      name,
+      type,
+      default = nil,
+      required: false,
+      aliases: [],
+      description: nil
+    )
       name = name.to_s
       env_var = name.upcase
       name = "#{name}?" if type == bool
@@ -29,6 +38,7 @@ module Env
 
       define_singleton_method(name) do
         return default unless @env.key?(env_var)
+
         coerce(type, @env[env_var])
       end
 
@@ -53,16 +63,25 @@ module Env
     end
 
     def mandatory(name, type, aliases: [], description: nil)
-      set(name, type, required: true, aliases: aliases, description: description)
+      set(
+        name,
+        type,
+        required: true,
+        aliases: aliases,
+        description: description
+      )
     end
 
     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, description: nil, &block)
+    def property(name, func = nil, cache: true, description: nil, &block) # rubocop:disable Lint/UnusedMethodArgument
       callable = (func || block)
-      raise MissingCallable, "arg[1] must respond to #call or pass a block" unless callable
+
+      unless callable
+        raise MissingCallable, "arg[1] must respond to #call or pass a block"
+      end
 
       if cache
         define_singleton_method(name) do
@@ -102,37 +121,43 @@ module Env
       [:array, type]
     end
 
-    private
+    def json
+      :json
+    end
 
-    def coerce_to_string(value)
+    private def coerce_to_string(value)
       value
     end
 
-    def coerce_to_bool(value)
+    private def coerce_to_bool(value)
       BOOL_TRUE.include?(value)
     end
 
-    def coerce_to_int(value)
+    private def coerce_to_int(value)
       Integer(value) if !BOOL_FALSE.include?(value) && value
     end
 
-    def coerce_to_float(value)
+    private def coerce_to_float(value)
       Float(value) if value
     end
 
-    def coerce_to_bigdecimal(value)
+    private def coerce_to_bigdecimal(value)
       BigDecimal(value) if value
     end
 
-    def coerce_to_symbol(value)
-      value && value.to_sym
+    private def coerce_to_symbol(value)
+      value&.to_sym
+    end
+
+    private def coerce_to_array(value, type)
+      value&.split(/, */)&.map {|v| coerce(type, v) }
     end
 
-    def coerce_to_array(value, type)
-      value && value.split(/, */).map {|v| coerce(type, v) }
+    private def coerce_to_json(value)
+      value && JSON.parse(value)
     end
 
-    def coerce(type, value)
+    private def coerce(type, value)
       main_type, sub_type = type
       args = [value]
       args << sub_type if sub_type

data/lib/env_vars/dotenv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "env_vars"
 require "dotenv"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_vars
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -118,7 +119,7 @@ homepage: https://github.com/fnando/env_vars
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,9 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Access environment variables. Also includes presence validation, type coercion
   and default values.