ruport-wiki-table-formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbb609c0de7f3ecc62cbfcccc448a63ca295f0913aee64f45860fbfee72e4dc9
+  data.tar.gz: f913326247bff8d30c6d0aadd125a9b371b738290d2a4afbcf0d29cf6da2a172
+SHA512:
+  metadata.gz: bcea9f3935328cf7f6ca79b682d0e0098a634b3442339de1bbee60f70aef5219e29b67f7eda40422add6d8204f043195b5b62d32254177571b29c006ecfcb643
+  data.tar.gz: e14c4c149c2e9b1bb00f6749a8aa57973a9994e1a7e90014b56a7d61c9ce17c52b820131c45db75536bb3a754f2671efc009516ed282440177da3ea3d54af446

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at taichi730@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -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,66 @@
+[![Build Status](https://travis-ci.org/taichi-ishitani/ruport-wiki-table-formatter.svg?branch=master)](https://travis-ci.org/taichi-ishitani/ruport-wiki-table-formatter)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f3b59dc0ae2f3d912ffc/maintainability)](https://codeclimate.com/github/taichi-ishitani/ruport-wiki-table-formatter/maintainability)
+[![codecov](https://codecov.io/gh/taichi-ishitani/ruport-wiki-table-formatter/branch/master/graph/badge.svg)](https://codecov.io/gh/taichi-ishitani/ruport-wiki-table-formatter)
+
+# Ruport::WikiTableFormatter
+
+Ruport::WikiTableFormatter is an extention for [Ruport](https://github.com/ruport/ruport) to format `Ruport::Table` data into wiki table format.
+
+Currently, Ruport::WikiTableFormatter supports following wiki formats:
+
+* Markdown
+
+## Installation
+
+To install Ruport::WikiTableFormatter, hit command below:
+
+```
+$ gem install ruport-wiki-table-formatter
+```
+
+Or add this line to your Gemfile:
+
+```ruby
+gem 'ruport-wiki-table-formatter'
+```
+
+## Usage
+
+To format `Ruport::Table` data into wiki table format, you only have to call following methods:
+
+* Markdown: #to_markdown
+
+Here is an sample code:
+
+```ruby
+require 'ruport'
+require 'ruport/wiki_table_formatter'
+
+table = Ruport.Table('Airport', 'IATA code', 'Opend')
+table << ['Kansai'     , 'KIX', 1994]
+table << ['Haneda'     , 'HND', 1931]
+table << ['Narita'     , 'NRT', 1978]
+table << ['New Chitose', 'CTS', 1988]
+
+md = table.to_markdown
+File.binwrite('sample.md', md)
+```
+
+Execute above sample code, Markdown table format below will be output:
+
+|Airport|IATA code|Opend|
+|:--|:--|:--|
+|Kansai|KIX|1994|
+|Haneda|HND|1931|
+|Narita|NRT|1978|
+|New Chitose|CTS|1988|
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/taichi-ishitani/ruport-wiki-table-formatter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Copyright & License
+
+Copyrigh (c) 2019 Taichi Ishitani.
+
+Licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE.txt](LICENSE.txt) for further details.

data/lib/ruport/wiki_table_formatter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'ruport'
+require_relative 'wiki_table_formatter/version'
+require_relative 'wiki_table_formatter/markdown'
+
+module Ruport
+  # Ruport::WikiTableFormatter is an extention for {Ruport}[https://github.com/ruport/ruport]
+  # to format Ruport::Table data into wiki table format.
+  #
+  # Currently, following formats are supported:
+  #
+  # * Markdown: Ruport::WikiTableFormatter::Markdown
+  #
+  # To get wiki table format from Ruport::Table data,
+  # you only have to call following methods:
+  #
+  # * Markdown: #to_markdown
+  #
+  # Example:
+  #
+  #   table = Ruport.Table('Airport', 'IATA code', 'Opend')
+  #   table << ['Kansai'     , 'KIX', 1994]
+  #   table << ['Haneda'     , 'HND', 1931]
+  #   table << ['Narita'     , 'NRT', 1978]
+  #   table << ['New Chitose', 'CTS', 1988]
+  #   md = table.to_markdown
+  #
+  # Output
+  #
+  #   |Airport|IATA code|Opend|
+  #   |:--|:--|:--|
+  #   |Kansai|KIX|1994|
+  #   |Haneda|HND|1931|
+  #   |Narita|NRT|1978|
+  #   |New Chitose|CTS|1988|
+  module WikiTableFormatter
+  end
+end

data/lib/ruport/wiki_table_formatter/markdown.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Ruport
+  module WikiTableFormatter
+    # This class produces Markdown table output from Ruport::Table data.
+    #
+    # === Rendering Options
+    # <tt>:alignment:</tt> Default alignment for all columns.
+    # Allowed values are :left, :center and :right. Default is :left.
+    #
+    # <tt>:column_alignments:</tt> Alignments for specific columns.
+    # You can configure alignments by using Hash (key: column name, value: alignment)
+    class Markdown < Ruport::Formatter
+      renders :markdown, for: [Controller::Table]
+
+      # Hook for setting available options using a template.
+      def apply_template
+        apply_table_format_template(template.table)
+      end
+
+      # Checks to ensure the table has non empty column_names.
+      def prepare_table
+        if data.column_names.empty?
+          message = 'Can\'t output table without column names.'
+          raise Ruport::FormatterError.new(message)
+        end
+      end
+
+      # Uses the column names from the given Data::Table to generate a table header.
+      def build_table_header
+        build_md_row(output, data.column_names)
+        build_md_row(output, alignment_strings(data.column_names))
+      end
+
+      # Generates body of Markdown table data.
+      # Following characters will be replaced as escape.
+      # | -> &#124;
+      # newline code(\n) -> <br>
+      def build_table_body
+        data.each { |row| build_md_row(output, row) }
+      end
+
+      private
+
+      def build_md_row(output, row)
+        output << '|'
+        output << row.to_a.map { |cell| escape(+cell.to_s) }.join('|')
+        output << "|\n"
+      end
+
+      def escape(cell)
+        cell.gsub!('|', '&#124;')
+        cell.gsub!("\n", '<br>')
+        cell
+      end
+
+      def alignment_strings(column_names)
+        column_names.map(&method(:alignment_string))
+      end
+
+      def alignment_string(column_name)
+        case column_alignment(column_name)
+        when :right
+          '--:'
+        when :center
+          ':-:'
+        else
+          ':--'
+        end
+      end
+
+      def column_alignment(column_name)
+        if options.column_alignments&.key?(column_name)
+          options.column_alignments[column_name]
+        elsif options.alignment
+          options.alignment
+        else
+          :left
+        end
+      end
+
+      def apply_table_format_template(template)
+        template = (template || {}).merge(options.table_format || {})
+        options.alignment ||= template[:alignment]
+        options.column_alignments =
+          merget_column_alignments(options, template)
+      end
+
+      def merget_column_alignments(options, template)
+        (template[:column_alignments] || {})
+          .merge(options.column_alignments || {})
+      end
+    end
+  end
+end

data/lib/ruport/wiki_table_formatter/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Ruport
+  module WikiTableFormatter
+    # Version of Ruport::WikiTableFormatter
+    VERSION = '0.1.0'
+  end
+end

data/sample/sample.md

@@ -0,0 +1,6 @@
+|Airport|IATA code|Opend|
+|:--|:--|:--|
+|Kansai|KIX|1994|
+|Haneda|HND|1931|
+|Narita|NRT|1978|
+|New Chitose|CTS|1988|

data/sample/sample.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'ruport'
+require 'ruport/wiki_table_formatter'
+
+table = Ruport.Table('Airport', 'IATA code', 'Opend')
+table << ['Kansai'     , 'KIX', 1994]
+table << ['Haneda'     , 'HND', 1931]
+table << ['Narita'     , 'NRT', 1978]
+table << ['New Chitose', 'CTS', 1988]
+
+md = table.to_markdown
+File.binwrite('sample.md', md)

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ruport-wiki-table-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taichi Ishitani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  Ruport::WikiTableFormatter is an extension for Ruport to format Ruport::Table data
+  into wiki table format.
+email:
+- taichi730@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/ruport/wiki_table_formatter.rb
+- lib/ruport/wiki_table_formatter/markdown.rb
+- lib/ruport/wiki_table_formatter/version.rb
+- sample/sample.md
+- sample/sample.rb
+homepage: https://github.com/taichi-ishitani/ruport-wiki-table-formatter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--tile"
+- Ruport::WikiTableFormatter
+- "--main"
+- README.md
+- "--q"
+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: Wiki table formatter for Ruport
+test_files: []