pnote_client 1.2.3 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51962b2b01db21b479a44a054f80d1b7de0eb4041a5696d982f3cf252659a38f
-  data.tar.gz: 4a621d7b873d913b31747aaa1066d5317d597ea0e1dc2c932afcb2bd46d6b5f9
+  metadata.gz: 6768e747c37505e8606dd774b8ff50bed95eaa2c76673aa6ab26ad39a640f7f5
+  data.tar.gz: 87eee8422ea2646fbe047558f4839915c5128258a87fd5c4ab305db9fa51d516
 SHA512:
-  metadata.gz: 2cf225c6e104c0ea88ca8640f4056ed27d3fb2a1050582c9ba3a3eb104dd2bf9e29e6c775348fd0368d260c5bbdb0fbe20a3999e5daef3cf31c549d2f5092f21
-  data.tar.gz: 8c1f886afdd86384f60429c6b6dccae923d23b467a593345e89598dcc0e3047743f1b39070445d04677aef52c49acfac728854a6e210ed5dda5f44ed8076602a
+  metadata.gz: d6cede281e8d80463854ee8beb831b675b262de076393ec39458c21d053f8fbe2e66c323cd1858ba25888d77a7bca9c6709f671d3558ac0d772d54048e9163ee
+  data.tar.gz: 30a5fe6cc5bdda30450e4dbd94c3641c6d93847de1d871491a8a7c6ef0bcc58d3a6fc4ceb2308036857c5a36756e985baea7eae8954dc4fce702c7896bb12eea

data/exe/pnote_to_json

@@ -3,6 +3,7 @@
 
 require 'json'
 require 'optparse'
+require 'pnote_client'
 require 'pnote_client/converters/hml_to_pnote_converter'
 require 'pnote_client/converters/pnote_to_json_converter'
 require 'pnote_client/documents/hml'
@@ -22,7 +23,9 @@ def write_file(content, filepath)
 end
 
 options = {
-  include_image_data: false
+  config_filepath: File.join(File.dirname(__FILE__), '..', 'config.json'),
+  include_image_data: false,
+  show_time: 600
 }
 
 optparser = OptionParser.new do |opt|
@@ -43,6 +46,10 @@ optparser = OptionParser.new do |opt|
   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
 end
 optparser.parse!
 
@@ -50,15 +57,34 @@ if options[:input_filepath].nil? || options[:output_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]}초
+
+계속 진행하시겠습니까? (y/n)
+NOTICE
+puts notice
+response = gets.chomp.downcase
+
+if response != 'y'
+  abort
+end
+
 display = PnoteClient::ConsoleDisplay.new
-default_config_file_path = File.join(File.dirname(__FILE__), '..', 'config.json')
-config_content = read_file(options[:config_filepath] || default_config_file_path)
+config_content = read_file(options[:config_filepath])
 config = JSON.parse(config_content, symbolize_names: true)
 type_style_mapper = config[:hml_pnote_styles]
 
 hml_document = PnoteClient::Documents::Hml.parse_from_file(options[:input_filepath])
-hml_to_pnote_converter = PnoteClient::Converters::HmlToPnoteConverter.new(hml_document, type_style_mapper)
+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
-json = PnoteClient::Converters::PnoteToJsonConverter.new(pnote_document, include_image_data: options[:include_image_data]).convert
+json = PnoteClient::Converters::PnoteToJsonConverter.new(pnote_document).convert
 write_file(json, options[:output_filepath])

data/lib/pnote_client/converters/hml_to_pnote_converter.rb

@@ -2,8 +2,7 @@ require 'pnote_client/documents/pnote'
 require 'pnote_client/documents/pnote/chapter'
 require 'pnote_client/documents/pnote/sub_chapter'
 require 'pnote_client/documents/pnote/concept'
-require 'pnote_client/documents/pnote/exercise'
-require 'pnote_client/documents/pnote/practice'
+require 'pnote_client/documents/pnote/problem'
 require 'pnote_client/documents/pnote/image'
 require 'pnote_client/documents/pnote/teacher_comment'
 require 'pnote_client/documents/hml/paragraph_reader'
@@ -14,9 +13,11 @@ module PnoteClient
 
       attr_accessor :delegate
 
