envyable 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d4af1ced0824764bbac3e7f28bda8982ddc9d85
-  data.tar.gz: f70751518161fba856b02d3cfe3a0d4039ca4552
+  metadata.gz: 2fbd50432fb934f5ea104f0d132571f52faae369
+  data.tar.gz: 3a9c3525fc21bed5cca528df0f940c3c082471e5
 SHA512:
-  metadata.gz: e7866d20605d48c64e15f8f5b8a4d58ad6b41708c6e2468b00f77d7757d5db49dc37a94a8aaf2039732fd0b11c2786ec989c46e4e6693cfb6d3b4bbda369929f
-  data.tar.gz: 9f514156650430d6ea34ef5d764e1c4eb7fe1f47b13377a47a33466c639bc11537e329c0af19a60b5e15518faa7d2577fd41aec2ad500e6281203db2a3accb31
+  metadata.gz: 3fa0fc79aa27d5f66cc7245cf9e93fb31f92624776f75bc99dd218100494937afdb3ce2191f564c7aff4b63f342c6d83c160f0e5d18abfb3732ade2bbc112588
+  data.tar.gz: fa43e0f9fe688c5ca72207718fbad81c04446815e542e15db7642314dcbf9b9207a7ac701bbf72af7367c7791161f6c6ba16e4b0530d479dfb00418bdcf45576

data/.gitignore

@@ -17,3 +17,4 @@ test/tmp
 test/version_tmp
 tmp
 spec/sandbox
+log/

data/README.md

@@ -23,13 +23,11 @@ Or install it yourself as:
 Once the gem is included in your project, you can then use it to generate the
 default required files. Just run:
 
-```
-$ envyable install
-```
+    $ envyable install
 
 and you will get a `config` directory containing an `env.yml` and a
 `env.yml.example` file. If you have a `.gitignore` file this will also append
-the line
+the line:
 
 ```yaml
 /config/env.yml
@@ -37,6 +35,15 @@ the line
 
 to your config so that you do not check in `/config/env.yml`.
 
+If you have [Spring](https://github.com/rails/spring) bundled with your
+application this will append the following line to `/config/spring.rb`:
+
+```ruby
+Spring.watch 'config/env.yml'
+```
+
+If the file `/config/spring.rb` does not exist, it will be created.
+
 ## Usage
 
 ### YAML file
@@ -51,11 +58,11 @@ test:
 
 ### Rails
 
-Once installed in a Rails app, add your yaml file at `config/env.yml`. The gem will load the correct environment on initialization of the application.
+Once installed in a Rails app, add your yaml file at `config/env.yml`. The gem will load the correct environment on initialization of the application. If you are using Spring to load your Rails application, [add `config/env.yml` to Spring's watch list](https://github.com/rails/spring#watching-files-and-directories).
 
 ### Load Immediately
 
-If you have gems that require variables to be set earlier, then place `envyable` in the `Gemfile` before those gems and require `envyable/rails-now`:
+If you have gems that require variables to be set earlier then place `envyable` in the `Gemfile` before those gems and require `envyable/rails-now`:
 ```
 gem 'envyable', require: 'envyable/rails-now'
 gem 'other-gem-that-requires-env-variables'
@@ -76,7 +83,11 @@ Envyable.load('config/env.yml')
 
 ### Version control
 
-It is not recommended that you check the yaml file in to version control. Personally, I like to check in a `env.yml.example` file that shows the required keys, but does not include any credentials.
+It is not recommended that you check the yaml file in to version control. Personally, I like to check in a `env.yml.example` file that shows the required keys, but does not include any credentials. If you generate your Envyable files using the installer, `config/env.yml` will be added to your `.gitignore` file.
+
+## Troubleshooting
+
+If your ENV values don't update when you modify `config/env.yml`, verify whether you have Spring (or another application preloader) that isn't configured to watch and reload when you update values.  You should try configuring the preloader or just restarting it.
 
 ## Contributing
 

data/lib/envyable.rb

@@ -20,7 +20,7 @@ module Envyable
   #   Envyable.load('config/application.yml', 'production')
   #
   # Returns nothing.
-  def self.load(path, environment='development')
+  def self.load(path, environment = 'development')
     Loader.new(path).load(environment)
   end
 end

data/lib/envyable/cli.rb

