envee 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f94f269e8d206155b0b450605a6d6c8583b691e
-  data.tar.gz: 7c00b33fbdabc979917bff9252082061953b4b66
+  metadata.gz: 824832af193657ff86be9e8cf81cdbd88bbe7083
+  data.tar.gz: 5acc339405e11452663c18095845538157a69bae
 SHA512:
-  metadata.gz: 40bb0f11403e0a96e5ad0fcdbb3c7d528b849854c202ffa0d6402635e5dc69dbd833acaec456fa247b2f8a4c57146b33d896e51b3291df7a6a66cd1830b8731b
-  data.tar.gz: 283fb912b6021af77e8511d5cf5cc5ddd9261fc71d0e1e9564830c222d1d241dd94958dc187560a16934c95f0f15eb1bb313206268e46b4865e6849761d29faf
+  metadata.gz: 01aebb8fe0d719957bc87e3a4045b7cf54d5ab3ab94d95b3261321aeb7a6eb6f84b5d6dcd4ff86d4219b4eecdad4fa8ffdabaa04baf1d6c361027a52f11bb562
+  data.tar.gz: 80f9ae958f80e6218f19a62f2dde7db177f3dc23beccb165a589a13d62d515ffa6632e8d2e8176533a02d33e893b3746e85b215ac6a975e854f8b37e907be04e

data/.rubocop.yml

