rock_config 0.0.0 → 0.0.1

data/Rakefile

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

data/lib/rock_config/config.rb

@@ -0,0 +1,21 @@
+module RockConfig
+  class Config
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def method_missing(*args, &block)
+      if value = @hash[args.first.to_s]
+        if Hash === value
+          Config.new(value)
+        else
+          value
+        end
+      end
+    end
+
+    def raw
+      @hash.dup
+    end
+  end
+end

data/lib/rock_config/configuration.rb

@@ -1,10 +1,10 @@
 module RockConfig
   class Configuration
-    attr_accessor :scanned_directories
+    attr_accessor :scanned_directories, :config_loaders
 
     def initialize
-      default_directory = File.join(Dir.pwd, "config")
-      @scanned_directories = [default_directory]
+      @scanned_directories = []
+      @config_loaders = []
     end
   end
 end

data/lib/rock_config/manager.rb

@@ -1,5 +1,3 @@
-require "rock_config/scanner"
-
 module RockConfig
   class Manager
     def initialize(configuration, scanner = Scanner)
@@ -9,9 +7,7 @@ module RockConfig
 
     def fetch(config_name, environment)
       if config = @configs[config_name]
-        config.for_environment environment
-      else
-        yield if block_given?
+        config.send environment
       end
     end
 
@@ -22,5 +18,6 @@ module RockConfig
         end
       end
     end
+
   end
 end

data/lib/rock_config/scanner.rb

@@ -5,22 +5,15 @@ module RockConfig
     end
 
     def find(file_name)
-      full_file_name = resolve_full_file_name(file_name)
-
       @configuration.scanned_directories.each do |directory|
-        file = File.join(directory, full_file_name)
-        if File.exists? file
-          return File.read file
+        @configuration.config_loaders.each do |loader|
+          if config = loader.find_at(directory, file_name)
+            return config
+          end
         end
       end
 
-      nil
-    end
-
-    private
-
-    def resolve_full_file_name(file_name)
-      "#{file_name}.yml"
+      raise ConfigNotFound, "Config not found"
     end
   end
 end

data/lib/rock_config/version.rb

@@ -1,3 +1,3 @@
 module RockConfig
-  VERSION = "0.0.0"
+  VERSION = "0.0.1"
 end

data/lib/rock_config/yaml_loader.rb

@@ -0,0 +1,31 @@
+require "yaml"
+
+module RockConfig
+  class YamlLoader
+    def find_at(directory, file_name)
+      path = full_path(directory, file_name)
+
+      if readable?(path)
+        return Config.new(load_yaml_from(path))
+      end
+    end
+
+    private
+
+    def full_path(directory, file_name)
+      File.join(directory, full_name(file_name))
+    end
+
+    def full_name(file_name)
+      "#{file_name}.yml"
+    end
+
+    def readable?(path)
+      File.exists?(path) && File.readable?(path)
+    end
+
+    def load_yaml_from(path)
+      YAML.load_file(path)
+    end
+  end
+end

data/lib/rock_config.rb

@@ -2,15 +2,16 @@ require "rock_config/version"
 require "rock_config/environment_detector"
 require "rock_config/configuration"
 require "rock_config/manager"
+require "rock_config/scanner"
+require "rock_config/yaml_loader"
+require "rock_config/config"
 
 module RockConfig
   class ConfigNotFound < Exception; end
 
   class << self
     def for(config_name, environment = detect_environment)
-      manager.fetch(config_name, environment) do
-        raise ConfigNotFound, "Config not found"
-      end
+      manager.fetch(config_name, environment)
     end
 
     def configure
@@ -28,7 +29,16 @@ module RockConfig
     end
 
     def configuration
-      @configuration ||= Configuration.new
+      @configuration ||= initialize_configuration
+    end
+
+    def initialize_configuration
+      configuration = Configuration.new
+
+      configuration.scanned_directories << File.join(Dir.pwd, "config")
+      configuration.config_loaders << YamlLoader.new
+
+      configuration
     end
 
     def manager

data/spec/config_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+module RockConfig
+  describe Config do
+    it "accepts a hash" do
+      hash = {foo: "bar"}
+
+      config = Config.new(hash)
+      config.raw.should eq(hash)
+    end
+
+    it "returns config for given environment" do
+      subhash_dev  = {"a" => 123}
+      subhash_prod = {"a" => 321}
+      hash = {
+        "development" => subhash_dev,
+        "production"  => subhash_prod
+      }
+
+      config = Config.new(hash)
+      config.development.raw.should eq(subhash_dev)
+      config.production.raw.should eq(subhash_prod)
+    end
+
+    it "returns nil when asked for non existing environment" do
+      config = Config.new({})
+      config.for_environment("I do not exist").should be_nil
+    end
+
+    it "returns correct values when asked for" do
+      hash = {
+        "development" => {
+          "host" => "localhost"
+        }
+      }
+
+      config = Config.new(hash)
+      config.development.host.should eq("localhost")
+    end
+
+    it "returns correct nested values when asked for" do
+      hash = {
+        "development" => {
+          "elastic" => {
+            "host" => "localhost"
+          }
+        }
+      }
+
+      config = Config.new(hash)
+      config.development.elastic.host.should eq("localhost")
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -2,16 +2,18 @@ require "spec_helper"
 
 module RockConfig
   describe Configuration do
-    it "has default scanned directory" do
-      configuration = Configuration.new
-      configuration.scanned_directories.count.should eq 1
-    end
-
     it "accepts scanned directories" do
       configuration = Configuration.new
 
       configuration.scanned_directories << "/custom/path"
       configuration.scanned_directories.should include "/custom/path"
     end
