complex_config 0.16.0 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 114e86c26b5932221df1aa2ae61c248697a40162db12aac16673f2a204597a08
-  data.tar.gz: cc4847658eff087770fa628015f2edb8e27f61fce248ba82e5087671ceb1cdd8
+  metadata.gz: 8a0d455caf5fdc57de73eafd6308920b5f0b1e5b0bf99b67e289fa4df83b54d6
+  data.tar.gz: 41948d2b4b6dfcddbcec801639b19a2c855b9c81d573281f098ccb954b9e5606
 SHA512:
-  metadata.gz: aa4c8feae89efd54ad866f0ad98d68479b383a9fbce025de01f0db160a95210a7e894973ca5bd29a1491a146a7d611e1caa3398255203ac8fc8c0678e41a3608
-  data.tar.gz: 047cd0f7ca2c59daaa8fd3ea03e978e8c2c06dcd14dd447762a4cad771b190533563d3dbf3e74d67682cada3c2ce0b17beb4abbceab8ff4267e2a03c67931b28
+  metadata.gz: 9ec0abc072a32b190f3982254f45a1475a28442d78ac03e80c111a589027bc34b3095f51187b264e17cc74147e1137680494d9c51e7b02b71b9c0ce86e41e6b6
+  data.tar.gz: be4f16643cb26822aa77d6e68fb82a125fa3b559d0eff6abdb0f0d34fdbe3b48778939392c68cc3747de7e4bf8b0f5b96888d1519414bcb4a64b80ef4f1db516

data/.gitignore

@@ -7,3 +7,4 @@ Gemfile.lock
 coverage
 errors.lst
 pkg
+tags

data/.travis.yml

@@ -1,11 +1,11 @@
 rvm:
-  - 2.0
   - 2.1
   - 2.2
   - 2.3
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
   - ruby-head
   - jruby-head
 sudo: false

data/README.md

@@ -144,6 +144,8 @@ Here is the `ComplexConfig::Plugins::MONEY` plugin for example:
 
 ## Changes
 
+* 2019-03-18 Release 0.17.0
+  * Improve error message for missing encryption key
 * 2019-03-14 Release 0.16.0
   * Enable `- trim_mode` for ERB in yml files
   * Allow `to_json` calls on settings

data/Rakefile

@@ -12,7 +12,7 @@ GemHadar do
   executables 'complex_config'
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc',
-    '.AppleDouble', '.DS_Store', '.byebug_history', 'errors.lst'
+    '.AppleDouble', '.DS_Store', '.byebug_history', 'errors.lst', 'tags'
 
   readme      'README.md'
   title       "#{name.camelize} -- configuration library"

data/VERSION

@@ -1 +1 @@
-0.16.0
+0.18.2

data/complex_config.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: complex_config 0.16.0 ruby lib
+# stub: complex_config 0.18.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "complex_config".freeze
-  s.version = "0.16.0"
+  s.version = "0.18.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2019-03-14"
+  s.date = "2020-08-26"
   s.description = "This library allows you to access configuration files via a simple interface".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["complex_config".freeze]
@@ -17,34 +17,25 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/flori/complex_config".freeze
   s.licenses = ["Apache-2.0".freeze]
   s.rdoc_options = ["--title".freeze, "ComplexConfig -- configuration library".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "3.0.3".freeze
+  s.rubygems_version = "3.1.2".freeze
   s.summary = "configuration library".freeze
   s.test_files = ["spec/complex_config/config_spec.rb".freeze, "spec/complex_config/encryption_spec.rb".freeze, "spec/complex_config/key_source_spec.rb".freeze, "spec/complex_config/plugins_spec.rb".freeze, "spec/complex_config/provider_spec.rb".freeze, "spec/complex_config/settings_spec.rb".freeze, "spec/complex_config/shortcuts_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
-      s.add_development_dependency(%q<rake>.freeze, [">= 0"])
-      s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
-      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_development_dependency(%q<monetize>.freeze, [">= 0"])
-      s.add_runtime_dependency(%q<json>.freeze, [">= 0"])
-      s.add_runtime_dependency(%q<tins>.freeze, [">= 0"])
-      s.add_runtime_dependency(%q<mize>.freeze, ["~> 0.3", ">= 0.3.4"])
-    else
-      s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
-      s.add_dependency(%q<rake>.freeze, [">= 0"])
-      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
-      s.add_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_dependency(%q<monetize>.freeze, [">= 0"])
-      s.add_dependency(%q<json>.freeze, [">= 0"])
-      s.add_dependency(%q<tins>.freeze, [">= 0"])
-      s.add_dependency(%q<mize>.freeze, ["~> 0.3", ">= 0.3.4"])
-    end
+  if s.respond_to? :add_runtime_dependency then
+    s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.11.0"])
+    s.add_development_dependency(%q<rake>.freeze, [">= 0"])
+    s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_development_dependency(%q<monetize>.freeze, [">= 0"])
+    s.add_runtime_dependency(%q<json>.freeze, [">= 0"])
+    s.add_runtime_dependency(%q<tins>.freeze, [">= 0"])
+    s.add_runtime_dependency(%q<mize>.freeze, ["~> 0.3", ">= 0.3.4"])
   else
-    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
+    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.11.0"])
     s.add_dependency(%q<rake>.freeze, [">= 0"])
     s.add_dependency(%q<simplecov>.freeze, [">= 0"])
     s.add_dependency(%q<rspec>.freeze, [">= 0"])

data/lib/complex_config/errors.rb

@@ -23,6 +23,9 @@ module ComplexConfig
   class EncryptionKeyInvalid < EncryptionError
   end
 
+  class EncryptionKeyMissing < EncryptionError
+  end
+
   class DecryptionFailed < EncryptionError
   end
 end

data/lib/complex_config/plugins/uri.rb

@@ -2,7 +2,7 @@ require 'uri'
 
 module ComplexConfig::Plugins
   URI = -> id do
-    url = id.to_s
+    url = id.to_s.dup
     if url.sub!(/uri\z/, 'url') and url = ask_and_send(url)
       ::URI.parse(url)
     else

data/lib/complex_config/provider.rb

@@ -65,7 +65,7 @@ class ComplexConfig::Provider
   end
 
   def config_dir
-    @config_dir || (defined?(Rails) && Rails.root || Pathname.pwd) + 'config'
+    @config_dir || (defined?(Rails) && Rails.respond_to?(:root) && Rails.root || Pathname.pwd) + 'config'
   end
 
   def pathname(name)
@@ -73,12 +73,7 @@ class ComplexConfig::Provider
   end
 
   def decrypt_config(pathname)
-    enc_pathname = pathname.to_s + '.enc'
-    my_ks        = key_source(pathname)
-    if File.exist?(enc_pathname) && my_ks.ask_and_send(:key)
-      text = IO.binread(enc_pathname)
-      ComplexConfig::Encryption.new(my_ks.key_bytes).decrypt(text)
-    end
+    decrypt_config_case(pathname).first
   end
 
   def encrypt_config(pathname, config)
@@ -88,14 +83,21 @@ class ComplexConfig::Provider
 
   def config(pathname, name = nil)
     datas = []
-    if File.exist?(pathname)
+    path_exist = File.exist?(pathname)
+    if path_exist
       datas << IO.binread(pathname)
     end
-    if decrypted = decrypt_config(pathname)
+    decrypted, reason, enc_pathname = decrypt_config_case(pathname)
+    case reason
+    when :ok
       datas << decrypted
+    when :key_missing
+      datas.empty? and raise ComplexConfig::EncryptionKeyMissing,
+        "encryption key for #{enc_pathname.to_s.inspect} is missing"
+    when :file_missing
+      datas.empty? and raise ComplexConfig::ConfigurationFileMissing,
+        "configuration file #{pathname.to_s.inspect} is missing"
     end
-    datas.empty? and raise ComplexConfig::ConfigurationFileMissing,
-      "configuration file #{pathname.to_s.inspect} is missing"
     results = datas.map { |d| evaluate(pathname, d) }
     hashes = results.map { |r| ::YAML.load(r, pathname) }
     settings = ComplexConfig::Settings.build(name, hashes.shift)
@@ -104,7 +106,7 @@ class ComplexConfig::Provider
       shared = shared.to_h
       settings.each do |key, value|
         if value.is_a? ComplexConfig::Settings
-          value.attributes_update(shared)
+          value.attributes_update_if_nil(shared)
         elsif value.nil?
           settings[key] = ComplexConfig::Settings.build(nil, shared.dup)
         end
@@ -153,7 +155,7 @@ class ComplexConfig::Provider
 
   def exist?(name)
     !!config(pathname(name), name)
-  rescue ComplexConfig::ConfigurationFileMissing
+  rescue ComplexConfig::ConfigurationFileMissing, ComplexConfig::EncryptionKeyMissing
     false
   end
 
@@ -174,7 +176,9 @@ class ComplexConfig::Provider
   end
 
   def env
-    @env || defined?(Rails) && Rails.env || ENV['RAILS_ENV'] || 'development'
+    @env || defined?(Rails) && Rails.respond_to?(:env) && Rails.env ||
+      ENV['RAILS_ENV'] ||
+      'development'
   end
 
   attr_writer :env
@@ -211,6 +215,21 @@ class ComplexConfig::Provider
 
   private
 
+  def decrypt_config_case(pathname)
+    enc_pathname = pathname.to_s + '.enc'
+    my_ks        = key_source(pathname)
+    if File.exist?(enc_pathname)
+      if my_ks.ask_and_send(:key)
+        text = IO.binread(enc_pathname)
+        decrypted = ComplexConfig::Encryption.new(my_ks.key_bytes).decrypt(text)
+        return decrypted, :ok, enc_pathname
+      else
+        return nil, :key_missing, enc_pathname
+      end
+    end
+    return nil, :file_missing, enc_pathname
+  end
+
   def interpret_name_value(name, value)
     if ComplexConfig::Settings === name
       if value

data/lib/complex_config/settings.rb

@@ -76,6 +76,15 @@ class ComplexConfig::Settings < BasicObject
     @table.update(other.table)
   end
 
+  def attributes_update_if_nil(other)
+    unless other.is_a? self.class
+      other = self.class.from_hash(other)
+    end
+    @table.update(other.table) do |key, oldval, newval|
+      @table.key?(key) ? oldval : newval
+    end
+  end
+
   def replace_attributes(hash)
     @table = self.class.from_hash(hash).table
     self
@@ -124,7 +133,7 @@ class ComplexConfig::Settings < BasicObject
   def to_s(pair_sep: ' = ', path_sep: ?.)
     empty? and return self.class.name
     pathes(path_sep: path_sep).inject('') do |result, (path, value)|
-      result << "#{path}#{pair_sep}#{value.inspect}\n"
+      result + "#{path}#{pair_sep}#{value.inspect}\n"
     end
   end
 

data/lib/complex_config/version.rb

@@ -1,6 +1,6 @@
 module ComplexConfig
   # ComplexConfig version
-  VERSION         = '0.16.0'
+  VERSION         = '0.18.2'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/spec/complex_config/provider_spec.rb

@@ -314,8 +314,8 @@ RSpec.describe ComplexConfig::Provider do
 
     it 'can share values' do
       expect(described_class['config'].development.shared).to eq true
-      expect(described_class['config'].test.shared).to eq true
-      expect(described_class['config'].staging.shared).to eq true
+      expect(described_class['config'].test.shared).to eq nil
+      expect(described_class['config'].staging.shared).to eq false
     end
   end
 end

data/spec/config/config.yml

@@ -9,8 +9,10 @@ development:
     pi:  <%= Math::PI %>
 
 staging:
+  shared: false
 
 test:
+  shared: null
   config:
     foo: false
     bar: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: complex_config
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.2
 platform: ruby
 authors:
 - Florian Frank
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -200,7 +200,7 @@ homepage: https://github.com/flori/complex_config
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - ComplexConfig -- configuration library
@@ -219,8 +219,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: configuration library
 test_files: