rggen-core 0.29.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18a9718f8b5e18dc5fff8f27e29df34c94017f3964cd63d2f6fa09eb5627a7de
-  data.tar.gz: 21993e58645d31298ec8a8044f1eb05d436a2a05b10215b8f93f5e91443daf03
+  metadata.gz: '0969d51d5ab39e5bf98ff6d7cb44ae8b9b4a7a9efea6d2c0eb47a8cd9685b4c2'
+  data.tar.gz: f5e71796fd8de70124491d20b3501680968edf8f12c15f3fc6e729791f7bdfd0
 SHA512:
-  metadata.gz: 92e3f06ffd5182911e805c145b08ebea4e74e2e07e618eb7311be527b2abc8e2fdc41b50f82e1565d38798b109d12d325ce15da3262b4ac9aabcad0df077b824
-  data.tar.gz: fc15825417a32f84cddcc5b776b24a51c2f2bc495e82001ca3912a4e7f992e5bfa0b366a19d6ae37f080d3bad9258213a8701c9b9c5b8bff1332f0835fde4377
+  metadata.gz: 9c27bfff2f272e80ca16331a3071560962e80051e0c4e566ae277bff99a5097cd32ccc87519f4c37a466bacd826da60c882b3e032492439d7c282437fc4d4aeb
+  data.tar.gz: b8b2365ac6de6ec997dbb3054d91a46e5c761218460ec416dcaf126e35549f38643f94d446c3b865bdc9e0346a4d7e7ead38e0665e9b09510ef7d6083013cbd5

data/lib/rggen/core/builder/feature_registry.rb

@@ -30,12 +30,11 @@ module RgGen
           entry.define_feature(feature_name, context, &body)
         end
 
-        def enable(feature_or_list_names, feature_names = nil)
-          if feature_names
-            list_name = feature_or_list_names
+        def enable(list_name = nil, feature_names)
+          if list_name
             (@enabled_features[list_name] ||= []).merge!(Array(feature_names))
           else
-            Array(feature_or_list_names).each do |name|
+            Array(feature_names).each do |name|
               @enabled_features.key?(name) || (@enabled_features[name] = nil)
             end
           end
@@ -45,21 +44,23 @@ module RgGen
           @enabled_features.clear
         end
 
-        def delete(feature_or_list_names = nil, feature_names = nil)
-          if feature_names
-            @feature_entries[feature_or_list_names]&.delete(feature_names)
-          elsif feature_or_list_names
-            Array(feature_or_list_names).each(&@feature_entries.method(:delete))
+        def delete(list_name = nil, feature_names)
+          if list_name
+            @feature_entries[list_name]&.delete(feature_names)
           else
-            @feature_entries.clear
+            Array(feature_names).each(&@feature_entries.method(:delete))
           end
         end
 
-        def feature?(feature_or_list_name, feature_name = nil)
-          if feature_name
-            list_feature?(feature_or_list_name, feature_name)
+        def delete_all
+          @feature_entries.clear
+        end
+
+        def feature?(list_name = nil, feature_name)
+          if list_name
+            list_feature?(list_name, feature_name)
           else
-            @feature_entries.key?(feature_or_list_name)
+            @feature_entries.key?(feature_name)
           end
         end
 

data/lib/rggen/core/builder/input_component_registry.rb

@@ -23,9 +23,9 @@ module RgGen
           block_given? && yield(@loader_registries[loader_type])
         end
 
-        def define_value_extractor(loader_type, layers_or_value, value = nil, &body)
+        def define_value_extractor(loader_type, layers = nil, value, &body)
           @loader_registries[loader_type]
-            .define_value_extractor(layers_or_value, value, &body)
+            .define_value_extractor(layers, value, &body)
         end
 
         def build_factory

data/lib/rggen/core/builder/layer.rb

@@ -94,9 +94,9 @@ module RgGen
           end
         end
 
-        def enable(feature_or_list_names, feature_names = nil)
+        def enable(...)
           @feature_registries.each_value do |registry|
-            registry.enable(feature_or_list_names, feature_names)
+            registry.enable(...)
           end
         end
 
@@ -104,12 +104,16 @@ module RgGen
           @feature_registries.each_value(&:enable_all)
         end
 
-        def delete(feature_or_list_names = nil, feature_names = nil)
+        def delete(...)
           @feature_registries.each_value do |registry|
