rock_config 0.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rock_config.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jiri Pospisil
+
+MIT License
+
+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

@@ -0,0 +1,54 @@
+# RockConfig
+
+RockConfig is a simple convention based library for reading and accessing config files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "rock_config"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rock_config
+
+## Usage
+
+Given the file elastic_search.yml:
+
+    development:
+      host: 127.0.0.1
+      port: 9200
+
+    production:
+      host: 192.168.1.10
+      port: 9200
+
+RockConfig allows you to read these settings with an API like this:
+
+    elastic_config = RockConfig.for :elastic_search
+    elastic_config.host # > 127.0.0.1
+
+RockConfig automatically chooses the current application environment. You select the environment yourself
+with: 
+
+    RockConfig.for :elastic_search, :production
+
+RockConfig scans predefined directories for config files. By default, it tries to scan directory
+`config` in the project root. You can add more directories:
+
+    RockConfig.configure do |config|
+      config.scanned_directories << "custom_path"
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rock_config/configuration.rb

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

data/lib/rock_config/environment_detector.rb

@@ -0,0 +1,11 @@
+module RockConfig
+  class EnvironmentDetector
+    def initialize(environment)
+      @environment = environment
+    end
+
+    def detect
+      @environment["RAILS_ENV"] || @environment["RACK_ENV"] || "development"
+    end
+  end
+end

data/lib/rock_config/manager.rb

@@ -0,0 +1,26 @@
+require "rock_config/scanner"
+
+module RockConfig
+  class Manager
+    def initialize(configuration, scanner = Scanner)
+      @scanner = scanner.new(configuration)
+      @configs = initialize_configs
+    end
+
+    def fetch(config_name, environment)
+      if config = @configs[config_name]
+        config.for_environment environment
+      else
+        yield if block_given?
+      end
+    end
+
+    def initialize_configs
+      Hash.new do |hash, key|
+        if config = @scanner.find(key)
+          hash[key] = config
+        end
+      end
+    end
+  end
+end

data/lib/rock_config/scanner.rb

@@ -0,0 +1,26 @@
+module RockConfig
+  class Scanner
+    def initialize(configuration)
+      @configuration = configuration
+    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
+        end
+      end
+
+      nil
+    end
+
+    private
+
+    def resolve_full_file_name(file_name)
+      "#{file_name}.yml"
+    end
+  end
+end

data/lib/rock_config/version.rb

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

data/lib/rock_config.rb

@@ -0,0 +1,38 @@
+require "rock_config/version"
+require "rock_config/environment_detector"
+require "rock_config/configuration"
+require "rock_config/manager"
+
+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
+    end
+
+    def configure
+      yield configuration if block_given?
+      @manager = nil
+    end
+
+    private
+
+    def detect_environment
+      @detected_environment ||= lambda do
+        detector = EnvironmentDetector.new(ENV)
+        detector.detect
+      end.call
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def manager
+      @manager ||= Manager.new(configuration)
+    end
+  end
+end

data/rock_config.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rock_config/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jiri Pospisil"]
+  gem.email         = ["mekishizufu@gmail.com"]
+  gem.summary       = %q{RockConfig allows you to use custom config files easily.}
+  gem.description   = %q{RockConfig allows you to use custom config files easily.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rock_config"
+  gem.require_paths = ["lib"]
+  gem.version       = RockConfig::VERSION
+
+  gem.add_development_dependency "rspec", "~> 2.11.0"
+  gem.add_development_dependency "pry", "~> 0.9.10"
+  gem.add_development_dependency "pry-nav", "~> 0.2.2"
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,17 @@
+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
+  end
+end

data/spec/environment_detector_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+module RockConfig
+  describe EnvironmentDetector do
+    it "detects rails' environment" do
+      detector = EnvironmentDetector.new("RAILS_ENV" => "production")
+      detector.detect.should eq("production")
+    end
+
+    it "detects rack's environment" do
+      detector = EnvironmentDetector.new("RACK_ENV" => "production")
+      detector.detect.should eq("production")
+    end
+
+    it "fallbacks to development environment if no other specified" do
+      detector = EnvironmentDetector.new({})
+      detector.detect.should eq("development")
+    end
+  end
+end

data/spec/fixtures/database.yml

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

data/spec/manager_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+module RockConfig
+  describe Manager do
+    before do
+      @configuration = Configuration.new
+    end
+
+    it "returns config if found" do
+      result = double("Config")
+      result.should_receive(:for_environment).with("development").and_return("yay")
+
+      scanner = double("Scanner")
+      scanner.should_receive(:new).with(@configuration).and_return(scanner)
+      scanner.should_receive(:find).with("sample").and_return(result)
+
+      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)
+    end
+  end
+end

data/spec/scanner_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+module RockConfig
+  describe Scanner do
+    it "finds nothing when the target doesnt exist" do
+      configuration = Configuration.new
+      scanner       = Scanner.new(configuration)
+
+      scanner.find("database").should be_nil
+    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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "rock_config"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = "random"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rock_config
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jiri Pospisil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+description: RockConfig allows you to use custom config files easily.
+email:
+- mekishizufu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rock_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
+- rock_config.gemspec
+- spec/configuration_spec.rb
+- spec/environment_detector_spec.rb
+- spec/fixtures/database.yml
+- spec/manager_spec.rb
+- spec/scanner_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: RockConfig allows you to use custom config files easily.
+test_files:
+- spec/configuration_spec.rb
+- spec/environment_detector_spec.rb
+- spec/fixtures/database.yml
+- spec/manager_spec.rb
+- spec/scanner_spec.rb
+- spec/spec_helper.rb
+has_rdoc: