textlint-ruby 0.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34fcdaa79b17b3ea92addafa5125e0d28f4cd114fb338d0f6ec97d243070bdd1
-  data.tar.gz: 28cd88e7d364424b8c75889f6c57fa92e03d02c2756f70974ac2d395a59e301b
+  metadata.gz: 5bcefd07ee04b3840f45267770a1faa99fe9ed9f7f5161b11df94fa0839bcb62
+  data.tar.gz: d2dd891a4a2ce1866d13dd6963b3944494f2ca19ad15aec67859743edb6c41b7
 SHA512:
-  metadata.gz: e4b43a0e423cef7b375202b4b20f144563bd16434dd279bd991b1d29ab696f1852bb71f13dad18adb78fe407537fe9c620482ebcec692cd2c67f4224704203e6
-  data.tar.gz: b2bc9ca563fe12d94d161508c24fdd261585db92e35088fad0ceeb83a5ae54c614454bb314a2db2b5facc62e28498508e22a10ecb4dcff4e44a78cbdb3abc2f3
+  metadata.gz: 9658421db72d38e73718eae4325d64b15d9b871976e8db31dda7ae2e3630348f66fbf30c30cdd18744f980e3cbdc5c34e89f02d15f455ed687a1176a377756fc
+  data.tar.gz: 979b738b6230d5d717a0d6e534128867274d641a003603f6ea8050b6e9462c5cd18dc2294e348d25f31078f3ea7dd42f4d3187ca8bef2ec6bcf78db0509e86ea

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+- Add stdio server mode. textlint-plugin-ruby(>= v2.0.0) can connect with textlint-ruby via stdio.
+- Remove textlint-ruby-optimized command
+
 ## [0.1.1]
 
 - Support ruby 2.5

data/README.md

@@ -4,8 +4,6 @@ Ruby AST parser for [textlint-ruby-plugin](https://github.com/alpaca-tc/textlint
 
 ## Installation
 
-**TODO: release gems**
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -25,11 +23,12 @@ Or install it yourself as:
 Parse ruby to textlint AST
 
 ```sh
+# Parse specific file
 $ textlint-ruby ./path/to/file.rb
 {"type":"Document","raw":"...","range":[0,465],"loc":{"start":{"line":1,"column":0},"end":{"line":26,"column":0}},"children":[...]}
 
-# textlint-ruby-optimized is 10x faster but many features of ruby are disabled.
-$ textlint-ruby-optimized ./path/to/file.rb
+# Boot textlint-ruby server for textlint-plugin-ruby
+$ textlint-ruby --stdio
 ```
 
 ### Supported nodes
@@ -69,7 +68,7 @@ Supported node types are only `Document` and `Str` because this plugin is used t
 | ASTNodeTypes.ImageExit          | TxtNode       |                                      |
 | ASTNodeTypes.HorizontalRule     | TxtNode       |                                      |
 | ASTNodeTypes.HorizontalRuleExit | TxtNode       |                                      |
-| ASTNodeTypes.Comment            | TxtTextNode   |                                      |
+| ASTNodeTypes.Comment            | TxtTextNode   | yes                                  |
 | ASTNodeTypes.CommentExit        | TxtTextNode   |                                      |
 | ASTNodeTypes.Str                | TxtTextNode   | yes                                  |
 | ASTNodeTypes.StrExit            | TxtTextNode   |                                      |

data/bin/textlint-ruby

@@ -5,21 +5,4 @@ $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 require 'textlint'
 
-path = ARGV[0]
-
-unless File.exist?(path.to_s)
-  warn("Error: No such file or directory: #{path}")
-  exit(1)
-end
-
-content = File.read(path)
-
-begin
-  ast = Textlint::Parser.parse(content)
-  puts(ast.as_textlint_json.to_json)
-rescue Textlint::SyntaxError => error
-  warn("Failed to compile: #{path}")
-  warn('')
-  warn(error)
-  exit(1)
-end
+Textlint::Cli.run(ARGV.clone)

data/lib/textlint/cli.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module Textlint
+  class Cli
+    attr_reader :options
+
+    DEFAULT_OPTIONS = {
+      stdio: false,
+      paths: []
+    }.freeze
+
+    # @param argv [Array] ARGV
+    def self.run(argv)
+      new(argv).run
+    end
+
+    # @param argv [Array] ARGV
+    def initialize(argv)
+      @options = DEFAULT_OPTIONS.dup
+      parse_options(argv)
+    end
+
+    # Run textlint-ruby
+    #
+    # @return [void]
+    def run
+      if @options[:stdio]
+        run_stdio_server
+      else
+        run_file_parser
+      end
+    end
+
+    private
+
+    def run_stdio_server
+      Textlint::Server.new.start
+    end
+
+    def run_file_parser
+      path = @options[:path]
+
+      unless File.exist?(path.to_s)
+        warn("Error: No such file or directory: #{path}")
+        exit(1)
+      end
+
+      content = File.read(path)
+
+      begin
+        ast = Textlint::Parser.parse(content)
+        puts(ast.as_textlint_json.to_json)
+      rescue Textlint::SyntaxError => error
+        warn("Failed to compile: #{path}")
+        warn('')
+        warn(error)
+        exit(1)
+      end
+    end
+
+    def parse_options(argv)
+      option_parser = ::OptionParser.new do |parser|
+        parser.banner = 'Usage: textlint-ruby [rubyfile_path] [options]'
+        parser.program_name = 'textlint-ruby'
+
+        parser.version = [
+          Textlint::VERSION::MAJOR,
+          Textlint::VERSION::MINOR,
+          Textlint::VERSION::TINY
+        ]
+
+        parser.on('--stdio', 'use stdio') do
+          @options[:stdio] = true
+        end
+
+        parser.on_tail('-h', '--help') do
+          puts option_parser.help
+          exit
+        end
+      end
+
+      @options[:path] = option_parser.parse(argv).first
+
+      if !@options[:stdio] && !@options[:path]
+        puts option_parser.help
+        exit(1)
+      end
+    end
+  end
+end

data/lib/textlint/parser.rb

@@ -5,6 +5,8 @@ require 'ripper'
 module Textlint
   class Parser
     class RubyToTextlintAST < ::Ripper::Filter
+      EVENT_RE = /\Aon_(?<name>\w*)_(?:beg|end)\z/.freeze
+
       # @param src [String]
       # @param lines [Array<String>]
       def initialize(src)
@@ -12,20 +14,23 @@ module Textlint
         @src = src
         @pos = 0
         @lines = @src.lines
+        @events = []
       end
 
       private
 
+      # All events call this method
       # NOTE: Instance variables are allowed to assign only here to readable code.
       def on_default(event, token, node)
         @token = token
+        @event = event
 
         method_name = :"custom_#{event}"
 
         if respond_to?(method_name, true)
           @range = @pos...(@pos + @token.size)
           @raw = @src[@range]
-          node = send(method_name, node)
+          send(method_name, node)
         end
 
         @pos += @token.size
@@ -34,6 +39,14 @@ module Textlint
       end
 
       def default_node_attributes(type:, **attributes)
+        break_count = @token.scan(Textlint::BREAK_RE).size
+
+        last_column = if break_count == 0
+                        column + @token.size
+                      else
+                        @token.match(LAST_LINE_RE).to_s.size
+                      end
+
         {
           type: type,
           raw: @raw,
@@ -43,12 +56,21 @@ module Textlint
               line: lineno,
               column: column
             ),
-            end: end_txt_node_position
+            end: Textlint::Nodes::TxtNodePosition.new(
+              line: lineno + break_count,
+              column: last_column
+            )
           )
         }.merge(attributes)
       end
 
+      # "hello world"
+      # 'hello world'
+      # %q{hello world}
       def custom_on_tstring_content(parentNode)
+        begin_event_name, _begin_node = @events.last
+        return unless %w[tstring qwords].include?(begin_event_name)
+
         node = Textlint::Nodes::TxtTextNode.new(
           **default_node_attributes(
             type: Textlint::Nodes::STR,
@@ -61,20 +83,68 @@ module Textlint
         parentNode
       end
 
-      def end_txt_node_position
-        break_count = @token.scan(Textlint::BREAK_RE).size
+      # # hello world
+      def custom_on_comment(parentNode)
+        node = Textlint::Nodes::TxtTextNode.new(
+          **default_node_attributes(
+            type: Textlint::Nodes::COMMENT,
+            value: @token.gsub(/\A#/, '')
+          )
+        )
 
-        last_column = if break_count == 0
-                        column + @token.size
-                      else
-                        @token.match(LAST_LINE_RE).to_s.size
-                      end
+        parentNode.children.push(node)
+      end
+
+      # =begin
+      # hello world
+      # =end
+      def custom_on_embdoc(parentNode)
+        _begin_event_name, begin_node = @events.last
+
+        node = Textlint::Nodes::TxtTextNode.new(
+          type: Textlint::Nodes::COMMENT,
+          loc: begin_node.loc,
+          range: begin_node.range,
+          raw: begin_node.raw,
+          value: @token
+        )
+
+        parentNode.children.push(node)
+      end
 
-        Textlint::Nodes::TxtNodePosition.new(
-          line: lineno + break_count,
-          column: last_column
+      def event_name
+        matched = EVENT_RE.match(@event)
+        matched[:name] if matched
+      end
+
+      def on_beg_event(*)
+        @events.push(
+          [
+            event_name,
+            Textlint::Nodes::TxtTextNode.new(
+              **default_node_attributes(
+                type: nil, # NOTE: beg event has no type
+                value: @token
+              )
+            )
+          ]
         )
       end
+
+      def on_end_event(*)
+        @events.pop
+      end
+
+      alias custom_on_tstring_beg on_beg_event
+      alias custom_on_regexp_beg on_beg_event
+      alias custom_on_embexpr_beg on_beg_event
+      alias custom_on_qwords_beg on_beg_event
+      alias custom_on_embdoc_beg on_beg_event
+
+      alias custom_on_tstring_end on_end_event
+      alias custom_on_regexp_end on_end_event
+      alias custom_on_embexpr_end on_end_event
+      alias custom_on_embdoc_end on_end_event
     end
 
     # Parse ruby code to AST for textlint
@@ -86,33 +156,41 @@ module Textlint
       new(src).call
     end
 
-    # @param src [String] ruby source code
-    def initialize(src)
-      @src = src
-    end
-
-    # Parse ruby code to AST for textlint
+    # Parse ruby code to TxtParentNode
+    #
+    # @param src [String]
     #
     # @return [Textlint::Nodes::TxtParentNode]
-    def call
-      check_syntax!
-
-      document = Textlint::Nodes::TxtParentNode.new(
+    def self.build_document(src)
+      Textlint::Nodes::TxtParentNode.new(
         type: Textlint::Nodes::DOCUMENT,
-        raw: @src,
-        range: 0...@src.size,
+        raw: src,
+        range: 0...src.size,
         loc: Textlint::Nodes::TxtNodeLineLocation.new(
           start: Textlint::Nodes::TxtNodePosition.new(
             line: 1,
             column: 0
           ),
           end: Textlint::Nodes::TxtNodePosition.new(
-            line: @src.split(Textlint::BREAK_RE).size + 1,
-            column: @src.match(LAST_LINE_RE).to_s.size # extract last line
+            line: src.split(Textlint::BREAK_RE).size + 1,
+            column: src.match(LAST_LINE_RE).to_s.size # extract last line
           )
         )
       )
+    end
+
+    # @param src [String] ruby source code
+    def initialize(src)
+      @src = src
+    end
+
+    # Parse ruby code to AST for textlint
+    #
+    # @return [Textlint::Nodes::TxtParentNode]
+    def call
+      check_syntax!
 
+      document = self.class.build_document(@src)
       RubyToTextlintAST.new(@src).parse(document)
     end
 

data/lib/textlint/server.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Textlint
+  class Server
+    REQUIRED_VERSION = '2.0.0'
+
+    AVAILABLE_ACTIONS = %w[
+      parse
+      info
+    ].freeze
+
+    # @param stdin [IO]
+    # @param stdout [IO]
+    # @param stderr [IO]
+    def initialize(stdin: $stdin, stdout: $stdout, stderr: $stderr)
+      @stdin = stdin
+      @stdout = stdout
+      @stderr = stderr
+    end
+
+    # Start stdio server
+    #
+    # @return [void]
+    def start
+      @stdout.sync = true
+      trap_signals
+      start_server
+    end
+
+    private
+
+    def start_server
+      receive_stdin do |json|
+        action = json['action']
+        result = send(:"do_#{action}", json)
+        request_seq = json['seq']
+        response = { request_seq: request_seq, result: result }
+
+        @stdout.puts(JSON.dump(response))
+      end
+    end
+
+    def validate_request(json)
+      if Gem::Version.create(json['version'].to_s) < Gem::Version.create(REQUIRED_VERSION)
+        raise(Textlint::RequestError, "textlint-ruby requires textlin-plugin-ruby version >= #{REQUIRED_VERSION}")
+      elsif !AVAILABLE_ACTIONS.include?(json['action'])
+        raise(Textlint::RequestError, "Unknown action(#{json['action']}) given. Available actions are #{AVAILABLE_ACTIONS}")
+      end
+    end
+
+    # request spec
+    #   { "seq": number, "action": string, "version": string, [key: string]: any }
+    #
+    # response spec
+    #   action "info"
+    #     { "request_seq": number, "version": string, result: string(version) }
+    #
+    #   action "parse"
+    #     { "request_seq": number, "version": string, result: string(AST for textlint) }
+    def receive_stdin
+      loop do
+        return if @stdin.eof?
+
+        line = @stdin.readline
+
+        begin
+          json = JSON.parse(line)
+          validate_request(json)
+          yield(json)
+        rescue JSON::JSONError
+          warn("Can't parse request to JSON")
+        rescue StandardError => error
+          warn(error.message)
+        end
+      end
+    end
+
+    def warn(message)
+      @stderr.puts(message)
+    end
+
+    def trap_signals
+      ::Signal.trap(:SIGINT) do
+        exit
+      end
+    end
+
+    def do_info(_json)
+      Textlint::VERSION::STRING
+    end
+
+    def do_parse(json)
+      path = json['path'].to_s
+
+      unless File.exist?(path)
+        raise(Textlint::RequestError, "Error: No such file or directory: #{path}")
+      end
+
+      content = File.read(path)
+
+      ast = begin
+        Textlint::Parser.parse(content)
+      rescue Textlint::SyntaxError
+        error = Textlint::RequestError.new("Failed to parse: #{path}. syntax error or the file is incompatible with the ruby(#{RUBY_VERSION}) running textlint-ruby")
+        warn(error)
+
+        Textlint::Parser.build_document(content)
+      end
+
+      ast.as_textlint_json
+    end
+  end
+end

data/lib/textlint/version.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
 module Textlint
-  VERSION = '0.1.1'
+  module VERSION
+    MAJOR = 2
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
 end

data/lib/textlint.rb

@@ -4,10 +4,14 @@ require 'json'
 require 'textlint/version'
 require 'textlint/nodes'
 require 'textlint/parser'
+require 'textlint/cli'
+require 'textlint/server'
 
 module Textlint
   BREAK_RE = /\r?\n/.freeze
   LAST_LINE_RE = /(?!\r?\n).*\z/.freeze
 
-  class SyntaxError < StandardError; end
+  class Error < StandardError; end
+  class SyntaxError < Error; end
+  class RequestError < Error; end
 end

data/textlint.gemspec

@@ -4,7 +4,7 @@ require_relative 'lib/textlint/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'textlint-ruby'
-  spec.version       = Textlint::VERSION
+  spec.version       = Textlint::VERSION::STRING
   spec.authors       = ['alpaca-tc']
   spec.email         = ['alpaca-tc@alpaca.tc']
 

metadata

@@ -1,21 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: textlint-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - alpaca-tc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2021-12-02 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email:
 - alpaca-tc@alpaca.tc
 executables:
 - textlint-ruby
-- textlint-ruby-optimized
 extensions: []
 extra_rdoc_files: []
 files:
@@ -31,11 +30,12 @@ files:
 - README.md
 - Rakefile
 - bin/textlint-ruby
-- bin/textlint-ruby-optimized
 - lib/textlint-ruby.rb
 - lib/textlint.rb
+- lib/textlint/cli.rb
 - lib/textlint/nodes.rb
 - lib/textlint/parser.rb
+- lib/textlint/server.rb
 - lib/textlint/version.rb
 - textlint.gemspec
 homepage: https://github.com/alpaca-tc/textlint-ruby
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: ruby source code parser for textlint

data/bin/textlint-ruby-optimized

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby --disable-all
-# frozen_string_literal: true
-
-load "#{__dir__}/textlint-ruby"