rggen-markdown 0.20.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0e5ece9dd3d244671164701253d739352b8a73a5d3536f4e2f96e9754cef2b1
-  data.tar.gz: 21527d0a2bcb0246ba75dbcc73e5011edbfd7db9918847252c30f36018cde9c9
+  metadata.gz: b80423dd457da00191f9c0623535ced32b9cfffc0a4e0234104a97bc34d30c5c
+  data.tar.gz: 54fafa2f584f8174d00ebdc7a82f5e6b56d81b55db1e592e094869ad76cecf87
 SHA512:
-  metadata.gz: 5873b9da35b8827ac46945bd7220fb9a5a8fcddc9d93347ef65a8436d078a69eec35ca3ea64eefc8907472fc7729c8e3b9c6abebec7253ee0bfd36f55e43c0e1
-  data.tar.gz: 77b2792a66ea7636ae2b02144dfd4d9e213565972d9e794bf9cbf0728cf6f6359af08acb1d1b1b332a0dff3c24696107399c7d19b6fdd52b95b6b32014e3666f
+  metadata.gz: 00d46912a2f44aef4edf37d4e8f4e6deba65f386a1a6b6e0f2985029e3bad879bcadfdc917423d67d1a1cd7905492e0991f21af2ecad2216679054416df7cae8
+  data.tar.gz: aafec148dc87ae5c66a463dfed54301258307604dcf9a507f98a7402cc37a5ee4fc8de4f1ef11cb5d51f8a8c93c173180f13011e630d5c8dfa960608dac956fc

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2021 Taichi Ishitani
+Copyright (c) 2019-2022 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

@@ -17,7 +17,7 @@ During RgGen installation, RgGen::Markdown will also be installed automatically.
 $ gem install rggen
 ```
 
-If you to install RgGen::Markdown only, use the command below:
+If you want to install RgGen::Markdown only, use the command below:
 
 ```
 $ gem install rggen-markdown
@@ -27,14 +27,15 @@ $ gem install rggen-markdown
 
 Feedbacks, bug reports, questions and etc. are wellcome! You can post them by using following ways:
 
-* [GitHub Issue Tracker](https://github.com/rggen/rggen-markdown/issues)
+* [GitHub Issue Tracker](https://github.com/rggen/rggen/issues)
+* [GitHub Discussions](https://github.com/rggen/rggen/discussions)
 * [Chat Room](https://gitter.im/rggen/rggen)
 * [Mailing List](https://groups.google.com/d/forum/rggen)
 * [Mail](mailto:rggen@googlegroups.com)
 
 ## Copyright & License
 
-Copyright © 2019-2021 Taichi Ishitani. RgGen::Markdown is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+Copyright © 2019-2022 Taichi Ishitani. RgGen::Markdown is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
 
 ## Code of Conduct
 

data/lib/rggen/markdown/factories.rb

@@ -2,7 +2,7 @@
 
 module RgGen
   module Markdown
-    class ComponentFactory < Core::OutputBase::ComponentFactory
+    class ComponentFactory < Core::OutputBase::DocumentComponentFactory
     end
 
     class FeatureFactory < Core::OutputBase::FeatureFactory

data/lib/rggen/markdown/register/markdown.rb

@@ -16,9 +16,7 @@ RgGen.define_simple_feature(:register, :markdown) do
     end
 
     def register_printables
-      register.printables
-        .reject { |key, _| [:name, :layer_name].include?(key) }
-        .compact
+      register.printables.except(:name, :layer_name).compact
     end
 
     def bit_field_table

data/lib/rggen/markdown/register_block/markdown.rb

@@ -21,13 +21,11 @@ RgGen.define_simple_feature(:register_block, :markdown) do
     end
 
     def register_block_printables
-      register_block.printables
-        .reject { |key, _| key == :name }
-        .compact
+      register_block.printables.except(:name).compact
     end
 
     def register_table
-      table([:name], table_rows)
+      table([:name, :offset_address], table_rows)
     end
 
     def table_rows
@@ -37,7 +35,8 @@ RgGen.define_simple_feature(:register_block, :markdown) do
     def table_row(register)
       name = register.printables[:layer_name]
       id = register.anchor_id
-      [anchor_link(name, id)]
+      offset_address = register.printables[:offset_address].join("\n")
+      [anchor_link(name, id), offset_address]
     end
   end
 end

data/lib/rggen/markdown/utility/table_formatter.rb

@@ -18,11 +18,9 @@ module RgGen
         private
 
         def build_md_lines(labels, table)
-          lines = []
-          build_md_line(lines, labels)
-          build_md_line(lines, alignment_marks(labels.size))
-          table.each { |row| build_md_line(lines, row) }
-          lines
+          [
+            labels, alignment_marks(labels.size), *table
+          ].each_with_object([]) { |row, lines| build_md_line(lines, row) }
         end
 
         def build_md_line(lines, row)

data/lib/rggen/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module RgGen
   module Markdown
-    VERSION = '0.20.0'
+    VERSION = '0.23.0'
   end
 end

data/lib/rggen/markdown.rb

@@ -8,20 +8,18 @@ require_relative 'markdown/component'
 require_relative 'markdown/feature'
 require_relative 'markdown/factories'
 
-module RgGen
-  module Markdown
-    extend Core::Plugin
+RgGen.setup_plugin :'rggen-markdown' do |plugin|
+  plugin.version RgGen::Markdown::VERSION
 
-    setup_plugin :'rggen-markdown' do |plugin|
-      plugin.register_component :markdown do
-        component Component, ComponentFactory
-        feature Feature, FeatureFactory
-      end
-
-      plugin.files [
-        'markdown/register/markdown',
-        'markdown/register_block/markdown'
-      ]
-    end
+  plugin.register_component :markdown do
+    component RgGen::Markdown::Component,
+              RgGen::Markdown::ComponentFactory
+    feature RgGen::Markdown::Feature,
+            RgGen::Markdown::FeatureFactory
   end
+
+  plugin.files [
+    'markdown/register_block/markdown',
+    'markdown/register/markdown'
+  ]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-markdown
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,7 +43,6 @@ files:
 - lib/rggen/markdown/register/markdown.rb
 - lib/rggen/markdown/register_block/markdown.erb
 - lib/rggen/markdown/register_block/markdown.rb
-- lib/rggen/markdown/setup.rb
 - lib/rggen/markdown/utility.rb
 - lib/rggen/markdown/utility/source_file.rb
 - lib/rggen/markdown/utility/table_formatter.rb
@@ -52,8 +51,9 @@ homepage: https://github.com/rggen/rggen-markdown
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/rggen/rggen-markdown/issues
+  bug_tracker_uri: https://github.com/rggen/rggen/issues
   mailing_list_uri: https://groups.google.com/d/forum/rggen
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/rggen/rggen-markdown
   wiki_uri: https://github.com/rggen/rggen/wiki
 post_install_message: 
@@ -64,15 +64,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
-summary: rggen-markdown-0.20.0
+summary: rggen-markdown-0.23.0
 test_files: []

data/lib/rggen/markdown/setup.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'rggen/markdown'
-
-RgGen.register_plugin RgGen::Markdown do |builder|
-  builder.enable :register_block, [:markdown]
-  builder.enable :register, [:markdown]
-end