hirobumi-chocolate_disco-jruby 0.1.2

data/README.rdoc

@@ -0,0 +1,123 @@
+= Chocolate Disco
+
+== Description
+
+Provides methods to extract texts from various file formats like Microsoft Office (<= 2002, as well as >= 2007,) PDF and HTML.
+
+== Installation
+
+	sudo gem install hirobumi-chocolate_disco-jruby -s http://gems.github.com/ --no-ri --no-rdoc
+
+== Usage
+
+	require 'rubygems'
+	require 'chocolate_disco'
+	
+	ChocolateDisco.extract('/path/to/file.ext')
+
+== License
+
+Copyright (c) 2009 Hirobumi Hama
+
+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.
+
+== Bundles
+
+=== JTextExtract
+
+by Jaideep Pillai
+
+http://code.google.com/p/jtextextract
+
+JTextExtract is licensed under the GNU Lesser General Public License. (http://www.gnu.org/licenses/lgpl.html)
+
+=== PDFBox
+
+http://incubator.apache.org/pdfbox
+
+by the Apache Software Foundation
+
+PDFBox is licensed under the the Apache License, Version 2.0. (http://www.apache.org/licenses/LICENSE-2.0)
+
+=== The Bouncy Castle Crypto APIs
+
+http://www.bouncycastle.org
+
+by the Legion of the Bouncy Castle
+
+Copyright (c) 2000 - 2008 The Legion Of The Bouncy Castle (http://www.bouncycastle.org)
+
+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.
+
+=== dom4j
+
+http://www.dom4j.org
+
+by MetaStuff, Ltd.
+
+Redistribution and use of this software and associated documentation ("Software"), with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain copyright statements and notices. Redistributions must also contain a copy of this document.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+The name "DOM4J" must not be used to endorse or promote products derived from this Software without prior written permission of MetaStuff, Ltd. For written permission, please contact dom4j-info@metastuff.com.
+Products derived from this Software may not be called "DOM4J" nor may "DOM4J" appear in their names without prior written permission of MetaStuff, Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
+Due credit should be given to the DOM4J Project - http://www.dom4j.org
+THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
+
+=== log4j
+
+http://logging.apache.org/log4j
+
+by the Apache Software Foundation
+
+log4j is licensed under the the Apache License, Version 2.0. (http://www.apache.org/licenses/LICENSE-2.0)
+
+=== OpenXML4J
+
+http://openxml4j.org
+
+by Wygwam
+
+Copyright (c) 2006, Wygwam
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+- Neither the name of Wygwam nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+We chose to use the BSD license and the open source development model because we think that allows developers and companies from all around the world to participate, use & contribute to the project without restriction.
+
+=== The Apache POI
+
+http://poi.apache.org
+
+by the Apache Software Foundation
+
+The Apache POI is licensed under the the Apache License, Version 2.0. (http://www.apache.org/licenses/LICENSE-2.0)

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/chocolate_disco/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'chocolate_disco-jruby'
+  s.version          = ChocolateDisco::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "Provides methods to extract texts from various file formats like Microsoft Office (<= 2002, as well as >= 2007,) PDF and HTML."
+  s.author           = 'Hirobumi Hama'
+  s.email            = 'hama@yoidore.org'
+  s.homepage         = 'http://yoidore.org/chocolate_disco'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
+  s.executables    = ['chocolate_disco']
+  
+  s.add_dependency('mime-types', '>= 1.16')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end
+
+desc 'Drops into interactive Ruby'
+task :irb do
+  require 'lib/chocolate_disco'
+  
+  ARGV.delete_at(ARGV.index('irb'))  
+  require 'irb'
+  IRB.start
+end

data/bin/chocolate_disco

@@ -0,0 +1,24 @@
+#!/usr/bin/env jruby
+
+require 'rubygems'
+require 'open-uri'
+
+begin
+	require 'chocolate_disco'
+rescue LoadError
+  require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'chocolate_disco'))
+end
+
+if ARGV.length == 0
+  STDERR.puts("#{File.basename(__FILE__)} #{ChocolateDisco::Version.to_s}")
+  STDERR.puts("USAGE: chocolate_disco /path/to/file_with.extension [mime]")
+end # if ARGV.length == 0
+
+unless ARGV[0].nil?
+  if File.exists?(ARGV[0]) && !File.directory?(ARGV[0])
+    STDERR.puts("Forcing MIME to be '#{ARGV[1]}'.") if ARGV[1].is_a?(String)
+    puts(ChocolateDisco.extract(ARGV[0], :force_mime => ARGV[1]))
+  else # if File.exists?(ARGV[0])
+    STDERR.puts("File '#{ARGV[0]}' not found.")
+  end # else if File.exists?(ARGV[0])
+end # unless ARGV[0].nil?

data/lib/chocolate_disco.rb

@@ -0,0 +1,13 @@
+raise(NotImplementedError.new([
+    'ChocolateDisco (chocolate_disco-jruby) is not supported in this Ruby.',
+    'Use JRuby or try The Apache POI Ruby Bindings.'
+  ].join("\n"))) unless RUBY_PLATFORM == 'java'
+
+$:.unshift File.dirname(__FILE__)
+
+module ChocolateDisco  
+end # module ChocolateDisco
+
+require 'chocolate_disco/version'
+require 'chocolate_disco/java'
+require 'chocolate_disco/chocolate_disco'

data/lib/chocolate_disco/chocolate_disco.rb

@@ -0,0 +1,62 @@
+gem 'mime-types', '>= 1.16'
+require 'mime/types'
+
+module ChocolateDisco
+  
+  class << self
+    
+    @@supported_mime_types = nil
+    
+    # returns an array of supported mime types.
+    def supported_mime_types
+      @@supported_mime_types ||= Java::SupportedMimeTypes.constants.map { |const| eval("Java::SupportedMimeTypes::#{const}") }
+    end # def supported_mime_types
+    
+    # returns whether or not the file is supported.
+    # :path to specify the file. :mime to specify the mime.
+    # :mimes to give an array of mimes.
+    def supported?(opts = {})
+      mimes = []
+      mimes << opts[:mime] if opts[:mime].is_a?(String)
+      mimes += opts[:mimes] if opts[:mimes].is_a?(Array)
+      
+      if opts[:path].is_a?(String) && File.exists?(opts[:path]) && !File.directory?(opts[:path]) && File.file?(opts[:path])
+        begin
+          mimes << MIME::Types.of(opts[:path]).map { |mime| mime.simplified }
+        rescue NoMethodError # begin
+          raise(NotImplementedError.new("MIME types of a file '#{opts[:path]}' could not be inferred."))
+        end # rescue
+      end # if opts[:path].is_a?(String) && File.exists?(opts[:path]) && !File.directory?(opts[:path]) && File.file?(opts[:path])
+      
+      mimes.flatten!
+      mimes.compact!
+      mimes.uniq!
+      
+      mimes.map { |mime| return true if supported_mime_types.include?(mime) }
+      
+      false
+    end # def supported?(opts = {})
+    
+    # extracts text from path, returns string, empty string or nil.
+    def extract(path, opts = {})
+      
+      if opts[:force_mime].is_a?(String)
+        mimes = [opts[:force_mime]]
+      else
+        mimes = MIME::Types.of(path).map { |mime| mime.simplified }
+      end
+      
+      raise(NotImplementedError.new("MIME (#{mimes.join(', ')}) for '#{path}' is not supported by chocolate_disco.")) unless supported?(:mimes => mimes)
+      
+      extractor = mimes.map { |mime| Java::TextExtractionFactory.getExtractor(mime) }[0]
+      
+      raise(RuntimeError.new('TextExtractionFactory failed to get an instance of TextExtractor, which is impossible.')) if extractor.nil?
+      
+      extractor.extractText(java.io.File.new(path))
+    end # def extract
+    
+    alias :lets_party! :extract
+    
+  end # class << self
+  
+end # module ChocolateDisco

data/lib/chocolate_disco/java.rb

@@ -0,0 +1,15 @@
+module ChocolateDisco
+  
+  module Java
+    
+    Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), 'java', '*.jar'))).each do |jar|
+      require(jar)
+    end
+    
+    %w(HTMLExtractor MSExcelExtractor MSOffice2007Extractor MSPPTExtractor MSVisioExtractor MSWordExtractor PDFExtractor SupportedMimeTypes TextExtractionFactory TxtTextExtractor XMLExtractor).each do |klass_name|
+      include_class "org.jaideep.jtextextract.#{klass_name}"
+    end # %w(...).each do |klass_name|
+    
+  end # module Java
+  
+end # module ChocolateDisco

