pnote_client 2.4.5 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8f2b39c3dcb41b81b2acd6aa0e6c6468ae694def1f31b6b7c3cd1bd871dcec
-  data.tar.gz: 11118c0753bf8876099e2ac833919f3dd4b51abe46d80ff7e5e78aedb3a34c35
+  metadata.gz: a3ba1826c4b23e1951591e2b88f0b835ea3c5ffa2c3501f58afd971d8a0b52c2
+  data.tar.gz: b18197526f4a93f7910310b885479c55d8f32f4c4b3b7cb3165afa54ef13cfb0
 SHA512:
-  metadata.gz: accfeda9c8ebd5288e4104783ba1d6b83b2565c94015b2310a740fe4eb54bee8e47c4f1586f2b483b29db10207a8e2338c6918e83b48be90b12cfe159d4af8f5
-  data.tar.gz: 5b2fb999ab60ece1abed5e1c94d7ad1f4bce5bab7ec58528b7f7e25ecfe5c4ed5006b1cc2400179528cfec77fb128c0cdc28740d3e56fa483acb000edcc36fe5
+  metadata.gz: 1c3edfc027d91c5738e144885f03d495f87f401cbdd0c5cc31d2be566479c241520c73a3d410b1269ec62b9b3f31710d202dd26ad9f39287761a3fd5fefe3c5d
+  data.tar.gz: 9feceda15a01f1fe44c87875057b2c85625a52bdd67bb1cd588cbfcaaf94656d10501714f5fae5a490d09a90a73ca1b152750929f5a136701edfab2782ac04a9

data/exe/pnote_to_json

@@ -9,6 +9,7 @@ require 'pnote_client/converters/pnote_to_json_converter'
 require 'pnote_client/documents/hml'
 require 'pnote_client/display/console_display'
 require 'pnote_client/validators/pnote_validator'
+require 'pnote_client/validators/hml_validator'
 
 def read_file(filepath)
   f = File.open(filepath, 'r')
@@ -25,22 +26,21 @@ def write_file(content, filepath)
   f.close
 end
 
-def save_validation_log_file(result, log_filepath)
+def save_validation_log_file(hml_validate_result, pnote_validate_result, log_filepath)
   log_content = ""
   log_content += "==========[Warnings]=========="
   log_content += "\n"
-  result[:warnings].each_with_index do |warning, index|
+  (hml_validate_result[:warnings] + pnote_validate_result[:warnings]).each_with_index do |warning, index|
     log_content += "#{index + 1}.\n[경고 메시지]\n#{warning[:message]}\n[상세내용]\n#{warning[:detail]}\n\n\n"
   end
   log_content += "\n\n"
   log_content += "==========[Errors]=========="
   log_content += "\n"
-  result[:errors].each_with_index do |error, index|
+  (hml_validate_result[:errors] + pnote_validate_result[:errors]).each_with_index do |error, index|
     log_content += "#{index + 1}.\n[에러 메시지]\n#{error[:message]}\n[상세내용]\n#{error[:detail]}\n\n\n"
   end
 
   write_file(log_content, log_filepath)
-  puts "로그 파일이 저장되었습니다. (#{log_filepath})"
 end
 
 # 커맨드라인 argument로 옵션 입력받기
@@ -104,28 +104,65 @@ input_filename, input_dir_path, hml_content = read_file(options[:input_filepath]
 output_filepath = File.join(input_dir_path, input_filename + ".json")
 log_filepath = File.join(input_dir_path, input_filename + ".log")
 
-# 파일 읽어들인 뒤 PnoteDocument로 변환
+# 변환 전 HmlDocument 검증
+puts ""
+puts "=============================================="
+puts "hml 파일을 검사하는 중입니다..."
+puts "=============================================="
+puts ""
+sleep(1)
 hml_document = PnoteClient::Documents::Hml.parse(hml_content)
+hml_validator = PnoteClient::Validators::HmlValidator.new(hml_document)
+hml_validate_result = hml_validator.validate
+
+# HmlDocument를 PnoteDocument로 변환
+puts ""
+puts "=============================================="
+puts "hml 파일을 pnote 파일로 변환하는 중입니다..."
 hml_to_pnote_converter = PnoteClient::Converters::HmlToPnoteConverter.new(hml_document, show_time: options[:show_time], type_style_mapper: type_style_mapper, include_image_data: options[:include_image_data])
 hml_to_pnote_converter.delegate = display
 pnote_document = hml_to_pnote_converter.convert
+puts "=============================================="
+puts ""
 
 # PnoteDocument 상태 검증
-validator = PnoteClient::Validators::PnoteValidator.new(pnote_document, display)
-result = validator.validate
-if validator.has_error?
-  save_validation_log_file(result, log_filepath)
-  puts "변환 에러가 발생했습니다. 로그파일을 확인해주세요."
-  abort
-elsif validator.has_warning?
-  save_validation_log_file(result, log_filepath)
-  puts "#{validator.warning_count}개의 경고가 있습니다. 계속 진행하시겠습니까? (y/n)"
-  response = gets.chomp.downcase
-  if response != 'y'
-    abort
-  end
-end
+puts ""
+puts "=============================================="
+puts "pnote 파일을 검사하는 중입니다..."
+puts "=============================================="
+puts ""
+sleep(1)
+pnote_validator = PnoteClient::Validators::PnoteValidator.new(pnote_document)
+pnote_validate_result = pnote_validator.validate
+
 
 # PnoteDocument를 JSON 파일로 저장
+puts ""
+puts "=============================================="
+puts "pnote 파일을 json 파일로 저장하는 중입니다..."
+puts "=============================================="
+puts ""
+sleep(1)
 json = PnoteClient::Converters::PnoteToJsonConverter.new(pnote_document).convert
 write_file(json, output_filepath)
+
+
+#로그 파일 저장
+puts ""
+puts "=============================================="
+puts "로그 파일을 저장하는 중입니다..."
+puts "파일 경로: #{log_filepath}"
+puts "=============================================="
+puts ""
+sleep(1)
+save_validation_log_file(hml_validate_result, pnote_validate_result, log_filepath)
+
+puts ""
+puts "=============================================="
+puts "변환이 완료되었습니다. (파일 경로: #{output_filepath})"
+puts "hml 파일 검사 결과: 경고 #{hml_validate_result[:warnings].length}개, 에러 #{hml_validate_result[:errors].length}개"
+puts "pnote 파일 검사 결과: 경고 #{pnote_validate_result[:warnings].length}개, 에러 #{pnote_validate_result[:errors].length}개"
+puts ""
+puts "에러가 있을 경우 json 파일 업로드나 LaTeX 렌더링에 문제가 발생할 수 있습니다."
+puts "=============================================="
+puts ""

data/lib/pnote_client/display/console_display.rb

@@ -6,10 +6,6 @@ module PnoteClient
     def initialize
     end
 
-    def print_validation(result)
-      puts "검증 결과: 경고 #{result[:warnings].length}개, 에러 #{result[:errors].length}개"
-    end
-
     def paragraph_converted(count:, current:)
       print_progress(count, current, "문단 변환 중")
 

data/lib/pnote_client/documents/hml/equation.rb

@@ -11,6 +11,8 @@ module PnoteClient
           return self.new(script)
         end
 
+        attr_reader :script
+
         def initialize(script)
           @script = script
           @script_converter = ::HwpScriptToLatex::Converter.new

data/lib/pnote_client/documents/hml/paragraph.rb

@@ -48,7 +48,7 @@ module PnoteClient
           return paragraph
         end
 
-        attr_reader :style_id, :shape_id
+        attr_reader :style_id, :shape_id, :elements
         attr_reader :endnote_paragraphs, :footnote_paragraphs
 
         def initialize(style_id:, shape_id:)

data/lib/pnote_client/validators/hml_validator.rb

@@ -0,0 +1,110 @@
+#
+#  Author: osh
+#  Created: 2019-05-23
+#  Last modified: 2019-05-23
+
+require 'pnote_client/documents/hml/equation'
+
+module PnoteClient
+  module Validators
+    class HmlValidator
+      def initialize(hml_document)
+        @hml_document = hml_document
+        @result = {
+          errors: [],
+          warnings: []
+        }
+      end
+
+      def validate
+        reset_result
+        validate_document
+        return @result
+      end
+
+      def has_error?
+        return error_count > 0
+      end
+
+      def has_warning?
+        return warning_count > 0
+      end
+
+      def error_count
+        return @result[:errors].length
+      end
+
+      def warning_count
+        return @result[:warnings].length
+      end
+
+      private
+
+      def reset_result
+        @result = {
+          errors: [],
+          warnings: []
+        }
+      end
+
+      def validate_document
+        @hml_document.paragraphs.each do |paragraph|
+          validate_paragraph(paragraph)
+
+          paragraph.footnote_paragraphs.each do |paragraph|
+            validate_paragraph(paragraph)
+          end
+
+          paragraph.endnote_paragraphs.each do |paragraph|
+            validate_paragraph(paragraph)
+          end
+        end
+      end
+
+      def validate_paragraph(paragraph)
+        paragraph.elements.each do |element|
+          if element.class == Documents::Hml::Equation
+            invalids = validate_equation(element) 
+            invalids.each do |invalid|
+              if invalid[:type] == :error
+                @result[:errors] << {
+                  message: invalid[:message],
+                  detail: paragraph.content
+                }
+              elsif invalid[:type] == :warning
+                @result[:warnings] << {
+                  message: invalid[:message],
+                  detail: paragraph.content
+                }
+              end
+            end
+          end
+        end
+      end
+
+      def validate_equation(equation)
+        open_bracket_regex = /(?<![\\])\s*{/
+        close_bracket_regex = /(?<![\\])\s*}/
+        open_bracket_count = equation.script.scan(open_bracket_regex).length
+        close_bracket_count = equation.script.scan(close_bracket_regex).length
+        invalids = []
+
+        if open_bracket_count > close_bracket_count
+          invalids << {
+            type: :error,
+            message: "닫는 중괄호(`}`)가 부족합니다."
+          }
+        end
+
+        if open_bracket_count < close_bracket_count
+          invalids << {
+            type: :error,
+            message: "여는 중괄호(`}`)가 부족합니다."
+          }
+        end
+
+        return invalids
+      end
+    end
+  end
+end

data/lib/pnote_client/validators/pnote_validator.rb

@@ -6,9 +6,8 @@
 module PnoteClient
   module Validators
     class PnoteValidator
-      def initialize(pnote_document, display = nil)
+      def initialize(pnote_document)
         @pnote_document = pnote_document
-        @display = display
         @result = {
           errors: [],
           warnings: []
@@ -18,7 +17,6 @@ module PnoteClient
       def validate
         reset_result
         validate_pnote_document
-        print_validation_result
         return @result
       end
 
@@ -110,10 +108,6 @@ module PnoteClient
           }
         end
       end
-
-      def print_validation_result
-        @display&.print_validation(@result)
-      end
     end
   end
 end

data/lib/pnote_client/version.rb

@@ -1,3 +1,3 @@
 module PnoteClient
-  VERSION = "2.4.5"
+  VERSION = "2.5.0"
 end

data/pnote_client.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_dependency "nokogiri"
-  spec.add_dependency "hwp_script_to_latex", '~> 1.3.5'
+  spec.add_dependency "hwp_script_to_latex", '~> 1.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pnote_client
 version: !ruby/object:Gem::Version
-  version: 2.4.5
+  version: 2.5.0
 platform: ruby
 authors:
 - bluesh55
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: 1.4.0
 description: 
 email:
 - bluesh55@naver.com
@@ -126,6 +126,7 @@ files:
 - lib/pnote_client/documents/pnote/sub_chapter.rb
 - lib/pnote_client/documents/pnote/teacher_comment.rb
 - lib/pnote_client/utils/string_util.rb
+- lib/pnote_client/validators/hml_validator.rb
 - lib/pnote_client/validators/pnote_validator.rb
 - lib/pnote_client/version.rb
 - pnote_client.gemspec