fedux_org-stdlib 0.7.33 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2df3bafb3b745bddbd69a9f0537867eedec950b6
-  data.tar.gz: 0b1051884555097787efc2771df1479eae33f1d8
+  metadata.gz: dba0a7408d790446d802807ca52a3f5ef8e3f81a
+  data.tar.gz: 870ffc809e5ea3e9ff10c5950d2825b0a0245ee4
 SHA512:
-  metadata.gz: e9f5967d86a4a088582bcc535ba777d90bc9e912414e3db8db9f4464142c17a5b9ed041bfddde2a650ff693e892651e5f54007e3009fee2811bfe4438df42abb
-  data.tar.gz: 7567209863dbd40e9491b691fc571e4fcddaee1f703e4845b4bbcc624b4e0b7a120a272de106781cac2878f84eeb12dddc1beb30acfedb79a35c781f45f33adf
+  metadata.gz: 5a82ec771eaf3053241133c98b5a186096888b0b94d0e4f470800d310d2444faa6863db872d8f4112ec78e74c93c966b0b5b1074e4f536f6e20d68871bdfd01d
+  data.tar.gz: 3f6e181070c4e31b9bf8953b44ddeebe91e3fbaa0057af16c04c71bd14383c590b92a90a6c911c7e62eef687e06c09d1b70865d053c2846758bcd8a67f19aa3d

data/Gemfile.lock

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

data/lib/fedux_org_stdlib/config_directory/exceptions.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module FeduxOrgStdlib
+  class ExternalConfigDirectory
+    module Exceptions
+      # No allowed config file could be found
+      class NoConfigDirectoryFound < StandardError; end
+
+      # If no module is given on class
+      class NamespaceIsMissing < StandardError; end
+
+      # If no class name is present
+      class ClassNameIsMissing < StandardError; end
+    end
+  end
+end

data/lib/fedux_org_stdlib/config_directory.rb

@@ -0,0 +1,148 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/require_files'
+require 'fedux_org_stdlib/config_directory/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)
+
+module FeduxOrgStdlib
+  # This class detects the file name for an config file. By default it will
+  # look for a suitable config file in the given order:
+  #
+  # 1. $HOME/.config/<application_name>/<config_directory>
+  # 2. $HOME/.<application_name>/<config_directory>
+  # 2. $HOME/.<config_directory>
+  # 3. /etc/.<application_name>/<config_directory>
+  #
+  # Please keep in mind
+  #
+  # * 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)
+  #
+  # Most conventions defined by me are implemented as separate methods. If one convention
+  # is not suitable for your use case, just overwrite the method.
+  #
+  # If you prefer to use a different path to the config file or name of the
+  # config file one of the following methods needs to be overwritten:
+  #
+  # * config_directory
+  # * config_name
+  # * application_name
+  #
+  # If you want the class to look for your config file at a different place
+  # overwrite the following method
+  #
+  # * allowed_config_directory_paths
+  #
+  # Below you find some examples for the usage of the class:
+  #
+  # @example Create config with one writer and reader
+  #   module MyApplication
+  #     class ClientConfig < ConfigDirectory
+  #     end
+  #   end
+  class ConfigDirectory
+    # Create a new instance of config
+    #
+    # It tries to find a suitable configuration file. If it doesn't find one
+    # the config is empty and uses the defaults defined within a config class
+    #
+    # @param [String] file
+    #   Path where config file is stored. The file will be read by the
+    #   `config_engine`.
+    #
+    # @raise [Exceptions::ConfigFileNotReadable]
+    #   If an avaiable config file could not be read by the config engine
+    #
+    # @return [ConfigDirectory]
+    #   The config instance. If the resulting data structure created by the
+    #   config_engine does not respond to `:[]` an empty config object will be
+    #   created.
+
+    attr_reader :directory, :logger
+
+    def initialize(
+      logger: FeduxOrgStdlib::Logging::Logger.new,
+      directory: _available_config_directory
+    )
+      @logger    = logger
+      @directory = directory
+
+      unless directory
+        logger.debug "No configuration directory found at #{_allowed_config_directory_paths.to_list}, therefor I'm going to use an empty config object instead."
+      end
+    end
+
+    # Return the path to the preferred configuration file
+    # @return [String]
+    #   The path to the preferred configuration file
+    def preferred_configuration_directory
+      _allowed_config_directory_paths.first
+    end
+
+    private
+
+    # The base name of the config
+    #
+    # @return [String]
+    #   This one returns the base name of the config file (without the file
+    #   extension). It uses the class name of the config class
+    #
+    # @example Determine the base name of the config
+    #
+    #   class ClientConfig; 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?
+        return name
+      end
+
+      fail Exceptions::ClassNameIsMissing, JSON.dump(klass: _class_name)
+    end
+
+    # The name of your application
+    #
+    # @return [String]
+    #  This will strip of the class part of fully qualified class name and
+    #  converted it to a path.
+    #
+    # @example Determine application name
+    #
+    #   class MyApplication::MyConfig; end
+    #
+    # This will be converted to
+    #
+    #    my_application
+    def _application_name
+      _module_name.underscore
+    end
+
+    # The paths where to look for the config file
+    #
+    # @return [Array]
+    #   A list of paths where the config object should look for its config
+    #   file.
+    def _allowed_config_directory_paths
+      [
+        ::File.expand_path(::File.join('~', '.config', _application_name, _config_directory)),
+        ::File.expand_path(::File.join('~', format('.%s', _application_name), _config_directory)),
+        ::File.expand_path(::File.join('~', format('.%s', _config_directory))),
+        ::File.expand_path(::File.join('/etc', _application_name, _config_directory)),
+      ]
+    end
+
+    def _class_name
+      self.class.name.to_s.demodulize
+    end
+
+    def _module_name
+      self.class.to_s.deconstantize
+    end
+
+    def _available_config_directory
+      _allowed_config_directory_paths.find { |f| ::File.directory? f }
+    end
+  end
+end

data/lib/fedux_org_stdlib/config_file/exceptions.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module FeduxOrgStdlib
+  class ConfigFile
+    module Exceptions
+      # No allowed config file could be found
+      class NoConfigFileFound < StandardError; end
+
+      # If no module is given on class
+      class NamespaceIsMissing < StandardError; end
+
+      # If no class name is present
+      class ClassNameIsMissing < StandardError; end
+    end
+  end
+end

data/lib/fedux_org_stdlib/config_file.rb

@@ -0,0 +1,168 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/require_files'
+require 'fedux_org_stdlib/config_file/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)
+
+module FeduxOrgStdlib
+  # This class detects the file name for an config file. By default it will
+  # look for a suitable config file in the given order:
+  #
+  # 1. $HOME/.config/<application_name>/<config_file>.yaml
+  # 2. $HOME/.<application_name>/<config_file>.yaml
+  # 2. $HOME/.<config_file>.yaml
+  # 2. $HOME/.<config_file>rc
+  # 3. /etc/.<application_name>/<config_file>.yaml
+  #
+  # Please keep in mind
+  #
+  # * 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)
+  #
+  # Most conventions defined by me are implemented as separate methods. If one convention
+  # is not suitable for your use case, just overwrite the method.
+  #
+  # If you prefer to use a different path to the config file or name of the
+  # config file one of the following methods needs to be overwritten:
+  #
+  # * config_file
+  # * config_name
+  # * application_name
+  #
+  # If you want the class to look for your config file at a different place
+  # overwrite the following method
+  #
+  # * allowed_config_file_paths
+  #
+  # Below you find some examples for the usage of the class:
+  #
+  # @example Create config with one writer and reader
+  #   module MyApplication
+  #     class ClientConfig < ConfigFile
+  #     end
+  #   end
+  class ConfigFile
+    # Create a new instance of config
+    #
+    # It tries to find a suitable configuration file. If it doesn't find one
+    # the config is empty and uses the defaults defined within a config class
+    #
+    # @param [String] file
+    #   Path where config file is stored. The file will be read by the
+    #   `config_engine`.
+    #
+    # @raise [Exceptions::ConfigFileNotReadable]
+    #   If an avaiable config file could not be read by the config engine
+    #
+    # @return [ConfigFile]
+    #   The config instance. If the resulting data structure created by the
+    #   config_engine does not respond to `:[]` an empty config object will be
+    #   created.
+
+    attr_reader :file, :logger
+
+    def initialize(
+      logger: FeduxOrgStdlib::Logging::Logger.new,
+      file: _available_config_file
+    )
+      @logger             = logger
+      @file               = file
+
+      unless file
+        logger.debug "No configuration file found at #{_allowed_config_file_paths.to_list}, therefor I'm going to use an empty config object instead."
+      end
+    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
+    #
+    # @return [String]
+    #   The name of the config file. It defaults to `<config_name>.yaml`. If
+    #   you want to use a different file name you need to overwrite this
+    #   method.
+    def _config_file
+      "#{_config_name}#{_config_file_suffix}"
+    end
+
+    # The suffix of the config file
+    #
+    # @return [String]
+    #   The suffix of the config file
+    def _config_file_suffix
+      '.yaml'
+    end
+
+    # The base name of the config
+    #
+    # @return [String]
+    #   This one returns the base name of the config file (without the file
+    #   extension). It uses the class name of the config class
+    #
+    # @example Determine the base name of the config
+    #
+    #   class ClientConfig; 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?
+        return name
+      end
+
+      fail Exceptions::ClassNameIsMissing, JSON.dump(klass: _class_name)
+    end
+
+    # The name of your application
+    #
+    # @return [String]
+    #  This will strip of the class part of fully qualified class name and
+    #  converted it to a path.
+    #
+    # @example Determine application name
+    #
+    #   class MyApplication::MyConfig; end
+    #
+    # This will be converted to
+    #
+    #    my_application
+    def _application_name
+      _module_name.underscore
+    end
+
+    # The paths where to look for the config file
+    #
+    # @return [Array]
+    #   A list of paths where the config object should look for its config
+    #   file.
+    def _allowed_config_file_paths
+      [
+        ::File.expand_path(::File.join('~', '.config', _application_name, _config_file)),
+        ::File.expand_path(::File.join('~', format('.%s', _application_name), _config_file)),
+        ::File.expand_path(::File.join('~', format('.%s', _config_file))),
+        ::File.expand_path(::File.join('~', format('.%src', _config_name))),
+        ::File.expand_path(::File.join('/etc', _application_name, _config_file)),
+      ]
+    end
+
+    def _class_name
+      self.class.name.to_s.demodulize
+    end
+
+    def _module_name
+      self.class.to_s.deconstantize
+    end
+
+    def _available_config_file
+      _allowed_config_file_paths.find { |f| ::File.exist? f }
+    end
+  end
+end

data/lib/fedux_org_stdlib/version.rb

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

data/spec/config_directory_spec.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'fedux_org_stdlib/config_directory'
+
+RSpec.describe ConfigDirectory 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(ConfigDirectory) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.preferred_configuration_directory).to eq File.expand_path('~/.config/my_application/tests')
+      end
+    end
+
+    it 'works with nested module names' do
+      with_env 'HOME' => absolute_path('.') do
+        config_klass = Class.new(ConfigDirectory) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication::MySub'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.preferred_configuration_directory).to eq File.expand_path('~/.config/my_application/my_sub/tests')
+      end
+    end
+  end
+
+  context 'config files' do
+    it 'looks at ~/.test.yaml' do
+      with_env 'HOME' => absolute_path('.') do
+        create_dir '.tests'
+
+        config_klass = Class.new(ConfigDirectory) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.directory).to eq absolute_path('.tests')
+      end
+    end
+
+    it 'looks at ~/.config/my_application/tests.yaml' do
+      with_env 'HOME' => absolute_path('.') do
+        create_dir '.config/my_application/tests'
+
+        config_klass = Class.new(ConfigDirectory) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.directory).to eq absolute_path('.config/my_application/tests')
+      end
+    end
+
+    it 'looks at ~/.my_application/tests.yaml' do
+      with_env 'HOME' => absolute_path('.') do
+        create_dir '.my_application/tests'
+
+        config_klass = Class.new(ConfigDirectory) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.directory).to eq absolute_path('.my_application/tests')
+      end
+    end
+
+    it 'looks at ~/.tests' do
+      with_env 'HOME' => absolute_path('.') do
+        create_dir '.tests'
+
+        config_klass = Class.new(ConfigDirectory) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.directory).to eq absolute_path('.tests')
+      end
+    end
+  end
+end

data/spec/config_file_spec.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'fedux_org_stdlib/config_file'
+
+RSpec.describe ConfigFile 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
+
+          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_env 'HOME' => absolute_path('.') do
+        config_klass = Class.new(ConfigFile) 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_env 'HOME' => absolute_path('.') do
+        touch_file '.tests.yaml'
+
+        config_klass = Class.new(ConfigFile) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.file).to eq absolute_path('.tests.yaml')
+      end
+    end
+
+    it 'looks at ~/.config/my_application/tests.yaml' do
+      with_env 'HOME' => absolute_path('.') do
+        touch_file '.config/my_application/tests.yaml'
+
+        config_klass = Class.new(ConfigFile) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.file).to eq absolute_path('.config/my_application/tests.yaml')
+      end
+    end
+
+    it 'looks at ~/.my_application/tests.yaml' do
+      with_env 'HOME' => absolute_path('.') do
+        touch_file '.my_application/tests.yaml'
+
+        config_klass = Class.new(ConfigFile) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.file).to eq absolute_path('.my_application/tests.yaml')
+      end
+    end
+
+    it 'looks at ~/.testsrc' do
+      with_env 'HOME' => absolute_path('.') do
+        touch_file '.testsrc'
+
+        config_klass = Class.new(ConfigFile) do
+
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.file).to eq absolute_path('.testsrc')
+      end
+    end
+  end
+end

data/spec/gem_plugins/plugin_manager_spec.rb

@@ -15,16 +15,11 @@ RSpec.describe GemPlugins::PluginManager do
   end
 
   context '#activate_plugin' do
-    it 'loads available plugins by its name' do
-      FeduxOrgStdlib::Fixtures::PluginManager::Load::PluginManager.new
-
-      expect('FeduxOrgStdlib::Fixtures::PluginManager::Plugin::Load').not_to be_defined
-    end
-
     it 'loads available plugins only on request' do
       manager = FeduxOrgStdlib::Fixtures::PluginManager::Load::PluginManager.new
-      manager.activate_plugin 'fedux_org_stdlib-fixtures-plugin_manager-load'
+      expect('FeduxOrgStdlib::Fixtures::PluginManager::Plugin::Load').not_to be_defined
 
+      manager.activate_plugin 'fedux_org_stdlib-fixtures-plugin_manager-load'
       expect('FeduxOrgStdlib::Fixtures::PluginManager::Plugin::Load').to be_defined
     end
   end
@@ -39,12 +34,12 @@ RSpec.describe GemPlugins::PluginManager do
     expect(result).to include 'plugin-blub'
   end
 
-  context '#to_s' do
-    it 'has a string representation' do
-      manager = FeduxOrgStdlib::Fixtures::PluginManager::Load::PluginManager.new
-      manager.activate_plugin 'fedux_org_stdlib-fixtures-plugin_manager-load'
+  #context '#to_s' do
+  #  it 'has a string representation' do
+  #    manager = FeduxOrgStdlib::Fixtures::PluginManager::Load::PluginManager.new
+  #    manager.activate_plugin 'fedux_org_stdlib-fixtures-plugin_manager-load'
 
-      expect(manager.to_s).to include '1 row in set'
-    end
-  end
+  #    expect(manager.to_s).to include '1 row in set'
+  #  end
+  #end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.7.33
+  version: 0.8.0
 platform: ruby
 authors:
 - Max Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -62,6 +62,10 @@ 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
@@ -166,6 +170,8 @@ 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
@@ -245,6 +251,8 @@ 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