konfa 0.0.2 → 0.1.0

data/lib/konfa.rb

@@ -3,25 +3,59 @@ require 'yaml'
 
 module Konfa
   class Base
+    class << self
+      protected
 
-    @@env_variable_prefix = 'APP_'
-    @@variables = {}
+      #
+      # The following methods are not a part of the public API. You may sublcass
+      # them, but remember that unless you scope them as protected or private,
+      # they will then be public
+      #
 
-    class << self
+      attr_writer :configuration
 
-      def get(variable)
-        raise UnsupportedVariableError.new(variable) unless @@variables.has_key? variable
-        @@variables[variable]
+      def configuration
+        @configuration ||= self.allowed_variables
+      end
+
+      def truthy?(value)
+        (!value.nil? && value =~ /^\s*(?:true|1|yes|on)\s*$/i) ? true : false
+      end
+
+      def store(key, value)
+        key = key.to_sym
+        raise UnsupportedVariableError.new(key) unless self.configuration.has_key? key
+        self.configuration[key] = value.to_s
       end
 
-      def set(variable, value = nil)
-        raise UnsupportedVariableError.new(variable) unless @@variables.has_key? variable
-        @@variables[variable] = value
+      public
+
+
+      #
+      # The following methods should be overridden and used to configure the
+      # configuration class
+      #
+
+      def env_variable_prefix
+        'APP_'
+      end
+
+      def allowed_variables
+        {}
+      end
+
+
+      #
+      # The following methods provides the interface to this class
+      #
+
+      def get(variable)
+        raise UnsupportedVariableError.new(variable) unless self.configuration.has_key? variable
+        self.configuration[variable]
       end
 
       def true?(variable)
-        v = self.get(variable)
-        (!v.nil? && v =~ /^\s*(?:true|1|yes|on)\s*$/i) ? true : false
+        self.truthy?(self.get(variable))
       end
 
       def false?(variable)
@@ -29,15 +63,11 @@ module Konfa
       end
 
       def variables
-        @@variables.keys
+        self.configuration.keys
       end
 
       def dump
-        @@variables.dup
-      end
-
-      def env_variable_prefix
-        @@env_variable_prefix
+        self.configuration.dup
       end
 
       def initialize_from_yaml(path)
@@ -47,23 +77,22 @@ module Konfa
 
         yaml_data = YAML.load_file(path)
         yaml_data.each do |variable, value|
-          raise UnsupportedVariableError.new(variable) unless @@variables.has_key? variable.to_sym
-          set(variable.to_sym, value.to_s)
+          self.store(variable, value)
         end
+
         after_initialize
         dump
       end
 
-      def initialize_from_env(prefix=@@env_variable_prefix)
+      def initialize_from_env
+        conf_prefix = self.env_variable_prefix.upcase
+
         ENV.keys.reject { |key|
-          key !~ /^#{prefix}/ # Ignore everything that doesn't match the prefix
+          key !~ /^#{conf_prefix}/ # Ignore everything that doesn't match the prefix
         }.each { |key|
-          variable = key[prefix.size..-1].downcase.to_sym
-          unless @@variables.has_key? variable
-            raise UnsupportedVariableError.new(variable)
-          end
+          variable = key[conf_prefix.size..-1].downcase
 
-          set(variable, ENV[key])
+          self.store(variable, ENV[key])
         }
         after_initialize
         dump
@@ -73,13 +102,13 @@ module Konfa
       end
 
       def with_config(overrides={})
-        originals = dump
-        overrides.each_pair {|k,v| self.set(k, v) }
+        original_config = dump
+        overrides.each_pair {|k,v| self.store(k, v) }
 
         begin
           result = yield
         ensure
-          @@variables = originals
+          self.configuration = original_config
         end
 
         result

metadata

@@ -1,68 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: konfa
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Gunnar Hansson
 - Avidity
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-09-20 00:00:00 +02:00
-default_executable: 
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies: []
-
 description: Helps you avoid common pitfalls when dealing with app config
 email: code@avidiy.se
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/konfa.rb
-has_rdoc: true
 homepage: http://github.com/avidity/konfa
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Application configuration
 test_files: []
-