early 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afe1d324298d4e3b6ee90653d46d3f12aa82fb03faf80863a43a2b0d6e70d219
+  data.tar.gz: 2c9e6c181582728c3161e98ab33685f2246f9259a7ba74bdb8e29b62ddfc4144
+SHA512:
+  metadata.gz: 57a93b949787e7d0126dec845d65da1dcc663c1d1bb4abcacdf4b90fdceb2cc3d15b72e15d2a80afcc324859bc606d1e7efde0c437d74b671ba7b1bbdaa1b2cf
+  data.tar.gz: bb08b31946e9f6fa2e172029082bd3228106b04f4c9506283aa2973fc287e59d585cf597c3b0915b284321ff0e21b342091baa433125944581043acf17d98f74

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gsamokovarov@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in early.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Genadi Samokovarov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Early
+
+Early checks for environment variables availability, so you don't have to. Hook
+it early in your program to require or default a variable and then work with
+`ENV` like you normally would. Extremely useful for [Twelve-Factor apps][12f].
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'early'
+```
+
+Afterwards make sure to call `Early` as early as possible in your application,
+to check the `ENV` variables, before you use them in your configuration layer:
+
+```ruby
+Early do
+  require :DATABASE_URL
+  require :REDIS_URL
+
+  default :PROVIDER, :generic
+end
+```
+
+The configuration will require the presence of `DATABASE_URL` and `REDIS_URL`
+and will raise `Early::Error` if any of them is missing. It will also set a
+default value to the env `PROVIDER`.
+
+### Rails
+
+If you want to use early with Rails, you can store the early configuration in
+`config/early.rb`:
+
+
+```ruby
+Early do
+  require :ADMIN_NAME, :ADMIN_PASSWORD
+  require :MEETUP_API_KEY
+end
+```
+
+More importantly, require it in `config/boot.rb`, which is executed before the
+`config/application.rb` and `config/initializers` files:
+
+```ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.
+require 'bootsnap/setup'
+
+require_relative 'early' # 👈
+```
+
+This will make sure, that the rules you wanted early to enforce have been
+applied before any code in `config` has been run.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'early'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'early'
+  spec.version       = Early::VERSION
+  spec.authors       = ['Genadi Samokovarov']
+  spec.email         = ['gsamokovarov@gmail.com']
+
+  spec.summary       = 'Checks for environment variables early in your program.'
+  spec.description   = 'Checks for environment variables early in your program.'
+  spec.homepage      = 'https://github.com/gsamokovarov'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/early.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# Early checks for environment variables availability, so you don't have to.
+#
+# Hook it early in your program and work with `ENV` like you normally would.
+# This time, however, the errors would be thrown early and not when a critical
+# piece of code is hit, which may happen late in the program runtime an be easy
+# to miss.
+module Early
+  VERSION = '0.1.0'
+
+  class Configuration # :nodoc:
+    attr_reader :variables
+
+    def initialize(&block)
+      @variables = []
+
+      instance_eval(&block)
+    end
+
+    private
+
+    def require(*names)
+      names.each do |name|
+        @variables << RequiredVariable.new(name)
+      end
+    end
+
+    def default(name, value)
+      @variables << DefaultVariable.new(name, value)
+    end
+  end
+
+  class DefaultVariable # :nodoc:
+    attr_reader :name, :value
+
+    def initialize(name, value)
+      @name = String(name)
+      @value = String(value)
+    end
+
+    def apply
+      ENV[name] ||= value
+    end
+  end
+
+  class RequiredVariable # :nodoc:
+    attr_reader :name
+
+    def initialize(name)
+      @name = String(name)
+    end
+
+    def apply
+      ENV.fetch(name) { raise Error, self }
+    end
+  end
+
+  # Error is raised when an environment variable is missing.
+  class Error < KeyError
+    attr_reader :variable
+
+    def initialize(variable)
+      @variable = variable
+
+      super("Variable ENV[#{variable.name.inspect}] is missing")
+    end
+  end
+
+  # Env returns the early environment. This is either the value of RAILS_ENV,
+  # RACK_ENV (in order) or the string <tt>'development'</tt> if neither of the
+  # aforementioned environment variables are present.
+  def self.env
+    ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+  end
+
+  # Applies a configuration, which means every variable is either defaulted or
+  # checked for existence.
+  def self.apply(config)
+    config.variables.each(&:apply)
+  end
+end
+
+module Kernel
+  # Early checks for environment variables availability. It provides a DSL that
+  # can require or set a default value for an environment variable. This will
+  # help you catch configuration errors earlier in your application runtime.
+  # Here is an example:
+  #
+  #   Early do
+  #     require :REDIS_URL
+  #     default :PROVIDER, :generic
+  #   end
+  #
+  # Calling <tt>require :REDIS_URL</tt> will fail if <tt>ENV['REDIS_URL']</tt> is
+  # <tt>nil</tt>, which means that it wasn't provided, before running the current
+  # application. The error will give you information about the missing variable:
+  #
+  #   Early::Error (Variable ENV["REDIS_URL"] is missing)
+  #
+  # Setting a default calls <tt>ENV['PROVIDER'] ||= 'generic'</tt> under the
+  # hood. Every time you use <tt>ENV['PROVIDER']</tt> will give you
+  # <tt>'generic'</tt>. No need to set it explicitly prior to the application
+  # run.
+  #
+  # A quick note about how <tt>ENV</tt> works in Ruby. It is a plain
+  # <tt>Object</tt> that is monkey patched to behave a bit like a hash. You can
+  # get an variable with <tt>ENV['NAME']</tt> and you can set an environment
+  # variable with <tt>ENV['NAME'] = 'val'</tt>.
+  #
+  # Both of the operations explicitly require strings for the variable name and
+  # value. Passing a symbol to <tt>ENV[:NAME]</tt> will result in an error. The
+  # same will happen if you try to set a variable to any non-string value, like
+  # <tt>ENV['NAME'] = :val</tt>. Early converts both the name and the value to
+  # strings when it eventually deals with <tt>ENV</tt>, so you don't have to
+  # worry about it.
+  def Early(*envs, &block)
+    config = Early::Configuration.new(&block)
+
+    if envs.empty? || envs.find { |e| Early.env == e.to_s }
+      Early.apply(config)
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: early
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Genadi Samokovarov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Checks for environment variables early in your program.
+email:
+- gsamokovarov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- early.gemspec
+- lib/early.rb
+homepage: https://github.com/gsamokovarov
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Checks for environment variables early in your program.
+test_files: []