fedux_org-stdlib 0.6.11 → 0.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa0d7a7ab30a474b38ae886c1762c787216540ba
-  data.tar.gz: a28c29b1299b5f4e2b9db259381b785bcc9a32c3
+  metadata.gz: 1b6d4b263098c38be3d3499fdd03734a2c1efbd8
+  data.tar.gz: c7a34b1c7f3b72378eea3c10bdfe9b6d76723cfd
 SHA512:
-  metadata.gz: 1085c790d1c8453489989abdd8cc7914e7431b98a015ee0d16bcffabea8f805d7c4bf9d60ca17d0e66b9b6481ed095c1e18a8f755ce2cae11f48bd0695f69e43
-  data.tar.gz: 3ddb778fa2e54966f92c9c87cb60b99e3edf4a1ed300f3f9019bb7104853ea8d769779cce3ed0fdbd8c98f8259bdf03073bbcdb296adbdc73ff1e87adb1b3898
+  metadata.gz: cb1230859eae20347dfd17ef155d45026b8271a6dc9ebc9e2d6515e4e5ab188e916b2ff2190e382fe7f502a6ab777b2bccf1b41408ea0cc459659be7d6f89bc8
+  data.tar.gz: 80459da9eb8de1d77e37ef78cad19d8f0aa2ace3e405b827ee342fa4f2b136e51291712ae46112ef60663aef5c09b2e4cc6325630d762fa4f51efc1772107fee

data/lib/fedux_org_stdlib/app_config.rb

@@ -4,7 +4,7 @@ require 'fedux_org_stdlib/app_config/exceptions'
 require 'fedux_org_stdlib/process_environment'
 require 'fedux_org_stdlib/core_ext/array'
 require 'fedux_org_stdlib/logging/logger'
-require_library %w{ json psych active_support/core_ext/string/inflections thread set active_support/hash_with_indifferent_access }
+require_library %w{ json psych active_support/core_ext/string/inflections set active_support/core_ext/hash/slice }
 
 module FeduxOrgStdlib
   # This class makes a config file available as an object. The config file
@@ -71,7 +71,7 @@ module FeduxOrgStdlib
     class << self
       
       # @api private
-      def _options
+      def _known_options
         @options ||= Set.new
       end
 
@@ -103,7 +103,7 @@ module FeduxOrgStdlib
           _config.fetch(option, default_value)
         end
 
-        self._options << option
+        self._known_options << option
       end
 
       # Define a writer for option
@@ -130,7 +130,7 @@ module FeduxOrgStdlib
           end
         end
 
-        self._options << option
+        self._known_options << option
       end
 
       # Define a writer and a reader for option
@@ -148,9 +148,10 @@ module FeduxOrgStdlib
 
     private
 
-    # @!attribute [r] config
-    #   Holds the config
-    attr_reader :_config
+    # Holds the config
+    def _config
+      @__config
+    end
 
     public
 
@@ -166,6 +167,10 @@ module FeduxOrgStdlib
     # @param [Object] config_engine (Psych)
     #   The engine to read config file
     #
+    # @param [true, false] check_unknown_options
+    #   Should a warning be put to stdout if there are unknown options in yaml
+    #   config file
+    #
     # @raise [Exceptions::ConfigFileNotReadable]
     #   If an avaiable config file could not be read by the config engine
     #
@@ -176,27 +181,36 @@ module FeduxOrgStdlib
     def initialize(
       file: _available_config_file, 
       config_engine: Psych,
-      logger: FeduxOrgStdlib::Logging::Logger.new
+      logger: FeduxOrgStdlib::Logging::Logger.new,
+      check_unknown_options: true
     )
       @logger = logger
 
       unless file
         logger.debug "No configuration file found at #{_allowed_config_file_paths.to_list}, using an empty config." 
-        @_config = HashWithIndifferentAccess.new
+        @__config = {}
 
         return 
       end
 
       begin
-        yaml = Psych.safe_load(File.read(file))
+        yaml = Psych.safe_load(File.read(file), [Symbol])
       rescue StandardError => e
         fail Exceptions::ConfigFileNotReadable, JSON.dump(message: e.message, file: file)
       end
 
-      if yaml.respond_to? :[]
-        @_config = HashWithIndifferentAccess.new(yaml.symbolize_keys)
+      if yaml.respond_to? :[] and !yaml.kind_of? Array
+        yaml = yaml.deep_symbolize_keys
+
+        yaml_with_known_options = yaml.deep_symbolize_keys.slice(*self.class._known_options)
+        unknown_options = yaml.keys - yaml_with_known_options.keys
+
+        logger.warn "Unknown config options #{(unknown_options).to_list} in config file #{file} detected. Please define them in your config class or remove the entries in your config file or disable check via `check_unknown_options: false` to get rid of this warning." unless unknown_options.blank? && check_unknown_options == true
+
+        @__config = Hash(yaml_with_known_options)
       else
-        @_config = HashWithIndifferentAccess.new
+        logger.warn "There seems to be a problem transforming config file \"#{file}\" to a hash using an empty config."
+        @__config = {}
       end
     end
 
@@ -214,7 +228,7 @@ module FeduxOrgStdlib
       result << sprintf("%20s | %s", 'option', 'value')
       result << sprintf("%s + %s", '-' * 20, '-' * 80)
 
-      self.class._options.each do |o|
+      self.class._known_options.each do |o|
         result << sprintf("%20s | %s", o, Array(public_send(o)).join(', '))
       end
 

data/lib/fedux_org_stdlib/version.rb

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

data/spec/app_config_spec.rb

@@ -67,7 +67,28 @@ RSpec.describe AppConfig do
         end.to raise_error FeduxOrgStdlib::AppConfig::Exceptions::OptionNameForbidden
       end
     end
+  end
+
+  context '#lock' do
+    it 'raises error if config is locked and one tries to modify a config option' do
+      with_environment 'HOME' => working_directory do
+        config_klass = Class.new(AppConfig) do
+          option :opt1, nil
 
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        config.lock
+        expect { config.opt1 = 1 }.to raise_error FeduxOrgStdlib::AppConfig::Exceptions::ConfigLocked
+      end
+    end
   end
 
   context 'config files' do
@@ -118,76 +139,160 @@ RSpec.describe AppConfig do
         expect(config.opt1).to eq 'hello world'
       end
     end
-  end
-  it 'looks at ~/.my_application/tests.yaml' do
-    with_environment 'HOME' => working_directory do
-      create_file '.my_application/tests.yaml', <<-EOS.strip_heredoc
+
+    it 'looks at ~/.my_application/tests.yaml' do
+      with_environment 'HOME' => working_directory do
+        create_file '.my_application/tests.yaml', <<-EOS.strip_heredoc
         ---
         opt1: hello world
-      EOS
+        EOS
 
-      config_klass = Class.new(AppConfig) do
-        option_reader :opt1, nil
+        config_klass = Class.new(AppConfig) do
+          option_reader :opt1, nil
 
-        def _class_name
-          'TestConfig'
-        end
+          def _class_name
+            'TestConfig'
+          end
 
-        def _module_name
-          'MyApplication'
+          def _module_name
+            'MyApplication'
+          end
         end
-      end
 
-      config = config_klass.new
-      expect(config.opt1).to eq 'hello world'
+        config = config_klass.new
+        expect(config.opt1).to eq 'hello world'
+      end
     end
-  end
 
-  it 'looks at ~/.tests.yaml' do
-    with_environment 'HOME' => working_directory do
-      create_file '.tests.yaml', <<-EOS.strip_heredoc
+    it 'looks at ~/.tests.yaml' do
+      with_environment 'HOME' => working_directory do
+        create_file '.tests.yaml', <<-EOS.strip_heredoc
         ---
         opt1: hello world
-      EOS
+        EOS
 
-      config_klass = Class.new(AppConfig) do
-        option_reader :opt1, nil
+        config_klass = Class.new(AppConfig) do
+          option_reader :opt1, nil
 
-        def _class_name
-          'TestConfig'
-        end
+          def _class_name
+            'TestConfig'
+          end
 
-        def _module_name
-          'MyApplication'
+          def _module_name
+            'MyApplication'
+          end
         end
+
+        config = config_klass.new
+        expect(config.opt1).to eq 'hello world'
       end
+    end
+
+    it 'looks at ~/.testsrc' do
+      with_environment 'HOME' => working_directory do
+        create_file '.testsrc', <<-EOS.strip_heredoc
+        ---
+        opt1: hello world
+        EOS
+
+        config_klass = Class.new(AppConfig) do
+          option_reader :opt1, nil
 
-      config = config_klass.new
-      expect(config.opt1).to eq 'hello world'
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        config = config_klass.new
+        expect(config.opt1).to eq 'hello world'
+      end
     end
-  end
 
-  it 'looks at ~/.testsrc' do
-    with_environment 'HOME' => working_directory do
-      create_file '.testsrc', <<-EOS.strip_heredoc
+    it 'loads yaml files with the following data types' do
+      with_environment 'HOME' => working_directory do
+        create_file '.testsrc', <<-EOS.strip_heredoc
         ---
         opt1: hello world
-      EOS
+        opt2: :test
+        opt3: 1
+        opt4: true
+        opt5: false
+        opt6:
+          - a
+          - b
+        opt7:
+          name: berni
+        EOS
 
-      config_klass = Class.new(AppConfig) do
-        option_reader :opt1, nil
+        config_klass = Class.new(AppConfig) do
+          option_reader :opt1, nil
+          option_reader :opt2, nil
+          option_reader :opt3, nil
+          option_reader :opt4, nil
+          option_reader :opt5, nil
+          option_reader :opt6, nil
+          option_reader :opt7, nil
 
-        def _class_name
-          'TestConfig'
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
         end
 
-        def _module_name
-          'MyApplication'
+        config = config_klass.new
+        expect(config.opt1).to eq 'hello world'
+      end
+    end
+
+    it 'raises error on invalid yaml file' do
+      with_environment 'HOME' => working_directory do
+        create_file '.testsrc', random_binary_string(100)
+
+        config_klass = Class.new(AppConfig) do
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
         end
+
+        expect { config_klass.new }.to raise_error FeduxOrgStdlib::AppConfig::Exceptions::ConfigFileNotReadable
       end
+    end
 
-      config = config_klass.new
-      expect(config.opt1).to eq 'hello world'
+    it 'returns an empty config if data file cannot be transformed to hash' do
+      with_environment 'HOME' => working_directory do
+        create_file '.testsrc', <<-EOS.strip_heredoc
+        ---
+        - hello
+        - world
+        EOS
+
+        config_klass = Class.new(AppConfig) do
+          def _class_name
+            'TestConfig'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        result = capture :stderr do
+          config_klass.new 
+        end
+
+        expect(result).to include "There seems"
+      end
     end
   end
 

data/spec/support/generator.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module FeduxOrgStdlib
+  module SpecHelper
+    module Generators
+      def random_binary_string(length)
+        Random.new.bytes(length)
+      end
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include FeduxOrgStdlib::SpecHelper::Generators
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.6.11
+  version: 0.6.12
 platform: ruby
 authors:
 - Max Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -159,6 +159,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/environment.rb
 - spec/support/filesystem.rb
+- spec/support/generator.rb
 - spec/support/reporting.rb
 - spec/support/rspec.rb
 - spec/support/string.rb
@@ -224,6 +225,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/environment.rb
 - spec/support/filesystem.rb
+- spec/support/generator.rb
 - spec/support/reporting.rb
 - spec/support/rspec.rb
 - spec/support/string.rb