+
+    it "accepts config loaders" do
+      configuration = Configuration.new
+
+      configuration.config_loaders << "duck"
+      configuration.config_loaders.should include "duck"
+    end
   end
 end

data/spec/fixtures/database_invalid.yml

@@ -0,0 +1,8 @@
+development
+  magic_number: 213
+
+test:
+  magic_number: 214
+
+production:
+  magic_number: 215

data/spec/manager_spec.rb

@@ -2,35 +2,30 @@ require "spec_helper"
 
 module RockConfig
   describe Manager do
-    before do
-      @configuration = Configuration.new
-    end
+    let(:configuration) { Configuration.new }
 
     it "returns config if found" do
-      result = double("Config")
-      result.should_receive(:for_environment).with("development").and_return("yay")
+      result = mock("Config")
+      result.should_receive(:send).with("development") { "yay" }
 
-      scanner = double("Scanner")
-      scanner.should_receive(:new).with(@configuration).and_return(scanner)
-      scanner.should_receive(:find).with("sample").and_return(result)
+      scanner = mock("Scanner")
+      scanner.should_receive(:new) .with(configuration) { scanner }
+      scanner.should_receive(:find).with("sample")      { result }
 
-      manager         = Manager.new(@configuration, scanner)
+      manager         = Manager.new(configuration, scanner)
       manager_result  = manager.fetch "sample", "development"
 
       manager_result.should eq("yay")
     end
 
-    it "yields if config not found" do
-      scanner = double("Scanner")
-      scanner.should_receive(:new).with(@configuration).and_return(scanner)
-      scanner.should_receive(:find).with("sample").and_return(nil)
-
-      manager = Manager.new(@configuration, scanner)
-      lambda do
-        manager_result = manager.fetch "sample", "development" do
-          raise Exception
-        end
-      end.should raise_error(Exception)
+    it "returns nul if config not found" do
+      scanner = mock("Scanner")
+      scanner.should_receive(:new) .with(configuration) { scanner }
+      scanner.should_receive(:find).with("sample")      { nil }
+
+      manager = Manager.new(configuration, scanner)
+
+      manager.fetch("sample", "development").should be_nil
     end
   end
 end

data/spec/rock_config_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+module RockConfig
+  describe RockConfig do
+    it "it loads valid configs" do
+      RockConfig.configure do |config|
+        config.scanned_directories << File.join(Dir.pwd, "spec", "fixtures")
+        config.config_loaders << YamlLoader.new
+      end
+
+      RockConfig.for("database", "development").magic_number.should eq(213)
+    end
+  end
+end

data/spec/scanner_spec.rb

@@ -2,21 +2,24 @@ require "spec_helper"
 
 module RockConfig
   describe Scanner do
-    it "finds nothing when the target doesnt exist" do
+    let(:configuration) do
       configuration = Configuration.new
-      scanner       = Scanner.new(configuration)
+      configuration.scanned_directories << File.join(Dir.pwd, "config")
+      configuration.config_loaders << YamlLoader.new
+      configuration
+    end
 
-      scanner.find("database").should be_nil
+    let(:scanner)       { Scanner.new(configuration) }
+    let(:fixtures_path) { File.join(Dir.pwd, "spec", "fixtures") }
+
+    it "finds nothing when the target doesnt exist" do
+      expect do
+        scanner.find("database")
+      end.to raise_error(ConfigNotFound)
     end
 
     it "scans additional directories" do
-      fixtures_path = File.join(Dir.pwd, "spec", "fixtures")
-
-      configuration = Configuration.new
       configuration.scanned_directories << fixtures_path
-
-      scanner = Scanner.new(configuration)
-
       scanner.find("database").should_not be_nil
     end
   end

data/spec/yaml_loader_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+module RockConfig
+  describe YamlLoader do
+    it "loads config when given valid path and filename" do
+      directory = File.join(Dir.pwd, "spec", "fixtures") 
+
+      loader = YamlLoader.new
+      config = loader.find_at(directory, "database")
+
+      config.should_not be_nil
+    end
+
+    it "throws exception when given valid path to an invalid file" do
+      directory = File.join(Dir.pwd, "spec", "fixtures") 
+      loader = YamlLoader.new
+
+      expect do
+        config = loader.find_at(directory, "database_invalid")
+      end.to raise_error(Psych::SyntaxError)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rock_config
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -73,18 +73,24 @@ files:
 - README.md
 - Rakefile
 - lib/rock_config.rb
+- lib/rock_config/config.rb
 - lib/rock_config/configuration.rb
 - lib/rock_config/environment_detector.rb
 - lib/rock_config/manager.rb
 - lib/rock_config/scanner.rb
 - lib/rock_config/version.rb
+- lib/rock_config/yaml_loader.rb
 - rock_config.gemspec
+- spec/config_spec.rb
 - spec/configuration_spec.rb
 - spec/environment_detector_spec.rb
 - spec/fixtures/database.yml
+- spec/fixtures/database_invalid.yml
 - spec/manager_spec.rb
+- spec/rock_config_spec.rb
 - spec/scanner_spec.rb
 - spec/spec_helper.rb
+- spec/yaml_loader_spec.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -110,10 +116,14 @@ signing_key:
 specification_version: 3
 summary: RockConfig allows you to use custom config files easily.
 test_files:
+- spec/config_spec.rb
 - spec/configuration_spec.rb
 - spec/environment_detector_spec.rb
 - spec/fixtures/database.yml
+- spec/fixtures/database_invalid.yml
 - spec/manager_spec.rb
+- spec/rock_config_spec.rb
 - spec/scanner_spec.rb
 - spec/spec_helper.rb
+- spec/yaml_loader_spec.rb
 has_rdoc: