config_mapper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ed0d0f28834d3999b5b04b181fb26ec7969b325
-  data.tar.gz: 293d2c6acc73402a951c53e9a65c65b7171f52d5
+  metadata.gz: 7d643ab8607c785459650363209b078699513bd5
+  data.tar.gz: 1a4ef25c93114686800bc0cf82dc13c7736e448a
 SHA512:
-  metadata.gz: e65eabdf9faeb1e2bcc15a4e9f85584da821ccce43f34c1eea852001ee602c9e71c96fbcc11887d509608c4704df0f12391ccf52cb725b284deb6e2a2dac4158
-  data.tar.gz: b9d158e005ebcddf4cd6ee5695b950d549acfe4a3e893fed07ebf12272f3d1d37b6c139d3e85e16e0cadfc0f8b0b6fa297238a52e17f744e794d03702a218247
+  metadata.gz: f323e289fbdc9d7c1f6d8f8c436e7d62bb68b98b35268e210a0f4bc0568a6f69549e7c9fb54c38173ce3b84f797c5dba732a7ab80239b0ccaf4d046bbbca5278
+  data.tar.gz: 7fcb8808ee09efb2a932ab5b8f4dc74f49405b12438c50428d2506667a7f5862b31b2a771e08964f49ed8f9d8988355748328c407a80eb376f5ff40ec5a19daf

data/.rubocop.yml

@@ -0,0 +1,51 @@
+Eval:
+  Exclude:
+    - "Rakefile"
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+  Exclude:
+    - "spec/**/*"
+
+Style/Documentation:
+  Exclude:
+    - "lib/**/version.rb"
+    - "spec/**/*"
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+  Enabled: true
+
+Style/FileName:
+  Exclude:
+    - "bin/*"
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/WordArray:
+  Enabled: false

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in config_mapper.gemspec
 gemspec

data/README.md

@@ -1,41 +1,84 @@
 # ConfigMapper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/config_mapper`. To experiment with that code, run `bin/console` for an interactive prompt.
+ConfigMapper maps configuration data onto Ruby objects.
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
 
-## Installation
+Imagine you have some Ruby objects:
 
-Add this line to your application's Gemfile:
+    class Position
 
-```ruby
-gem 'config_mapper'
-```
+      attr_reader :x
+      attr_reader :y
 
-And then execute:
+      def x=(arg); @x = Integer(arg); end
+      def y=(arg); @y = Integer(arg); end
 
-    $ bundle
+    end
 
-Or install it yourself as:
+    class State
 
-    $ gem install config_mapper
+      def initialize
+        @position = Position.new
+      end
 
-## Usage
+      attr_reader :position
+      attr_accessor :orientation
 
-TODO: Write usage instructions here
+    end
 
-## Development
+    state = State.new
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+and wish to populate/modify it, based on plain data:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    config_data = {
+      "orientation" => "North",
+      "position" => {
+        "x" => 2,
+        "y" => 4
+      }
+    }
 
-## Contributing
+ConfigMapper will help you out:
+
+    require 'config_mapper'
+
+    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 }
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/config_mapper.
+    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
+
+### 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> }
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+## Contributing
+
+It's on GitHub; you know the drill.

data/config_mapper.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'config_mapper/version'
+require "config_mapper/version"
 
 Gem::Specification.new do |spec|
 

data/lib/config_mapper/version.rb

@@ -1,3 +1,5 @@
 class ConfigMapper
-  VERSION = "0.1.0"
+
+  VERSION = "0.2.0"
+
 end

data/lib/config_mapper.rb

@@ -19,7 +19,7 @@ class ConfigMapper
   end
 
   def initialize(target, errors = {})
-    @target = target
+    @target = ObjectAsHash[target]
     @errors = errors
   end
 
@@ -39,22 +39,43 @@ class ConfigMapper
   # Set a single attribute.
   #
   def set_attribute(key, value)
-    if value.is_a?(Hash)
-      set_nested(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.public_send("#{key}=", value)
+      target[key] = value
     end
   rescue NoMethodError, ArgumentError => e
     errors[key] = e
   end
 
-  def set_nested(key, value)
-    nested_target = target.public_send(key)
-    nested_errors = ErrorProxy.new(errors, "#{key}.")
-    nested_mapper = self.class.new(nested_target, nested_errors)
-    nested_mapper.set_attributes(value)
+  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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-03 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Maps config data onto plain old objects