qonf 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e1ef8c9bbf6a8d5f9cd0f71c5253a44424970dc
-  data.tar.gz: 43b459ff2cb58753fe21720f1c1fe3353616d7cd
+  metadata.gz: 12132d8454c98e3c2a1424e86cbb6faebb0f51e2
+  data.tar.gz: eda1d01e2b676e61d9438492e11b819df425d961
 SHA512:
-  metadata.gz: dbc596ae062ef2df9de3fb17a15e9840e9047e54b9c84a9568326f660674cfee5cb6d17d48e83978ba8a87048420a1a41ca1acafc851e1f27fdf82d6f302477f
-  data.tar.gz: 4bf7a0488b3c608021176ef5a3004bac2dc14c08b20c259202e137a36ad91bdc253c8bf0424f06c173154854c134528aacb2fd3d5b885009ce5a0b52c786ed6a
+  metadata.gz: e401058d8f0a05b2a3ad34b75639d1599673233fc9db17a4e9f367531623c1573beed6bd8dd08f9d283ef6fd7463d37ab4c8018273ba151afb082036df278ba2
+  data.tar.gz: 13104477004369318b7016ee489c85d83e8df055fc28eb9f28d42deecc396ca782ef78225aad1c01f78d15efb3e116d76d2b364e757017ea817dfb5676e9bf2b

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/README.md

@@ -2,23 +2,53 @@
 
 Versitle configuration management.  Pull data from ENV or config files.  Simplest use case:
 
-config/qonf.json
-```
-{
-"host": "http://google.com"
-}
-```
+## Usage
+
+Qonf works well with or without Rails.  If using Rails, Qonf will assume config files are in `Rails.root/config` directory.  Otherwise, you'll need to set the root yourself:
+
+    Qonf.configure do
+      self.base_dir = "./config"
+    end
+
+Qonf also allows you to use environment based keys, these will come preconfigured for Rails or could be set by other ruby applications:
+
+    Qonf.configure do
+      self.env = "staging" # hash under this key will be merged into top-level hash
+      self.environments = %w{test staging production} # these will be removed from hash if they are top-level keys
+    end
+
+So, if you config is as follows:
+    
+    # config/names.json
+    {
+      "test": {
+        "name": "Test data"
+      },
+      "staging": {
+        "name": "Bob Jones"
+      }
+    }
 
-Qonf.host # "http://google.com"
+    Qonf.get(:names,:name) # Bob Jones
 
-Additionally, you could make a file config/redis.yml
+## Config Files
 
-```
-development:
-  host: localhost
-```
+Config files can be either json or yml.  They are addressed by name and must live in the `base_dir` path (for Rails, this is `Rails.root/config`)
 
-Qonf.get(:redis,:host) # "localhost"
+    # config/qonf.json
+    {
+      "host": "http://google.com"
+    }
+
+    Qonf.host # "http://google.com"
+
+YAML can also be used:
+
+    # config/redis.yml
+    development:
+      host: localhost
+
+    Qonf.get(:redis,:host) # "localhost"
 
 ## Installation
 
@@ -34,9 +64,11 @@ Or install it yourself as:
 
     $ gem install qonf
 
-## Usage
+## Testing
+
+Tests are maintained by RSpec.  To run test cases:
 
-TODO: Write usage instructions here
+    bundle exec rake test
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,8 @@
+#!/usr/bin/env rake
+require "rspec/core/rake_task"
 require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/examples/environed.json

@@ -0,0 +1,8 @@
+{
+  "test": {
+    "name": "Matt"
+  },
+  "production": {
+    "name": "Steve"
+  }
+}

data/examples/simple.json

@@ -0,0 +1,3 @@
+{
+  "name": "Bob Jones"
+}

data/lib/qonf/version.rb

@@ -1,3 +1,3 @@
 module Qonf
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/qonf.rb

@@ -3,7 +3,33 @@ require "qonf/version"
 # A simple module to get information quickly out of config files
 module Qonf
   @@cache = {} # note, we're caching the config in memory
-  @@environments = Dir.glob("./config/environments/*.rb").map { |filename| File.basename(filename, ".rb") } # for extraction
+
+  module Config
+    @@environments = []
+    @@base_dir = nil
+    @@env = nil
+    @@use_cache = true
+
+    [:environments,:env,:base_dir,:use_cache].each do |var|
+      self.class_eval("def self.#{var}=(value); @@#{var} = value; end")
+      self.class_eval("def self.#{var}; @@#{var}; end")
+    end
+
+    def self.load_defaults
+      if defined?(Rails) # Rails defaults
+        self.environments = Dir.glob("#{Rails.root}/config/environments/*.rb").map { |filename| File.basename(filename, ".rb") } # for extraction
+        self.base_dir = "#{Rails.root}/config"
+        self.env = Rails.env
+        self.use_cache = Rails.env != "development"
+      end
+    end
+
+    load_defaults # load defaults by default
+  end
+
+  def self.configure(&block)
+    Qonf::Config.instance_eval(&block)
+  end
 
   # Qonf.name -> Qonf.get(:qonf, [:name]) for quick short-hand
   def self.method_missing(method)
@@ -26,23 +52,31 @@ module Qonf
     raise "Invalid config" unless config =~ /^\w+$/
     config = config.to_sym
 
-    if !Rails.env.development? && @@cache[config.to_sym] # don't cache in development
+    # Do we just use cached version?
+    if !Qonf::Config.use_cache || !@@cache.has_key?(config.to_sym)
+      base_path = "#{Qonf::Config.base_dir}/#{config}"
 
-    else
-      base_path = "#{Rails.root}/config/#{config}"
-
-      formats = {
-        yml: ->(f){ YAML.load(f) },
-        json: ->(f){ JSON(f.read) }
-      }
+      formats={}
+      formats[:yml] = ->(f){ YAML.load(f) } if defined?(YAML)
+      formats[:json] = ->(f){ JSON(f.read) } if defined?(JSON)
+      raise "Must include JSON or YAML parser" if formats.keys.count == 0
 
       formats.each do |ext,parser|
         if File.exists?("#{base_path}.#{ext}")
           cache = parser.call(File.open("#{base_path}.#{ext}"))
           raise "Invalid Qonf; must be hash" unless cache.is_a?(Hash)
-          cache = cache.deep_symbolize_keys! # Let's do this as symbols
-          cache.deep_merge!(cache.delete(Rails.env.to_sym)) if cache.has_key?(Rails.env.to_sym) # Now merge anything under current env
-          @@environments.each { |env| cache.delete(env.to_sym) } # And remove any other env keys
+          cache = symbolize_keys(cache) # Let's do this as symbols
+
+          # Do we use env key? (e.g. "development")
+          if Qonf::Config.env
+            # TODO: This should be a deep merge?
+            cache.merge!(cache.delete(Qonf::Config.env.to_sym)) if cache.has_key?(Qonf::Config.env.to_sym) # Now merge anything under current env
+          end
+
+          # Remove any other envs (e.g. "staging")
+          Qonf::Config.environments.each do |environment|
+            cache.delete(environment.to_sym)
+          end
           
           @@cache[config.to_sym] = cache # Store
 
@@ -50,10 +84,10 @@ module Qonf
         end
       end
       
-      raise "Unable to find config for #{config} in #{Rails.root}/config/*.{#{formats.keys.join(',')}}" if @@cache[config.to_sym].nil?
+      raise "Unable to find config for #{config} in #{base_path}/*.{#{formats.keys.join(',')}}" if @@cache[config.to_sym].nil?
     end
     
-    return get_route(@@cache[config.to_sym], route)  
+    return get_route(@@cache[config.to_sym], route)
   end
 
   def self.reset!
@@ -68,4 +102,19 @@ module Qonf
       # TODO: Do we want to accept _ for -?
       return Qonf.get_route(hash[route.shift.to_sym], route) # Recursive, yo!
     end
+
+    def self.symbolize_keys(hash)
+      hash.inject({}) do |result, (key, value)|
+        new_key = case key
+                  when String then key.to_sym
+                  else key
+                  end
+        new_value = case value
+                    when Hash then symbolize_keys(value)
+                    else value
+                    end
+        result[new_key] = new_value
+        result
+      end
+    end
 end

data/qonf.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/spec/qonf_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'json'
+
+describe 'qonf examples' do
+
+  it 'should configure correctly' do
+    Qonf.configure do
+      self.base_dir = "."
+    end
+
+    expect(Qonf::Config.base_dir).to eq(".")
+    expect(Qonf::Config.environments).to eq([])
+  end
+
+  it 'should use Rails config if available' do
+    begin
+      Rails = double("rails", root: 'root', env: 'staging')
+      Qonf::Config.load_defaults
+
+      expect(Qonf::Config.base_dir).to eq("root/config")
+      expect(Qonf::Config.environments).to eq([]) # TODO: Test "environments"
+      expect(Qonf::Config.env).to eq("staging")
+      expect(Qonf::Config.use_cache).to eq(true)
+    ensure
+      Object.send(:remove_const, 'Rails')
+    end
+  end
+
+  it 'should read from correct file path' do
+    Qonf.configure do
+      self.base_dir = "./examples"
+    end
+
+    expect(Qonf.get(:simple, :name)).to eq("Bob Jones")
+  end
+
+  it 'should work with environments' do
+    Qonf.configure do
+      self.base_dir = "./examples"
+      self.environments = ['test','production']
+      self.env = 'production'
+    end
+
+    expect(Qonf.get(:environed, :name)).to eq("Steve")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'qonf'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qonf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Geoff Hayes
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Qonf is a simple configuration management tool
 email:
 - hayesgm@gmail.com
@@ -46,13 +60,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/environed.json
+- examples/simple.json
 - lib/qonf.rb
 - lib/qonf/version.rb
 - qonf.gemspec
+- spec/qonf_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -78,4 +97,6 @@ signing_key:
 specification_version: 4
 summary: Simplest use case, add config/qonf.json or config/qonf.yaml and call Qonf.key
   to pull key from config file.  And much more.
-test_files: []
+test_files:
+- spec/qonf_spec.rb
+- spec/spec_helper.rb