configru 3.0.0 → 3.1.0

data/ChangeLog.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 3.1.0 (28 October 2012)
+
+ * Added required options
+
 ## 3.0.0 (22 September 2012)
 
  * Added option arrays

data/Gemfile

@@ -3,7 +3,7 @@ source :rubygems
 group :development do
   gem "rake", "~> 0.9.0"
   gem "rspec", "~> 2.11.0"
-  gem "simplecov", "~> 0.6.0"
+  gem "simplecov", "~> 0.7.0"
 end
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    configru (3.0.0)
+    configru (3.1.0)
 
 GEM
   remote: http://rubygems.org/
@@ -17,10 +17,10 @@ GEM
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.2)
-    simplecov (0.6.4)
+    simplecov (0.7.1)
       multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
 
 PLATFORMS
   ruby
@@ -29,4 +29,4 @@ DEPENDENCIES
   configru!
   rake (~> 0.9.0)
   rspec (~> 2.11.0)
-  simplecov (~> 0.6.0)
+  simplecov (~> 0.7.0)

data/README.md

@@ -15,7 +15,7 @@ require 'configru'
 
 Configru.load('config.yml') do
   option :username, String, 'example_user'
-  option :token, Fixnum, 1234
+  option_required :token, Fixnum
   option_group :connection do
     option :server, String, 'example.com'
     option :port, Fixnum, 42
@@ -24,22 +24,27 @@ Configru.load('config.yml') do
     transform {|x| File.expand_path(x) }
     validate {|x| File.directory?(x) }
   end
+  option_array :channels, String, ['foo', 'bar']
 end
 
 example = Example.new(Configru.connection.server, Configru.connection.port)
 example.login(Configru.username, Configru.token)
-example.sync(Configru.path)
+Configru.channels.each do |x|
+  example.sync(x, Configru.path)
+end
 ```
 
 These defaults are equivalent to the following YAML:
 
 ```yaml
 username: example_user
-token: 1234
 connection:
   server: example.com
   port: 42
 path: ~
+channels:
+  - foo
+  - bar
 ```
 
 # License

data/lib/configru/dsl.rb

@@ -16,6 +16,12 @@ module Configru
         @options[name.to_s] = option
       end
 
+      def option_required(name, type = Object, validation = nil, &block)
+        option = Configru::RequiredOption.new(type, validation, nil)
+        RequiredOption.new(option, &block) if block
+        @options[name.to_s] = option
+      end
+
       def option_array(name, type = Object, default = [], validation = nil, &block)
         option = Configru::OptionArray.new(type, default, validation, nil)
         Option.new(option, &block) if block
@@ -27,7 +33,7 @@ module Configru
       end
     end
 
-    class Option
+    class RequiredOption
       def initialize(option, &block)
         @option = option
         instance_eval(&block)
@@ -37,10 +43,6 @@ module Configru
         @option.type = t
       end
 
-      def default(d)
-        @option.default = d
-      end
-
       def validate(v = nil, &block)
         @option.validation = v || block
       end
@@ -49,5 +51,11 @@ module Configru
         @option.transformation = block
       end
     end
+
+    class Option < RequiredOption
+      def default(d)
+        @option.default = d
+      end
+    end
   end
 end

data/lib/configru/option.rb

@@ -1,5 +1,5 @@
 module Configru
-  class Option < Struct.new(:type, :default, :validation, :transformation)
+  module OptionMethods
     def type?(value)
       value.is_a?(self.type)
     end
@@ -15,6 +15,14 @@ module Configru
     end
   end
 
+  class Option < Struct.new(:type, :default, :validation, :transformation)
+    include OptionMethods
+  end
+
+  class RequiredOption < Struct.new(:type, :validation, :transformation)
+    include OptionMethods
+  end
+
   class OptionArray < Option
     def type?(values)
       return false unless values.is_a?(Array)

data/lib/configru/version.rb

@@ -1,3 +1,3 @@
 module Configru
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/lib/configru.rb

@@ -11,6 +11,12 @@ module Configru
     end
   end
 
+  class OptionRequiredError < OptionError
+    def initialize(path)
+      super(path, 'option required')
+    end
+  end
+
   class OptionTypeError < OptionError
     def initialize(path, expected, got)
       super(path, "expected #{expected}, got #{got}")
@@ -76,6 +82,8 @@ module Configru
       elsif output.include? key # option has already been set
         @option_path.pop
         next
+      elsif option.is_a? RequiredOption
+        raise OptionRequiredError.new(@option_path)
       else # option has not been set
         value = option.default
       end

data/spec/configru_spec.rb

@@ -169,4 +169,12 @@ describe Configru do
 
     Configru.example.should == [3, 5, 7, 8]
   end
+
+  it 'requires required options' do
+    expect do
+      Configru.load(example_file :a) do
+        option_required :required
+      end
+    end.to raise_error(Configru::OptionRequiredError)
+  end
 end

data/spec/dsl_spec.rb

@@ -1,6 +1,6 @@
-describe Configru::DSL::Option do
+describe Configru::DSL::RequiredOption do
   before do
-    @option = Configru::Option.new(:type, :default, :validation, :transformation)
+    @option = Configru::RequiredOption.new(:type, :validation, :transformation)
   end
 
   it 'sets option type' do
@@ -11,14 +11,6 @@ describe Configru::DSL::Option do
     @option.type.should == String
   end
 
-  it 'sets option default' do
-    described_class.new(@option) do
-      default 'Example'
-    end
-
-    @option.default.should == 'Example'
-  end
-
   it 'sets option validate value' do
     described_class.new(@option) do
       validate /example/
@@ -50,6 +42,20 @@ describe Configru::DSL::Option do
   end
 end
 
+describe Configru::DSL::Option do
+  before do
+    @option = Configru::Option.new(:type, :default, :validation, :transformation)
+  end
+
+  it 'sets option default' do
+    described_class.new(@option) do
+      default 'Example'
+    end
+
+    @option.default.should == 'Example'
+  end
+end
+
 describe Configru::DSL::OptionGroup do
   it 'creates an option' do
     group = described_class.new do
@@ -72,6 +78,26 @@ describe Configru::DSL::OptionGroup do
     group.options.should have_key('example')
   end
 
+  it 'creates a required option' do
+    group = described_class.new do
+      option_required 'example'
+    end
+
+    group.options.should have_key('example')
+    group.options['example'].should be_a(Configru::RequiredOption)
+    group.options['example'].type.should == Object
+    group.options['example'].validation.should be_nil
+    group.options['example'].transformation.should be_nil
+  end
+
+  it 'converts required option names to strings' do
+    group = described_class.new do
+      option_required :example
+    end
+
+    group.options.should have_key('example')
+  end
+
   it 'creates an option array' do
     group = described_class.new do
       option_array 'example'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configru
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-22 00:00:00.000000000 Z
+date: 2012-10-28 00:00:00.000000000 Z
 dependencies: []
 description: YAML configuration file loader
 email:
@@ -59,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2949675092247533978
+      hash: -933194907027225468
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2949675092247533978
+      hash: -933194907027225468
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24