envied 0.9.0 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 803c704396a34b45112c1e893d902f616146d826
-  data.tar.gz: 2886267c88374d9b75d02920f55ca0df9e025244
+SHA256:
+  metadata.gz: dcc781ac6f01f4925045b61ca88d14b41dbccebe46dc34582a391c884bb99e4a
+  data.tar.gz: 542a7c711445013a845478f716cddf7ac82b7834365429ebf24ed36b08462ca2
 SHA512:
-  metadata.gz: 721fa2f72d8fbba07714eaf8efdaa93bd48b045defb67fdd4d2e0a56e7d78fe132e152a68762fe1586138b6624b6c2ea16a80ab9cd16f13b7bb22f8b26750c64
-  data.tar.gz: 44567081a050048fc3eec30c4c7746999aaf9d5a26cb6c6f80480d3b4464ae88caa3be21aa1247a96c6304c0050575759bb631bfefa118a0e6ee57b939efb140
+  metadata.gz: 2c976e128a2c3c8ab59c31fbec653aa7fe3b8d01973e92e4da220deff09cdee826c34627ca873d4eb612292f175419914c4235932002422cab3454f72b3da2d8
+  data.tar.gz: f37e48c5f981902d2db3e46dfa2a6101998ef11987e48e59ac9fc8e951d5b48d4e1cc6da756ff9b1860bb01e2abf6c72d0f1563a453f3e412754c2f0b8cfcbbb

data/.gitignore

@@ -1,18 +1,14 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-bin

data/.gitlab-ci.yml

@@ -0,0 +1,49 @@
+.rspec: &rspec
+  stage: test
+  tags:
+    - docker
+  before_script:
+    - "echo 'gem: --no-document' > ~/.gemrc"
+    - gem install bundler
+    - 'git -v || apk --update add git'
+    - bundle install -j $(nproc)
+  script:
+    - bundle exec rake
+
+rspec ruby-2.4:
+  image: ruby:2.4-alpine
+  <<: *rspec
+
+rspec ruby-2.5:
+  image: ruby:2.5-alpine
+  <<: *rspec
+
+rspec ruby-2.6:
+  image: ruby:2.6-alpine
+  <<: *rspec
+
+rspec ruby-2.7:
+  image: ruby:2.7-rc-alpine
+  <<: *rspec
+
+rspec jruby-9.2:
+  image: jruby:9.2-alpine
+  <<: *rspec
+  only:
+    - 0-9-releases
+
+release:
+  stage: deploy
+  image: ruby:2.6-alpine
+  tags:
+    - docker
+  script:
+    - "echo 'gem: --no-document' > ~/.gemrc"
+    - gem install bundler
+    - 'git -v || apk --update add git'
+    - bundle install -j $(nproc)
+    - 'ruby -ryaml -e "puts YAML.dump({rubygems_api_key: ENV.fetch(%{RUBYGEMS_API_KEY})})" > ~/.gem/credentials'
+    - chmod 600 ~/.gem/credentials
+    - bundle exec rake release
+  only:
+    - tags

data/.rspec

@@ -1,3 +1,2 @@
---warnings
---format progress
 --color
+--require spec_helper

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.9.2 / 2019-06-29
+
+* Project moved to GitLab (https://gitlab.com/envied/envied)
+* Now requiring Ruby 2.4+ [#48], [#51]
+* Removed `coercible` dependency as now all coercion functionality is implemented locally. This is a backwards compatible change. [#49]
+* Lots of refactoring and bringing the project up-to-date
+
+### Deprecated
+
+ * default values
+
+    See https://gitlab.com/envied/envied/tree/0-9-releases#defaults
+
+## 0.9.1 / 2017-07-06
+
+* Updates `envied check:heroku` to support multiline ENV variables [#42](../../pull/42)
+
 ## 0.9.0 / 2017-03-01
 
 * Support multiple groups [#16](../../pull/16)

data/Gemfile

@@ -2,6 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in envied.gemspec
 gemspec
-
-gem 'pry'
-gem 'benchmark-ips'

data/README.md

@@ -1,4 +1,4 @@
-# ENVied [![Build Status](https://travis-ci.org/eval/envied.svg?branch=master)](https://travis-ci.org/eval/envied)
+# ENVied [![pipeline status](https://gitlab.com/envied/envied/badges/0-9-releases/pipeline.svg)](https://gitlab.com/envied/envied/commits/0-9-releases) [![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://envied-rb.zulipchat.com/)
 
 ### TL;DR ensure presence and type of your app's ENV-variables.
 
@@ -19,7 +19,6 @@ For the rationale behind this project, see this [blogpost](http://www.gertgoet.c
   * [Groups](#groups)
   * [Defaults](#defaults)
   * [More examples](#more-examples)
-* [Rails](#rails--spring)
 * [Command-line interface](#command-line-interface)
 * [How do I...?](#how-do-i)
 * [Testing](#testing)
@@ -91,7 +90,7 @@ The following types are supported:
 * `:time` (e.g. '14:00')
 * `:hash` (e.g. 'a=1&b=2' becomes `{'a' => '1', 'b' => '2'}`)
 * `:array` (e.g. 'tag1,tag2' becomes `['tag1', 'tag2']`)
-* `:uri` (e.g. 'http://www.google.com' becomes `URI.parse('http://www.google.com')`
+* `:uri` (e.g. 'http://www.google.com' becomes result of `URI.parse('http://www.google.com')`)
 
 ### Groups
 
@@ -134,6 +133,9 @@ ENVied.require(nil)
 
 ### Defaults
 
+> *NOTE*: default values will be removed in the next minor-release (i.e. > v0.9). See https://gitlab.com/envied/envied/tree/master#what-happened-to-default-values for more information and how to migrate.  
+> While your project depends on this feature it's recommended to pin the gem to 0.9-releases, i.e. `gem 'envied', '~> 0.9.3'`.
+
 In order to let other developers easily bootstrap the application, you can assign defaults to variables.
 Defaults can be a value or a `Proc` (see example below).
 
@@ -192,7 +194,7 @@ It assumes a standard project layout (see the default value for the globs-option
 The easiest/quickest is to run:
 
 ```
-$ heroku config | bundle exec envied check:heroku
+$ heroku config --json | bundle exec envied check:heroku
 ```
 
 This is equivalent to having the heroku config as your local environment and running `envied check:heroku --groups default production`.
@@ -220,12 +222,14 @@ bundle exec rspec
 ## Developing
 
 ```bash
-bundle exec pry --gem
+bin/console
 ```
 
 ## Contributing
 
-1. Fork it: http://github.com/eval/envied/fork
+To suggest a new feature, [open an Issue](https://gitlab.com/envied/envied/issues/new) before opening a PR.
+
+1. Fork it: https://gitlab.com/envied/envied/-/forks/new
 2. Create your feature branch: `git checkout -b my-new-feature`
 3. Commit your changes: `git commit -am 'Add some feature'`
 4. Push to the branch: `git push origin my-new-feature`

data/Rakefile

@@ -1,10 +1,6 @@
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec) do |s|
-  s.ruby_opts = %w(-w)
-  s.rspec_opts = '--format progress'
-end
+RSpec::Core::RakeTask.new(:spec)
 
-desc "Run the specs"
 task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+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__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/envied.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["gert@thinkcreate.nl", "jjfutbol@gmail.com"]
   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://github.com/eval/envied"
+  spec.homepage      = "https://gitlab.com/envied/envied/tree/master#envied"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,10 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.1.9"
-  spec.add_dependency "coercible", "~> 1.0"
+  spec.required_ruby_version = ">= 2.4"
+
   spec.add_dependency "thor", "~> 0.15"
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/examples/extensive_envfile

@@ -1,4 +1,6 @@
 # -*- 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/lib/envied/cli.rb

@@ -1,4 +1,5 @@
 require 'thor'
+require 'json'
 require 'envied/env_var_extractor'
 
 class ENVied
@@ -42,10 +43,8 @@ class ENVied
       puts "Writing Envfile to #{File.expand_path('Envfile')}"
       template("Envfile.tt")
 
-      puts <<-INIT
-Add the following snippet (or similar) to your app's initialization:
-ENVied.require(*ENV['ENVIED_GROUPS'] || [:default, ENV['RACK_ENV']])
-INIT
+      puts "Add the following snippet (or similar) to your app's initialization:"
+      puts "ENVied.require(*ENV['ENVIED_GROUPS'] || [:default, ENV['RACK_ENV']])"
     end
 
     desc "init:rails", "Generate all files needed for a Rails project"
@@ -78,13 +77,12 @@ INIT
     end
 
     desc "check:heroku", "Checks whether a Heroku config contains required variables"
-
     long_desc <<-LONG
       Checks the config of your Heroku app against the local Envfile.
 
       The Heroku config should be piped to this task:
 
-      heroku config | bundle exec envied check:heroku
+      heroku config --json | bundle exec envied check:heroku
 
       Use the check:heroku:binstub-task to turn this into a bash-script.
 
@@ -95,18 +93,11 @@ INIT
     option :quiet, type: :boolean, desc: 'Communicate success of the check only via the exit status.'
     define_method "check:heroku" do
       if STDIN.tty?
-        error <<-ERR
-Please pipe the contents of `heroku config` to this task.
-I.e. `heroku config | bundle exec envied check:heroku`"
-ERR
+        error "Please pipe to this task i.e. `heroku config --json | bundle exec envied check:heroku`"
         exit 1
       end
-      config = STDIN.read
-      heroku_env = Hash[config.split("\n")[1..-1].each_with_object([]) do |i, res|
-        res << i.split(":", 2).map(&:strip)
-      end]
-
-      ENV.replace({}).update(heroku_env)
+      heroku_env = JSON.parse(STDIN.read)
+      ENV.replace(heroku_env)
 
       requested_groups = ENV['ENVIED_GROUPS'] || options[:groups]
       ENVied.require(*requested_groups)
@@ -119,8 +110,7 @@ ERR
     long_desc <<-LONG
       Generates a shell script to check the Heroku config against the local Envfile.
 
-      The same as the check:heroku-task, but all in one script (no need to pipe `heroku config` to it etc.).
-
+      The same as the check:heroku-task, but all in one script (no need to pipe `heroku config --json` to it etc.).
     LONG
     option :dest, banner: "where to put the script", desc: "Default: bin/<app>-env-check or bin/heroku-env-check"
     option :app, banner: "name of Heroku app", desc: "uses ENV['HEROKU_APP'] as default if present", default: ENV['HEROKU_APP']

data/lib/envied/coercer/envied_string.rb

@@ -0,0 +1,72 @@
+class ENVied::Coercer::ENViedString
+  TRUE_VALUES = %w[1 on t true y yes].freeze
+  FALSE_VALUES = %w[0 off f false n no].freeze
+  BOOLEAN_MAP = (TRUE_VALUES.product([ true ]) + FALSE_VALUES.product([ false ])).to_h.freeze
+
+  def to_array(str)
+    str.split(/(?<!\\),/).map{|i| i.gsub(/\\,/,',') }
+  end
+
+  def to_boolean(str)
+    BOOLEAN_MAP.fetch(str&.downcase) do
+      raise_unsupported_coercion(str, __method__)
+    end
+  end
+
+  def to_date(str)
+    require 'date'
+    ::Date.parse(str)
+  rescue ArgumentError
+    raise_unsupported_coercion(str, __method__)
+  end
+
+  def to_float(str)
+    Float(str)
+  rescue ArgumentError
+    raise_unsupported_coercion(str, __method__)
+  end
+
+  def to_hash(str)
+    require 'cgi'
+    ::CGI.parse(str).map { |key, values| [key, values[0]] }.to_h
+  end
+
+  def to_string(str)
+    if str.respond_to?(:to_str)
+      str.public_send(:to_str)
+    else
+      raise_unsupported_coercion(str, __method__)
+    end
+  end
+
+  def to_symbol(str)
+    str.to_sym
+  end
+
+  def to_time(str)
+    require 'time'
+    ::Time.parse(str)
+  rescue ArgumentError
+    raise_unsupported_coercion(str, __method__)
+  end
+
+  def to_uri(str)
+    require 'uri'
+    ::URI.parse(str)
+  end
+
+  def to_integer(str)
+    Integer(str)
+  rescue ArgumentError
+    raise_unsupported_coercion(str, __method__)
+  end
+
+  private
+
+  def raise_unsupported_coercion(value, method)
+    raise(
+      ENVied::Coercer::UnsupportedCoercion,
+      "#{self.class}##{method} doesn't know how to coerce #{value.inspect}"
+    )
+  end
+end

data/lib/envied/coercer.rb

@@ -1,23 +1,7 @@
-require 'coercible'
-
 # Responsible for all string to type coercions.
 class ENVied::Coercer
-  module CoercerExts
-    def to_array(str)
-      str.split(/(?<!\\),/).map{|i| i.gsub(/\\,/,',') }
-    end
-
-    def to_hash(str)
-      require 'cgi'
-      ::CGI.parse(str).map { |key, values| [key, values[0]] }.to_h
-    end
 
-    def to_uri(str)
-      require 'uri'
-      ::URI.parse(str)
-    end
-  end
-  Coercible::Coercer::String.send(:include, CoercerExts)
+  UnsupportedCoercion = Class.new(StandardError)
 
   # Coerce strings to specific type.
   #
@@ -31,14 +15,9 @@ class ENVied::Coercer
   # @return [type] the coerced string.
   def coerce(string, type)
     unless supported_type?(type)
-      raise ArgumentError, "#{type.inspect} is not supported type"
+      raise ArgumentError, "The type `#{type.inspect}` is not supported."
     end
-    coerce_method_for(type.to_sym)[string]
-  end
-
-  def coerce_method_for(type)
-    return nil unless supported_type?(type)
-    coercer.method("to_#{type.downcase}")
+    coercer.public_send("to_#{type.downcase}", string)
   end
 
   def self.supported_types
@@ -69,7 +48,7 @@ class ENVied::Coercer
   end
 
   def coercer
-    @coercer ||= Coercible::Coercer.new[String]
+    @coercer ||= ENViedString.new
   end
 
   def coerced?(value)
@@ -80,7 +59,7 @@ class ENVied::Coercer
     return false unless supported_type?(type)
     coerce(string, type)
     true
-  rescue Coercible::UnsupportedCoercion
+  rescue UnsupportedCoercion
     false
   end
 end

data/lib/envied/configuration.rb

@@ -2,21 +2,13 @@ class ENVied
   class Configuration
     attr_reader :current_group, :defaults_enabled, :coercer
 
-    def initialize(options = {}, &block)
+    def initialize(**options, &block)
       @coercer = options.fetch(:coercer, Coercer.new)
       @defaults_enabled = options.fetch(:enable_defaults, defaults_enabled_default)
       instance_eval(&block) if block_given?
     end
 
-    def defaults_enabled_default
-      if ENV['ENVIED_ENABLE_DEFAULTS'].nil?
-        false
-      else
-        @coercer.coerce(ENV['ENVIED_ENABLE_DEFAULTS'], :boolean)
-      end
-    end
-
-    def self.load(options = {})
+    def self.load(**options)
       envfile = File.expand_path('Envfile')
       new(options).tap do |v|
         v.instance_eval(File.read(envfile), envfile)
@@ -24,6 +16,7 @@ class ENVied
     end
 
     def enable_defaults!(value = true, &block)
+      default_values_deprecation
       @defaults_enabled = block_given? ? block.call : value
     end
 
@@ -33,13 +26,9 @@ class ENVied
         @defaults_enabled
     end
 
-    def variable(name, *args)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      type = args.first || :string
-
+    def variable(name, type = :string, **options)
       unless coercer.supported_type?(type)
-        raise ArgumentError,
-          "Variable type (of #{name}) should be one of #{coercer.supported_types}"
+        raise ArgumentError, "#{type.inspect} is not a supported type. Should be one of #{coercer.supported_types}"
       end
       options[:group] = current_group if current_group
       variables << ENVied::Variable.new(name, type, options)
@@ -57,6 +46,24 @@ class ENVied
     def variables
       @variables ||= []
     end
-  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_proxy.rb

@@ -2,8 +2,9 @@ class ENVied
   # Responsible for anything related to the ENV.
   class EnvProxy
     attr_reader :config, :coercer, :groups
+    private :config, :coercer, :groups
 
-    def initialize(config, options = {})
+    def initialize(config, **options)
       @config = config
       @coercer = options.fetch(:coercer, ENVied::Coercer.new)
       @groups = options.fetch(:groups, [])
@@ -17,16 +18,6 @@ class ENVied
       variables.reject(&method(:coerced?)).reject(&method(:coercible?))
     end
 
-    def variables
-      @variables ||= begin
-        config.variables.select {|v| groups.include?(v.group) }
-      end
-    end
-
-    def variables_by_name
-      Hash[variables.map {|v| [v.name, v] }]
-    end
-
     def [](name)
       coerce(variables_by_name[name.to_sym])
     end
@@ -35,35 +26,45 @@ class ENVied
       variables_by_name[name.to_sym]
     end
 
-    def env_value_of(var)
-      ENV[var.name.to_s]
-    end
-
-    def default_value_of(var)
-      var.default_value(ENVied, var)
-    end
-
     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
+
     def coerce(var)
       coerced?(var) ?
         value_to_coerce(var) :
         coercer.coerce(value_to_coerce(var), var.type)
     end
 
+    def coerced?(var)
+      coercer.coerced?(value_to_coerce(var))
+    end
+
     def coercible?(var)
       coercer.coercible?(value_to_coerce(var), var.type)
     end
 
+    def default_value_of(var)
+      var.default_value(ENVied, var)
+    end
+
+    def env_value_of(var)
+      ENV[var.name.to_s]
+    end
+
     def missing?(var)
       value_to_coerce(var).nil?
     end
 
-    def coerced?(var)
-      coercer.coerced?(value_to_coerce(var))
+    def variables
+      @variables ||= config.variables.select {|v| groups.include?(v.group) }
+    end
+
+    def variables_by_name
+      @variables_by_name ||= variables.map {|v| [v.name, v] }.to_h
     end
   end
 end

data/lib/envied/env_var_extractor.rb

@@ -15,12 +15,12 @@ class ENVied
 
     attr_reader :globs, :extensions
 
-    def initialize(options = {})
+    def initialize(**options)
       @globs = options.fetch(:globs, self.defaults[:globs])
       @extensions = options.fetch(:extensions, self.defaults[:extensions])
     end
 
-    def self.extract_from(globs, options = {})
+    def self.extract_from(globs, **options)
       new(options.merge(globs: Array(globs))).extract
     end
 

data/lib/envied/templates/heroku-env-check.tt

@@ -3,7 +3,7 @@
 # Check the config of a Heroku app against the defined variables in `Envfile`
 
 <%- if @app %>
-HEROKU_APP=<%= @app %> exec heroku config | bundle exec envied check:heroku --groups <%= @groups.join(" ") %>
+HEROKU_APP=<%= @app %> exec heroku config --json | bundle exec envied check:heroku --groups <%= @groups.join(" ") %>
 <%- else %>
-exec heroku config | bundle exec envied check:heroku --groups <%= @groups.join(" ") %>
+exec heroku config --json | bundle exec envied check:heroku --groups <%= @groups.join(" ") %>
 <%- end %>

data/lib/envied/variable.rb

@@ -1,7 +1,7 @@
 class ENVied::Variable
   attr_reader :name, :type, :group, :default
 
-  def initialize(name, type, options = {})
+  def initialize(name, type, **options)
     @name = name.to_sym
     @type = type.to_sym
     @group = options.fetch(:group, :default).to_sym

data/lib/envied/version.rb

@@ -1,3 +1,3 @@
 class ENVied
-  VERSION = '0.9.0'
+  VERSION = '0.9.3'
 end