dot_env 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f007f4a0f032b2fc3e54499c7af7788ed2172d6
+  data.tar.gz: 6d6e6f77239cd6299365547b993400b24ba358ab
+SHA512:
+  metadata.gz: b691e2b0ef4baad4049b2c48546ece7a593e7fe8f6a8fe397a28146cb4378a0dec6e3443eaee4d5a84e8b8e4f42cf0e107eed242fb960073cb512dff845c9239
+  data.tar.gz: 1f58772ad5fae4469b696545b99c5d0de58c3e61ba58359c5162f9f95c26a3dfde3917a33720af3198c650f23dfa0b8ce1b89f6d87b2bdebbd916f7997234184

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dot_env.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 zsolt kormany
+
+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,48 @@
+# DotEnv
+
+`DotEnv` is for managing different environment setups based on a simple textfile.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dot_env', github: 'kaze/dot_env'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Basic usage:
+
+    require 'dot_env'
+
+    current_environment = DotEnv.get_environment  #=> 'development'
+
+The `DotEnv.get_environment` method reads a file (named `.env` as default). It reads, parses and sets all the environment variables found in this file. After that you can access these variables in your application simply using `ENV['VARIABLE_NAME']`.
+
+If it doesn't find an `.env` file in your app's root directory, then sets the name of the environment -- as default -- to `development`.
+
+I made assumption only about naming one variable, and this is `'APP_ENV'`. `DotEnv` tries to detect the current environment's name from this setting.
+
+You can use any other name for your settings file, and you can add that name as a parameter to the function: `DotEnv.get_environment('path/to/settings_file')`
+
+`DotEnv` handles the variables as below:
+
+- accepts shell-compatible variable names
+- values could be quoted or unquoted
+- supports basic shell variable expansion (`$VARIABLE` and `${VARIABLE}`)
+- handles simple arrays
+- handles boolean values (`true, yes, 1` will be `true` and `false, no, 0` will be `false`, case insensitively)
+
+After parsing every variable's type will be `string`, except booleans and arrays.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/kaze/dot_env/fork )
+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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :test
+
+desc 'Generates a coverage report'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['test'].execute
+end

data/dot_env.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dot_env/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dot_env"
+  spec.version       = DotEnv::VERSION
+  spec.authors       = ["zsolt kormany"]
+  spec.email         = ["zsoltkormany@gmail.com"]
+  spec.summary       = %q{dotenv manages your environment settings}
+  spec.description   = %q{dotenv manages your environment settings}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "minitest-reporters", "~> 1.0"
+  spec.add_development_dependency "simplecov", "~> 0.8"
+end

data/lib/dot_env.rb

@@ -0,0 +1,43 @@
+require "dot_env/version"
+require 'logger'
+require_relative 'dot_env/parser'
+require_relative 'dot_env/environment'
+
+module DotEnv
+  @log       = Logger.new($stdout)
+  @log.level = Logger::DEBUG
+  @parser    = DotEnv::Parser
+  @env       = DotEnv::Environment.new(@parser, ARGV)
+  @env_file  = @env.fetch('ENVIRONMENT_SETTINGS_FILE', '.env')
+
+  def self.read_env_file(filepath)
+    File.open(filepath).each do |line|
+      unless line.strip.empty? or line.strip.start_with?('#')
+        key, value = @parser.get_value_pair(line.strip)
+        @env.set(key, value)
+      end
+    end.close()
+  end
+
+  def self.set_default_env(filepath)
+    current_env = @env.get_current
+    # @log.info "Environment settings file ('#{filepath}') not found."
+    # @log.info "Setting up #{current_env} environment."
+    @env.set_current(current_env)
+  end
+
+  def self.set_environment(filepath)
+    self.read_env_file(filepath)
+    current_env = @env.get_current
+    # @log.info "Environment settings file ('#{filepath}') found."
+    # @log.info "Setting up #{current_env} environment."
+  rescue Errno::ENOENT
+    self.set_default_env(filepath)
+  end
+
+  def self.get_environment(filepath=nil)
+    filepath ||= @env_file
+    self.set_environment(filepath)
+    @env.get_current
+  end
+end

data/lib/dot_env/environment.rb

@@ -0,0 +1,54 @@
+module DotEnv
+  class Environment
+    attr_accessor :cmdline_args,
+                  :test_runner_words,
+                  :test_file_words
+
+    def initialize(parser, command_line_args)
+      @parser = parser
+      @cmdline_args = command_line_args
+      @test_runner_words = ['spec', 'rspec', 'cucumber']
+      @test_file_words = ['test', 'spec', 'feature']
+    end
+
+    def fetch(key, default=nil)
+      value = ENV.fetch(key, default)
+      value = @parser.parse(value) unless value.nil?
+    end
+
+    def set(key, value)
+      ENV[key] = value
+    end
+
+    def check_test_runner
+      @test_runner_words.each do |word|
+        return 'testing' if @cmdline_args.include? word
+      end
+
+      nil
+    end
+
+    def check_test_file(argword)
+      @test_file_words.each do |word|
+        return 'testing' if argword.include? word
+      end
+
+      nil
+    end
+
+    def check_if_testing
+      test_runner = check_test_runner
+      test_file = nil
+      @cmdline_args.each { |a| test_file = check_test_file(a) if test_file.nil? }
+      current_env = test_runner || test_file
+    end
+
+    def set_current(env)
+      set('APP_ENV', env)
+    end
+
+    def get_current
+      check_if_testing || fetch('APP_ENV', 'development')
+    end
+  end
+end

data/lib/dot_env/parser.rb

@@ -0,0 +1,46 @@
+module DotEnv
+  module Parser
+    TRUEWORDS = ['true', 'yes', '1']
+    FALSEWORDS = ['false', 'no', '0']
+
+    def self.get_value_pair(line)
+      return line.chomp.split('=').each {|v| v.gsub!(/['"]/, '') }.each(&:strip!)
+    end
+
+    def self.cleanup(value)
+      value.gsub(/["'\[\]]/, '').split(',').each(&:strip!)
+    end
+
+    def self.expand(value)
+      value.gsub!(/\$\{?(\w+)\}?/) { ENV.fetch($1, nil) } || value
+    end
+
+    def self.check_truthy(value)
+      if TRUEWORDS.include? value.to_s.downcase
+        return true
+      else
+        return value
+      end
+    end
+
+    def self.check_falsy(value)
+      if FALSEWORDS.include? value.to_s.downcase
+        return false
+      else
+        return value
+      end
+    end
+
+    def self.parse(value)
+      parsed = []
+      self.cleanup(value).each do |v|
+        v = self.expand(v)
+        v = self.check_truthy(v)
+        v = self.check_falsy(v)
+        parsed.push v
+      end
+
+      parsed.length > 1 ? parsed : parsed.first
+    end
+  end
+end

data/lib/dot_env/version.rb

@@ -0,0 +1,3 @@
+module DotEnv
+  VERSION = "0.0.1"
+end

data/spec/dot_env_spec.rb

@@ -0,0 +1,43 @@
+require 'logger'
+require_relative 'test_helper'
+require_relative '../lib/dot_env'
+
+describe DotEnv do
+  before { ENV['APP_ENV'] = nil }
+
+  describe "set_environment" do
+    describe "the happy path" do
+      let(:env) { DotEnv::Environment.new(DotEnv::Parser, ARGV) }
+
+      before do
+        DotEnv.set_environment('spec/fixtures/dotenv/testenv')
+      end
+
+      it "reads the given environment settings file and sets the environment" do
+        ENV['APP_NAME'].must_equal 'testapp'
+        ENV['AN_ARRAY'].must_equal '[egy, ketto, harom]'
+        ENV['UNBELIEVABLE'].must_equal 'True'
+        ENV['SOMEWHERE'].must_equal '$HOME'
+      end
+
+      it "can read back those settings" do
+        env.fetch('APP_NAME').must_equal 'testapp'
+        env.fetch('AN_ARRAY').must_equal ['egy', 'ketto', 'harom']
+        env.fetch('UNBELIEVABLE').must_equal true
+        env.fetch('SOMEWHERE').must_equal ENV['HOME']
+      end
+    end
+
+    describe "when there is no environment setting file found" do
+      it "must return 'development' environment" do
+        DotEnv.set_environment('path/to/nonexisting/file').must_equal 'development'
+      end
+    end
+  end
+
+  describe "get_environment" do
+    it "returns the environment's name after set up" do
+      DotEnv.get_environment('spec/fixtures/dotenv/testenv').must_equal 'staging'
+    end
+  end
+end

data/spec/dotenv/environment_spec.rb

@@ -0,0 +1,114 @@
+require_relative '../test_helper'
+require_relative '../../lib/dot_env/parser'
+require_relative '../../lib/dot_env/environment'
+
+describe DotEnv::Environment do
+  let(:env) { DotEnv::Environment.new(DotEnv::Parser, ARGV) }
+
+  before do
+    ENV['THE_MEANING_OF_LIFE'] = '42'
+  end
+
+  describe "fetch" do
+    it "reads environment variables" do
+      env.fetch('THE_MEANING_OF_LIFE').must_equal '42'
+    end
+
+    it "reads environment variables with defaults" do
+      env.fetch('THE_MEANING_OF_LIFE', 'hello').must_equal '42'
+    end
+
+    it "uses default if there is no such variable" do
+      env.fetch('NONEXISTINGVARIABLE', 'hello').must_equal 'hello'
+    end
+  end
+
+  describe "check_test_runner" do
+    it "returns 'testing' when rspec runs" do
+      env.cmdline_args = ['spec']
+
+      env.check_test_runner.must_equal 'testing'
+    end
+
+    it "returns 'testing' when cucumber runs" do
+      env.cmdline_args = ['cucumber']
+
+      env.check_test_runner.must_equal 'testing'
+    end
+
+    it "returns nil when no test runs" do
+      env.cmdline_args = []
+
+      env.check_test_runner.must_equal nil
+    end
+  end
+
+  describe "check_test_file" do
+    it "returns 'testing' when a spec file runs" do
+      argword = 'path/to/something_spec.rb'
+
+      env.check_test_file(argword).must_equal 'testing'
+    end
+
+    it "returns 'testing' when cucumber runs" do
+      argword = 'path/to/something.feature'
+
+      env.check_test_file(argword).must_equal 'testing'
+    end
+
+    it "returns nil when no test runs" do
+      argword = ''
+
+      env.check_test_file(argword).must_equal nil
+    end
+  end
+
+  describe "check_if_testing" do
+    it "returns 'testing' when there is a testfile in the arguments" do
+      env.cmdline_args = ['ruby', 'path/to/test_file.rb']
+
+      env.check_if_testing.must_equal 'testing'
+    end
+
+    it "returns nil when no test runs" do
+      env.cmdline_args = []
+
+      env.check_if_testing.must_equal nil
+    end
+  end
+
+  it "sets the current environment" do
+    ENV['APP_ENV'] = 'nothing'
+    env.set_current('strange')
+
+    ENV['APP_ENV'].must_equal 'strange'
+  end
+
+  describe "get_current_env" do
+    it "returns 'testing' when there is a testfile in the arguments" do
+      env.cmdline_args = ['ruby', 'path/to/test_file.rb']
+
+      env.get_current.must_equal 'testing'
+    end
+
+    it "returns 'testing' when a test runner runs" do
+      env.cmdline_args = ['cucumber']
+
+      env.get_current.must_equal 'testing'
+    end
+
+    it "returns 'dev' when there are no tests, but the APP_ENV is 'dev'" do
+      ENV['APP_ENV'] = 'dev'
+      env.cmdline_args = []
+
+      env.get_current.must_equal 'dev'
+    end
+
+    it "returns 'development' otherwise" do
+      ENV['APP_ENV'] = nil
+      env.cmdline_args = []
+
+      env.get_current.must_equal 'development'
+    end
+  end
+end

data/spec/dotenv/parser_spec.rb

@@ -0,0 +1,44 @@
+require_relative '../test_helper'
+require_relative '../../lib/dot_env/parser'
+
+describe DotEnv::Parser do
+  let(:parser) { DotEnv::Parser }
+
+  before do
+    ENV['THE_MEANING_OF_LIFE'] = '42'
+  end
+
+  it "gets key-value pairs from lines" do
+    line = " something = '  some other thing '"
+
+    parser.get_value_pair(line).must_equal ["something", "some other thing"]
+  end
+
+  it "expands environment variables" do
+    parser.expand("$THE_MEANING_OF_LIFE").must_equal '42'
+  end
+
+  it "cleans up variables" do
+    value = '["spec", "rspec", "test", "cucumber", $HOME]'
+    result = ["spec", "rspec", "test", "cucumber", "$HOME"]
+
+    parser.cleanup(value).must_equal result
+  end
+
+  describe "parse" do
+    it "handles arrays" do
+      value = '["spec", "rspec", "test", "cucumber", $HOME, FALSE]'
+      result = ["spec", "rspec", "test", "cucumber", ENV['HOME'], false]
+
+      parser.parse(value).must_equal result
+    end
+
+    it "handles booleans" do
+      parser.parse("True").must_equal true
+    end
+
+    it "handles expandable variables" do
+      parser.parse("$HOME").must_equal ENV['HOME']
+    end
+  end
+end

data/spec/fixtures/dotenv/testenv

@@ -0,0 +1,12 @@
+# simple value
+APP_NAME = testapp
+APP_ENV = staging
+
+# a boolean value
+UNBELIEVABLE = True
+
+# an array
+AN_ARRAY = [egy, ketto, harom]
+
+# expansion
+SOMEWHERE = $HOME

data/spec/test_helper.rb

@@ -0,0 +1,14 @@
+app_root = File.realpath(File.join(File.dirname(__FILE__), '..'))
+$:.unshift app_root unless $LOAD_PATH.include? app_root
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'test'
+    command_name 'Minitest'
+  end
+end
+
+require 'minitest/reporters'
+Minitest::Reporters.use!(Minitest::Reporters::SpecReporter.new)
+require 'minitest/autorun'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: dot_env
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- zsolt kormany
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: dotenv manages your environment settings
+email:
+- zsoltkormany@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dot_env.gemspec
+- lib/dot_env.rb
+- lib/dot_env/environment.rb
+- lib/dot_env/parser.rb
+- lib/dot_env/version.rb
+- spec/dot_env_spec.rb
+- spec/dotenv/environment_spec.rb
+- spec/dotenv/parser_spec.rb
+- spec/fixtures/dotenv/testenv
+- spec/test_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: dotenv manages your environment settings
+test_files:
+- spec/dot_env_spec.rb
+- spec/dotenv/environment_spec.rb
+- spec/dotenv/parser_spec.rb
+- spec/fixtures/dotenv/testenv
+- spec/test_helper.rb