rggen-markdown 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e37ce6b6ceb51b9f258addcb2b0e2da82fed605d7f9a6ee6eb10076d787e4a1c
-  data.tar.gz: a661202f51802d780d79b509e080000d0bbd54f4eacff83c4166c00143aa1674
+  metadata.gz: 68db11d5b3f3170e538d563033633f8fcb1a0ef8ee0aa77328fe582df583388a
+  data.tar.gz: d6efb2f95d8cfaf72b93a8c19c91e382e9b74b12ef8c63fc9efe78f7e7aace45
 SHA512:
-  metadata.gz: bf6363005392ef3383d5eb2f921770a0c496aa313a560c5984e3a0639bcf069522d60e54a9e22880243cf807d301bac2126f6f6c005c657501ab463d686abcbe
-  data.tar.gz: 3e07be2a53d52fda1d23fc4c7a3419d42666b7a67e0437de6e2144615d1f64295177e6f338c31cc6fac8fb887ef5d1a74ce0de238faa19eccc64704dfa7453ad
+  metadata.gz: a1b34df82c7438e6f2219696e4dfba96258afeda27365fa9414cadf0e6b59ffbef0473e4362a9ed8282f38df2956c6b29937be76e7c13de2b4313ade2b9d48e9
+  data.tar.gz: e0b3120bf1923ccd92112189a0f34ad36542e139ca8781920e3ea0b3c4400f2c90fb75ea4b9f0143d9da4771e79cca5578ce7b15ebe1587ba00fd72eb1e12f78

data/README.md

@@ -7,10 +7,7 @@
 
 # RgGen::Markdown
 
-RgGen::Markdown provides features listed below:
-
-* Structure of Markdown writer for RgGen
-* Convinience APIs for Markdown code
+RgGen::Markdown provides Markdown generator for RgGen.
 
 ## Installation
 

data/lib/rggen/markdown.rb

@@ -12,7 +12,12 @@ require_relative 'markdown/factories'
 
 module RgGen
   module Markdown
-    def self.setup(builder)
+    FEATURES = [
+      'markdown/register/markdown',
+      'markdown/register_block/markdown'
+    ].freeze
+
+    def self.register_component(builder)
       builder.output_component_registry(:markdown) do
         register_component [
           :register_map, :register_block, :register, :bit_field
@@ -22,7 +27,14 @@ module RgGen
         end
       end
     end
-  end
 
-  setup :markdown, Markdown
+    def self.load_features
+      FEATURES.each { |feature| require_relative feature }
+    end
+
+    def self.default_setup(builder)
+      register_component(builder)
+      load_features
+    end
+  end
 end

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

@@ -0,0 +1,11 @@
+
+### <%= anchor(anchor_id) %><%= register.name %>
+
+<% register.printables.each do |name, printable| %>
+* <%= name %>
+    * <%= printable || 'NA' %>
+<% end %>
+<% if register.bit_fields? %>
+
+<%= bit_field_table %>
+<% end%>

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:register, :markdown) do
+  markdown do
+    export def anchor_id
+      [register_block.anchor_id, register.name].join('-')
+    end
+
+    main_code :markdown, from_template: true
+
+    private
+
+    def bit_field_table
+      column_names = bit_field_printables.first.keys
+      rows =
+        bit_field_printables
+          .map(&:values)
+          .map { |row| row.map { |cell| Array(cell).join("\n") } }
+      table(column_names, rows)
+    end
+
+    def bit_field_printables
+      @bit_field_printables ||= register.bit_fields.map(&:printables)
+    end
+  end
+end

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

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

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:register_block, :markdown) do
+  markdown do
+    export def anchor_id
+      register_block.name
+    end
+
+    write_file '<%= register_block.name %>.md' do |file|
+      file.body do |code|
+        register_block.generate_code(:markdown, :top_down, code)
+      end
+    end
+
+    main_code :markdown, from_template: true
+
+    private
+
+    def register_table
+      table([:name, :offset_address], table_rows)
+    end
+
+    def table_rows
+      register_block.registers
+        .zip(register_block.registers.map(&:printables))
+        .map { |register, printables| table_row(register, printables) }
+    end
+
+    def table_row(register, printables)
+      [
+        anchor_link(printables[:name], register.anchor_id),
+        printables[:offset_address]
+      ]
+    end
+  end
+end

data/lib/rggen/markdown/setup.rb

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

data/lib/rggen/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module RgGen
   module Markdown
-    VERSION = '0.12.0'
+    VERSION = '0.13.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-markdown
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 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: ruport
@@ -67,6 +67,11 @@ files:
 - lib/rggen/markdown/component.rb
 - lib/rggen/markdown/factories.rb
 - lib/rggen/markdown/feature.rb
+- lib/rggen/markdown/register/markdown.erb
+- 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/version.rb
@@ -96,5 +101,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: rggen-markdown-0.12.0
+summary: rggen-markdown-0.13.0
 test_files: []