data/lib/chocolate_disco/version.rb

@@ -0,0 +1,13 @@
+module ChocolateDisco
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 2
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# http://sneaq.net/textmate-wtf
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'test/unit'
+
+gem 'thoughtbot-shoulda', '>= 2.10.1'
+require 'shoulda'
+
+require File.dirname(__FILE__) + '/../lib/chocolate_disco'

data/test/unit/chocolate_disco_test.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ChocolateDiscoTest < Test::Unit::TestCase
+  
+  context 'bin/chocolate_disco' do
+    
+    should 'have tests' do
+      flunk('TODO')
+    end
+    
+  end
+  
+  context 'ChocolateDisco' do
+    
+    should 'have tests' do
+      flunk('TODO')
+    end
+    
+    ["application/vnd.visio", "application/pdf", "text/html", "text/xml", "application/vnd.ms-excel", "application/vnd.openxmlformats ", "text", "application/rtf", "application/vnd.ms-powerpoint", "application/msword"].each do |mime|
+      
+      should "support #{mime}" do
+        assert(ChocolateDisco.supported?(:mime => mime))
+      end
+      
+    end # [mime, ...].each do |mime|
+    
+  end
+  
+end # class ChocolateDiscoTest < Test::Unit::TestCase

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: hirobumi-chocolate_disco-jruby
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Hirobumi Hama
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-11 00:00:00 -07:00
+default_executable: chocolate_disco
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.16"
+    version: 
+description: 
+email: hama@yoidore.org
+executables: 
+- chocolate_disco
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/chocolate_disco
+- lib/chocolate_disco/chocolate_disco.rb
+- lib/chocolate_disco/java
+- lib/chocolate_disco/java/apache-pdfbox-0.8.0-incubator-dev.jar
+- lib/chocolate_disco/java/bcprov-jdk15-142.jar
+- lib/chocolate_disco/java/dom4j-1.6.1.jar
+- lib/chocolate_disco/java/JTextExtract.jar
+- lib/chocolate_disco/java/log4j-1.2.13.jar
+- lib/chocolate_disco/java/openxml4j-bin-beta.jar
+- lib/chocolate_disco/java/poi-3.2-FINAL-20081019.jar
+- lib/chocolate_disco/java/poi-scratchpad-3.2-FINAL-20081019.jar
+- lib/chocolate_disco/java.rb
+- lib/chocolate_disco/version.rb
+- lib/chocolate_disco.rb
+- test/sample
+- test/test_helper.rb
+- test/unit
+- test/unit/chocolate_disco_test.rb
+- bin/chocolate_disco
+has_rdoc: true
+homepage: http://yoidore.org/chocolate_disco
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Provides methods to extract texts from various file formats like Microsoft Office (<= 2002, as well as >= 2007,) PDF and HTML.
+test_files: []
+