get_env 0.2.0.pre3 → 0.2.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bba82e71b1cff0bda4ff516323e391680d6c5d18d96981f1a4434c702ad5a544
-  data.tar.gz: 26782f15c8f3e8cfb493d2629ec22fe12fe517fc969fcadc72e17c2f597a2f8a
+  metadata.gz: 2a89e2cc9d400fab0b30d9b74201547f3d08f6609b32869e9b32c5e1fb4984a2
+  data.tar.gz: b85bde1e2d563e9cf7481836eeea2eed8a9fc571022bb737bf74b7bd8636b449
 SHA512:
-  metadata.gz: e2a32b34e46a3f38736eeeea7ed99694da08bb62d19ae2dbd213c75ebeabb59bd3e37a016eebfb1e72ff43570561ebf873193c80fe88dfe8f4724d02131a6cac
-  data.tar.gz: 52054e2cdf526fd255fc12d77d94c19ea0ec1732721b501203bcdb50143324308ae97db90eac599c27890a3314cd5fd8580261a087bbd9aa204e0d472c06c1ba
+  metadata.gz: f3634e108a5c48ab5262a9855ab6f94cbf4a01443982698f674e14d39113fcdfa48e187904f73711394b1ef90e13df21165fdf3322ba9b303577f7928246271c
+  data.tar.gz: 56923245058d42eca837afb64b6289b4bda520e7c5955d107bb519ff8738499b630db739a38c1f92f1a43106b596b7edd3a08e8bbc0134c6dc45d31c186886b2

data/lib/get_env.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'get_env/version'
-require 'get_env/cops'
 
 module GetEnv
   def self.[](key)

data/lib/get_env/cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative '../rubocop/cop/lint/no_env'

data/lib/get_env/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GetEnv
-  VERSION = '0.2.0.pre3'
+  VERSION = '0.2.0.pre4'
 end

data/lib/rubocop/cop/lint/no_env.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # @example
+      #   # bad
+      #   ENV[]
+      #
+      #   # bad
+      #   ENV.fetch(..)
+      #
+      #   # good
+      #   GetEnv[]
+      #
+      #   # good
+      #   GetEnv.fetch(...)
+      class NoENV < Cop
+        MSG = 'Use `GetEnv` instead of `ENV`.'
+
+        def_node_matcher :is_ENV_index?, '(send (const nil? :ENV) :[] _key)'
+        def_node_matcher :is_ENV_fetch?, '(send (const nil? :ENV) :fetch _key ...)'
+
+        def on_const(node)
+          parent = node.parent
+          return unless is_ENV_index?(parent) || is_ENV_fetch?(parent)
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            if Gem::Version.new(RuboCop::Version.version) >= Gem::Version.new('0.82.0')
+              corrector.replace(node, 'GetEnv')
+            else
+              corrector.replace(node.loc.expression, 'GetEnv')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/get_env_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+RSpec.describe GetEnv do
+  before(:all) do
+    ENV['SOME_STRING'] = 'foo'
+    ENV['SOME_INT'] = '1'
+    ENV['SOME_FLOAT'] = '1.23'
+    ENV['SOME_TRUE'] = 'true'
+    ENV['SOME_FALSE'] = 'false'
+  end
+
+  it "has a version number" do
+    expect(GetEnv::VERSION).not_to be nil
+  end
+
+  describe '#[]' do
+    it 'handles nil' do
+      expect(GetEnv[nil]).to eq(nil)
+    end
+
+    it 'handles missing value' do
+      expect(GetEnv['klfadjslfkadjsflkadjs']).to eq(nil)
+    end
+
+    it 'returns strings' do
+      expect(GetEnv['SOME_STRING']).to eq('foo')
+    end
+
+    it 'casts ints' do
+      expect(GetEnv['SOME_INT']).to eq(1)
+    end
+
+    it 'casts floats' do
+      expect(GetEnv['SOME_FLOAT']).to eq(1.23)
+    end
+
+    it 'casts bools' do
+      expect(GetEnv['SOME_TRUE']).to be(true)
+      expect(GetEnv['SOME_FALSE']).to be(false)
+    end
+  end
+
+  describe '#fetch' do
+    it 'casts types' do
+      expect(GetEnv.fetch('SOME_FLOAT')).to eq(1.23)
+    end
+
+    it 'returns the value when found' do
+      expect(GetEnv.fetch('SOME_FLOAT', 3.21)).to eq(1.23)
+    end
+
+    it 'returns the defaults when not found' do
+      expect(GetEnv.fetch('SOME_NON_EXISTANT_FLOAT', 3.21)).to eq(3.21)
+    end
+
+    it 'raises an exception if not found and no default is specified' do
+      expect do
+        GetEnv.fetch('SOME_NON_EXISTANT_FLOAT')
+      end.to raise_error KeyError, /key not found: "SOME_NON_EXISTANT_FLOAT"/
+    end
+
+    it 'accepts a block for the default value' do
+      v = GetEnv.fetch('SOME_NON_EXISTANT_FLOAT') { 3.21 }
+      expect(v).to eq(3.21)
+    end
+  end
+end

