markdown_formatter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdd3b74679d7aa16c5765abe754fb06c4bbee2fd
+  data.tar.gz: 3703602b1af4af696464005232c8161c71e11371
+SHA512:
+  metadata.gz: 1e45c53ebb1e521c5420d5f602d44ebdbdb3f3eed33a1b5fc5d78d603cecd35c14b41970f721fed9da194c23bab69ea6bd9487f42b06b0a08bbc6544ade47337
+  data.tar.gz: f272dd9370d2914ba7a89890610daeb5b0b3ae816c624cdcc7de0041abc3d41491530fe2e0eecbe3feb76438a2df8c642c93189cc55f38d22821c523eb27abb2

data.tar.gz.sig

@@ -0,0 +1 @@
+�X�j�D#"����F�I�o�r.�C���+��&y�e0��VI�-���3���(��q�#ʖ�����<H	f^����Ƭ��q'�u���}����"~�h�����Aɷ����g�غ�U¼�;��(�#��

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in markdown_formatter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 YassLab
+
+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,46 @@
+# MarkdownFormatter
+
+Markdown formatter that removes unnecessary newlines, written in Ruby.
+This polishes segments for making [Translation Memory](https://en.wikipedia.org/wiki/Translation_memory) more maintainable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'markdown_formatter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install markdown_formatter
+
+## Usage
+
+```
+Usage: mdfmt [options] filepath
+    -w, --overwrite                  overwrite file instead of stdout
+    -v, --version                    display the version.
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yasslab/markdown_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.
+
+## License
+
+Copyright © 2017 [YassLab](https://yasslab.jp)
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[![YassLab Logo](https://yasslab.jp/img/logo_800x200.png)](https://yasslab.jp/)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "markdown_formatter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/mdfmt

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require "markdown_formatter"
+require "optparse"
+
+options = {}
+
+opt_parse = OptionParser.new do |opt|
+  opt.banner = 'Usage: mdfmt [options] markdownfile'
+  opt.on('-w', '--overwrite', 'overwrite file instead of stdout') { options[:overwrite] = true }
+  opt.on('-v', '--version', 'display the version.') { options[:version] = true }
+  opt.parse!(ARGV)
+end
+
+filepath = ARGV.first
+
+MarkdownFormatter::OPTIONS.merge!(options)
+
+case
+  when options[:version]
+    puts "MarkdownFormatter version: #{MarkdownFormatter::VERSION}"
+  when filepath.nil?
+    puts opt_parse
+  else
+    MarkdownFormatter::CLI.run(filepath.chomp)
+end
+

data/lib/markdown_formatter.rb

@@ -0,0 +1,57 @@
+require "kramdown"
+require "active_support"
+require "active_support/core_ext"
+require "pp"
+
+require "markdown_formatter/version"
+require "markdown_formatter/ast"
+require "markdown_formatter/cli"
+
+require "markdown_formatter/nodes/base"
+require "markdown_formatter/nodes/link"
+require "markdown_formatter/nodes/leaf_block"
+require "markdown_formatter/nodes/blank"
+require "markdown_formatter/nodes/leaf_block"
+require "markdown_formatter/nodes/container_block"
+require "markdown_formatter/nodes/inline"
+require "markdown_formatter/nodes/code_span"
+require "markdown_formatter/nodes/emphasis"
+require "markdown_formatter/nodes/entity"
+require "markdown_formatter/nodes/image"
+require "markdown_formatter/nodes/header"
+require "markdown_formatter/nodes/thematic_break"
+require "markdown_formatter/nodes/paragraph"
+require "markdown_formatter/nodes/smart_quote"
+require "markdown_formatter/nodes/strong"
+require "markdown_formatter/nodes/html_element"
+require "markdown_formatter/nodes/code_block"
+require "markdown_formatter/nodes/footnote"
+require "markdown_formatter/nodes/typographic_sym"
+require "markdown_formatter/nodes/list_item"
+require "markdown_formatter/nodes/list"
+require "markdown_formatter/nodes/block_quote"
+
+# Monkey Patch
+require "monkey_patches/kramdown/parser/kramdown/autolink"
+require "monkey_patches/kramdown/parser/kramdown/blockquote"
+require "monkey_patches/kramdown/parser/kramdown/code_span"
+require "monkey_patches/kramdown/parser/kramdown/emphasis"
+require "monkey_patches/kramdown/parser/kramdown/escaped_chars"
+require "monkey_patches/kramdown/parser/kramdown/footnote"
+require "monkey_patches/kramdown/parser/kramdown/link"
+require "monkey_patches/kramdown/parser/kramdown/html"
+require "monkey_patches/kramdown/parser/kramdown/typographic_symbol"
+require "monkey_patches/kramdown/parser/kramdown/list"
+require "monkey_patches/kramdown/parser/kramdown/header"
+require "monkey_patches/kramdown/parser/kramdown/paragraph"
+require "monkey_patches/kramdown/parser/kramdown/code_block"
+require "monkey_patches/kramdown/utils/entities"
+require "monkey_patches/kramdown/parser/gfm"
+
+module MarkdownFormatter
+  OPTIONS = {}
+
+  def self.format(source)
+    AST.new(source).to_s
+  end
+end

data/lib/markdown_formatter/ast.rb

@@ -0,0 +1,47 @@
+module MarkdownFormatter
+  class AST
+    def initialize(source)
+      @source = source.dup
+      doc = Kramdown::Document.new(source.dup, input: "GFM")
+      @ast, @warnings = doc.to_hash_ast
+    end
+
+    def traverse(parent = [@ast])
+      parent.each do |node|
+        case node[:type]
+          when :root
+            traverse(node[:children])
+          when :blank
+            # skip event
+          when :p
+            str = ASTNode::Paragraph.new(node).to_s
+
+            unless @source.sub!(node.dig(:options, :raw_text).chomp) { |m| str.gsub(/\R(?!\z)/, " ").chomp }
+              raise "Parse Failed!!"
+            end
+          when :ul, :ol, :blockquote
+            str = ASTNode::ContainerBlock.new(node).to_s
+            unless @source.sub!(node.dig(:options, :raw_text), str)
+              raise "Parse Failed!!"
+            end
+          when :header
+            # skip event
+          when :hr
+            # skip event
+          when :codeblock
+            # skip event
+          when :table
+            # TODO: implements Table node.
+          else
+            pp node
+            raise "Unexpected type #{node[:type]}"
+        end
+      end
+    end
+
+    def to_s
+      traverse
+      @source
+    end
+  end
+end

data/lib/markdown_formatter/cli.rb

@@ -0,0 +1,13 @@
+module MarkdownFormatter
+  class CLI
+    def self.run(filepath)
+      result = MarkdownFormatter.format(File.read(filepath))
+
+      if MarkdownFormatter::OPTIONS[:overwrite]
+        File.write(filepath, result)
+      else
+        puts result
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/base.rb

@@ -0,0 +1,11 @@
+module MarkdownFormatter
+  module ASTNode
+    class Base
+      attr_reader :node
+
+      def initialize(node)
+        @node = node
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/blank.rb

@@ -0,0 +1,9 @@
+module MarkdownFormatter
+  module ASTNode
+    class Blank < Base
+      def to_s
+        node[:value]
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/block_quote.rb

@@ -0,0 +1,22 @@
+module MarkdownFormatter
+  module ASTNode
+    class BlockQuote < Base
+      def to_s
+        node[:children].map do |c|
+          case c[:type]
+            when :blank
+              ">"
+            when :header
+              "> " + Header.new(c).to_s.gsub(/\R/, "\n> ")
+            when :ol, :ul
+              "> " + List.new(c).to_s.gsub(/\R(?!\z)/, "\n> ")
+            when :blockquote
+              "> " + BlockQuote.new(c).to_s
+            else
+              "> " + Paragraph.new(c).to_s.gsub(/\R/, " ")
+          end
+        end.join("\n").chomp + "\n"
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/code_block.rb

@@ -0,0 +1,9 @@
+module MarkdownFormatter
+  module ASTNode
+    class CodeBlock < Base
+      def to_s
+        node.dig(:options, :raw_text).chomp.strip_heredoc
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/code_span.rb

@@ -0,0 +1,9 @@
+module MarkdownFormatter
+  module ASTNode
+    class CodeSpan < Base
+      def to_s
+        node.dig(:options, :raw_text).gsub(/\R/, " ")
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/container_block.rb

@@ -0,0 +1,23 @@
+module MarkdownFormatter
+  module ASTNode
+    class ContainerBlock < Base
+      def to_s
+        str = ""
+
+        case node[:type]
+          when :blockquote
+            str += ASTNode::BlockQuote.new(node).to_s
+          when :ul, :ol
+            str += ASTNode::List.new(node).to_s
+          when :table
+            # TODO: implements Table node.
+          else
+            pp node
+            raise "Unexpected type #{node[:type]}"
+        end
+
+        str
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/emphasis.rb

@@ -0,0 +1,10 @@
+module MarkdownFormatter
+  module ASTNode
+    class Emphasis < Base
+      def to_s
+        delim = node.dig(:options, :delim)
+        "%s%s%s" % [delim, Paragraph.new(node).to_s, delim]
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/entity.rb

@@ -0,0 +1,9 @@
+module MarkdownFormatter
+  module ASTNode
+    class Entity < Base
+      def to_s
+        node.dig(:options, :original)
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/footnote.rb

@@ -0,0 +1,9 @@
+module MarkdownFormatter
+  module ASTNode
+    class Footnote < Base
+      def to_s
+        node.dig(:options, :raw_text)
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/header.rb

@@ -0,0 +1,9 @@
+module MarkdownFormatter
+  module ASTNode
+    class Header < Base
+      def to_s
+        node.dig(:options, :original_text)
+      end
+    end
+  end
+end

data/lib/markdown_formatter/nodes/html_element.rb

@@ -0,0 +1,9 @@
+module MarkdownFormatter
+  module ASTNode
+    class HTMLElement < Base
+      def to_s
+        "%s%s</%s>" % [node.dig(:options, :opening_tag), Paragraph.new(node).to_s, node[:value]]
+      end
+    end
+  end
+end