@@ -0,0 +1,467 @@
+# Common configuration.
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+    - '**/Rakefile'
+    - '**/*.rake'
+    - '**/Gemfile'
+  Exclude:
+    - 'vendor/**'
+  RunRailsCops: false
+
+# Indent private/protected/public as deep as method definitions
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+  SupportedStyles:
+    - outdent
+    - indent
+
+# Indentation of `when`.
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: false
+
+ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 200
+
+# Align ends correctly.
+EndAlignment:
+  # The value `keyword` means that `end` should be aligned with the matching
+  # keyword (if, while, etc.).
+  # The value `variable` means that in assignments, `end` should be aligned
+  # with the start of the variable on the left hand side of `=`. In all other
+  # situations, `end` should still be aligned with the keyword.
+  AlignWith: variable
+  SupportedStyles:
+    - keyword
+    - variable
+
+# Built-in global variables are allowed by default.
+GlobalVars:
+  AllowedVariables: ['$1', '$2', '$3', '$4', '$5', '$6']
+
+LineLength:
+  Max: 120
+
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+
+NumericLiterals:
+  MinDigits: 10
+
+SignalException:
+  EnforcedStyle: only_raise
+  SupportedStyles:
+    - only_raise
+    - only_fail
+    - semantic
+
+SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
+SpaceInsideBlockBraces:
+  EnforcedStyle: no_space
+  SupportedStyles:
+    - space
+    - no_space
+  # Valid values are: space, no_space
+  EnforcedStyleForEmptyBraces: no_space
+  # Space between { and |. Overrides EnforcedStyle if there is a conflict.
+  SpaceBeforeBlockParameters: false
+
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
+# Checks whether the source file has a utf-8 encoding comment or not
+Encoding:
+  EnforcedStyle: when_needed
+  SupportedStyles:
+    - when_needed
+    - always
+
+WordArray:
+  MinSize: 0
+
+##########################################################################
+####################### DEFAULTS FROM RUBOCOP ############################
+##########################################################################
+
+# Align the elements of a hash literal if they span more than one line.
+AlignHash:
+  # Alignment of entries using hash rocket as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   'a' => 2
+  #   'bb' => 3
+  # separator - alignment of hash rockets, keys are right aligned
+  #    'a' => 2
+  #   'bb' => 3
+  # table - left alignment of keys, hash rockets, and values
+  #   'a'  => 2
+  #   'bb' => 3
+  EnforcedHashRocketStyle: key
+  # Alignment of entries using colon as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   a: 0
+  #   bb: 1
+  # separator - alignment of colons, keys are right aligned
+  #    a: 0
+  #   bb: 1
+  # table - left alignment of keys and values
+  #   a:  0
+  #   bb: 1
+  EnforcedColonStyle: key
+  # Select whether hashes that are the last argument in a method call should be
+  # inspected? Valid values are:
+  #
+  # always_inspect - Inspect both implicit and explicit hashes.
+  #   Registers and offence for:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offence for:
+  #     function({a: 1,
+  #       b: 2})
+  # always_ignore - Ignore both implicit and explicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_implicit - Ingore only implicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offence for:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_explicit - Ingore only explicit hashes.
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  #   Registers an offence for:
+  #     function(a: 1,
+  #       b: 2)
+  EnforcedLastArgumentHashStyle: always_inspect
+  SupportedLastArgumentHashStyles:
+    - always_inspect
+    - always_ignore
+    - ignore_implicit
+    - ignore_explicit
+
+AlignParameters:
+  # Alignment of parameters in multi-line method calls.
+  #
+  # The `with_first_parameter` style aligns the following lines along the same column
+  # as the first parameter.
+  #
+  #     method_call(a,
+  #                 b)
+  #
+  # The `with_fixed_indentation` style alignes the following lines with one
+  # level of indenation relative to the start of the line with the method call.
+  #
+  #     method_call(a,
+  #       b)
+  EnforcedStyle: with_first_parameter
+  SupportedStyles:
+    - with_first_parameter
+    - with_fixed_indentation
+
+# Allow safe assignment in conditions.
+AssignmentInCondition:
+  AllowSafeAssignment: true
+
+BlockNesting:
+  Max: 3
+
+BracesAroundHashParameters:
+  EnforcedStyle: no_braces
+  SupportedStyles:
+    - braces
+    - no_braces
+
+ClassAndModuleChildren:
+  # Checks the style of children definitions at classes and modules.
+  #
+  # Basically there are two different styles:
+  #
+  # `nested` - have each child on a separat line
+  #   class Foo
+  #     class Bar
+  #     end
+  #   end
+  #
+  # `compact` - combine definitions as much as possible
+  #   class Foo::Bar
+  #   end
+  #
+  # The compact style is only forced, for classes / modules with one child.
+  EnforcedStyle: nested
+  SupportedStyles:
+    - nested
+    - compact
+
+# Align with the style guide.
+CollectionMethods:
+  # Mapping from undesired method to desired_method
+  # e.g. to use `detect` over `find`:
+  #
+  # CollectionMethods:
+  #   PreferredMethods:
+  #     find: detect
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+# Checks formatting of special comments
+CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+# Avoid complex methods.
+CyclomaticComplexity:
+  Max: 6
+
+# Multi-line method chaining should be done with leading dots.
+DotPosition:
+  EnforcedStyle: leading
+  SupportedStyles:
+    - leading
+    - trailing
+
+# Use empty lines between defs.
+EmptyLineBetweenDefs:
+  # If true, this parameter means that single line method definitions don't
+  # need an empty line between them.
+  AllowAdjacentOneLineDefs: false
+
+FileName:
+  Exclude:
+    - Rakefile
+    - Gemfile
+    - Capfile
+
+# Checks use of for or each in multiline loops.
+For:
+  EnforcedStyle: each
+  SupportedStyles:
+    - for
+    - each
+
+# Enforce the method used for string formatting.
+FormatString:
+  EnforcedStyle: format
+  SupportedStyles:
+    - format
+    - sprintf
+    - percent
+
+HashSyntax:
+  EnforcedStyle: ruby19
+  SupportedStyles:
+    - ruby19
+    - hash_rockets
+
+IfUnlessModifier:
+  MaxLineLength: 79
+
+# Checks the indentation of the first key in a hash literal.
+IndentHash:
+  # The value `special_inside_parentheses` means that hash literals with braces
+  # that have their opening brace on the same line as a surrounding opening
+  # round parenthesis, shall have their first key indented relative to the
+  # first position inside the parenthesis.
+  # The value `consistent` means that the indentation of the first key shall
+  # always be relative to the first position of the line where the opening
+  # brace is.
+  EnforcedStyle: special_inside_parentheses
+  SupportedStyles:
+    - special_inside_parentheses
+    - consistent
+
+LambdaCall:
+  EnforcedStyle: call
+  SupportedStyles:
+    - call
+    - braces
+
+MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+  SupportedStyles:
+    - require_parentheses
+    - require_no_parentheses
+
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 10
+
+MethodName:
+  EnforcedStyle: snake_case
+  SupportedStyles:
+    - snake_case
+    - camelCase
+
+ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+# Allow safe assignment in conditions.
+ParenthesesAroundCondition:
+  AllowSafeAssignment: true
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': ()
+    '%W': ()
+    '%x': ()
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+    - has_
+    - have_
+
+RaiseArgs:
+  EnforcedStyle: exploded
+  SupportedStyles:
+    - compact # raise Exception.new(msg)
+    - exploded # raise Exception, msg
+
+
+RedundantReturn:
+  # When true allows code like `return x, y`.
+  AllowMultipleReturnValues: false
+
+Semicolon:
+  # Allow ; to separate several expressions on the same line.
+  AllowAsExpressionSeparator: false
+
+SingleLineBlockParams:
+  Methods:
+    - reduce:
+        - a
+        - e
+    - inject:
+        - a
+        - e
+
+SingleLineMethods:
+  AllowIfMethodIsEmpty: true
+
+StringLiterals:
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+
+SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+  SupportedStyles:
+    - space
+    - no_space
+
+TrailingComma:
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+    - comma
+    - no_comma
+
+# TrivialAccessors doesn't require exact name matches and doesn't allow
+# predicated methods by default.
+TrivialAccessors:
+  ExactNameMatch: false
+  AllowPredicates: false
+  # Allows trivial writers that don't end in an equal sign. e.g.
+  #
+  # def on_exception(action)
+  #   @on_exception=action
+  # end
+  # on_exception :restart
+  #
+  # Commonly used in DSLs
+  AllowDSLWriters: false
+  Whitelist:
+    - to_ary
+    - to_a
+    - to_c
+    - to_enum
+    - to_h
+    - to_hash
+    - to_i
+    - to_int
+    - to_io
+    - to_open
+    - to_path
+    - to_proc
+    - to_r
+    - to_regexp
+    - to_str
+    - to_s
+    - to_sym
+
+VariableName:
+  EnforcedStyle: snake_case
+  SupportedStyles:
+    - snake_case
+    - camelCase
+
+WhileUntilModifier:
+  MaxLineLength: 79
+
+##################### Rails ##################################
+
+ActionFilter:
+  EnforcedStyle: action
+  SupportedStyles:
+    - action
+    - filter
+  Include:
+    - app/controllers/*.rb
+
+DefaultScope:
+  Include:
+    - app/models/*.rb
+
+HasAndBelongsToMany:
+  Include:
+    - app/models/*.rb
+
+ReadWriteAttribute:
+  Include:
+    - app/models/*.rb
+
+ScopeArgs:
+  Include:
+    - app/models/*.rb
+
+Validation:
+  Include:
+    - app/models/*.rb

data/Rakefile

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

data/envee.gemspec

@@ -4,20 +4,20 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'envee/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "envee"
+  spec.name          = 'envee'
   spec.version       = Envee::VERSION
-  spec.authors       = ["Allen Madsen"]
-  spec.email         = ["blatyo@gmail.com"]
+  spec.authors       = ['Allen Madsen']
+  spec.email         = ['blatyo@gmail.com']
   spec.summary       = 'Provides casting wrappers around fetch for environment variables.'
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}){|f| File.basename(f)}
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
 end

data/lib/envee.rb

@@ -1,7 +1,9 @@
 require 'envee/version'
 require 'time'
 
+# Adds casting fetchers and validation for values filled with a placeholder.
 module Envee
+  # Error thrown by validate when there are missing keys
   class MissingValuesError < StandardError
     def initialize(missing_keys)
       super(
@@ -15,14 +17,22 @@ module Envee
     Integer(fetch(*args, &block))
   end
 
+  def fl(*args, &block)
+    Float(fetch(*args, &block))
+  end
+
   def str(*args, &block)
     String(fetch(*args, &block))
   end
 
+  def sym(*args, &block)
+    String(fetch(*args, &block)).to_sym
+  end
+
   def bool(*args, &block)
     value = fetch(*args, &block)
 
-    value && value !~ /^(0|no|false|off|)$/i
+    value && value !~ /\A(0|no|false|off|nil|null|)\z/i
   end
 
   def time(*args, &block)
@@ -38,9 +48,9 @@ module Envee
   end
 
   def validate!(options)
-    missing = options[:missing_value]
-    missing_keys = select{|k, v| v.include?(missing)}.map(&:first)
-    raise MissingValuesError.new(missing_keys) unless missing_keys.empty?
+    missing = options[:placeholder] || 'CHANGEME'
+    missing_keys = select{|_k, v| v.include?(missing)}.map(&:first)
+    raise MissingValuesError, missing_keys unless missing_keys.empty?
   end
 end
 

data/lib/envee/version.rb

@@ -1,3 +1,4 @@
+# Version
 module Envee
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/spec/envee_spec.rb

@@ -41,6 +41,40 @@ describe Envee do
     end
   end
 
+  describe '#fl' do
+    context 'when requesting a value in env without default' do
+      it 'returns env value casted as float' do
+        env['NUM'] = '1.0'
+        expect(env.fl('NUM')).to eq(1.0)
+      end
+    end
+
+    context 'when requesting a value not in env with a default value' do
+      it 'returns the default value casted as float' do
+        expect(env.fl('NUM', '2.1')).to eq(2.1)
+      end
+    end
+
+    context 'when requesting a value not in env with a default block' do
+      it 'returns the default block value casted as float' do
+        expect(env.fl('NUM'){'2.1'}).to eq(2.1)
+      end
+    end
+
+    context 'when requesting a value not in env with no default' do
+      it 'raises an KeyError' do
+        expect{env.fl('NUM')}.to raise_error(KeyError)
+      end
+    end
+
+    context 'when requesting a value in env that cannot be casted to float' do
+      it 'raises an ArgumentError' do
+        env['NUM'] = 'a'
+        expect{env.fl('NUM')}.to raise_error(ArgumentError)
+      end
+    end
+  end
+
   describe '#str' do
     context 'when requesting a value in env without default' do
       it 'returns env value casted as string' do
@@ -68,6 +102,33 @@ describe Envee do
     end
   end
 
+  describe '#sym' do
+    context 'when requesting a value in env without default' do
+      it 'returns env value casted as symbol' do
+        env['NUM'] = '1'
+        expect(env.sym('NUM')).to eq(:'1')
+      end
+    end
+
+    context 'when requesting a value not in env with a default value' do
+      it 'returns the default value casted as symbol' do
+        expect(env.sym('NUM', 2)).to eq(:'2')
+      end
+    end
+
+    context 'when requesting a value not in env with a default block' do
+      it 'returns the default block value casted as symbol' do
+        expect(env.sym('NUM'){2}).to eq(:'2')
+      end
+    end
+
+    context 'when requesting a value not in env with no default' do
+      it 'raises an KeyError' do
+        expect{env.sym('NUM')}.to raise_error(KeyError)
+      end
+    end
+  end
+
   describe '#bool' do
     context 'when requesting a value in env without default' do
       it 'returns env value casted as truthy' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envee
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Allen Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Provides casting wrappers around fetch for environment variables.