pnote_client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aefca9ca088bc2820cb547cc1440e8f16171f330
+  data.tar.gz: 7f906da6182fc767d86f66f609f2125154f1e873
+SHA512:
+  metadata.gz: 5206517055ab81f50e9dd8fd55c0b3b2a0ec884d92ba7503bdf5213a4ea6b038b9b85a7111bc7741c64c06463006efa2990666dd9e899e3e7776ce97533ddd25
+  data.tar.gz: 44fcad012662f3149139acc9134ddb415fa1f981921e6f4501e2394f08913495c44ceaaa1b96885e5d7a188274b1abbe4d19be588bdb2da5c90bf9b406a1b05f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+examples/
+.DS_Store
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pnote_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 bluesh55
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# PnoteClient
+
+아래아 한글으로 작성된 프라이빗 노트의 노트 파일(이하 pnote 파일)을 json포맷으로 변환하여 저장합니다.
+
+## Installation
+
+Bundler를 사용할 경우 Gemfile에 다음 줄을 추가합니다.
+
+```ruby
+gem 'pnote_client', git: 'git@github.com:PrivateCoach/pnote_client.git'
+```
+
+그리고 다음 명령을 실행합니다.
+
+    $ bundle
+
+혹은 다음 명령으로 직접 젬을 설치할 수 있습니다.
+
+```bash
+git clone git@github.com:PrivateCoach/pnote_client.git
+cd ./pnote_client
+gem build pnote_client.gemspec
+gem install pnote_client-[version].gem
+```
+
+## Usage
+
+### Pnote to JSON
+
+hml로 저장된 pnote 파일을 json 파일로 저장시키는 기능입니다.
+
+```bash
+$ pnote_to_json -f [input file(.hml)] -o [output file]
+```
+
+예를 들어 다음과 같이 사용할 수 있습니다.
+
+```bash
+$ pnote_to_json -f ./subject_1.hml -o ./subject_1.json
+```
+
+이 기능은 아래아 한글의 `스타일`을 사용하여 문단을 구분하기 때문에
+입력으로 주어진 pnote에서 사용된 스타일 정보가 필요합니다.
+기본으로 사용하는 스타일 정보는 다음과 같습니다.
+
+
+1. 단원
+2. 개념군
+3. 개념
+4. 개념 본문
+5. 예제 문제
+6. 예제(그림, 표, 박스, 글)
+7. 예제 정답
+8. 예제 정답 해설
+9. 문제
+10. 문제(그림, 표, 박스, 글)
+11. 문제 정답
+12. 문제 정답 해설
+13. 각주(선생님한테 과외받기)
+14. 보기
+15. 꿀팁
+
+설정 파일을 통해 스타일 정보를 수정할 수 있습니다.
+설정 파일은 json 포맷으로 작성되고, `-c` 옵션을 통해 지정할 수 있습니다.
+예를 들면 다음과 같습니다.
+
+```bash
+$ pnote_to_json -f [input] -o [output] -c ./config.json
+```
+
+`config.json` 파일의 예시는 다음과 같습니다. 키 값은 그대로 두고 스타일 문자열 부분만 변경하면 됩니다.
+
+```json
+{
+  "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": "각주(선생님한테 과외받기)",
+    "choice": "보기",
+    "tip_content": "꿀팁"
+  }
+}
+```
+
+## License
+
+[MIT License](http://opensource.org/licenses/MIT)
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pnote_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.json

@@ -0,0 +1,26 @@
+{
+  "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": "꿀팁"
+  }
+}

data/exe/pnote_to_json

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+## Private Note 파일(.hml)을 JSON 구조로 변환하여 Export 해줍니다.
+
+require 'json'
+require 'optparse'
+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'
+
+def read_file(filepath)
+  f = File.open(filepath, 'r')
+  content = f.read
+  f.close
+  return content
+end
+
+def write_file(content, filepath)
+  f = File.open(filepath, 'w')
+  f.write(content)
+  f.close
+end
+
+options = {
+  include_image_data: false
+}
+
+optparser = OptionParser.new do |opt|
+  opt.banner = 'Usage: pnote_to_json [options]'
+
+  opt.on('-f', '--file [FILEPATH]', String, 'Input file path(.hml)') do |filepath|
+    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
+
+  opt.on('-c', '--config [FILEPATH]', String, 'File path of configuration file(`config.json`). Default is `../config.json`') do |filepath|
+    options[:config_filepath]
+  end
+end
+optparser.parse!
+
+if options[:input_filepath].nil? || options[:output_filepath].nil?
+  abort(optparser.help)
+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 = 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.delegate = display
+pnote_document = hml_to_pnote_converter.convert
+json = PnoteClient::Converters::PnoteToJsonConverter.new(pnote_document, include_image_data: options[:include_image_data]).convert
+write_file(json, options[:output_filepath])

data/lib/pnote_client/converters/hml_to_pnote_converter.rb

@@ -0,0 +1,195 @@
+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/image'
+require 'pnote_client/documents/pnote/teacher_comment'
+require 'pnote_client/documents/hml/paragraph_reader'
+
+module PnoteClient
+  module Converters
+    class HmlToPnoteConverter
+
+      attr_accessor :delegate
+
+      def initialize(hml_document, type_style_mapper = {})
+        @hml_document = hml_document
+        @type_style_mapper = type_style_mapper
+
+        @current_chapter = nil
+        @current_sub_chapter = nil
+        @current_concept = nil
+        @current_exercise = nil
+        @current_practice = nil
+        @practice_continuous = false
+        @current_problem = nil
+        @current_teacher_comment = nil
+        @delegate = nil
+      end
+
+      def convert
+        pnote_document = Documents::Pnote.new
+
+        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|
+          case paragraph_type(paragraph)
+          when :chapter # 구분점
+            new_chapter = Documents::Pnote::Chapter.new
+            new_chapter.set_title(paragraph.content)
+            add_new_chapter_to_pnote(pnote_document, new_chapter)
+          when :sub_chapter_title # 구분점
+            new_sub_chapter = Documents::Pnote::SubChapter.new
+            new_sub_chapter.set_title(paragraph.content)
+            add_new_sub_chapter_to_chapter(@current_chapter, new_sub_chapter) if @current_chapter
+          when :concept_title # 구분점
+            new_concept = Documents::Pnote::Concept.new
+            new_concept.set_title(paragraph.content)
+            add_new_concept_to_sub_chapter(@current_sub_chapter, new_concept) if @current_sub_chapter
+          when :concept_content
+            @current_concept.add_content(paragraph.content) if @current_concept
+          when :exercise_question # 구분점
+            if is_continuous
+              @current_exercise.add_question_line(paragraph.content) if @current_exercise
+            else
+              new_exercise = Documents::Pnote::Exercise.new
+              new_exercise.question = paragraph.content
+              add_new_exercise_to_sub_chapter(@current_sub_chapter, new_exercise) if @current_sub_chapter
+            end
+          when :exercise_continuous_question
+            @current_exercise.add_question_line(paragraph.content) if @current_exercise
+          when :exercise_answer
+            @current_exercise.add_answer_line(paragraph.content) if @current_exercise
+          when :exercise_explaination
+            @current_exercise.add_explaination_line(paragraph.content) if @current_exercise
+          when :practice_question # 구분점
+            if @practice_continuous
+              @current_practice.add_question_line(paragraph.content) if @current_practice
+            else
+              new_practice = Documents::Pnote::Practice.new
+              new_practice.question = paragraph.content
+
+              if @current_sub_chapter
+                # 실전문제를 소단원에 추가
+                add_new_practice_to_sub_chapter(@current_sub_chapter, new_practice) if @current_sub_chapter
+              elsif @current_chapter
+                # 소단원이 없다면 실전문제를 단원에 추가(심화문제)
+                add_new_practice_to_chapter(@current_chapter, new_practice) if @current_chapter
+              end
+            end
+
+            # 답변(미주)
+            endnote_paragraph_reader = Documents::Hml::ParagraphReader.new(paragraph.endnote_paragraphs)
+            endnote_paragraph_reader.next_paragraph do |endnote_paragraph, prev_endnote_paragraph, is_continuous|
+              case paragraph_type(endnote_paragraph)
+              when :practice_answer
+                @current_practice.add_answer_line(endnote_paragraph.content) if @current_practice
+              when :practice_explaination
+                @current_practice.add_explaination_line(endnote_paragraph.content) if @current_practice
+              when :tip_content
+                @current_practice.add_tip_line(endnote_paragraph.content) if @current_practice
+              end
+            end
+
+            # 과외노트(각주)
+            footnote_paragraph_reader = Documents::Hml::ParagraphReader.new(paragraph.footnote_paragraphs)
+            footnote_paragraph_reader.next_paragraph do |footnote_paragraph, prev_footnote_paragraph, is_continuous, index|
+              case paragraph_type(footnote_paragraph)
+              when :practice_teacher_comment
+                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.content = footnote_paragraph.content
+                  add_new_teacher_comment_to_practice(@current_practice, new_teacher_comment) if @current_practice
+                end
+              end
+            end
+
+            @practice_continuous = paragraph.footnote_paragraphs.size == 0 # 각주가 없다면 다음 paragraph도 같은 문제로 인식
+          when :practice_continuous_question
+            @current_practice.add_question_line(paragraph.content) if @current_practice
+          when :choice
+            @current_problem.add_choice_line(paragraph.content) if @current_problem
+          end
+
+          @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|
+          pnote_document.add_image(Documents::Pnote::Image.new(bin_item.id, bin_item.format, bin_item.size, bin_item.raw_data))
+
+          @delegate.binary_converted(count: binary_count, current: index) if @delegate
+        end
+
+        return pnote_document
+      end
+
+      private
+
+      def add_new_chapter_to_pnote(pnote_document, new_chapter)
+        pnote_document.add_chapter(new_chapter)
+        @current_chapter = new_chapter
+        @current_sub_chapter = nil
+        @current_concept = nil
+        @current_exercise = nil
+        @current_practice = nil
+        @current_problem = nil
+        @current_teacher_comment = nil
+      end
+
+      def add_new_sub_chapter_to_chapter(chapter, new_sub_chapter)
+        chapter.add_sub_chapter(new_sub_chapter)
+        @current_sub_chapter = new_sub_chapter
+        @current_concept = nil
+        @current_exercise = nil
+        @current_practice = nil
+        @current_problem = nil
+        @current_teacher_comment = nil
+      end
+
+      def add_new_concept_to_sub_chapter(sub_chapter, new_concept)
+        sub_chapter.add_concept(new_concept)
+        @current_concept = new_concept
+      end
+
+      def add_new_exercise_to_sub_chapter(sub_chapter, new_exercise)
+        sub_chapter.add_exercise(new_exercise)
+        @current_exercise = new_exercise
+        @current_problem = new_exercise
+      end
+
+      def add_new_practice_to_sub_chapter(sub_chapter, new_practice)
+        sub_chapter.add_practice(new_practice)
+        @current_practice = new_practice
+        @current_problem = new_practice
+      end
+
+      def add_new_practice_to_chapter(chapter, new_practice)
+        chapter.add_practice(new_practice)
+        @current_practice = new_practice
+        @current_problem = new_practice
+      end
+
+      def add_new_teacher_comment_to_practice(practice, new_teacher_comment)
+        practice.add_teacher_comment(new_teacher_comment)
+        @current_teacher_comment = new_teacher_comment
+      end
+
+      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))}
+        return nil if result.nil?
+        return result[0]
+      end
+
+      def find_style(style_id)
+        return @hml_document.styles.find {|style| style.id == style_id}
+      end
+    end
+  end
+end

