dotenv-schema-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93df2b54e8b80293e76f260b9073801257c0be8d
+  data.tar.gz: acf240ce0ee51c2355a8d3cc2bf2d1eae9590482
+SHA512:
+  metadata.gz: c3ced370670d19da2c563f0f006c2ef19fc4cf16a3eb4d2b164df21d96185f581c70ccbcaf81a02e609782124989b211f5a80bee959a21598ff5bdfa5986561f
+  data.tar.gz: 889bc0434c04d6cdac5ad153d67e3759b6227ac0119e3f8f81d3e5c7eb495780973886888432f281f624943c5e6334c20a7234700f4a98b622bd7c9ad60a461b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.8.7
+  - ree

data/Changelog.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.0.1
+* First release

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :name => 'dotenv-schema'
+
+gem 'guard-rspec'
+gem 'guard-bundler'
+gem 'rb-fsevent'

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'bundler' do
+  watch('Gemfile')
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Issei Naruta
+
+MIT License
+
+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,103 @@
+# dotenv-schema [![Build Status](https://travis-ci.org/mirakui/dotenv-schema.png?branch=master)](https://travis-ci.org/mirakui/dotenv-schema)
+
+Dotenv-schema makes [dotenv](https://github.com/bkeepers/dotenv) schemaful.
+
+## Installation
+Write `.env` and `.env_schema`:
+
+```shell
+$ cat .env
+DB_HOST=db.example.com
+DB_PORT=3306
+
+$ cat .env_schema
+DB_HOST:
+DB_PORT:
+```
+
+### Rails
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dotenv-shcmea-rails'
+# DO NOT load dotenv-rails gem! Use dotenv-schema-rails instead.
+```
+
+And then execute:
+```
+$ bundle
+$ rails server
+```
+It fails Dotenv::Schema::ValidationError if the validation failed.
+
+### Sinatra or Plain ol' Ruby
+```
+$ gem install dotenv
+```
+
+```ruby
+require 'dotenv-schema'
+Dotenv.load # raises Dotenv::Schema::ValidationError if the validation failed.
+```
+
+## Schema validation rule and `.env_schema` format
+`.env_schema` is based on YAML format.
+
+### Basic rule
+It fails validation If any variables which are defined in `.env_schema` don't exist in `.env`.
+```shell
+# .env_schema
+DB_HOST:
+DB_PORT:
+
+# .env
+DB_HOST=db.example.com
+# => Dotenv::Schema::ValidationError: ENV['DB_PORT'] must exist
+```
+
+It fails validation If any variables which aren't defined in `.env_schema` exist in `.env`.
+```shell
+# .env_schema
+DB_HOST:
+
+# .env
+DB_HOST=db.example.com
+DB_PORT=3306
+# => Dotenv::Schema::ValidationError: Undefined variable(s): DB_PORT; Please add them into .env_schema
+```
+
+### To allow empty string
+In default, it fails if any environment variables in `.env` are empty string.
+```shell
+# .env_schema
+DB_HOST:
+
+# .env
+DB_HOST=
+# => Dotenv::Schema::ValidationError: ENV['DB_HOST'] must not be empty string
+```
+
+You can allow it by using `allow_empty_string` option.
+
+```shell
+# .env_schema
+DB_HOST:
+  allow_empty_string: true
+
+# .env
+DB_HOST=
+# => Passes validation even though DB_HOST is empty
+```
+
+### To allow variables to don't exist
+```shell
+# .env_schema
+DB_HOST:
+DB_PORT:
+  allow_not_exists: true
+
+# .env
+DB_HOST=
+# => Passes validation even though DB_PORT doesn't exist
+```
+

data/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_helper'
+
+namespace 'dotenv-schema' do
+  Bundler::GemHelper.install_tasks :name => 'dotenv-schema'
+end
+
+namespace 'dotenv-schema-rails' do
+  class DotenvSchemaRailsGemHelper < Bundler::GemHelper
+    def guard_already_tagged; end # noop
+    def tag_version; end # noop
+  end
+
+  DotenvSchemaRailsGemHelper.install_tasks :name => 'dotenv-schema-rails'
+end
+
+task :build => ["dotenv-schema:build", 'dotenv-schema-rails:build']
+task :install => ["dotenv-schema:install", 'dotenv-schema-rails:install']
+task :release => ["dotenv-schema:release", 'dotenv-schema-rails:release']
+
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+  t.verbose = false
+end
+
+task :default => :spec

data/dotenv-schema-rails.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotenv-schema/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dotenv-schema-rails"
+  spec.version       = Dotenv::SCHEMA_VERSION
+  spec.authors       = ["Issei Naruta"]
+  spec.email         = ["naruta@cookpad.com"]
+  spec.description   = %q{Loads environment variables with dotenv-schema in Rails}
+  spec.summary       = %q{Loads environment variables with dotenv-schema in Rails}
+  spec.homepage      = "https://github.com/mirakui/dotenv-schema"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dotenv-schema", Dotenv::SCHEMA_VERSION
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/dotenv-schema.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotenv-schema/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dotenv-schema"
+  spec.version       = Dotenv::SCHEMA_VERSION
+  spec.authors       = ["Issei Naruta"]
+  spec.email         = ["naruta@cookpad.com"]
+  spec.description   = %q{Defines schema for dotenv}
+  spec.summary       = %q{Defines schema for dotenv}
+  spec.homepage      = "https://github.com/mirakui/dotenv-schema"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dotenv"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/dotenv-schema-rails.rb

@@ -0,0 +1,2 @@
+require 'dotenv-schema'
+require 'dotenv/railtie'

data/lib/dotenv-schema.rb

@@ -0,0 +1,25 @@
+require 'dotenv'
+require 'dotenv/schema'
+
+module Dotenv
+  class << self
+    def load_with_validation(*filenames)
+      env_before = ENV.to_hash
+      load_without_validation *filenames
+      env = ENV.to_hash.reject {|k, v| env_before.has_key?(k) }
+
+      schema = Schema.load schema_path
+      schema.validate! env
+    end
+    alias_method :load_without_validation, :load
+    alias_method :load, :load_with_validation
+
+    def schema_path=(path)
+      @schema_path = path
+    end
+
+    def schema_path
+      @schema_path || '.env_schema'
+    end
+  end
+end

data/lib/dotenv-schema/version.rb

@@ -0,0 +1,3 @@
+module Dotenv
+  SCHEMA_VERSION = '0.0.1'
+end

data/lib/dotenv/schema.rb

@@ -0,0 +1,32 @@
+require 'dotenv-schema'
+require 'yaml'
+
+module Dotenv
+  class Schema < Hash
+    class ValidationError < StandardError; end
+
+    def initialize(hash={})
+      replace hash if hash
+    end
+
+    def self.load(file)
+      new YAML.load(File.read(file))
+    end
+
+    def validate!(env)
+      undefined_keys = env.keys - keys
+      unless undefined_keys.empty?
+        raise ValidationError, "Undefined variable(s): #{undefined_keys.join(', ')}; Please add them into #{Dotenv.schema_path}"
+      end
+      each do |key, options|
+        if env[key] == '' && (options && !options['allow_empty_string'] || !options)
+          raise ValidationError, "ENV['#{key}'] must not be empty string"
+        end
+        if !env.has_key?(key) && (options && !options['allow_not_exists'] || !options)
+          raise ValidationError, "ENV['#{key}'] must exist"
+        end
+      end
+      true
+    end
+  end
+end

data/spec/dotenv_schema_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'dotenv'
+require 'dotenv-schema'
+require 'tempfile'
+
+describe 'Dotenv Schema' do
+  before(:all) do
+    Dotenv.schema_path = file <<-END
+KEY1:
+  allow_empty_string: true
+  allow_not_exists: true
+KEY2:
+KEY3:
+  allow_empty_string: false
+    END
+  end
+
+  before do
+    %w[KEY1 KEY2 KEY3].each {|k| ENV.delete(k) }
+  end
+
+  it do
+    expect {
+      Dotenv.load file <<-END
+KEY1=value1
+KEY2=value2
+KEY3=value3
+      END
+    }.not_to raise_error
+  end
+
+  it do
+    expect {
+      Dotenv.load file <<-END
+KEY1=value1
+KEY3=value3
+      END
+    }.to raise_error(Dotenv::Schema::ValidationError)
+  end
+
+  it do
+    expect {
+      Dotenv.load file <<-END
+KEY1=
+KEY2=value2
+KEY3=value3
+      END
+    }.not_to raise_error
+  end
+
+  it do
+    expect {
+      Dotenv.load file <<-END
+KEY1=value1
+KEY2=value2
+KEY3=
+      END
+    }.to raise_error(Dotenv::Schema::ValidationError)
+  end
+
+  it do
+    expect {
+      Dotenv.load file <<-END
+KEY1=value1
+KEY2=
+KEY3=value3
+      END
+    }.to raise_error(Dotenv::Schema::ValidationError)
+  end
+
+  it do
+    expect {
+      Dotenv.load file <<-END
+KEY2=value2
+KEY3=value3
+      END
+    }.not_to raise_error
+  end
+
+  it do
+    expect {
+      Dotenv.load file <<-END
+KEY1=value1
+KEY2=value2
+KEY3=value3
+KEY4=value4
+      END
+    }.to raise_error(Dotenv::Schema::ValidationError)
+  end
+
+end

data/spec/lib/dotenv/schema_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'dotenv/schema'
+
+describe Dotenv::Schema do
+  let(:schema) {
+    described_class.load file <<-END
+KEY1:
+  allow_empty_string: true
+  allow_not_exists: true
+KEY2:
+KEY3:
+  allow_empty_string: false
+    END
+  }
+
+  it do
+    expect(schema).to eq({
+'KEY1' => { 'allow_empty_string' => true, 'allow_not_exists' => true },
+'KEY2' => nil,
+'KEY3' => { 'allow_empty_string' => false }
+    })
+  end
+
+  it do
+    expect {
+      schema.validate!({
+        'KEY1' => 'VALUE1',
+        'KEY2' => 'VALUE2',
+        'KEY3' => 'VALUE3'
+      })
+    }.not_to raise_error
+  end
+
+  it do
+    expect {
+      schema.validate!({
+        'KEY1' => 'VALUE1',
+        'KEY3' => 'VALUE3'
+      })
+    }.to raise_error(Dotenv::Schema::ValidationError)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+require 'tempfile'
+$tmp_files = []
+
+def file(str)
+  tmp = Tempfile.new('dotenv-schema.')
+  tmp.puts str
+  tmp.flush
+  $tmp_files << tmp
+  tmp.path
+end

data/test.env

@@ -0,0 +1,2 @@
+TEST1=
+TEST2=value

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: dotenv-schema-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Issei Naruta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Loads environment variables with dotenv-schema in Rails
+email:
+- naruta@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Changelog.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dotenv-schema-rails.gemspec
+- dotenv-schema.gemspec
+- lib/dotenv-schema-rails.rb
+- lib/dotenv-schema.rb
+- lib/dotenv-schema/version.rb
+- lib/dotenv/schema.rb
+- spec/dotenv_schema_spec.rb
+- spec/lib/dotenv/schema_spec.rb
+- spec/spec_helper.rb
+- test.env
+homepage: https://github.com/mirakui/dotenv-schema
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Loads environment variables with dotenv-schema in Rails
+test_files:
+- spec/dotenv_schema_spec.rb
+- spec/lib/dotenv/schema_spec.rb
+- spec/spec_helper.rb