rbrc 0.0.1

data/README.md

@@ -0,0 +1,32 @@
+# rbrc #
+
+App config helpers for ruby apps.
+
+## Install ##
+
+Install with gem
+
+    gem install rbrc
+
+Or add to your Gemfile
+
+    gem 'rbrc'
+
+Or get it from `master`
+
+    git clone 'https://github.com/mikebannister/rbrc
+    cd rbrc
+    gem install ./rbrc.gemspec
+
+## Usage ##
+
+Register a config file somewhere in your app
+
+    require 'rbrc'
+
+    register_config(:my_app)
+
+Now you can access the config file values like this
+
+    MyAppConfig.password #=> 'secret_password'
+

data/Rakefile

@@ -0,0 +1,26 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Importable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+task :default => 'spec'

data/lib/rbrc.rb

@@ -0,0 +1,8 @@
+require 'rbrc/shortcut_class'
+require 'rbrc/registry'
+require 'rbrc/config'
+
+module Rbrc
+  class ConfigFileDoesNotExistError < Exception
+  end
+end

data/lib/rbrc/config.rb

@@ -0,0 +1,31 @@
+require 'active_support/inflector'
+require 'parseconfig'
+
+module Rbrc
+  class Config
+    def initialize(name)
+      @name = name
+      raise ConfigFileDoesNotExistError unless File.exist?(file_path)
+
+      init_shortcut_class
+    end
+
+    def file_path
+      @file_path ||= File.expand_path("~/.#{@name}rc")
+    end
+
+    def values
+      ParseConfig.new(file_path).params
+    end
+
+    def [](key)
+      values[key.to_s]
+    end
+
+    def init_shortcut_class
+      helper_name = "#{@name.to_s.camelize}Config".to_sym
+      shortcut_class = Class.new(Rbrc::ShortcutClass)
+      Object.const_set(helper_name, shortcut_class)
+    end
+  end
+end

data/lib/rbrc/registry.rb

@@ -0,0 +1,14 @@
+module Rbrc
+  class Registry
+    class << self
+      def register_config(name)
+        @configs ||= {}
+        @configs[name] = Config.new(name)
+      end
+
+      def [](name)
+        @configs[name] if @configs
+      end
+    end
+  end
+end

data/lib/rbrc/shortcut_class.rb

@@ -0,0 +1,26 @@
+module Rbrc
+  class ShortcutClass
+    class << self
+      def method_missing(sym, *args, &block)
+        @sym = sym
+        if config_exists? and
+          return config[sym]
+        end
+        super(sym, *args, &block)
+      end
+
+      # get :Foo from FooConfig
+      def config_name
+        self.name.slice(0..-7).underscore.to_sym
+      end
+
+      def config
+        Registry[config_name]
+      end
+
+      def config_exists?
+        !!config
+      end
+    end
+  end
+end

data/lib/rbrc/version.rb

@@ -0,0 +1,3 @@
+module Rbrc
+  VERSION = "0.0.1"
+end

data/spec/config_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module Rbrc
+  describe Config do
+    before(:each) do
+      # Note: FakeFS activated globally in spec_helper
+      FileUtils.mkdir_p File.expand_path('~')
+      FileUtils.touch File.expand_path('~/.foorc')
+      FileUtils.touch File.expand_path('~/.barrc')
+    end
+
+    describe "#initialize" do
+      it "should throw an error if the file doesn't exist" do
+        FileUtils.rm File.expand_path('~/.foorc')
+
+        lambda {
+          Config.new(:foo)
+        }.should raise_error Rbrc::ConfigFileDoesNotExistError
+      end
+
+      it "should activate a shortcut class for accessing config values globally" do
+        FakeFS.deactivate!
+        Config.any_instance.stubs(:file_path).returns('/Users/mike/work/rbrc/spec/files/foorc')
+
+        Registry.register_config :foo
+
+        FooConfig.should be_a ShortcutClass.class
+      end
+    end
+
+    describe "#file_path" do
+      it "should return the path to the config file" do
+        config = Config.new(:foo)
+        relative_path = config.file_path.split('/').last
+
+        relative_path.should eq '.foorc'
+      end
+    end
+
+    describe "#values" do
+      it "should return values from the config file" do
+        FakeFS.deactivate!
+        Config.any_instance.stubs(:file_path).returns('/Users/mike/work/rbrc/spec/files/foorc')
+
+        config = Config.new(:foo)
+        expected_values = {
+          'moof' => 'doof',
+          'foof' => 'toof'
+        }
+        config.values.should eq expected_values
+      end
+    end
+
+    describe "#[]" do
+      it "should return for specified config key" do
+        FakeFS.deactivate!
+        Config.any_instance.stubs(:file_path).returns('/Users/mike/work/rbrc/spec/files/foorc')
+
+        Registry.register_config :foo
+
+        FooConfig.moof.should == 'doof'
+        FooConfig.foof.should == 'toof'
+      end
+    end
+  end
+end

data/spec/files/foorc

@@ -0,0 +1,2 @@
+moof = doof
+foof = toof

data/spec/registry_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module Rbrc
+  describe Registry do
+    describe "#register_config" do
+      it "should add a config object to the registry for each registered config" do
+        # Note: FakeFS activated globally in spec_helper
+        FileUtils.mkdir_p File.expand_path('~')
+        FileUtils.touch File.expand_path('~/.foorc')
+        FileUtils.touch File.expand_path('~/.barrc')
+
+        Registry.register_config(:foo)
+        Registry.register_config(:bar)
+        Registry[:foo].should be_a Rbrc::Config
+        Registry[:bar].should be_a Rbrc::Config
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'fakefs/spec_helpers'
+
+require File.expand_path("../../lib/rbrc", __FILE__)
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.include FakeFS::SpecHelpers
+
+  config.before(:each) do
+    FakeFS.activate!
+  end
+
+  config.after(:each) do
+    FakeFS.deactivate!
+    FakeFS::FileSystem.clear
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: rbrc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Bannister
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parseconfig
+  requirement: &70154352504120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70154352504120
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70154352502920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70154352502920
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70154352501640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70154352501640
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70154352500820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70154352500820
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70154352499360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :development
+  prerelease: false
+  version_requirements: *70154352499360
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: &70154352497460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70154352497460
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70154352495680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70154352495680
+description: App config helpers for ruby apps.
+email:
+- mikebannister@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rbrc/config.rb
+- lib/rbrc/registry.rb
+- lib/rbrc/shortcut_class.rb
+- lib/rbrc/version.rb
+- lib/rbrc.rb
+- Rakefile
+- README.md
+- spec/config_spec.rb
+- spec/files/foorc
+- spec/registry_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mikebannister/rbrc
+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'
+      segments:
+      - 0
+      hash: -2253627055374088253
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2253627055374088253
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: App config helpers for ruby apps.
+test_files:
+- spec/config_spec.rb
+- spec/files/foorc
+- spec/registry_spec.rb
+- spec/spec_helper.rb