config_mapper 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cad2a71b7850554a0a981b18d91bb1198cd16f8a
-  data.tar.gz: 305d415a5243d35b97d4a9b881fe51fad55217c5
+  metadata.gz: c439738a98e1865c82d286061ea400b181ff9899
+  data.tar.gz: 9a850ec8e62445f822838cb388dee7b1f3fae69f
 SHA512:
-  metadata.gz: 91509bfa9e31c03bb8093c434942980cbd8616fffb22b7d0b4bf21f64edd01b750b7e9dd270c2d491452ae191455dcdf9c49724feb1d9f5076c3421c54d16c6d
-  data.tar.gz: 423dcae0bc0c14b13979fbf1a10980b43c5e669a23fa521ad8b864fba965f83f3e5ee5bab1c569a8b6c2c47de017570964bd08ae7ef3b0cd36f37cb20c3da6b1
+  metadata.gz: cfe874d019e5d3f0195b42a0945d6d5f335c660e6a45bfc6b93f7a32b1af1bb193aa5088c3f2ae0dcb543b49fca33394813158bd167b90988643af7cd5d9d128
+  data.tar.gz: 10de84239f89b4bd1a83a62ed172537684a28add36cf5e52e87c76b109f9ae6267f52d9ee030d8612c402f662b8c70e07028f5592147589ac64612d627d5280f

data/README.md

@@ -217,6 +217,30 @@ class State < ConfigMapper::ConfigStruct
 end
 ```
 
+`component_list` declares a nested list of configurable objects, indexed by position, and `component_dict` declares a dictionary (map) of configurable objects, indexed by an arbitrary key.
+
+```ruby
+class Polygon < ConfigMapper::ConfigStruct
+
+  component_list :points do
+    attribute :x
+    attribute :y
+  end
+
+end
+
+class Cargo < ConfigMapper::ConfigStruct
+
+  component_dict :packages do
+    attribute :contents
+    attribute :weight, Float
+  end
+
+end
+```
+
+In both cases, new collection entries pop into existance the first time they are accessed.
+
 ### Semantic errors
 
 `ConfigStruct#config_errors` returns errors for each unset mandatory attribute.

data/lib/config_mapper.rb

@@ -1,5 +1,6 @@
 require "config_mapper/collection_mapper"
 require "config_mapper/config_dict"
+require "config_mapper/config_list"
 require "config_mapper/object_mapper"
 
 # Supports marshalling of plain-old data (e.g. loaded from

data/lib/config_mapper/config_list.rb

@@ -0,0 +1,72 @@
+require 'config_mapper'
+require 'config_mapper/config_struct'
+require "config_mapper/factory"
+require "config_mapper/validator"
+require "forwardable"
+
+module ConfigMapper
+  class ConfigList
+
+    class Factory
+
+      def initialize(entry_factory)
+        @entry_factory = ConfigMapper::Factory.resolve(entry_factory)
+      end
+
+      attr_reader :entry_factory
+
+      def new
+        ConfigList.new(@entry_factory)
+      end
+
+      def config_doc
+        return {} unless entry_factory.respond_to?(:config_doc)
+        {}.tap do |result|
+          entry_factory.config_doc.each do |path, doc|
+            result["[N]#{path}"] = doc
+          end
+        end
+      end
+
+    end
+
+    def initialize(entry_factory)
+      @entry_factory = entry_factory
+      @entries = []
+    end
+
+    def [](index)
+      @entries[index] ||= @entry_factory.new
+    end
+
+    def to_a
+      map do |element|
+        case
+          when element.respond_to?(:to_h); element.to_h
+          when element.respond_to?(:to_a); element.to_a
+          else element
+        end
+      end
+    end
+
+    def config_errors
+      {}.tap do |errors|
+        each_with_index do |element, index|
+          next unless element.respond_to?(:config_errors)
+          prefix = "[#{index}]"
+          element.config_errors.each do |path, path_errors|
+            errors["#{prefix}#{path}"] = path_errors
+          end
+        end
+      end
+    end
+
+    extend Forwardable
+
+    def_delegators :@entries, :each, :each_with_index, :empty?, :map, :size
+
+    include Enumerable
+
+  end
+end
+

data/lib/config_mapper/config_struct.rb

@@ -89,6 +89,19 @@ module ConfigMapper
         component(name, type: ConfigDict::Factory.new(type, key_type), description: description)
       end
 
+      # Defines an array of sub-components.
+      #
+      # If a block is be provided, it will be `class_eval`ed to define the
+      # sub-components class.
+      #
+      # @param name [Symbol] list attribute name
+      # @param type [Class] base-class for component values
+      #
+      def component_list(name, type: ConfigStruct, description: nil, &block)
+        type = Class.new(type, &block) if block
+        component(name, type: ConfigList::Factory.new(type), description: description)
+      end
+
       # Generate documentation, as Ruby data.
       #
       # Returns an entry for each configurable path, detailing
@@ -159,6 +172,8 @@ module ConfigMapper
           value = send(attribute.name)
           if value && value.respond_to?(:to_h) && !value.is_a?(Array)
             value = value.to_h
+          elsif value && value.respond_to?(:to_a)
+            value = value.to_a
           end
           result[attribute.name.to_s] = value
         end

data/lib/config_mapper/version.rb

@@ -1,5 +1,5 @@
 module ConfigMapper
 
-  VERSION = "1.6.0".freeze
+  VERSION = "1.7.0".freeze
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_mapper
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - lib/config_mapper.rb
 - lib/config_mapper/collection_mapper.rb
 - lib/config_mapper/config_dict.rb
+- lib/config_mapper/config_list.rb
 - lib/config_mapper/config_struct.rb
 - lib/config_mapper/factory.rb
 - lib/config_mapper/mapper.rb