config_module 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ff9be2b58fa4690a4341b05c51578ca4066810c
+  data.tar.gz: 0c6aeb9814bf45f447b86091c869804954909a3b
+SHA512:
+  metadata.gz: 9308b74b9f72f8c1f58384cb6063ed8736349628b5e30d338fa7f42290f5aabfc2e87e0b76f1c9b8ca1c2685d9bff2c13525d93db915cffd6639d5560e0e159a
+  data.tar.gz: 083a6b61d0e40931f2335ef76b02db1e07bbca73cb8523f0667247f1650b0938fb0dae2a00669c80a39f1577200f80bc56d74c733165ae554d5466469395d26f

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ruby-2.0.0-p0@config_module

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in config_module.gemspec
 gemspec
+
+gem 'uspec', git: '../uspec'

data/config_module.gemspec

@@ -16,4 +16,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-theme'
 end

data/lib/config_module.rb

@@ -1,71 +1,38 @@
-require_relative 'config_module/version'
 require 'ostruct'
 require 'yaml'
+require 'pry'
+
+require_relative 'config_module/version'
+require_relative 'config_module/exceptions'
+require_relative 'config_module/config_option'
+require_relative 'config_module/config_helper'
 
 module ConfigModule
   def [] key
-    config.send key
+    __config_module_helper.config.send key
   end
 
   def config
-    @config ||= ConfigOption.wrap load_config
+    __config_module_helper.config
   end
 
 protected
 
-  def config_file file
-    @config_file = file
+  def config_file new_config_file
+    __config_module_helper.config_file = new_config_file
   end
 
-  def namespace *name
-    @namespace = Array name
+  def namespace *new_namespace
+    __config_module_helper.namespaces = *new_namespace
   end
 
 private
 
-  def namespaced?
-    !(@namespace.nil? || @namespace.empty?)
-  end
-
-  def load_config
-    file = YAML.load_file(@config_file)
-
-    if namespaced? then
-      @namespace.inject(file) do |file, ns|
-        file.include?(ns) && file[ns] || file.include?(ns.to_sym) && file[ns.to_sym]
-      end
-    else
-      file
-    end
+  def __config_module_helper
+    @__config_module_helper ||= ConfigHelper.new
   end
 
   def method_missing name
-    ConfigOption.wrap config.get name
-  rescue NoMethodError => error
-    if error.name == name then
-      raise NoMethodError, "undefined method `#{name}' for #{self}", caller(1)
-    else
-      raise
-    end
-  end
-
-  class ConfigOption < OpenStruct
-    def self.wrap data
-      if data.is_a? Hash then
-        ConfigOption.new data
-      else
-        data
-      end
-    end
-
-    def get name
-      if @table.include? name then
-        self.class.wrap @table[name]
-      else
-        raise ConfigOption::NotFound
-      end
-    end
-
-    class NotFound < RangeError; end
+    __config_module_helper.method_missing_handler name, caller(1)
   end
 end

data/lib/config_module/config_helper.rb

@@ -0,0 +1,40 @@
+module ConfigModule
+  class ConfigHelper
+    attr :raw_config
+    attr_accessor :config_file, :namespaces
+
+    def config
+      @config ||= ConfigOption.wrap load_config
+    end
+
+    def method_missing_handler name, source
+      config.send name
+    rescue NoMethodError => error
+      if error.name == name then
+        raise # ConfigOption::NotFoundError.new(name, source)#, source
+      else
+        raise
+      end
+    end
+
+    def load_config
+      @raw_config = YAML.load_file config_file
+
+      load_namespaces_from raw_config
+    end
+
+    def load_namespaces_from tree
+      return tree unless namespaced?
+
+      Array(namespaces).inject(ConfigOption.wrap tree) do |subtree, ns|
+        raise(InvalidNamespaceError.new(ns, subtree)) unless subtree.respond_to? ns
+
+        subtree.send ns
+      end
+    end
+
+    def namespaced?
+      !(namespaces.nil? || namespaces.empty?)
+    end
+  end
+end

data/lib/config_module/config_option.rb

@@ -0,0 +1,41 @@
+module ConfigModule
+  class ConfigOption < OpenStruct
+    include Enumerable
+
+    def self.wrap data
+      if data.is_a? Hash then
+        ConfigOption.new data
+      else
+        data
+      end
+    end
+
+    def each
+      return to_enum __method__ unless block_given?
+      @table.each_pair{|p| yield p}
+    end
+
+    def method_missing name, *args, &block
+      result = super
+
+      if result || @table.include?(name) then
+        self.class.wrap result
+      else
+        raise ConfigOption::NotFoundError.new name, self
+      end
+    end
+
+    def new_ostruct_member name
+      name = name.to_sym
+      unless respond_to? name
+        define_singleton_method(name) { self.class.wrap @table[name] }
+        define_singleton_method("#{name}=") { |x| modifiable[name] = x }
+      end
+      name
+    end
+
+    class NotFoundError < ::ConfigModule::ConfigError
+      def identifier; :key; end
+    end
+  end
+end

data/lib/config_module/exceptions.rb

@@ -0,0 +1,21 @@
+module ConfigModule
+  class ConfigError < NoMethodError
+    def initialize name, object
+      @name, @object = name, object
+      super "invalid #{identifier} `#{name}' for #{object_info}"
+    end
+    attr :name, :object
+
+    def object_info
+      if object.is_a?(Class) then
+        object.name
+      else
+        "instance of `#{object.class} < #{object.class.superclass}'"
+      end
+    end
+  end
+
+  class InvalidNamespaceError < ConfigError
+    def identifier; :namespace; end
+  end
+end

data/lib/config_module/version.rb

@@ -1,3 +1,3 @@
 module ConfigModule
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/config/example.yml

@@ -0,0 +1,6 @@
+---
+production:
+  foo: bar
+  noodle: boom!
+  dictionary:
+    configuration: An arrangement of elements in a particular form, figure, or combination.

data/spec/config_helper_spec.rb

@@ -0,0 +1,16 @@
+require_relative 'spec_helper'
+
+hash = {a: {b: 5}}
+opt = ConfigModule::ConfigOption.new hash
+
+spec 'ConfigOptions are Enumerable' do
+  opt.map{|k,v| v[:b]} == [5]
+end
+
+spec 'to_ary' do
+  begin
+    opt.to_ary
+  rescue NoMethodError => error
+    error.class == ConfigModule::ConfigOption::NotFoundError
+  end
+end

data/{test/test.rb → spec/config_module_spec.rb}

@@ -1,12 +1,6 @@
-require_relative 'mutest'
-extend Mutest
-
-require_relative '../lib/config_module'
-module Rails; def self.env; 'production'; end; end
+require_relative 'spec_helper'
 require_relative 'example_config'
 
-Dir.chdir File.dirname(__FILE__)
-
 spec 'modules extended with ConfigModule will load configurations' do
   ExampleConfig.foo == 'bar'
 end
@@ -15,12 +9,12 @@ spec 'modules extended with ConfigModule have "namespace" methods' do
   ExampleConfig.methods.include? :namespace
 end
 
-spec 'nested hash values are properly wrapped' do
-  ExampleConfig.dictionary.class == ConfigModule::ConfigOption
+spec 'config modules have [] methods' do
+  ExampleConfig.respond_to? :[]
 end
 
-spec 'config modules have [] methods' do
-  ExampleConfig[:dictionary].keys.include? :configuration
+spec 'nested hash values are properly wrapped' do
+  ExampleConfig.dictionary.class == ConfigModule::ConfigOption
 end
 
 spec 'subkeys are accessible with methods' do
@@ -43,7 +37,7 @@ end
 spec 'missing keys raise exception when called as methods' do
   begin
     FalseNil.nonexistant
-  rescue ConfigModule::ConfigOption::NotFound
+  rescue ConfigModule::ConfigOption::NotFoundError
     true
   end
 end
@@ -57,3 +51,17 @@ end
 spec 'multiple namespaces can be set' do
   MultipleExample.configuration == ExampleConfig.dictionary.configuration
 end
+
+module InvalidNamespaceExample
+  extend ConfigModule
+  config_file './config/example.yml'
+  namespace :jimmy, :pop, :ali
+end
+
+spec 'incorrect namespaces raise informative errors' do
+  begin
+    InvalidNamespaceExample.whatever
+  rescue => error
+    error.class == ConfigModule::InvalidNamespaceError
+  end
+end

data/spec/namespace_spec.rb

@@ -0,0 +1,23 @@
+require_relative 'spec_helper'
+
+def self.helper
+  if @helper then @helper
+  else
+    @helper = ConfigModule::ConfigHelper.new
+    @helper.config_file = './config/example.yml'
+    @helper.namespaces = 'production'
+    @helper.config
+    @helper
+  end
+end
+
+table = helper.load_config.instance_variable_get(:@table)
+
+spec 'namespaces obtain subtrees of the full config' do
+  table.keys == [:foo, :noodle, :dictionary]
+end
+
+spec 'specifying a namespace forces #config to return that subtree the first time its called' do
+  symbolized_keys_from_full_config = helper.raw_config['production'].keys.map(&:to_sym)
+  symbolized_keys_from_full_config == table.keys
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'uspec'
+
+Dir.chdir File.dirname(__FILE__)
+
+require_relative '../lib/config_module'
+
+extend Uspec
+
+module Rails; def self.env; 'production'; end; end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: config_module
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Anthony Cook
@@ -10,7 +9,35 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-02-27 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-theme
+  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: Wrap a configuration file in a module for easy use throughout your application.
   Inspired by Rails.
 email:
@@ -20,45 +47,51 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - Gemfile
 - README.markdown
 - Rakefile
 - config_module.gemspec
 - lib/config_module.rb
+- lib/config_module/config_helper.rb
+- lib/config_module/config_option.rb
+- lib/config_module/exceptions.rb
 - lib/config_module/version.rb
-- test/config/example.yml
-- test/config/false_nil.yml
-- test/example_config.rb
-- test/mutest.rb
-- test/test.rb
+- spec/config/example.yml
+- spec/config/false_nil.yml
+- spec/config_helper_spec.rb
+- spec/config_module_spec.rb
+- spec/example_config.rb
+- spec/namespace_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/acook/config_module
 licenses: []
+metadata: {}
 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.25
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Load important configuration files into their own modules!
 test_files:
-- test/config/example.yml
-- test/config/false_nil.yml
-- test/example_config.rb
-- test/mutest.rb
-- test/test.rb
-has_rdoc: 
+- spec/config/example.yml
+- spec/config/false_nil.yml
+- spec/config_helper_spec.rb
+- spec/config_module_spec.rb
+- spec/example_config.rb
+- spec/namespace_spec.rb
+- spec/spec_helper.rb

data/test/config/example.yml

@@ -1,6 +0,0 @@
----
-:production:
-  :foo: bar
-  :noodle: boom!
-  :dictionary:
-    :configuration: An arrangement of elements in a particular form, figure, or combination.

data/test/mutest.rb

@@ -1,112 +0,0 @@
-module Mutest
-  def spec description
-    print ' -- ', description
-
-    return puts(': ' + yellow('pending') + vspace) unless block_given?
-
-    begin
-      result = yield
-    rescue => result
-    end
-
-    print ': ', colorize(result, caller), "\n"
-  end
-
-  module Color
-
-    def colors
-      {
-        red: 1,
-        green: 2,
-        yellow: 3,
-        white: 7
-      }
-    end
-
-    def color hue, text = nil
-      esc("3#{colors[hue]};1") + "#{text}#{normal if text}"
-    end
-
-    def esc seq
-      "\e[#{seq}m"
-    end
-
-    def normal text=nil
-      esc(0) + text.to_s
-    end
-
-    def colorize result, source
-      if result == true then
-        green result
-      elsif result == false then
-        red result
-      elsif result.is_a? Exception then
-        [
-          red('Exception'), vspace,
-          hspace, 'Spec encountered an Exception ', newline,
-          hspace, 'in spec at ', source.first, vspace,
-          hspace, message(result), vspace,
-          white(trace result)
-        ].join
-      else
-        [
-          red('Unknown Result'), vspace,
-          hspace, 'Spec did not return a boolean value ', newline,
-          hspace, 'in spec at ', source.first, vspace,
-          hspace, red(classinfo(result)), result.inspect, newline
-        ].join
-      end
-    end
-
-    def trace error
-      error.backtrace.inject(String.new) do |text, line|
-        text << hspace + line + newline
-      end
-    end
-
-    def message error
-      red(classinfo error) + error.message
-    end
-
-    def classinfo object
-      "#{classify object} < #{superclass object}: "
-    end
-
-    def classify object
-      object.is_a?(Module) ? object : object.class
-    end
-
-    def superclass object
-      classify(object).superclass
-    end
-
-    def hspace
-      '    '
-    end
-
-    def vspace
-      newline + newline
-    end
-
-    def newline
-      $/
-    end
-
-    private
-
-    def method_missing name, *args, &block
-      if colors.keys.include? name then
-        color name, *args
-      else
-        super
-      end
-    end
-
-  end
-
-  private
-
-  include Color
-end
-
-