rggen-core 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 135125b25bc30e8eb74fa97644c356afd817cda2a84a810a401efbcde7d2a647
-  data.tar.gz: c4cb605aaa49801ff0f70458148f1349a220de2c41b6f7ed614e98466e425668
+  metadata.gz: d6fde36c04e21476aef2a09a20a3d22467bf6f4a28fa4f831c7aa7208bdb0a9a
+  data.tar.gz: 0735722aae6a60569505b06ec3c3c9465c47f201138056752a00cc29b780d5a0
 SHA512:
-  metadata.gz: 122340fafae09f08a604c54b3f21e8428a0d03af5ef81b37f4211f881a99186c2f0a45e50cad9367406a75f784041eabc0ef87ebf692946a2dfbec5221135e8f
-  data.tar.gz: fb87835adc54ec4416f5811126ff65355ada76e05cc46d89eedbe87e2899fd16665d26caf66e41a9919a074824f51ef97fd6dee9abc2aa959b42d83b9c4dd35c
+  metadata.gz: 4f1ae60ad3e557b0f18514cb803c635134f93f922deae475db97745571b0ff38a0ce7571c2cef324ed1ac4250fc2e3e5d78d9d48689cfafe827d4ed938425684
+  data.tar.gz: 589c74ee6817e7b5aa90595c7d358f2e2db730cf3b06af40ce737da62135680fd55df52259294501c2c43b063d67908b5cd0b1fe8d8fa06d9efdbe7ef05ff1cc

data/lib/rggen/core.rb

@@ -95,7 +95,7 @@ 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/plugins'
+require_relative 'core/builder/plugin_manager'
 require_relative 'core/builder/builder'
 require_relative 'core/builder'
 

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

@@ -4,13 +4,15 @@ module RgGen
   module Core
     module Builder
       class Builder
+        extend Forwardable
+
         def initialize
           initialize_component_registries
           initialize_layers
-          @plugins = Plugins.new
+          @plugin_manager = PluginManager.new(self)
         end
 
-        attr_reader :plugins
+        attr_reader :plugin_manager
 
         def input_component_registry(name, &body)
           component_registry(:input, name, body)
@@ -88,23 +90,9 @@ module RgGen
           RegisterMap.setup(self)
         end
 
-        def setup(name, module_or_version = nil, &block)
-          plugins.add(name, module_or_version, &block)
-        end
-
-        def activate_plugins(**options)
-          plugins.activate(self, **options)
-        end
-
-        def load_setup_file(file, activation = true)
-          (file.nil? || file.empty?) &&
-            (raise Core::LoadError.new('no setup file is given'))
-          File.readable?(file) ||
-            (raise Core::LoadError.new("cannot load such setup file: #{file}"))
-          RgGen.builder(self)
-          load(file)
-          activation && activate_plugins
-        end
+        def_delegator :plugin_manager, :load_plugin
+        def_delegator :plugin_manager, :load_plugins
+        def_delegator :plugin_manager, :setup
 
         private
 

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/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

@@ -20,6 +20,9 @@ module RgGen
     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/options.rb

@@ -101,21 +101,19 @@ module RgGen
       end
     end
 
-    Options.add_option(:setup) do |option|
-      option.long_option '--setup FILE'
-      option.default { default_steup_file }
-      option.description 'Specify a Ruby file to set up RgGen tool'
-
-      def option.default_steup_file
-        ENV['RGGEN_DEFAULT_SETUP_FILE'] || define_setup_file_from_const
-      end
+    Options.add_option(:no_default_plugins) do |option|
+      option.long_option '--no-default-plugins'
+      option.default false
+      option.action { |_, options| options[:no_default_plugins] = true }
+      option.description 'Do not load default plugins'
+    end
 
-      def option.define_setup_file_from_const
-        require 'rggen/default_setup_file'
-        RgGen::DEFAULT_SETUP_FILE
-      rescue ::LoadError
-        nil
-      end
+    Options.add_option(:plugins) do |option|
+      option.long_option '--plugin PLUGIN'
+      option.default { [] }
+      option.action { |value, options| options[:plugins] << value }
+      option.description 'Load a RgGen plugin ' \
+                         "(name of plugin/path to 'setup.rb' file)"
     end
 
     Options.add_option(:configuration) do |option|

data/lib/rggen/core/printers.rb

@@ -18,18 +18,20 @@ module RgGen
       end
 
       def run(builder, options)
-        verbose? && load_setup_file(builder, options[:setup])
+        verbose? && load_plugins(builder, options)
         puts version_message(builder)
       end
 
       private
 
-      def verbose?
-        @verbose
+      def load_plugins(builder, options)
+        plugins = options[:plugins]
+        no_default_plugins = options[:no_default_plugins]
+        builder.load_plugins(plugins, no_default_plugins, false)
       end
 
-      def load_setup_file(builder, file)
-        file.nil? || file.empty? || builder.load_setup_file(file, false)
+      def verbose?
+        @verbose
       end
 
       def version_message(builder)
@@ -44,8 +46,10 @@ module RgGen
       end
 
       def verbose_version(builder)
-        ["rggen-core #{Core::VERSION}", *builder.plugins.version_info]
-          .map { |version_info| "  - #{version_info}" }
+        [
+          "rggen-core #{Core::VERSION}",
+          *builder.plugin_manager.version_info
+        ].map { |version_info| "  - #{version_info}" }
       end
     end
   end

data/lib/rggen/core/version.rb

@@ -3,7 +3,7 @@
 module RgGen
   module Core
     MAJOR = 0
-    MINOR = 21
+    MINOR = 22
     PATCH = 0
     VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-core
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -98,7 +98,7 @@ files:
 - lib/rggen/core/builder/list_feature_entry.rb
 - lib/rggen/core/builder/loader_registry.rb
 - lib/rggen/core/builder/output_component_registry.rb
-- lib/rggen/core/builder/plugins.rb
+- lib/rggen/core/builder/plugin_manager.rb
 - lib/rggen/core/builder/simple_feature_entry.rb
 - lib/rggen/core/cli.rb
 - lib/rggen/core/configuration.rb
@@ -189,5 +189,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: rggen-core-0.21.0
+summary: rggen-core-0.22.0
 test_files: []

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

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-module RgGen
-  module Core
-    module Builder
-      class Plugin
-        DEFAULT_PLUGIN_VERSION = '0.0.0'
-
-        def initialize(name, module_or_version, &block)
-          @name = name
-          @block = block
-          @version, @plugin_module =
-            if module_or_version.is_a?(Module)
-              [extract_version(module_or_version), module_or_version]
-            else
-              [module_or_version || DEFAULT_PLUGIN_VERSION]
-            end
-        end
-
-        attr_reader :name
-        attr_reader :version
-
-        def default_setup(builder)
-          @plugin_module &&
-            begin
-              @plugin_module.respond_to?(:default_setup) &&
-                @plugin_module.default_setup(builder)
-            end
-        end
-
-        def optional_setup(builder)
-          @block &&
-            if @plugin_module
-              @plugin_module.instance_exec(builder, &@block)
-            else
-              @block.call(builder)
-            end
-        end
-
-        def version_info
-          "#{name} #{version}"
-        end
-
-        private
-
-        def extract_version(plugin_module)
-          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
-      end
-
-      class Plugins
-        def initialize
-          @plugins = []
-        end
-
-        def add(name, module_or_version, &block)
-          @plugins << Plugin.new(name, module_or_version, &block)
-        end
-
-        def activate(builder, **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
-      end
-    end
-  end
-end