me2text-ruby 1.0.2 → 1.0.3

data/README.rdoc

@@ -0,0 +1,98 @@
+= me2text-ruby, me2text parser for ruby
+
+me2text-ruby는 me2text 형식의 문자열을 HTML 또는 평문(plain text)로 변환해주는 
+ruby 라이브러리이다. 
+
+== 사용
+
+
+=== HTML로 변환
+
+    require 'me2text'
+
+    str = 'me2text는 "미투데이(TM)":http://me2day.net 의 글/댓글 작성 규칙이다.'
+    Me2Text.me2text(str)
+    => "me2text는 <a href='http://me2day.net'>미투데이™"</a>의 글/댓글 작성 규칙이다."
+
+=== 평문으로 변환
+
+    require 'me2text'
+
+    str = 'me2text는 "미투데이(TM)":http://me2day.net 의 글/댓글 작성 규칙이다.'
+    Me2Text.me2text(str, :text)
+    => "me2text는 미투데이™"의 글/댓글 작성 규칙이다."
+    
+=== String 클래스 확장
+
+    require 'me2text/string_ext'
+
+    str = 'me2text는 "미투데이(TM)":http://me2day.net 의 글/댓글 작성 규칙이다.'
+    str.me2text
+    => "me2text는 <a href='http://me2day.net'>미투데이™"</a>의 글/댓글 작성 규칙이다."
+
+=== 주의 사항
+
+me2text-ruby는 입력값이 <tt>UTF-8</tt>로 인코딩된 경우에 한해서만 작동한다.
+
+== 설치
+
+me2text-ruby 라이브러리는 RubyGems를 통해 설치할 수 있다.
+
+    gem install me2text-ruby
+
+
+== me2text란?
+
+me2text는 미투데이 글/댓글등의 글 작성 규칙을 일컫는다.
+
+=== 링크
+
+링크를 표현하는 형식은 다음과 같다
+
+    "링크를 걸 문구":URL
+
+예를 들면 다음과 같다.
+
+    미투텍스트는 "미투데이":http://me2day.net 의 글/댓글 작성 규칙을 일컫는다.
+    => 미투텍스트는 <a href='http://me2day.net'>미투데이"</a>의 글/댓글 작성 규칙을 일컫는다.
+
+또, 이와 같은 링크 형식으로 작성되지 않더라도 단순히 URL만 지정한 경우에 대해서도 링크로 변환한다. 
+
+    `자세한 내용은 이 주소로. http://me2day.net`
+    => `자세한 내용은 이 주소로. <a href='http://me2day.net'>http://me2day.net</a>`
+
+백슬래시를 사용해 링크를 걸 문구에 따옴표를 포함할 수 있다. 즉, 아래와 같은 링크를 지정한 문자열에서 링크를 걸 문구에 포함된 따옴표에는 백슬래시를 붙여 전체 문자열에 링크를 적용할 수 있다.
+
+    "레이디가가 소감, \"한국의 환대 따뜻하고 신나, 그리웠다\"":http://me2.do/FnlH8u3
+    => <a href='http://me2.do/FnlH8u3'>레이디가가 소감, “한국의 환대 따뜻하고 신나, 그리웠다”</a>
+
+=== 따옴표 
+
+다음과 같이 따옴표 문자를 LEFT/RIGHT DOUBLE QUOTATION MARK(“”) 문자로 변환한다.
+
+    "안녕하세요" -> “안녕하세요”
+
+=== 심볼 문자의 표현
+
+다음과 같은 특정 순서의 문자열을 심볼 문자로 변환한다. 
+
+* ...  => … (HORIZONTAL ELLIPSIS)
+* (TM) => ™ (TRADE MARK SIGN)
+* (R)  => ® (REGISTERED SIGN)
+* (C)  => © (COPYRIGHT SIGN)
+* --   => — (EN DASH)
+
+== TODO
+
+== Contributors
+
+Authors ordered by first contribution.
+
+* Heungseok Do <codian@gmail.com> 
+* MinYoung Jung <kkungkkung@gmail.com>  
+
+== License
+
+me2text-ruby is released under the MIT license:
+
+* www.opensource.org/licenses/MIT

data/Rakefile

@@ -1,6 +1,10 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
-
+begin
+	require 'rdoc/task'
+rescue LoadError
+	require 'rake/rdoctask'
+end
 desc "Run unit tests"
 Rake::TestTask.new("test_units") do |t|
 	t.pattern = 'test/*_test.rb'
@@ -8,4 +12,17 @@ Rake::TestTask.new("test_units") do |t|
 	t.warning = true
 end
 
+desc "generate API documentation to doc/"
+Rake::RDocTask.new do |rd|
+	rd.rdoc_dir = 'doc/'
+	rd.main = 'README.rdoc'
+	rd.rdoc_files.include 'README.rdoc', 'MIT-LICENSE', 'lib/me2text/me2text.rb'
+
+	rd.options << '-c utf-8'
+	rd.options << '--inline-source'
+	rd.options << '--line-numbers'
+	rd.options << '--all'
+	rd.options << '--fileboxes'
+end
+
 task :default => :test_units

data/lib/me2text/me2text.rb

@@ -2,67 +2,59 @@
 
 require 'me2text/token'
 
-# Public: me2text 변환 메소드 제공한다.
+# me2text 변환 메소드를 제공한다.
 #
-# Examples
+# == Examples
 #
 #    require 'me2text'
 #    
 #    str = 'me2text는 "미투데이(TM)":http://me2day.net 의 글/댓글 작성 규칙이다.'
 #    Me2Text.me2text(str)
-#    # => me2text는 <a href='http://me2day.net'>미투데이™"</a>의 글/댓글 작성 규칙이다.
+#    => "me2text는 <a href='http://me2day.net'>미투데이™"</a>의 글/댓글 작성 규칙이다."
 module Me2Text
   class << self
-    # me2text(`text`)를 HTML로 변환한다.
+    
+    # me2text(+text+)를 HTML로 변환한다.
     #
-    # text - 변환할 me2text 형식의 문자열
-    # options - 다음과 같은 옵션을 지원한다. :
-    #     :symbolize - 특정 순서의 문자열을 UNICODE의 해당 심볼로 변환한다. 
-    #         지정하지 않는 경우 `true`.
-    #     :open_new_window - +:html+ 형식으로 변환시 link에 대해 클릭하면 새 창으로 열릴 
-    #         수 있도록 `<a>` 태그에 `target='_blank'`를 삽입한다. 
-    #         지정하지 않는 경우 `false`.
-    #     :allow_line_break - 라인브레이크를 허용한다. `:html` 로 변환시 라인브레이크는 
-    #                         `<br />` 태그로 변환된다. 지정하지 않는 경우 `false`. 
-    #     :limit - 변환 결과의 글자수를 제한한다. `:limit`에는 숫자를 지정하며 변환 결과는 
-    #              지정된 글자 수 까지만 변환된다.
-    #     :link_handler - 문자열에 나타나는 각 링크에 대해 지정된 block이 호출된다.
+    # === Parameters
+    # +text+ - 변환할 me2text 형식의 문자열
+    # 
+    # === Options (+options+)
+    # * <tt>:symbolize</tt> - 특정 순서의 문자열을 UNICODE의 해당 심볼로 변환한다. 지정하지 않는 경우 `true`.
+    # * <tt>:open_new_window</tt> - <tt>:html</tt> 형식으로 변환시 link에 대해 클릭하면 새 창으로 열릴 수 있도록 `<a>` 태그에 `target='_blank'`를 삽입한다. 지정하지 않는 경우 `false`.
+    # * <tt>:allow_line_break</tt> - 라인브레이크를 허용한다. <tt>:html</tt> 로 변환시 라인브레이크는  `<br />` 태그로 변환된다. 지정하지 않는 경우 `false`. 
+    # * <tt>:limit</tt> - 변환 결과의 글자수를 제한한다. <tt>:limit</tt>에는 숫자를 지정하며 변환 결과는 지정된 글자 수 까지만 변환된다.
+    # * <tt>:link_handler</tt> - 문자열에 나타나는 각 링크에 대해 지정된 block이 호출된다.
     def to_html(text, options = {})
       me2text(text, :html, options)
     end
 
     # me2text(+text+)를 평문(plain text)로 변환한다.
     #
