superconfig 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75ba7c940329c14aed30b1442f6e78b50286adbd42ccc0f1110d8923ee2b8ef3
-  data.tar.gz: 39430ed39dbc947935dee8705b52e52179f480867008f25b02f664fe47019581
+  metadata.gz: fbd7451e326a63df725764a9e0b29dec045b330b499eefefe40437808e0049b0
+  data.tar.gz: bfa6173594fe005b5a379e3208aaa2df3495ce9abbd25a25d443c8df282a97c9
 SHA512:
-  metadata.gz: cb45a0fabec9816865b7635fa3bba29bd879f3b55997fa2dedb4703c3e7440774cb3e1c5d07421389fbdc04b27147954317ceabdc70b9695154aaee336d0b1f6
-  data.tar.gz: d19ec7430c5780af73cf2d7d8f51608dbff7f4f3f40cb7eb7923769af2ddf6f4352428d044002a0cd4df2eb0290e42d3a86cbd6ba3b11fef596e98e6d54565a2
+  metadata.gz: e02df280e20253019f4f5d1e2c36df847c48e7057976371b6dd03ad19b873c42c9d2eba90d11a48a4e8cdd7059a7c488e6a986711ebe771d9380f115b96ebc01
+  data.tar.gz: 9151d646da85061a80cad78aa9ea58391319550e5d72afcf8a7793ebd40ed6f37f0af22932de46f309009fe14c8e6e597e07535a4ee3d2d377b2e983d94fef01

data/.github/workflows/ruby-tests.yml

@@ -2,8 +2,10 @@
 name: ruby-tests
 
 on:
-  pull_request:
+  pull_request_target:
   push:
+    branches:
+      - main
   workflow_dispatch:
     inputs: {}
 
@@ -11,23 +13,28 @@ jobs:
   build:
     name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
     runs-on: "ubuntu-latest"
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0"]
+        ruby: ["2.7", "3.0", "3.1"]
         gemfile:
           - Gemfile
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: vendor/bundle
           key: >
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }}
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
           restore-keys: >
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }}
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1

data/.rubocop.yml

@@ -7,6 +7,3 @@ AllCops:
   NewCops: enable
   Exclude:
     - vendor/**/*
-
-Metrics:
-  Enabled: false

data/CHANGELOG.md

@@ -11,6 +11,10 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
-## v1.0.0 - 2021-12-07
+## v2.0.1
 
-- Initial release as SuperConfig (previously known as env_vars).
+- [Changed] Ensure bad JSON strings doesn't leak it's contents.
+
+## v2.0.0
+
+- Initial release.

data/README.md

@@ -1,7 +1,7 @@
 ![SuperConfig: Access environment variables. Also includes presence validation, type coercion and default values.](https://raw.githubusercontent.com/fnando/superconfig/main/superconfig.png)
 
 <p align="center">
-  <a href="https://github.com/fnando/superconfig/actions/workflows/tests.yml"><img src="https://github.com/fnando/superconfig/workflows/Tests/badge.svg" alt="Github Actions"></a>
+  <a href="https://github.com/fnando/superconfig/actions/workflows/ruby-tests.yml"><img src="https://github.com/fnando/superconfig/workflows/ruby-tests/badge.svg" alt="Github Actions"></a>
   <a href="https://codeclimate.com/github/fnando/superconfig"><img src="https://codeclimate.com/github/fnando/superconfig/badges/gpa.svg" alt="Code Climate"></a>
   <a href="https://rubygems.org/gems/superconfig"><img src="https://img.shields.io/gem/v/superconfig.svg" alt="Gem"></a>
   <a href="https://rubygems.org/gems/superconfig"><img src="https://img.shields.io/gem/dt/superconfig.svg" alt="Gem"></a>
@@ -118,6 +118,47 @@ You can coerce values to the following types:
 - `json`: E.g. `mandatory :keyring, json`. The environment variable must be
   parseable by `JSON.parse(content)`.
 
+### Report
+
+Sometimes it gets hard to understand what's set and what's not. In this case,
+you can get a report by calling `SuperConfig::Base#report`. If you're using
+Rails, you can create a rake task like this:
+
+```ruby
+# frozen_string_literal: true
+
+desc "Show SuperConfig report"
+task superconfig: [:environment] do
+  puts YourAppNamespace::Config.report
+end
+```
+
+Then, change your configuration so it doesn't raise an exception.
+
+```ruby
+# frozen_string_literal: true
+# file: config/config.rb
+
+module YourAppNamespace
+  Config = SuperConfig.new(raise_exception: false) do
+    mandatory :database_url, string
+    optional :app_name, string
+    optional :wait, string
+    optional :force_ssl, bool, true
+  end
+end
+```
+
+Finally, run the following command:
+
+```console
+$ rails superconfig
+❌ DATABASE_URL is not set (mandatory)
+✅ APP_NAME is set (optional)
+⚠️ WAIT is not set (optional)
+✅ FORCE_SSL is not set, but has default value (optional)
+```
+
 ### Dotenv integration
 
 If you're using [dotenv](https://rubygems.org/gems/dotenv), you can simply

data/lib/superconfig.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SuperConfig
-  VERSION = "1.0.0"
+  VERSION = "2.0.1"
 
   MissingEnvironmentVariable = Class.new(StandardError)
   MissingCallable = Class.new(StandardError)
@@ -18,6 +18,7 @@ module SuperConfig
       @env = env
       @raise_exception = raise_exception
       @stderr = stderr
+      @attributes = {}
       @__cache__ = {}
       instance_eval(&block)
     end
@@ -37,6 +38,9 @@ module SuperConfig
     )
       name = name.to_s
       env_var = name.upcase
+
+      @attributes[env_var] = {required: required, default: default}
+
       name = "#{name}?" if type == bool
 
       validate!(env_var, required, description)
@@ -44,7 +48,7 @@ module SuperConfig
       define_singleton_method(name) do
         return default unless @env.key?(env_var)
 
-        coerce(type, @env[env_var])
+        coerce(env_var, type, @env[env_var])
       end
 
       aliases.each do |alias_name|
@@ -139,41 +143,69 @@ module SuperConfig
       :json
     end
 
-    private def coerce_to_string(value)
+    def report
+      attrs = @attributes.sort
+
+      report = attrs.each_with_object([]) do |(env_var, info), buffer|
+        icon, message = if @env.key?(env_var)
+                          ["✅", "is set"]
+                        elsif info[:required]
+                          ["❌", "is not set"]
+                        elsif !info[:required] && !info[:default].nil?
+                          ["✅", "is not set, but has default value"]
+                        else
+                          ["⚠️", "is not set"]
+                        end
+
+        label = if info[:required]
+                  "mandatory"
+                else
+                  "optional"
+                end
+
+        buffer << [icon, env_var, message, "(#{label})"].join(" ")
+      end
+
+      "#{report.join("\n")}\n"
+    end
+
+    private def coerce_to_string(_name, value)
       value
     end
 
-    private def coerce_to_bool(value)
+    private def coerce_to_bool(_name, value)
       BOOL_TRUE.include?(value)
     end
 
-    private def coerce_to_int(value)
+    private def coerce_to_int(_name, value)
       Integer(value) if !BOOL_FALSE.include?(value) && value
     end
 
-    private def coerce_to_float(value)
+    private def coerce_to_float(_name, value)
       Float(value) if value
     end
 
-    private def coerce_to_bigdecimal(value)
+    private def coerce_to_bigdecimal(_name, value)
       BigDecimal(value) if value
     end
 
-    private def coerce_to_symbol(value)
+    private def coerce_to_symbol(_name, value)
       value&.to_sym
     end
 
-    private def coerce_to_array(value, type)
-      value&.split(/, */)&.map {|v| coerce(type, v) }
+    private def coerce_to_array(name, value, type)
+      value&.split(/, */)&.map {|v| coerce(name, type, v) }
     end
 
-    private def coerce_to_json(value)
+    private def coerce_to_json(name, value)
       value && JSON.parse(value)
+    rescue JSON::ParserError
+      raise ArgumentError, "#{name} is not a valid JSON string"
     end
 
-    private def coerce(type, value)
+    private def coerce(name, type, value)
       main_type, sub_type = type
-      args = [value]
+      args = [name, value]
       args << sub_type if sub_type
 
       send("coerce_to_#{main_type}", *args)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superconfig
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Access environment variables. Also includes presence validation, type coercion