pnote_client 2.2.5 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60c919494ece6eb84dca42ee0ba300980294f031d403682dc250c369397b12ec
-  data.tar.gz: e6e5f9786206a3c65136089529878a976df0180e83873c19db55590b8bac164e
+  metadata.gz: 5f55161957eb41b02e736937e17854bb20f353f5d67296aac4c3d71ba720462b
+  data.tar.gz: '05397c7bfa6567dbde1ba88d5cb086143be08a590a9f79f8bf0dc4410d9089d4'
 SHA512:
-  metadata.gz: 0de7f247dddb1ffb5f0267354fba0543c5a347c99827cac16f2cfa659f0222c50e5e4cbc897849d5b8c6e367d568de35e4e1dda86b5bd53e273b56ca7c4ee7da
-  data.tar.gz: 74caa57768f34f3e00248908de7e35271685412696a341859e47bfb5725ad828617b946ff165ca4979b970b68a887335e3a78dcc04fb869005ba35762a9e7321
+  metadata.gz: c714b9c5cf37cd7dd00a75c97154a8ba1ccfdc46d1bba1e85e7f651abe3f329910ff07bcc9d2dab5abe0b7dc39996b2cf48137dfa55c41f1d71cd4a6e28b8f78
+  data.tar.gz: 18198bc923ee330a8289ba21a79f238ac6b844ecb695f540fc666f0b03c517f5705d25b28dfa323769b8cf96971366a22ac09654440d1a7c9668b223c88c36d2

data/exe/pnote_clean

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+## Private Note 파일(.hml)에서 필요없는 텍스트들을 삭제시켜줍니다.
+require 'optparse'
+require 'fileutils'
+
+def read_file(filepath)
+  f = File.open(filepath, 'r')
+  dir_path = File.expand_path(File.dirname(f))
+  filename = File.basename(f, File.extname(f))
+  content = f.read
+  f.close
+  return filename, dir_path, content
+end
+
+def write_file(content, filepath)
+  f = File.open(filepath, 'w')
+  f.write(content)
+  f.close
+end
+
+options = {}
+optparser = OptionParser.new do |opt|
+  opt.banner = 'Usage: pnote_clean [options]'
+
+  opt.on('-f', '--file [FILEPATH]', String, 'Input file path(.hml)') do |filepath|
+    options[:input_filepath] = filepath
+  end
+end
+optparser.parse!
+
+if options[:input_filepath].nil?
+  abort(optparser.help)
+end
+
+filename, input_dir_path, hml_content = read_file(options[:input_filepath])
+output_dirpath = File.join(input_dir_path, "pnote_clean", "#{filename}_output")
+FileUtils.mkdir_p(output_dirpath)
+output_filepath = File.join(output_dirpath, "#{filename}.hml")
+
+junk_regex = %r(from\s*=+(?:족보닷컴.*?)=+)
+clean_content = hml_content.gsub(junk_regex, '')
+write_file(clean_content, output_filepath)
+
+before_bytes = hml_content.length
+before_kb = (before_bytes / 1024.0).round(2)
+before_mb = (before_bytes / 1024.0 / 1024.0).round(2)
+
+after_bytes = clean_content.length
+after_kb = (after_bytes / 1024.0).round(2)
+after_mb = (after_bytes / 1024.0 / 1024.0).round(2)
+
+puts "Before Size: #{before_bytes} bytes, #{before_kb} kb, #{before_mb} mb"
+puts "After Size: #{clean_content.length} bytes, #{after_kb} kb, #{after_mb} mb"
+puts "Done\n"

data/exe/pnote_to_json

@@ -8,12 +8,15 @@ require 'pnote_client/converters/hml_to_pnote_converter'
 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'
 
 def read_file(filepath)
   f = File.open(filepath, 'r')
+  dir_path = File.expand_path(File.dirname(f))
+  filename = File.basename(f, File.extname(f))
   content = f.read
   f.close
-  return content
+  return filename, dir_path, content
 end
 
 def write_file(content, filepath)
@@ -22,6 +25,25 @@ def write_file(content, filepath)
   f.close
 end
 
+def save_validation_log_file(result, log_filepath)
+  log_content = ""
+  log_content += "==========[Warnings]=========="
+  log_content += "\n"
+  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|
+    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로 옵션 입력받기
 options = {
   config_filepath: File.join(File.dirname(__FILE__), '..', 'config.json'),
   include_image_data: false,
@@ -35,10 +57,6 @@ optparser = OptionParser.new do |opt|
     options[:input_filepath] = filepath
   end
 
-  opt.on('-o', '--output [FILEPATH]', String, 'Output file path') do |filepath|
-    options[:output_filepath] = filepath
-  end
-
   opt.on('--[no-]image', 'Include image raw data (Default: false)') do |flag|
     options[:include_image_data] = flag
   end
@@ -53,17 +71,17 @@ optparser = OptionParser.new do |opt|
 end
 optparser.parse!
 
-if options[:input_filepath].nil? || options[:output_filepath].nil?
+if options[:input_filepath].nil?
   abort(optparser.help)
 end
 
+# 입력된 옵션 값 확인받기
 notice = <<-NOTICE
 [PnoteClient Version]
 #{PnoteClient::VERSION}
 
 [변환설정]
 입력파일 경로: #{options[:input_filepath]}
-출력파일 경로: #{options[:output_filepath]}
 이미지: #{options[:include_image_data] ? '포함' : '제외'}
 설정파일 경로: #{options[:config_filepath]}
 코멘트 노출시간 단위: #{options[:show_time]}초
@@ -77,14 +95,37 @@ if response != 'y'
   abort
 end
 
+# 변환 준비 작업
 display = PnoteClient::ConsoleDisplay.new
-config_content = read_file(options[:config_filepath])
+_, _, 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")
 
-hml_document = PnoteClient::Documents::Hml.parse_from_file(options[:input_filepath])
+# 파일 읽어들인 뒤 PnoteDocument로 변환
+hml_document = PnoteClient::Documents::Hml.parse(hml_content)
 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
+
+# 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
+
+# PnoteDocument를 JSON 파일로 저장
 json = PnoteClient::Converters::PnoteToJsonConverter.new(pnote_document).convert
-write_file(json, options[:output_filepath])
+write_file(json, output_filepath)

data/lib/pnote_client/converters/hml_to_pnote_converter.rb

@@ -33,6 +33,7 @@ module PnoteClient
       def convert
         pnote_document = Documents::Pnote.new
 
+        # 한 문단(Paragraph)씩 변환
         paragraph_length = @hml_document.paragraphs.length
         paragraph_reader = Documents::Hml::ParagraphReader.new(@hml_document.paragraphs)
         paragraph_reader.next_paragraph do |paragraph, prev_paragraph, is_continuous, index|
@@ -119,7 +120,7 @@ module PnoteClient
           @delegate.paragraph_converted(count: paragraph_length, current: index) if @delegate
         end
 
-
+        # 바이너리(이미지) 변환
         binary_count = @hml_document.bin_items.length
         @hml_document.bin_items.each_with_index do |bin_item, index|
           raw_data = @include_image_data ? bin_item.raw_data : nil

data/lib/pnote_client/display/console_display.rb

@@ -6,8 +6,12 @@ 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, "Converting paragraphs")
+      print_progress(count, current, "문단 변환 중")
 
       # Print newline when task is done
       if count == (current + 1)
@@ -16,7 +20,7 @@ module PnoteClient
     end
 
     def binary_converted(count:, current:)
-      print_progress(count, current, "Converting binaries")
+      print_progress(count, current, "바이너리 파일 변환 중")
 
       # Print newline when task is done
       if count == (current + 1)

data/lib/pnote_client/documents/hml.rb

@@ -10,14 +10,6 @@ module PnoteClient
     class Hml
       attr_reader :styles, :paragraphs, :bin_items
 
-      def self.parse_from_file(file_path)
-        file = File.open(file_path)
-        hml_content = file.read
-        file.close
-
-        return self.parse(hml_content)
-      end
-
       def self.parse(hml_content)
         styles = []
         paragraphs = []

data/lib/pnote_client/validators/pnote_validator.rb

@@ -0,0 +1,119 @@
+#
+#  Author: osh
+#  Created: 2019-05-20
+#  Last modified: 2019-05-20
+
+module PnoteClient
+  module Validators
+    class PnoteValidator
+      def initialize(pnote_document, display = nil)
+        @pnote_document = pnote_document
+        @display = display
+        @result = {
+          errors: [],
+          warnings: []
+        }
+      end
+
+      def validate
+        reset_result
+        validate_pnote_document
+        print_validation_result
+        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_pnote_document
+        @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)
+            end
+
+            sub_chapter.practices.each do |practice|
+              validation_result = validate_problem(practice)
+              add_result(validation_result)
+            end
+          end
+        end
+      end
+
+      def validate_problem(problem)
+        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 >= 20
+            return {
+              valid: false,
+              type: :warning,
+              message: "문제 정답의 길이가 20자 이상입니다.",
+              detail: "문제 질문: #{problem.question}\n문제 정답: #{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
+
+      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.2.5"
+  VERSION = "2.3.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.0.4'
+  spec.add_dependency "hwp_script_to_latex", '~> 1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnote_client
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.3.0
 platform: ruby
 authors:
 - bluesh55
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,18 +72,19 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.1.0
 description: 
 email:
 - bluesh55@naver.com
 executables:
+- pnote_clean
 - pnote_to_json
 extensions: []
 extra_rdoc_files: []
@@ -98,6 +99,7 @@ files:
 - bin/console
 - bin/setup
 - config.json
+- exe/pnote_clean
 - exe/pnote_to_json
 - lib/pnote_client.rb
 - lib/pnote_client/converters/hml_to_pnote_converter.rb
@@ -124,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/pnote_validator.rb
 - lib/pnote_client/version.rb
 - pnote_client.gemspec
 homepage: https://github.com/PrivateCoach/pnote_client