conf_conf 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b97132adaed0144f56e5fd294aeff6346d2a9e6b
-  data.tar.gz: e8a6488828ee9923f258a5b74d3e0329ede4fbcb
+  metadata.gz: 5ae8997ac5c6fb20fe8a764c3cdcc8b1ef08a07e
+  data.tar.gz: 0d96b60522f33f63984c9e1bda6b2aa106f5353e
 SHA512:
-  metadata.gz: 5061abb3d321fc3cc58bd7d60a12d57cffcbb4b3a6b348fb54fa00d5c30d80aa12fa9ab1910ecdec122c8ff98656d2812e6b6250658b1bdebbaa7b7535dd6187
-  data.tar.gz: c0dc60294413944698ba812d936d00a187ac922eba19f1285f54855a66d4a2fc35e41caa2f000ec73d724ede71ee989bbd3cb68939640aad27aa301e87278257
+  metadata.gz: 38d308e844b7cf90e7dbc58ca78465bde0cdbd6f4277193886520ccc48779d15aca22454ef9726206892f30fb02cc0129f2c86f92bebdd4eabaf8c064f0b1bd2
+  data.tar.gz: 5ddbb1345649fa3564c3abb98d7cfc0e2c8e791ca230ce25f2238d6f9e88dda5ccab3bafb73088e0aa8445c94a0c9b7e8ba690bd152a216ac52bdbde26ffb211

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 James Kassemi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -13,26 +13,17 @@ we can fail fast when there's a configuration problem.
 
 Add `gem 'conf_conf'` to your application's Gemfile.
 
-## Rails 
+## Usage
 
-Add a new initializer - if you use conf_conf.rb, as a matter
-of convention you shouldn't add ConfConf configuration blocks
-to other initializers.
+Add a new initializer - if you use conf_conf.rb , as a matter of 
+convention you shouldn't add ConfConf configuration blocks to
+other initializers.
 
 ```ruby
 # config/initializers/conf_conf.rb
-ConfConf.rails_configuration do
-  # Sets Rails.configuration.secret_key, app fails to boot if not present
+$configuration = ConfConf.configuration do
+  # Sets $configuration.secret_key, app fails to boot if not present
   config :secret_key
-
-  # Sets Rails.configuration.public_key from ENV["public_key"], or uses the default if not available in ENV
-  config :public_key, default: "XYZ123"
-
-  # Sets Rails.configuration.admin to a boolean value of true or false, app fails to boot if not present
-  config :admin, { |admin| admin ? true : false } 
-
-  # Sets Rails.configuration.public_key from ENV["PUBLIC_KEY_WITH_ALT_NAME"]
-  config :public_key, from: "PUBLIC_KEY_WITH_ALT_NAME"
 end
 ```
 
