rggen-core 0.19.0 → 0.23.1

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module Builder
+      class LoaderRegistry
+        def initialize
+          @loaders = []
+          @extractors = []
+          @ignore_values = {}
+        end
+
+        def register_loader(loader)
+          register_loaders([loader])
+        end
+
+        def register_loaders(loaders)
+          @loaders.concat(Array(loaders))
+        end
+
+        def define_value_extractor(layers, value, &body)
+          @extractors <<
+            create_extractor(layers, value, &body)
+        end
+
+        def ignore_value(layers, value)
+          ignore_values(layers, [value])
+        end
+
+        def ignore_values(layers, values)
+          [layers].flatten.each do |layer|
+            (@ignore_values[layer] ||= []).concat(Array(values))
+          end
+        end
+
+        def create_loaders
+          @loaders.map { |loader| loader.new(@extractors, @ignore_values) }
+        end
+
+        private
+
+        def create_extractor(layers, value, &body)
+          Class.new(Core::InputBase::InputValueExtractor, &body).new(layers, value)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module Builder
+      class Plugin
+        DEFAULT_PLUGIN_VERSION = '0.0.0'
+
+        def initialize(plugin_module, &block)
+          @plugin_module = plugin_module
+          @block = block
+          plugin_name # check if plugin name is given
+        end
+
+        def default_setup(builder)
+          @plugin_module.respond_to?(:default_setup) &&
+            @plugin_module.default_setup(builder)
+        end
+
+        def optional_setup(builder)
+          @block && @plugin_module.instance_exec(builder, &@block)
+        end
+
+        def plugin_name
+          if @plugin_module.const_defined?(:PLUGIN_NAME)
+            @plugin_module.const_get(:PLUGIN_NAME)
+          elsif @plugin_module.respond_to?(:plugin_name)
+            @plugin_module.plugin_name
+          else
+            raise Core::PluginError.new('no plugin name is given')
+          end
+        end
+
+        def version
+          if @plugin_module.const_defined?(:VERSION)
+            @plugin_module.const_get(:VERSION)
+          elsif @plugin_module.respond_to?(:version)
+            @plugin_module.version
+          else
+            DEFAULT_PLUGIN_VERSION
+          end
+        end
+
+        def version_info
+          "#{plugin_name} #{version}"
+        end
+      end
+
+      class PluginManager
+        def initialize(builder)
+          @builder = builder
+          @plugins = []
+        end
+
+        def load_plugin(setup_path_or_name)
+          setup_path_or_name = setup_path_or_name.to_s.strip
+          setup_path =
+            if setup_file_directly_given?(setup_path_or_name)
+              setup_path_or_name
+            else
+              get_setup_path(setup_path_or_name)
+            end
+          read_setup_file(setup_path, setup_path_or_name)
+        end
+
+        def load_plugins(plugins, no_default_plugins, activation = true)
+          RgGen.builder(@builder)
+          merge_plugins(plugins, no_default_plugins)
+            .each { |plugin| load_plugin(*plugin) }
+          activation && activate_plugins
+        end
+
+        def setup(plugin_module, &block)
+          @plugins << Plugin.new(plugin_module, &block)
+        end
+
+        def activate_plugins(**options)
+          options[:no_default_setup] ||
+            @plugins.each { |plugin| plugin.default_setup(@builder) }
+          options[:no_optional_setup] ||
+            @plugins.each { |plugin| plugin.optional_setup(@builder) }
+        end
+
+        def version_info
+          @plugins.map(&:version_info)
+        end
+
+        private
+
+        def setup_file_directly_given?(setup_path_or_name)
+          File.ext(setup_path_or_name) == 'rb' ||
+            File.basename(setup_path_or_name, '.*') == 'setup'
+        end
+
+        def get_setup_path(name)
+          base, sub_directory = name.split('/', 2)
+          base = base.sub(/^rggen[-_]/, '').tr('-', '_')
+          File.join(*[
+            'rggen', base, sub_directory || '', 'setup'
+          ].reject(&:empty?))
+        end
+
+        def read_setup_file(setup_path, setup_path_or_name)
+          require setup_path
+        rescue ::LoadError
+          raise Core::PluginError.new([
+            "cannot load such plugin: #{setup_path_or_name}",
+            setup_path_or_name != setup_path && " (#{setup_path})" || ''
+          ].join)
+        end
+
+        def merge_plugins(plugins, no_default_plugins)
+          [
+            *default_plugins(no_default_plugins),
+            *plugins_from_env,
+            *plugins
+          ]
+        end
+
+        DEFAULT_PLUGSINS = 'rggen/setup'
+
+        def default_plugins(no_default_plugins)
+          load_default_plugins?(no_default_plugins) && DEFAULT_PLUGSINS || nil
+        end
+
+        def load_default_plugins?(no_default_plugins)
+          return false if no_default_plugins
+          return false if ENV.key?('RGGEN_NO_DEFAULT_PLUGINS')
+          return false if Gem.find_files(DEFAULT_PLUGSINS).empty?
+          true
+        end
+
+        def plugins_from_env
+          ENV['RGGEN_PLUGINS']
+            &.split(':')&.map(&:strip)&.reject(&:empty?)
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/configuration.rb

@@ -10,8 +10,9 @@ module RgGen
             feature Feature, FeatureFactory
           end
 
-          base_loader Loader
-          register_loaders [RubyLoader, JSONLoader, YAMLLoader]
+          register_loader :ruby, RubyLoader
+          register_loader :yaml, YAMLLoader
+          register_loader :json, JSONLoader
         end
       end
     end

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

@@ -4,6 +4,11 @@ module RgGen
   module Core
     module Configuration
       class Component < InputBase::Component
+        private
+
+        def post_initialize
+          need_no_children
+        end
       end
     end
   end

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

@@ -7,7 +7,7 @@ module RgGen
         private
 
         def create_input_data(&block)
-          InputBase::InputData.new(valid_value_lists, &block)
+          InputData.new(valid_value_lists, &block)
         end
       end
     end

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

@@ -4,8 +4,10 @@ module RgGen
   module Core
     module Configuration
       module HashLoader
-        def format(read_data, file)
-          input_data.values(Hash(read_data), file)
+        private
+
+        def format_layer_data(read_data, _layer, file)
+          Hash(read_data)
         rescue TypeError => e
           raise Core::LoadError.new(e.message, file)
         end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module Configuration
+      class InputData < InputBase::InputData
+        def initialize(valid_value_lists, &block)
+          super(nil, valid_value_lists, &block)
+        end
+
+        undef_method :child
+      end
+    end
+  end
+end

data/lib/rggen/core/dsl.rb

@@ -15,11 +15,13 @@ module RgGen
         :define_simple_feature,
         :define_list_feature,
         :define_list_item_feature,
+        :define_value_extractor,
         :enable,
         :disable_all,
         :disable,
         :delete,
-        :setup
+        :setup,
+        :load_plugin
       ].each do |method_name|
         def_delegator :'RgGen.builder', method_name
       end

data/lib/rggen/core/exceptions.rb

@@ -3,23 +3,28 @@
 module RgGen
   module Core
     class RgGenError < StandardError
-      def initialize(message, additional_info = nil)
+      def initialize(message, location_info = nil, verbose_info = nil)
         super(message)
         @error_message = message
-        @additional_info = additional_info
+        @location_info = location_info
+        @verbose_info = verbose_info
       end
 
       attr_reader :error_message
-      attr_reader :additional_info
+      attr_reader :location_info
+      attr_reader :verbose_info
 
       def to_s
-        additional_info ? "#{super} -- #{additional_info}" : super
+        location_info && "#{super} -- #{location_info}" || super
       end
     end
 
     class BuilderError < RgGenError
     end
 
+    class PluginError < RgGenError
+    end
+
     class RuntimeError < RgGenError
     end
 

data/lib/rggen/core/generator.rb

@@ -4,7 +4,7 @@ module RgGen
   module Core
     class Generator
       def run(builder, options)
-        load_setup_file(builder, options[:setup])
+        load_plugins(builder, options)
         load_configuration(builder, options[:configuration])
         load_register_map(builder, options.register_map_files)
         write_files(builder, options)
@@ -15,8 +15,8 @@ module RgGen
       attr_reader :configuration
       attr_reader :register_map
 
-      def load_setup_file(builder, file)
-        builder.load_setup_file(file)
+      def load_plugins(builder, options)
+        builder.load_plugins(options[:plugins], options[:no_default_plugins])
       end
 
       def load_configuration(builder, file)

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

@@ -4,6 +4,20 @@ module RgGen
   module Core
     module InputBase
       class ComponentFactory < Base::ComponentFactory
+        class << self
+          def enable_no_children_error
+            @enable_no_children_error = true
+          end
+
+          def disable_no_children_error
+            @enable_no_children_error = false
+          end
+
+          def enable_no_children_error?
+            @enable_no_children_error.nil? || @enable_no_children_error
+          end
+        end
+
         attr_setter :loaders
 
         private
@@ -27,8 +41,13 @@ module RgGen
         end
 
         def find_loader(file)
-          loader = loaders.find { |l| l.support?(file) }
-          loader || (raise Core::LoadError.new('unsupported file type', file))
+          loaders.find { |l| l.support?(file) } ||
+            (raise Core::LoadError.new('unsupported file type', file))
+        end
+
+        def valid_value_lists
+          component_factories
+            .transform_values(&->(f) { f.valid_value_list })
         end
 
         def create_input_data(&block)
@@ -58,9 +77,23 @@ module RgGen
         end
 
         def post_build(component)
+          exist_no_children?(component) &&
+            raise_no_children_error(component)
           component.verify(:component)
         end
 
+        def exist_no_children?(component)
+          enable_no_children_error? &&
+            component.need_children? && component.children.empty?
+        end
+
+        def enable_no_children_error?
+          self.class.enable_no_children_error?
+        end
+
+        def raise_no_children_error(_component)
+        end
+
         def finalize(component)
           component.verify(:all)
         end
@@ -77,10 +110,8 @@ module RgGen
 
         protected
 
-        def valid_value_lists
-          list = [Array(active_feature_factories&.keys)]
-          list.concat(Array(child_factory&.valid_value_lists))
-          list
+        def valid_value_list
+          Array(active_feature_factories&.keys)
         end
       end
     end

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

@@ -80,9 +80,9 @@ module RgGen
           end
 
           def export_verifiers(subclass)
-            copied_verifiers =
-              @verifiers.map { |scope, blocks| [scope, blocks.dup] }.to_h
-            subclass.instance_variable_set(:@verifiers, copied_verifiers)
+            subclass.instance_variable_set(
+              :@verifiers, @verifiers.transform_values(&:dup)
+            )
           end
         end
 

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

@@ -4,7 +4,8 @@ module RgGen
   module Core
     module InputBase
       class InputData
-        def initialize(valid_value_lists)
+        def initialize(layer, valid_value_lists)
+          @layer = layer
           @valid_value_lists = valid_value_lists
           @values = Hash.new(NAValue)
           @children = []
@@ -12,6 +13,8 @@ module RgGen
           block_given? && yield(self)
         end
 
+        attr_reader :layer
+
         def value(value_name, value, position = nil)
           symbolized_name = value_name.to_sym
           return unless valid_value?(symbolized_name)
@@ -24,8 +27,8 @@ module RgGen
             end
         end
 
-        def []=(value_name, position = nil, value)
-          value(value_name, value, position)
+        def []=(value_name, position_or_value, value = nil)
+          value(value_name, value || position_or_value, position_or_value)
         end
 
         def [](value_name)
@@ -39,8 +42,8 @@ module RgGen
 
         attr_reader :children
 
-        def child(value_list = nil, &block)
-          create_child_data do |child_data|
+        def child(layer, value_list = nil, &block)
+          create_child_data(layer) do |child_data|
             child_data.build_by_block(block)
             child_data.values(value_list)
             @children << child_data
@@ -56,11 +59,11 @@ module RgGen
         private
 
         def valid_value?(value_name)
-          @valid_value_lists.first.include?(value_name)
+          @valid_value_lists[layer].include?(value_name)
         end
 
         def define_setter_methods
-          @valid_value_lists.first.each(&method(:define_setter_method))
+          @valid_value_lists[layer].each(&method(:define_setter_method))
         end
 
         def define_setter_method(value_name)
@@ -79,12 +82,12 @@ module RgGen
           locations[0].path.include?('docile') ? locations[1] : locations[0]
         end
 
-        def create_child_data(&block)
-          child_data_class.new(@valid_value_lists[1..-1], &block)
+        def create_child_data(layer, &block)
+          child_data_class.new(layer, @valid_value_lists, &block)
         end
 
         def child_data_class
-          InputData
+          self.class
         end
 
         protected