config_mapper 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cad2a71b7850554a0a981b18d91bb1198cd16f8a
-  data.tar.gz: 305d415a5243d35b97d4a9b881fe51fad55217c5
+SHA256:
+  metadata.gz: 893366e1a4af52a813c5b92b4053ce74266f04ff2ae5714d901567cd2cc6e82e
+  data.tar.gz: b0b1583750a6b2a5951d87dda67e7a919e82ae4eac49af820b2841140a24b459
 SHA512:
-  metadata.gz: 91509bfa9e31c03bb8093c434942980cbd8616fffb22b7d0b4bf21f64edd01b750b7e9dd270c2d491452ae191455dcdf9c49724feb1d9f5076c3421c54d16c6d
-  data.tar.gz: 423dcae0bc0c14b13979fbf1a10980b43c5e669a23fa521ad8b864fba965f83f3e5ee5bab1c569a8b6c2c47de017570964bd08ae7ef3b0cd36f37cb20c3da6b1
+  metadata.gz: ec06636f7a51b8c0a8843f3fdaeb538f5b1fad50db5f990b1e2f34d4e1af6c131ef29a78921af31c6d72b9ecec3abde5fa7f96b620ecdc702d54e71803b5d6a3
+  data.tar.gz: c69ea2e26bd80e145179afd3800d6bf2efde4ecb8701d47e6c27e83149619006388df4ccd629ff4105aa09d5d90c403c114f89d16acc0ad563c10a945ae4a8fd

data/README.md

@@ -1,7 +1,7 @@
 # ConfigMapper
 
 [![Gem Version](https://badge.fury.io/rb/config_mapper.svg)](https://badge.fury.io/rb/config_mapper)
-[![Build Status](https://travis-ci.org/mdub/config_mapper.svg?branch=master)](https://travis-ci.org/mdub/config_mapper)
+[![Build Status](https://github.com/mdub/config_mapper/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/mdub/config_mapper/actions/workflows/test.yaml)
 
 ConfigMapper maps configuration data onto Ruby objects.
 
@@ -72,21 +72,6 @@ state.orientation              #=> "North"
 state.position.x               #=> 2
 ```
 
-It can even populate Hashes of objects, e.g.
-
-```ruby
-positions = Hash.new { |h,k| h[k] = Position.new }
-
-config_data = {
-  "fred" => { "x" => 2, "y" => 4 },
-  "mary" => { "x" => 3, "y" => 5 }
-}
-
-ConfigMapper.configure_with(config_data, positions)
-positions["fred"].x            #=> 2
-positions["mary"].y            #=> 5
-```
-
 ### Target object
 
 Given
@@ -134,7 +119,7 @@ makes it even easier to declare configuration data-structures.
 
 ### Attributes
 
-The `attribute` method is similar to `attr_accessor`, defining both reader and writer methods for the named attribute.   
+The `attribute` method is similar to `attr_accessor`, defining both reader and writer methods for the named attribute.
 
 ```ruby
 require "config_mapper/config_struct"
@@ -204,7 +189,7 @@ Specify a default value of `nil` to mark an attribute as optional. Attributes wi
 
 ### Sub-components
 
-The `component` method defines a nested component object, itself a `ConfigStruct`.  
+The `component` method defines a nested component object, itself a `ConfigStruct`.
 
 ```ruby
 class State < ConfigMapper::ConfigStruct
@@ -217,6 +202,35 @@ class State < ConfigMapper::ConfigStruct
 end
 ```
 
+`component_list` declares a nested list of configurable objects, indexed by position.
+
+```ruby
+class Polygon < ConfigMapper::ConfigStruct
+
+  component_list :points do
+    attribute :x
+    attribute :y
+  end
+
+end
+
+```
+
+`component_dict` declares a dictionary (map) of configurable objects, indexed by an arbitrary key.
+
+```ruby
+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/collection_mapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "config_mapper/mapper"
 
 module ConfigMapper
@@ -22,7 +24,7 @@ module ConfigMapper
       @hash[key] = value
     end
 
-    def can_set?(key)
+    def can_set?(_key)
       @hash.respond_to?("[]=")
     end
 

data/lib/config_mapper/config_dict.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "config_mapper/factory"
 require "config_mapper/validator"
 require "forwardable"
@@ -22,6 +24,7 @@ module ConfigMapper
 
       def config_doc
         return {} unless entry_factory.respond_to?(:config_doc)
+
         {}.tap do |result|
           entry_factory.config_doc.each do |path, doc|
             result["[X]#{path}"] = doc
@@ -55,6 +58,7 @@ module ConfigMapper
         each do |key, value|
           prefix = "[#{key.inspect}]"
           next unless value.respond_to?(:config_errors)
+
           value.config_errors.each do |path, path_errors|
             errors["#{prefix}#{path}"] = path_errors
           end

data/lib/config_mapper/config_list.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+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|
+        if element.respond_to?(:to_h) then element.to_h
+        elsif element.respond_to?(:to_a) then 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "config_mapper"
 require "config_mapper/config_dict"
 require "config_mapper/factory"
@@ -36,8 +38,7 @@ module ConfigMapper
       # @param default default value
       # @yield type-coercion block
       #
-      def attribute(name, type = nil, default: :no_default, description: nil, &type_block)
-
+      def attribute(name, type = nil, default: :no_default, description: nil, &type_block) # rubocop:disable Metrics/PerceivedComplexity
         attribute = attribute!(name)
         attribute.description = description
 
@@ -52,12 +53,11 @@ module ConfigMapper
         define_method("#{attribute.name}=") do |value|
           if value.nil?
             raise NoValueProvided if attribute.required
-          else
-            value = attribute.validator.call(value) if attribute.validator
+          elsif attribute.validator
+            value = attribute.validator.call(value)
           end
           instance_variable_set("@#{attribute.name}", value)
         end
-
       end
 
       # Defines a sub-component.
@@ -86,7 +86,20 @@ module ConfigMapper
       #
       def component_dict(name, type: ConfigStruct, key_type: nil, description: nil, &block)
         type = Class.new(type, &block) if block
-        component(name, type: ConfigDict::Factory.new(type, key_type), description: description)
+        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.
@@ -106,8 +119,10 @@ module ConfigMapper
 
       def each_attribute(&action)
         return enum_for(:each_attribute) unless action
+
         ancestors.each do |klass|
           next unless klass.respond_to?(:attributes)
+
           klass.attributes.each(&action)
         end
       end
@@ -157,8 +172,10 @@ module ConfigMapper
       {}.tap do |result|
         self.class.each_attribute do |attribute|
           value = send(attribute.name)
-          if value && value.respond_to?(:to_h) && !value.is_a?(Array)
+          if value&.respond_to?(:to_h) && !value.is_a?(Array) && !value.is_a?(ConfigList)
             value = value.to_h
+          elsif value&.respond_to?(:to_a)
+            value = value.to_a
           end
           result[attribute.name.to_s] = value
         end
@@ -171,6 +188,7 @@ module ConfigMapper
       {}.tap do |result|
         self.class.each_attribute do |a|
           next unless a.factory
+
           result[".#{a.name}"] = instance_variable_get("@#{a.name}")
         end
       end
@@ -187,9 +205,7 @@ module ConfigMapper
     def missing_required_attribute_errors
       {}.tap do |errors|
         self.class.each_attribute do |a|
-          if a.required && instance_variable_get("@#{a.name}").nil?
-            errors[".#{a.name}"] = NoValueProvided.new
-          end
+          errors[".#{a.name}"] = NoValueProvided.new if a.required && instance_variable_get("@#{a.name}").nil?
         end
       end
     end
@@ -198,6 +214,7 @@ module ConfigMapper
       {}.tap do |errors|
         components.each do |component_path, component_value|
           next unless component_value.respond_to?(:config_errors)
+
           component_value.config_errors.each do |path, value|
             errors["#{component_path}#{path}"] = value
           end
@@ -212,15 +229,16 @@ module ConfigMapper
       end
 
       attr_reader :name
+      attr_reader :factory
 
       attr_accessor :description
-      attr_accessor :factory
       attr_accessor :validator
       attr_accessor :default
       attr_accessor :required
 
       def initial_value
         return factory.new if factory
+
         default
       end
 
@@ -246,6 +264,7 @@ module ConfigMapper
 
       def type_doc
         return {} unless factory.respond_to?(:config_doc)
+
         factory.config_doc.each_with_object({}) do |(path, doc), result|
           result[".#{name}#{path}"] = doc
         end

data/lib/config_mapper/factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ConfigMapper
 
   module Factory
@@ -5,6 +7,7 @@ module ConfigMapper
     def self.resolve(arg)
       return arg if arg.respond_to?(:new)
       return ProcFactory.new(arg) if arg.respond_to?(:call)
+
       raise ArgumentError, "invalid factory"
     end
 
@@ -12,7 +15,7 @@ module ConfigMapper
 
   class ProcFactory
 
-    def initialize(f)
+    def initialize(f) # rubocop:disable Naming/MethodParameterName
       @f = f
     end
 

data/lib/config_mapper/mapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ConfigMapper
 
   # Something that accepts configuration.

data/lib/config_mapper/mapping_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ConfigMapper
 
   # Thrown to indicate a problem parsing config.
@@ -16,7 +18,7 @@ module ConfigMapper
     def generate_message
       result = "configuration error"
       errors_by_field.each do |field, error|
-        result << "\n  #{field[1..-1]} - #{error}"
+        result += "\n  #{field[1..-1]} - #{error}"
       end
       result
     end

data/lib/config_mapper/object_mapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "config_mapper/mapper"
 
 module ConfigMapper

data/lib/config_mapper/validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ConfigMapper
 
   module Validator
@@ -8,6 +10,7 @@ module ConfigMapper
         # looks like a primitive class -- find the corresponding coercion method
         return Kernel.method(arg.name)
       end
+
       arg
     end
 

data/lib/config_mapper/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ConfigMapper
 
-  VERSION = "1.6.0".freeze
+  VERSION = "1.8.0"
 
 end

data/lib/config_mapper.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_mapper
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Mike Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,43 +16,57 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 1.46.0
+description:
 email:
 - mdub@dogbiscuit.org
 executables: []
@@ -64,6 +78,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
@@ -75,7 +90,7 @@ homepage: https://github.com/mdub/config_mapper
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,16 +98,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Maps config data onto plain old objects
 test_files: []