dotenvious 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05b9cfc0c1060c40bfbbf274f483ae4d351991f6
-  data.tar.gz: 1c9bc373c7b9f4f49300bbb1046f4abc71a635b5
+  metadata.gz: ab78cc6851361858979e2f864f6f7c50bc5265b3
+  data.tar.gz: 4ba12610eb2d596bd875b200d19e755ac21c9154
 SHA512:
-  metadata.gz: e7b431f326f238f3212e7a2602f829c61c141c43412d9b13ed618af526719bb572f5fde8f54425cbacad9eb7e2d4b73a204a720d5e56a8db95ec6f2038f03d03
-  data.tar.gz: 61213d32ed4d838ff06b5c261761a24eb4773a557a0d357a1b919c5ed3589b935befcac929735bbebd81d64cc8c07d25c84ddab4e8bfb9cca3a892963d33ff3c
+  metadata.gz: aa8135e30a38c0d91180866fa659f509cc56829e7e54302648de7d4438a2e7d32ceb1164892ad784590cc48957a9ce944e8ae09a85a249aa9714935906303856
+  data.tar.gz: 3a57368c0557b87a84fa983b39650233ecde8370c0e65457eb7290d4f22697a2cf2093d8f7da8c709649bd38d460130fa92bb92252eda33987607ad89db099a6

data/README.md

@@ -39,25 +39,40 @@ First, add a `.envious` file to the root of your project. In the file, you can s
 Dotenvious::Configuration.new do |config|
 
 	config.custom_variables = %w(VARIABLES WITH DIFFERENT VALUES)
-	
+
 	config.optional_variables = %w(VARIABLES YOU DONT NEED)
 
 end
 
-``` 
+```
 
 These both need to be arrays.
 
 `dotenvious` will ignore the variables specified.
 
-### Sorting
+### Additional Options
+
+#### --sort
 
 Running `dotenvious --sort` will sort your `.env` file alphabetically.
 
-## Future Work
+#### --file
+
+To select another example enironment file to use, add the optional flag `--file .env-example` or whatever your filename is.
 
+This gem also works with `.yml` or `.yaml` files designed for CircleCI. To use a `.yaml` file of this style, it must have the format:
 
-- [ ] Ability to choose which development `.env-*` file to load from
+```
+machine:
+	environment:
+		MY_ENV_VAR_1: "asdfghjk"
+		MY_ENV_VAR_2: "qwertyu"
+		...
+```
+
+Other configuration formats can be added in the future.
+
+## Future Work
 
 - [ ] Persist user's individual choices in a `.envious` file in directory after run
 

data/dotenvious.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'dotenvious'
-  s.version     = '0.0.6'
-  s.date        = '2017-01-08'
+  s.version     = '0.0.7'
+  s.date        = '2017-10-22'
   s.summary     = "Dotenvious"
   s.description = "A Gem to manage environment variables"
   s.authors     = ["Jake Faris"]

data/lib/dotenvious/cli/env_file_consolidator.rb

@@ -6,23 +6,24 @@ require_relative '../loaders/configuration'
 module Dotenvious
   module CLI
     class EnvFileConsolidator
-      def initialize(options = {})
-        @example_file = options[:example_file]
+      def initialize(example_file: DEFAULT_EXAMPLE_ENV_FILE, env_file: DEFAULT_ENV_FILE)
+        @example_file = example_file
+        @env_file = env_file
       end
 
       def run
         Loaders::Configuration.new.load
-        Loaders::Environments.new({example_file: example_file}).load_environments
+        Loaders::Environments.new({example_file: example_file, env_file: env_file}).load_environments
         unless all_vars_present? && all_vars_match?
           alert_user
           decision = STDIN.gets.strip
-          Prompter.run if decision.downcase == 'y'
+          Prompter.new(env_file).run if decision.downcase == 'y'
         end
       end
 
       private
 
-      attr_reader :example_file, :filename
+      attr_reader :example_file, :env_file, :filename
 
       def alert_user
         puts "You have missing ENV variables. Examime them? [y/n]"

data/lib/dotenvious/cli/env_file_sorter.rb

@@ -1,15 +1,21 @@
 module Dotenvious
   module CLI
     class EnvFileSorter
+      def initialize(filename = DEFAULT_ENV_FILE)
+        @filename = filename
+      end
+
       def run
-        File.open('.env', 'w') do |file|
+        File.open(filename, 'w') do |file|
           file.write(sorted_env_text)
         end
-        puts 'Your .env file is now neat and orderly. Enjoy!'
+        puts "Your #{filename} file is now neat and orderly. Enjoy!"
       end
 
       private
 
+      attr_reader :filename
+
       def sorted_env_text
         ENV.sort.map do |(key, value)|
           "#{key}=#{value}"

data/lib/dotenvious/cli/main.rb

@@ -11,23 +11,35 @@ module Dotenvious
 
       def run
         parse_options
-        EnvFileConsolidator.new({example_file: options[:file]}).run
-        EnvFileSorter.new.run if options[:sort]
+        EnvFileConsolidator.new(file_options).run
+        EnvFileSorter.new(options[:env_file]).run if options[:sort]
       end
 
       private
 
       attr_accessor :options
+      attr_reader :file_options
+
+      def file_options
+        @file_options ||= Hash.new.tap do |hash|
+          hash[:example_file] = options[:example_file] if options.key?(:example_file)
+          hash[:env_file] = options[:env_file] if options.key?(:env_file)
+        end
+      end
 
       def parse_options
         parser = OptionParser.new do |opts|
           opts.banner = "How to use Dotenvious:"
 
-          opts.on('-f .example-environment-file', '--file .example-environment-file', 'Specify which example file to use') do |file|
-            options[:file] = file
+          opts.on('-x .example-env-file', '--example .example-env-file', 'Specify which example file to use') do |file|
+            options[:example_file] = file
+          end
+
+          opts.on('-f .env-file', '--file .env-file', 'Specify which file to write to') do |file|
+            options[:env_file] = file
           end
 
-          opts.on('-s', '--sort', 'Sort .env file by key names alphabetically') do
+          opts.on('-s', '--sort', 'Sort env file by key names alphabetically') do
             options[:sort] = true
           end
 

data/lib/dotenvious/env_appender.rb

@@ -1,15 +1,20 @@
 module Dotenvious
   class EnvAppender
+    def initialize(filename)
+      @filename = filename
+    end
+
     def append(key)
       env.write("#{key}=#{ENV_EXAMPLE[key]}\n")
+      env.close
     end
 
     private
 
-    attr_reader :env
+    attr_reader :env, :filename
 
     def env
-      @env ||= File.open('.env', 'a+')
+      @env ||= File.open(filename, 'a+')
     end
   end
 end

data/lib/dotenvious/loaders/environments.rb

@@ -6,17 +6,18 @@ module Dotenvious
     class Environments
       def initialize(options = {})
         @example_file = options[:example_file] || DEFAULT_EXAMPLE_ENV_FILE
+        @env_file = options[:env_file] || DEFAULT_ENV_FILE
       end
 
       def load_environments
-        ENV.merge!(DotenvFile.load_from('.env'))
+        ENV.merge!(DotenvFile.load_from(env_file))
         environment_loader = example_file.match(/\.ya?ml/) ? YamlFile : DotenvFile
         ENV_EXAMPLE.merge!(environment_loader.load_from(example_file))
       end
 
       private
 
-      attr_reader :example_file
+      attr_reader :example_file, :env_file
     end
   end
 end

data/lib/dotenvious/prompter.rb

@@ -5,47 +5,53 @@ require_relative 'env_appender'
 
 module Dotenvious
   class Prompter
-    def self.run
+    def initialize(filename = DEFAULT_ENV_FILE)
+      @filename = filename
+    end
+
+    def run
       keys_in_question.each do |key, status|
         decision = prompt(key, status)
         return if decision == 'q'
         next unless decision.downcase == 'y'
 
         if status == 'missing'
-          EnvAppender.new.append(key)
+          EnvAppender.new(filename).append(key)
         elsif status == 'mismatched'
-          ValueReplacer.new.replace(key)
+          ValueReplacer.new(filename).replace(key)
         end
       end
     end
 
     private
 
-    def self.keys_in_question
+    attr_reader :filename
+
+    def keys_in_question
       missing_keys = missing_vars.zip(['missing'] * missing_vars.length)
       mismatched_keys = mismatched_vars.zip(['mismatched'] * mismatched_vars.length)
       missing_keys + mismatched_keys
     end
 
-    def self.missing_vars
+    def missing_vars
       MissingVariableFinder.missing_required_vars
     end
 
-    def self.mismatched_vars
+    def mismatched_vars
       MismatchedVariableFinder.mismatched_vars
     end
 
-    def self.prompt(var, status)
+    def prompt(var, status)
       send(:"display_#{status}_output", var)
       STDIN.gets.strip
     end
 
-    def self.display_missing_output(var)
+    def display_missing_output(var)
       puts "#{var}=#{ENV_EXAMPLE[var]}"
-      puts "Add to .env? [y/n/q]"
+      puts "Add to #{filename}? [y/n/q]"
     end
 
-    def self.display_mismatched_output(var)
+    def display_mismatched_output(var)
       puts "ENV[#{var}] is set to: #{ENV[var]}"
       puts "Example [#{var}] is set to: #{ENV_EXAMPLE[var]}"
       puts "Replace with the example value? [y/n/q]"

data/lib/dotenvious/value_replacer.rb

@@ -1,24 +1,29 @@
 module Dotenvious
   class ValueReplacer
+    def initialize(filename)
+      @filename = filename
+    end
+
     def replace(key)
       line_number = base_env.find_index do |line|
         line.match(/^#{key}=/)
       end
       updated_env = base_env.dup
       updated_env[line_number] = "#{key}=#{ENV_EXAMPLE[key]}"
-      env_writer.write(updated_env.join("\n"))
+      env_writer.write(updated_env.join("\n") + "\n")
+      env_writer.close
     end
 
     private
 
-    attr_reader :base_env
+    attr_reader :base_env, :filename
 
     def base_env
-      @base_env ||= File.read('.env').split("\n")
+      @base_env ||= File.read(filename).split("\n")
     end
 
     def env_writer
-      File.open('.env', 'w')
+      @env_writer ||= File.open(filename, 'w')
     end
   end
 end

data/spec/dotenvious/cli/env_file_consolidator_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Dotenvious::CLI::EnvFileConsolidator do
   describe '.new' do
     it 'takes option hash' do
-      expect { described_class.new({example_file: '.envenvenv'}) }.to_not raise_error
+      expect { described_class.new({example_file: '.envenvenv', env_file: '.env'}) }.to_not raise_error
     end
   end
 
@@ -23,9 +23,11 @@ describe Dotenvious::CLI::EnvFileConsolidator do
         context 'and the user wants to append them' do
           it 'begins the Prompter' do
             io_object = double
+            prompter = double
             expect(STDIN).to receive(:gets).and_return('y')
             expect_any_instance_of(described_class).to receive(:all_vars_present?).and_return false
-            expect(Dotenvious::Prompter).to receive(:run)#.and_return false
+            expect(Dotenvious::Prompter).to receive(:new).and_return prompter
+            expect(prompter).to receive(:run)
             described_class.new.run
           end
         end
@@ -56,7 +58,7 @@ describe Dotenvious::CLI::EnvFileConsolidator do
       it 'loads environments with that example_file' do
         environments_double = double
         expect(Dotenvious::Loaders::Environments).to receive(:new)
-          .with({example_file: '.test.env.test'}).and_return(environments_double)
+          .with({example_file: '.test.env.test', env_file: '.env'}).and_return(environments_double)
         expect(environments_double).to receive(:load_environments)
 
         described_class.new({example_file: '.test.env.test'}).run

data/spec/dotenvious/cli/main_spec.rb

@@ -41,9 +41,9 @@ describe Dotenvious::CLI::Main do
           end
         end
 
-        context '--file' do
+        context '--example' do
           before do
-            stub_const('ARGV', ['--file', '.my-test-file-env'])
+            stub_const('ARGV', ['--example', '.my-test-file-env'])
           end
 
           it 'uses the user-specified filename to read example environment' do
@@ -56,6 +56,22 @@ describe Dotenvious::CLI::Main do
             described_class.new.run
           end
         end
+
+        context '--file' do
+          before do
+            stub_const('ARGV', ['--file', '.my-env'])
+          end
+
+          it 'uses the user-specified filename to read example environment' do
+            fake_consolidator = double
+            expect(fake_consolidator).to receive(:run)
+            expect(Dotenvious::CLI::EnvFileConsolidator).to receive(:new)
+              .with({env_file: '.my-env'})
+              .and_return(fake_consolidator)
+
+            described_class.new.run
+          end
+        end
       end
     end
   end

data/spec/dotenvious/env_appender_spec.rb

@@ -9,11 +9,12 @@ describe Dotenvious::EnvAppender do
     it 'appends the value to the end of the .env file' do
       env_double = double('File', write: nil)
       expect(env_double).to receive(:write).with("test2=example2\n")
+      expect(env_double).to receive(:close)
       expect(File).to receive(:open).
-        with('.env', 'a+').once.
+        with('.big-ol-env', 'a+').once.
         and_return(env_double)
 
-      described_class.new.append('test2')
+      described_class.new('.big-ol-env').append('test2')
     end
   end
 end

data/spec/dotenvious/prompter_spec.rb

@@ -11,22 +11,29 @@ describe Dotenvious::Prompter do
     it 'prompts the user to add every missing or mismatched variable do' do
       expect(STDIN).to receive(:gets).twice.and_return('n')
 
-      described_class.run
+      described_class.new.run
     end
 
     it 'appends the vars to .env' do
       expect(STDIN).to receive(:gets).twice.and_return('y','n')
+      file_double = double
+      expect(file_double).to receive(:write).with("test2=\n")
+      expect(file_double).to receive(:close)
+
       expect(File).to receive(:open).
         with('.env', 'a+').once.
-        and_return(double('File', write: nil))
+        and_return(file_double)
 
-      described_class.run
+      described_class.new.run
     end
 
     it 'quits out if the user presses q' do
       expect(STDIN).to receive(:gets).once.and_return('q')
 
-      described_class.run
+      described_class.new.run
+    end
+
+    xit 'given missing and different args, appends/rewrites correctly into env' do
     end
   end
 end

data/spec/dotenvious/value_replacer_spec.rb

@@ -3,21 +3,25 @@ require 'spec_helper'
 describe Dotenvious::ValueReplacer do
   describe '#replace' do
     before do
-      stub_const('Dotenvious::ENV_EXAMPLE', {'fake' => 'correct'} )
+      stub_const('Dotenvious::ENV_EXAMPLE', example_const )
     end
-    it "replaces the key's value in .env if user presses yes" do
-      expect(File).to receive(:read).
-        with('.env').
-        and_return("test=1234\nfake=missing")
+    context 'given a key with a different value' do
+      let(:example_const) { {'fake' => 'correct'} }
+      it "replaces the key's value in .env if user presses yes" do
+        expect(File).to receive(:read).
+          with('.big-ol-env').
+          and_return("test=1234\nfake=missing")
 
-      env_double = double('File', write: nil)
-      expect(env_double).to receive(:write).with("test=1234\nfake=correct")
+        env_double = double('File', write: nil)
+        expect(env_double).to receive(:write).with("test=1234\nfake=correct\n")
+        expect(env_double).to receive(:close)
 
-      expect(File).to receive(:open).
-        with('.env', 'w').
-        and_return(env_double)
+        expect(File).to receive(:open).
+          with('.big-ol-env', 'w').
+          and_return(env_double)
 
-      described_class.new.replace('fake')
+        described_class.new('.big-ol-env').replace('fake')
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenvious
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Jake Faris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2017-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler