quandl-config 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 403c3cbaabc16054de24a43fc59bffc6e3a3c13c
-  data.tar.gz: c88b13a483cd007997e25a4c40c861f9333911ff
+  metadata.gz: 9f99d2c151b092438f654afcdb16e59ad4f67522
+  data.tar.gz: a5e7c655ff56638c343113fb6619995e589ef0e5
 SHA512:
-  metadata.gz: 09ae2b94937905c73ecd90c05acb8bdd2987cac21faa7b612b5dc0422bdcff800ad6cccdb243ebdc08f44b6a03ba985a7a8a2c4ac37df9bd866d9829352c0a9f
-  data.tar.gz: 8abac3e2cd3051478a54d6c78ee1e7231e6961869f0f2ce26c301505554e3750495594458c78d4b2f061175a9381dc8c0b27e6c092943233f6d8a2370b6ea1cf
+  metadata.gz: e734ff03977f94c1302477277be280834315bfcf85960c0ef596c8bff09260558508c3bed7edd315ccc8fd09bac840d33eafb5a558d6791488f577ea5a946330
+  data.tar.gz: c8f1487d99ab0148a215d25b35f811e0b383e36c164777ec3c20b793d4a2827252c7f728b5e4c469f77a9083c60af8f986d2f756523a111b3dd22f08479b574a

data/README.md

@@ -58,9 +58,39 @@ end
 
 ### What if my project is not a Rails app?
 
-That's ok. `Quandl::Config` will find your config file if it's in a `config` folder in the root of your app.
+That's ok. `Quandl::Config` will find your config file if it's in a `config` folder in the root of your app. See also the [How do I override default values?](#how-do-i-override-default-values) for more information.
 
-If you want to provide the environment, use `ENV['RAILS_ENV']` or `ENV['RAKE_ENV']`. If you don't, the `default` environment will be assumed.
+### How do I override default values?
+
+You can override default values by adding a `configuration_options` method to your class/instance. The options available to be overwritten are:
+
+* `root_path` - Override this when you want to change the default path to your configuration files root folder. (default: your project path)
+* `environment` - Override this when you are not using a rails project and don't set the environment via `ENV['RAILS_ENV']`
+
+```ruby
+class A::B::Special
+  extend Quandl::Configurable
+  
+  def self.configuration_options
+    {
+        root_path: Pathname.new('~/configs/my_project'),
+        environment: ENV['MY_PROJECT']
+    }
+  end
+end
+```
+
+## FAQ
+
+### My config file won't reload in development mode (Rails)
+
+quandl-config utilizes an internal caching schema to save previously loaded configurations so that they don't load twice. You may need to restart your server in certain cases depending on how quandl-config was used in your project.
+
+Additionally if you have `included` via `include Quandl::Configurable` you can use the following method to reset the internal config. This however will not work when `extending` the module.
+
+```ruby
+Quandl::Config.clear_internal_cache
+``` 
 
 ## Contributing
 

data/lib/quandl/{configurable.rb → config/configurable.rb}

@@ -1,5 +1,3 @@
-require 'active_support/inflector'
-
 module Quandl
   module Configurable
     def configuration

data/lib/quandl/config/version.rb

@@ -0,0 +1,5 @@
+module Quandl
+  module Configurable
+    VERSION = '0.1.0'
+  end
+end

data/lib/quandl/config.rb

@@ -1,20 +1,29 @@
 require 'ostruct'
 require 'yaml'
-require 'quandl/project_root'
+require 'active_support/inflector'
+require 'pathname'
+
+require_relative 'config/project_root'
+require_relative 'config/configurable'
 
 module Quandl
   class Config < ::OpenStruct
-    VERSION = '0.0.4'
+    # Optimize loading of configs multiple times by keeping a hash of already loaded configs.
+    def self.new(filename, options = {})
+      @_registered_configs ||= {}
+      return @_registered_configs[filename] if @_registered_configs.key?(filename)
+      @_registered_configs[filename] = super
+    end
 
-    def initialize(file_name, options = {})
-      raw_config = File.read(project_root.join('config', "#{file_name}.yml"))
-      erb_config = ERB.new(raw_config).result
-      config = YAML.load(erb_config)[project_environment]
+    def self.clear_internal_cache
+      @_registered_configs = {}
+    end
 
+    def initialize(file_name, options = {})
       @_root = options.delete(:root_path)
       @_environment = options.delete(:environment)
 
-      super(config)
+      super(read_config(file_name))
     end
 
     def configurable_attributes
@@ -25,8 +34,14 @@ module Quandl
 
     private
 
+    def read_config(file_name)
+      raw_config = File.read(Pathname.new(project_root).join('config', "#{file_name}.yml"))
+      erb_config = ERB.new(raw_config).result
+      YAML.load(erb_config)[project_environment]
+    end
+
     def project_root
-      @_root ||= defined?(Rails) ? ::Rails.root : Pathname.new(ProjectRoot.root)
+      @_root ||= defined?(Rails) ? ::Rails.root : ProjectRoot.root
     end
 
     def project_environment
@@ -34,5 +49,3 @@ module Quandl
     end
   end
 end
-
-require 'quandl/configurable'

data/spec/quandl/quandl-configurable_spec.rb

@@ -1,17 +1,65 @@
 require 'spec_helper'
 
+module ConfigurationOverride
+  def configuration_options
+    {
+      root_path: Pathname.new(Dir.tmpdir),
+      environment: 'this_is_a_test'
+    }
+  end
+end
+
 describe Quandl::Configurable do
+  before(:each) do
+    Quandl::Config.clear_internal_cache
+  end
+
+  shared_examples 'override configuration' do
+    it 'should use the overwritten values' do
+      expect(File).to receive(:read).with(Pathname.new(Dir.tmpdir).join('config', 'fake.yml')).and_return('---\n:a: :b\n')
+      expect(subject.send(:project_environment)).to eq('this_is_a_test')
+      expect(subject.send(:project_root)).to eq(Pathname.new(Dir.tmpdir))
+    end
+  end
+
   context 'when extending' do
-    it 'adds a configuration class method' do
+    subject { Fake.configuration }
+
+    before(:each) do
       Fake.extend(Quandl::Configurable)
-      expect(Fake.configuration).to be_kind_of(Quandl::Config)
+      Fake.instance_variable_set(:@configuration, nil)
+    end
+
+    it 'adds a configuration class method' do
+      expect(subject).to be_kind_of(Quandl::Config)
+    end
+
+    context 'when overriding configuration options' do
+      before(:each) do
+        Fake.extend(ConfigurationOverride)
+      end
+
+      include_examples 'override configuration'
     end
   end
 
   context 'when including' do
-    it 'adds a configuration instance method' do
+    subject { Fake.new.configuration }
+
+    before(:each) do
       Fake.include(Quandl::Configurable)
-      expect(Fake.new.configuration).to be_kind_of(Quandl::Config)
+    end
+
+    it 'adds a configuration instance method' do
+      expect(subject).to be_kind_of(Quandl::Config)
+    end
+
+    context 'when overriding configuration options' do
+      before(:each) do
+        Fake.include(ConfigurationOverride)
+      end
+
+      include_examples 'override configuration'
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,2 @@
-require 'pry'
 require 'quandl/config'
 require 'fixtures/dummy_rails_app/application'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quandl-config
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Najwa Azer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -152,7 +152,7 @@ dependencies:
         version: '0'
 description: Load ERB-based YML files into open OpenStruct objects for ease of use.
 email:
-- najwa.azer@gmail.com
+- dev@quandl.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -160,8 +160,9 @@ files:
 - LICENSE.txt
 - README.md
 - lib/quandl/config.rb
-- lib/quandl/configurable.rb
-- lib/quandl/project_root.rb
+- lib/quandl/config/configurable.rb
+- lib/quandl/config/project_root.rb
+- lib/quandl/config/version.rb
 - spec/fixtures/dummy_rails_app/application.rb
 - spec/fixtures/dummy_rails_app/config/fake.yml
 - spec/fixtures/dummy_rails_app/fake.rb