config_reader 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fa20c036bed02f5864bb5fdaebbd2f0ecce3315
-  data.tar.gz: cea79cb4e8a5b14456f64d3988fe2f9274f36099
+  metadata.gz: c70acd1692b08bdedb8f5f0ed7647cdbecda42d7
+  data.tar.gz: 852b2bddd711ab21984d0049701e38e83295d3f8
 SHA512:
-  metadata.gz: 69f491dc61461f6d7415b65f3cf1d3ec22b64f950bd9ed996ffcbcb173c2de78e61afa87c6bdd1af1021f39bec8c0b792cd27f483c85c936ab00fd7c57055e10
-  data.tar.gz: 9bd67ba76fc575145621f4f0f274384e3fa7fef06f913876b11b3176400a9d043ace8559f55aae5b30222042ac86f30708dcf25be334955184b744963ed0f183
+  metadata.gz: 81654334867c8598084c0b66bdbd27abf9af5c4970c049b5b898da732509e1badb07fbebb53721422ce04caacecaa61ebb478b834327390138ab691d6a1c7f1a
+  data.tar.gz: 1cdb20047b97d4162bc966f2afa7e1235fe80198671bf0509da480ad33da712e50fc1db8a3c5d4f2d20924cbe15af53ba22335d01360a1091c8f6a46e3b2f844

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    config_reader (1.0.5)
+    config_reader (2.0.0)
       deep_merge
 
 GEM
@@ -10,17 +10,17 @@ GEM
     arrayfields (4.9.2)
     chronic (0.10.2)
     coderay (1.1.0)
-    coerce (0.0.6)
+    coerce (0.0.8)
       chronic (>= 0.6.2)
     deep_merge (1.1.1)
-    fattr (2.2.2)
-    highline (1.6.21)
-    main (6.0.0)
-      arrayfields (>= 4.7.4)
-      chronic (>= 0.6.2)
-      fattr (>= 2.2.0)
-      map (>= 5.1.0)
-    map (6.5.3)
+    fattr (2.3.0)
+    highline (1.7.10)
+    main (6.2.2)
+      arrayfields (~> 4.7, >= 4.7.4)
+      chronic (~> 0.6, >= 0.6.2)
+      fattr (~> 2.2, >= 2.2.0)
+      map (~> 6.1, >= 6.1.0)
+    map (6.6.0)
     method_source (0.8.2)
     pry (0.9.12.6)
       coderay (~> 1.0)
@@ -28,12 +28,12 @@ GEM
       slop (~> 3.4)
     rake (0.9.2.2)
     rspec (1.3.2)
-    sekrets (1.7.0)
-      coerce (>= 0.0.3)
-      fattr (>= 2.2.1)
-      highline (>= 1.6.15)
-      main (>= 5.1.1)
-      map (>= 6.3.0)
+    sekrets (1.10.0)
+      coerce (~> 0.0.3)
+      fattr (~> 2.2)
+      highline (~> 1.6)
+      main (~> 6.1)
+      map (~> 6.3)
     slop (3.5.0)
 
 PLATFORMS
@@ -44,7 +44,7 @@ DEPENDENCIES
   pry
   rake
   rspec (= 1.3.2)
-  sekrets (~> 1.7.0)
+  sekrets (~> 1)
 
 BUNDLED WITH
    1.16.1

data/README.rdoc

@@ -21,35 +21,28 @@ Example config file:
   test:
     blackbird: false
 
-Example class:
-
-  class MyConfig < ConfigReader
-    self.config_file = 'config/my_config.yml'
-  end
-
-don't throw errors on missing keys
-
-  class MyConfig < ConfigReader
-    self.config_file = 'config/my_config.yml'
-    self.ignore_missing_keys = true
-  end
-
 == Sekrets
-Now also includes Sekrets integration. https://github.com/ahoward/sekrets
+
+Includes Sekrets integration. See https://github.com/ahoward/sekrets for more information.
 
 The format of the sekrets file is the same as the regular file.
 
-Example class with Sekrets:
+== Setup
 
   class MyConfig < ConfigReader
-    self.config_file = 'config/my_config.yml'
-    self.sekrets_file = 'config/my_config.yml.enc'
+    configure do |config|
+      config.environment = Rails.env # (set this however you access the env in your app)
+      config.config_file = 'config/my_config.yml'
+      config.sekrets_file = 'config/my_config.yml.enc' # (default nil)
+      config.ignore_missing_keys = true # (default false, raises KeyError)
+    end
   end
 
-Usage:
+== Usage
 
   MyConfig.mail_from   #=> noreply@example.com
   MyConfig[:mail_from] #=> noreply@example.com
+  MyConfig['mail_from'] #=> noreply@example.com
 
 == Note on Patches/Pull Requests
 
@@ -63,4 +56,4 @@ Usage:
 
 == Copyright
 
-Copyright (c) 2008 Michael Moen. See LICENSE for details.
+Copyright (c) 2008-2018 Michael Moen. See LICENSE for details.

data/config_reader.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '1.3.2'
-  s.add_development_dependency 'sekrets', '~> 1.7.0'
+  s.add_development_dependency 'sekrets', '~> 1'
   s.add_development_dependency 'pry'
+
+  s.post_install_message = "If you are are upgrading from a pre 2.x version, please see the configuration changes in the README https://github.com/UnderpantsGnome/config_reader-gem/blob/master/README.rdoc"
 end

data/lib/config_reader.rb

@@ -1,5 +1,5 @@
-require "config_reader/version"
-require "config_reader/magic_hash"
+require 'config_reader/version'
+require 'config_reader/magic_hash'
 require 'yaml'
 require 'deep_merge'
 
@@ -11,23 +11,15 @@ end
 
 class ConfigReader
   class << self
-    attr_accessor :config_file, :config, :sekrets_file, :ignore_missing_keys
+    attr_accessor :configuration
 
     def config
       @config = nil unless defined?(@config)
       @config ||= reload
     end
 
-    def config_file=(file)
-      @config_file = file
-    end
-
-    def ignore_missing_keys=(bool)
-      @ignore_missing_keys = bool
-    end
-
     def reload
-      merge_configs(find_env, load_config, load_sekrets)
+      merge_configs(load_config, load_sekrets)
     end
 
     def [](key)
@@ -35,14 +27,14 @@ class ConfigReader
     end
 
     def find_config
-      return @config_file if File.exist?(@config_file)
+      return configuration.config_file if File.exist?(configuration.config_file)
 
       %w( . config ).each do |dir|
-        config_file = File.join(dir, @config_file)
+        config_file = File.join(dir, configuration.config_file)
         return config_file if File.exist?(config_file)
       end
 
-      ''
+      nil
     end
 
     def method_missing(key, *args, &block)
@@ -57,24 +49,6 @@ class ConfigReader
       puts config.inspect
     end
 
-    def find_env
-      if defined?(Rails) && Rails.respond_to?(:stage)
-        Rails.stage
-      elsif defined?(Rails) && Rails.env
-        Rails.env
-      elsif defined?(RAILS_ENV)
-        RAILS_ENV
-      elsif defined?(Padrino) && Padrino.env
-        Padrino.env.to_s
-      elsif defined?(PADRINO_ENV)
-        PADRINO_ENV
-      elsif ENV['RACK_ENV']
-        ENV['RACK_ENV']
-      elsif defined?(APP_ENV)
-        APP_ENV
-      end
-    end
-
     def load_config
       raise 'No config file set' unless find_config
 
@@ -92,10 +66,10 @@ class ConfigReader
     def load_sekrets
       sekrets = {}
 
-      if @sekrets_file
+      if configuration.sekrets_file
         begin
           require 'sekrets'
-          sekrets = ::Sekrets.settings_for(@sekrets_file)
+          sekrets = ::Sekrets.settings_for(configuration.sekrets_file)
           raise 'No sekrets found' unless sekrets
         rescue LoadError
           $stderr.puts "You specified a sekrets_file, but the sekrets gem isn't available."
@@ -105,12 +79,37 @@ class ConfigReader
       sekrets
     end
 
-    def merge_configs(env, conf, sekrets)
+    def merge_configs(conf, sekrets)
+      env = configuration.environment
+
       _conf = conf['defaults']
       _conf.deep_merge!(sekrets['defaults']) if sekrets && sekrets['defaults']
       _conf.deep_merge!(conf[env]) if conf[env]
       _conf.deep_merge!(sekrets[env]) if sekrets && sekrets[env]
-      ConfigReader::MagicHash.convert_hash(_conf, @ignore_missing_keys)
+
+      MagicHash.convert_hash(_conf, configuration.ignore_missing_keys)
     end
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
   end
+
+  class Configuration
+    attr_accessor :config_file, :sekrets_file, :ignore_missing_keys, :environment
+
+    def initialize
+      @config_file = nil
+      @sekrets_file = nil
+      @ignore_missing_keys = false
+      @environment = nil
+    end
+  end
+
 end

data/lib/config_reader/version.rb

@@ -1,3 +1,3 @@
 class ConfigReader
-  VERSION = "1.0.5"
+  VERSION = "2.0.0"
 end

data/spec/no_key_no_error_config.rb

@@ -1,4 +1,7 @@
 class NoKeyNoErrorConfig < ConfigReader
-  self.config_file = 'spec/test_config.yml'
-  self.ignore_missing_keys = true
+  configure do |config|
+    config.environment = 'test'
+    config.config_file = 'spec/test_config.yml'
+    config.ignore_missing_keys = true
+  end
 end

data/spec/sekrets_config.rb

@@ -1,4 +1,7 @@
 class SekretsConfig < ConfigReader
-  self.config_file = 'spec/test_config.yml'
-  self.sekrets_file = 'spec/sekrets_config.yml.enc'
+  configure do |config|
+    config.environment = 'test'
+    config.config_file = 'spec/test_config.yml'
+    config.sekrets_file = 'spec/sekrets_config.yml.enc'
+  end
 end

data/spec/test_config.rb

@@ -1,3 +1,6 @@
 class TestConfig < ConfigReader
-  self.config_file = 'spec/test_config.yml'
-end
+  configure do |config|
+    config.environment = 'test'
+    config.config_file = 'spec/test_config.yml'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_reader
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Michael Moen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-01 00:00:00.000000000 Z
+date: 2018-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,8 @@ files:
 homepage: https://github.com/UnderpantsGnome/config_reader-gem
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message: If you are are upgrading from a pre 2.x version, please see
+  the configuration changes in the README https://github.com/UnderpantsGnome/config_reader-gem/blob/master/README.rdoc
 rdoc_options: []
 require_paths:
 - lib
@@ -125,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: config_reader
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Provides a way to manage environment specific configuration settings.