-      def initialize(hml_document, type_style_mapper = {})
+      def initialize(hml_document, show_time:, type_style_mapper: {}, 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
         @current_sub_chapter = nil
@@ -54,7 +55,7 @@ module PnoteClient
             if is_continuous
               @current_exercise.add_question_line(paragraph.content) if @current_exercise
             else
-              new_exercise = Documents::Pnote::Exercise.new
+              new_exercise = Documents::Pnote::Problem.new
               new_exercise.question = paragraph.content
               add_new_exercise_to_sub_chapter(@current_sub_chapter, new_exercise) if @current_sub_chapter
             end
@@ -68,7 +69,7 @@ module PnoteClient
             if @practice_continuous
               @current_practice.add_question_line(paragraph.content) if @current_practice
             else
-              new_practice = Documents::Pnote::Practice.new
+              new_practice = Documents::Pnote::Problem.new
               new_practice.question = paragraph.content
 
               if @current_sub_chapter
@@ -101,7 +102,7 @@ module PnoteClient
                 if is_continuous
                   @current_teacher_comment.add_content_line(footnote_paragraph.content) if @current_teacher_comment
                 else
-                  new_teacher_comment = Documents::Pnote::TeacherComment.new(index)
+                  new_teacher_comment = Documents::Pnote::TeacherComment.new(show_time: (index + 1) * @show_time)
                   new_teacher_comment.content = footnote_paragraph.content
                   add_new_teacher_comment_to_practice(@current_practice, new_teacher_comment) if @current_practice
                 end
@@ -121,7 +122,10 @@ module PnoteClient
 
         binary_count = @hml_document.bin_items.length
         @hml_document.bin_items.each_with_index do |bin_item, index|
-          pnote_document.add_image(Documents::Pnote::Image.new(bin_item.id, bin_item.format, bin_item.size, bin_item.raw_data))
+          raw_data = @include_image_data ? bin_item.raw_data : nil
+          pnote_document.add_image(
+            Documents::Pnote::Image.new(bin_item.id, bin_item.format, bin_item.size, raw_data)
+          )
 
           @delegate.binary_converted(count: binary_count, current: index) if @delegate
         end

data/lib/pnote_client/converters/pnote_to_json_converter.rb

@@ -1,16 +1,17 @@
 require 'json'
+require 'pnote_client'
 
 module PnoteClient
   module Converters
     class PnoteToJsonConverter
 
-      def initialize(pnote_document, include_image_data: false)
+      def initialize(pnote_document)
         @pnote_document = pnote_document
-        @include_image_data = include_image_data
       end
 
       def convert
         result = {
+          pnote_client_version: PnoteClient::VERSION,
           chapters: [],
           images: [],
           created_at: Time.now.strftime("%Y-%m-%d %H:%M")
@@ -21,7 +22,7 @@ module PnoteClient
             id: image.id,
             format: image.format,
             size: image.size,
-            raw_data: @include_image_data ? image.raw_data : nil
+            raw_data: image.raw_data
           }
         end
 
@@ -42,14 +43,7 @@ module PnoteClient
 
             # 심화단원의 실전 문제
             chapter.practices.each do |practice|
-              practice_hash = {
-                question: practice.question,
-                answer: practice.answer,
-                explaination: practice.explaination,
-                teacher_comments: practice.teacher_comments.sort_by {|tc| tc.index }.map(&:content),
-                choices: practice.choices,
-                tip: practice.tip
-              }
+              practice_hash = get_problem_hash(practice)
               sub_chapter_hash[:practices] << practice_hash
             end
           else # 일반 단원일경우 소단원 채우기
@@ -72,24 +66,12 @@ module PnoteClient
               end
 
               sub_chapter.exercises.each do |exercise|
-                exercise_hash = {
-                  question: exercise.question,
-                  answer: exercise.answer,
-                  explaination: exercise.explaination,
-                  choices: exercise.choices
-                }
+                exercise_hash = get_problem_hash(exercise)
                 sub_chapter_hash[:exercises] << exercise_hash
               end
 
               sub_chapter.practices.each do |practice|
-                practice_hash = {
-                  question: practice.question,
-                  answer: practice.answer,
-                  explaination: practice.explaination,
-                  teacher_comments: practice.teacher_comments.sort_by {|tc| tc.index }.map(&:content),
-                  choices: practice.choices,
-                  tip: practice.tip
-                }
+                practice_hash = get_problem_hash(practice)
                 sub_chapter_hash[:practices] << practice_hash
               end
             end
@@ -98,6 +80,24 @@ module PnoteClient
 
         return result.to_json
       end
+
+      private
+
+      def get_problem_hash(problem)
+        {
+          question: problem.question,
+          answer: problem.answer,
+          explaination: problem.explaination,
+          teacher_comments: problem.teacher_comments.sort_by {|tc| tc.show_time }.map do |tc|
+            {
+              show_time: tc.show_time,
+              content: tc.content
+            }
+          end,
+          choices: problem.choices,
+          tip: problem.tip
+        }
+      end
     end
   end
 end

data/lib/pnote_client/documents/pnote/chapter.rb

@@ -4,8 +4,8 @@ module PnoteClient
       class Chapter
         attr_reader :title, :sub_chapters, :practices
 
-        def initialize
-          @title = nil
+        def initialize(title: nil)
+          @title = title
           @sub_chapters = []
           @practices = []
         end

data/lib/pnote_client/documents/pnote/concept.rb

@@ -8,7 +8,7 @@ module PnoteClient
 
         attr_reader :title, :content
 
-        def initialize
+        def initialize(title: nil, content: nil)
           @title = nil
           @content = nil
         end

data/lib/pnote_client/documents/pnote/problem.rb

@@ -3,18 +3,19 @@ require 'pnote_client/utils/string_util'
 module PnoteClient
   module Documents
     class Pnote
-      # 연습문제(Exercise)와 실전문제(Practice)의 부모 클래스
-      # 중복되는 부분을 재사용하기위해 만듦
       class Problem
         include Utils::StringUtil
 
         attr_accessor :question, :explaination
+        attr_accessor :teacher_comments, :tip
 
-        def initialize
-          @question = nil
-          @answer = nil
-          @explaination = nil
-          @choice = nil
+        def initialize(
+          question: nil, answer: nil, explaination: nil,
+          choices: nil, choice: nil, teacher_comments: [], tip: nil
+        )
+
+          @question, @answer, @explaination, @choices, @choice, @teacher_comments, @tip =
+            question, answer, explaination, choices, choice, teacher_comments, tip
         end
 
         def add_question_line(new_line)
@@ -39,11 +40,20 @@ module PnoteClient
         end
 
         def choices
+          return @choices if @choices
           return [] if @choice.nil?
 
           choice_number_pattern = /①|②|③|④|⑤/
           return @choice.split(choice_number_pattern).reject {|el| el.empty?}.map {|el| el.strip}
         end
+
+        def add_teacher_comment(new_teacher_comment)
+          @teacher_comments << new_teacher_comment
+        end
+
+        def add_tip_line(new_line)
+          @tip = add_line(@tip, new_line)
+        end
       end
     end
   end

data/lib/pnote_client/documents/pnote/sub_chapter.rb

@@ -4,8 +4,8 @@ module PnoteClient
       class SubChapter
         attr_reader :title, :concepts, :exercises, :practices
 
-        def initialize
-          @title = nil
+        def initialize(title: nil)
+          @title = title
           @concepts = []
           @exercises = []
           @practices = []

data/lib/pnote_client/documents/pnote/teacher_comment.rb

@@ -6,11 +6,11 @@ module PnoteClient
       class TeacherComment
         include Utils::StringUtil
 
-        attr_accessor :index, :content
+        attr_accessor :content, :show_time
 
-        def initialize(index)
-          @index = index
-          @content = nil
+        def initialize(content: nil, show_time: 0)
+          @show_time = show_time
+          @content = content
         end
 
         def add_content_line(new_line)

data/lib/pnote_client/version.rb

@@ -1,3 +1,3 @@
 module PnoteClient
-  VERSION = "1.2.3"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnote_client
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 2.1.1
 platform: ruby
 authors:
 - bluesh55
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,9 +118,7 @@ files:
 - lib/pnote_client/documents/pnote.rb
 - lib/pnote_client/documents/pnote/chapter.rb
 - lib/pnote_client/documents/pnote/concept.rb
-- lib/pnote_client/documents/pnote/exercise.rb
 - lib/pnote_client/documents/pnote/image.rb
-- lib/pnote_client/documents/pnote/practice.rb
 - lib/pnote_client/documents/pnote/problem.rb
 - lib/pnote_client/documents/pnote/sub_chapter.rb
 - lib/pnote_client/documents/pnote/teacher_comment.rb

data/lib/pnote_client/documents/pnote/exercise.rb

@@ -1,10 +0,0 @@
-require 'pnote_client/documents/pnote/problem'
-
-module PnoteClient
-  module Documents
-    class Pnote
-      class Exercise < Problem
-      end
-    end
-  end
-end

data/lib/pnote_client/documents/pnote/practice.rb

@@ -1,25 +0,0 @@
-require 'pnote_client/documents/pnote/problem'
-
-module PnoteClient
-  module Documents
-    class Pnote
-      class Practice < Problem
-        attr_accessor :teacher_comments, :tip
-
-        def initialize
-          super
-          @teacher_comments = []
-          @tip = nil
-        end
-
-        def add_teacher_comment(new_teacher_comment)
-          @teacher_comments << new_teacher_comment
-        end
-
-        def add_tip_line(new_line)
-          @tip = add_line(@tip, new_line)
-        end
-      end
-    end
-  end
-end