rggen-core 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8dee87d7320d747018f9f7b739024fe776cb30ad25fd8d64c89c24d5e4bbaf2
-  data.tar.gz: 1c78c53f111dd3cf10dda3ad836933a9044730d0ae1cd6a2436dd0ea92733770
+  metadata.gz: 7b863029dea0e5088f792bad82e185bf15bd22de39578f7e1d368851ab9d7549
+  data.tar.gz: 5e8714a42f5b385f2373e01bcf7395b0139359c2a6dde6aa22889759edda12d0
 SHA512:
-  metadata.gz: 784f1269c603f6c1bed63aa25c1a2030414cf685fde796494cd4c6b00a976b6b46f90c118589644fe5eb1df6ecd21db6ceef81c63f6c35900b85543ca617c949
-  data.tar.gz: e74c890fea65661e48d640df7bc6f8827ca0668d5f0aafaf7a4e77615e8cf2a8bae9a742d9e25490f73513c1d2a6a21cb831d455fac58cad758bf7ddce1a6f92
+  metadata.gz: 953bf54d406360b11bf39a2d5be9be50dffbb139ec9a55b2d0cc8e5405f58e05e047e938bb92cbee866dada08e57000e2675aa3055dfde881d63fbe570e1d24f
+  data.tar.gz: 5ccbf66f592401e5fd3bd3bacf9dcdd883a5744eb7ba684eb6efb70332042efa8b692d2c2e7d07cc3dbbb4b7c95cadc2234d8a6125789ffbb42b8580fa0b4a2e

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/rggen-core.svg)](https://badge.fury.io/rb/rggen-core)
-[![Build Status](https://travis-ci.org/rggen/rggen-core.svg?branch=master)](https://travis-ci.org/rggen/rggen-core)
+[![Build Status](https://travis-ci.com/rggen/rggen-core.svg?branch=master)](https://travis-ci.com/rggen/rggen-core)
 [![Maintainability](https://api.codeclimate.com/v1/badges/53c8e6654c2b5ecb9142/maintainability)](https://codeclimate.com/github/rggen/rggen-core/maintainability)
 [![codecov](https://codecov.io/gh/rggen/rggen-core/branch/master/graph/badge.svg)](https://codecov.io/gh/rggen/rggen-core)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rggen_rggen-core&metric=alert_status)](https://sonarcloud.io/dashboard?id=rggen_rggen-core)

data/exe/rggen

@@ -3,11 +3,11 @@
 
 $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 require 'rggen/core'
-require 'facets/module/lastname'
 
 begin
   cli = RgGen::Core::CLI.new
   cli.run(ARGV)
-rescue OptionParser::ParseError, RgGen::Core::RuntimeError => e
-  abort "[#{e.class.lastname}] #{e.message}"
+rescue ScriptError, StandardError => e
+  abort RgGen::Core::Utility::ErrorUtility
+          .compose_error_message(e, cli.options[:print_backtrace])
 end

data/lib/rggen/core.rb

@@ -22,6 +22,7 @@ require_relative 'core/utility/code_utility/code_block'
 require_relative 'core/utility/code_utility/source_file'
 require_relative 'core/utility/code_utility/structure_definition'
 require_relative 'core/utility/code_utility'
+require_relative 'core/utility/error_utility'
 require_relative 'core/utility/regexp_patterns'
 
 require_relative 'core/exceptions'
@@ -78,6 +79,7 @@ require_relative 'core/output_base/template_engine'
 require_relative 'core/output_base/erb_engine'
 require_relative 'core/output_base/code_generator'
 require_relative 'core/output_base/file_writer'
+require_relative 'core/output_base/raise_error'
 require_relative 'core/output_base/component'
 require_relative 'core/output_base/component_factory'
 require_relative 'core/output_base/feature'
@@ -91,6 +93,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/category'
+require_relative 'core/builder/plugins'
 require_relative 'core/builder/builder'
 require_relative 'core/builder'
 

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

@@ -7,8 +7,11 @@ module RgGen
         def initialize
           initialize_component_registries
           initialize_categories
+          @plugins = Plugins.new
         end
 
+        attr_reader :plugins
+
         def input_component_registry(name, &body)
           component_registry(:input, name, body)
         end
@@ -87,29 +90,22 @@ module RgGen
           RegisterMap.setup(self)
         end
 
-        def setup(library_name, library_module)
-          library_versions[library_name] =
-            if library_module.const_defined?(:VERSION)
-              library_module.const_get(:VERSION)
-            elsif library_module.respond_to?(:version)
-              library_module.version
-            else
-              '0.0.0'
-            end
-          library_module.setup(self)
+        def setup(name, plugin_module, &block)
+          plugins.add(name, plugin_module, block)
         end
 
-        def library_versions
-          @library_versions ||= {}
+        def activate_plugins
+          plugins.activate(self)
         end
 
-        def load_setup_file(file)
+        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
 
         private
@@ -136,7 +132,7 @@ module RgGen
 
         COMPONENT_REGISTRIES = {
           input: InputComponentRegistry, output: OutputComponentRegistry
-        }
+        }.freeze
 
         def component_registry(type, name, body)
           registries = @component_registries[type]

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module Builder
+      class Plugin
+        def initialize(name, plugin_module, block)
+          @name = name
+          @version = extract_version(plugin_module)
+          @plugin_module = plugin_module
+          @block = block
+        end
+
+        attr_reader :name
+        attr_reader :version
+
+        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
+
+        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
+            '0.0.0'
+          end
+        end
+      end
+
+      class Plugins
+        def initialize
+          @plugins = []
+        end
+
+        def add(name, plugin_module, block)
+          @plugins << Plugin.new(name, plugin_module, block)
+        end
+
+        def activate(builder)
+          @plugins.each { |plugin| plugin.default_setup(builder) }
+          @plugins.each { |plugin| plugin.optional_setup(builder) }
+        end
+
+        def plugin_versions
+          @plugins.map { |plugin| [plugin.name, plugin.version] }.to_h
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/cli.rb

@@ -4,24 +4,21 @@ module RgGen
   module Core
     class CLI
       def initialize(builder = nil)
-        RgGen.builder(builder || Builder.create)
+        @builder = builder || Builder.create
+        @options = Options.new
       end
 
+      attr_reader :builder
+      attr_reader :options
+
       def run(args)
-        options = parse_options(args)
-        builder = RgGen.builder
-        runner(options).run(builder, options)
+        options.parse(args)
+        runner.run(builder, options)
       end
 
       private
 
-      def parse_options(args)
-        options = Options.new
-        options.parse(args)
-        options
-      end
-
-      def runner(options)
+      def runner
         options[:runner] || Generator.new
       end
     end

data/lib/rggen/core/exceptions.rb

@@ -25,5 +25,8 @@ module RgGen
 
     class LoadError < Core::RuntimeError
     end
+
+    class GeneratorError < Core::RuntimeError
+    end
   end
 end

data/lib/rggen/core/facets.rb

@@ -5,3 +5,4 @@ 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/property.rb

@@ -66,10 +66,21 @@ module RgGen
           varible_name = "@#{@name[-1] == '?' ? @name[0..-2] : @name}"
           if feature.instance_variable_defined?(varible_name)
             feature.instance_variable_get(varible_name)
+          elsif @options.key?(:initial)
+            set_initial_value(feature, varible_name)
           else
-            @options[:default]
+            evaluate_default_initial_value(feature, @options[:default])
           end
         end
+
+        def set_initial_value(feature, varible_name)
+          value = evaluate_default_initial_value(feature, @options[:initial])
+          feature.instance_variable_set(varible_name, value)
+        end
+
+        def evaluate_default_initial_value(feature, value)
+          value.is_a?(Proc) ? feature.instance_exec(&value) : value
+        end
       end
     end
   end

data/lib/rggen/core/options.rb

@@ -152,6 +152,12 @@ module RgGen
       end
     end
 
+    Options.add_option(:print_backtrace) do |option|
+      option.long_option '--print-backtrace'
+      option.default false
+      option.description 'Print backtrace when an error occurs'
+    end
+
     Options.add_option(:version) do |option|
       option.short_option '-v'
       option.long_option '--version'

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

@@ -5,6 +5,7 @@ module RgGen
     module OutputBase
       class Feature < Base::Feature
         include Base::HierarchicalFeatureAccessors
+        include RaiseError
 
         class << self
           attr_reader :pre_builders

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

@@ -4,6 +4,8 @@ module RgGen
   module Core
     module OutputBase
       class FeatureFactory < Base::FeatureFactory
+        include RaiseError
+
         def create(component, configuration, register_map)
           create_feature(component, configuration, register_map)
         end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module OutputBase
+      module RaiseError
+        def error(message)
+          raise GeneratorError.new(message)
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/printers.rb

@@ -29,7 +29,7 @@ module RgGen
       end
 
       def load_setup_file(builder, file)
-        file.nil? || file.empty? || builder.load_setup_file(file)
+        file.nil? || file.empty? || builder.load_setup_file(file, false)
       end
 
       def help_message(builder)
@@ -45,8 +45,8 @@ module RgGen
 
       def verbose_version(builder)
         { core: Core::VERSION }
-          .merge(builder.library_versions)
-          .map { |(lib, version)| "  - rggen-#{lib} #{version}" }
+          .merge(builder.plugins.plugin_versions)
+          .map { |(name, version)| "  - rggen-#{name} #{version}" }
       end
     end
   end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Core
+    module Utility
+      module ErrorUtility
+        module_function
+
+        def compose_error_message(error, verbose)
+          lines = []
+          lines << "[#{error.class.lastname}] #{error.message}"
+          verbose &&
+            error.backtrace.each { |trace| lines << "    #{trace}" }
+          lines.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core/version.rb

@@ -3,7 +3,7 @@
 module RgGen
   module Core
     MAJOR = 0
-    MINOR = 12
+    MINOR = 13
     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.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -97,6 +97,7 @@ files:
 - lib/rggen/core/builder/input_component_registry.rb
 - lib/rggen/core/builder/list_feature_entry.rb
 - lib/rggen/core/builder/output_component_registry.rb
+- lib/rggen/core/builder/plugins.rb
 - lib/rggen/core/builder/simple_feature_entry.rb
 - lib/rggen/core/cli.rb
 - lib/rggen/core/configuration.rb
@@ -136,6 +137,7 @@ files:
 - lib/rggen/core/output_base/feature.rb
 - lib/rggen/core/output_base/feature_factory.rb
 - 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/printers.rb
 - lib/rggen/core/register_map.rb
@@ -156,6 +158,7 @@ files:
 - lib/rggen/core/utility/code_utility/line.rb
 - lib/rggen/core/utility/code_utility/source_file.rb
 - lib/rggen/core/utility/code_utility/structure_definition.rb
+- lib/rggen/core/utility/error_utility.rb
 - lib/rggen/core/utility/regexp_patterns.rb
 - lib/rggen/core/version.rb
 homepage: https://github.com/rggen/rggen-core
@@ -184,5 +187,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: rggen-core-0.12.0
+summary: rggen-core-0.13.0
 test_files: []