rggen-core 0.23.1 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d508be683e4b6306f85c0fa2c793e98ba33dc2710dab29c07ae0fb720c0b1e20
-  data.tar.gz: a19ac7cea3493c7128672f343dee9833199d9e2c3769fdf0cd4679c3cc464c6d
+  metadata.gz: 040113a3bef96502aae386b3aa7dafcca07af29d8881b41bfc6e17b3e0769885
+  data.tar.gz: 4392f0ae0bc1cd8d7422606eea73f11dffe293e29cc39250c5fd3479581dc349
 SHA512:
-  metadata.gz: f173621ce29ca6664d0201b4af80d9851151ab71dbd01f3027793d48402533ee9b8941d7149e5df0039370b4701975c9e926af2b36c94d8253bb6921ef3710b9
-  data.tar.gz: 0a7bdf33b0708f3e493b79f932fb4daf1400ea68fef957d040ef6ff5b6e1881b783b06d78d7d43a857034bc98addb3c10bb0238b01e0d7d93921c49a7ec3901b
+  metadata.gz: c77e46129bc726cb7afee6b21b3b31e2a692ee3fa2d99aade8eb6f6a3d1082e4f3fab1c83ff4f20afead532c521dfea6f23c8c6762a0b54ed9ab9cfbf013b484
+  data.tar.gz: c20b96a0be7b1f15cae6cc8b1512d05b83d8f06cb3407b34fe1731221065de3467522bdabfd74b2b5336fcc96b245a9eff191629ff58c61635b8ca77af511be1

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2020 Taichi Ishitani
+Copyright (c) 2017-2021 Taichi Ishitani
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -13,6 +13,7 @@ RgGen::Core is a core library of RgGen tool and provides features listed below:
 * Basic loaders for configuration file and register map documents
     * Ruby with APIs for description
     * YAML
+    * TOML
     * JSON
 * Structure and APIs for defining output file writers
 * Building RgGen tool up by linking defined above features
@@ -43,7 +44,7 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 
 ## Copyright & License
 
-Copyright © 2017-2020 Taichi Ishitani. RgGen::Core is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+Copyright © 2017-2021 Taichi Ishitani. RgGen::Core is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
 
 ## Code of Conduct
 

data/lib/rggen/core.rb

@@ -8,6 +8,7 @@ require 'json'
 require 'optparse'
 require 'pathname'
 require 'singleton'
+require 'tomlrb'
 require 'yaml'
 
 require_relative 'core/version'
@@ -41,6 +42,7 @@ require_relative 'core/input_base/input_data'
 require_relative 'core/input_base/input_value_extractor'
 require_relative 'core/input_base/loader'
 require_relative 'core/input_base/json_loader'
+require_relative 'core/input_base/toml_loader'
 require_relative 'core/input_base/yaml_loader'
 require_relative 'core/input_base/component'
 require_relative 'core/input_base/component_factory'
@@ -60,6 +62,7 @@ require_relative 'core/configuration/loader'
 require_relative 'core/configuration/ruby_loader'
 require_relative 'core/configuration/hash_loader'
 require_relative 'core/configuration/json_loader'
+require_relative 'core/configuration/toml_loader'
 require_relative 'core/configuration/yaml_loader'
 require_relative 'core/configuration'
 
@@ -73,6 +76,7 @@ require_relative 'core/register_map/loader'
 require_relative 'core/register_map/ruby_loader'
 require_relative 'core/register_map/hash_loader'
 require_relative 'core/register_map/json_loader'
+require_relative 'core/register_map/toml_loader'
 require_relative 'core/register_map/yaml_loader'
 require_relative 'core/register_map'
 
@@ -95,10 +99,12 @@ require_relative 'core/builder/simple_feature_entry'
 require_relative 'core/builder/list_feature_entry'
 require_relative 'core/builder/feature_registry'
 require_relative 'core/builder/layer'
+require_relative 'core/builder/plugin_spec'
 require_relative 'core/builder/plugin_manager'
 require_relative 'core/builder/builder'
 require_relative 'core/builder'
 
+require_relative 'core/plugin'
 require_relative 'core/printers'
 require_relative 'core/options'
 require_relative 'core/dsl'

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

@@ -15,11 +15,11 @@ module RgGen
         attr_reader :plugin_manager
 
         def input_component_registry(name, &body)
-          component_registry(:input, name, body)
+          component_registry(:input, name, &body)
         end
 
         def output_component_registry(name, &body)
-          component_registry(:output, name, body)
+          component_registry(:output, name, &body)
         end
 
         [
@@ -32,6 +32,10 @@ module RgGen
           end
         end
 
+        def register_map_layers
+          REGISTER_MAP_LAYERS
+        end
+
         def add_feature_registry(name, target_layer, registry)
           target_layers =
             if target_layer
@@ -92,7 +96,7 @@ module RgGen
 
         def_delegator :plugin_manager, :load_plugin
         def_delegator :plugin_manager, :load_plugins
-        def_delegator :plugin_manager, :setup
+        def_delegator :plugin_manager, :register_plugin
 
         private
 
@@ -105,26 +109,30 @@ module RgGen
           end
         end
 
+        REGISTER_MAP_LAYERS = [
+          :root, :register_block, :register_file, :register, :bit_field
+        ].freeze
+
+        ALL_LAYERS = [
+          :global, *REGISTER_MAP_LAYERS
+        ].freeze
+
         def initialize_layers
           @layers = Hash.new do |_, layer_name|
             raise BuilderError.new("unknown layer: #{layer_name}")
           end
-          [
-            :global, :root, :register_block, :register_file, :register, :bit_field
-          ].each do |layer|
-            @layers[layer] = Layer.new(layer)
-          end
+          ALL_LAYERS.each { |layer| @layers[layer] = Layer.new(layer) }
         end
 
         COMPONENT_REGISTRIES = {
           input: InputComponentRegistry, output: OutputComponentRegistry
         }.freeze
 
-        def component_registry(type, name, body)
+        def component_registry(type, name, &body)
           registries = @component_registries[type]
           klass = COMPONENT_REGISTRIES[type]
           registries.key?(name) || (registries[name] = klass.new(name, self))
-          Docile.dsl_eval(registries[name], &body)
+          block_given? && Docile.dsl_eval(registries[name], &body) || registries[name]
         end
       end
     end

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

@@ -11,22 +11,22 @@ module RgGen
         end
 
         def register_component(layers = nil, &block)
-          if layers
-            Array(layers).each do |layer|
-              @entries << create_new_entry(layer, block)
-            end
-          else
-            @entries << create_new_entry(nil, block)
+          Array(layers || @builder.register_map_layers).each do |layer|
+            @entries << create_new_entry(layer, &block)
           end
         end
 
+        def register_global_component(&block)
+          @entries << create_new_entry(nil, &block)
+        end
+
         def build_factory
           build_factories.first.tap(&:root_factory)
         end
 
         private
 
-        def create_new_entry(layer, block)
+        def create_new_entry(layer, &block)
           entry = ComponentEntry.new(@component_name, layer)
           Docile.dsl_eval(entry, layer, &block)
           add_feature_registry(layer, entry.feature_registry)
@@ -35,8 +35,7 @@ module RgGen
 
         def add_feature_registry(layer, feature_registry)
           feature_registry &&
-            @builder
-              .add_feature_registry(@component_name, layer, feature_registry)
+            @builder.add_feature_registry(@component_name, layer, feature_registry)
         end
 
         def build_factories

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

@@ -3,46 +3,22 @@
 module RgGen
   module Core
     module Builder
-      class Plugin
-        DEFAULT_PLUGIN_VERSION = '0.0.0'
-
+      class PluginRegistry
         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)
+          @plugin_module.plugin_spec.activate(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}"
+          @plugin_module.plugin_spec.version_info
         end
       end
 
@@ -65,13 +41,14 @@ module RgGen
 
         def load_plugins(plugins, no_default_plugins, activation = true)
           RgGen.builder(@builder)
-          merge_plugins(plugins, no_default_plugins)
-            .each { |plugin| load_plugin(*plugin) }
+          merge_plugins(plugins, no_default_plugins).each(&method(:load_plugin))
           activation && activate_plugins
         end
 
-        def setup(plugin_module, &block)
-          @plugins << Plugin.new(plugin_module, &block)
+        def register_plugin(plugin_module, &block)
+          plugin?(plugin_module) ||
+            (raise Core::PluginError.new('no plugin spec is given'))
+          @plugins << PluginRegistry.new(plugin_module, &block)
         end
 
         def activate_plugins(**options)
@@ -95,18 +72,19 @@ module RgGen
         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?))
+          File.join(*['rggen', base, sub_directory, 'setup'].compact)
         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)
+          message =
+            if setup_path_or_name == setup_path
+              "cannot load such plugin: #{setup_path_or_name}"
+            else
+              "cannot load such plugin: #{setup_path_or_name} (#{setup_path})"
+            end
+          raise Core::PluginError.new(message)
         end
 
         def merge_plugins(plugins, no_default_plugins)
@@ -134,6 +112,10 @@ module RgGen
           ENV['RGGEN_PLUGINS']
             &.split(':')&.map(&:strip)&.reject(&:empty?)
         end
+
+        def plugin?(plugin_module)
+          plugin_module.respond_to?(:plugin_spec) && plugin_module.plugin_spec
+        end
       end
     end
   end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module Builder
+      class PluginSpec
+        def initialize(name, plugin_module)
+          @name = name
+          @plugin_module = plugin_module
+          @component_registrations = []
+          @loader_registrations = []
+          @files = []
+        end
+
+        def version(value = nil)
+          @version = value if value
+          version_value
+        end
+
+        def version_info
+          "#{@name} #{version}"
+        end
+
+        def register_component(component, layers = nil, &body)
+          @component_registrations << [component, layers, body]
+        end
+
+        def register_loader(component, loader_type, loader)
+          @loader_registrations << [component, loader_type, loader]
+        end
+
+        def register_loaders(component, loader_type, loaders)
+          Array(loaders)
+            .each { |loader| register_loader(component, loader_type, loader) }
+        end
+
+        def register_files(files)
+          root = File.dirname(caller_locations(1, 1).first.path)
+          files.each { |file| @files << File.join(root, file) }
+        end
+
+        alias_method :files, :register_files
+
+        def activate(builder)
+          activate_components(builder)
+          activate_loaders(builder)
+          load_files
+        end
+
+        private
+
+        DEFAULT_VERSION = '0.0.0'
+
+        def version_value
+          @version || const_version || DEFAULT_VERSION
+        end
+
+        def const_version
+          @plugin_module.const_defined?(:VERSION) &&
+            @plugin_module.const_get(:VERSION)
+        end
+
+        def activate_components(builder)
+          @component_registrations.each do |component, layers, body|
+            builder
+              .output_component_registry(component)
+              .register_component(layers, &body)
+          end
+        end
+
+        def activate_loaders(builder)
+          @loader_registrations.each do |component, loader_type, loader|
+            builder.register_loader(component, loader_type, loader)
+          end
+        end
+
+        def load_files
+          @files.each(&method(:require))
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/configuration.rb

@@ -5,14 +5,15 @@ module RgGen
     module Configuration
       def self.setup(builder)
         builder.input_component_registry(:configuration) do
-          register_component do
+          register_global_component do
             component Component, ComponentFactory
             feature Feature, FeatureFactory
           end
 
           register_loader :ruby, RubyLoader
-          register_loader :yaml, YAMLLoader
           register_loader :json, JSONLoader
+          register_loader :toml, TOMLLoader
+          register_loader :yaml, YAMLLoader
         end
       end
     end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module Configuration
+      class TOMLLoader < Loader
+        include HashLoader
+        include InputBase::TOMLLoader
+
+        support_types [:toml]
+
+        def read_file(file)
+          load_toml(file)
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/dsl.rb

@@ -20,7 +20,7 @@ module RgGen
         :disable_all,
         :disable,
         :delete,
-        :setup,
+        :register_plugin,
         :load_plugin
       ].each do |method_name|
         def_delegator :'RgGen.builder', method_name

data/lib/rggen/core/facets.rb

@@ -2,7 +2,6 @@
 
 require 'facets/array/merge'
 require 'facets/file/ext'
-require 'facets/hash/at'
 require 'facets/pathname/to_path'
 require 'facets/module/attr_setter'
 require 'facets/module/lastname'

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

@@ -149,8 +149,8 @@ module RgGen
         end
 
         def do_verify(scope)
-          Array(self.class.verifiers&.at(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/input_data.rb

@@ -51,9 +51,9 @@ module RgGen
         end
 
         def load_file(file)
-          build_by_block(
-            instance_eval("-> { #{File.binread(file)} }", file, 1)
-          )
+          build_by_block(instance_eval(<<~BODY, file, 1))
+            -> { #{File.binread(file)} }  # -> { File.binread(file) }
+          BODY
         end
 
         private
@@ -79,7 +79,11 @@ module RgGen
 
         def position_from_caller
           locations = caller_locations(3, 2)
-          locations[0].path.include?('docile') ? locations[1] : locations[0]
+          include_docile_path?(locations[0]) && locations[1] || locations[0]
+        end
+
+        def include_docile_path?(caller_location)
+          caller_location.path.include?('docile')
         end
 
         def create_child_data(layer, &block)

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module InputBase
+      module TOMLLoader
+        private
+
+        def load_toml(file)
+          toml = File.binread(file)
+          Tomlrb.parse(toml, symbolize_keys: true)
+        end
+      end
+    end
+  end
+end

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

@@ -25,16 +25,20 @@ module RgGen
           end
 
           def symbolize_keys(result)
-            if result.is_a? Hash
-              result.each_with_object({}) do |(key, value), hash|
-                hash[key.to_sym] = symbolize_keys(value)
-              end
-            elsif result.is_a? Array
-              result.map(&method(:symbolize_keys))
-            else
-              result
+            case result
+            when Hash then symbolize_hash(result)
+            when Array then symbolize_array(result)
+            else result
             end
           end
+
+          def symbolize_hash(result)
+            result.map { |key, value| [key.to_sym, symbolize_keys(value)] }.to_h
+          end
+
+          def symbolize_array(result)
+            result.map(&method(:symbolize_keys))
+          end
         end
 
         def load_yaml(file)

data/lib/rggen/core/output_base/code_generator.rb

@@ -31,7 +31,7 @@ module RgGen
           if block.arity.zero?
             code << context.instance_exec(&block)
           else
-            context .instance_exec(code, &block)
+            context.instance_exec(code, &block)
           end
         end
 

data/lib/rggen/core/plugin.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module Plugin
+      attr_reader :plugin_spec
+
+      private
+
+      def setup_plugin(name)
+        @plugin_spec = Builder::PluginSpec.new(name, self)
+        block_given? && yield(@plugin_spec)
+      end
+    end
+  end
+end

data/lib/rggen/core/register_map.rb

@@ -5,16 +5,15 @@ module RgGen
     module RegisterMap
       def self.setup(builder)
         builder.input_component_registry(:register_map) do
-          register_component [
-            :root, :register_block, :register_file, :register, :bit_field
-          ] do |layer|
+          register_component do
             component Component, ComponentFactory
-            feature Feature, FeatureFactory if layer != :root
+            feature Feature, FeatureFactory
           end
 
           register_loader :ruby, RubyLoader
-          register_loader :yaml, YAMLLoader
           register_loader :json, JSONLoader
+          register_loader :toml, TOMLLoader
+          register_loader :yaml, YAMLLoader
         end
       end
     end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module RegisterMap
+      class TOMLLoader < Loader
+        include HashLoader
+        include InputBase::TOMLLoader
+
+        support_types [:toml]
+
+        def read_file(file)
+          load_toml(file)
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/utility/attribute_setter.rb

@@ -26,6 +26,7 @@ module RgGen
           end
 
           def inherited(subclass)
+            super
             export_instance_variable(:@attributes, subclass, &:dup)
           end
         end

data/lib/rggen/core/version.rb

@@ -2,9 +2,7 @@
 
 module RgGen
   module Core
-    MAJOR = 0
-    MINOR = 23
-    PATCH = 1
-    VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    VERSION = '0.24.0'
+    MAJOR, MINOR, PATCH = VERSION.split('.').map(&:to_i)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-core
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.24.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-24 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.5
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.5
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tomlrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +119,7 @@ files:
 - lib/rggen/core/builder/loader_registry.rb
 - lib/rggen/core/builder/output_component_registry.rb
 - lib/rggen/core/builder/plugin_manager.rb
+- lib/rggen/core/builder/plugin_spec.rb
 - lib/rggen/core/builder/simple_feature_entry.rb
 - lib/rggen/core/cli.rb
 - lib/rggen/core/configuration.rb
@@ -112,6 +133,7 @@ files:
 - lib/rggen/core/configuration/json_loader.rb
 - lib/rggen/core/configuration/loader.rb
 - lib/rggen/core/configuration/ruby_loader.rb
+- lib/rggen/core/configuration/toml_loader.rb
 - lib/rggen/core/configuration/yaml_loader.rb
 - lib/rggen/core/core_extensions/object.rb
 - lib/rggen/core/dsl.rb
@@ -129,6 +151,7 @@ files:
 - lib/rggen/core/input_base/json_loader.rb
 - lib/rggen/core/input_base/loader.rb
 - lib/rggen/core/input_base/property.rb
+- lib/rggen/core/input_base/toml_loader.rb
 - lib/rggen/core/input_base/verifier.rb
 - lib/rggen/core/input_base/yaml_loader.rb
 - lib/rggen/core/options.rb
@@ -141,6 +164,7 @@ files:
 - lib/rggen/core/output_base/file_writer.rb
 - lib/rggen/core/output_base/raise_error.rb
 - lib/rggen/core/output_base/template_engine.rb
+- lib/rggen/core/plugin.rb
 - lib/rggen/core/printers.rb
 - lib/rggen/core/register_map.rb
 - lib/rggen/core/register_map/component.rb
@@ -153,6 +177,7 @@ files:
 - lib/rggen/core/register_map/json_loader.rb
 - lib/rggen/core/register_map/loader.rb
 - lib/rggen/core/register_map/ruby_loader.rb
+- lib/rggen/core/register_map/toml_loader.rb
 - lib/rggen/core/register_map/yaml_loader.rb
 - lib/rggen/core/utility/attribute_setter.rb
 - lib/rggen/core/utility/code_utility.rb
@@ -186,8 +211,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: rggen-core-0.23.1
+summary: rggen-core-0.24.0
 test_files: []