hwayo 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b649626b8aa64f7e09efcca03cbc6aaf09564fa7fedd669603f58df2cd2255e
-  data.tar.gz: d3390414f88e33b5c25d0219d9cc41a9b12674b3d52f180a225bd9eb4768364e
+  metadata.gz: 56b0f33f4688b679d29dd4624f08eb5878756a7b63d6ce2ddaaa3f5a6e3ede68
+  data.tar.gz: 25301f388cc45b11e106b6b9d232949b9b500020cc060c58efb380203bb6b18e
 SHA512:
-  metadata.gz: 83f850bf7491f9c6d0caf3b0ede1720d82b6c9c7e8644b0b2d4735622b343e07036f980eaefd115bda21a374ac8d93533efb1773c38e042226ee2b7b8a307d4b
-  data.tar.gz: 20916130d516ddd212721212ae518851b92efba543868bf49b0006c76d4ebf531b9f23493be6f262d98b74d0c06ef54d6d81b3bcf7054f9e9465329428b0fe9b
+  metadata.gz: b9f5179e4859fe79df367eb296ec721b4aa7ec37cb4ee0f165b1b44fd6cc6c0ac6538086f03e86ca4e8c1a8116461e269f2ca8e4606ba303d41c8b7ad23acf21
+  data.tar.gz: ce6ed80928e916998043dc0b213107fd36c07e0ead01338353a9e2ea1325bddd5c6af890c81a947ed3882d493d825f8e507825a5802cbc4609c3e62ef840a582

data/README.md

@@ -1,10 +1,27 @@
 # Hwayo
 
-Hwayo는 한글(HWP) 파일에서 텍스트를 추출하는 Ruby gem입니다. Java 기반의 hwplib 라이브러리를 Ruby에서 사용할 수 있도록 래핑하였습니다.
+[![Gem Version](https://badge.fury.io/rb/hwayo.svg)](https://badge.fury.io/rb/hwayo)
+
+Hwayo는 한글(HWP) 및 PDF 파일에서 텍스트를 추출하는 Ruby gem입니다. Java 기반의 [hwplib](https://github.com/neolord0/hwplib)와 [Apache PDFBox](https://pdfbox.apache.org/) 라이브러리를 Ruby에서 쉽게 사용할 수 있도록 래핑하였습니다.
+
+## 특징
+
+- 한글(HWP) 파일에서 텍스트 추출
+- PDF 파일에서 텍스트 추출 (Apache PDFBox 3.0.5 사용)
+- 표, 그림 설명 등 컨트롤 텍스트 포함 추출
+- 간단한 Ruby 인터페이스
+- 파일 저장 또는 문자열 반환 선택 가능
+
+## 요구사항
+
+- Ruby 2.7.0 이상
+- Java 8 이상 설치 필요
+- hwplib JAR 파일 (자동 포함 또는 별도 다운로드)
+- PDFBox JAR 파일 (자동 포함)
 
 ## 설치
 
-Gemfile에 다음을 추가하세요:
+Gemfile에 추가:
 
 ```ruby
 gem 'hwayo'
@@ -28,6 +45,15 @@ require 'hwayo'
 # HWP 파일에서 텍스트 추출
 result = Hwayo.extract_text('document.hwp')
 
+if result[:success]
+  puts result[:text]
+else
+  puts "Error: #{result[:error]}"
+end
+
+# PDF 파일에서 텍스트 추출
+result = Hwayo.extract_text('document.pdf')
+
 if result[:success]
   puts result[:text]
 else
@@ -38,37 +64,177 @@ end
 ### 파일로 저장
 
 ```ruby
-# 추출한 텍스트를 파일로 저장
+# HWP에서 추출한 텍스트를 파일로 저장
 result = Hwayo.extract_text('document.hwp', 'output.txt')
 
 if result[:success]
-  puts "Text saved to: #{result[:output_path]}"
+  puts "텍스트가 저장되었습니다: #{result[:output_path]}"
 else
-  puts "Error: #{result[:error]}"
+  puts "오류 발생: #{result[:error]}"
+end
+
+# PDF에서 추출한 텍스트를 파일로 저장
+result = Hwayo.extract_text('document.pdf', 'output.txt')
+
+if result[:success]
+  puts "텍스트가 저장되었습니다: #{result[:output_path]}"
+else
+  puts "오류 발생: #{result[:error]}"
 end
 ```
 
-## 요구사항
+### 여러 파일 일괄 처리
 
-- Ruby 2.7.0 이상
-- Java 8 이상 (JAVA_HOME 환경변수 설정 필요)
-- MRI Ruby의 경우 RJB gem 필요 (자동 설치됨)
-- JRuby의 경우 추가 설정 없이 사용 가능
+```ruby
+# HWP와 PDF 파일 모두 처리
+files = Dir.glob("*.{hwp,pdf}")
+
+files.each do |file|
+  output_file = file.gsub(/\.(hwp|pdf)$/i, '.txt')
+  result = Hwayo.extract_text(file, output_file)
+  
+  if result[:success]
+    puts "✓ #{file} → #{output_file}"
+  else
+    puts "✗ #{file}: #{result[:error]}"
+  end
+end
+```
+
+### Rails에서 사용하기
+
+```ruby
+class DocumentsController < ApplicationController
+  def extract
+    uploaded_file = params[:file]
+    
+    if uploaded_file.present?
+      # 임시 파일로 저장
+      temp_file = Tempfile.new(['document', '.hwp'])
+      temp_file.binmode
+      temp_file.write(uploaded_file.read)
+      temp_file.rewind
+      
+      # 텍스트 추출
+      result = Hwayo.extract_text(temp_file.path)
+      
+      # 정리
+      temp_file.close
+      temp_file.unlink
+      
+      if result[:success]
+        render json: { text: result[:text] }
+      else
+        render json: { error: result[:error] }, status: :unprocessable_entity
+      end
+    else
+      render json: { error: 'No file provided' }, status: :bad_request
+    end
+  end
+end
+```
+
+## 설정
+
+### JAR 파일 위치 지정
+
+hwayo는 다음 순서로 JAR 파일을 찾습니다:
+
+**HWP 처리용 hwplib JAR:**
+1. gem 내부의 `lib/hwayo/java/hwplib-1.1.10.jar`
+2. 현재 디렉토리의 `hwplib-1.1.10.jar`
+3. 현재 디렉토리의 `target/hwplib-1.1.10.jar`
+4. 환경 변수 `HWPLIB_JAR_PATH`
 
-## 개발
+**PDF 처리용 PDFBox JAR:**
+1. gem 내부의 `lib/hwayo/java/pdfbox-app-3.0.5.jar`
+2. 현재 디렉토리의 `pdfbox-app-3.0.5.jar`
+3. 현재 디렉토리의 `target/pdfbox-app-3.0.5.jar`
+4. 환경 변수 `PDFBOX_JAR_PATH`
 
-이 gem을 개발하려면:
+커스텀 경로 지정:
 
-1. 저장소를 클론합니다
-2. `bin/setup`을 실행하여 의존성을 설치합니다
-3. `rake spec`을 실행하여 테스트를 실행합니다
-4. `bin/console`을 실행하여 대화형 프롬프트를 시작합니다
+```bash
+export HWPLIB_JAR_PATH=/path/to/hwplib-1.1.10.jar
+export PDFBOX_JAR_PATH=/path/to/pdfbox-app-3.0.5.jar
+```
+
+### Docker에서 사용하기
+
+Dockerfile에 Java 설치:
+
+```dockerfile
+# Debian/Ubuntu
+RUN apt-get update && apt-get install -y openjdk-11-jre-headless
+
+# Alpine Linux
+RUN apk add --no-cache openjdk11-jre
+
+# 환경 변수 설정
+ENV HWPLIB_JAR_PATH=/app/vendor/hwplib-1.1.10.jar
+```
+
+## 문제 해결
+
+### Java가 설치되지 않음
+
+```
+Error: Java is not installed. Please install Java 8 or later.
+```
+
+해결 방법:
+
+```bash
+# macOS
+brew install openjdk@11
+
+# Ubuntu/Debian
+sudo apt-get install openjdk-11-jre
+
+# CentOS/RHEL
+sudo yum install java-11-openjdk
+```
 
-## 기여
+### JAR 파일을 찾을 수 없음
 
-버그 리포트와 풀 리퀘스트는 GitHub에서 환영합니다.
+```
+Error: hwplib JAR not found
+```
+
+해결 방법:
+
+1. [hwplib releases](https://github.com/neolord0/hwplib/releases)에서 JAR 파일 다운로드
+2. 환경 변수 설정: `export HWPLIB_JAR_PATH=/path/to/hwplib-1.1.10.jar`
+
+### 한글 깨짐
+
+UTF-8 인코딩을 확인하세요:
+
+```ruby
+result = Hwayo.extract_text('document.hwp')
+puts result[:text].encoding  # UTF-8이어야 함
+```
+
+## 제한사항
+
+- 암호화된 HWP/PDF 파일은 지원하지 않습니다
+- 이미지, HTML로 변환은 지원하지 않습니다
+- Java 프로세스 실행으로 인한 오버헤드가 있습니다
+
+## 기여하기
+
+1. Fork it ( https://github.com/onesup/hwayo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
 
 ## 라이선스
 
 이 gem은 [MIT License](https://opensource.org/licenses/MIT)로 제공됩니다.
-hwplib은 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)으로 제공됩니다.
+
+hwplib은 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)으로 제공됩니다.
+
+## 감사의 말
+
+이 gem은 [hwplib](https://github.com/neolord0/hwplib) 프로젝트를 기반으로 만들어졌습니다. hwplib 개발자분들께 감사드립니다.

data/lib/hwayo/pdf_extractor.rb

@@ -0,0 +1,103 @@
+require 'open3'
+require 'tempfile'
+
+module Hwayo
+  module PdfExtractor
+    class << self
+      def extract_text(pdf_file, output_file = nil)
+        validate_inputs(pdf_file)
+        validate_java_installation
+        
+        jar_path = find_pdfbox_jar
+        
+        result = if output_file
+          extract_to_file(pdf_file, output_file, jar_path)
+        else
+          extract_to_string(pdf_file, jar_path)
+        end
+        
+        format_result(result, output_file)
+      end
+      
+      private
+      
+      def validate_inputs(pdf_file)
+        raise ArgumentError, "PDF file path is required" if pdf_file.nil? || pdf_file.empty?
+        raise ArgumentError, "PDF file not found: #{pdf_file}" unless File.exist?(pdf_file)
+        raise ArgumentError, "Not a PDF file: #{pdf_file}" unless pdf_file.downcase.end_with?('.pdf')
+      end
+      
+      def validate_java_installation
+        stdout, stderr, status = Open3.capture3('java', '-version')
+        unless status.success?
+          raise RuntimeError, "Java is not installed or not in PATH. Please install Java 8 or higher."
+        end
+      end
+      
+      def find_pdfbox_jar
+        search_paths = [
+          File.join(File.dirname(__FILE__), 'java', 'pdfbox-app-3.0.5.jar'),
+          'pdfbox-app-3.0.5.jar',
+          'target/pdfbox-app-3.0.5.jar',
+          ENV['PDFBOX_JAR_PATH']
+        ].compact
+        
+        jar_path = search_paths.find { |path| path && File.exist?(path) }
+        
+        unless jar_path
+          raise RuntimeError, "PDFBox JAR file not found. Searched in: #{search_paths.join(', ')}"
+        end
+        
+        jar_path
+      end
+      
+      def extract_to_file(pdf_file, output_file, jar_path)
+        cmd = ['java', '-jar', jar_path, 'export:text', '-i', pdf_file, '-o', output_file]
+        
+        stdout, stderr, status = Open3.capture3(*cmd)
+        
+        {
+          success: status.success?,
+          stdout: stdout,
+          stderr: stderr,
+          output_path: output_file
+        }
+      end
+      
+      def extract_to_string(pdf_file, jar_path)
+        Tempfile.create(['pdfbox_output', '.txt']) do |temp_file|
+          result = extract_to_file(pdf_file, temp_file.path, jar_path)
+          
+          if result[:success]
+            result[:text] = File.read(temp_file.path, encoding: 'UTF-8')
+          end
+          
+          result
+        end
+      end
+      
+      def format_result(result, output_file)
+        if result[:success]
+          base_result = {
+            success: true,
+            message: "Successfully extracted text from PDF"
+          }
+          
+          if output_file
+            base_result[:output_path] = result[:output_path]
+          else
+            base_result[:text] = result[:text]
+          end
+          
+          base_result
+        else
+          {
+            success: false,
+            message: "Failed to extract text from PDF",
+            error: result[:stderr]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/hwayo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hwayo
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/hwayo.rb

@@ -1,14 +1,26 @@
 # frozen_string_literal: true
 
 require_relative "hwayo/version"
+require_relative "hwayo/pdf_extractor"
 require 'open3'
 require 'tempfile'
 
 module Hwayo
   class Error < StandardError; end
   
+  # Extract text from HWP or PDF file
+  def self.extract_text(file_path, output_path = nil)
+    return extract_pdf(file_path, output_path) if file_path.downcase.end_with?('.pdf')
+    extract_hwp(file_path, output_path)
+  end
+  
+  # Extract text from PDF file
+  def self.extract_pdf(pdf_file_path, output_path = nil)
+    PdfExtractor.extract_text(pdf_file_path, output_path)
+  end
+  
   # Extract text from HWP file
-  def self.extract_text(hwp_file_path, output_path = nil)
+  def self.extract_hwp(hwp_file_path, output_path = nil)
     raise Error, "HWP file not found: #{hwp_file_path}" unless File.exist?(hwp_file_path)
     
     # Java 실행 가능 여부 확인

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hwayo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - 이원섭wonsup Lee/Alfonso
@@ -24,6 +24,8 @@ files:
 - lib/hwayo/extractor.rb
 - lib/hwayo/java/HWPTextExtractorCLI.class
 - lib/hwayo/java/hwplib-1.1.10.jar
+- lib/hwayo/java/pdfbox-app-3.0.5.jar
+- lib/hwayo/pdf_extractor.rb
 - lib/hwayo/simple_extractor.rb
 - lib/hwayo/version.rb
 - sig/hwayo.rbs