dotenv-missing_variable_notifier 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2dd3c13da01e1884a717b6a00b408f627c1abf529146c91cc5d5b41b9eb310f
+  data.tar.gz: 14644cd592db0088ef9e1685af95ecfd7e195b422c8ea84bceb538b58628b236
+SHA512:
+  metadata.gz: 6d05e3c1b13894d7535392c0826afb10f4cda411cac736d466ceda51b864e6c7c3c729f919be304e70a42c2d9b06b575e4d57fec55d4cc33d829933de043e54c
+  data.tar.gz: cdc27a149dd64bef3d7496fa14fd903103bac14c360b0bcf59073350a6f8306e6f92b0453745deaa489b72f876f87dc13e673bebae67e28d5ec527d47abd101a

data/.gitignore

@@ -0,0 +1,3 @@
+/.ruby-gemset
+/Gemfile.lock
+/*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Glen Crawford
+
+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

@@ -0,0 +1,36 @@
+# dotenv-missing_variable_notifier
+
+dotenv-missing_variable_notifier is a tiny (literally 6 lines of code) extension for [dotenv](https://github.com/bkeepers/dotenv) to notify you if your development environment is missing any environment variables listed in the example dotenv file in your Rails application. This is useful for projects that use an example file for their environment variables (usually `.env.template` or `.env.example`), which is most projects that use dotenv. Now you won't need to check for new environment variables after you do a `git pull`!
+
+## Installation
+
+Add the gem to your Gemfile _after_ `dotenv-rails`.
+
+```ruby
+group :development, :test do
+  gem 'dotenv-rails'
+  gem 'dotenv-missing_variable_notifier', '~> 1.0'
+end
+```
+
+And then install:
+
+```
+bundle install
+```
+
+### Load order
+
+`dotenv-missing_variable_notifier` is basically a tiny [Railtie](https://api.rubyonrails.org/classes/Rails/Railtie.html) that runs in a `before_configuration` callback while your application is booting. If it runs before dotenv does then it will complain that _every_ environment variable is missing, and it would be right! This means that you _must_ list `dotenv-missing_variable_notifier` in your Gemfile after `dotenv-rails`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GlenCrawford/dotenv-missing_variable_notifier.
+
+## Acknowledgements
+
+A huge thanks to the author(s) of [dotenv](https://github.com/bkeepers/dotenv) for their amazing gem.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/dotenv-missing_variable_notifier.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotenv/missing_variable_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dotenv-missing_variable_notifier'
+  spec.version       = Dotenv::MissingVariableNotifier::VERSION
+  spec.authors       = ['Glen Crawford']
+
+  spec.summary       = 'Tiny extension for dotenv to notify you if you are missing any environment variables listed in your example file.'
+  spec.homepage      = 'https://github.com/GlenCrawford/dotenv-missing_variable_notifier'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |file| file.match(%r{^(spec)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  # Runtime versions deliberately left unspecified.
+  spec.add_runtime_dependency 'dotenv-rails'
+  spec.add_runtime_dependency 'railties'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+end

data/lib/dotenv-missing_variable_notifier.rb

@@ -0,0 +1,4 @@
+if defined?(Rails) && defined?(Dotenv) && Rails.env.development?
+  require 'dotenv/missing_variable_notifier/railtie'
+  require 'dotenv/missing_variable_notifier/core'
+end

data/lib/dotenv/missing_variable_notifier/core.rb

@@ -0,0 +1,19 @@
+module Dotenv
+  module MissingVariableNotifier
+    class MissingEnvironmentVariableError < StandardError; end
+
+    class Core
+      def self.check_for_missing_environment_variables!
+        example_file = ['.env.template', '.env.example'].detect { |example_file| Rails.root.join(example_file).exist? }
+        return unless example_file
+
+        example_file_contents = File.open(Rails.root.join(example_file), 'rb:bom|utf-8', &:read)
+        example_file_variables = Dotenv::Parser.call(example_file_contents, false) # Thank you dotenv <3
+        missing_variables = example_file_variables.keys.reject { |variable| ENV.has_key?(variable) }
+        if missing_variables.any?
+          raise MissingEnvironmentVariableError, "There are environment variables in your dotenv template file that are not set in your development environment: #{missing_variables.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/lib/dotenv/missing_variable_notifier/railtie.rb

@@ -0,0 +1,7 @@
+module Dotenv
+  module MissingVariableNotifier
+    class Railtie < Rails::Railtie
+      config.before_configuration { Dotenv::MissingVariableNotifier::Core.check_for_missing_environment_variables! }
+    end
+  end
+end

data/lib/dotenv/missing_variable_notifier/version.rb

@@ -0,0 +1,5 @@
+module Dotenv
+  module MissingVariableNotifier
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: dotenv-missing_variable_notifier
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Glen Crawford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dotenv-missing_variable_notifier.gemspec
+- lib/dotenv-missing_variable_notifier.rb
+- lib/dotenv/missing_variable_notifier/core.rb
+- lib/dotenv/missing_variable_notifier/railtie.rb
+- lib/dotenv/missing_variable_notifier/version.rb
+homepage: https://github.com/GlenCrawford/dotenv-missing_variable_notifier
+licenses:
+- MIT
+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: Tiny extension for dotenv to notify you if you are missing any environment
+  variables listed in your example file.
+test_files: []