-            registry.delete(*[feature_or_list_names, feature_names].compact)
+            registry.delete(...)
           end
         end
 
+        def delete_all
+          @feature_registries.each_value(&:delete_all)
+        end
+
         private
 
         def define_proxy_call(name)

data/lib/rggen/core/builder/loader_registry.rb

@@ -18,18 +18,15 @@ module RgGen
           @loaders.concat(Array(loaders))
         end
 
-        def define_value_extractor(layers_or_value, value = nil, &body)
-          value, layers = [value, layers_or_value].compact
+        def define_value_extractor(layers = nil, value, &body)
           @extractors << create_extractor(layers, value, &body)
         end
 
-        def ignore_value(layers_or_value, value = nil)
-          value, layers = [value, layers_or_value].compact
+        def ignore_value(layers = nil, value)
           ignore_values(layers, [value])
         end
 
-        def ignore_values(layers_or_values, values = nil)
-          values, layers = [values, layers_or_values].compact
+        def ignore_values(layers = nil, values)
           [layers].flatten.each do |layer|
             (@ignore_values[layer] ||= []).concat(Array(values))
           end

data/lib/rggen/core/configuration/component_factory.rb

@@ -6,7 +6,7 @@ module RgGen
       class ComponentFactory < InputBase::ComponentFactory
         private
 
-        def create_input_data(&block)
+        def create_input_data(*_args, &block)
           InputData.new(valid_value_lists, &block)
         end
       end

data/lib/rggen/core/configuration/error.rb

@@ -7,16 +7,13 @@ module RgGen
       end
 
       module RaiseError
+        include InputBase::RaiseError
+
         private
 
         def error_exception
           ConfigurationError
         end
-
-        def error(message, input_value = nil)
-          position = input_value.position if input_value.respond_to?(:position)
-          raise ConfigurationError.new(message, position || @position)
-        end
       end
     end
   end

data/lib/rggen/core/input_base/component_factory.rb

@@ -24,14 +24,15 @@ module RgGen
 
         def preprocess(args)
           if root_factory?
-            [*args[0..-2], load_files(args.last)]
+            [*args[0..-2], load_files(args)]
           else
             args
           end
         end
 
-        def load_files(files)
-          create_input_data do |input_data|
+        def load_files(args)
+          files = args.last
+          create_input_data(*args[0..-2]) do |input_data|
             files.each { |file| load_file(file, input_data) }
           end
         end
@@ -50,7 +51,7 @@ module RgGen
             .transform_values(&->(f) { f.valid_value_list })
         end
 
-        def create_input_data(&block)
+        def create_input_data(*_args, &block)
         end
 
         def create_features(component, *sources)

data/lib/rggen/core/input_base/conversion_utility.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module InputBase
+      module ConversionUtility
+        private
+
+        def to_int(value, position = nil)
+          v, pos =
+            if value.is_a?(InputValue)
+              [value.value, value.position]
+            else
+              [value, position]
+            end
+          Integer(v)
+        rescue ArgumentError, TypeError
+          message = yield(v)
+          error message, pos
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/input_base/error.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module InputBase
+      ApproximatelyErrorPosition = Struct.new(:position) do
+        def self.create(position)
+          position && new(position)
+        end
+
+        def to_s
+          "#{position} (approximately)"
+        end
+      end
+
+      module RaiseError
+        private
+
+        def error(message, position = nil)
+          pos = extract_error_position(position)
+          raise error_exception.new(message, pos)
+        end
+
+        def extract_error_position(position)
+          pos =
+            if position.respond_to?(:position)
+              position.position
+            else
+              position
+            end
+          pos ||
+            if respond_to?(:error_position)
+              error_position
+            else
+              @position
+            end
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/input_base/feature.rb

@@ -6,6 +6,7 @@ module RgGen
       class Feature < Base::Feature
         include Utility::RegexpPatterns
         include Utility::TypeChecker
+        include ConversionUtility
 
         class << self
           def property(name, **options, &body)
@@ -29,15 +30,13 @@ module RgGen
           end
 
           def build(&block)
-            @builders ||= []
-            @builders << block
+            (@builders ||= []) << block
           end
 
           attr_reader :builders
 
           def post_build(&block)
-            @post_builders ||= []
-            @post_builders << block
+            (@post_builders ||= []) << block
           end
 
           attr_reader :post_builders
@@ -64,8 +63,7 @@ module RgGen
           attr_reader :verifiers
 
           def printable(name, &body)
-            @printables ||= {}
-            @printables[name] = body
+            (@printables ||= {})[name] = body
           end
 
           attr_reader :printables
@@ -119,11 +117,22 @@ module RgGen
         end
 
         def inspect
-          printable_values =
-            printables&.map { |name, value| "#{name}: #{value.inspect}" }
+          printable_values = printables&.map { |name, value| "#{name}: #{value.inspect}" }
           (printable_values && "#{super}[#{printable_values.join(', ')}]") || super
         end
 
+        attr_reader :position
+
+        def error_position
+          if position
+            position
+          else
+            approximate_position =
+              component.features.map(&:position).find(&:itself)
+            ApproximatelyErrorPosition.create(approximate_position)
+          end
+        end
+
         private
 
         def do_build(args)
@@ -137,16 +146,12 @@ module RgGen
           self.class.builders.each { |builder| instance_exec(*args, &builder) }
         end
 
-        attr_reader :position
-
         def match_automatically?
-          matcher = self.class.input_matcher
-          matcher&.match_automatically?
+          self.class.input_matcher&.match_automatically?
         end
 
         def match_pattern(rhs)
-          matcher = self.class.input_matcher
-          @match_data, @match_index = matcher&.match(rhs)
+          @match_data, @match_index = self.class.input_matcher&.match(rhs)
         end
 
         attr_reader :match_data
@@ -161,8 +166,7 @@ module RgGen
         end
 
         def do_verify(scope)
-          self.class.verifiers&.[](scope)
-            &.each { |verifier| verifier.verify(self) }
+          self.class.verifiers&.[](scope)&.each { |verifier| verifier.verify(self) }
           (@verified ||= {})[scope] = true
         end
 

data/lib/rggen/core/input_base/feature_factory.rb

@@ -18,8 +18,8 @@ module RgGen
             @default_value
           end
 
-          def value_format(format = nil)
-            @value_format = format if format
+          def value_format(format = nil, **options)
+            @value_format = [format, options] if format
             @value_format
           end
         end
@@ -51,29 +51,31 @@ module RgGen
         end
 
         def process_active_input_value(input_value)
-          parseed_value, options =
+          parsed_value, options =
             if self.class.value_format
               parse_input_value(input_value, self.class.value_format)
             end
-          override_input_value(input_value, parseed_value, options) || input_value
+          override_input_value(input_value, parsed_value, options) || input_value
         end
 
         VALUE_PARSERS = {
-          value_with_options: ValueWithOptionsParser,
+          option_array: OptionArrayParser,
+          option_hash: OptionHashParser,
           hash_list: HashListParser
         }.freeze
 
         def parse_input_value(input_value, value_format)
-          VALUE_PARSERS[value_format].new(error_exception).parse(input_value)
+          format, options = value_format
+          VALUE_PARSERS[format].new(error_exception, **options).parse(input_value)
         end
 
-        def override_input_value(input_value, parseed_value, options)
-          (convert_value(input_value, parseed_value) || parseed_value)
+        def override_input_value(input_value, parsed_value, options)
+          (convert_value(input_value, parsed_value) || parsed_value)
             &.then { |v| InputValue.new(v, options, input_value.position) }
         end
 
-        def convert_value(input_value, parseed_value)
-          value = parseed_value || input_value.value
+        def convert_value(input_value, parsed_value)
+          value = parsed_value || input_value.value
           if empty_value?(value)
             evaluate_defalt_value(input_value.position)
           else

data/lib/rggen/core/input_base/input_data.rb

@@ -4,7 +4,7 @@ module RgGen
   module Core
     module InputBase
       class InputData
-        def initialize(layer, valid_value_lists)
+        def initialize(layer, valid_value_lists, *_args)
           @layer = layer
           @valid_value_lists = valid_value_lists
           @values = Hash.new(NAValue)
@@ -21,8 +21,8 @@ module RgGen
             assign_value(symbolized_name, value, position)
         end
 
-        def []=(value_name, position_or_value, value = nil)
-          value(value_name, value || position_or_value, position_or_value)
+        def []=(value_name, position = nil, value)
+          value(value_name, value, position)
         end
 
         def [](value_name)
@@ -87,8 +87,8 @@ module RgGen
           caller_location.path.include?('docile')
         end
 
-        def create_child_data(layer, &block)
-          child_data_class.new(layer, @valid_value_lists, &block)
+        def create_child_data(layer, *args, &block)
+          child_data_class.new(layer, @valid_value_lists, *args, &block)
         end
 
         def child_data_class

data/lib/rggen/core/input_base/input_value.rb

@@ -6,14 +6,10 @@ module RgGen
       class InputValue < ::SimpleDelegator
         NoValue = Object.new
 
-        def initialize(value, options_or_position, position = NoValue)
+        def initialize(value, options = NoValue, position)
           super((value.is_a?(String) && value.strip) || value)
-          @options, @position =
-            if position.equal?(NoValue)
-              [NoValue, options_or_position]
-            else
-              [options_or_position, position]
-            end
+          @options = options
+          @position = position
         end
 
         alias_method :value, :__getobj__

data/lib/rggen/core/input_base/input_vaue_parser.rb

@@ -6,7 +6,7 @@ module RgGen
       class InputValueParser
         include Utility::TypeChecker
 
-        def initialize(exception)
+        def initialize(exception, **_option)
           @exception = exception
         end
 
@@ -16,8 +16,13 @@ module RgGen
           string&.split(separator, limit)&.map(&:strip)
         end
 
-        def error(message, input_value = nil)
-          position = input_value.position if input_value.respond_to?(:position)
+        def error(message, position_or_input_value = nil)
+          position =
+            if position_or_input_value.respond_to?(:position)
+              position_or_input_value.position
+            else
+              position_or_input_value
+            end
           raise @exception.new(message, position)
         end
       end

data/lib/rggen/core/input_base/{value_with_options_parser.rb → option_array_parser.rb}

@@ -3,7 +3,7 @@
 module RgGen
   module Core
     module InputBase
-      class ValueWithOptionsParser < InputValueParser
+      class OptionArrayParser < InputValueParser
         def parse(input_value)
           value, options =
             if string?(input_value)

data/lib/rggen/core/input_base/option_hash_parser.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module InputBase
+      class OptionHashParser < InputValueParser
+        def initialize(exception, allowed_options: nil, multiple_values: false)
+          super
+          @allowed_options = allowed_options
+          @multiple_values = multiple_values
+        end
+
+        def parse(input_value)
+          values, options = parse_input_value(input_value)
+          check_result(values, options, input_value)
+          pack_result(values, options)
+        end
+
+        private
+
+        def parse_input_value(input_value)
+          values, options =
+            if string?(input_value)
+              parse_string_value(input_value)
+            elsif array?(input_value)
+              parse_array_value(input_value)
+            elsif hash?(input_value)
+              [nil, input_value]
+            elsif !input_value.empty_value?
+              [[input_value.value]]
+            end
+          [values || [], symbolize_keys(options) || {}]
+        end
+
+        def parse_string_value(input_value)
+          value_string, option_string = split_string(input_value, ':', 2)
+          values = split_string(value_string, /[,\n]/, 0)
+          options = parse_option_string(option_string, input_value.position)
+          [values, options]
+        end
+
+        def parse_option_string(option_string, position)
+          split_string(option_string, /[,\n]/, 0)
+            &.to_h { |option| split_string(option, ':', 2) }
+        rescue ArgumentError, TypeError
+          error "invalid options are given: #{option_string.inspect}", position
+        end
+
+        def parse_array_value(input_value)
+          input_value.each_with_object([[], {}]) do |item, (values, options)|
+            if value_item?(item, values)
+              values << item
+            else
+              update_option_hash(options, item, input_value.position)
+            end
+          end
+        end
+
+        def value_item?(item, values)
+          !hash?(item) && (@multiple_values || values.empty?)
+        end
+
+        def update_option_hash(option_hash, item, position)
+          option_hash.update(item)
+        rescue ArgumentError, TypeError
+          error "invalid option is given: #{item.inspect}", position
+        end
+
+        def symbolize_keys(options)
+          options&.transform_keys { |k| string?(k) && k.to_sym || k }
+        end
+
+        def check_result(values, options, input_value)
+          no_values?(values, options) &&
+            (error "no input values are given: #{input_value.inspect}", input_value)
+          illegal_value_size?(values) &&
+            (error "multiple input values are given: #{values}", input_value)
+          check_option(options, input_value.position)
+        end
+
+        def no_values?(values, options)
+          values.empty? && !options.empty?
+        end
+
+        def illegal_value_size?(values)
+          !@multiple_values && values.size > 1
+        end
+
+        def check_option(options, position)
+          return if @allowed_options.nil? || @allowed_options.empty?
+          return if options.nil? || options.empty?
+
+          unknown_options = options.keys - @allowed_options
+          unknown_options.empty? ||
+            (error "unknown options are given: #{unknown_options}", position)
+        end
+
+        def pack_result(values, options)
+          [@multiple_values && values || values.first, options]
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/register_map/component_factory.rb

@@ -12,8 +12,8 @@ module RgGen
           configuration
         end
 
-        def create_input_data(&block)
-          InputData.new(:root, valid_value_lists, &block)
+        def create_input_data(configuration, &block)
+          InputData.new(:root, valid_value_lists, configuration, &block)
         end
 
         def find_child_factory(_configuration, register_map)

data/lib/rggen/core/register_map/error.rb

@@ -7,16 +7,13 @@ module RgGen
       end
 
       module RaiseError
+        include InputBase::RaiseError
+
         private
 
         def error_exception
           RegisterMapError
         end
-
-        def error(message, input_value = nil)
-          position = input_value.position if input_value.respond_to?(:position)
-          raise RegisterMapError.new(message, position || @position)
-        end
       end
     end
   end

data/lib/rggen/core/register_map/input_data.rb

@@ -38,9 +38,18 @@ module RgGen
           bit_field: BitField
         }.freeze
 
-        def initialize(layer, valid_value_list)
+        def initialize(layer, valid_value_list, configuration)
           extend(LAYER_EXTENSIONS[layer])
-          super
+          @configuration = configuration
+          super(layer, valid_value_list)
+        end
+
+        attr_reader :configuration
+
+        private
+
+        def create_child_data(layer, &block)
+          super(layer, @configuration, &block)
         end
       end
     end

data/lib/rggen/core/version.rb

@@ -2,7 +2,7 @@
 
 module RgGen
   module Core
-    VERSION = '0.29.0'
+    VERSION = '0.31.0'
     MAJOR, MINOR, PATCH = VERSION.split('.').map(&:to_i)
   end
 end

data/lib/rggen/core.rb

@@ -42,6 +42,8 @@ require_relative 'core/base/feature_layer_extension'
 require_relative 'core/input_base/input_value'
 require_relative 'core/input_base/input_data'
 require_relative 'core/input_base/input_value_extractor'
+require_relative 'core/input_base/error'
+require_relative 'core/input_base/conversion_utility'
 require_relative 'core/input_base/loader'
 require_relative 'core/input_base/json_loader'
 require_relative 'core/input_base/toml_loader'
@@ -53,7 +55,8 @@ require_relative 'core/input_base/verifier'
 require_relative 'core/input_base/property'
 require_relative 'core/input_base/feature'
 require_relative 'core/input_base/input_vaue_parser'
-require_relative 'core/input_base/value_with_options_parser'
+require_relative 'core/input_base/option_array_parser'
+require_relative 'core/input_base/option_hash_parser'
 require_relative 'core/input_base/hash_list_parser'
 require_relative 'core/input_base/feature_factory'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-core
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -144,6 +144,8 @@ files:
 - lib/rggen/core/generator.rb
 - lib/rggen/core/input_base/component.rb
 - lib/rggen/core/input_base/component_factory.rb
+- lib/rggen/core/input_base/conversion_utility.rb
+- lib/rggen/core/input_base/error.rb
 - lib/rggen/core/input_base/feature.rb
 - lib/rggen/core/input_base/feature_factory.rb
 - lib/rggen/core/input_base/hash_list_parser.rb
@@ -154,9 +156,10 @@ files:
 - lib/rggen/core/input_base/input_vaue_parser.rb
 - lib/rggen/core/input_base/json_loader.rb
 - lib/rggen/core/input_base/loader.rb
+- lib/rggen/core/input_base/option_array_parser.rb
+- lib/rggen/core/input_base/option_hash_parser.rb
 - lib/rggen/core/input_base/property.rb
 - lib/rggen/core/input_base/toml_loader.rb
-- lib/rggen/core/input_base/value_with_options_parser.rb
 - lib/rggen/core/input_base/verifier.rb
 - lib/rggen/core/input_base/yaml_loader.rb
 - lib/rggen/core/options.rb
@@ -219,8 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
-summary: rggen-core-0.29.0
+summary: rggen-core-0.31.0
 test_files: []