envied 0.9.1 → 0.9.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1eae6e996d1e0a70624b7c24167eccd631a5d9a0
-  data.tar.gz: d9df438b52137f7a22592b468a44895f7cd5a99d
+SHA256:
+  metadata.gz: 13dbc94c996f024f24f78d106973b051c90c83231a79a5f78e190f17c31c431b
+  data.tar.gz: '0836c6bb61eb65228beaa6ee0100d9229f7557b52d663a68914b641528d37d6f'
 SHA512:
-  metadata.gz: 6e770306eb9e9fb37130e5a3fb69be59d3c25443bbd1c36ab09303a9575ad884f0f4569755827f7e0f1362e05621d0c7ac6455d2eb438b620b2bd48e4f6ac3fb
-  data.tar.gz: 6a49f0e90abb416a73e3199961df26b4cdef5e83fa8c0b60e9053f46f4ed18cec7608faddb9b82fdaa726a9329922981135eb05c6a85043ae4052ca34ddff7bb
+  metadata.gz: 85fc118a868a8b78e22c9e1160fe842e2a4a173f86c39f740cdaa8f26cc3ba2d383f4ab2c6606ee422a60e914b30a8b6f5db109532051831430be52b8e1f030c
+  data.tar.gz: 96f37d724c1d660e1530360782c01d704562ded183c4f19fc3e9821c2a8ac6bab319434210d15c9e7f40d8e80c686bbdd61f73df20c66af549b109ec3a31f9f3

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/.rspec

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

data/.travis.yml

@@ -1,16 +1,15 @@
 language: ruby
 
 before_install:
+  - "echo 'gem: --no-document' > ~/.gemrc"
   - gem update --system
   - gem install bundler
 
 rvm:
-  - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
-  - jruby-9.1.12.0
-  - jruby-head
+  - 2.4.5
+  - 2.5.5
+  - 2.6.2
+  - jruby-9.2.6.0
 
 cache: bundler
 sudo: false

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## master / unreleased
+
+* 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]
+
 ## 0.9.1 / 2017-07-06
 
 * Updates `envied check:heroku` to support multiline ENV variables [#42](../../pull/42)

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 [![Build Status](https://travis-ci.org/eval/envied.svg?branch=master)](https://travis-ci.org/eval/envied) [![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,11 +90,11 @@ 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
 
-Groups give you more flexibility to define when variables are needed.  
+Groups give you more flexibility to define when variables are needed.
 It's similar to groups in a Gemfile:
 
 ```ruby
@@ -147,7 +146,7 @@ variable :FORCE_SSL, :boolean, default: 'false'
 variable :PORT, :integer, default: proc {|envied| envied.FORCE_SSL ? 443 : 80 }
 ```
 
-Please remember that ENVied only **reads** from ENV; it doesn't mutate ENV.  
+Please remember that ENVied only **reads** from ENV; it doesn't mutate ENV.
 Don't let setting a default for, say `RAILS_ENV`, give you the impression that `ENV['RAILS_ENV']` is set.
 As a rule of thumb you should only use defaults:
 * for local development
@@ -220,7 +219,7 @@ bundle exec rspec
 ## Developing
 
 ```bash
-bundle exec pry --gem
+bin/console
 ```
 
 ## Contributing

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/envied

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

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

@@ -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/lib/envied.rb

@@ -12,8 +12,7 @@ class ENVied
     alias_method :required?, :env
   end
 
-  def self.require(*args)
-    options = args.last.is_a?(Hash) ? args.pop : {}
+  def self.require(*args, **options)
     requested_groups = (args && !args.empty?) ? args : ENV['ENVIED_GROUPS']
     env!(requested_groups, options)
     error_on_missing_variables!(options)
@@ -22,26 +21,23 @@ class ENVied
     ensure_spring_after_fork_require(args, options)
   end
 
-  def self.env!(requested_groups, options = {})
-    @env = begin
-      @config = options.fetch(:config) { Configuration.load }
-      groups = required_groups(*requested_groups)
-      EnvProxy.new(@config, groups: groups)
-    end
+  def self.env!(requested_groups, **options)
+    @config = options.fetch(:config) { Configuration.load }
+    @env = EnvProxy.new(@config, groups: required_groups(*requested_groups))
   end
 
-  def self.error_on_missing_variables!(options = {})
+  def self.error_on_missing_variables!(**options)
     names = env.missing_variables.map(&:name)
     if names.any?
-      msg = "The following environment variables should be set: #{names * ', '}."
+      msg = "The following environment variables should be set: #{names.join(', ')}."
       msg << "\nPlease make sure to stop Spring before retrying." if spring_enabled? && !options[:via_spring]
       raise msg
     end
   end
 
-  def self.error_on_uncoercible_variables!(options = {})
+  def self.error_on_uncoercible_variables!(**options)
     errors = env.uncoercible_variables.map do |v|
-      "%{name} ('%{value}' can't be coerced to %{type})" % {name: v.name, value: env.value_to_coerce(v), type: v.type }
+      format("%{name} with %{value} (%{type})", name: v.name, value: env.value_to_coerce(v).inspect, type: v.type)
     end
     if errors.any?
       msg = "The following environment variables are not coercible: #{errors.join(", ")}."
@@ -56,17 +52,18 @@ class ENVied
     result.any? ? result.map(&:to_sym) : [:default]
   end
 
-  def self.ensure_spring_after_fork_require(args, options = {})
+  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)) }
+      Spring.after_fork { ENVied.require(args, options.merge(via_spring: true)) }
     end
   end
 
   def self.springify(&block)
     if defined?(ActiveSupport::Deprecation.warn) && !required?
