summarize 1.0.2 → 1.0.3

data/.gitignore

@@ -1,4 +1,5 @@
 Makefile
+mkmf.log
 lib/**/*.bundle
 tmp/*
 doc/*

data/README.markdown

@@ -33,6 +33,13 @@ You can also use custom stemming rules
 
     "text to summarize".summarize(:dictionary => 'path/to/custom/dictionary')
 
+Topics can also be returned
+
+    # Returns an array with content first and topics second
+    content, topics = "text to summarize".summarize(:topics => true)
+    # content => summarized text
+    # topics  => Comma-delimited string of topics
+
 ## Dependencies
 
 You must have glib-2.0 and libxml-2.0 installed and properly configured.
@@ -42,3 +49,21 @@ You must have glib-2.0 and libxml-2.0 installed and properly configured.
 Gem written by Sean Soper ([@ssoper](http://twitter.com/ssoper))
 
 The Open Text Summarizer library was written by Nadav Rotem and can be found at <http://libots.sourceforge.net/>
+
+## License
+
+Copyright (C) 2010 Sean Soper <sean.soper@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Library General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

data/Rakefile

@@ -44,6 +44,11 @@ task :test => :build do
         content.summarize(:dictionary => '/path/to/nowhere')
       end
     end
+
+    def test_topics
+      content, topics = @jupiter.split('||').first.summarize(:topics => true)
+      assert_equal topics, "jupiter,planet,moon,system,mass"
+    end
   end
 
 end

data/ext/summarize/extconf.rb

@@ -4,7 +4,4 @@ require 'mkmf'
   pkg_config lib
 end
 
-# $CFLAGS = ENV["CFLAGS"].to_s + " " + `pkg-config --cflags glib-2.0 libxml-2.0`.chomp
-# $LDFLAGS = ENV["LDFLAGS"].to_s  + " " + `pkg-config --libs glib-2.0 libxml-2.0`.chomp
-
 create_makefile('summarize/summarize')

data/ext/summarize/summarize.c

@@ -12,18 +12,22 @@
 
 void Init_summarize() {
  VALUE rb_mOts = rb_define_module("Summarize");
- rb_define_module_function(rb_mOts, "summarize", summarize, 3);
+ rb_define_module_function(rb_mOts, "summarize", summarize, 4);
 }
 
-static VALUE summarize(const VALUE self, volatile VALUE rb_str, volatile VALUE rb_dict_file, const VALUE rb_ratio) {
+static VALUE summarize(const VALUE self, volatile VALUE rb_str, volatile VALUE rb_dict_file, const VALUE rb_ratio, const VALUE rb_topics) {
   long int length = RSTRING_LEN(rb_str);
   char *text = StringValuePtr(rb_str);
   char *dictionary_file = StringValuePtr(rb_dict_file);
   int ratio = NUM2INT(rb_ratio);
-  unsigned char *result;
+
   size_t result_len;
   OtsArticle *doc = ots_new_article();
 
+  VALUE summary;
+  VALUE topics;
+  VALUE result;
+
   if (!ots_load_xml_dictionary(doc, dictionary_file)) {
     ots_free_article(doc);
     rb_raise(rb_eRuntimeError, "Cannot load dictionary file");
@@ -34,9 +38,17 @@ static VALUE summarize(const VALUE self, volatile VALUE rb_str, volatile VALUE r
   ots_grade_doc(doc);
   ots_highlight_doc(doc, ratio);
 
-  result = ots_get_doc_text(doc, &result_len);
+  summary = rb_str_new2(ots_get_doc_text(doc, &result_len));
+  topics = rb_str_new2((const char *)doc->title);
 
   ots_free_article(doc);
 
-  return rb_str_new2(result);
+  if (rb_topics == Qtrue) {
+    result = rb_ary_new();
+    rb_ary_push(result, summary);
+    rb_ary_push(result, topics);
+    return result;
+  } else {
+    return summary;
+  }
 }

data/ext/summarize/summarize.h

@@ -8,5 +8,5 @@
 
 #ifndef __summarize_h__
 #define __summarize_h__
-static VALUE summarize(VALUE, VALUE, VALUE, VALUE);
+static VALUE summarize(VALUE, VALUE, VALUE, VALUE, VALUE);
 #endif

data/lib/summarize.rb

@@ -10,7 +10,7 @@ class Hash #:nodoc:
 end unless {}.respond_to? 'symbolize_keys'
 
 module Summarize
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 
   LANGUAGES = [
     'bg', # Bulgarian
@@ -54,8 +54,9 @@ module Summarize
 
   def self.parse_options(options = {}) #:nodoc:
     default_options = {
-      :ratio => 25,     # percentage
-      :language => 'en' # ISO 639-1 code
+      :ratio => 25,      # percentage
+      :language => 'en', # ISO 639-1 code
+      :topics => false
     }
 
     options = default_options.merge(options.symbolize_keys)
@@ -67,7 +68,7 @@ module Summarize
       dict_file = File.join(File.expand_path(File.dirname(__FILE__)), "../ext/summarize/dic/#{options[:language]}")
     end
 
-    return [dict_file, options[:ratio]]
+    return [dict_file, options[:ratio], options[:topics]]
   end
 
 end
@@ -87,12 +88,16 @@ class String
   # dictionary::
   #   A path to a custom stemming XML file
   #
+  # topics::
+  #   A boolean indicating whether to return topics as well. Return value will be
+  #   an array instead with content first and topics second. Default is false.
+  #
   # == Returns:
-  # A string summary
+  # A string summary OR an array of content and topics
   #
   def summarize(options = {})
-    dict_file, ratio = Summarize.parse_options(options)
-    String.send(:summarize, self, dict_file, ratio)
+    dict_file, ratio, topics = Summarize.parse_options(options)
+    String.send(:summarize, self, dict_file, ratio, topics)
   end
 
 end
@@ -111,8 +116,12 @@ class File
   # dictionary::
   #   A path to a custom stemming XML file
   #
+  # topics::
+  #   A boolean indicating whether to return topics as well. Return value will be
+  #   an array instead with content first and topics second. Default is false.
+  #
   # == Returns:
-  # A string summary
+  # A string summary OR an array of content and topics
   #
   def summarize(options = {})
     self.read.summarize(options)

data/summarize.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.email            = %q{sean.soper@gmail.com}
 
   s.rubygems_version  = %q{1.3.7}
-  s.date              = %q{2010-11-30}
+  s.date              = %q{2010-12-06}
   s.rubyforge_project = "summarize"
 
   s.require_paths = ["lib"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Sean Soper
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-30 00:00:00 -05:00
+date: 2010-12-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency