confuse 0.1.8 → 1.0.0

data/lib/confuse/source.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+module Confuse
+  module Source
+    class << self
+      def types
+        @types ||= { }
+      end
+
+      def create(options = {})
+        path = options[:path]
+
+        type = if path
+                 path[path.rindex('.') + 1, path.length].to_sym
+               end
+        type ||= options[:type]
+
+        if type
+          types[type].new(options)
+        else
+          Env.new(options)
+        end
+      end
+
+      def register(type, klass)
+        types[type] = klass
+      end
+    end
+  end
+end
+
+require 'confuse/source/ini'
+require 'confuse/source/yaml'
+require 'confuse/source/env'

data/lib/confuse/source/env.rb

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+module Confuse
+  module Source
+    class Env
+      def initialize(options = {})
+        @prefix = options[:prefix]
+      end
+
+      def [](namespace, key)
+        lookup = key
+        lookup = prepend(namespace, lookup) if namespace
+        lookup = prepend(@prefix, lookup) if @prefix
+
+        ENV[lookup.upcase]
+      end
+
+      private
+
+      def prepend(pref, key)
+        "#{pref}_#{key}" if pref
+      end
+    end
+
+    register(:env, Env)
+  end
+end
+

data/lib/confuse/source/ini.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+require 'inifile'
+
+module Confuse
+  module Source
+    class Ini
+      def initialize(options = {})
+        @ini = from_file(options[:path])
+      end
+
+      def from_file(file)
+        IniFile.load(file).to_h
+      rescue IniFile::Error
+        nil
+      end
+
+      def [](namespace, key)
+        namespace ||= :global
+        @ini[namespace.to_s][key.to_s]
+      end
+    end
+
+    register(:ini, Ini)
+  end
+end

data/lib/confuse/source/yaml.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+require 'yaml'
+
+module Confuse
+  module Source
+    class Yaml
+      def initialize(options = {})
+        @yaml = ::YAML.load_file(options[:path])
+      end
+
+      def [](namespace, key)
+        namespace ? @yaml[namespace][key] : @yaml[key]
+      end
+    end
+
+    register(:yml, Yaml)
+    register(:yaml, Yaml)
+  end
+end

data/lib/confuse/version.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+
+# Confuse version
 module Confuse
-  VERSION = '0.1.8'
+  VERSION = '1.0.0'
 end

data/test/test_config.rb

@@ -1,62 +1,45 @@
+# coding: utf-8
+
 require 'minitest/autorun'
-require 'confuse'
 
-# Test instance methods
 class TestConfig < MiniTest::Unit::TestCase
-  def setup
-    namespace = Confuse::Namespace.new do
-      define :baz do
-        default 1
-      end
+  def definition
+    @definition ||= Confuse.define do |conf|
+      conf.add_item :foo
+      conf.add_item :bar, :default => 'default'
+      conf.add_item :baz, :required => true
     end
-    @config = Confuse::Config
-    @config.load_namespaces({ :foo_bar => namespace })
   end
 
-  def test_find_namespace
-    assert_equal :foo_bar, @config.find_namespace(:foo_bar_baz)
+  def source
+    @source ||= Class.new do
+      def [](namespace, key)
+        'foo' if key == :foo
+      end
+    end.new
   end
 
-  def test_fine_namespace_no_sub_key
-    assert_equal :foo_bar, @config.find_namespace(:foo_bar)
+  def setup
+    @config = Confuse::Config.new(definition, source)
   end
 
-  def test_find_namespace_doesnt_exist
-    assert_equal nil, @config.find_namespace(:bar)
+  # gets a value from the source if it is defined, and in the source
+  def test_get_value_from_source
+    assert_equal 'foo', @config.foo
   end
 
-  def test_rest_of_key
-    assert_equal :bar, @config.rest_of_key(:foo_bar, :foo)
+  # returns the default value if the source returns nil
+  def test_get_default_from_definition
+    assert_equal 'default', @config.bar
   end
 
-  def test_rest_of_key_default_namespace
-    assert_equal :bar, @config.rest_of_key(:bar, :default)
+  # raises undefined if an item hasn't been set, and has no default
+  def test_get_default_from_definition
+    assert_nil @config.buz
   end
 
-  def test_load_namespaces
-    namespace = Confuse::Namespace.new do
-      define :foo do
-        default 1
-      end
-    end
-
-    @config.load_namespaces({ :foo_bar => namespace })
-
-    assert @config[:foo_bar][:foo]
-    assert @config[:foo_bar][:baz]
+  # raises an error if any items are required and don't have defaults
+  def test_check
+    assert_raises(Confuse::Errors::Undefined) { @config.check }
   end
-
-  def test_to_hash
-    config = Class.new(Confuse::ConfigBase) do
-      define :foo do
-        description 'Foo'
-        type :integer
-        default 1
-      end
-    end
-    assert_nil config.new.to_hash[:default_foo]
-    refute_nil config.new.to_hash[:foo]
-  end
-
 end
-

data/test/test_confuse.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+require 'minitest/autorun'
+
+class TestConfuse < MiniTest::Unit::TestCase
+  def create_definition
+    definition = Confuse.define do |d|
+      d.add_item :foo, :default => 1, :description => 'Foo'
+    end
+
+    assert definition.instance_of Confuse::Definition
+  end
+end

data/test/test_definition.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+module Confuse
+  class TestDefinition < MiniTest::Unit::TestCase
+    def setup
+      @definition = Confuse::Definition.new do |d|
+        d.add_item :foo, :default => 1
+        d.add_namespace :bar do |n|
+          n.add_item(:foo, :default => 1, :description => 'test')
+        end
+      end
+    end
+
+    # can define a configuration item
+    def test_define_item
+      assert @definition.defines? :foo
+    end
+
+    # can define a namespace
+    def test_define_namespace
+      assert @definition.defines? :bar_foo
+    end
+
+    def test_default
+      assert_equal 1, @definition.default(nil, :foo)
+    end
+
+    def test_default_for_namespaced_item
+      assert_equal 1, @definition.default(:bar, :foo)
+    end
+  end
+end

data/test/test_item.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+class TestItem < MiniTest::Unit::TestCase
+  def setup
+    @item = Confuse::Item.new(:foo, :default => 1, :description => 'Description')
+  end
+
+  def test_sets_the_default_value
+    assert_equal 1, @item.default
+  end
+
+  def test_sets_the_description
+    assert_equal 'Description', @item.description
+  end
+
+  def test_required_item
+    item = Confuse::Item.new(:foo, :description => 'required!',
+                                   :required => true)
+    assert_raises(Confuse::Errors::Undefined) { item.default }
+  end
+end

data/test/test_key_splitter.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+require 'minitest/autorun'
+
+class TestKeySplitter < MiniTest::Unit::TestCase
+  def test_key_with_no_underscore
+    key_splitter = Confuse::KeySplitter.new(:foo)
+    assert_equal 0, key_splitter.possible_namespaces.count
+  end
+
+  def test_key_with_one_underscore
+    key_splitter = Confuse::KeySplitter.new(:foo_bar)
+    assert_equal 1, key_splitter.possible_namespaces.count
+    assert key_splitter.possible_namespaces.include? :foo
+  end
+
+  def test_key_with_many_underscores
+    key_splitter = Confuse::KeySplitter.new(:foo_1_2_3_4_5_6_7_8_9)
+    assert_equal 9, key_splitter.possible_namespaces.count
+    assert key_splitter.possible_namespaces.include? :foo
+    assert key_splitter.possible_namespaces.include? :foo_1
+    assert key_splitter.possible_namespaces.include? :foo_1_2
+    assert key_splitter.possible_namespaces.include? :foo_1_2_3
+    assert key_splitter.possible_namespaces.include? :foo_1_2_3_4
+    assert key_splitter.possible_namespaces.include? :foo_1_2_3_4_5
+    assert key_splitter.possible_namespaces.include? :foo_1_2_3_4_5_6
+    assert key_splitter.possible_namespaces.include? :foo_1_2_3_4_5_6_7
+    assert key_splitter.possible_namespaces.include? :foo_1_2_3_4_5_6_7_8
+  end
+
+  def test_rest_of_key
+    key_splitter = Confuse::KeySplitter.new(:foo_bar)
+    assert_equal :bar, key_splitter.rest_of_key(:foo)
+  end
+
+  def test_rest_of_key_return_nil_if_namespace_doesnt_match
+    key_splitter = Confuse::KeySplitter.new(:foo_bar)
+    assert_nil key_splitter.rest_of_key(:baz)
+  end
+
+  def test_split
+    key_splitter = Confuse::KeySplitter.new(:foo_1_2_3_4_5_6_7_8_9)
+    assert key_splitter.split.include? [:foo, :"1_2_3_4_5_6_7_8_9"]
+    assert key_splitter.split.include? [:foo_1, :"2_3_4_5_6_7_8_9"]
+    assert key_splitter.split.include? [:foo_1_2, :"3_4_5_6_7_8_9"]
+    assert key_splitter.split.include? [:foo_1_2_3, :"4_5_6_7_8_9"]
+    assert key_splitter.split.include? [:foo_1_2_3_4, :"5_6_7_8_9"]
+    assert key_splitter.split.include? [:foo_1_2_3_4_5, :"6_7_8_9"]
+    assert key_splitter.split.include? [:foo_1_2_3_4_5_6, :"7_8_9"]
+    assert key_splitter.split.include? [:foo_1_2_3_4_5_6_7, :"8_9"]
+    assert key_splitter.split.include? [:foo_1_2_3_4_5_6_7_8, :"9"]
+  end
+end

