config_mapper 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ef98e7511cb9930fbda99d63064fc49e7634c25
-  data.tar.gz: b22f51b95e5248c20f91f353fddbd304b0a6ed26
+  metadata.gz: 2b50eb5ad224762a6891a4bb75077f7cf24dd19a
+  data.tar.gz: ee8a164e3478984a0793df79345af4bbaa67054a
 SHA512:
-  metadata.gz: eafa293ee0625f4c8d330f00f59a2618affeff679d5189e24087734cd4601f45bf32c0f7fdfaf380e643c7a9a0762b34581a6efc2f918eae237fc918e35b02e8
-  data.tar.gz: f59d8a5d5a27502ae8bb457aa083a14be7d2f35be5af3a2550d2347142ab452bfb76b25f17f343e6fd193ea267cdcadb8049853366ebba2b21699aa37c1b1cef
+  metadata.gz: 4f16a33006c27cc333e7bed302052b372728755a900103f42781f116639cde0a6af56c598d2335677bba75b031ed49e0c3c70162d00c5bcce0cce0085d80a302
+  data.tar.gz: 0ef76dfb3980e16c6e671e5a055e4deb546408c1515f7675da6bccf43d10357d4432b7c43262f8767f7b2017e42765e869ca44823c502480661098b5cde93b52

data/.rubocop.yml

@@ -44,6 +44,9 @@ Style/FileName:
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
+Style/Lambda:
+  Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 

data/README.md

@@ -1,5 +1,8 @@
 # ConfigMapper
 
+[![Gem Version](https://badge.fury.io/rb/config_mapper.png)](http://badge.fury.io/rb/config_mapper)
+[![Build Status](https://secure.travis-ci.org/mdub/config_mapper.png?branch=master)](http://travis-ci.org/mdub/config_mapper)
+
 ConfigMapper maps configuration data onto Ruby objects.
 
 ## Usage
@@ -119,8 +122,8 @@ require "config_mapper/config_struct"
 class State < ConfigMapper::ConfigStruct
 
   component :position do
-    attribute(:x) { |arg| Integer(arg) }
-    attribute(:y) { |arg| Integer(arg) }
+    attribute :x
+    attribute :y
   end
 
   attribute :orientation
@@ -128,35 +131,48 @@ class State < ConfigMapper::ConfigStruct
 end
 ```
 
-By default, declared attributes are assumed to be mandatory. The
-`ConfigStruct#config_errors` method returns errors for each unset mandatory
-attribute.
+`ConfigStruct#config_errors` returns errors for each unset mandatory attribute.
 
 ```ruby
 state = State.new
 state.position.x = 3
 state.position.y = 4
 state.config_errors
-#=> { ".orientation" => "no value provided" }
+#=> { ".orientation" => #<ConfigMapper::ConfigStruct::NoValueProvided: no value provided> }
 ```
 
 `#config_errors` can be overridden to provide custom semantic validation.
 
-Attributes can be given default values. Provide an explicit `nil` default to
-mark an attribute as optional, e.g.
+Attributes can be given default values. Specify a default value of `nil` to mark an attribute as optional, e.g.
 
 ```ruby
 class Address < ConfigMapper::ConfigStruct
-
   attribute :host
   attribute :port, :default => 80
   attribute :path, :default => nil
+end
+```
+
+If a block is provided when an `attribute` is declared, it is used to validate values when they are set, and/or coerce them to a canonical type.  The block should raise `ArgumentError` to indicate an invalid value.
+
+```ruby
+class Server < ConfigMapper::ConfigStruct
+
+  attribute :host do |arg|
+    unless arg =~ /^\w+(\.\w+)+$/
+      raise ArgumentError, "invalid hostname: #{arg}"
+    end
+    arg
+  end
+
+  attribute :port do |arg|
+    Integer(arg)
+  end
 
 end
 ```
 
-`ConfigStruct#configure_with` maps data into the object, and combines mapping errors and
-semantic errors (returned by `#config_errors`) into a single Hash:
+`ConfigStruct#configure_with` maps data into the object, and combines mapping errors and semantic errors (returned by `#config_errors`) into a single Hash:
 
 ```ruby
 data = {

data/lib/config_mapper/config_dict.rb

@@ -15,6 +15,14 @@ module ConfigMapper
       @entries[key] ||= @entry_type.call
     end
 
+    def to_h
+      {}.tap do |result|
+        @entries.each do |key, value|
+          result[key] = value.to_h
+        end
+      end
+    end
+
     extend Forwardable
 
     def_delegators :@entries, :each, :empty?, :keys, :map, :size

data/lib/config_mapper/config_struct.rb

@@ -21,21 +21,24 @@ module ConfigMapper
       # @options options [String] :default (nil) default value
       # @yield type-coercion block
       #
-      def attribute(name, options = {}, &coerce_block)
+      def attribute(name, options = {})
         name = name.to_sym
+        required = true
+        default_value = nil
         if options.key?(:default)
           default_value = options.fetch(:default).freeze
-          attribute_initializers[name] = proc { default_value }
-        else
-          required_attributes << name
+          required = false if default_value.nil?
         end
+        attribute_initializers[name] = proc { default_value }
+        required_attributes << name if required
         attr_reader(name)
-        if coerce_block
-          define_method("#{name}=") do |arg|
-            instance_variable_set("@#{name}", coerce_block.call(arg))
+        define_method("#{name}=") do |value|
+          if value.nil?
+            raise NoValueProvided if required
+          else
+            value = yield(value) if block_given?
           end
-        else
-          attr_writer(name)
+          instance_variable_set("@#{name}", value)
         end
       end
 
@@ -125,6 +128,22 @@ module ConfigMapper
       config_errors.merge(errors)
     end
 
+    # Return the configuration as a Hash.
+    #
+    # @return [Hash] serializable config data
+    #
+    def to_h
+      {}.tap do |result|
+        self.class.attribute_initializers.keys.each do |attr_name|
+          value = send(attr_name)
+          if value && value.respond_to?(:to_h) && !value.is_a?(Array)
+            value = value.to_h
+          end
+          result[attr_name.to_s] = value
+        end
+      end
+    end
+
     private
 
     def components
@@ -140,13 +159,19 @@ module ConfigMapper
       end
     end
 
-    NOT_SET = "no value provided".freeze
+    class NoValueProvided < ArgumentError
+
+      def initialize
+        super("no value provided")
+      end
+
+    end
 
     def missing_required_attribute_errors
       {}.tap do |errors|
         self.class.required_attributes.each do |name|
-          unless instance_variable_defined?("@#{name}")
-            errors[".#{name}"] = NOT_SET
+          if instance_variable_get("@#{name}").nil?
+            errors[".#{name}"] = NoValueProvided.new
           end
         end
       end

data/lib/config_mapper/version.rb

@@ -1,5 +1,5 @@
 module ConfigMapper
 
-  VERSION = "1.1.1"
+  VERSION = "1.2.0".freeze
 
 end

data/lib/config_mapper.rb

@@ -25,7 +25,7 @@ module ConfigMapper
       mapper_for(target).configure_with(data)
     end
 
-    alias_method :set, :configure_with
+    alias set configure_with
 
     def mapper_for(target)
       if target.is_a?(Hash) || target.is_a?(ConfigMapper::ConfigDict)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_mapper
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Maps config data onto plain old objects