env-checker 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c947e5de754d1f3516256571096b944fda28114
-  data.tar.gz: 2e9491a8e67ab09847f242d6e69bfcd426bc386c
+  metadata.gz: e6889c86228fd44c99631f0444f423220e039167
+  data.tar.gz: 5fb83011dcfbe9029a0b11579bc5f16bb8b535e6
 SHA512:
-  metadata.gz: 468664562b4cdcf6237f7d3cba41472b88290db4fbfff3520ada45467fc98b363b91edf573f9c4650db1bef1ddb649d75b4ef1fa0ba4fef7dd673c844dea02fc
-  data.tar.gz: 74fa44ecf12cec49fd81199fb5cc83a5acc37f1f43bd070aa45abf70b62d07bd0657f7e4bfee41df28c969d76722d54b1eb6fa3471a456c5aac9458bd570f5cf
+  metadata.gz: b1580c19ec2e28b7b3814ce6f772e31f6a2b97f47c918b44223d0132b327bdfaeed93c23a9f9b81c441463e27bb9d1f38b15e561239f6fb8042b7cd8210edbc3
+  data.tar.gz: c93de2bbaf04a2a1fdeed0e43627894bd3627e88b3d05c75593c7c0ebb686e5fd6ee0206d323e1c4683c61efd277d0ff1fb0f9e7317222ca60bd919c9bbedb7d

data/.gitignore

@@ -10,6 +10,7 @@
 /test/version_tmp/
 /tmp/
 
+test_config.yml
 # Used by dotenv library to load environment variables.
 # .env
 

data/.rubocop_todo.yml

@@ -1,30 +1,39 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-11-21 18:20:26 +0100 using RuboCop version 0.45.0.
+# on 2016-11-26 09:12:44 +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: 2
+# Offense count: 4
 Metrics/AbcSize:
-  Max: 27
+  Max: 31
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/BlockLength:
   Max: 32
 
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
 # Offense count: 3
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 95
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 23
+  Max: 25
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 107
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -33,14 +42,14 @@ Style/ExtraSpacing:
   Exclude:
     - 'env-checker.gemspec'
 
-# Offense count: 16
+# Offense count: 17
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: when_needed, always
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-# Offense count: 12
+# Offense count: 15
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    env-checker (0.1.8)
+    env-checker (0.1.9)
       slack-notifier (~> 1.5)
       thor (~> 0.19.1)
 

data/README.md

@@ -135,7 +135,7 @@ $ env-checker check --config_file sample_config.yml
 
 ## Contributing
 
-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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryanfox1985/env-checker/issues and https://github.com/ryanfox1985/env-checker/pulls. 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/lib/env_checker.rb

@@ -5,6 +5,7 @@ require 'env_checker/version'
 require 'env_checker/missing_keys_error'
 require 'env_checker/configuration'
 require 'env_checker/cli'
+require 'env_checker/notifier'
 
 module EnvChecker
   class << self
@@ -14,13 +15,12 @@ module EnvChecker
       self.configurations ||= {}
       configurations['global'] = Configuration.new
       yield(configurations['global'])
-      after_configure_and_check(configurations['global'])
+      after_configure_and_check(configurations)
     end
 
     def cli_configure_and_check(options)
-      if run_configure_and_check(options) && options[:run]
+      run_configure_and_check(options) && options[:run] &&
         exit(system(options[:run]))
-      end
 
       exit(true)
     end
@@ -35,7 +35,9 @@ module EnvChecker
       self.configurations = create_config_from_parameters(options)
 
       begin
-        exit(1) unless after_configure_and_check(configurations['global'])
+        unless after_configure_and_check(configurations)
+          exit(options[:run] ? system(options[:run]) : 1)
+        end
       rescue EnvChecker::MissingKeysError
         exit 2
       rescue EnvChecker::ConfigurationError
@@ -45,19 +47,26 @@ module EnvChecker
       true
     end
 
-    def after_configure_and_check(configuration)
-      configuration.after_initialize
+    def after_configure_and_check(configurations)
+      environments_to_check = %w(global)
 
-      bov = check_optional_variables(configuration)
-      brv = check_required_variables(configuration)
+      current_env = configurations['global'].environment
+      if current_env && configurations.key?(current_env)
+        environments_to_check << current_env
+      end
 