@@ -15,6 +15,12 @@ module Envyable
           "\n# Don't check in credentials \nconfig/env.yml"
         end
       end
+      if File.exist?("#{destination_root}/bin/spring")
+        create_file("config/spring.rb") unless File.exist?("#{destination_root}/config/spring.rb")
+        append_to_file("config/spring.rb") do
+          "\nSpring.watch 'config/env.yml'"
+        end
+      end
     end
   end
 end

data/lib/envyable/loader.rb

@@ -13,7 +13,7 @@ module Envyable
     #             resides.
     # loadable  - a Hash or hashlike structure that the yaml file variables
     #             should be loaded into (default: ENV).
-    def initialize(path, loadable=ENV)
+    def initialize(path, loadable = ENV)
       @path = path
       @loadable = loadable
     end
@@ -28,7 +28,7 @@ module Envyable
     # load('production')
     #
     # Returns nothing.
-    def load(environment='development')
+    def load(environment = 'development')
       if @yml ||= load_yml
         @yml.each { |key, value| set_value(key, value) }
         if @yml[environment]

data/lib/envyable/version.rb

@@ -1,3 +1,3 @@
 module Envyable
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/spec/envyable/cli_spec.rb

@@ -38,5 +38,28 @@ describe Envyable::CLI do
       capture_io { cli.install }
       File.readlines(gitignore).any? { |line|  line == "config/env.yml" }.must_equal true
     end
+
+    it "should create a file in config/spring.rb if it doesn't exist already" do
+      spring_rb = "#{cli.destination_root}/config/spring.rb"
+      cli = Envyable::CLI.new([], {}, :destination_root => destination_root(:with_spring_bin => true))
+      File.exist?(spring_rb).must_equal false
+      capture_io { cli.install }
+      File.exist?(spring_rb).must_equal true
+    end
+
+    it "should add config/env.yml to Spring's watch list" do
+      spring_rb = "#{cli.destination_root}/config/spring.rb"
+      cli = Envyable::CLI.new([], {}, :destination_root => destination_root(:with_spring_bin => true))
+      capture_io { cli.install }
+      File.readlines(spring_rb).any? { |line| line == "Spring.watch 'config/env.yml'" }.must_equal true
+    end
+
+    it "should add config/env.yml to Spring's watch list when spring.rb exists" do
+      spring_rb = "#{cli.destination_root}/config/spring.rb"
+      cli = Envyable::CLI.new([], {}, :destination_root => destination_root(:with_spring_bin => true, :with_spring_rb => true))
+      File.readlines(spring_rb).none? { |line| line == "Spring.watch 'config/env.yml'" }.must_equal true
+      capture_io { cli.install }
+      File.readlines(spring_rb).any? { |line| line == "Spring.watch 'config/env.yml'" }.must_equal true
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,16 +1,20 @@
 require 'fileutils'
 require 'rubygems'
 begin
-  require "simplecov"
-  require "codeclimate-test-reporter"
+  require 'simplecov'
+  require 'codeclimate-test-reporter'
   SimpleCov.start do
     formatter SimpleCov::Formatter::MultiFormatter.new([
       SimpleCov::Formatter::HTMLFormatter,
       CodeClimate::TestReporter::Formatter
     ])
-    add_filter "/spec/"
+    add_filter '/spec/'
   end
 rescue LoadError
+  require 'logger'
+  logger = Logger.new('./log/test.log')
+  logger.info 'Couldn\'t load simplecov or codeclimate-test-reporter. Check ' \
+              'your dependencies.'
 end
 
 gem 'minitest'
@@ -19,8 +23,16 @@ require 'minitest/autorun'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'envyable')
 
 def destination_root(opts={})
-  dir = File.join(File.dirname(__FILE__), "sandbox")
+  dir = File.join(File.dirname(__FILE__), 'sandbox')
   FileUtils.mkdir_p(dir)
   FileUtils.touch("#{dir}/.gitignore") if opts[:with_gitignore]
+  if opts[:with_spring_rb]
+    FileUtils.mkdir_p("#{dir}/config")
+    FileUtils.touch("#{dir}/config/spring.rb")
+  end
+  if opts[:with_spring_bin]
+    FileUtils.mkdir_p("#{dir}/bin")
+    FileUtils.touch("#{dir}/bin/spring")
+  end
   dir
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envyable
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Phil Nash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2016-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor