Merge pull request #385 from DannyBen/add/bashly-settings-filename-support

Allow using `bashly-settings.yml` instead of `settings.yml`

Author: DannyBen

lib/bashly/settings.rb

@@ -56,9 +56,9 @@ def strict
       end
 
       def strict_string
-        if Settings.strict.is_a? String
-          Settings.strict
-        elsif Settings.strict
+        if strict.is_a? String
+          strict
+        elsif strict
           'set -euo pipefail'
         else
           'set -e'
@@ -101,7 +101,13 @@ def user_settings
       end
 
       def user_settings_path
-        ENV['BASHLY_SETTINGS_PATH'] || 'settings.yml'
+        @user_settings_path ||= if ENV['BASHLY_SETTINGS_PATH']
+          ENV['BASHLY_SETTINGS_PATH']
+        elsif File.exist? 'bashly-settings.yml'
+          'bashly-settings.yml'
+        else
+          'settings.yml'
+        end
       end
 
       def defsult_settings

spec/bashly/settings_spec.rb

@@ -1,13 +1,56 @@
 require 'spec_helper'
 
 describe Settings do
-  subject { described_class }
+  subject { BaselineSettings.clone }
 
   describe 'standard value' do
     it 'returns a predefined default value' do
       expect(subject.tab_indent).to be false
     end
 
+    context 'when settings.yml exists' do
+      before do
+        reset_tmp_dir
+        File.write 'spec/tmp/settings.yml', 'source_dir: somedir'
+        subject.source_dir = nil
+      end
+
+      it 'returns the value from the settings file' do
+        Dir.chdir 'spec/tmp' do
+          expect(subject.source_dir).to eq 'somedir'
+        end
+      end
+    end
+
+    context 'when bashly-settings.yml exists' do
+      before do
+        reset_tmp_dir
+        File.write 'spec/tmp/bashly-settings.yml', 'source_dir: somedir'
+        subject.source_dir = nil
+      end
+
+      it 'returns the value from the settings file' do
+        Dir.chdir 'spec/tmp' do
+          expect(subject.source_dir).to eq 'somedir'
+        end
+      end
+    end
+
+    context 'when BASHLY_SETTINGS_PATH is set' do
+      before do
+        reset_tmp_dir
+        File.write 'spec/tmp/my-settings.yml', 'source_dir: from-var'
+        ENV['BASHLY_SETTINGS_PATH'] = 'spec/tmp/my-settings.yml'
+        subject.source_dir = nil
+      end
+
+      after { ENV['BASHLY_SETTINGS_PATH'] = nil }
+
+      it 'returns the value from the settings file' do
+        expect(subject.source_dir).to eq 'from-var'
+      end
+    end
+
     context 'when its corresponding env var is set' do
       original_value = ENV['BASHLY_TAB_INDENT']
 
@@ -57,10 +100,6 @@
   end
 
   describe 'strict_string' do
-    original_value = described_class.strict
-
-    after { subject.strict = original_value }
-
     context 'when strict is true' do
       before { subject.strict = true }
 

spec/spec_helper.rb

@@ -34,6 +34,10 @@
 Settings.env = :development
 reset_tmp_dir
 
+# This is used in the Settings spec, to ensure we are working with an
+# eigenclass that has a known state
+BaselineSettings = Settings.clone
+
 # Consistent Colsole output (for rspec_fixtures)
 ENV['TTY'] = 'off'
 ENV['COLUMNS'] = '80'