rggen-markdown 0.16.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e35fb93a0fc6227415ad2b8647cd127a579ab0fb98553a116e5b04a970744f4
-  data.tar.gz: 673b9127ce1f4e993a93e06c4cf4928f0976d68fdc3fd06f49e9f934559f4cf1
+  metadata.gz: 0e347a1415bad51303960a8097d5797a5e0f2ff5c05b88624d4dd633e16eeedf
+  data.tar.gz: fdb87961c636225cb342f2f5fbd1d7ca55e39d0ff3cff28e1aabf75dec4b05fc
 SHA512:
-  metadata.gz: cae81e6fe7ed9aeda80268bccffae0799e438744a857dbfcb82b29054abef4ab43674b884018c3aa65f841e4de1d468c074f1ad6a0dbd8693e94bcd876a336fa
-  data.tar.gz: 137a5c107c1ce1834a1edc333e9b33c8dfdb941b8125ef5229b2fbbf655b9ed501a9d64087d61a3a9cddd792ed8000564d53002beb5de037750f868f6f9733ec
+  metadata.gz: 5bc02eae4f5bfe7d6aec45a9329444ddf3c75e60c0ae993346186679e3a326a4c8d902373d8cc2368fbec8d0acaf80dbe6254ad49c0a11398dd5c90fe2e78be8
+  data.tar.gz: e42872b5e274015b2311ee35efa7cb73bfe1d26b4491b7dc81a9949310890be5666c7d1d3ac8cbe021bff0dad443f8d79a48901250549b01462e570c3f8a525a

data/LICENSE

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

@@ -34,7 +34,7 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 
 ## Copyright & License
 
-Copyright © 2019-2020 Taichi Ishitani. RgGen::Markdown is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+Copyright © 2019-2021 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.rb

@@ -10,29 +10,18 @@ require_relative 'markdown/factories'
 
 module RgGen
   module Markdown
-    FEATURES = [
-      'markdown/register/markdown',
-      'markdown/register_block/markdown'
-    ].freeze
+    extend Core::Plugin
 
-    def self.register_component(builder)
-      builder.output_component_registry(:markdown) do
-        register_component [
-          :register_map, :register_block, :register, :bit_field
-        ] do |category|
-          component Component, ComponentFactory
-          feature Feature, FeatureFactory if category != :register_map
-        end
+    setup_plugin :'rggen-markdown' do |plugin|
+      plugin.register_component :markdown do
+        component Component, ComponentFactory
+        feature Feature, FeatureFactory
       end
-    end
-
-    def self.load_features
-      FEATURES.each { |feature| require_relative feature }
-    end
 
-    def self.default_setup(builder)
-      register_component(builder)
-      load_features
+      plugin.files [
+        'markdown/register/markdown',
+        'markdown/register_block/markdown'
+      ]
     end
   end
 end

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.erb

@@ -1,13 +1,13 @@
 
-### <%= anchor(anchor_id) %><%= register.name %>
+### <%= anchor(anchor_id) %><%= title %>
 
-<% register.printables.each do |name, values| %>
+<% register_printables.each do |name, value_or_values| %>
 * <%= name %>
-    <% Array(values || [nil]).each do |value| %>
-    * <%= value || 'NA' %>
+    <% Array(value_or_values).each do |value| %>
+    * <%= trim_space(value) %>
     <% end %>
 <% end %>
-<% if register.bit_fields? %>
+<% unless register.bit_fields.empty? %>
 
 <%= bit_field_table %>
-<% end%>
+<% end %>

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

@@ -3,13 +3,22 @@
 RgGen.define_simple_feature(:register, :markdown) do
   markdown do
     export def anchor_id
-      [register_block.anchor_id, register.name].join('-')
+      [register_block, *register_files, register]
+        .map(&:name).join('-')
     end
 
     main_code :markdown, from_template: true
 
     private
 
+    def title
+      register.printables[:layer_name]
+    end
+
+    def register_printables
+      register.printables.except(:name, :layer_name).compact
+    end
+
     def bit_field_table
       column_names = bit_field_printables.first.keys
       rows =

data/lib/rggen/markdown/register_block/markdown.erb

@@ -1,8 +1,8 @@
-## <%= register_block.name %>
+## <%= title %>
 
-<% register_block.printables.each do |name, printable| %>
+<% register_block_printables.each do |name, printable| %>
 * <%= name %>
-    * <%= printable || 'NA' %>
+    * <%= trim_space(printable) %>
 <% end %>
 
 <%= register_table %>

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

@@ -8,7 +8,7 @@ RgGen.define_simple_feature(:register_block, :markdown) do
 
     write_file '<%= register_block.name %>.md' do |file|
       file.body do |code|
-        register_block.generate_code(:markdown, :top_down, code)
+        register_block.generate_code(code, :markdown, :top_down)
       end
     end
 
@@ -16,21 +16,26 @@ RgGen.define_simple_feature(:register_block, :markdown) do
 
     private
 
+    def title
+      register_block.name
+    end
+
+    def register_block_printables
+      register_block.printables.except(:name).compact
+    end
+
     def register_table
-      table([:name, :offset_address], table_rows)
+      table([:name], table_rows)
     end
 
     def table_rows
-      register_block.registers
-        .zip(register_block.registers.map(&:printables))
-        .map { |register, printables| table_row(register, printables) }
+      register_block.registers.map(&method(:table_row))
     end
 
-    def table_row(register, printables)
-      [
-        anchor_link(printables[:name], register.anchor_id),
-        printables[:offset_address]
-      ]
+    def table_row(register)
+      name = register.printables[:layer_name]
+      id = register.anchor_id
+      [anchor_link(name, id)]
     end
   end
 end

data/lib/rggen/markdown/setup.rb

@@ -2,7 +2,7 @@
 
 require 'rggen/markdown'
 
-RgGen.setup :'rggen-markdown', RgGen::Markdown do |builder|
+RgGen.register_plugin RgGen::Markdown do |builder|
   builder.enable :register_block, [:markdown]
   builder.enable :register, [:markdown]
 end

data/lib/rggen/markdown/utility.rb

@@ -19,6 +19,10 @@ module RgGen
         "[#{text}](##{id})"
       end
 
+      def trim_space(string)
+        string.to_s.split(newline).map(&:strip).reject(&:empty?).join('<br>')
+      end
+
       def table(labels, rows)
         TableFormatter.new.format(labels, rows)
       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.16.0'
+    VERSION = '0.21.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-markdown
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,15 +64,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: rggen-markdown-0.16.0
+summary: rggen-markdown-0.21.0
 test_files: []