env-checker 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b69d2729808eb8df421332bd614066c161fdeda
-  data.tar.gz: 6a78a5b6c6e31ba5e25f7e8f52d0e92797f46197
+  metadata.gz: 157bc8d87b47465463bf92d1f36cabd512383af7
+  data.tar.gz: 38eb8608f2b9ec6bc737da8150eecddc4a0c7d65
 SHA512:
-  metadata.gz: 6377aec544e2d13020113253fdf63eb35fefa0a008ce0067e99c96599bb2bb81a7894bfc9eaf00ff109e5e23d1d64a8ff7663539d7be8be8ccb2c71d06b6b0a1
-  data.tar.gz: c38c14c7ea5b277e1658718c47e70d1a1f2b6d50cfac3f66e1d3578bf24ac6c40273353f05fc599f890c026b8e1cfb3ab47240ab607cb8b220111974c689bc91
+  metadata.gz: 5207f2040ab213eb3fae659885f674ea09f04d2f19271a21b52d3aa531ce310fd7928f2a57e11506e4b044ee0d3d432098696ee0798b12bf4a510cae139cc359
+  data.tar.gz: dc18440c297ef31674862717097829cd008526492f5fc7e25a16ea7cef02484b04f1630e48da427e17ade50bf40e66c5ac48e1f939c24e268a73ca084aac1b6b

data/.gitignore

@@ -21,6 +21,7 @@ build/
 build-iPhoneOS/
 build-iPhoneSimulator/
 .ruby-gemset
+.byebug_history
 
 ## Specific to RubyMotion (use of CocoaPods):
 #

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-11-08 20:21:40 +0100 using RuboCop version 0.45.0.
+# on 2016-11-11 15:00:02 +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
@@ -8,24 +8,30 @@
 
 # Offense count: 2
 Metrics/AbcSize:
-  Max: 16
+  Max: 21
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/BlockLength:
-  Max: 30
+  Max: 31
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 81
+  Max: 82
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 11
 
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/EmptyLines:
+  Exclude:
+    - 'spec/env_checker/cli_spec.rb'
+
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
@@ -33,34 +39,21 @@ Style/ExtraSpacing:
   Exclude:
     - 'env-checker.gemspec'
 
-# Offense count: 15
+# Offense count: 16
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: when_needed, always
 Style/FrozenStringLiteralComment:
-  Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'bin/console'
-    - 'env-checker.gemspec'
-    - 'exe/env-checker'
-    - 'lib/env_checker.rb'
-    - 'lib/env_checker/cli.rb'
-    - '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'
+  Enabled: false
 
-# Offense count: 5
+# Offense count: 7
 # Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
 Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+  Exclude:
+    - 'Rakefile'
+    - 'lib/env_checker/cli.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    env-checker (0.1.2)
-      thor (~> 0)
+    env-checker (0.1.3)
+      thor
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.3.0)
+    byebug (9.0.6)
     coveralls (0.8.15)
       json (>= 1.8, < 3)
       simplecov (~> 0.12.0)
@@ -21,7 +22,7 @@ GEM
       ast (~> 2.2)
     powerpack (0.1.1)
     rainbow (2.1.0)
-    rake (10.5.0)
+    rake (11.3.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -57,13 +58,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.13)
-  coveralls (~> 0)
+  bundler (>= 1.13)
+  byebug (>= 9.0.5)
+  coveralls
   env-checker!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop (~> 0)
-  simplecov (~> 0)
+  rake (>= 10.0)
+  rspec (>= 3.0)
+  rubocop
+  simplecov
 
 BUNDLED WITH
    1.13.6

data/README.md

@@ -96,8 +96,14 @@ end
 
 #### Check optional and required variables
 
+Inline passing the variables with the shell:
+
     $ env-checker check --optional MyOptVar1 MyOptVar2 --required MyReqVar1 MyReqVar2
 
+Example with a `.yml` [example file](https://raw.githubusercontent.com/ryanfox1985/env-checker/master/sample_config.yml):
+
+    $ env-checker check --config_file sample_config.yml
+
 #### Show help
 
     $ env-checker help

data/env-checker.gemspec

@@ -32,11 +32,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_runtime_dependency 'thor', '~> 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'
+  spec.add_runtime_dependency 'thor', '>= 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'
+  spec.add_development_dependency 'byebug', '>= 9.0.5'
 end

data/exe/env-checker

@@ -2,4 +2,4 @@
 
 require 'env_checker'
 
-CLI.start(ARGV)
+EnvChecker::CLI.start(ARGV)

data/lib/env_checker.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+require 'yaml'
 require 'env_checker/version'
 require 'env_checker/missing_keys_error'
 require 'env_checker/configuration'
@@ -19,12 +20,14 @@ module EnvChecker
     end
 
     def configure
-      self.configuration ||= Configuration.new
+      self.configuration = Configuration.new
       yield(configuration)
     end
 
     def cli_configure_and_check(options)
-      return if !options[:optional] && !options[:required]
+      return if !options[:optional] &&
+                !options[:required] &&
+                !options[:config_file]
 
       self.configuration = create_config_from_parameters(options)
 
@@ -39,6 +42,15 @@ module EnvChecker
 
     def create_config_from_parameters(options)
       config = Configuration.new
+
+      if options[:config_file]
+        from_file = YAML.load_file(options[:config_file])
+        config.optional_variables = from_file['optional_variables']
+        config.required_variables = from_file['required_variables']
+
+        return config
+      end
+
       config.optional_variables = options[:optional] if options[:optional]
       config.required_variables = options[:required] if options[:required]
 

data/lib/env_checker/cli.rb

@@ -1,21 +1,25 @@
 require 'thor'
 
-class CLI < Thor
-  desc 'version', 'EnvChecker version.'
-  def version
-    puts "EnvChecker #{EnvChecker::VERSION}"
-  end
+module EnvChecker
+  class CLI < Thor
+    desc 'version', 'EnvChecker version.'
+    def version
+      puts "EnvChecker #{EnvChecker::VERSION}"
+    end
 
-  option :required, :aliases => :r, :type => :array
-  option :optional, :aliases => :o, :type => :array
-  desc 'check', 'check environment variables'
-  def check
-    output = []
-    output << 'Variables: '
-    output << "- Optional: #{options[:optional]}" if options[:optional]
-    output << "- Required: #{options[:required]}" if options[:required]
-    puts output.join("\n")
+    option :config_file, :aliases => :cf, :type => :string
+    option :required, :aliases => :r, :type => :array
+    option :optional, :aliases => :o, :type => :array
+    desc 'check', 'Check optional and required environment variables.'
+    def check
+      output = []
+      output << 'Variables: '
+      output << "- Config file: #{options[:config_file]}" if options[:config_file]
+      output << "- Optional: #{options[:optional]}" if options[:optional]
+      output << "- Required: #{options[:required]}" if options[:required]
+      puts output.join("\n")
 
-    EnvChecker.cli_configure_and_check(options)
+      EnvChecker.cli_configure_and_check(options)
+    end
   end
 end

data/lib/env_checker/version.rb

@@ -1,3 +1,3 @@
 module EnvChecker
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/sample_config.yml

@@ -0,0 +1,6 @@
+optional_variables:
+  - MyOptVar1
+  - MyOptVar2
+required_variables:
+  - MyReqVar1
+  - MyReqVar2  

data/test_config.yml

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

metadata

@@ -1,113 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: env-checker
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Guillermo Guerrero Ibarra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   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: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   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: 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:
-    - - "~>"
+    - - ">="
       - !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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.5
 description: |2
       When you are developing a new feature if your app have some environments
       like test, staging and production is easy to forget an environment variable
@@ -140,6 +154,8 @@ files:
 - lib/env_checker/configuration.rb
 - lib/env_checker/missing_keys_error.rb
 - lib/env_checker/version.rb
+- sample_config.yml
+- test_config.yml
 homepage: https://github.com/ryanfox1985/env-checker
 licenses:
 - MIT