data/test/test_namespace.rb

@@ -1,25 +1,16 @@
+# coding: utf-8
+
 require 'minitest/autorun'
 require 'confuse'
 
+# Test {Confuse::Namespace}
 class TestNamespace < MiniTest::Unit::TestCase
   def setup
-    @namespace = Confuse::Namespace.new do
-      define :foo do
-        default 1
-      end
-    end
+    @namespace = Confuse::Namespace.new
   end
 
-  def test_merge!
-    namespace = Confuse::Namespace.new do
-      define :bar do
-        default 1
-      end
-    end
-
-    @namespace.merge!(namespace)
-
-    assert @namespace[:foo]
-    assert @namespace[:bar]
+  def test_add_an_item
+    @namespace.add_item(:foo, :default => :foo, :description => 'Test')
+    refute_nil @namespace[:foo]
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: confuse
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 23
   prerelease: 
   segments: 
-  - 0
   - 1
-  - 8
-  version: 0.1.8
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Tom Chipchase
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-02-07 00:00:00 Z
+date: 2014-09-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: inifile
@@ -60,6 +60,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Add nested configuration to an application
 email: 
 - tom@mediasp.com
@@ -77,22 +91,28 @@ files:
 - README.md
 - Rakefile
 - confuse.gemspec
-- example/001_simple_example.ini
-- example/001_simple_example.rb
-- example/002_namespace_example.rb
-- example/003_config_subclass_instance.ini
-- example/003_config_subclass_instance_example.rb
-- example/004_configured_by.rb
+- example/env_example.rb
+- example/example.ini
+- example/example.yaml
+- example/ini_example.rb
+- example/yaml_example.rb
 - lib/confuse.rb
 - lib/confuse/config.rb
-- lib/confuse/config_item.rb
-- lib/confuse/config_mixin.rb
-- lib/confuse/configurable.rb
-- lib/confuse/dsl.rb
+- lib/confuse/definition.rb
+- lib/confuse/errors.rb
+- lib/confuse/item.rb
+- lib/confuse/key_splitter.rb
 - lib/confuse/namespace.rb
+- lib/confuse/source.rb
+- lib/confuse/source/env.rb
+- lib/confuse/source/ini.rb
+- lib/confuse/source/yaml.rb
 - lib/confuse/version.rb
 - test/test_config.rb
-- test/test_config_base.rb
+- test/test_confuse.rb
+- test/test_definition.rb
+- test/test_item.rb
+- test/test_key_splitter.rb
 - test/test_namespace.rb
 homepage: https://github.com/mediasp/confuse
 licenses: 
@@ -129,6 +149,9 @@ specification_version: 3
 summary: A DSL for defining configuration options in classes
 test_files: 
 - test/test_config.rb
-- test/test_config_base.rb
+- test/test_confuse.rb
+- test/test_definition.rb
+- test/test_item.rb
+- test/test_key_splitter.rb
 - test/test_namespace.rb
 has_rdoc: