fedux_org-stdlib 0.6.7 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3f80fa1083cd772f019321591b3d271f2d01b2b
-  data.tar.gz: 2974ed01ed39c5d2813c08e709a1ff45718654f4
+  metadata.gz: d9e703de0319a8f92f9c1e72fc69158c014aa21f
+  data.tar.gz: a34707ffed29a092d49b31855d885ead61c8a3b9
 SHA512:
-  metadata.gz: fa6da85ec9aa70cb9d4ebf189d88afdf95437ebb663a672547e3764cf0a1c9d62c6119f55b105476dd7660e2686a0a8e243734b281c83aded4bb894e77ceae78
-  data.tar.gz: cba56858043efd2bd845aa5554c74e375badb0a7ad6e48ed0172814894574486a1ac98c4a18e9feb141c14ecd49482d1e9cf2a1cc60da587f7e330a1dd86dc6a
+  metadata.gz: 6c571e1a5eb285d3645b1678955a07029c52d80ad108c510d4ba12f8d77e67d9cad7c83beae9779a9c1bc3acf6e420f9e6220d242bca9c6ff42325b7c17aaef0
+  data.tar.gz: 68d5bf20b8b276d4eb31e5aa4ae02cdd4fe27cd29adc72aa131dd60c21df397be728abf16f565766ddb34850ade47c75b8179b7b00c67fd5faaa429fda15e707

data/lib/fedux_org_stdlib/app_config/exceptions.rb

@@ -16,6 +16,9 @@ module FeduxOrgStdlib
 
       # If no class name is present
       class ClassNameIsMissing < StandardError; end
+
+      # If one tries to define an option name which is forbbiden
+      class OptionNameForbidden < StandardError; end
     end
   end
 end

data/lib/fedux_org_stdlib/app_config.rb

@@ -70,12 +70,12 @@ module FeduxOrgStdlib
     class << self
       
       # @api private
-      def options
+      def _options
         @options ||= Set.new
       end
 
       # @api private
-      def process_environment
+      def _process_environment
         @process_environment ||= ProcessEnvironment.new
       end
 
@@ -87,11 +87,15 @@ module FeduxOrgStdlib
       # @param [Object] default_value
       #   The default value of this option
       def option_reader(option, default_value)
-        define_method option.to_sym do
-          instance_variable_get(:'@config').fetch(option.to_sym, default_value)
+        option =  option.to_sym
+
+        fail Exceptions::OptionNameForbidden, JSON.dump(option: option) if _reserved_key_words.include? option
+
+        define_method option do
+          _config.fetch(option, default_value)
         end
 
-        self.options << option
+        self._options << option
       end
 
       # Define a writer for option
@@ -108,15 +112,17 @@ module FeduxOrgStdlib
       # @raise [Exceptions::ConfigLocked]
       #   If one tries to modified a locked config
       def option_writer(option)
+        fail Exceptions::OptionNameForbidden, JSON.dump(option: option) if _reserved_key_words.include? "#{option}=".to_sym
+
         define_method "#{option}=".to_sym do |value|
           begin
-            instance_variable_get(:'@config')[option.to_sym] = value
+            _config[option.to_sym] = value
           rescue RuntimeError
             raise Exceptions::ConfigLocked
           end
         end
 
-        self.options << option
+        self._options << option
       end
 
       # Define a writer and a reader for option
@@ -136,7 +142,7 @@ module FeduxOrgStdlib
 
     # @!attribute [r] config
     #   Holds the config
-    attr_reader :config
+    attr_reader :_config
 
     public
 
@@ -163,15 +169,15 @@ module FeduxOrgStdlib
     #   config_engine does not respond to `:[]` an empty config object will be
     #   created. 
     def initialize(
-      file: available_config_file, 
+      file: _available_config_file, 
       config_engine: Psych,
       logger: FeduxOrgStdlib::Logging::Logger.new
     )
       @logger = logger
 
       unless file
-        logger.debug "No configuration file found at #{allowed_config_file_paths.to_list}, using an empty config." 
-        @config = HashWithIndifferentAccess.new
+        logger.debug "No configuration file found at #{_allowed_config_file_paths.to_list}, using an empty config." 
+        @_config = HashWithIndifferentAccess.new
 
         return 
       end
@@ -183,15 +189,15 @@ module FeduxOrgStdlib
       end
 
       if yaml.respond_to? :[]
-        @config = HashWithIndifferentAccess.new(yaml.symbolize_keys)
+        @_config = HashWithIndifferentAccess.new(yaml.symbolize_keys)
       else
-        @config = HashWithIndifferentAccess.new
+        @_config = HashWithIndifferentAccess.new
       end
     end
 
     # Lock the configuration
     def lock
-      config.freeze
+      _config.freeze
     end
 
     # Output a string presentation of the configuration
@@ -203,7 +209,7 @@ module FeduxOrgStdlib
       result << sprintf("%20s | %s", 'option', 'value')
       result << sprintf("%s + %s", '-' * 20, '-' * 80)
 
-      self.class.options.each do |o|
+      self.class._options.each do |o|
         result << sprintf("%20s | %s", o, Array(public_send(o)).join(', '))
       end
 
@@ -218,15 +224,15 @@ module FeduxOrgStdlib
     #   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}"
+    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
+    def _config_file_suffix
       '.yaml'
     end
 
@@ -241,12 +247,12 @@ module FeduxOrgStdlib
     #   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?
+    def _config_name
+      unless (name = _class_name.sub(/Config/, '').underscore.pluralize).blank?
         return name
       end
       
-      fail Exceptions::ClassNameIsMissing, JSON.dump(klass: class_name)
+      fail Exceptions::ClassNameIsMissing, JSON.dump(klass: _class_name)
     end
 
     # The name of your application
@@ -262,8 +268,8 @@ module FeduxOrgStdlib
     # This will be converted to
     #
     #    my_application
-    def application_name
-      module_name.underscore
+    def _application_name
+      _module_name.underscore
     end
 
     # The paths where to look for the config file
@@ -271,27 +277,31 @@ module FeduxOrgStdlib
     # @return [Array]
     #   A list of paths where the config object should look for its config
     #   file.
-    def allowed_config_file_paths
+    def _allowed_config_file_paths
       [
-        ::File.expand_path(::File.join(self.class.process_environment.fetch('HOME'), '.config', application_name, config_file)),
-        ::File.expand_path(::File.join(self.class.process_environment.fetch('HOME'), format('.%s', application_name), config_file)),
-        ::File.expand_path(::File.join(self.class.process_environment.fetch('HOME'), format('.%s', config_file))),
-        ::File.expand_path(::File.join(self.class.process_environment.fetch('HOME'), format('.%src', config_name))),
-        ::File.expand_path(::File.join('/etc', application_name, config_file)),
+        ::File.expand_path(::File.join(self.class._process_environment.fetch('HOME'), '.config', _application_name, _config_file)),
+        ::File.expand_path(::File.join(self.class._process_environment.fetch('HOME'), format('.%s', _application_name), _config_file)),
+        ::File.expand_path(::File.join(self.class._process_environment.fetch('HOME'), format('.%s', _config_file))),
+        ::File.expand_path(::File.join(self.class._process_environment.fetch('HOME'), format('.%src', _config_name))),
+        ::File.expand_path(::File.join('/etc', _application_name, _config_file)),
         #          ::File.expand_path("../../../../files/#{config_file}", __FILE__),
       ]
     end
 
-    def class_name
+    def _class_name
       self.class.name.to_s.demodulize
     end
 
-    def module_name
+    def _module_name
       self.class.to_s.deconstantize
     end
 
-    def available_config_file
-      allowed_config_file_paths.find { |f| ::File.exists? f }
+    def _available_config_file
+      _allowed_config_file_paths.find { |f| ::File.exists? f }
+    end
+
+    def self._reserved_key_words
+      (methods | instance_methods | private_methods | private_instance_methods ) - (Class.methods | Class.private_methods ) | [:to_s]
     end
   end
 end

data/lib/fedux_org_stdlib/version.rb

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

data/spec/app_config_spec.rb

@@ -10,11 +10,11 @@ RSpec.describe AppConfig do
         config_klass = Class.new(AppConfig) do
           option :opt1, nil
 
-          def class_name
+          def _class_name
             'TestConfig'
           end
 
-          def module_name
+          def _module_name
             'MyApplication'
           end
         end
@@ -32,11 +32,11 @@ RSpec.describe AppConfig do
         config_klass = Class.new(AppConfig) do
           option_reader :opt1, nil
 
-          def class_name
+          def _class_name
             'TestConfig'
           end
 
-          def module_name
+          def _module_name
             'MyApplication'
           end
         end
@@ -50,6 +50,24 @@ RSpec.describe AppConfig do
       end
     end
 
+    it 'checks for reserved key words' do
+      with_environment 'HOME' => working_directory do
+        expect do
+          Class.new(AppConfig) do
+            option_reader :_config_file, nil
+
+            def _class_name
+              'TestConfig'
+            end
+
+            def _module_name
+              'MyApplication'
+            end
+          end
+        end.to raise_error FeduxOrgStdlib::AppConfig::Exceptions::OptionNameForbidden
+      end
+    end
+
   end
 
   context 'config files' do
@@ -63,11 +81,11 @@ RSpec.describe AppConfig do
         config_klass = Class.new(AppConfig) do
           option_reader :opt1, nil
 
-          def class_name
+          def _class_name
             'TestConfig'
           end
 
-          def module_name
+          def _module_name
             'MyApplication'
           end
         end
@@ -87,11 +105,11 @@ RSpec.describe AppConfig do
         config_klass = Class.new(AppConfig) do
           option_reader :opt1, nil
 
-          def class_name
+          def _class_name
             'TestConfig'
           end
 
-          def module_name
+          def _module_name
             'MyApplication'
           end
         end
@@ -111,11 +129,11 @@ RSpec.describe AppConfig do
       config_klass = Class.new(AppConfig) do
         option_reader :opt1, nil
 
-        def class_name
+        def _class_name
           'TestConfig'
         end
 
-        def module_name
+        def _module_name
           'MyApplication'
         end
       end
@@ -135,11 +153,11 @@ RSpec.describe AppConfig do
       config_klass = Class.new(AppConfig) do
         option_reader :opt1, nil
 
-        def class_name
+        def _class_name
           'TestConfig'
         end
 
-        def module_name
+        def _module_name
           'MyApplication'
         end
       end
@@ -159,11 +177,11 @@ RSpec.describe AppConfig do
       config_klass = Class.new(AppConfig) do
         option_reader :opt1, nil
 
-        def class_name
+        def _class_name
           'TestConfig'
         end
 
-        def module_name
+        def _module_name
           'MyApplication'
         end
       end
@@ -180,11 +198,11 @@ RSpec.describe AppConfig do
           option :opt1, 'test1'
           option :opt2, 'test2'
 
-          def class_name
+          def _class_name
             'TestConfig'
           end
 
-          def module_name
+          def _module_name
             'MyApplication'
           end
         end

metadata

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