rggen-markdown 0.13.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 320d98bbec41bfc1c44c1864589a1a4b3ff7a6f30423bad15ad70ccb6462282d
-  data.tar.gz: eb9986b8b7629c32cccb095186dc5f4774cdfb38ae84c43c1c35e54904a96c14
+  metadata.gz: 399827f511dd221bd6e8b647aa33ae36c4d22022a7948fb99a8242e647ae0bb9
+  data.tar.gz: cd31131a1a3299717474f16983683a2f9854d136fc22ac104acff2a16c3a9460
 SHA512:
-  metadata.gz: 2e58b47a99a5b7cdc541c5ca34996369124d17fa8d8b0cb4360df68750d5a3f9cc3cd4498431f984d75bc6a65fc449ff632b5044f147490000a967555d88ed8e
-  data.tar.gz: 16badbc6f41c52379518fc3549e8126112193d2f99a551d61fe3fb0d593bd4835be28600737c8b401ee26d9773a24ca9e9244095eda4fb990bd8a26177ab241f
+  metadata.gz: 5afddc0aa9cadcd6e6672eb859a659239f9828577357caf063922dc29019f7cca018babf3a9d4c33f9fd1152390f09f79e3706e3c2a5e6013f64818850a7d868
+  data.tar.gz: 120a0d0084997adb97975a62bc99d8e27bdfa9a6da598b6971627e9b880e6191d5edd6d485f203d23dd3968de2a541f449eec27b45ac045eb6e001d73015f5db

data/LICENSE

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

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/rggen-markdown.svg)](https://badge.fury.io/rb/rggen-markdown)
-[![Build Status](https://travis-ci.com/rggen/rggen-markdown.svg?branch=master)](https://travis-ci.com/rggen/rggen-markdown)
+[![CI](https://github.com/rggen/rggen-markdown/workflows/CI/badge.svg)](https://github.com/rggen/rggen-markdown/actions?query=workflow%3ACI)
 [![Maintainability](https://api.codeclimate.com/v1/badges/5bbd7d84fefb30c5ee9a/maintainability)](https://codeclimate.com/github/rggen/rggen-markdown/maintainability)
 [![codecov](https://codecov.io/gh/rggen/rggen-markdown/branch/master/graph/badge.svg)](https://codecov.io/gh/rggen/rggen-markdown)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rggen_rggen-markdown&metric=alert_status)](https://sonarcloud.io/dashboard?id=rggen_rggen-markdown)
@@ -34,7 +34,7 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 
 ## Copyright & License
 
-Copyright © 2019 Taichi Ishitani. RgGen::Markdown is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+Copyright © 2019-2020 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

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require 'ruport'
-require 'ruport/wiki_table_formatter'
-
 require_relative 'markdown/version'
 require_relative 'markdown/utility/source_file'
+require_relative 'markdown/utility/table_formatter'
 require_relative 'markdown/utility'
 require_relative 'markdown/component'
 require_relative 'markdown/feature'
@@ -20,10 +18,10 @@ module RgGen
     def self.register_component(builder)
       builder.output_component_registry(:markdown) do
         register_component [
-          :register_map, :register_block, :register, :bit_field
+          :root, :register_block, :register_file, :register, :bit_field
         ] do |category|
           component Component, ComponentFactory
-          feature Feature, FeatureFactory if category != :register_map
+          feature Feature, FeatureFactory if category != :root
         end
       end
     end

data/lib/rggen/markdown/register/markdown.erb

@@ -1,11 +1,13 @@
 
-### <%= anchor(anchor_id) %><%= register.name %>
+### <%= anchor(anchor_id) %><%= title %>
 
-<% register.printables.each do |name, printable| %>
+<% register_printables.each do |name, value_or_values| %>
 * <%= name %>
-    * <%= printable || '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,24 @@
 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
+        .reject { |key, _| [:name, :layer_name].include?(key) }
+        .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,28 @@ RgGen.define_simple_feature(:register_block, :markdown) do
 
     private
 
+    def title
+      register_block.name
+    end
+
+    def register_block_printables
+      register_block.printables
+        .reject { |key, _| key == :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 :markdown, RgGen::Markdown do |builder|
+RgGen.setup :'rggen-markdown', RgGen::Markdown do |builder|
   builder.enable :register_block, [:markdown]
   builder.enable :register, [:markdown]
 end

data/lib/rggen/markdown/utility.rb

@@ -19,11 +19,12 @@ module RgGen
         "[#{text}](##{id})"
       end
 
-      def table(column_names, rows)
-        table = Ruport.Table(column_names) do |t|
-          rows.each { |row| t << row }
-        end
-        table.to_markdown(io: +'').chomp
+      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
     end
   end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Markdown
+    module Utility
+      class TableFormatter
+        include Core::Utility::CodeUtility
+
+        def format(labels, table)
+          code_block do |code|
+            build_md_lines(labels, table).each_with_index do |line, i|
+              code << nl if i.positive?
+              code << line
+            end
+          end
+        end
+
+        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
+        end
+
+        def build_md_line(lines, row)
+          lines <<
+            ['', *row]
+              .map(&method(:escape))
+              .zip(separators(row.size + 1))
+              .flatten
+        end
+
+        def escape(cell)
+          cell.to_s
+            .gsub('|', '&#124;')
+            .gsub("\n", '<br>')
+        end
+
+        def separators(size)
+          Array.new(size, '|')
+        end
+
+        def alignment_marks(size)
+          Array.new(size, ':--')
+        end
+      end
+    end
+  end
+end

data/lib/rggen/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module RgGen
   module Markdown
-    VERSION = '0.13.1'
+    VERSION = '0.18.0'
   end
 end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rggen-markdown
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ruport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: ruport-wiki-table-formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +26,7 @@ dependencies:
         version: '0'
 description: 'Markdown generator for RgGen.
 
-'
+  '
 email:
 - rggen@googlegroups.com
 executables: []
@@ -74,6 +46,7 @@ files:
 - lib/rggen/markdown/setup.rb
 - lib/rggen/markdown/utility.rb
 - lib/rggen/markdown/utility/source_file.rb
+- lib/rggen/markdown/utility/table_formatter.rb
 - lib/rggen/markdown/version.rb
 homepage: https://github.com/rggen/rggen-markdown
 licenses:
@@ -91,15 +64,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: rggen-markdown-0.13.1
+summary: rggen-markdown-0.18.0
 test_files: []