@@ -48,3 +39,46 @@ In the case above, if SECRET_KEY is not present, then
     from conf_conf/lib/conf_conf.rb:42
     ...
 ```
+
+### Default Values
+
+```ruby
+# Sets $configuration.public_key from ENV["PUBLIC_KEY"], or uses the default if not available in ENV
+config :public_key, default: "XYZ123"
+```
+
+### Casting
+
+You can adjust the value from the environment and typecast it or perform
+additional validation by passing a block to `config`:
+
+```ruby
+# Sets $configuration.admin to a boolean value of true or false based on truthiness of ENV key, app fails to boot if not present
+config(:admin) { |admin| 
+  admin ? true : false 
+}
+```
+
+### Varying Names
+
+If you'd like to reference a configuration value with a different name, you can
+use the `from` key as an option to `config` and pass it the name to expect from
+the environment.
+
+```ruby
+# Sets $configuration.public_key from ENV["PUBLIC_KEY_WITH_ALT_NAME"]
+config :public_key, from: "PUBLIC_KEY_WITH_ALT_NAME"
+```
+
+## Rails.configuration
+
+To assign directly to Rails.configuration instead of CONFCONF, you can
+use `ConfConf.rails_configuration` method.
+
+```ruby
+# config/initializers/conf_conf.rb
+ConfConf.rails_configuration do
+  # Sets Rails.configuration.secret_key
+  config :secret_key
+end
+```

data/conf_conf.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name             = "conf_conf"
-  s.version          = "1.0.1"
+  s.version          = "1.0.2"
   s.licenses         = ["MIT"]
   s.authors          = ["James Kassemi"] 
   s.email            = ["jkassemi@gmail.com"]

data/lib/conf_conf.rb

@@ -1,12 +1,17 @@
+require 'ostruct'
+
 Dir["tasks/**/*.rake"].each { |ext| load ext } if defined?(Rake)
 
 module ConfConf
   class MissingConfigurationValueError < StandardError; end;
 
   class << self
+    def configuration(&block)
+      OpenStruct.new(Configuration.new(&block).parsed_values)
+    end
+
     def rails_configuration(&block)
       configuration = Configuration.new
-
       configuration.run(block)
 
       configuration.parsed_values.each do |key, value|
@@ -18,8 +23,9 @@ module ConfConf
   class Configuration
     attr_reader :parsed_values
 
-    def initialize
+    def initialize(&block)
       @parsed_values = {}
+      run(block) if block
     end
 
     def run(block)

data/spec/conf_conf_spec.rb

@@ -3,51 +3,65 @@ require 'conf_conf'
 module Rails; end;
 
 describe ConfConf do
-  let(:configuration){ double() }
-  before { allow(Rails).to receive(:configuration).and_return(configuration) }
+  context "#configuration" do
+    it "sets a value from the environment" do
+      ENV["TEST_KEY"] = "hey"
 
-  it "sets a value from the environment" do
-    ENV["TEST_KEY"] = "hey"
-    expect(configuration).to receive(:test_key=).with("hey")
+      configuration = ConfConf.configuration {
+        config :test_key 
+      }
 
-    ConfConf.rails_configuration do
-      config :test_key
+      expect(configuration.test_key).to eq("hey")
     end
   end
 
-  it "sets the default value when key not present" do
-    expect(configuration).to receive(:key_not_present=).with("hey")
+  context "#rails_configuration" do
+    let(:configuration){ double() }
+    before { allow(Rails).to receive(:configuration).and_return(configuration) }
 
-    ConfConf.rails_configuration do
-      config :key_not_present, default: "hey"
+    it "sets a value from the environment" do
+      ENV["TEST_KEY"] = "hey"
+      expect(configuration).to receive(:test_key=).with("hey")
+
+      ConfConf.rails_configuration do
+        config :test_key
+      end
     end
-  end
 
-  it "sets value from specified environment key" do
-    ENV["TEST_KEY"] = "hey"
-    expect(configuration).to receive(:other_key=).with("hey")
+    it "sets the default value when key not present" do
+      expect(configuration).to receive(:key_not_present=).with("hey")
 
-    ConfConf.rails_configuration do
-      config :other_key, from: "TEST_KEY"
+      ConfConf.rails_configuration do
+        config :key_not_present, default: "hey"
+      end
     end
-  end
 
-  it "throws an exception when required key not present" do
-    expect {
+    it "sets value from specified environment key" do
+      ENV["TEST_KEY"] = "hey"
+      expect(configuration).to receive(:other_key=).with("hey")
+
       ConfConf.rails_configuration do
-        config :key_not_present
+        config :other_key, from: "TEST_KEY"
       end
-    }.to raise_error(ConfConf::MissingConfigurationValueError)
-  end
+    end
 
-  it "evaluates a block to establish the actual configuration value" do
-    ENV["INTEGER_VALUE"] = "2"
+    it "throws an exception when required key not present" do
+      expect {
+        ConfConf.rails_configuration do
+          config :key_not_present
+        end
+      }.to raise_error(ConfConf::MissingConfigurationValueError)
+    end
+
+    it "evaluates a block to establish the actual configuration value" do
+      ENV["INTEGER_VALUE"] = "2"
 
-    expect(configuration).to receive(:integer_value=).with(2)
+      expect(configuration).to receive(:integer_value=).with(2)
 
-    ConfConf.rails_configuration do
-      config :integer_value do |value|
-        value.to_i
+      ConfConf.rails_configuration do
+        config :integer_value do |value|
+          value.to_i
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conf_conf
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - James Kassemi
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- LICENSE
 - README.md
 - conf_conf.gemspec
 - lib/conf_conf.rb