rggen-markdown 0.12.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e37ce6b6ceb51b9f258addcb2b0e2da82fed605d7f9a6ee6eb10076d787e4a1c
+  data.tar.gz: a661202f51802d780d79b509e080000d0bbd54f4eacff83c4166c00143aa1674
+SHA512:
+  metadata.gz: bf6363005392ef3383d5eb2f921770a0c496aa313a560c5984e3a0639bcf069522d60e54a9e22880243cf807d301bac2126f6f6c005c657501ab463d686abcbe
+  data.tar.gz: 3e07be2a53d52fda1d23fc4c7a3419d42666b7a67e0437de6e2144615d1f64295177e6f338c31cc6fac8fb887ef5d1a74ce0de238faa19eccc64704dfa7453ad

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+[![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)
+[![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)
+[![Gitter](https://badges.gitter.im/rggen/rggen.svg)](https://gitter.im/rggen/rggen?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
+# RgGen::Markdown
+
+RgGen::Markdown provides features listed below:
+
+* Structure of Markdown writer for RgGen
+* Convinience APIs for Markdown code
+
+## Installation
+
+During RgGen installation, RgGen::Markdown will also be installed automatically.
+
+```
+$ gem install rggen
+```
+
+If you to install RgGen::Markdown only, use the command below:
+
+```
+$ gem install rggen-markdown
+```
+
+## Contact
+
+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)
+* [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 Taichi Ishitani. RgGen::Markdown is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+
+## Code of Conduct
+
+Everyone interacting in the RgGen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rggen/rggen-markdown/blob/master/CODE_OF_CONDUCT.md).

data/lib/rggen/markdown.rb

@@ -0,0 +1,28 @@
+# 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'
+require_relative 'markdown/component'
+require_relative 'markdown/feature'
+require_relative 'markdown/factories'
+
+module RgGen
+  module Markdown
+    def self.setup(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
+      end
+    end
+  end
+
+  setup :markdown, Markdown
+end

data/lib/rggen/markdown/component.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Markdown
+    class Component < Core::OutputBase::Component
+    end
+  end
+end

data/lib/rggen/markdown/factories.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Markdown
+    class ComponentFactory < Core::OutputBase::ComponentFactory
+    end
+
+    class FeatureFactory < Core::OutputBase::FeatureFactory
+    end
+  end
+end

data/lib/rggen/markdown/feature.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Markdown
+    class Feature < Core::OutputBase::Feature
+      include Utility
+      template_engine Core::OutputBase::ERBEngine
+    end
+  end
+end

data/lib/rggen/markdown/utility.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Markdown
+    module Utility
+      include Core::Utility::CodeUtility
+
+      def create_blank_file(path)
+        SourceFile.new(path)
+      end
+
+      private
+
+      def anchor(id)
+        "<div id=\"#{id}\"></div>"
+      end
+
+      def anchor_link(text, id)
+        "[#{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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Markdown
+    module Utility
+      class SourceFile < Core::Utility::CodeUtility::SourceFile
+        undef_method :include_guard
+        undef_method :include_files
+        undef_method :include_file
+      end
+    end
+  end
+end

data/lib/rggen/markdown/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RgGen
+  module Markdown
+    VERSION = '0.12.0'
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rggen-markdown
+version: !ruby/object:Gem::Version
+  version: 0.12.0
+platform: ruby
+authors:
+- Taichi Ishitani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-19 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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Structure of Markdown writer for RgGen
+
+'
+email:
+- rggen@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rggen/markdown.rb
+- lib/rggen/markdown/component.rb
+- lib/rggen/markdown/factories.rb
+- lib/rggen/markdown/feature.rb
+- lib/rggen/markdown/utility.rb
+- lib/rggen/markdown/utility/source_file.rb
+- lib/rggen/markdown/version.rb
+homepage: https://github.com/rggen/rggen-markdown
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/rggen/rggen-markdown/issues
+  mailing_list_uri: https://groups.google.com/d/forum/rggen
+  source_code_uri: https://github.com/rggen/rggen-markdown
+  wiki_uri: https://github.com/rggen/rggen/wiki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: rggen-markdown-0.12.0
+test_files: []