envdocs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9da113a4d5f4deb3f456ec4b964af5bab94de452f0672607bf0f60054a8d9b5
+  data.tar.gz: 96418182334564c323a009d4753a47e836891329c6c2f4aa4af837e877a88dbb
+SHA512:
+  metadata.gz: 22f5cb72671e016f3c7836e7b5b5ecae59aa727f900a99a1255b4d733b8c8830913d568835c7d22e67a3b1219d536b8adc04f231f46ec6c06f28191f1dcd238c
+  data.tar.gz: 7feb5f0a2a18419e6c8d45bf3583c7df365c71d932a01447de78ef7b4855684ba72b9841803c8da04e8ac13acce8d73651fd75dfc00de3f361cbe4132ebfca34

data/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) Joseph James Rodriguez
+
+EnvDocs is an Open Source project licensed under the terms of
+the LGPLv3 license. Please see <https://www.gnu.org/licenses/lgpl-3.0.txt>
+for license text.

data/README.md

@@ -0,0 +1,63 @@
+# Envdocs
+Simple and Lightweight Gem to handle Environment(ENV) variable sanity-checks and documentation. Providing teams with the ability to sanity-check their expected loaded ENV variables at any point.
+
+Every team documents, stores and persists ENV variables differently. One of the most draining experiences for a team is forgetting to update an ENV key for an environment, pushing things through, and trying to understand why things aren't working. This gem aims to fix that.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'envdocs'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install envdocs
+```
+
+## Usage
+
+1. Create a `sample_keys.yml` file in your application's `config` directory:
+Example:
+```yaml
+- development:
+  - key: RAILS_ENV
+    description: Provides info on the rails env
+    required: true
+- key: FOO
+    description: Testing
+    required: false
+- test:
+  - key: RAILS_ENV
+    description: Provides info on the rails env
+    required: true
+```
+The top-level key denotes the environment name we'd like to check against(ie. development, test, etc...). The nested objects each represent a key we'd like to validate for that environment.
+
+2. Initialize the gem by pointing it to your `sample_keys.yml` file in your application's `./config` folder.
+```ruby
+# initializers/envdocs.rb
+Envdocs.configure(
+  filename: 'sample_keys.yml',
+  environment: Rails.env,
+  opts: { include_optional: false }
+)
+```
+
+3. Anywhere in your code that you'd like to validate the proper keys exist, call:
+```ruby
+Envdocs.find_missing_keys
+```
+
+When called, an array of strings will be returned containing any missing keys. If no keys are missing, an empty array will be returned.
+
+## Contributing
+Features, bug fixes and other changes to envdocs-ruby are gladly accepted. Please open issues or a pull request with your change.
+
+## License
+The gem is available as open source under the terms of the [LGPLv3 License](https://www.gnu.org/licenses/lgpl-3.0.html).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Envdocs'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/envdocs.rb

@@ -0,0 +1,63 @@
+require 'envdocs/railtie'
+
+module Envdocs
+  class << self
+    attr_reader :environment, :filename, :opts
+
+    # @param [String] filename
+    # @param [String] environment
+    # @param [Hash] opts
+    #   => [Booleam] include_optional
+    def configure(filename:, environment:, opts: {})
+      @configured = true
+      @environment = environment
+      @filename = filename
+      @opts = opts
+      @sampler = Sampler.new(filename, environment)
+    end
+
+    # Returns an array of keys that were not found in the current ENV
+    # @return [Array[String]]
+    def find_missing_keys
+      unless @configured
+        raise StandardError, 'Envdocs environment must be configured before running this command'
+      end
+
+      # If optionals included, return all. 
+      # Otherwise, return only keys that are marked as required.
+      result = {}
+      keys_to_search = @sampler.env_keys.select { |ek| @opts[:include_optional] || ek['required'] }
+
+      keys_to_search.each { |ek| result[ek['key']] = ENV.fetch(ek['key'], nil) }
+
+      result.reject { |k,v| !v.nil? }.keys
+    end
+  end
+
+  # Retrieves keys for an environment from a sample template
+  class Sampler
+    attr_reader :filename, :template, :curr_env, :env_keys
+
+    # @param [String] filename
+    # @param [String] curr_env
+    def initialize(filename, curr_env)
+      @filename = filename
+      @curr_env = curr_env
+      @template = retrieve_keys_template(filename)
+      @env_keys = retrieve_keys_for_env_from_template(curr_env)
+    end
+
+    private
+
+    # @param [String] filename
+    def retrieve_keys_template(filename)
+      YAML.load(File.read(Rails.root.join('config', filename)))
+    end
+
+    # @param [String] curr_env
+    # @return [Array[Hash]]
+    def retrieve_keys_for_env_from_template(curr_env)
+      @template.find { |k| k[curr_env].present? }[curr_env]
+    end
+  end
+end

data/lib/envdocs/railtie.rb

@@ -0,0 +1,4 @@
+module Envdocs
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/envdocs/version.rb

@@ -0,0 +1,3 @@
+module Envdocs
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: envdocs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph James Rodriguez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: Envdocs allows you to find missing env keys, as well as create living
+  documentation of the keys themselves.
+email:
+- joerodrig3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/envdocs.rb
+- lib/envdocs/railtie.rb
+- lib/envdocs/version.rb
+homepage: https://github.com/joerodrig/envdocs-ruby/
+licenses:
+- LGPLv3
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Find missing ENV keys
+test_files: []