yomu 0.1.1 → 0.1.2

data/README.md

@@ -1,5 +1,5 @@
 # Yomu 読む
-[Yomu](http://erol.github.com/yomu) is a library for extracting text and metadata from files and documents using the [Apache TIKA](http://tika.apache.org/) content analysis toolkit.
+[Yomu](http://erol.github.com/yomu) is a library for extracting text and metadata from files and documents using the [Apache Tika](http://tika.apache.org/) content analysis toolkit.
 
 Here are some of the formats supported:
 
@@ -10,7 +10,7 @@ Here are some of the formats supported:
 - Rich Text Format (.rtf)
 - Portable Document Format (.pdf)
 
-For the complete list of supported formats, please visit the Apache TIKA
+For the complete list of supported formats, please visit the Apache Tika
 [Supported Document Formats](http://tika.apache.org/0.9/formats.html) page.
 
 ## Installation and Dependencies
@@ -27,7 +27,7 @@ Or install it yourself as:
 
     $ gem install yomu
 
-**Yomu packages the Apache TIKA application jar and requires a working JRE for it to work.**
+**Yomu packages the Apache Tika application jar and requires a working JRE for it to work.**
 
 ## Usage
 
@@ -70,4 +70,4 @@ Yomu can also read from a stream or any object that responds to `read`, includin
 3. Create tests and make them pass ( `rake test` )
 4. Commit your changes ( `git commit -am 'Added some feature'` )
 5. Push to the branch ( `git push origin my-new-feature` )
-6. Create a new Pull Request
+6. Create a new Pull Request

data/lib/yomu.rb

@@ -5,7 +5,7 @@ require 'yaml'
 
 class Yomu
   GEMPATH = File.dirname(File.dirname(__FILE__))
-  JARPATH = File.join(Yomu::GEMPATH, 'jar', 'tika-app-1.1.jar')
+  JARPATH = File.join(Yomu::GEMPATH, 'jar', 'tika-app-1.2.jar')
 
   # Read text or metadata from a data buffer.
   #
@@ -30,7 +30,7 @@ class Yomu
     type == :metadata ? YAML.load(result) : result
   end
 
-  # Create a new instance of Yomu.
+  # Create a new instance of Yomu with a given document.
   #
   # Using a file path:
   #
@@ -40,7 +40,7 @@ class Yomu
   #
   #   Yomu.new 'http://svn.apache.org/repos/asf/poi/trunk/test-data/document/sample.docx'
   #
-  # Using a stream or object which responds to +read+
+  # From a stream or an object which responds to +read+
   #
   #   Yomu.new File.open('sample.pages')
 
@@ -60,7 +60,7 @@ class Yomu
     end
   end
 
-  # Returns the text contents of a Yomu object.
+  # Returns the text content of the Yomu document.
   #
   #   yomu = Yomu.new 'sample.pages'
   #   yomu.text
@@ -71,30 +71,49 @@ class Yomu
     @text = Yomu.read :text, data
   end
 
-  # Returns the metadata hash of a Yomu object.
+  # Returns the metadata hash of the Yomu document.
   #
   #   yomu = Yomu.new 'sample.pages'
   #   yomu.metadata['Content-Type']
-  
+
   def metadata
     return @metadata if defined? @metadata
 
     @metadata = Yomu.read :metadata, data
   end
 
+  # Returns +true+ if the Yomu document was specified using a file path.
+  #
+  #   yomu = Yomu.new 'sample.pages'
+  #   yomu.path? #=> true
+
   def path?
     defined? @path
   end
 
+  # Returns +true+ if the Yomu document was specified using a URI.
+  #
+  #   yomu = Yomu.new 'http://svn.apache.org/repos/asf/poi/trunk/test-data/document/sample.docx'
+  #   yomu.uri? #=> true
+
   def uri?
     defined? @uri
   end
 
+  # Returns +true+ if the Yomu document was specified from a stream or an object which responds to +read+.
+  #
+  #   file = File.open('sample.pages')
+  #   yomu = Yomu.new file
+  #   yomu.stream? #=> true
+
   def stream?
     defined? @stream
   end
 
-  protected
+  # Returns the raw/unparsed content of the Yomu document.
+  #
+  #   yomu = Yomu.new 'sample.pages'
+  #   yomu.data
 
   def data
     return @data if defined? @data
@@ -109,4 +128,4 @@ class Yomu
 
     @data
   end
-end
+end

data/lib/yomu/version.rb

@@ -1,3 +1,3 @@
 class Yomu
-  VERSION = "0.1.1"
-end
+  VERSION = "0.1.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yomu
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-11 00:00:00.000000000 Z
+date: 2012-09-09 00:00:00.000000000 Z
 dependencies: []
 description: Yomu is a library for extracting text and metadata using the Apache TIKA
   content analysis toolkit.
@@ -25,7 +25,7 @@ files:
 - NOTICE.txt
 - README.md
 - Rakefile
-- jar/tika-app-1.1.jar
+- jar/tika-app-1.2.jar
 - lib/yomu.rb
 - lib/yomu/version.rb
 - test/samples/sample filename with spaces.pages
@@ -53,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Yomu is a library for extracting text and metadata using the Apache TIKA
@@ -63,4 +63,3 @@ test_files:
 - test/samples/sample.pages
 - test/test_helper.rb
 - test/yomu_test.rb
-has_rdoc: