app_config_loader 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e592723d0d4dc4f9f4640900c9898bb83fd4c35
-  data.tar.gz: c2b0ffc59d4e620846cab0c9f38a245e34460ec7
+  metadata.gz: ee4a503703a004e9c25e4741e7703de61c4cb28b
+  data.tar.gz: 093690ba1c61b1cccefc46aeab9fa3762a2b13d9
 SHA512:
-  metadata.gz: 8478ba6318c4ff97a6c47f8e04358d26086f07f88db2e2a5fc00b69f96aada7fadf6d391d97a6aa84ea1dfe6eefb2eb2dcc9561bedd9caed34f3f2070fff2db9
-  data.tar.gz: 528e97b31426dd3aa76a782a0d19945763c826c5d861e1015bd053bc25460b019e7f26ac6c21cfede5a839fa188d865c3eba223758c7f111ac3a74f25ef548f8
+  metadata.gz: ec2bdc27e3a13eebc34c51f587563ed2e78d030504f98000f8ac69805a74d442e0e0c9284e5af3c920c8707ca664b7d797ab631013cba6ec670f6aeb48c5adc7
+  data.tar.gz: c9eb2f9b4cced192906de26f28e569320db289eb6b193a0135d195fb3c1139e649518fca7372d3fb536c03f74cfd2893e40ecf2fd040c1018607036ce0ac6083

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## [v1.0.4](https://github.com/lscspirit/app_config_loader/tree/v1.0.4) (2017-04-30)
+[Full list of commits](https://github.com/lscspirit/app_config_loader/compare/v1.0.3...v1.0.4)
+
+- Auto-initialize in Rails 'db' tasks
+
 ## [v1.0.3](https://github.com/lscspirit/app_config_loader/tree/v1.0.3) (2017-04-23)
 [Full list of commits](https://github.com/lscspirit/app_config_loader/compare/v1.0.2...v1.0.3)
 

data/README.md

@@ -46,7 +46,10 @@ When using `AppConfigLoader` outside of Rails, getting started is a little diffe
 
 ## Configuration
 
-You can configure where and how AppConfigLoader load your app config file(s).
+You can configure where and how AppConfigLoader load your app config file(s). 
+
+In Rails, the following code should be placed
+before Rails is initialized but after your Rails application is defined (e.g. `config/application.rb`). Outside Rails, this should be placed before the `AppConfigLoader.init` call. 
 
 ```ruby
 AppConfigLoader.configure do |config|
@@ -220,6 +223,21 @@ conflict with each other and a `ConfigKeyConflict` error will be raises.
 
 The local overrides file provides a quick way to override any entries defined in regular app config files. Entries within this file are resolved according to the specificity rule. Once resolved, the resolved entries will override any existing entries regardless of specificity. This is meant for development or testing purposes. Typically, you would not want to check this file into your source repository.
 
+## Manual Load
+
+Apart from initializing the module using `AppConfigLoader.init`, you may also manually parse and load app config. 
+
+```ruby
+config = AppConfigLoader::Config.new
+config.use_domain = true
+config.env = 'development'
+config.config_paths << '/path/to/app_config.yml'
+
+app_config = AppConfigLoader::load(config)
+app_config['some_config.key']   #=> config value for the 'some_config.key' key
+
+```
+
 ## Contributors
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/lscspirit/app_config_loader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/lib/app_config_loader.rb

@@ -9,21 +9,57 @@ require 'app_config_loader/config_with_indifferent_access'
 require 'app_config_loader/railtie' if defined?(Rails)
 
 module AppConfigLoader
+  # Configure the module
   #
-  # Config
+  # @yield [config] configuration block
+  # @yieldparam [AppConfigLoader::Config] config the config object
   #
-
+  # @example Change the default settings
+  #   AppConfigLoader.configure do |config|
+  #     config.use_domain = true
+  #     config.domain = 'us'
+  #     config.config_paths << '/path/to/app_config.yml'
+  #   end
   def self.configure
     yield self.config if block_given?
   end
 
+  # Initialize the module
+  # This parse and load the app config into the constant specified by the configuration's +const_name+ property
+  #
+  # @raise [NameError] the constant has already been defined
   def self.init
     cfg = self.config
 
     raise NameError, "cannot assign app config because '#{cfg.const_name}' is already defined" if Object.const_defined?(cfg.const_name)
     Object.const_set cfg.const_name, self.load(cfg)
+
+    @inited = true
+  end
+
+  # Whether the module has been initialized
+  #
+  # @return [Boolean] the module is initialized
+  def self.initialized?
+    !!@inited
   end
 
+  # Parse and load the app config
+  #
+  # @param [AppConfigLoader::Config] config configuration to use when loading the app config
+  #
+  # @raise [ArgumentError] configuration is invalid
+  #
+  # @return [AppConfigLoader::ConfigWithIndifferentAccess] app config map
+  #
+  # @example Manually load app config
+  #   config = AppConfigLoader::Config.new
+  #   config.use_domain = true
+  #   config.env = 'development'
+  #   config.config_paths << '/path/to/app_config.yml'
+  #
+  #   app_config = AppConfigLoader::load(config)
+  #   app_config['some_config.key']   #=> config value for the 'some_config.key' key
   def self.load(config = nil)
     raise ArgumentError, 'config must be a AppConfigLoader::Config instance' unless config.nil? || config.is_a?(AppConfigLoader::Config)
     Loader.new(config || self.config).load

data/lib/app_config_loader/config_with_indifferent_access.rb

@@ -7,6 +7,15 @@ module AppConfigLoader
       @prefix     = prefix
     end
 
+    # Get value for a specified config key
+    #
+    # @param [String] key app config key
+    #
+    # @return the value for the key or another ConfigWithIndifferentAccess; nil if there is no value at the key
+    #
+    # @example Getting key value
+    #   app_config['some_service.host']      # => 'dev.someservice.com'
+    #   app_config.get('some_service.host')  # => 'dev.someservice.com'
     def get(key)
       # append prefix to the key if needed
       target_key = @prefix ? "#{@prefix}.#{key}" : key.to_s

data/lib/app_config_loader/railtie.rb

@@ -1,8 +1,13 @@
 module AppConfigLoader
   class Railtie < Rails::Railtie
     config.before_initialize do
-      # initialize the app config before Rails initialization
-      AppConfigLoader.init
+      # initialize the app config before Rails initialization unless it has already been initialized
+      AppConfigLoader.init unless AppConfigLoader.initialized?
+    end
+
+    rake_tasks do
+      # install a rake task for initializing the module
+      load File.expand_path('../tasks.rake', __FILE__)
     end
   end
 end

data/lib/app_config_loader/tasks.rake

@@ -0,0 +1,9 @@
+namespace :app_config_loader do
+  task :init do
+    # initialize AppConfigLoader unless it has already been done so
+    AppConfigLoader.init unless AppConfigLoader.initialized?
+  end
+end
+
+# initialize the module before db:load_config task so that app config is available for all 'db' tasks
+Rake::Task['db:load_config'].enhance %w(app_config_loader:init)

data/lib/app_config_loader/version.rb

@@ -1,3 +1,3 @@
 module AppConfigLoader
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_config_loader
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Derrick Yeung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-23 00:00:00.000000000 Z
+date: 2017-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +91,7 @@ files:
 - lib/app_config_loader/loader.rb
 - lib/app_config_loader/parser.rb
 - lib/app_config_loader/railtie.rb
+- lib/app_config_loader/tasks.rake
 - lib/app_config_loader/version.rb
 homepage: https://github.com/lscspirit/app_config_loader
 licenses: