dotenvious 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f3d8233b6bd8144495af0638e41cf3b14fa65db
-  data.tar.gz: 18506bfd293ac3125816db78052fed52dd85660a
+  metadata.gz: 9fbd0527566372e2936735e868632eae06450968
+  data.tar.gz: ffab6509a4ce0ef809f5b095ac9f6c0d67c99d43
 SHA512:
-  metadata.gz: 26a1170e357207a78f1ecfb5a8881e0ca1a462b0db643ba7e1dff023eec89b38d3cad3b60f26297d76439aa44c578e0843a260cf5cbf2719b63a38f80e3fe479
-  data.tar.gz: cc93d31e8d2ac1cec5e6b47e9bb033d0b993b5f99647b284488dfa4ccb3320be2366fd524a16f042cb623603d75246c778b05eac8a8d2fd6e5d8659366ca72b5
+  metadata.gz: 0533e7fbf6f16111122bb2fba3b718af04ad1de1b65590a6bc549ceadd44a668bf6d8aa2d230ca928b418138c8b24a809bdc0b18eb0d1cdff33449d9f16d6893
+  data.tar.gz: 176333978d98cc06104debc2d40c5627628a8c9c3dc97dfcfbecd397c7bb9198656854a77c65d5f7c4e4de2b196dc6b406b03ce7cb22919744e6ed5fb7a8c99d

data/.gitignore

@@ -3,3 +3,4 @@
 .example-env
 .envious
 dotenvious-*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 2.3.1
+
+script: bundle exec rspec spec

data/Gemfile

@@ -1,3 +1,9 @@
 source 'https://www.rubygems.org'
 
-gemspec
+ruby '2.3.1'
+
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/README.md

@@ -1,41 +1,61 @@
 # Dotenvious
 
-A gem to manage .env dependencies.
+A gem to manage `.env` dependencies.
 
 Your `.env` file gets jealous when `.example-env` has keys that it does not. Dotenvious helps `.env` get back on the right track.
 
-This gem exists to solve the following workflow:
+See that your most recent pull breaks Rails on startup due to missing environment variables? Run `bundle exec dotenvious` and it will present to you the new variables that were added - and give you the option to immediately add them to your `.env` file.
 
-Imagine you're working at a small to mid-size team in a startup whose architecture is constantly evolving. In a fast-moving startup, environment variable may change rapidly.
+Dotenvious eliminates the pain of manually parsing through a newly changed `.example-env` file to see which new breaking variables have been added.
 
-If you're working on one team within a larger application, environment variables may be added to your codebase that you might know were added, some of which may break the application's code after pulling from your updated repository.
+## Getting Started
 
-Dotenvious solves this problem. See that your most recent pull breaks Rails on startup? Run dotenvious and it will present to you the new variables that were added - and give you the option to immediately add them to your `.env` file.
+Add the gem to your Gemfile by the following:
 
-Dotenvious eliminates the pain of manually parsing through a newly changed `.example-env` file to see which new breaking variables have been added.
+```
+
group :development do
+	gem 'dotenvious'
+end
 
-## Getting Started
+```
 
+then run:
 
+```
+bundle install
+bundle exec dotenvious
+```
 
-## What You Need
+The CLI will then take you through your `.env` and `.example-env` files, prompting you to add missing variables or overwrite differing variables.
 
-This gem compares the variables set in your `.env` file with what exists in `.example-env`. The gem includes a CLI which walks you through the variables missing in `.env` but present in `.example-env`.
 
-Currently, this gem relies on [Dotenv](https://github.com/bkeepers/dotenv) to load dependencies from ENV.
+## Customization
 
-## Future Work
+Currently, one can whitelist which variables they want to exclude from examination.
 
-- [ ] Figure out how to incorporate in rakefile
+First, add a `.envious` file to the root of your project. In the file, you can specify which variables to ignore fully (`optional_variables`) or those that you need but are expected to have different values from those provided in `.example-env` (`custom_variables`).
 
-- [x] Compare keys already present in both files but with different values
+```
+Dotenvious::Configuration.new do |config|
 
-- [ ] Ability to choose which development `.env-*` file to load from
+	config.custom_variables = %w(VARIABLES WITH DIFFERENT VALUES)
+	
+	config.optional_variables = %w(VARIABLES YOU DONT NEED)
+
+end
 
-- [ ] Persist user's individual choices in a `.dotenvious` file in directory
+``` 
+
+These both need to be arrays.
+
+`dotenvious` will ignore the variables specified.
+## Future Work
+
+
+- [ ] Ability to choose which development `.env-*` file to load from
 
-- [ ] Option to always run on boot after recent pull from master
+- [ ] Persist user's individual choices in a `.envious` file in directory after run
 
 - [ ] Auto create `.envious` with user specified options if not exists
 
-- [ ] More things are always on the horizon!
+- [ ] Remove duplicate variables if declared twice in `.env` file

data/bin/dotenvious

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require "dotenvious"
-Dotenvious::CLI.new.run
+Dotenvious::CLI::Main.new.run

data/dotenvious.gemspec

@@ -1,15 +1,14 @@
 Gem::Specification.new do |s|
   s.name        = 'dotenvious'
-  s.version     = '0.0.1'
-  s.date        = '2016-09-10'
+  s.version     = '0.0.3'
+  s.date        = '2016-10-21'
   s.summary     = "Dotenvious"
-  s.description = "A dotenv wrapper to manage variables"
+  s.description = "A Gem to manage environment variables"
   s.authors     = ["Jake Faris"]
   s.email       = 'jakefaris@outlook.com'
   s.files       = `git ls-files`.split($/)
   s.executables = ['dotenvious']
-  s.homepage    =
-    'http://rubygems.org/gems/dotenvious'
+  s.homepage    = 'https://github.com/farisj/dotenvious'
   s.license       = 'MIT'
 
   s.add_development_dependency 'bundler', '~> 1.3'

data/lib/dotenvious/cli/env_file_consolidator.rb

@@ -0,0 +1,36 @@
+require_relative '../loaders/environments'
+require_relative '../missing_variable_finder'
+require_relative '../prompter'
+require_relative '../loaders/configuration'
+
+module Dotenvious
+  module CLI
+    class EnvFileConsolidator
+      def run
+        Loaders::Configuration.new.load
+        Loaders::Environments.new.load_envs
+        unless all_vars_present? && all_vars_match?
+          alert_user
+          decision = STDIN.gets.strip
+          Prompter.run if decision.downcase == 'y'
+        end
+      end
+
+      private
+
+      attr_reader :filename
+
+      def alert_user
+        puts "You have missing ENV variables. Examime them? [y/n]"
+      end
+
+      def all_vars_present?
+        !MissingVariableFinder.required_vars_missing?
+      end
+
+      def all_vars_match?
+        !MismatchedVariableFinder.mismatched_vars?
+      end
+    end
+  end
+end

data/lib/dotenvious/cli/env_file_sorter.rb

@@ -0,0 +1,24 @@
+require_relative '../loaders/env'
+
+module Dotenvious
+  module CLI
+    class EnvFileSorter
+      def run
+        Loaders::Env.new.load
+        puts "Sorting..."
+        File.open('.env', 'w') do |file|
+          file.write(sorted_env_text)
+        end
+        puts 'Your .env file is now neat and orderly. Enjoy!'
+      end
+
+      private
+
+      def sorted_env_text
+        ENV.sort.map do |(key, value)|
+          "#{key}=#{value}"
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/dotenvious/cli/main.rb

@@ -0,0 +1,26 @@
+require_relative 'env_file_consolidator'
+require_relative 'env_file_sorter'
+
+module Dotenvious
+  module CLI
+    class Main
+      def run
+        if ARGV[0].to_s.empty?
+          EnvFileConsolidator.new.run
+        elsif ARGV[0].to_s == '--sort'
+          EnvFileSorter.new.run
+        else
+          ask_user_to_remove_flags
+        end
+      end
+
+      private
+
+      attr_reader :filename
+
+      def ask_user_to_remove_flags
+        puts "dotenvious does not have flags at this time. Run 'dotenvious' without flags to get the main functionality."
+      end
+    end
+  end
+end

data/lib/dotenvious/loaders/env.rb

@@ -3,6 +3,10 @@ module Dotenvious
     class Env < Environment
       private
 
+      def filename
+        DEFAULT_ENV_FILE
+      end
+
       def environment
         Dotenvious::ENV
       end

data/lib/dotenvious/loaders/environment.rb

@@ -1,10 +1,6 @@
 module Dotenvious
   module Loaders
     class Environment
-      def initialize(filename)
-        @filename = filename
-      end
-
       def load
         #took from Dotenv source code whoops
         file.each do |line|
@@ -18,11 +14,13 @@ module Dotenvious
         raise "environment must be defined in child class"
       end
 
-      def file
-        File.read(@filename).split("\n")
+      def filename
+        raise "fileame must be defined in child class"
       end
 
-      attr_reader :filename
+      def file
+        File.read(filename).split("\n")
+      end
     end
   end
 end

data/lib/dotenvious/loaders/environments.rb

@@ -4,19 +4,10 @@ require_relative 'env'
 module Dotenvious
   module Loaders
     class Environments
-
-      def initialize(filename)
-        @filename = filename
-      end
-
       def load_envs
-        Env.new('.env').load
-        Example.new(filename).load
+        Env.new.load
+        Example.new.load
       end
-
-      private
-
-      attr_reader :filename
     end
   end
 end

data/lib/dotenvious/loaders/example.rb

@@ -5,6 +5,10 @@ module Dotenvious
     class Example < Environment
       private
 
+      def filename
+        DEFAULT_EXAMPLE_ENV_FILE
+      end
+
       def environment
         Dotenvious::ENV_EXAMPLE
       end

data/lib/dotenvious.rb

@@ -1,7 +1,9 @@
 module Dotenvious
+  DEFAULT_ENV_FILE = '.env'
+  DEFAULT_EXAMPLE_ENV_FILE = '.example-env'
   ENV = {}
   ENV_EXAMPLE = {}
   CONFIG = {}
 end
 
-require_relative 'dotenvious/cli'
+require_relative 'dotenvious/cli/main'

data/spec/dotenvious/cli/env_file_consolidator_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Dotenvious::CLI::EnvFileConsolidator do
+  describe '.new' do
+    xit 'determines the correct file to use as example' do
+      # future release work
+    end
+  end
+
+  describe '#run' do
+    context 'with no flags' do
+      before do
+        allow(File).to receive(:read).and_return("")
+      end
+
+      it 'loads the environment & example environment variables' do
+        expect_any_instance_of(Dotenvious::Loaders::Environments).to receive(:load_envs)
+
+        described_class.new.run
+      end
+
+      context 'when there are ENV vars missing' do
+        context 'and the user wants to append them' do
+          it 'begins the Prompter' do
+            io_object = 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
+            described_class.new.run
+          end
+        end
+
+        context 'but the user does not care' do
+          it 'quits' do
+            expect(STDIN).to receive(:gets).and_return('n')
+            expect_any_instance_of(described_class).to receive(:all_vars_present?).and_return false
+            expect(Dotenvious::Prompter).not_to receive(:run)#.and_return false
+
+            described_class.new.run
+          end
+        end
+      end
+
+      #Keep
+      context 'when there are no ENV vars missing or mismatched' do
+        it 'does nothing' do
+          expect_any_instance_of(described_class).to receive(:all_vars_present?).and_return true
+          expect_any_instance_of(described_class).to receive(:all_vars_match?).and_return true
+
+          expect { described_class.new.run }.to_not raise_error
+        end
+      end
+    end
+  end
+end

data/spec/dotenvious/cli/env_file_sorter_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Dotenvious::CLI::EnvFileSorter do
+  describe '#run' do
+    it "sorts the key-value pairs back into .env" do
+      expect_any_instance_of(Dotenvious::Loaders::Env).to receive(:load).and_return true
+
+      stub_const('Dotenvious::ENV', {'TEST' => 'same', 'ABC' => '123'} )
+
+      fake_file = double
+      expect(fake_file).to receive(:write).with("ABC=123\nTEST=same")
+      expect(File).to receive(:open).with('.env', 'w').and_yield fake_file
+
+      described_class.new.run
+    end
+  end
+end

data/spec/dotenvious/cli/main_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Dotenvious::CLI::Main do
+  describe '#run' do
+    context 'with no flags' do
+      before do
+        allow(File).to receive(:read).and_return("")
+      end
+
+      it 'begins the EnvFileConsolidator' do
+        expect_any_instance_of(Dotenvious::CLI::EnvFileConsolidator).to receive(:run)
+
+        described_class.new.run
+      end
+    end
+
+    context 'when option flags are given' do
+      before do
+        stub_const('ARGV', ['--test'])
+      end
+
+      it 'tells the user to try again without flags' do
+        expect_any_instance_of(described_class).to receive(:ask_user_to_remove_flags)
+
+        described_class.new.run
+      end
+    end
+  end
+end

data/spec/dotenvious/loaders/env_spec.rb

@@ -1,23 +1,17 @@
 require 'spec_helper'
 
 describe Dotenvious::Loaders::Env do
-  describe '.new' do
-    it 'takes one argument' do
-      expect{ described_class.new('test') }.to_not raise_error
-    end
-  end
-
   describe '#load' do
-    it 'loads files from its .new argument' do
-      expect(File).to receive(:read).with('test').and_return ""
+    it 'loads files from .env' do
+      expect(File).to receive(:read).with('.env').and_return ""
 
-      described_class.new('test').load
+      described_class.new.load
     end
 
     it 'passes those arguments to Dotenvious::ENV_EXAMPLE' do
       expect(File).to receive(:read).and_return "TEST=123\nEXAMPLE=234"
 
-      described_class.new('test').load
+      described_class.new.load
 
       expect(Dotenvious::ENV['TEST']).to eq '123'
       expect(Dotenvious::ENV['EXAMPLE']).to eq '234'

data/spec/dotenvious/loaders/environments_spec.rb

@@ -1,18 +1,12 @@
 require 'spec_helper'
 
 describe Dotenvious::Loaders::Environments do
-  describe '#initialize' do
-    it 'takes 1 argument' do
-      expect { described_class.new('test') }.to_not raise_error
-    end
-  end
-
   describe '#load_envs' do
     it 'loads from Dotenv as well as Loaders::Example' do
       expect_any_instance_of(Dotenvious::Loaders::Example).to receive(:load)
       expect_any_instance_of(Dotenvious::Loaders::Env).to receive(:load)
 
-      described_class.new('test').load_envs
+      described_class.new.load_envs
     end
   end
 end

data/spec/dotenvious/loaders/example_spec.rb

@@ -1,23 +1,20 @@
 require 'spec_helper'
 
 describe Dotenvious::Loaders::Example do
-  describe '.new' do
-    it 'takes one argument' do
-      expect{ described_class.new('test') }.to_not raise_error
-    end
-  end
-
   describe '#load' do
-    it 'loads files from its .new argument' do
-      expect(File).to receive(:read).with('test').and_return ""
+    before do
+      stub_const('Dotenvious::DEFAULT_EXAMPLE_ENV_FILE', '.example-env')
+    end
+    it 'loads files from Dotenvious::DEFAULT_EXAMPLE_ENV_FILE' do
+      expect(File).to receive(:read).with('.example-env').and_return ""
 
-      described_class.new('test').load
+      described_class.new.load
     end
 
     it 'passes those arguments to Dotenvious::ENV_EXAMPLE' do
       expect(File).to receive(:read).and_return "TEST=123\nEXAMPLE=234"
 
-      described_class.new('test').load
+      described_class.new.load
 
       expect(Dotenvious::ENV_EXAMPLE['TEST']).to eq '123'
       expect(Dotenvious::ENV_EXAMPLE['EXAMPLE']).to eq '234'

data/spec/spec_helper.rb

@@ -18,3 +18,5 @@ RSpec.configure do |config|
     $stdout = original_stdout
   end
 end
+
+ARGV = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenvious
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Jake Faris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-10 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-description: A dotenv wrapper to manage variables
+description: A Gem to manage environment variables
 email: jakefaris@outlook.com
 executables:
 - dotenvious
@@ -60,13 +60,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - README.md
 - bin/dotenvious
 - dotenvious.gemspec
 - lib/dotenvious.rb
-- lib/dotenvious/cli.rb
+- lib/dotenvious/cli/env_file_consolidator.rb
+- lib/dotenvious/cli/env_file_sorter.rb
+- lib/dotenvious/cli/main.rb
 - lib/dotenvious/configuration.rb
 - lib/dotenvious/env_appender.rb
 - lib/dotenvious/loaders/configuration.rb
@@ -78,7 +80,9 @@ files:
 - lib/dotenvious/missing_variable_finder.rb
 - lib/dotenvious/prompter.rb
 - lib/dotenvious/value_replacer.rb
-- spec/dotenvious/cli_spec.rb
+- spec/dotenvious/cli/env_file_consolidator_spec.rb
+- spec/dotenvious/cli/env_file_sorter_spec.rb
+- spec/dotenvious/cli/main_spec.rb
 - spec/dotenvious/configuration_spec.rb
 - spec/dotenvious/env_appender_spec.rb
 - spec/dotenvious/loaders/configuration_spec.rb
@@ -90,7 +94,7 @@ files:
 - spec/dotenvious/prompter_spec.rb
 - spec/dotenvious/value_replacer_spec.rb
 - spec/spec_helper.rb
-homepage: http://rubygems.org/gems/dotenvious
+homepage: https://github.com/farisj/dotenvious
 licenses:
 - MIT
 metadata: {}
@@ -115,4 +119,3 @@ signing_key:
 specification_version: 4
 summary: Dotenvious
 test_files: []
-has_rdoc: 

data/Gemfile.lock

@@ -1,41 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dotenvious (0.0.0)
-
-GEM
-  remote: https://www.rubygems.org/
-  specs:
-    coderay (1.1.1)
-    diff-lcs (1.2.5)
-    method_source (0.8.2)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    slop (3.6.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.3)
-  dotenvious!
-  pry
-  rspec (>= 3.0)
-
-BUNDLED WITH
-   1.12.5

data/lib/dotenvious/cli.rb

@@ -1,44 +0,0 @@
-require_relative 'loaders/environments'
-require_relative 'missing_variable_finder'
-require_relative 'prompter'
-require_relative 'loaders/configuration'
-require 'pry'
-module Dotenvious
-  class CLI
-    def initialize
-      #figure out which file - for now can just look .env.example or .example-env
-      @filename = '.example-env' # or .env-example
-    end
-
-    def run
-      Loaders::Configuration.new.load
-      Loaders::Environments.new(filename).load_envs
-      unless all_vars_present? && all_vars_match?
-        alert_user
-        decision = STDIN.gets.strip
-        Prompter.run if decision.downcase == 'y'
-      end
-    end
-
-    private
-
-    attr_reader :filename
-
-    def alert_user
-      puts "You have missing ENV variables. Examime them? [y/n]"
-    end
-
-    def all_vars_present?
-      !MissingVariableFinder.required_vars_missing?
-    end
-
-    def all_vars_match?
-      !MismatchedVariableFinder.mismatched_vars?
-    end
-
-    def abort
-      abort_message = 'Hold up! Your .env file is green with envy towards .example-env. You should update it.'
-      super abort_message
-    end
-  end
-end

data/spec/dotenvious/cli_spec.rb

@@ -1,47 +0,0 @@
-require 'spec_helper'
-
-describe Dotenvious::CLI do
-  describe '.new' do
-    xit 'determines the correct file to use as example' do
-      # future release work
-    end
-  end
-
-  describe '#run' do
-    it 'loads the environment & example environment variables' do
-      expect_any_instance_of(Dotenvious::Loaders::Environments).to receive(:load_envs)
-
-      described_class.new.run
-    end
-
-    context 'when there are ENV vars missing' do
-      context 'and the user wants to append them' do
-        it 'begins the Prompter' do
-          io_object = 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
-          described_class.new.run
-        end
-      end
-      context 'but the user does not care' do
-        it 'quits' do
-          expect(STDIN).to receive(:gets).and_return('n')
-          expect_any_instance_of(described_class).to receive(:all_vars_present?).and_return false
-          expect(Dotenvious::Prompter).not_to receive(:run)#.and_return false
-
-          described_class.new.run
-        end
-      end
-    end
-
-    context 'when there are no ENV vars missing or mismatched' do
-      it 'does nothing' do
-        expect_any_instance_of(described_class).to receive(:all_vars_present?).and_return true
-        expect_any_instance_of(described_class).to receive(:all_vars_match?).and_return true
-
-        expect { described_class.new.run }.to_not raise_error
-      end
-    end
-  end
-end