chupa-text 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae05a44da20490f2d7833d513cfc423819dd65ef5e1d6285e5a82db8482673fa
-  data.tar.gz: b202c67426ca48058422f169339c069cb6bc42e892a40fd9c72bda3463610b94
+  metadata.gz: 99a53085d7eca8e459b0944e44cdb415036d19b6dc5a366e10bc3921a8c8cb09
+  data.tar.gz: ce808a0a9e9352e2b4cf92c9e7348b57e522ee1717dc8070631451aa6a3b9a29
 SHA512:
-  metadata.gz: 28126643d65dc7ef423dccc0f727be7b275db0005f66f4c40f0c8e5dafe8b159cdea2b6c8aeca98bf7e9979849cf531ddd5afad81f30c85d031dae925029e763
-  data.tar.gz: 498fb93a26bfd139d9fba1d15d00bbc17547b9e326c403301794b89f2548c78e8d000ed45c3404c3b0a00073e677c1783c64b1423357893c89326d60efeb07d3
+  metadata.gz: 334356c90df57f22ae1fe0871e93147470c7505782487f71613f3fa794ea7fe0ed03b16980892beb46d662f830b876b6b4ff5132b8677892be1246ea26e38f40
+  data.tar.gz: 86de4013d3f07d4d89c2113d01d78d4e6685b95af28ab1ad72267908d3c4b9ea30720eec515380989b6fb2a50d913041ee8223197cbcfa00c51b61b97506d1d7

data/doc/text/news.md

@@ -1,5 +1,21 @@
 # News
 
+## 1.2.1: 2019-03-04
+
+### Improvements
+
+  * `ChupaText::ExternalCommand`:
+
+    * Added more logs.
+
+    * Added support for ensuring killing external command.
+
+    * Added default value API.
+
+  * `ChupaText::VirtualFileContent`:
+
+    * Added support for inlining small data.
+
 ## 1.2.0: 2019-03-03
 
 ### Improvements

data/lib/chupa-text/decomposers/tar.rb

@@ -40,18 +40,9 @@ module ChupaText
               path_converter = PathConverter.new(entry.full_name,
                                                  uri_escape: true)
               entry_uri.path = "#{base_path}/#{path_converter.convert}"
-              size = entry.header.size
-              if size < (32 * 1024)
-                entry_data = Data.new(source_data: data)
-                entry_data.uri = entry_uri
-                body = entry.read || ""
-                entry_data.body = body
-                entry_data.size = body.bytesize
-              else
-                entry_data = VirtualFileData.new(entry_uri,
-                                                 entry,
-                                                 :source_data => data)
-              end
+              entry_data = VirtualFileData.new(entry_uri,
+                                               entry,
+                                               :source_data => data)
               yield(entry_data)
             end
           end

data/lib/chupa-text/decomposers/zip.rb

@@ -49,18 +49,9 @@ module ChupaText
                                                encoding: base_path.encoding,
                                                uri_escape: true)
             entry_uri.path = "#{base_path}/#{path_converter.convert}"
-            size = entry.raw_data.window_size
-            if size < (8 * 1024)
-              entry_data = Data.new(source_data: data)
-              entry_data.uri = entry_uri
-              body = entry.file_data.read
-              entry_data.body = body
-              entry_data.size = body.bytesize
-            else
-              entry_data = VirtualFileData.new(entry_uri,
-                                               entry.file_data,
-                                               source_data: data)
-            end
+            entry_data = VirtualFileData.new(entry_uri,
+                                             entry.file_data,
+                                             source_data: data)
             yield(entry_data)
           end
         end

data/lib/chupa-text/external-command.rb

@@ -22,6 +22,42 @@ module ChupaText
   class ExternalCommand
     include Loggable
 
+    @default_timeout = nil
+    @default_limit_cpu = nil
+    @default_limit_as = nil
+    class << self
+      def default_timeout
+        @default_timeout || ENV["CHUPA_TEXT_EXTERNAL_COMMAND_TIMEOUT"]
+      end
+
+      def default_timeout=(timeout)
+        @default_timeout = timeout
+      end
+
+      def default_limit_cpu
+        @default_limit_cpu || limit_env("CPU")
+      end
+
+      def default_limit_cpu=(cpu)
+        @default_limit_cpu = cpu
+      end
+
+      def default_limit_as
+        @default_limit_as || limit_env("AS")
+      end
+
+      def default_limit_as=(as)
+        @default_limit_as = as
+      end
+
+      private
+      def limit_env(name)
+        ENV["CHUPA_TEXT_EXTERNAL_COMMAND_LIMIT_#{name}"] ||
+          # For backward compatibility
+          ENV["CHUPA_EXTERNAL_COMMAND_LIMIT_#{name}"]
+      end
+    end
+
     attr_reader :path
     def initialize(path)
       @path = Pathname.new(path)
@@ -37,7 +73,18 @@ module ChupaText
                   @path.to_s,
                   *arguments,
                   spawn_options(options[:spawn_options]))
-      status = wait_process(pid, options[:timeout])
+      status = nil
+      begin
+        status = wait_process(pid, options[:timeout])
+      ensure
+        unless status
+          begin
+            Process.kill(:KILL, pid)
+            Process.waitpid(pid)
+          rescue SystemCallError
+          end
+        end
+      end
       status.success?
     end
 
@@ -72,11 +119,8 @@ module ChupaText
       return if options[option_key]
 
       tag = "[limit][#{key}]"
-      value =
-        ENV["CHUPA_TEXT_EXTERNAL_COMMAND_LIMIT_#{key.to_s.upcase}"] ||
-        # For backward compatibility
-        ENV["CHUPA_EXTERNAL_COMMAND_LIMIT_#{key.to_s.upcase}"]
-      value = send("parse_#{type}", tag, value)
+      value = self.class.__send__("default_limit_#{key}")
+      value = __send__("parse_#{type}", tag, value)
       return if value.nil?
       rlimit_number = Process.const_get("RLIMIT_#{key.to_s.upcase}")
       soft_limit, hard_limit = Process.getrlimit(rlimit_number)
@@ -96,67 +140,87 @@ module ChupaText
     end
 
     def parse_int(tag, value)
-      return nil if value.nil?
-      return nil if value.empty?
-      begin
-        Integer(value)
-      rescue ArgumentError
-        log_invalid_value(tag, value, type, "int")
+      case value
+      when nil
         nil
+      when Integer
+        value
+      when Float
+        value.round
+      else
+        return nil if value.empty?
+        begin
+          Integer(value)
+        rescue ArgumentError
+          log_invalid_value(tag, value, type, "int")
+          nil
+        end
       end
     end
 
     def parse_size(tag, value)
-      return nil if value.nil?
-      return nil if value.empty?
-      scale = 1
       case value
-      when /GB?\z/i
-        scale = 1024 ** 3
-        number = $PREMATCH
-      when /MB?\z/i
-        scale = 1024 ** 2
-        number = $PREMATCH
-      when /KB?\z/i
-        scale = 1024 ** 1
-        number = $PREMATCH
-      when /B?\z/i
-        number = $PREMATCH
+      when nil
+        nil
+      when Numeric
+        value
       else
-        number = value
-      end
-      begin
-        number = Float(number)
-      rescue ArgumentError
-        log_invalid_value(tag, value, "size")
-        return nil
+        return nil if value.empty?
+        scale = 1
+        case value
+        when /GB?\z/i
+          scale = 1024 ** 3
+          number = $PREMATCH
+        when /MB?\z/i
+          scale = 1024 ** 2
+          number = $PREMATCH
+        when /KB?\z/i
+          scale = 1024 ** 1
+          number = $PREMATCH
+        when /B?\z/i
+          number = $PREMATCH
+        else
+          number = value
+        end
+        begin
+          number = Float(number)
+        rescue ArgumentError
+          log_invalid_value(tag, value, "size")
+          return nil
+        end
+        (number * scale).to_i
       end
-      (number * scale).to_i
     end
 
     def parse_time(tag, value)
-      return nil if value.nil?
-      return nil if value.empty?
-      scale = 1
       case value
-      when /h\z/i
-        scale = 60 * 60
-        number = $PREMATCH
-      when /m\z/i
-        scale = 60
-        number = $PREMATCH
-      when /s\z/i
-        number = $PREMATCH
+      when nil
+        nil
+      when Numeric
+        value
       else
-        number = value
-      end
-      begin
-        number = Float(number)
-      rescue ArgumentError
-        log_invalid_value(tag, value, "time")
-        return nil
+        return nil if value.empty?
+        scale = 1
+        case value
+        when /h\z/i
+          scale = 60 * 60
+          number = $PREMATCH
+        when /m\z/i
+          scale = 60
+          number = $PREMATCH
+        when /s\z/i
+          number = $PREMATCH
+        else
+          number = value
+        end
+        begin
+          number = Float(number)
+        rescue ArgumentError
+          log_invalid_value(tag, value, "time")
+          return nil
+        end
+        (number * scale).to_f
       end
-      (number * scale).to_f
     end
 
     def log_invalid_value(tag, value, type)
@@ -164,17 +228,17 @@ module ChupaText
     end
 
     def wait_process(pid, timeout)
-      if timeout.nil?
-        timeout_env = ENV["CHUPA_TEXT_EXTERNAL_COMMAND_TIMEOUT"]
-        timeout = parse_time("[timeout]", timeout_env) if timeout_env
-      end
-
+      tag = "[timeout]"
+      timeout = parse_time(tag, timeout || self.class.default_timeout)
       if timeout
+        info("#{log_tag}#{tag}[use] <#{timeout}s>: <#{pid}>")
         status = wait_process_timeout(pid, timeout)
         return status if status
+        info("#{log_tag}#{tag}[terminate] <#{pid}>")
         Process.kill(:TERM, pid)
         status = wait_process_timeout(pid, 5)
         return status if status
+        info("#{log_tag}#{tag}[kill] <#{pid}>")
         Process.kill(:KILL, pid)
       end
       _, status = Process.waitpid2(pid)

data/lib/chupa-text/version.rb

@@ -15,5 +15,5 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 module ChupaText
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/lib/chupa-text/virtual-content.rb

@@ -20,12 +20,10 @@ require "tempfile"
 
 module ChupaText
   class VirtualContent
-    KILO_BYTE = 1024
-    BUFFER_SIZE = 64 * KILO_BYTE
+    INLINE_MAX_SIZE = 64 * 1024
 
     attr_reader :size
     def initialize(input, original_path=nil)
-      @file = nil
       if original_path.is_a?(String)
         if original_path.empty?
           original_path = nil
@@ -34,28 +32,56 @@ module ChupaText
         end
       end
       @original_path = original_path
-      setup_file do |file|
-        @size = IO.copy_stream(input, file)
+      body = input.read(INLINE_MAX_SIZE + 1) || ""
+      if body.bytesize <= INLINE_MAX_SIZE
+        @body = body
+        @size = @body.bytesize
+        @file = nil
+        @path = nil
+      else
+        @body = nil
+        setup_file do |file|
+          file.write(body)
+          @size = body.bytesize
+          @size += IO.copy_stream(input, file)
+        end
       end
     end
 
     def open(&block)
-      File.open(path, "rb", &block)
+      if @body
+        yield(StringIO.new(@body))
+      else
+        File.open(path, "rb", &block)
+      end
     end
 
     def body
-      open do |file|
-        file.read
+      if @body
+        @body
+      else
+        open do |file|
+          file.read
+        end
       end
     end
 
     def peek_body(size)
-      open do |file|
-        file.read(size)
+      if @body
+        @body[0, size]
+      else
+        open do |file|
+          file.read(size)
+        end
       end
     end
 
     def path
+      if @path.nil?
+        setup_file do |file|
+          file.write(@body)
+        end
+      end
       @path
     end
 
@@ -77,6 +103,7 @@ module ChupaText
     def setup_file
       basename = compute_tempfile_basename
       @file = Tempfile.new(basename)
+      @file.binmode
       @path = @file.path
       yield(@file)
       @file.close

data/test/test-virtual-content.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2013-2019  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -53,7 +53,7 @@ class TestVirtualContent < Test::Unit::TestCase
 
   sub_test_case("large data") do
     def setup
-      @body = "X" * (ChupaText::VirtualContent::BUFFER_SIZE + 1)
+      @body = "X" * (ChupaText::VirtualContent::INLINE_MAX_SIZE + 1)
     end
 
     def test_size

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chupa-text
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Kouhei Sutou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-02 00:00:00.000000000 Z
+date: 2019-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: archive-zip