fuji_markdown 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad62ed44244c8054d2755a8b51709a6955f9a3f8d4934a32aae561c7c1fa22c7
-  data.tar.gz: 67b6b4b9d760c29027c9c8f0410a94965586b9b1836a35450ccee4257506be62
+  metadata.gz: 0e641373ec793135f6072dc2525b081db86b590618260ced757ba79a9e92604c
+  data.tar.gz: 52ea47ffb8b02107bc7071c9895ec111d1763d38c46bbde0f1d37e99509f3aab
 SHA512:
-  metadata.gz: 134866d32bce81be64a6a43f5ba84488f5961c05c49fa46c6d3523987517ef8a2fdb51db932ec3b99243a60c057fde72caa5fb6b0d4c95c5a226aa7b247c6974
-  data.tar.gz: 2d5970164fd3d4bfcde695792faae8d359abc34888cb649bcdf90e2a029f81842827b8397b22c0f7260869aab379793efbfb99ef7a8d961a03b9b3666ebf8c4f
+  metadata.gz: 10eb84854b743bdf5d17af4b386a974b9523f106c2d8d905a14df9dbef7bc3571fcad4823f3fc473dd12529a9223deb3b8f461eb97f4c6e594bbb828ea42ec92
+  data.tar.gz: 9d6a3ddc3b9518b967f7ce4afa02a6de998d323c779dcdbba24d2ff41f43997b2dd5b492dcc01fe8adbe7450ab4ee78a40bf40b026dae7dd565c38cc399f05cb

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: fuji-nakahara

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+
+      - name: Publish to GPR
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push --key github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+          OWNER: ${{ github.repository_owner }}

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - 2.6
+          - 2.7
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake

data/.rubocop.yml

@@ -1,6 +1,20 @@
-inherit_gem:
-  meowcop:
-    - config/rubocop.yml
+require:
+  - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+# rubocop
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Style/Documentation:
+  Enabled: false
+
+# rubocop-rspec
+
+RSpec/ExampleLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.4.0] - 2020-10-12
+
+### Added
+
+- Add CHANGELOG.md.
+
+### Changed
+
+- Specify required_ruby_version to '>= 2.6'.
+- Make preprocessors not to change given text destructively.
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.1...v0.4.0

data/Gemfile

@@ -1,4 +1,11 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fuji_markdown.gemspec
 gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-rspec'

data/Rakefile

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

data/bin/console

@@ -1,7 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'fuji_markdown'
 
-require 'pry'
-Pry.start
+# 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/exe/fujimd

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'optparse'
 require 'fuji_markdown'
+require 'fuji_markdown/version'
 
 option = :HTML
 

data/fuji_markdown.gemspec

@@ -1,7 +1,6 @@
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fuji_markdown/version'
+require_relative 'lib/fuji_markdown/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'fuji_markdown'
@@ -13,19 +12,20 @@ Gem::Specification.new do |spec|
   spec.description   = 'FujiMarkdown is the dialect of Markdown supporting extensions for Japanese novels.'
   spec.homepage      = 'https://github.com/fuji-nakahara/fuji_markdown'
   spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fuji-nakahara/fuji_markdown'
+  spec.metadata['changelog_uri'] = 'https://github.com/fuji-nakahara/fuji_markdown/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
-  spec.executables   = ['fujimd']
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_dependency 'commonmarker', '~> 0.17'
-
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'meowcop'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.7'
 end

data/lib/fuji_markdown.rb

@@ -1,8 +1,7 @@
-require 'commonmarker'
+# frozen_string_literal: true
 
+require_relative 'fuji_markdown/error'
 require_relative 'fuji_markdown/processor'
-require_relative 'fuji_markdown/version'
-
 require_relative 'fuji_markdown/postprocessors/ruby'
 require_relative 'fuji_markdown/preprocessors/ruby'
 require_relative 'fuji_markdown/preprocessors/escape_narou'
@@ -11,44 +10,36 @@ require_relative 'fuji_markdown/renderers/kakuyomu_renderer'
 require_relative 'fuji_markdown/renderers/narou_renderer'
 
 module FujiMarkdown
-  class << self
-    def parse(text, option = :HTML)
-      processor(option).parse(text)
-    end
+  PRESETS = {
+    HTML: {
+      preprocessors: [Preprocessors::Ruby.new],
+      renderer: CommonMarker::HtmlRenderer.new(options: %i[HARDBREAKS UNSAFE])
+    },
+    KAKUYOMU: {
+      preprocessors: [Preprocessors::Ruby.new, proc { |text| text.gsub(/《/, '|《') }],
+      postprocessors: [Postprocessors::Ruby.new],
+      renderer: Renderers::KakuyomuRenderer.new
+    },
+    NAROU: {
+      preprocessors: [Preprocessors::Ruby.new, Preprocessors::EscapeNarou.new],
+      postprocessors: [Postprocessors::Ruby.new],
+      renderer: Renderers::NarouRenderer.new
+    }
+  }.freeze
 
-    def render(text, option = :HTML)
-      processor(option).render(text)
-    end
-
-    private
-
-    def processor(option)
-      args = processor_args(option)
-      Processor.new(args)
+  class << self
+    def parse(text, preset = :HTML)
+      options = PRESETS.fetch(preset)
+      Processor.new(**options).parse(text)
+    rescue KeyError => e
+      raise InvalidPresetError, "Invalid preset: #{e.key}"
     end
 
-    def processor_args(option)
-      case option
-      when :HTML
-        {
-          preprocessors: [Preprocessors::Ruby.new],
-          renderer:      CommonMarker::HtmlRenderer.new(options: [:HARDBREAKS, :UNSAFE]),
-        }
-      when :KAKUYOMU
-        {
-          preprocessors:  [Preprocessors::Ruby.new, Proc.new { |text| text.gsub!(/《/, '|《') }],
-          postprocessors: [Postprocessors::Ruby.new],
-          renderer:       Renderers::KakuyomuRenderer.new,
-        }
-      when :NAROU
-        {
-          preprocessors:  [Preprocessors::Ruby.new, Preprocessors::EscapeNarou.new],
-          postprocessors: [Postprocessors::Ruby.new],
-          renderer:       Renderers::NarouRenderer.new,
-        }
-      else
-        raise ArgumentError, "Invalid option #{option}"
-      end
+    def render(text, preset = :HTML)
+      options = PRESETS.fetch(preset)
+      Processor.new(**options).render(text)
+    rescue KeyError => e
+      raise InvalidPresetError, "Invalid preset: #{e.key}"
     end
   end
 end

data/lib/fuji_markdown/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module FujiMarkdown
+  Error = Class.new(StandardError)
+  InvalidPresetError = Class.new(StandardError)
+end

data/lib/fuji_markdown/postprocessors/ruby.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 module FujiMarkdown
   module Postprocessors
     class Ruby
       KANJI_REGEXP = /\A[一-龠々]+\z/.freeze
 
-      attr_reader :omit_start_symbol
-
       def initialize(omit_start_symbol: false)
         @ruby              = false
         @omit_start_symbol = omit_start_symbol
@@ -12,15 +12,13 @@ module FujiMarkdown
 
       def call(doc)
         doc.walk do |node|
-          if node.type == :inline_html
-            process_ruby_node!(node)
-          end
+          process_ruby_node!(node) if node.type == :inline_html
         end
       end
 
       private
 
-      def process_ruby_node!(node)
+      def process_ruby_node!(node) # rubocop:disable Metrics/MethodLength
         case node.string_content
         when '<ruby>'
           @ruby = true
@@ -31,24 +29,22 @@ module FujiMarkdown
         when '<rt>'
           kanji_node = node.previous
           kana_node  = node.next
-          if @ruby && kana_node.next.string_content == '</rt>'
-            convert_to_kakuyomu_ruby!(kanji_node, kana_node)
-          end
+          convert_to_kakuyomu_ruby!(kanji_node, kana_node) if @ruby && kana_node.next.string_content == '</rt>'
           node.delete
         when '</rt>'
           node.delete
-        else
-          # do nothing
         end
       end
 
       def convert_to_kakuyomu_ruby!(kanji_node, kana_node)
-        kanji_node.string_content = "|#{kanji_node.string_content}" if kanji_node.type == :text && !(omit_start_symbol && start_symbol_omittable?(kanji_node))
-        kana_node.string_content  = "《#{kana_node.string_content}》" if kana_node.type == :text
+        if kanji_node.type == :text && !(@omit_start_symbol && start_symbol_omittable?(kanji_node))
+          kanji_node.string_content = "|#{kanji_node.string_content}"
+        end
+        kana_node.string_content = "《#{kana_node.string_content}》" if kana_node.type == :text
       end
 
       def start_symbol_omittable?(kanji_node)
-        kanji_node.string_content.match(KANJI_REGEXP) && !kanji_node.previous.string_content[-1].match(KANJI_REGEXP)
+        kanji_node.string_content.match?(KANJI_REGEXP) && !kanji_node.previous.string_content[-1].match?(KANJI_REGEXP)
       end
     end
   end

data/lib/fuji_markdown/preprocessors/escape_narou.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module FujiMarkdown
   module Preprocessors
     class EscapeNarou
       def call(text)
-        text.gsub!(/([一-龠々])（([\p{Hiragana}\p{Katakana}]+)）/, '\1|（\2）')
-        text.gsub!(/([一-龠々])\(([\p{Hiragana}\p{Katakana}]+)\)/, '\1|(\2)')
-        text.gsub!(/《([\p{Hiragana}\p{Katakana}]+)》/, '|《\1》')
+        text.gsub(/([一-龠々])（([\p{Hiragana}\p{Katakana}]+)）/, '\1|（\2）')
+            .gsub(/([一-龠々])\(([\p{Hiragana}\p{Katakana}]+)\)/, '\1|(\2)')
+            .gsub(/《([\p{Hiragana}\p{Katakana}]+)》/, '|《\1》')
       end
     end
   end

data/lib/fuji_markdown/preprocessors/ruby.rb

@@ -1,24 +1,31 @@
+# frozen_string_literal: true
+
 module FujiMarkdown
   module Preprocessors
     class Ruby
-      RUBY_PATTERN = %r({(?<kanji>[^{}|]*)\|(?<kana>[^{}]*)})
+      RUBY_REGEXP = /(?<!\\){(?<kanji>.*?)\|(?<kana>.*?)}/.freeze
 
       def call(text)
-        text.gsub!(RUBY_PATTERN) do |match|
-          kanji, *kanas = match.slice(1...-1).split('|')
-          return "<ruby>#{kanji}<rt></rt></ruby>" if kanas.empty?
+        text.gsub(RUBY_REGEXP) do |ruby_pattern|
+          convert_to_html(ruby_pattern)
+        end
+      end
 
-          pairs = []
-          kanas.each_with_index do |kana, i|
-            if i == kanas.size - 1
-              pairs << [kanji.slice(i..-1), kana]
-            else
-              pairs << [kanji.slice(i), kana]
-            end
-          end
+      private
 
-          "<ruby>#{pairs.map { |k, kana| "#{k}<rt>#{kana}</rt>" }.join}</ruby>"
+      def convert_to_html(ruby_pattern)
+        kanji_chars, *kanas = ruby_pattern[/\A{(.*)}\z/, 1].split('|')
+        return "<ruby>#{kanji_chars}<rt></rt></ruby>" if kanas.empty?
+
+        pairs = kanas.each_with_object([]).with_index do |(kana, arr), i|
+          arr << if i == kanas.size - 1
+                   [kanji_chars[i..], kana]
+                 else
+                   [kanji_chars[i], kana]
+                 end
         end
+
+        "<ruby>#{pairs.map { |kanji, kana| "#{kanji}<rt>#{kana}</rt>" }.join}</ruby>"
       end
     end
   end

data/lib/fuji_markdown/processor.rb

@@ -1,32 +1,31 @@
+# frozen_string_literal: true
+
+require 'commonmarker'
+
 module FujiMarkdown
   class Processor
-    attr_reader :preprocessors, :parser, :postprocessors, :renderer
-
-    def initialize(preprocessors: [], parser: CommonMarker, postprocessors: [], renderer: CommonMarker::HtmlRenderer.new)
+    def initialize(preprocessors: [], postprocessors: [], renderer: CommonMarker::HtmlRenderer.new)
       @preprocessors  = preprocessors
-      @parser         = parser
       @postprocessors = postprocessors
       @renderer       = renderer
     end
 
     def parse(text)
-      processed_text = text.dup
-
-      preprocessors.each do |preprocessor|
-        preprocessor.call(processed_text)
+      processed_text = @preprocessors.inject(text) do |result, preprocessor|
+        preprocessor.call(result)
       end
 
-      parser.render_doc(processed_text)
+      CommonMarker.render_doc(processed_text)
     end
 
     def render(text)
       doc = parse(text)
 
-      postprocessors.each do |postprocessor|
+      @postprocessors.each do |postprocessor|
         postprocessor.call(doc)
       end
 
-      renderer.render(doc)
+      @renderer.render(doc)
     end
   end
 end

data/lib/fuji_markdown/renderers/kakuyomu_renderer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FujiMarkdown
   module Renderers
     class KakuyomuRenderer < TextRenderer
@@ -13,7 +15,7 @@ module FujiMarkdown
         out('《《', :children, '》》')
       end
 
-      def link(node)
+      def link(_node)
         out(:children)
       end
     end

data/lib/fuji_markdown/renderers/narou_renderer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FujiMarkdown
   module Renderers
     class NarouRenderer < TextRenderer
@@ -11,14 +13,12 @@ module FujiMarkdown
 
       def emph(node)
         node.walk do |n|
-          if n.type == :text
-            n.string_content = n.string_content.chars.map { |char| "|#{char}《・》"}.join
-          end
+          n.string_content = n.string_content.chars.map { |char| "|#{char}《・》" }.join if n.type == :text
         end
         out(:children)
       end
 
-      def link(node)
+      def link(_node)
         out(:children)
       end
     end

data/lib/fuji_markdown/renderers/text_renderer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FujiMarkdown
   module Renderers
     class TextRenderer < CommonMarker::HtmlRenderer

data/lib/fuji_markdown/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FujiMarkdown
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fuji_markdown
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Fuji Nakahara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-12 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -24,76 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
-- !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'
-- !ruby/object:Gem::Dependency
-  name: meowcop
-  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'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
 description: FujiMarkdown is the dialect of Markdown supporting extensions for Japanese
   novels.
 email:
@@ -103,10 +33,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -117,6 +50,7 @@ files:
 - exe/fujimd
 - fuji_markdown.gemspec
 - lib/fuji_markdown.rb
+- lib/fuji_markdown/error.rb
 - lib/fuji_markdown/postprocessors/ruby.rb
 - lib/fuji_markdown/preprocessors/escape_narou.rb
 - lib/fuji_markdown/preprocessors/ruby.rb
@@ -128,7 +62,10 @@ files:
 homepage: https://github.com/fuji-nakahara/fuji_markdown
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/fuji-nakahara/fuji_markdown
+  source_code_uri: https://github.com/fuji-nakahara/fuji_markdown
+  changelog_uri: https://github.com/fuji-nakahara/fuji_markdown/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -137,14 +74,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Markdown processor for Japanese novels

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.6
-  - 2.5
-  - 2.4
-before_install:
-  - gem update --system
-  - gem install bundler