-      bov & brv
+      environments_to_check.map do |env|
+        configurations[env].after_initialize
+
+        check_optional_variables(env, configurations) &
+          check_required_variables(env, configurations)
+      end.reduce(:&)
     end
 
     def create_config_from_parameters(options)
-      config = Configuration.new
-
-      attributes = %w(environment
+      configurations = { 'global' => Configuration.new }
+      attributes = %w(environments
+                      environment
                       optional_variables
                       required_variables
                       slack_webhook_url)
@@ -65,48 +74,66 @@ module EnvChecker
       if options[:config_file]
         from_file = YAML.load_file(options[:config_file])
 
-        attributes.each do |a|
-          config.public_send("#{a}=", from_file[a]) if from_file[a]
+        configurations = config_from_file('global', attributes, from_file)
+        if configurations['global'].environments.any?
+          configurations['global'].environments.each do |env|
+            configurations
+              .merge!(config_from_file(env, attributes, from_file[env]))
+          end
         end
+      end
 
-        return { 'global' => config }
+      attributes.each do |a|
+        options[a.to_sym] &&
+          configurations['global'].public_send("#{a}=", options[a.to_sym])
       end
 
+      configurations
+    end
+
+    def config_from_file(name, attributes, from_file)
+      return { name => Configuration.new } unless from_file
+
+      config = Configuration.new
       attributes.each do |a|
-        config.public_send("#{a}=", options[a.to_sym]) if options[a.to_sym]
+        config.public_send("#{a}=", from_file[a]) if from_file[a]
       end
 
-      { 'global' => config }
+      { name => config }
     end
 
-    def check_optional_variables(configuration)
+    def check_optional_variables(env, configurations)
       return true if
-        !configuration.optional_variables ||
-        configuration.optional_variables.empty?
+        !configurations[env].optional_variables ||
+        configurations[env].optional_variables.empty?
 
-      missing_keys = missing_keys_env(configuration.optional_variables)
+      missing_keys = missing_keys_env(configurations[env].optional_variables)
       return true if missing_keys.empty?
 
-      log_message(configuration,
-                  :warning,
-                  configuration.environment,
-                  "Warning! Missing optional variables: #{missing_keys}")
+      Notifier.log_message(
+        configurations[env],
+        :warning,
+        env,
+        "Warning! Missing optional variables: #{missing_keys}"
+      )
 
       false
     end
 
-    def check_required_variables(configuration)
+    def check_required_variables(env, configurations)
       return true if
-        !configuration.required_variables ||
-        configuration.required_variables.empty?
+        !configurations[env].required_variables ||
+        configurations[env].required_variables.empty?
 
-      missing_keys = missing_keys_env(configuration.required_variables)
+      missing_keys = missing_keys_env(configurations[env].required_variables)
 
       if missing_keys.any?
-        log_message(configuration,
-                    :error,
-                    configuration.environment,
-                    "Error! Missing required variables: #{missing_keys}")
+        Notifier.log_message(
+          configurations[env],
+          :error,
+          env,
+          "Error! Missing required variables: #{missing_keys}"
+        )
 
         raise MissingKeysError.new(missing_keys)
       end
@@ -114,26 +141,6 @@ module EnvChecker
       true
     end
 
-    def log_message(configuration, type, environment, error_message)
-      return unless error_message
-
-      message = format_error_message(environment, error_message)
-
-      configuration.notify_slack(message)
-      # TODO: add other integrations like email...
-      configuration.notify_logger(type, message)
-    end
-
-    def format_error_message(environment, error_message)
-      return [] unless error_message
-
-      messages = []
-      messages << '[EnvChecker]'
-      messages << "[#{environment}]" if environment
-      messages << error_message
-      messages.join(' ')
-    end
-
     def missing_keys_env(keys)
       keys.flatten - ::ENV.keys
     end

data/lib/env_checker/cli.rb

@@ -5,6 +5,7 @@ module EnvChecker
     desc 'version', 'EnvChecker version.'
     def version
       puts "EnvChecker #{EnvChecker::VERSION}"
+      EnvChecker::VERSION
     end
 
     option :environment, :aliases => :e, :type => :string
@@ -12,11 +13,11 @@ module EnvChecker
     option :required_variables, :aliases => [:r, :required], :type => :array
     option :optional_variables, :aliases => [:o, :optional], :type => :array
     option :slack_webhook_url, :aliases => :slack, :type => :string
+    option :verbose, :aliases => :v, :type => :boolean, :default => false
     option :run, :type => :string
     desc 'check', 'Check optional and required environment variables.'
     def check
-      output = []
-      output << 'Variables: '
+      output = %w(Variables:)
 
       variables = %w(config_file
                      slack_webhook_url
@@ -30,7 +31,10 @@ module EnvChecker
         env_var_name = "env_checker_#{v}".upcase
         if ENV[env_var_name]
           my_options[v.to_sym] ||= if env_var_name.include?('_VARIABLES')
-                                     ENV[env_var_name].split(' ')
+                                     ENV[env_var_name]
+                                       .split(' ')
+                                       .map { |elem| elem.split(',') }
+                                       .flatten
                                    else
                                      ENV[env_var_name]
                                    end
@@ -38,7 +42,8 @@ module EnvChecker
         my_options[v.to_sym] = options[v.to_sym] if options[v.to_sym]
         output << "- #{v}: #{my_options[v.to_sym]}" if my_options[v.to_sym]
       end
-      puts output.join("\n")
+
+      puts output.join("\n") if options[:verbose]
 
       EnvChecker.cli_configure_and_check(my_options)
     end

data/lib/env_checker/configuration.rb

@@ -7,11 +7,13 @@ module EnvChecker
 
   class Configuration
     attr_accessor :required_variables, :optional_variables, :logger,
-                  :environment, :slack_webhook_url, :slack_notifier
+                  :environment, :slack_webhook_url, :slack_notifier,
+                  :environments
 
     # Has default settings, which can be overridden in the initializer.
     def initialize
       @environment = ENV['RACK_ENV'] || ENV['RAILS_ENV']
+      @environments = []
       @required_variables = []
       @optional_variables = []
       @slack_webhook_url = nil
@@ -35,24 +37,6 @@ module EnvChecker
       true
     end
 
-    def notify_slack(message)
-      slack_notifier && slack_notifier.ping(message)
-    rescue StandardError => e
-      notify_logger(:error, e)
-    end
-
-    def notify_logger(type, message)
-      logger &&
-        case type
-        when :warning
-          logger.warn(message)
-        when :error
-          logger.error(message)
-        else
-          logger.info(message)
-        end
-    end
-
     private
 
     def valid?

data/lib/env_checker/notifier.rb

@@ -0,0 +1,55 @@
+module EnvChecker
+  class Notifier
+    class << self
+      def log_message(configuration, type, environment, error_message)
+        return unless error_message
+
+        message = format_error_message(environment, error_message)
+        notify(configuration, type, message)
+      end
+
+      def format_error_message(environment, error_message)
+        return [] unless error_message
+
+        messages = %w([EnvChecker])
+        messages << "[#{environment}]" if environment
+        messages << error_message
+        messages.join(' ')
+      end
+
+      def notify(configuration, type, message)
+        notify_slack(configuration, message)
+        notify_rollbar(configuration, message)
+        notify_email(configuration, message)
+        notify_logger(configuration, type, message)
+      end
+
+      def notify_rollbar(configuration, message)
+        # TODO: implement rollbar
+      end
+
+      def notify_email(configuration, message)
+        # TODO: implement email
+      end
+
+      def notify_slack(configuration, message)
+        configuration.slack_notifier &&
+          configuration.slack_notifier.ping(message)
+      rescue StandardError => e
+        notify_logger(:error, e)
+      end
+
+      def notify_logger(configuration, type, message)
+        configuration.logger &&
+          case type
+          when :warning
+            configuration.logger.warn(message)
+          when :error
+            configuration.logger.error(message)
+          else
+            configuration.logger.info(message)
+          end
+      end
+    end
+  end
+end

data/lib/env_checker/version.rb

@@ -1,3 +1,3 @@
 module EnvChecker
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env-checker
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Guillermo Guerrero Ibarra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2016-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -167,9 +167,9 @@ files:
 - lib/env_checker/cli.rb
 - lib/env_checker/configuration.rb
 - lib/env_checker/missing_keys_error.rb
+- lib/env_checker/notifier.rb
 - lib/env_checker/version.rb
 - sample_config.yml
-- test_config.yml
 homepage: https://github.com/ryanfox1985/env-checker
 licenses:
 - MIT

data/test_config.yml

@@ -1,7 +0,0 @@
----
-optional_variables:
-- OptMyVar1
-- OptMyVar2
-required_variables:
-- MyVar1
-- MyVar2