html-pipeline-ruby_markup 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67c4ec7e23acac58f3008b76c0b09953cacdd9b37d6817b0d4239ecab82dd02a
+  data.tar.gz: 0a4e5736b4a58898b63714f2e8eef0a4e5185a167c8effda2d9d99665b7db373
+SHA512:
+  metadata.gz: 8d8c1340bd142e7962978fd1438a96956a7698389e448aea60c8c89255a1b7ba0b8122b25fcc1fa7d5ae081cddc9193b6436bad003d1edc6a392f92e8ddf1f65
+  data.tar.gz: 329e07d8356e3fc55938ecb33e08502c60a6181961a4166067fe9096853741c938f436635a50137082664c1ebf9ea6d5f77b82032274e021fb2bade143d5e4aa

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## Unreleased
+
+## 0.9.0
+
+2020.03.25
+
+Extract from my blog application.

data/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+1. [Fork it](https://github.com/juanitofatas/html-pipeline-ruby_markup/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Running tests
+
+```shell
+$ rake
+```

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twemoji.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "bundler"
+  gem "pry"
+end
+
+group :test do
+  gem "rspec"
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Juanito Fatas
+
+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,55 @@
+# HTML::Pipeline::RubyMarkup
+
+`HTML::Pipeline::RubyMarkup` provides a [HTML::Pipeline](https://github.com/jch/html-pipeline)
+filter to easily write [ruby markups] in Markdown documents.
+
+## Installation
+
+Add this line to your application‘s `Gemfile`:
+
+```ruby
+gem "html-pipeline-ruby_markup"
+```
+
+Or install it yourself as:
+
+    $ gem install html-pipeline-ruby_markup
+
+## Usage
+
+`HTML::Pipeline::RubyMarkup` processes Text, so it **must** come before the
+markdown filter.
+
+```ruby
+require "html/pipeline"
+require "html/pipeline/ruby_markup"
+
+pipeline = HTML::Pipeline.new [
+  HTML::Pipeline::RubyMarkup::Filter,
+  HTML::Pipeline::MarkdownFilter,
+]
+
+result = pipeline.call <<-MARKDOWN.strip_heredoc
+  [漢字(かんじ)]
+MARKDOWN
+
+puts result[:output].to_html
+```
+
+prints:
+
+```html
+<ruby>
+漢字<rp>(</rp><rt>かんじ</rt><rp>)</rp>
+</ruby>
+```
+
+## Contributing
+
+Please see the [CONTRIBUTING.md](/CONTRIBUTING.md) file.
+
+## License
+
+Please see the [LICENSE.md](/LICENSE.md) file.
+
+[ruby markups]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ruby

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :spec
+
+task :spec do
+  Rake::Task["specs"].invoke
+end

data/html-pipeline-ruby_markup.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "html/pipeline/ruby_markup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "html-pipeline-ruby_markup"
+  spec.version       = HTML::Pipeline::RubyMarkup::VERSION
+  spec.authors       = ["Juanito Fatas"]
+  spec.email         = ["katehuang0320@gmail.com"]
+  spec.summary       = %q{A HTML::Pipeline filter to write ruby markup elements.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/juanitofatas/html-pipeline-ruby_markup"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f =~ %r{^(spec)/} }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "html-pipeline", ">= 1.11"
+end

data/lib/html/pipeline/ruby_markup.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "html/pipeline"
+require_relative "ruby_markup/transformer"
+
+module HTML
+  class Pipeline
+    module RubyMarkup
+      class Filter < HTML::Pipeline::TextFilter
+        def call
+          Transformer.run(text.dup)
+        end
+      end
+    end
+  end
+end

data/lib/html/pipeline/ruby_markup/element.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module HTML
+  class Pipeline
+    module RubyMarkup
+      class Element
+        def initialize(word, reading, uri)
+          @word = word
+          @reading = reading
+          @uri = uri
+        end
+
+        def original
+          if uri
+            %([#{word}(#{reading})](#{uri}))
+          else
+            %([#{word}(#{reading})])
+          end
+        end
+
+        def to_html
+          if uri
+            %(<ruby><a href="#{uri}" target="_blank" rel="noopener noreferrer" itemprop="url" aria-label="search #{word} on jisho.org">#{word}</a><rt>#{reading}</rt></ruby>)
+          else
+            "<ruby>#{word}<rp>(</rp><rt>#{reading}</rt><rp>)</rp></ruby>"
+          end
+        end
+
+        private
+        attr_reader :word, :reading, :uri
+      end
+    end
+  end
+end

data/lib/html/pipeline/ruby_markup/markdown_traverser.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module HTML
+  class Pipeline
+    module RubyMarkup
+      # To go through a markdown document. Mainly used to decide if we are in
+      # code blocks to decide if we should escape underscored usernames.
+      class MarkdownTraverser
+        def initialize(markdown)
+          @lines = markdown.dup.lines
+          init_position
+        end
+
+        def each
+          lines.each do |line|
+            update_position(line.include?(CODEBLOCK_MARKER))
+            yield(line)
+          end
+        end
+
+        def in_codeblock?
+          prev == true && current == false
+        end
+
+        private
+
+        CODEBLOCK_MARKER = "```".freeze
+        private_constant :CODEBLOCK_MARKER
+
+        attr_reader :lines
+        attr_accessor :prev, :current
+
+        def init_position
+          self.prev = false
+          self.current = lines.first.include?(CODEBLOCK_MARKER)
+        end
+
+        def update_position(current)
+          self.current = current
+          self.prev = current ? !prev : prev
+        end
+      end
+    end
+  end
+end

data/lib/html/pipeline/ruby_markup/transformer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "element"
+require_relative "markdown_traverser"
+
+module HTML
+  class Pipeline
+    module RubyMarkup
+      class Transformer
+        def self.run(content)
+          new(content).run
+        end
+
+        def initialize(content)
+          @content = content
+        end
+
+        def run
+          transform_ruby_markups!
+        end
+
+        private
+
+        # Matching [漢字(かんじ)] or [漢字(かんじ)](url)
+        RubyTagPattern = %r(
+          (?<!!)
+          \[
+            (?<word>[^\[\(\)]+(?=\())(?<!\s)
+            \((?<reading>[^\[\]]+(?=\)))\)
+          \]
+          (\((?<uri>[^\(\)]+(?=\)))\))*
+        )x
+        RubyMarkupInsideCodePattern = /`.*#{RubyTagPattern}.*`/
+
+        attr_reader :content
+
+        def traverser
+          @traverser ||= MarkdownTraverser.new(content)
+        end
+
+        def transform_ruby_markups!
+          traverser.each do |line|
+            next if traverser.in_codeblock?
+            next if line.match?(RubyMarkupInsideCodePattern)
+
+            matches = line.scan(RubyTagPattern)
+
+            if !matches.empty?
+              matches.each do |word, reading, uri|
+                ruby_element = Element.new(word, reading, uri)
+                line.sub!(ruby_element.original, ruby_element.to_html)
+              end
+            end
+          end.join
+        end
+      end
+    end
+  end
+end

data/lib/html/pipeline/ruby_markup/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module HTML
+  class Pipeline
+    module RubyMarkup
+      VERSION = "0.9.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-ruby_markup
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Juanito Fatas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: A HTML::Pipeline filter to write ruby markup elements.
+email:
+- katehuang0320@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- html-pipeline-ruby_markup.gemspec
+- lib/html/pipeline/ruby_markup.rb
+- lib/html/pipeline/ruby_markup/element.rb
+- lib/html/pipeline/ruby_markup/markdown_traverser.rb
+- lib/html/pipeline/ruby_markup/transformer.rb
+- lib/html/pipeline/ruby_markup/version.rb
+homepage: https://github.com/juanitofatas/html-pipeline-ruby_markup
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A HTML::Pipeline filter to write ruby markup elements.
+test_files: []