envied 0.9.3 → 0.10.0.alpha1

data/bin/console

@@ -6,9 +6,5 @@ require "envied"
 # 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.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require 'pry'
+Pry.start

data/bin/envied

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby -Ilib
+
 require 'envied'
 
-ENVied::Cli.start
+ENVied::Cli.start

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/envied.gemspec

@@ -6,23 +6,33 @@ require "envied/version"
 Gem::Specification.new do |spec|
   spec.name          = "envied"
   spec.version       = ENVied::VERSION
-  spec.authors       = ["Gert Goet", "Javier Julio"]
-  spec.email         = ["gert@thinkcreate.nl", "jjfutbol@gmail.com"]
+  spec.authors       = ["Gert Goet"]
+  spec.email         = ["gert@thinkcreate.nl"]
   spec.summary       = %q{Ensure presence and type of ENV-variables}
   spec.description   = %q{Ensure presence and type of your app's ENV-variables.}
   spec.homepage      = "https://gitlab.com/envied/envied/tree/master#envied"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/envied/envied.git"
+  spec.metadata["changelog_uri"] = "https://gitlab.com/envied/envied/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 2.4"
 
-  spec.add_dependency "thor", "~> 0.15"
+  spec.add_dependency "thor", "~> 0.20"
 
   spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.12"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/examples/extensive_envfile

@@ -1,6 +1,4 @@
 # -*- mode: ruby -*-¬
-# NOTE: defaults are deprecated and will be removed in > v0.9
-
 # We allow defaults for local development (and local tests), but want our CI
 # to mimic our production as much as possible.
 # New developers that don't have RACK_ENV set, will in this way not be presented with a huge

data/exe/envied

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'envied'
+
+ENVied::Cli.start

data/lib/envied.rb

@@ -5,6 +5,7 @@ require 'envied/coercer'
 require 'envied/coercer/envied_string'
 require 'envied/variable'
 require 'envied/configuration'
+require 'envied/env_interceptor'
 
 class ENVied
   class << self
@@ -18,6 +19,7 @@ class ENVied
     error_on_missing_variables!(options)
     error_on_uncoercible_variables!(options)
 
+    intercept_env_vars!
     ensure_spring_after_fork_require(args, options)
   end
 
@@ -52,6 +54,20 @@ class ENVied
     result.any? ? result.map(&:to_sym) : [:default]
   end
 
+  def self.env_keys_to_intercept
+    config.variables.select {|var| var.type == :env }.map{|var| var.name.to_s }
+  end
+
+  def self.intercept_env_vars!
+    if (keys = env_keys_to_intercept).any?
+      ENV.instance_eval { @__envied_env_keys = keys }
+      class << ENV
+        prepend(ENVied::EnvInterceptor)
+      end
+    end
+  end
+  private_class_method :intercept_env_vars!, :env_keys_to_intercept
+
   def self.ensure_spring_after_fork_require(args, **options)
     if spring_enabled? && !options[:via_spring]
       Spring.after_fork { ENVied.require(args, options.merge(via_spring: true)) }
@@ -83,4 +99,5 @@ class ENVied
   def self.respond_to_missing?(method, include_private = false)
     (env && env.has_key?(method)) || super
   end
+
 end

data/lib/envied/cli.rb

@@ -70,6 +70,9 @@ class ENVied
     option :groups, type: :array, desc: "uses ENV['ENVIED_GROUPS'] as default if present", default: ENV['ENVIED_GROUPS'] || %w(default), banner: 'default production'
     option :quiet, type: :boolean, desc: 'Communicate success of the check only via the exit status.'
     def check
+      if rails_project?
+        require File.expand_path 'config/environment.rb'
+      end
       ENVied.require(*options[:groups])
       unless options[:quiet]
         puts "All variables for group(s) #{options[:groups]} are present and valid"
@@ -126,5 +129,11 @@ class ENVied
       template("heroku-env-check.tt", full_dest)
       FileUtils.chmod 0755, full_dest
     end
+
+    no_tasks do
+      def rails_project?
+        File.exists?('config/environment.rb')
+      end
+    end
   end
 end

data/lib/envied/coercer.rb

@@ -22,7 +22,7 @@ class ENVied::Coercer
 
   def self.supported_types
     @supported_types ||= begin
-      [:hash, :array, :time, :date, :symbol, :boolean, :integer, :string, :uri, :float].sort
+      [:env, :hash, :array, :time, :date, :symbol, :boolean, :integer, :string, :uri, :float].sort
     end
   end
 

data/lib/envied/coercer/envied_string.rb

@@ -39,6 +39,10 @@ class ENVied::Coercer::ENViedString
     end
   end
 
+  def to_env(string)
+    to_string(string)
+  end
+
   def to_symbol(str)
     str.to_sym
   end

data/lib/envied/configuration.rb

@@ -1,13 +1,25 @@
 class ENVied
   class Configuration
-    attr_reader :current_group, :defaults_enabled, :coercer
+    attr_reader :current_group, :coercer
 
     def initialize(**options, &block)
       @coercer = options.fetch(:coercer, Coercer.new)
-      @defaults_enabled = options.fetch(:enable_defaults, defaults_enabled_default)
+      @key_alias = options[:key_alias]
       instance_eval(&block) if block_given?
     end
 
+    def key_alias!(value = false, &block)
+      @key_alias = block_given? ? block.call : value
+    end
+
+    def key_alias
+      @key_alias && @key_alias.to_s.upcase
+    end
+
+    def enable_defaults!(*args)
+      raise "Defaults are no longer supported. See https://gitlab.com/envied/envied/tree/master#what-happened-to-default-values for the recommended upgrade-path, or pin the gem to 0.9-release (e.g. `gem 'envied', '~> 0.9.2'`) to keep using defaults."
+    end
+
     def self.load(**options)
       envfile = File.expand_path('Envfile')
       new(options).tap do |v|
@@ -15,17 +27,6 @@ class ENVied
       end
     end
 
-    def enable_defaults!(value = true, &block)
-      default_values_deprecation
-      @defaults_enabled = block_given? ? block.call : value
-    end
-
-    def defaults_enabled?
-      @defaults_enabled.respond_to?(:call) ?
-        @defaults_enabled.call :
-        @defaults_enabled
-    end
-
     def variable(name, type = :string, **options)
       unless coercer.supported_type?(type)
         raise ArgumentError, "#{type.inspect} is not a supported type. Should be one of #{coercer.supported_types}"
@@ -46,24 +47,5 @@ class ENVied
     def variables
       @variables ||= []
     end
-
-    private
-
-    def default_values_deprecation
-      warning = "Default values will be removed in the next minor-release of ENVied (i.e. > v0.9). For more info see https://gitlab.com/envied/envied/tree/0-9-releases#defaults."
-      if defined?(ActiveSupport::Deprecation)
-        ActiveSupport::Deprecation.warn warning
-      else
-        $stderr.puts "DEPRECATION WARNING: #{warning}"
-      end
-    end
-
-    def defaults_enabled_default
-      if ENV['ENVIED_ENABLE_DEFAULTS'].nil?
-        false
-      else
-        @coercer.coerce(ENV['ENVIED_ENABLE_DEFAULTS'], :boolean)
-      end
-    end
   end
 end

data/lib/envied/env_interceptor.rb

@@ -0,0 +1,19 @@
+class ENVied
+  module EnvInterceptor
+    def [](key)
+      if @__envied_env_keys.include?(key)
+        ENVied.public_send(key)
+      else
+        super
+      end
+    end
+
+    def fetch(key, *args)
+      if @__envied_env_keys.include?(key)
+        ENVied.public_send(key)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/envied/env_proxy.rb

@@ -28,7 +28,6 @@ class ENVied
 
     def value_to_coerce(var)
       return env_value_of(var) unless env_value_of(var).nil?
-      config.defaults_enabled? ? default_value_of(var) : nil
     end
 
     private
@@ -47,12 +46,16 @@ class ENVied
       coercer.coercible?(value_to_coerce(var), var.type)
     end
 
-    def default_value_of(var)
-      var.default_value(ENVied, var)
+    def env_value_of(var)
+      ENV.values_at(*env_keys(var, key_alias: config.key_alias)).compact.first
     end
 
-    def env_value_of(var)
-      ENV[var.name.to_s]
+    def env_keys(var, key_alias: nil)
+      base_key = var.name.to_s
+
+      result = [base_key]
+      result.unshift "#{base_key}_#{key_alias}" if key_alias
+      result
     end
 
     def missing?(var)

data/lib/envied/templates/Envfile.tt

@@ -1,7 +1,9 @@
-# A sample Envfile
-# enable_defaults! { ENV['RACK_ENV'] != 'production' }
+#
+# Allow ENV['FOO_<key_alias>'] to provide for ENVied.FOO (with ENV['FOO']
+# as fallback).
+# key_alias! { Rails.env }
 
-# variable :REDIS_URL, :string, default: 'redis://localhost:6379'
+# variable :REDIS_URL, :string
 #
 # group :production do
 #   variable :SECRET_KEY_BASE

data/lib/envied/variable.rb

@@ -1,23 +1,14 @@
 class ENVied::Variable
-  attr_reader :name, :type, :group, :default
+  attr_reader :name, :type, :group
 
   def initialize(name, type, **options)
     @name = name.to_sym
     @type = type.to_sym
     @group = options.fetch(:group, :default).to_sym
-    @default = options[:default]
-
-    #if !@default.is_a? String
-    #  raise ArgumentError, "Default values should be strings (variable #{@name})"
-    #end
-  end
-
-  def default_value(*args)
-    default.respond_to?(:call) ? default[*args] : default
   end
 
   def ==(other)
     self.class == other.class &&
-      [name, type, group, default] == [other.name, other.type, other.group, other.default]
+      [name, type, group] == [other.name, other.type, other.group]
   end
 end

data/lib/envied/version.rb

@@ -1,3 +1,3 @@
 class ENVied
-  VERSION = '0.9.3'
+  VERSION = '0.10.0.alpha1'
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.10.0.alpha1
 platform: ruby
 authors:
 - Gert Goet
-- Javier Julio
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -17,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +83,13 @@ dependencies:
 description: Ensure presence and type of your app's ENV-variables.
 email:
 - gert@thinkcreate.nl
-- jjfutbol@gmail.com
 executables:
-- console
 - envied
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc.sample"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
@@ -86,33 +98,33 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/bundle
 - bin/console
 - bin/envied
+- bin/rspec
 - bin/setup
 - envied.gemspec
 - examples/extensive_envfile
+- exe/envied
 - lib/envied.rb
 - lib/envied/cli.rb
 - lib/envied/coercer.rb
 - lib/envied/coercer/envied_string.rb
 - lib/envied/configuration.rb
+- lib/envied/env_interceptor.rb
 - lib/envied/env_proxy.rb
 - lib/envied/env_var_extractor.rb
 - lib/envied/templates/Envfile.tt
 - lib/envied/templates/heroku-env-check.tt
 - lib/envied/variable.rb
 - lib/envied/version.rb
-- spec/coercer_spec.rb
-- spec/configuration_spec.rb
-- spec/env_var_extractor_spec.rb
-- spec/envied_spec.rb
-- spec/gemspec_spec.rb
-- spec/spec_helper.rb
-- spec/variable_spec.rb
 homepage: https://gitlab.com/envied/envied/tree/master#envied
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://gitlab.com/envied/envied/tree/master#envied
+  source_code_uri: https://gitlab.com/envied/envied.git
+  changelog_uri: https://gitlab.com/envied/envied/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -124,19 +136,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ensure presence and type of ENV-variables
-test_files:
-- spec/coercer_spec.rb
-- spec/configuration_spec.rb
-- spec/env_var_extractor_spec.rb
-- spec/envied_spec.rb
-- spec/gemspec_spec.rb
-- spec/spec_helper.rb
-- spec/variable_spec.rb
+test_files: []