fedux_org-stdlib 0.6.13 → 0.6.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60fef56b9f2b99139d04e9f6c2c52f3f4387a48c
-  data.tar.gz: 2c87c193deb7f904ac38a9267cb0357f3c35171d
+  metadata.gz: 8b91278b5c856f0b5196c43ce4c6a1131194f32c
+  data.tar.gz: 4a7323abd7bf2c81361b76495013e4fd73c69d81
 SHA512:
-  metadata.gz: d073868ecf93d2e205e96afe9ce3c87d5165b31c1f472648955af004bca0d621bb2d9d8d3b1055e91733f414cf9a9e78175fbce93d294cfb2ddc6075fdeddedb
-  data.tar.gz: e33c28a397bc7ad10d22a6f5f72e977f44905eaa57c91300ac9184899033b64d399730f390ca3f81ce66d6be62ef0862af253b293060fa23fd989cc68edaa87a
+  metadata.gz: 7b38a4af025e8b6de93317956cf784142a0f3162280a24b0f31f054d226f1a7bfc442b334c5238b4fd44dcbe64d60117aa3d720d28da22627e947ac19a1c843a
+  data.tar.gz: d2c8d64fc7b4d711eabc9b52a74ae81c5b6a4e34cce7599e8feca279fe3c493d4f83aeae4f0e65d26f985c44ba334df6d0677ee4ccfb3affdce38d1821530a26

data/lib/fedux_org_stdlib/app_config.rb

@@ -235,6 +235,13 @@ module FeduxOrgStdlib
       result.join("\n")
     end
 
+    # Return the path to the preferred configuration file
+    # @return [String]
+    #   The path to the preferred configuration file
+    def preferred_configuration_file
+      _allowed_config_file_paths.first
+    end
+
     private
 
     # The name of the config file

data/lib/fedux_org_stdlib/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 # FeduxOrgStdlib
 module FeduxOrgStdlib
-  VERSION = '0.6.13'
+  VERSION = '0.6.14'
 end

data/spec/app_config_spec.rb

@@ -91,7 +91,46 @@ RSpec.describe AppConfig do
     end
   end
 
+  context '#preferred_configuration_file' do
+    it 'has a default configuration file which is the preferred place to store the configuration' do
+      with_environment 'HOME' => working_directory do
+        config_klass = Class.new(AppConfig) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.preferred_configuration_file).to eq File.expand_path('~/.config/my_application/tests.yaml')
+      end
+    end
+
+    it 'works with nested module names' do
+      with_environment 'HOME' => working_directory do
+        config_klass = Class.new(AppConfig) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication::MySub'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.preferred_configuration_file).to eq File.expand_path('~/.config/my_application/my_sub/tests.yaml')
+      end
+    end
+  end
+
   context 'config files' do
+
     it 'looks at ~/.test.yaml' do
       with_environment 'HOME' => working_directory do
         create_file '.tests.yaml', <<-EOS.strip_heredoc

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.6.13
+  version: 0.6.14
 platform: ruby
 authors:
 - Max Meyer