-      ActiveSupport::Deprecation.warn(<<-MSG)
-It's no longer recommended to `ENVied.require` within ENVied.springify's block. Please re-run `envied init:rails` to upgrade.
-MSG
+      ActiveSupport::Deprecation.warn(<<~MSG)
+        It's no longer recommended to `ENVied.require` within ENVied.springify's
+        block. Please re-run `envied init:rails` to upgrade.
+      MSG
     end
     if spring_enabled?
       Spring.after_fork(&block)

data/lib/envied/cli.rb

@@ -43,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"
@@ -79,7 +77,6 @@ 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.
 
@@ -96,14 +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 --json` to this task.
-I.e. `heroku config --json | 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
       heroku_env = JSON.parse(STDIN.read)
-      ENV.replace({}).update(heroku_env)
+      ENV.replace(heroku_env)
 
       requested_groups = ENV['ENVIED_GROUPS'] || options[:groups]
       ENVied.require(*requested_groups)
@@ -117,7 +111,6 @@ ERR
       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 --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.rb

@@ -1,7 +1,8 @@
-require 'coercible'
-
 # Responsible for all string to type coercions.
 class ENVied::Coercer
+
+  UnsupportedCoercion = Class.new(StandardError)
+
   # Coerce strings to specific type.
   #
   # @param string [String] the string to be coerced
@@ -14,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
@@ -52,7 +48,7 @@ class ENVied::Coercer
   end
 
   def coercer
-    @coercer ||= Coercible::Coercer.new[ENViedString]
+    @coercer ||= ENViedString.new
   end
 
   def coerced?(value)
@@ -63,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/coercer/envied_string.rb

@@ -1,15 +1,55 @@
-require 'coercible'
+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
 
-class ENVied::Coercer::ENViedString < Coercible::Coercer::String
   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)
@@ -20,4 +60,13 @@ class ENVied::Coercer::ENViedString < Coercible::Coercer::String
   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/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)
@@ -33,13 +25,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 +45,15 @@ class ENVied
     def variables
       @variables ||= []
     end
-  end
 
+    private
+
+    def defaults_enabled_default
+      if ENV['ENVIED_ENABLE_DEFAULTS'].nil?
+        false
+      else
+        @coercer.coerce(ENV['ENVIED_ENABLE_DEFAULTS'], :boolean)
+      end
+    end
+  end
 end