data/spec/rubocop/cop/lint/no_env_spec.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'rubocop/rspec/support'
+require_relative '../../../../lib/rubocop/cop/lint/no_env'
+
+RSpec.describe RuboCop::Cop::Lint::NoENV do
+  include RuboCop::RSpec::ExpectOffense
+
+  let(:config) { RuboCop::Config.new }
+
+  subject(:cop) { described_class.new(config) }
+
+  describe '#[]' do
+    it 'registers an offense when using `ENV`' do
+      expect_offense(<<~RUBY)
+        FOO = ENV['FOO']
+              ^^^ Use `GetEnv` instead of `ENV`.
+      RUBY
+
+      expect_correction(<<~RUBY)
+        FOO = GetEnv['FOO']
+      RUBY
+    end
+
+    it 'does not register an offense when using `GetEnv`' do
+      expect_no_offenses(<<~RUBY)
+        FOO = GetEnv['FOO']
+      RUBY
+    end
+  end
+
+  describe '#fetch' do
+    it 'registers an offense when using `ENV`' do
+      expect_offense(<<~RUBY)
+        do_the_thing(ENV.fetch('FOO'))
+                     ^^^ Use `GetEnv` instead of `ENV`.
+      RUBY
+
+      expect_correction(<<~RUBY)
+        do_the_thing(GetEnv.fetch('FOO'))
+      RUBY
+    end
+
+    it 'registers an offense when using `ENV` with a default value' do
+      expect_offense(<<~RUBY)
+        a = x + ENV.fetch('FOO', 42)
+                ^^^ Use `GetEnv` instead of `ENV`.
+      RUBY
+
+      expect_correction(<<~RUBY)
+        a = x + GetEnv.fetch('FOO', 42)
+      RUBY
+    end
+
+    it 'does not register an offense when using `GetEnv`' do
+      expect_no_offenses(<<~RUBY)
+        do_the_thing(GetEnv.fetch('FOO'))
+      RUBY
+    end
+
+    it 'does not register an offense when using `GetEnv` with a default value' do
+      expect_no_offenses(<<~RUBY)
+        a = x + GetEnv.fetch('FOO', 42)
+      RUBY
+    end
+  end
+
+  it 'does not register an offense when using `ENV` for a method not defined by `GetEnv`' do
+    expect_no_offenses(<<~RUBY)
+      ENV.map do |var|
+        foo << var.lowercase
+      end
+    RUBY
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "get_env"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: get_env
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre3
+  version: 0.2.0.pre4
 platform: ruby
 authors:
 - Simon Mathieu
 - Bartek Kruszczynski
 - Jonathan Barber
+- Paul Padier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,12 +87,18 @@ description: Read values from ENV in a reasonable way
 email:
 - bartek@rainforestqa.com
 - jonathan@rainforestqa.com
+- pp@rainforestqa.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/get_env.rb
+- lib/get_env/cops.rb
 - lib/get_env/version.rb
+- lib/rubocop/cop/lint/no_env.rb
+- spec/get_env_spec.rb
+- spec/rubocop/cop/lint/no_env_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/rainforestapp/get_env
 licenses:
 - MIT
@@ -115,4 +122,7 @@ rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Read values from ENV in a reasonable way
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/rubocop/cop/lint/no_env_spec.rb
+- spec/get_env_spec.rb