-    # text - 변환할 me2text 형식의 문자열
-    # options - 다음과 같은 옵션을 지원한다. :
-    #     :symbolize - 특정 순서의 문자열을 UNICODE의 해당 심볼로 변환한다. 
-    #         지정하지 않는 경우 `true`.
-    #     :allow_line_break - 라인브레이크를 허용한다. `:html` 로 변환시 라인브레이크는 
-    #                         `<br />` 태그로 변환된다. 지정하지 않는 경우 `false`. 
-    #     :limit - 변환 결과의 글자수를 제한한다. `:limit`에는 숫자를 지정하며 변환 결과는 
-    #              지정된 글자 수 까지만 변환된다.
-    #     :link_handler - 문자열에 나타나는 각 링크에 대해 지정된 block이 호출된다.
+    # === Parameters
+    # +text+ - 변환할 me2text 형식의 문자열
+    # 
+    # === Options (+options+)
+    # * <tt>:symbolize</tt> - 특정 순서의 문자열을 UNICODE의 해당 심볼로 변환한다. 지정하지 않는 경우 `true`.
+    # * <tt>:open_new_window</tt> - <tt>:html</tt> 형식으로 변환시 link에 대해 클릭하면 새 창으로 열릴 수 있도록 `<a>` 태그에 `target='_blank'`를 삽입한다. 지정하지 않는 경우 `false`.
+    # * <tt>:allow_line_break</tt> - 라인브레이크를 허용한다. <tt>:html</tt> 로 변환시 라인브레이크는  `<br />` 태그로 변환된다. 지정하지 않는 경우 `false`. 
+    # * <tt>:limit</tt> - 변환 결과의 글자수를 제한한다. <tt>:limit</tt>에는 숫자를 지정하며 변환 결과는 지정된 글자 수 까지만 변환된다.
+    # * <tt>:link_handler</tt> - 문자열에 나타나는 각 링크에 대해 지정된 block이 호출된다.
     def to_text(text, options = {})
       me2text(text, :text, options)
     end
 
-    # me2text(`text`)를 지정한 형식(`format`)으로 변환한다.
+    # me2text(+text+)를 지정한 형식(+format+)으로 변환한다.
     #
-    # text - 변환할 me2text 형식의 문자열
-    # format - 변환 형식을 지정한다. `:html`, `:text` 중 하나를 지정하며 
-    #     지정하지 않은 경우 +:html+ 이 지정된다. `:html`은 HTML 형식으로 변환하며 
-    #     +:text+는 평문(plain text)으로 변환한다.
-    # options - 다음과 같은 옵션을 지원한다. :
-    #     :symbolize - 특정 순서의 문자열을 UNICODE의 해당 심볼로 변환한다. 
-    #         지정하지 않는 경우 `true`.
-    #     :open_new_window - +:html+ 형식으로 변환시 link에 대해 클릭하면 새 창으로 열릴 
-    #         수 있도록 `<a>` 태그에 `target='_blank'`를 삽입한다. 
-    #         지정하지 않는 경우 `false`.
-    #     :allow_line_break - 라인브레이크를 허용한다. `:html` 로 변환시 라인브레이크는 
-    #                         `<br />` 태그로 변환된다. 지정하지 않는 경우 `false`. 
-    #     :limit - 변환 결과의 글자수를 제한한다. `:limit`에는 숫자를 지정하며 변환 결과는 
-    #              지정된 글자 수 까지만 변환된다.
-    #     :link_handler - 문자열에 나타나는 각 링크에 대해 지정된 block이 호출된다.
+    # == Parameters
+    # * +text+ - 변환할 me2text 형식의 문자열
+    # * +format+ - 변환 형식을 지정한다. <tt>:html</tt>, <tt>:text</tt> 중 하나를 지정하며 지정하지 않은 경우 <tt>:html</tt> 이 지정된다. <tt>:html</tt>은 HTML 형식으로 변환하며 <tt>:text</tt>는 평문(plain text)으로 변환한다.
+    # === Options (+options+)
+    # * <tt>:symbolize</tt> - 특정 순서의 문자열을 UNICODE의 해당 심볼로 변환한다. 지정하지 않는 경우 `true`.
+    # * <tt>:open_new_window</tt> - <tt>:html</tt> 형식으로 변환시 link에 대해 클릭하면 새 창으로 열릴 수 있도록 `<a>` 태그에 `target='_blank'`를 삽입한다. 지정하지 않는 경우 `false`.
+    # * <tt>:allow_line_break</tt> - 라인브레이크를 허용한다. <tt>:html</tt> 로 변환시 라인브레이크는  `<br />` 태그로 변환된다. 지정하지 않는 경우 `false`. 
+    # * <tt>:limit</tt> - 변환 결과의 글자수를 제한한다. <tt>:limit</tt>에는 숫자를 지정하며 변환 결과는 지정된 글자 수 까지만 변환된다.
+    # * <tt>:link_handler</tt> - 문자열에 나타나는 각 링크에 대해 지정된 block이 호출된다.
     def me2text(text, format = :html, options = {})
       options = {
         :symbolize => true,

data/lib/me2text/token.rb

@@ -149,7 +149,7 @@ module Me2Text
         process_length = 0
         tokens.each_with_index do |tk, idx| 
           n_len = process_length + tk.length
-          r_len = length - n_len
+          r_len = options[:limit] - n_len
           
           # 길이가 남았다.
           if r_len > 0
@@ -207,12 +207,12 @@ module Me2Text
       }.merge(options)
       
       val = self.to_s(format, options)
