pnote_client 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ba1826c4b23e1951591e2b88f0b835ea3c5ffa2c3501f58afd971d8a0b52c2
-  data.tar.gz: b18197526f4a93f7910310b885479c55d8f32f4c4b3b7cb3165afa54ef13cfb0
+  metadata.gz: 0bb3d199f3908b91924336552bc96b99bf2347bfe3d6f74502296e77279f119d
+  data.tar.gz: 796d96999b57c8e096fcbd894a8591f88f6b25c30baebc21ecb961873a56855b
 SHA512:
-  metadata.gz: 1c3edfc027d91c5738e144885f03d495f87f401cbdd0c5cc31d2be566479c241520c73a3d410b1269ec62b9b3f31710d202dd26ad9f39287761a3fd5fefe3c5d
-  data.tar.gz: 9feceda15a01f1fe44c87875057b2c85625a52bdd67bb1cd588cbfcaaf94656d10501714f5fae5a490d09a90a73ca1b152750929f5a136701edfab2782ac04a9
+  metadata.gz: faded062961626e6a1391f677b3f0b641e2218310ae3176539a0cc5abd34c944435bc3fe25130b7a8961b473528dffec1a230cb9ebbd827b7d34ddfef73fbf5a
+  data.tar.gz: d4258855df9b53d4a1737194958e3772a3fb7fc9401c6e9032b328fc249d20838b7a8364ca93faf9b0dc4a6b05ad100228f2849f867b3c21622124ce7facf57b

data/exe/pnote_to_json

@@ -26,18 +26,13 @@ def write_file(content, filepath)
   f.close
 end
 
-def save_validation_log_file(hml_validate_result, pnote_validate_result, log_filepath)
+def save_validation_log_file(hml_errors, pnote_errors, log_filepath)
   log_content = ""
-  log_content += "==========[Warnings]=========="
-  log_content += "\n"
-  (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"
-  (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"
+  (hml_errors + pnote_errors).each_with_index do |error, index|
+    log_content += error
+    log_content += "\n\n"
   end
 
   write_file(log_content, log_filepath)
@@ -45,7 +40,6 @@ end
 
 # 커맨드라인 argument로 옵션 입력받기
 options = {
-  config_filepath: File.join(File.dirname(__FILE__), '..', 'config.json'),
   include_image_data: false,
   show_time: 600
 }
@@ -61,10 +55,6 @@ optparser = OptionParser.new do |opt|
     options[:include_image_data] = flag
   end
 
-  opt.on('-c', '--config [FILEPATH]', String, 'File path of configuration file(`config.json`). Default is `../config.json`') do |filepath|
-    options[:config_filepath]
-  end
-
   opt.on('-t', '--time [TIME]', String, '선생님 코멘트 노출시간을 입력해주세요. 기본값 600') do |show_time|
     options[:show_time] = show_time.to_i
   end
@@ -83,7 +73,6 @@ notice = <<-NOTICE
 [변환설정]
 입력파일 경로: #{options[:input_filepath]}
 이미지: #{options[:include_image_data] ? '포함' : '제외'}
-설정파일 경로: #{options[:config_filepath]}
 코멘트 노출시간 단위: #{options[:show_time]}초
 
 계속 진행하시겠습니까? (y/n)
@@ -97,9 +86,6 @@ end
 
 # 변환 준비 작업
 display = PnoteClient::ConsoleDisplay.new
-_, _, config_content = read_file(options[:config_filepath])
-config = JSON.parse(config_content, symbolize_names: true)
-type_style_mapper = config[:hml_pnote_styles]
 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")
@@ -113,13 +99,13 @@ 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
+hml_errors = 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 = PnoteClient::Converters::HmlToPnoteConverter.new(hml_document, show_time: options[:show_time], include_image_data: options[:include_image_data])
 hml_to_pnote_converter.delegate = display
 pnote_document = hml_to_pnote_converter.convert
 puts "=============================================="
@@ -133,7 +119,7 @@ puts "=============================================="
 puts ""
 sleep(1)
 pnote_validator = PnoteClient::Validators::PnoteValidator.new(pnote_document)
-pnote_validate_result = pnote_validator.validate
+pnote_errors = pnote_validator.validate
 
 
 # PnoteDocument를 JSON 파일로 저장
@@ -155,13 +141,14 @@ puts "파일 경로: #{log_filepath}"
 puts "=============================================="
 puts ""
 sleep(1)
-save_validation_log_file(hml_validate_result, pnote_validate_result, log_filepath)
+save_validation_log_file(hml_errors, pnote_errors, 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 "예제 #{pnote_document.exercise_count}개, 문제 #{pnote_document.practice_count}개"
+puts "hml 파일 검사 결과: 에러 #{hml_errors.length}개"
+puts "pnote 파일 검사 결과: 에러 #{pnote_errors.length}개"
 puts ""
 puts "에러가 있을 경우 json 파일 업로드나 LaTeX 렌더링에 문제가 발생할 수 있습니다."
 puts "=============================================="

data/lib/pnote_client/converters/hml_to_pnote_converter.rb

@@ -1,3 +1,4 @@
+require 'pnote_client'
 require 'pnote_client/documents/pnote'
 require 'pnote_client/documents/pnote/chapter'
 require 'pnote_client/documents/pnote/sub_chapter'
@@ -13,10 +14,9 @@ module PnoteClient
 
       attr_accessor :delegate
 
-      def initialize(hml_document, show_time:, type_style_mapper: {}, include_image_data: false)
+      def initialize(hml_document, show_time:, include_image_data: false)
         @hml_document = hml_document
         @show_time = show_time
-        @type_style_mapper = type_style_mapper
         @include_image_data = include_image_data
 
         @current_chapter = nil
@@ -187,7 +187,7 @@ module PnoteClient
 
       def paragraph_type(paragraph)
         pg_style = find_style(paragraph.style_id)
-        result = @type_style_mapper.find {|k, v| v == pg_style.name || (v.is_a?(Array) && v.include?(pg_style.name))}
+        result = ::PnoteClient::STYLES.find {|k, v| v == pg_style.name || (v.is_a?(Array) && v.include?(pg_style.name))}
         return nil if result.nil?
         return result[0]
       end

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

@@ -1,4 +1,5 @@
 require 'hwp_script_to_latex/converter'
+require 'hwp_script_to_latex/validator'
 
 module PnoteClient
   module Documents
@@ -15,6 +16,7 @@ module PnoteClient
 
         def initialize(script)
           @script = script
+          @script_validator = HwpScriptToLatex::Validator.new
           @script_converter = ::HwpScriptToLatex::Converter.new
         end
 
@@ -29,6 +31,10 @@ module PnoteClient
         def textable?
           return true
         end
+
+        def validate
+          return @script_validator.validate(@script)
+        end
       end
     end
   end

data/lib/pnote_client/documents/pnote.rb

@@ -15,6 +15,22 @@ module PnoteClient
       def add_image(new_image)
         @images << new_image
       end
+
+      def exercise_count
+        return @chapters.sum do |chapter|
+          chapter.sub_chapters.sum do |sub_chapter|
+            sub_chapter.exercises.count
+          end
+        end
+      end
+
+      def practice_count
+        return @chapters.sum do |chapter|
+          chapter.sub_chapters.sum do |sub_chapter|
+            sub_chapter.practices.count
+          end
+        end
+      end
     end
   end
 end

data/lib/pnote_client/validators/hml_validator.rb

@@ -3,107 +3,72 @@
 #  Created: 2019-05-23
 #  Last modified: 2019-05-23
 
+require 'pnote_client'
+require 'pnote_client/validators/validator'
 require 'pnote_client/documents/hml/equation'
 
 module PnoteClient
   module Validators
-    class HmlValidator
+    class HmlValidator < Validator
       def initialize(hml_document)
+        super()
         @hml_document = hml_document
-        @result = {
-          errors: [],
-          warnings: []
-        }
       end
 
       def validate
-        reset_result
+        reset_errors
         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
+        return @errors
       end
 
       private
 
-      def reset_result
-        @result = {
-          errors: [],
-          warnings: []
-        }
-      end
-
       def validate_document
+        practice_number = 1
+
         @hml_document.paragraphs.each do |paragraph|
-          validate_paragraph(paragraph)
+          next if paragraph.style_id != practice_style_id
+          validate_paragraph(paragraph, practice_number)
+
+          paragraph.endnote_paragraphs.each do |paragraph|
+            validate_paragraph(paragraph, practice_number)
+          end
 
           paragraph.footnote_paragraphs.each do |paragraph|
-            validate_paragraph(paragraph)
+            validate_paragraph(paragraph, practice_number)
           end
 
-          paragraph.endnote_paragraphs.each do |paragraph|
-            validate_paragraph(paragraph)
+          # 한 문제가 두 문단 이상으로 나눠진경우
+          # 풋노트 존재여부로 문제 완료 여부를 알 수 있음
+          if paragraph.footnote_paragraphs.length > 0
+            practice_number += 1
           end
         end
       end
 
-      def validate_paragraph(paragraph)
+      def validate_paragraph(paragraph, practice_number)
         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
+            element.validate.each do |error|
+              add_error(
+                make_error(
+                  title: error[:message],
+                  problem_number: practice_number,
+                  type: paragraph_style_name(paragraph),
+                  detail: error[:detail]
+                )
+              )
             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
+      def practice_style_id
+        @practice_style_id ||= @hml_document.styles.find {|style| style.name == PnoteClient::STYLES[:practice_question] }&.id
+      end
 
-        return invalids
+      def paragraph_style_name(paragraph)
+        return @hml_document.styles.find {|style| style.id == paragraph.style_id }&.name
       end
     end
   end

data/lib/pnote_client/validators/pnote_validator.rb

@@ -2,111 +2,55 @@
 #  Author: osh
 #  Created: 2019-05-20
 #  Last modified: 2019-05-20
+require 'pnote_client/validators/validator'
 
 module PnoteClient
   module Validators
-    class PnoteValidator
+    class PnoteValidator < Validator
       def initialize(pnote_document)
+        super()
         @pnote_document = pnote_document
-        @result = {
-          errors: [],
-          warnings: []
-        }
       end
 
       def validate
-        reset_result
+        reset_errors
         validate_pnote_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
+        return @errors
       end
 
       private
 
-      def reset_result
-        @result = {
-          errors: [],
-          warnings: []
-        }
-      end
-
       def validate_pnote_document
+        practice_number = 1
+
         @pnote_document.chapters.each do |chapter|
           chapter.sub_chapters.each do |sub_chapter|
             chapter.practices.each do |practice|
-              validation_result = validate_problem(practice)
-              add_result(validation_result)
-            end
-
-            sub_chapter.exercises.each do |exercise|
-              validation_result = validate_problem(exercise)
-              add_result(validation_result)
+              validate_problem(practice, practice_number)
+              practice_number += 1
             end
 
             sub_chapter.practices.each do |practice|
-              validation_result = validate_problem(practice)
-              add_result(validation_result)
+              validate_problem(practice, practice_number)
+              practice_number += 1
             end
           end
         end
       end
 
-      def validate_problem(problem)
+      def validate_problem(problem, practice_number)
         if problem.answer
-          if problem.answer.length > 255
-            return {
-              valid: false,
-              type: :error,
-              message: "문제 정답의 길이가 255자보다 큽니다.",
-              detail: "문제 질문: #{problem.question}\n문제 정답: #{problem.answer}"
-            }
-          end
-
           if problem.answer.length >= 15
-            return {
-              valid: false,
-              type: :warning,
-              message: "문제 정답의 길이가 15자 이상입니다.",
-              detail: "문제 질문: #{problem.question}\n문제 정답: #{problem.answer}"
-            }
+            add_error(
+              make_error(
+                title: "문제 정답의 길이가 15자 이상입니다.",
+                practice_number: practice_number,
+                type: "문제 정답",
+                detail: problem.answer
+              )
+            )
           end
         end
-
-        return {
-          valid: true,
-          type: :success
-        }
-      end
-
-      def add_result(validation_result)
-        return if validation_result[:valid]
-
-        if validation_result[:type] == :error
-          @result[:errors] << {
-            message: validation_result[:message],
-            detail: validation_result[:detail]
-          }
-        elsif validation_result[:type] == :warning
-          @result[:warnings] << {
-            message: validation_result[:message],
-            detail: validation_result[:detail]
-          }
-        end
       end
     end
   end

data/lib/pnote_client/validators/validator.rb

@@ -0,0 +1,39 @@
+#
+#  Author: osh
+#  Created: 2019-05-27
+#  Last modified: 2019-05-27
+
+
+module PnoteClient
+  module Validators
+    class Validator
+      def initialize
+        @errors = []
+      end
+
+      def has_error?
+        return error_count > 0
+      end
+
+      def error_count
+        return @errors.length
+      end
+
+      protected
+
+      def reset_errors
+        @errors = []
+      end
+
+      def add_error(error_msg)
+        @errors << error_msg
+      end
+
+      def make_error(title:, problem_number:, type:, detail: nil)
+        return "[에러 메시지] #{title}\n" + 
+          "[에러 위치] 문제 #{problem_number}번, 유형: (#{type})\n" +
+          "[상세 내용]\n#{detail}"
+      end
+    end
+  end
+end

data/lib/pnote_client/version.rb

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

data/lib/pnote_client.rb

@@ -1,4 +1,28 @@
 require "pnote_client/version"
 
 module PnoteClient
+  STYLES = {
+    chapter: "단원",
+    sub_chapter_title: "개념군",
+    concept_title: "개념",
+    concept_content: "개념 본문",
+    exercise_question: "예제 문제",
+    exercise_continuous_question: "예제(그림, 표, 박스, 글)",
+    exercise_answer: "예제 정답",
+    exercise_explaination: "예제 정답 해설",
+    practice_question: "문제",
+    practice_continuous_question: "문제(그림, 표, 박스, 글)",
+    practice_answer: "문제 정답",
+    practice_explaination: "문제 정답 해설",
+    practice_teacher_comment: [
+      "각주(선생님한테 과외받기)",
+      "코멘트1",
+      "코멘트2",
+      "코멘트3",
+      "코멘트4",
+      "코멘트5"
+    ],
+    choice: "보기",
+    tip_content: "꿀팁"
+  }
 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.4.0'
+  spec.add_dependency "hwp_script_to_latex", '~> 1.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnote_client
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - bluesh55
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.6.0
 description: 
 email:
 - bluesh55@naver.com
@@ -98,7 +98,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- config.json
 - exe/pnote_clean
 - exe/pnote_to_json
 - lib/pnote_client.rb
@@ -128,6 +127,7 @@ files:
 - lib/pnote_client/utils/string_util.rb
 - lib/pnote_client/validators/hml_validator.rb
 - lib/pnote_client/validators/pnote_validator.rb
+- lib/pnote_client/validators/validator.rb
 - lib/pnote_client/version.rb
 - pnote_client.gemspec
 homepage: https://github.com/PrivateCoach/pnote_client

data/config.json

@@ -1,26 +0,0 @@
-{
-  "hml_pnote_styles": {
-    "chapter": "단원",
-    "sub_chapter_title": "개념군",
-    "concept_title": "개념",
-    "concept_content": "개념 본문",
-    "exercise_question": "예제 문제",
-    "exercise_continuous_question": "예제(그림, 표, 박스, 글)",
-    "exercise_answer": "예제 정답",
-    "exercise_explaination": "예제 정답 해설",
-    "practice_question": "문제",
-    "practice_continuous_question": "문제(그림, 표, 박스, 글)",
-    "practice_answer": "문제 정답",
-    "practice_explaination": "문제 정답 해설",
-    "practice_teacher_comment": [
-      "각주(선생님한테 과외받기)",
-      "코멘트1",
-      "코멘트2",
-      "코멘트3",
-      "코멘트4",
-      "코멘트5"
-    ],
-    "choice": "보기",
-    "tip_content": "꿀팁"
-  }
-}