env-checker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba5dc70e0bb1caa59a590c04462c078179acac60
-  data.tar.gz: 82f2e65694f42693073a6e883717d280c23a17df
+  metadata.gz: bcca1afc9d8e9b643130ad0acc664d52628187c6
+  data.tar.gz: dfd883610347cdfac5112599fa332c8671dcc7b4
 SHA512:
-  metadata.gz: fb5eed10a632c846d3b63ffbf17f11525e879e0a945c8b7aa0406dedc2eaa5aee32bdd0a2d5c87b3f54ba432d1589e0154752ca907722b792eaf9224256ebddb
-  data.tar.gz: 4e44a55a95f37fef15099574350a979a9de7ce375d903c1dacbdfe6ef39a3e0f4b5f681bb4d99631082b050b015f8fb555412298873b2bef0cfb5319c85f5cc4
+  metadata.gz: 1fea0979d2f9412ee81e4eca2251ec6cca3b3ae32aec6f5602265f426880a10d183ed6ca94a3d8c0c30eb8f8ca3a8b805c9ad41fb8d76b9681872a3e0e0cc272
+  data.tar.gz: 99a3af47a75a5635155be3671b1cd05075e46548389096334ab12479822116209257fb185b413550f210c16532cc2db0aeace7c604dc9e76546825c39090d09a

data/.rubocop.yml

@@ -1,5 +1,7 @@
-require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
+AllCops:
+  TargetRubyVersion: 2.3
+
 Style/Documentation:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,26 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-11-05 18:58:49 +0100 using RuboCop version 0.45.0.
+# on 2016-11-05 22:54:49 +0100 using RuboCop version 0.45.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 7
+# Offense count: 2
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 96
-
-# Offense count: 2
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/env_checker.rb'
-    - 'lib/env_checker/configuration.rb'
+  Max: 84
 
-# Offense count: 10
+# Offense count: 13
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: when_needed, always
@@ -34,15 +26,12 @@ Style/FrozenStringLiteralComment:
     - 'lib/env_checker/configuration.rb'
     - 'lib/env_checker/missing_keys_error.rb'
     - 'lib/env_checker/version.rb'
+    - 'spec/env_checker/configuration_spec.rb'
+    - 'spec/env_checker/missing_keys_error_spec.rb'
+    - 'spec/env_checker/version_spec.rb'
     - 'spec/env_checker_spec.rb'
     - 'spec/spec_helper.rb'
 
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/env_checker.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
@@ -50,12 +39,6 @@ Style/GuardClause:
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/LeadingCommentSpace:
-  Exclude:
-    - 'env-checker.gemspec'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/MutableConstant:
@@ -76,20 +59,6 @@ Style/PercentLiteralDelimiters:
 Style/RaiseArgs:
   EnforcedStyle: compact
 
-# Offense count: 28
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Rakefile'
-    - 'bin/console'
-    - 'env-checker.gemspec'
-    - 'lib/env_checker.rb'
-    - 'lib/env_checker/version.rb'
-    - 'spec/env_checker_spec.rb'
-    - 'spec/spec_helper.rb'
-
 # Offense count: 2
 # Cop supports --auto-correct.
 Style/UnneededPercentQ:

data/Gemfile.lock

@@ -1,13 +1,21 @@
 PATH
   remote: .
   specs:
-    env-checker (0.1.0)
+    env-checker (0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.3.0)
+    coveralls (0.8.15)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (>= 1.6.0, < 2)
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (2.0.2)
     parser (2.3.1.4)
       ast (~> 2.2)
     powerpack (0.1.1)
@@ -32,9 +40,16 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.8.0)
-      rubocop (>= 0.42.0)
     ruby-progressbar (1.8.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.4.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.12.0)
     unicode-display_width (1.1.1)
 
 PLATFORMS
@@ -42,11 +57,12 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.13)
+  coveralls (~> 0)
   env-checker!
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop
-  rubocop-rspec
+  rubocop (~> 0)
+  simplecov (~> 0)
 
 BUNDLED WITH
    1.13.6

data/README.md