data/lib/pnote_client/converters/pnote_to_json_converter.rb

@@ -0,0 +1,96 @@
+require 'json'
+
+module PnoteClient
+  module Converters
+    class PnoteToJsonConverter
+
+      def initialize(pnote_document, include_image_data: false)
+        @pnote_document = pnote_document
+        @include_image_data = include_image_data
+      end
+
+      def convert
+        result = {
+          chapters: [],
+          images: [],
+          created_at: Time.now.strftime("%Y-%m-%d %H:%M")
+        }
+
+        @pnote_document.images.each do |image|
+          result[:images] << {
+            id: image.id,
+            format: image.format,
+            size: image.size,
+            raw_data: @include_image_data ? image.raw_data : nil
+          }
+        end
+
+        @pnote_document.chapters.each do |chapter|
+          chapter_hash = {
+            title: chapter.title,
+            sub_chapters: [],
+            practices: []
+          }
+          result[:chapters] << chapter_hash
+
+          # 단원의 소단원 목록
+          chapter.sub_chapters.each do |sub_chapter|
+            sub_chapter_hash = {
+              title: sub_chapter.title,
+              concepts: [],
+              exercises: [],
+              practices: []
+            }
+            chapter_hash[:sub_chapters] << sub_chapter_hash
+
+            sub_chapter.concepts.each do |concept|
+              concept_hash = {
+                title: concept.title,
+                content: concept.content
+              }
+
+              sub_chapter_hash[:concepts] << concept_hash
+            end
+
+            sub_chapter.exercises.each do |exercise|
+              exercise_hash = {
+                question: exercise.question,
+                answer: exercise.answer,
+                explaination: exercise.explaination,
+                choices: exercise.choices
+              }
+              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
+              }
+              sub_chapter_hash[:practices] << practice_hash
+            end
+          end
+
+          # 단원의 실전 문제
+          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
+            }
+            chapter_hash[:practices] << practice_hash
+          end
+        end
+
+        return result.to_json
+      end
+    end
+  end
+end

data/lib/pnote_client/display/console_display.rb

@@ -0,0 +1,37 @@
+module PnoteClient
+  class ConsoleDisplay
+    # implement HmlToPnoteConverter Delegate
+    # implement PnoteClient Delegate
+
+    def initialize
+    end
+
+    def paragraph_converted(count:, current:)
+      print_progress(count, current, "Converting paragraphs")
+
+      # Print newline when task is done
+      if count == (current + 1)
+        printf("\n")
+      end
+    end
+
+    def binary_converted(count:, current:)
+      print_progress(count, current, "Converting binaries")
+
+      # Print newline when task is done
+      if count == (current + 1)
+        printf("\n")
+      end
+    end
+
+    private
+
+    def print_progress(count, current, title)
+      printf("\r[#{title}] #{current + 1}/#{count} [%-20s]", "=" * (percentage(count, current + 1) / 5) + ">")
+    end
+
+    def percentage(count, current)
+      return ((100.0 / count) * current)
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module PnoteClient
+  module Documents
+    class Hml
+      class BinaryItem
+        attr_reader :id, :raw_data, :format, :size
+
+        def initialize(bin_item_tag, doc)
+          bin_data_id = bin_item_tag['BinData']
+          bin_item = doc.at_xpath("//BINITEM[@BinData=#{bin_data_id}]")
+          bin_data = doc.at_xpath("//BINDATA[@Id=#{bin_data_id}]")
+
+          @id = bin_data_id
+          @raw_data = bin_data.content
+          @format = bin_item['Format']
+          @size = bin_data['Size'].to_i
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module PnoteClient
+  module Documents
+    class Hml
+      class Char
+        # Textable Element
+
+        def self.from_tag(char_tag)
+          return self.new(char_tag.content)
+        end
+
+        attr_reader :text
+
+        def initialize(text)
+          @text = text
+        end
+
+        def content
+          return @text
+        end
+
+        def textable?
+          return true
+        end
+      end
+    end
+  end
+end