config_mapper 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d643ab8607c785459650363209b078699513bd5
-  data.tar.gz: 1a4ef25c93114686800bc0cf82dc13c7736e448a
+  metadata.gz: a927800ba901de2ba648d012936b19b591d24c5e
+  data.tar.gz: c93aace56fd8a8a9662f547ef72e5c5f1d0a9396
 SHA512:
-  metadata.gz: f323e289fbdc9d7c1f6d8f8c436e7d62bb68b98b35268e210a0f4bc0568a6f69549e7c9fb54c38173ce3b84f797c5dba732a7ab80239b0ccaf4d046bbbca5278
-  data.tar.gz: 7fcb8808ee09efb2a932ab5b8f4dc74f49405b12438c50428d2506667a7f5862b31b2a771e08964f49ed8f9d8988355748328c407a80eb376f5ff40ec5a19daf
+  metadata.gz: 5da46b8fb08d97ccfe985cb2a0da607de151f2d70167c0edd03c66a5771d9e5e24fda1a2183e58552103aa451d9016c8d45991ba87d1c3a47fc0b3e1e7b0e8e1
+  data.tar.gz: 3b40a4cc5c9049f681bbeaf17cacad8817dffd48c53b5ec46314a1e49f0410053f335feee942357b8265dbbb660468751f2de1657994af68bca3b4514399faaf

data/README.md

@@ -6,74 +6,84 @@ ConfigMapper maps configuration data onto Ruby objects.
 
 Imagine you have some Ruby objects:
 
-    class Position
+```ruby
+class Position
 
-      attr_reader :x
-      attr_reader :y
+  attr_reader :x
+  attr_reader :y
 
-      def x=(arg); @x = Integer(arg); end
-      def y=(arg); @y = Integer(arg); end
+  def x=(arg); @x = Integer(arg); end
+  def y=(arg); @y = Integer(arg); end
 
-    end
+end
 
-    class State
+class State
 
-      def initialize
-        @position = Position.new
-      end
+  def initialize
+	@position = Position.new
+  end
 
-      attr_reader :position
-      attr_accessor :orientation
+  attr_reader :position
+  attr_accessor :orientation
 
-    end
+end
 
-    state = State.new
+state = State.new
+```
 
 and wish to populate/modify it, based on plain data:
 
-    config_data = {
-      "orientation" => "North",
-      "position" => {
-        "x" => 2,
-        "y" => 4
-      }
-    }
+```ruby
+config_data = {
+  "orientation" => "North",
+  "position" => {
+	"x" => 2,
+	"y" => 4
+  }
+}
+```
 
 ConfigMapper will help you out:
 
-    require 'config_mapper'
+```ruby
+require 'config_mapper'
 
-    errors = ConfigMapper.set(config_data, state)
-    state.orientation              #=> "North"
-    state.position.x               #=> 2
+errors = ConfigMapper.set(config_data, state)
+state.orientation              #=> "North"
+state.position.x               #=> 2
+```
 
 It can even populate Hashes of objects, e.g.
 
-    positions = Hash.new { |h,k| h[k] = Position.new }
+```ruby
+positions = Hash.new { |h,k| h[k] = Position.new }
 
-    config_data = {
-      "fred" => { "x" => 2, "y" => 4 },
-      "mary" => { "x" => 3, "y" => 5 }
-    }
+config_data = {
+  "fred" => { "x" => 2, "y" => 4 },
+  "mary" => { "x" => 3, "y" => 5 }
+}
 
-    ConfigMapper.set(config_data, positions)
-    positions["fred"].x            #=> 2
-    positions["mary"].y            #=> 5
+ConfigMapper.set(config_data, positions)
+positions["fred"].x            #=> 2
+positions["mary"].y            #=> 5
+```
 
 ### Errors
 
 `ConfigMapper.set` returns a Hash of errors encountered while mapping data
 onto objects.  The errors are Exceptions (typically ArgumentError or NoMethodError),
-keyed by a dot-delimited path to the offending data.  e.g.
-
-    config_data = {
-      "position" => {
-        "bogus" => "flibble"
-      }
-    }
-
-    errors = ConfigMapper.set(config_data, state)
-    errors    #=> { "position.bogus" => #<NoMethodError> }
+keyed by a Array representing the path to the offending data.  e.g.
+
+```ruby
+config_data = {
+  "position" => {
+    "bogus" => "flibble"
+  }
+}
+
+errors = ConfigMapper.set(config_data, state)
+errors    #=> { ["position", "bogus"] => #<NoMethodError> }
+```
 
 ## License
 

data/lib/config_mapper.rb

@@ -1,7 +1,9 @@
+require "config_mapper/attribute_sink"
+
 # Supports marshalling of plain-old data (e.g. loaded from
 # YAML files) onto strongly-typed objects.
 #
-class ConfigMapper
+module ConfigMapper
 
   # Attempt to set attributes on a target object.
   #
@@ -13,85 +15,9 @@ class ConfigMapper
   # @return [Hash] exceptions encountered
   #
   def self.set(data, target)
-    mapper = new(target)
+    mapper = AttributeSink.new(target)
     mapper.set_attributes(data)
     mapper.errors
   end
 
-  def initialize(target, errors = {})
-    @target = ObjectAsHash[target]
-    @errors = errors
-  end
-
-  attr_reader :target
-  attr_reader :errors
-
-  # Set multiple attributes from a Hash.
-  #
-  def set_attributes(data)
-    data.each do |key, value|
-      set_attribute(key, value)
-    end
-  end
-
-  private
-
-  # Set a single attribute.
-  #
-  def set_attribute(key, value)
-    if value.is_a?(Hash) && !target[key].nil?
-      nested_errors = ErrorProxy.new(errors, "#{key}.")
-      nested_mapper = self.class.new(target[key], nested_errors)
-      nested_mapper.set_attributes(value)
-    else
-      target[key] = value
-    end
-  rescue NoMethodError, ArgumentError => e
-    errors[key] = e
-  end
-
-  class ObjectAsHash
-
-    def self.[](target)
-      if target.is_a?(Hash)
-        target
-      else
-        ObjectAsHash.new(target)
-      end
-    end
-
-    def initialize(target)
-      @target = target
-    end
-
-    def [](key)
-      @target.public_send(key)
-    end
-
-    def []=(key, value)
-      @target.public_send("#{key}=", value)
-    end
-
-  end
-
-  # Wraps a Hash of errors, injecting prefixes
-  #
-  class ErrorProxy
-
-    def initialize(errors, prefix)
-      @errors = errors
-      @prefix = prefix
-    end
-
-    def []=(key, value)
-      errors[prefix + key] = value
-    end
-
-    private
-
-    attr_reader :errors
-    attr_reader :prefix
-
-  end
-
 end

data/lib/config_mapper/attribute_sink.rb

@@ -0,0 +1,42 @@
+require "config_mapper/error_proxy"
+require "config_mapper/object_as_hash"
+
+module ConfigMapper
+
+  # Sets attributes on an object, collecting errors
+  #
+  class AttributeSink
+
+    def initialize(target, errors = {})
+      @target = ObjectAsHash[target]
+      @errors = errors
+    end
+
+    attr_reader :target
+    attr_reader :errors
+
+    # Set multiple attributes from a Hash.
+    #
+    def set_attributes(data)
+      data.each do |key, value|
+        set_attribute(key, value)
+      end
+    end
+
+    # Set a single attribute.
+    #
+    def set_attribute(key, value)
+      if value.is_a?(Hash) && !target[key].nil?
+        nested_errors = ErrorProxy.new(errors, [key])
+        nested_mapper = self.class.new(target[key], nested_errors)
+        nested_mapper.set_attributes(value)
+      else
+        target[key] = value
+      end
+    rescue NoMethodError, ArgumentError => e
+      errors[[key]] = e
+    end
+
+  end
+
+end

data/lib/config_mapper/error_proxy.rb

@@ -0,0 +1,23 @@
+module ConfigMapper
+
+  # Wraps a Hash of errors, injecting prefixes
+  #
+  class ErrorProxy
+
+    def initialize(errors, prefix)
+      @errors = errors
+      @prefix = prefix
+    end
+
+    def []=(key, value)
+      errors[prefix + key] = value
+    end
+
+    private
+
+    attr_reader :errors
+    attr_reader :prefix
+
+  end
+
+end

data/lib/config_mapper/object_as_hash.rb

@@ -0,0 +1,29 @@
+module ConfigMapper
+
+  # Wrap an object to make it look more like a Hash.
+  #
+  class ObjectAsHash
+
+    def self.[](target)
+      if target.is_a?(Hash)
+        target
+      else
+        ObjectAsHash.new(target)
+      end
+    end
+
+    def initialize(target)
+      @target = target
+    end
+
+    def [](key)
+      @target.public_send(key)
+    end
+
+    def []=(key, value)
+      @target.public_send("#{key}=", value)
+    end
+
+  end
+
+end

data/lib/config_mapper/version.rb

@@ -1,5 +1,5 @@
-class ConfigMapper
+module ConfigMapper
 
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_mapper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,9 @@ files:
 - Rakefile
 - config_mapper.gemspec
 - lib/config_mapper.rb
+- lib/config_mapper/attribute_sink.rb
+- lib/config_mapper/error_proxy.rb
+- lib/config_mapper/object_as_hash.rb
 - lib/config_mapper/version.rb
 homepage: https://github.com/mdub/config_mapper
 licenses:
@@ -90,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Maps config data onto plain old objects