@@ -1,9 +1,18 @@
-# EnvChecker
+# Env-checker
+
+[![Gem Version](https://badge.fury.io/rb/env-checker.svg)](https://badge.fury.io/rb/env-checker)
+[![Dependency Status](https://gemnasium.com/badges/github.com/ryanfox1985/env-checker.svg)](https://gemnasium.com/github.com/ryanfox1985/env-checker)
+[![Build Status](https://travis-ci.org/ryanfox1985/env-checker.svg?branch=master)](https://travis-ci.org/ryanfox1985/env-checker)
+[![Coverage Status](https://coveralls.io/repos/github/ryanfox1985/env-checker/badge.svg?branch=master)](https://coveralls.io/github/ryanfox1985/env-checker?branch=master)
+[![Code Climate](https://codeclimate.com/github/ryanfox1985/env-checker/badges/gpa.svg)](https://codeclimate.com/github/ryanfox1985/env-checker)
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/ryanfox1985/env-checker/blob/master/LICENSE)
+
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/env_checker`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 TODO: Delete this and the text above, and describe your gem
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,19 +29,58 @@ Or install it yourself as:
 
     $ gem install env-checker
 
+
 ## Usage
 
-TODO: Write usage instructions here
 
-## Development
+### Rails or Ruby standalone
+
+Create a initializer to configure the gem and run the hook to check the
+environment variables. Example:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+# config/initializers/env_checker.rb
+
+require 'env_checker'
+
+EnvChecker.configure do |config|
+  config.optional_variables = %w(MyVar1 MyVar2)
+  config.required_variables = %w(MyVar1 MyVar2)
+
+  # LOGGER
+  # ======
+  # Default is:
+  #
+  # config.logger = Logger.new(STDERR)
+  #
+  # Some possible settings:
+  # config.logger = Rails.logger                        # Log with all your app's other messages
+  # config.logger = Logger.new('log/env_checker.log')   # Use this file
+  # config.logger = Logger.new('/dev/null')             # Don't log at all (on a Unix system)
+end
+
+# Example to run always
+[YOUR_APP]::Application.config.after_initialize do
+  EnvChecker.check_environment_variables
+end
+
+# Example to run in specific environments
+if Rails.env.production? || Rails.env.test?
+  [YOUR_APP]::Application.config.after_initialize do
+    EnvChecker.check_environment_variables
+  end
+end
+```
+
+
+### Standalone and CLI
+
+TODO: Write usage instructions here
 
-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/[USERNAME]/env-checker. 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/ryanfox1985/env-checker. 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

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "env_checker"
+require 'bundler/setup'
+require 'env_checker'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "env_checker"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/env-checker.gemspec

@@ -4,35 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'env_checker/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "env-checker"
+  spec.name          = 'env-checker'
   spec.version       = EnvChecker::VERSION
-  spec.authors       = ["Guillermo Guerrero Ibarra"]
-  spec.email         = ["guillermo@guerreroibarra.com"]
+  spec.authors       = ['Guillermo Guerrero Ibarra']
+  spec.email         = ['guillermo@guerreroibarra.com']
 
   spec.summary       = %q{Check your environment variables and don't forget anyone.}
   spec.description   = %q{Check your environment variables and don't forget anyone.}
-  spec.homepage      = "https://github.com/ryanfox1985/env-checker"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  #if spec.respond_to?(:metadata)
-  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  #else
-  #  raise "RubyGems 2.0 or newer is required to protect against " \
-  #    "public gem pushes."
-  #end
+  spec.homepage      = 'https://github.com/ryanfox1985/env-checker'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop-rspec", '~> 0'
-  spec.add_development_dependency "rubocop", '~> 0'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0'
+  spec.add_development_dependency 'coveralls', '~> 0'
+  spec.add_development_dependency 'simplecov', '~> 0'
 end

data/lib/env_checker.rb

@@ -1,23 +1,18 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
-require "env_checker/version"
-require "env_checker/missing_keys_error"
-require "env_checker/configuration"
+require 'env_checker/version'
+require 'env_checker/missing_keys_error'
+require 'env_checker/configuration'
 
 module EnvChecker
   class << self
     attr_accessor :configuration
 
     def check_environment_variables
-      if configuration.optional_variables
-        missing_keys = missing_keys_environment(configuration.optional_variables)
-        puts missing_keys # TODO: do something more.
-      end
+      bov = check_optional_variables
+      brv = check_required_variables
 
-      if configuration.required_variables
-        missing_keys = missing_keys_environment(configuration.required_variables)
-        raise MissingKeysError.new(missing_keys) if missing_keys.any?
-      end
+      bov & brv
     end
 
     def configure
@@ -27,7 +22,51 @@ module EnvChecker
 
     private
 
-    def missing_keys_environment(keys)
+    def check_optional_variables
+      if configuration.optional_variables
+        missing_keys = missing_keys_env(configuration.optional_variables)
+        log_message(:warning, "EnvChecker: Warning missing these optional
+          variables: [#{missing_keys}]")
+
+        return missing_keys.empty?
+      end
+
+      true
+    end
+
+    def check_required_variables
+      if configuration.required_variables
+        missing_keys = missing_keys_env(configuration.required_variables)
+
+        if missing_keys.any?
+          log_message(:error, "EnvChecker: Error missing these required
+            variables: [#{missing_keys}]")
+
+          raise MissingKeysError.new(missing_keys)
+        end
+      end
+
+      true
+    end
+
+    def log_message(type, message)
+      return unless configuration
+
+      # TODO: add other integrations like slack, email...
+
+      return unless configuration.logger
+
+      case type
+      when :warning
+        configuration.logger.warn(message)
+      when :error
+        configuration.logger.error(message)
+      else
+        configuration.logger.info(message)
+      end
+    end
+
+    def missing_keys_env(keys)
       keys.flatten - ::ENV.keys
     end
   end

data/lib/env_checker/configuration.rb

@@ -1,11 +1,13 @@
+require 'logger'
+
 module EnvChecker
   class Configuration
-    # Has default settings, which can be overridden in the initializer.
-
     attr_accessor :required_variables, :optional_variables, :logger
 
+    # Has default settings, which can be overridden in the initializer.
     def initialize
       @required_variables = []
+      @optional_variables = []
       @logger = Logger.new(STDERR)
     end
   end

data/lib/env_checker/version.rb

@@ -1,3 +1,3 @@
 module EnvChecker
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: env-checker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Guillermo Guerrero Ibarra
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: coveralls
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -96,7 +110,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Guillermo Guerrero
-
-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.