app_constants 1.0.2 → 1.0.3

data/Gemfile.lock

@@ -8,14 +8,14 @@ GEM
       git (>= 1.2.5)
       rake
     rake (0.8.7)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
+    rspec-mocks (2.5.0)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -67,6 +67,10 @@ After installing the gem - either using bundler or otherwise - you'll be respons
   AppConstants.environment = "development"
   AppConstants.load!
 
+Optionally you can set raise_error_on_missing which will raise a runtime error 1) during load if the environment doesn't exist and 2) all other times if a constant doesn't exist:
+
+  AppConstants.raise_error_on_missing = true
+  
 == Example
 
 If you have a constants.yml file that looks like this:

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.3

data/app_constants.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{app_constants}
-  s.version = "1.0.2"
+  s.version = "1.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leonardo Borges"]
-  s.date = %q{2011-02-02}
+  s.date = %q{2011-04-10}
   s.description = %q{A clean and simple way to manage your application's per-environment constants}
   s.email = %q{leonardoborges.rj@gmail.com}
   s.extra_rdoc_files = [
@@ -41,7 +41,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/leonardoborges/app_constants}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.5.0}
   s.summary = %q{A clean and simple way to manage your application's per-environment constants}
   s.test_files = [
     "test/app_constants_spec.rb",
@@ -49,7 +49,6 @@ Gem::Specification.new do |s|
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/app_constants.rb

@@ -4,6 +4,7 @@ require 'erb'
 class AppConstants
   @@config_path = Object.const_defined?(:Rails) ? "#{Rails.root}/config/constants.yml" : nil
   @@environment = Object.const_defined?(:Rails) ? Rails.env : 'test'
+  @@raise_error_on_missing = false  # if true this will raise an error if method you seek isn't in constants_hash
   
   def self.config_path=(path)
     @@config_path = path
@@ -13,20 +14,40 @@ class AppConstants
     @@environment = environment
   end  
   
+  def self.raise_error_on_missing=(true_false)
+    @@raise_error_on_missing = true_false
+  end
+  
   def self.method_missing(method, *args)
     @@instance.send(method).is_a?(Hash) ? AppConstants.new(@@instance.constants_hash[method.to_s]) : @@instance.send(method)
   end
 
   def method_missing(method, *args)
-    constants_hash[method.to_s].nil? ? "" : constants_hash[method.to_s].freeze 
+    fail_if_constant_missing(method.to_s)
+    constants_hash[method.to_s].nil? ? "" : constants_hash[method.to_s].freeze
   end
-  
+
+  def fail_if_constant_missing(constant)
+    unless constants_hash.keys.include?(constant) || @@raise_error_on_missing == false
+      raise "Constant #{constant} undefined in yml file. Options are: #{constants_hash.keys.join(", ")}"
+    end
+  end
+  private :fail_if_constant_missing
+
   def self.load!
     raise ArgumentError.new("No config file path specified. Use 'AppConstants.config_path = PATH' to set it up") if @@config_path.nil?
     constants_config = YAML::load(pre_process_constants_file)
+    fail_if_environment_missing(@@environment, constants_config)
     constants_hash = constants_config[@@environment] || {}
     @@instance = AppConstants.new(constants_hash)
-  end  
+  end
+
+  def self.fail_if_environment_missing(env, config)
+    unless config.keys.include?(env) || @@raise_error_on_missing == false
+      raise "Environment #{env} not found in yml file.  Options are: #{config.keys.join(", ")}"
+    end
+  end
+  private_class_method :fail_if_environment_missing
   
   def self.pre_process_constants_file
     template = File.open(@@config_path).read

data/test/app_constants_spec.rb

@@ -10,7 +10,7 @@ describe "AppConstants" do
     AppConstants.app_name.should == "Master of awesomeness"
   end
 
-  it "should raise a RuntiemError if trying to modify constants" do
+  it "should raise a RuntimeError if trying to modify constants" do
     AppConstants.config_path = "#{File.dirname(__FILE__)}/fixtures/constants.yml"
     AppConstants.environment = "development"
     AppConstants.load!
@@ -36,6 +36,25 @@ describe "AppConstants" do
     AppConstants.max_upload_in_bytes.should == 1048576
   end
 
+  it "should raise a runtime error if raise_error_on_missing is true" do
+    AppConstants.config_path = "#{File.dirname(__FILE__)}/fixtures/constants.yml"
+    AppConstants.raise_error_on_missing = true
+    AppConstants.environment = "development"
+    AppConstants.load!
+    expect { AppConstants.private_url }.to raise_error(RuntimeError)
+
+    AppConstants.public_url.should == "development.myawesomeapp.com"
+    AppConstants.app_name == "Master of awesomeness"
+    AppConstants.environment = "production"
+    AppConstants.load!
+    expect { AppConstants.private_url }.to raise_error(RuntimeError)
+
+    AppConstants.public_url.should == "www.myawesomeapp.com"
+    AppConstants.app_name == "Master of awesomeness"
+    AppConstants.environment = "playpen"
+    expect { AppConstants.load! }.to raise_error(RuntimeError)
+  end
+  
   describe "#load!" do
 
     before(:each) do

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: app_constants
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
+  prerelease: 
+  version: 1.0.3
 platform: ruby
 authors: 
 - Leonardo Borges
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-02 00:00:00 +11:00
+date: 2011-04-10 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,8 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   prerelease: false
@@ -37,8 +31,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   prerelease: false
@@ -50,8 +42,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   prerelease: false
@@ -63,8 +53,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   prerelease: false
@@ -113,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -781544183204636773
+      hash: -1519006393797098489
       segments: 
       - 0
       version: "0"
@@ -122,13 +110,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A clean and simple way to manage your application's per-environment constants