fedux_org-stdlib 0.8.0 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dba0a7408d790446d802807ca52a3f5ef8e3f81a
-  data.tar.gz: 870ffc809e5ea3e9ff10c5950d2825b0a0245ee4
+  metadata.gz: cd43ee83a3e06f40712bd01aa5444e63bebc11f0
+  data.tar.gz: c61db9ef8692a90fc318a68150f4fb3b16ce1f7a
 SHA512:
-  metadata.gz: 5a82ec771eaf3053241133c98b5a186096888b0b94d0e4f470800d310d2444faa6863db872d8f4112ec78e74c93c966b0b5b1074e4f536f6e20d68871bdfd01d
-  data.tar.gz: 3f6e181070c4e31b9bf8953b44ddeebe91e3fbaa0057af16c04c71bd14383c590b92a90a6c911c7e62eef687e06c09d1b70865d053c2846758bcd8a67f19aa3d
+  metadata.gz: ece8ea8122b2581e43a7611415b9ab9e433e52910fc5f6deebe92b5c330461012167170c74dc5ec42e9e80955eb461bfa4fd2d585906c5fb02cfff9fca39d337
+  data.tar.gz: db43dacb6082617500e1028f804e7d03231afc0017ba92f548828ce87df8a273072261547a9065220ac762caf143ef23b0b508dcf3d505120f021bf39bad7cf5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fedux_org-stdlib (0.7.34)
+    fedux_org-stdlib (0.8.3)
       activesupport
 
 PATH

data/lib/fedux_org_stdlib/{config_directory → directory_finder}/exceptions.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module FeduxOrgStdlib
-  class ExternalConfigDirectory
+  class DirectoryFinder
     module Exceptions
       # No allowed config file could be found
       class NoConfigDirectoryFound < StandardError; end

data/lib/fedux_org_stdlib/{config_directory.rb → directory_finder.rb}

@@ -1,6 +1,6 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require 'fedux_org_stdlib/config_directory/exceptions'
+require 'fedux_org_stdlib/directory_finder/exceptions'
 require 'fedux_org_stdlib/logging/logger'
 require_library %w(json active_support/core_ext/string/inflections set active_support/core_ext/hash/slice active_support/core_ext/object/blank active_support/core_ext/hash/keys)
 
@@ -17,8 +17,8 @@ module FeduxOrgStdlib
   #
   # * application_name: Module of your class, e.g. "MyApplication" becomes
   #   "my_application"
-  # * config_directory: Pluarized name of your class and "Config" strip
-  #   off, e.g "ClientConfig" becomes "clients.yaml" (mind the pluralized name)
+  # * config_directory: Name of your class and "Directory" strip
+  #   off, e.g "ClientDirectory" becomes "client"
   #
   # Most conventions defined by me are implemented as separate methods. If one convention
   # is not suitable for your use case, just overwrite the method.
@@ -39,10 +39,10 @@ module FeduxOrgStdlib
   #
   # @example Create config with one writer and reader
   #   module MyApplication
-  #     class ClientConfig < ConfigDirectory
+  #     class ClientDirectory < DirectoryFinder
   #     end
   #   end
-  class ConfigDirectory
+  class DirectoryFinder
     # Create a new instance of config
     #
     # It tries to find a suitable configuration file. If it doesn't find one
@@ -52,10 +52,10 @@ module FeduxOrgStdlib
     #   Path where config file is stored. The file will be read by the
     #   `config_engine`.
     #
-    # @raise [Exceptions::ConfigFileNotReadable]
+    # @raise [Exceptions::DirectoryFileNotReadable]
     #   If an avaiable config file could not be read by the config engine
     #
-    # @return [ConfigDirectory]
+    # @return [DirectoryFinder]
     #   The config instance. If the resulting data structure created by the
     #   config_engine does not respond to `:[]` an empty config object will be
     #   created.
@@ -91,11 +91,11 @@ module FeduxOrgStdlib
     #
     # @example Determine the base name of the config
     #
-    #   class ClientConfig; end
+    #   class ClientDirectory; end
     #
     # This will result in `client` as base name for the config file.
     def _config_directory
-      unless (name = _class_name.sub(/Config/, '').underscore.pluralize).blank?
+      unless (name = _class_name.sub(/Directory/, '').underscore).blank?
         return name
       end
 
@@ -110,7 +110,7 @@ module FeduxOrgStdlib
     #
     # @example Determine application name
     #
-    #   class MyApplication::MyConfig; end
+    #   class MyApplication::MyDirectory; end
     #
     # This will be converted to
     #

data/lib/fedux_org_stdlib/{config_file → file_finder}/exceptions.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module FeduxOrgStdlib
-  class ConfigFile
+  class FileFinder
     module Exceptions
       # No allowed config file could be found
       class NoConfigFileFound < StandardError; end

data/lib/fedux_org_stdlib/{config_file.rb → file_finder.rb}

@@ -1,6 +1,6 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require 'fedux_org_stdlib/config_file/exceptions'
+require 'fedux_org_stdlib/file_finder/exceptions'
 require 'fedux_org_stdlib/logging/logger'
 require_library %w(json active_support/core_ext/string/inflections set active_support/core_ext/hash/slice active_support/core_ext/object/blank active_support/core_ext/hash/keys)
 
@@ -18,8 +18,8 @@ module FeduxOrgStdlib
   #
   # * application_name: Module of your class, e.g. "MyApplication" becomes
   #   "my_application"
-  # * config_file: Pluarized name of your class and "Config" strip
-  #   off, e.g "ClientConfig" becomes "clients.yaml" (mind the pluralized name)
+  # * config_file: Pluarized name of your class and "File" strip
+  #   off, e.g "ClientFile" becomes "client.yaml"
   #
   # Most conventions defined by me are implemented as separate methods. If one convention
   # is not suitable for your use case, just overwrite the method.
@@ -40,10 +40,10 @@ module FeduxOrgStdlib
   #
   # @example Create config with one writer and reader
   #   module MyApplication
-  #     class ClientConfig < ConfigFile
+  #     class ClientFile < FileFinder
   #     end
   #   end
-  class ConfigFile
+  class FileFinder
     # Create a new instance of config
     #
     # It tries to find a suitable configuration file. If it doesn't find one
@@ -53,10 +53,10 @@ module FeduxOrgStdlib
     #   Path where config file is stored. The file will be read by the
     #   `config_engine`.
     #
-    # @raise [Exceptions::ConfigFileNotReadable]
+    # @raise [Exceptions::FileFinderNotReadable]
     #   If an avaiable config file could not be read by the config engine
     #
-    # @return [ConfigFile]
+    # @return [FileFinder]
     #   The config instance. If the resulting data structure created by the
     #   config_engine does not respond to `:[]` an empty config object will be
     #   created.
@@ -110,11 +110,11 @@ module FeduxOrgStdlib
     #
     # @example Determine the base name of the config
     #
-    #   class ClientConfig; end
+    #   class ClientFile; end
     #
     # This will result in `client` as base name for the config file.
     def _config_name
-      unless (name = _class_name.sub(/Config/, '').underscore.pluralize).blank?
+      unless (name = _class_name.sub(/File/, '').underscore).blank?
         return name
       end
 
@@ -129,7 +129,7 @@ module FeduxOrgStdlib
     #
     # @example Determine application name
     #
-    #   class MyApplication::MyConfig; end
+    #   class MyApplication::MyFile; end
     #
     # This will be converted to
     #

data/lib/fedux_org_stdlib/version.rb

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

data/spec/{config_directory_spec.rb → directory_finder_spec.rb}

@@ -1,16 +1,15 @@
 # encoding: utf-8
 require 'spec_helper'
-require 'fedux_org_stdlib/config_directory'
+require 'fedux_org_stdlib/directory_finder'
 
-RSpec.describe ConfigDirectory do
-
-  context '#preferred_configuration_file' do
+RSpec.describe DirectoryFinder do
+  context '#preferred_configuration_directory' do
     it 'has a default configuration file which is the preferred place to store the configuration' do
       with_env 'HOME' => absolute_path('.') do
-        config_klass = Class.new(ConfigDirectory) do
+        config_klass = Class.new(DirectoryFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestDirectory'
           end
 
           def _module_name
@@ -19,16 +18,16 @@ RSpec.describe ConfigDirectory do
         end
 
         config = config_klass.new
-        expect(config.preferred_configuration_directory).to eq File.expand_path('~/.config/my_application/tests')
+        expect(config.preferred_configuration_directory).to eq File.expand_path('~/.config/my_application/test')
       end
     end
 
     it 'works with nested module names' do
       with_env 'HOME' => absolute_path('.') do
-        config_klass = Class.new(ConfigDirectory) do
+        config_klass = Class.new(DirectoryFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestDirectory'
           end
 
           def _module_name
@@ -37,7 +36,7 @@ RSpec.describe ConfigDirectory do
         end
 
         config = config_klass.new
-        expect(config.preferred_configuration_directory).to eq File.expand_path('~/.config/my_application/my_sub/tests')
+        expect(config.preferred_configuration_directory).to eq File.expand_path('~/.config/my_application/my_sub/test')
       end
     end
   end
@@ -45,12 +44,12 @@ RSpec.describe ConfigDirectory do
   context 'config files' do
     it 'looks at ~/.test.yaml' do
       with_env 'HOME' => absolute_path('.') do
-        create_dir '.tests'
+        create_dir '.test'
 
-        config_klass = Class.new(ConfigDirectory) do
+        config_klass = Class.new(DirectoryFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestDirectory'
           end
 
           def _module_name
@@ -59,18 +58,18 @@ RSpec.describe ConfigDirectory do
         end
 
         config = config_klass.new
-        expect(config.directory).to eq absolute_path('.tests')
+        expect(config.directory).to eq absolute_path('.test')
       end
     end
 
-    it 'looks at ~/.config/my_application/tests.yaml' do
+    it 'looks at ~/.config/my_application/test.yaml' do
       with_env 'HOME' => absolute_path('.') do
-        create_dir '.config/my_application/tests'
+        create_dir '.config/my_application/test'
 
-        config_klass = Class.new(ConfigDirectory) do
+        config_klass = Class.new(DirectoryFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestDirectory'
           end
 
           def _module_name
@@ -79,18 +78,18 @@ RSpec.describe ConfigDirectory do
         end
 
         config = config_klass.new
-        expect(config.directory).to eq absolute_path('.config/my_application/tests')
+        expect(config.directory).to eq absolute_path('.config/my_application/test')
       end
     end
 
-    it 'looks at ~/.my_application/tests.yaml' do
+    it 'looks at ~/.my_application/test.yaml' do
       with_env 'HOME' => absolute_path('.') do
-        create_dir '.my_application/tests'
+        create_dir '.my_application/test'
 
-        config_klass = Class.new(ConfigDirectory) do
+        config_klass = Class.new(DirectoryFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestDirectory'
           end
 
           def _module_name
@@ -99,18 +98,18 @@ RSpec.describe ConfigDirectory do
         end
 
         config = config_klass.new
-        expect(config.directory).to eq absolute_path('.my_application/tests')
+        expect(config.directory).to eq absolute_path('.my_application/test')
       end
     end
 
-    it 'looks at ~/.tests' do
+    it 'looks at ~/.test' do
       with_env 'HOME' => absolute_path('.') do
-        create_dir '.tests'
+        create_dir '.test'
 
-        config_klass = Class.new(ConfigDirectory) do
+        config_klass = Class.new(DirectoryFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestDirectory'
           end
 
           def _module_name
@@ -119,7 +118,7 @@ RSpec.describe ConfigDirectory do
         end
 
         config = config_klass.new
-        expect(config.directory).to eq absolute_path('.tests')
+        expect(config.directory).to eq absolute_path('.test')
       end
     end
   end

data/spec/{config_file_spec.rb → file_finder_spec.rb}

@@ -1,16 +1,15 @@
 # encoding: utf-8
 require 'spec_helper'
-require 'fedux_org_stdlib/config_file'
-
-RSpec.describe ConfigFile do
+require 'fedux_org_stdlib/file_finder'
 
+RSpec.describe FileFinder do
   context '#preferred_configuration_file' do
     it 'has a default configuration file which is the preferred place to store the configuration' do
       with_env 'HOME' => absolute_path('.') do
-        config_klass = Class.new(ConfigFile) do
+        config_klass = Class.new(FileFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestFile'
           end
 
           def _module_name
@@ -19,16 +18,16 @@ RSpec.describe ConfigFile do
         end
 
         config = config_klass.new
-        expect(config.preferred_configuration_file).to eq File.expand_path('~/.config/my_application/tests.yaml')
+        expect(config.preferred_configuration_file).to eq File.expand_path('~/.config/my_application/test.yaml')
       end
     end
 
     it 'works with nested module names' do
       with_env 'HOME' => absolute_path('.') do
-        config_klass = Class.new(ConfigFile) do
+        config_klass = Class.new(FileFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestFile'
           end
 
           def _module_name
@@ -37,7 +36,7 @@ RSpec.describe ConfigFile do
         end
 
         config = config_klass.new
-        expect(config.preferred_configuration_file).to eq File.expand_path('~/.config/my_application/my_sub/tests.yaml')
+        expect(config.preferred_configuration_file).to eq File.expand_path('~/.config/my_application/my_sub/test.yaml')
       end
     end
   end
@@ -45,12 +44,12 @@ RSpec.describe ConfigFile do
   context 'config files' do
     it 'looks at ~/.test.yaml' do
       with_env 'HOME' => absolute_path('.') do
-        touch_file '.tests.yaml'
+        touch_file '.test.yaml'
 
-        config_klass = Class.new(ConfigFile) do
+        config_klass = Class.new(FileFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestFile'
           end
 
           def _module_name
@@ -59,18 +58,18 @@ RSpec.describe ConfigFile do
         end
 
         config = config_klass.new
-        expect(config.file).to eq absolute_path('.tests.yaml')
+        expect(config.file).to eq absolute_path('.test.yaml')
       end
     end
 
-    it 'looks at ~/.config/my_application/tests.yaml' do
+    it 'looks at ~/.config/my_application/test.yaml' do
       with_env 'HOME' => absolute_path('.') do
-        touch_file '.config/my_application/tests.yaml'
+        touch_file '.config/my_application/test.yaml'
 
-        config_klass = Class.new(ConfigFile) do
+        config_klass = Class.new(FileFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestFile'
           end
 
           def _module_name
@@ -79,18 +78,18 @@ RSpec.describe ConfigFile do
         end
 
         config = config_klass.new
-        expect(config.file).to eq absolute_path('.config/my_application/tests.yaml')
+        expect(config.file).to eq absolute_path('.config/my_application/test.yaml')
       end
     end
 
-    it 'looks at ~/.my_application/tests.yaml' do
+    it 'looks at ~/.my_application/test.yaml' do
       with_env 'HOME' => absolute_path('.') do
-        touch_file '.my_application/tests.yaml'
+        touch_file '.my_application/test.yaml'
 
-        config_klass = Class.new(ConfigFile) do
+        config_klass = Class.new(FileFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestFile'
           end
 
           def _module_name
@@ -99,18 +98,18 @@ RSpec.describe ConfigFile do
         end
 
         config = config_klass.new
-        expect(config.file).to eq absolute_path('.my_application/tests.yaml')
+        expect(config.file).to eq absolute_path('.my_application/test.yaml')
       end
     end
 
-    it 'looks at ~/.testsrc' do
+    it 'looks at ~/.testrc' do
       with_env 'HOME' => absolute_path('.') do
-        touch_file '.testsrc'
+        touch_file '.testrc'
 
-        config_klass = Class.new(ConfigFile) do
+        config_klass = Class.new(FileFinder) do
 
           def _class_name
-            'TestConfig'
+            'TestFile'
           end
 
           def _module_name
@@ -119,7 +118,7 @@ RSpec.describe ConfigFile do
         end
 
         config = config_klass.new
-        expect(config.file).to eq absolute_path('.testsrc')
+        expect(config.file).to eq absolute_path('.testrc')
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.3
 platform: ruby
 authors:
 - Max Meyer
@@ -62,10 +62,6 @@ files:
 - lib/fedux_org_stdlib/command/command_result.rb
 - lib/fedux_org_stdlib/command/run_command.rb
 - lib/fedux_org_stdlib/command/which.rb
-- lib/fedux_org_stdlib/config_directory.rb
-- lib/fedux_org_stdlib/config_directory/exceptions.rb
-- lib/fedux_org_stdlib/config_file.rb
-- lib/fedux_org_stdlib/config_file/exceptions.rb
 - lib/fedux_org_stdlib/core_ext/array.rb
 - lib/fedux_org_stdlib/core_ext/array/list.rb
 - lib/fedux_org_stdlib/core_ext/hash.rb
@@ -75,7 +71,11 @@ files:
 - lib/fedux_org_stdlib/core_ext/shellwords/clean.rb
 - lib/fedux_org_stdlib/core_ext/string.rb
 - lib/fedux_org_stdlib/core_ext/string/underline.rb
+- lib/fedux_org_stdlib/directory_finder.rb
+- lib/fedux_org_stdlib/directory_finder/exceptions.rb
 - lib/fedux_org_stdlib/environment.rb
+- lib/fedux_org_stdlib/file_finder.rb
+- lib/fedux_org_stdlib/file_finder/exceptions.rb
 - lib/fedux_org_stdlib/file_template.rb
 - lib/fedux_org_stdlib/file_template/exceptions.rb
 - lib/fedux_org_stdlib/filesystem.rb
@@ -170,13 +170,12 @@ files:
 - spec/colors/html_color_spec.rb
 - spec/command/run_command_spec.rb
 - spec/command/which_spec.rb
-- spec/config_directory_spec.rb
-- spec/config_file_spec.rb
 - spec/core_ext/array/list_spec.rb
 - spec/core_ext/hash/list_spec.rb
 - spec/core_ext/hash/options_spec.rb
 - spec/core_ext/shellwords/clean_spec.rb
 - spec/core_ext/string/underline_spec.rb
+- spec/directory_finder_spec.rb
 - spec/environment_spec.rb
 - spec/examples/models/class_based/forbidden_keyword.rb
 - spec/examples/models/class_based/ignore/ignored.rb
@@ -190,6 +189,7 @@ files:
 - spec/examples/models/filesystem_based/find_files/abc.rb.swp
 - spec/examples/models/filesystem_based/find_files/cde.rb
 - spec/examples/project/plan.tjp
+- spec/file_finder_spec.rb
 - spec/fixtures_management/fixtures_manager_spec.rb
 - spec/gem_plugins/plugin_manager_spec.rb
 - spec/list_spec.rb
@@ -251,13 +251,12 @@ test_files:
 - spec/colors/html_color_spec.rb
 - spec/command/run_command_spec.rb
 - spec/command/which_spec.rb
-- spec/config_directory_spec.rb
-- spec/config_file_spec.rb
 - spec/core_ext/array/list_spec.rb
 - spec/core_ext/hash/list_spec.rb
 - spec/core_ext/hash/options_spec.rb
 - spec/core_ext/shellwords/clean_spec.rb
 - spec/core_ext/string/underline_spec.rb
+- spec/directory_finder_spec.rb
 - spec/environment_spec.rb
 - spec/examples/models/class_based/forbidden_keyword.rb
 - spec/examples/models/class_based/ignore/ignored.rb
@@ -271,6 +270,7 @@ test_files:
 - spec/examples/models/filesystem_based/find_files/abc.rb.swp
 - spec/examples/models/filesystem_based/find_files/cde.rb
 - spec/examples/project/plan.tjp
+- spec/file_finder_spec.rb
 - spec/fixtures_management/fixtures_manager_spec.rb
 - spec/gem_plugins/plugin_manager_spec.rb
 - spec/list_spec.rb