+
       if (val.length - nos) <= 0 
-        #빼면 아무것도 없다면..
-        ##이 링크는 버린다
-        options[:ellipsis]
+        val << options[:ellipsis]
       else
-        val = val.split(//u)[0...(val.length - nos) - 1]
+        valarr = val.split(//u)
+        val = valarr[0...(valarr.length - nos) - 1].to_s
         val << options[:ellipsis]
       end
       

data/lib/me2text/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module Me2Text
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/me2text-ruby.gemspec

@@ -13,11 +13,15 @@ Gem::Specification.new do |s|
 me2text-ruby is ruby library to convert me2text to HTML or plain text}
   s.rubyforge_project = "me2text-ruby"
   s.files         = Dir['{lib/**/*,test/**/*}'] +
-                      %w(.gitignore me2text-ruby.gemspec Gemfile MIT-LICENSE Rakefile README.md)
-  s.test_files    = Dir['test/**/*']
+                      %w(.gitignore me2text-ruby.gemspec Gemfile MIT-LICENSE Rakefile README.rdoc)
+  s.test_files    = Dir['test/**/*_test.rb']
   s.executables   = ''
   s.require_paths = ["lib"]
 
+  s.extra_rdoc_files = ['MIT-LICENSE', 'README.rdoc']
+  s.rdoc_options = ["--main", "README.rdoc", "-c", "UTF-8"]
+
+
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"

data/test/me2text_test.rb

@@ -76,5 +76,12 @@ class Me2TextTest < Test::Unit::TestCase
       assert_equal test[1], Me2Text.me2text(test[0], :html, :allow_line_break => true)
     end 
   end
+  
+  def test_limit
+    assert_equal(
+      Me2Text.me2text("안녕하세요. 미투데이입니다.", :html, :limit => 10), 
+      "안녕하세요. 미투…"
+    )
+  end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: me2text-ruby
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - codian
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-22 00:00:00 Z
+date: 2012-05-23 00:00:00 Z
 dependencies: []
 
 description: |-
@@ -28,8 +28,9 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
 files: 
 - lib/me2text/me2text.rb
 - lib/me2text/string_ext.rb
@@ -43,13 +44,16 @@ files:
 - Gemfile
 - MIT-LICENSE
 - Rakefile
-- README.md
+- README.rdoc
 homepage: https://github.com/me2day/me2text-ruby
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README.rdoc
+- -c
+- UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -79,5 +83,4 @@ specification_version: 3
 summary: me2text parser for ruby
 test_files: 
 - test/me2text_test.rb
-- test/test_helper.rb
 has_rdoc: 

data/README.md

@@ -1,111 +0,0 @@
-me2text-ruby, me2text parser for ruby
-======================================
-
-me2text-ruby는 me2text 형식의 문자열을 HTML 또는 평문(plain text)로 변환해주는 
-ruby 라이브러리이다. 
-
-사용
-----
-
-### HTML로 변환
-
-    require 'me2text'
-
-    str = 'me2text는 "미투데이(TM)":http://me2day.net 의 글/댓글 작성 규칙이다.'
-    Me2Text.me2text(str)
-    # => me2text는 <a href='http://me2day.net'>미투데이™"</a>의 글/댓글 작성 규칙이다.
-
-### 평문으로 변환
-
-    require 'me2text'
-
-    str = 'me2text는 "미투데이(TM)":http://me2day.net 의 글/댓글 작성 규칙이다.'
-    Me2Text.me2text(str, :text)
-    # => me2text는 미투데이™"의 글/댓글 작성 규칙이다.
-    
-### String 클래스 확장
-
-    require 'me2text/string_ext'
-
-    str = 'me2text는 "미투데이(TM)":http://me2day.net 의 글/댓글 작성 규칙이다.'
-    str.me2text
-    # => me2text는 <a href='http://me2day.net'>미투데이™"</a>의 글/댓글 작성 규칙이다.
-
-### 주의 사항
-
-me2text-ruby 사용을 위해서는 $KCODE 변수를 'UTF8' 또는 'u'로 지정해야 한다.
-
-    $KCODE = 'UTF8'
-
-me2text-ruby는 ruby 1.8.7-p302에서 테스트되었으며 아직 ruby 1.9.X를 지원하지 않는다.
-
-설치
-----
-  me2text-ruby 라이브러리는 RubyGems를 통해 설치할 수 있다.
-
-    gem install me2text-ruby
-
-
-me2text란?
-----------
-me2text는 미투데이 글/댓글등의 글 작성 규칙을 일컫는다.
-
-### 링크
-
-  링크를 표현하는 형식은 다음과 같다
-
-    "링크를 걸 문구":URL
-
-  예를 들면 다음과 같다.
-
-    미투텍스트는 "미투데이":http://me2day.net 의 글/댓글 작성 규칙을 일컫는다.
-    => 미투텍스트는 <a href='http://me2day.net'>미투데이"</a>의 글/댓글 작성 규칙을 일컫는다.
-
-  또, 이와 같은 링크 형식으로 작성되지 않더라도 단순히 URL만 지정한 경우에 대해서도 링크로 
-  변환한다. 
-
-    `자세한 내용은 이 주소로. http://me2day.net`
-    => `자세한 내용은 이 주소로. <a href='http://me2day.net'>http://me2day.net</a>`
-
-  백슬래시를 사용해 링크를 걸 문구에 따옴표를 포함할 수 있다. 즉, 아래와 같은 링크를 지정한 
-  문자열에서 링크를 걸 문구에 포함된 따옴표에는 백슬래시를 붙여 전체 문자열에 링크를 적용할 
-  수 있다.
-
-    "레이디가가 소감, \"한국의 환대 따뜻하고 신나, 그리웠다\"":http://me2.do/FnlH8u3
-    => <a href='http://me2.do/FnlH8u3'>레이디가가 소감, “한국의 환대 따뜻하고 신나, 그리웠다”</a>
-
-### 따옴표 
-
-  다음과 같이 따옴표 문자를 LEFT/RIGHT DOUBLE QUOTATION MARK(“”) 문자로 변환한다.
-
-    "안녕하세요" -> “안녕하세요”
-
-### 심볼 문자의 표현
-
-  다음과 같은 특정 순서의 문자열을 심볼 문자로 변환한다. 
-
-  * ...  => … (HORIZONTAL ELLIPSIS)
-  * (TM) => ™ (TRADE MARK SIGN)
-  * (R)  => ® (REGISTERED SIGN)
-  * (C)  => © (COPYRIGHT SIGN)
-  * --   => — (EN DASH)
-
-TODO
-----
-
-  * Ruby 1.9 지원
-  
-Contributors
-------------
-
-Authors ordered by first contribution.
-
-Heungseok Do <codian@gmail.com>
-MinYoung Jung <kkungkkung@gmail.com>
-
-License
--------
-
-me2text-ruby is released under the MIT license:
-
-* www.opensource.org/licenses/MIT