ruby-stemmer 0.0.1 → 0.0.2

data/README

@@ -1,4 +1,6 @@
+--
 $Id: README 17 2008-01-07 16:59:10Z aurelian $
+++
 
 == About
 
@@ -46,34 +48,30 @@ see test.rb
 
 == API
 
-module Lingua
+  module Lingua
+    class Steemer
 
-  class Steemer
-
-    # creates a new Steemer,
-    # defaults: language => en, encoding => UTF_8
-    # pass :language or :encoding to change them 
-    def initialize
-    end
+      # creates a new Steemer,
+      # defaults: language => en, encoding => UTF_8
+      # pass :language or :encoding to change them 
+      def initialize
+      end
     
-    # stemms the word
-    def stem(word)
-    end
+      # stemms the word
+      def stem(word)
+      end
     
-    # gets the length of the last stemmed word
-    # same as: 
-    # word = Lingua::Steemer.new.stem("installation") # ==> install (string)
-    # word.length # ==> 6 (int)
-    def length
+      # gets the length of the last stemmed word
+      # same as: 
+      # word = Lingua::Steemer.new.stem("installation") # ==> install (string)
+      # word.length # ==> 6 (int)
+      def length
+      end
     end
-
   end
 
-end
-
 == Todo
 
-# RDoc
-# Add (Array of Hashes) Lingua::Stemmer.list to list available languages/encodings
-# Windows?
+* Add (Array of Hashes) Lingua::Stemmer.list to list available languages/encodings
+* Windows?
 

data/Rakefile

@@ -25,7 +25,7 @@ PKG_FILES.exclude('*.so')
 
 spec = Gem::Specification.new do | s |
   s.name = 'ruby-stemmer'
-  s.version = '0.0.1'
+  s.version = '0.0.2'
   s.summary = "Stemmer implementation to ruby using libstemmer_c."
   s.description = <<-EOF
     Stemmer implementation to ruby using libstemmer_c.
@@ -33,8 +33,10 @@ spec = Gem::Specification.new do | s |
 
   s.files = PKG_FILES.to_a
   s.extensions << "extconf.rb"
-  s.has_rdoc = false
-
+  s.has_rdoc = true
+  s.rdoc_options << '--title' <<  'Ruby-Stemmer' << 
+    '--exclude' << 'libstemmer_c' << '--exclude' << 'extconf.rb' <<
+    '--exclude' << 'test.rb' << '--inline-source' << 'ruby-stemmer.c' << 'README' << '--main' << 'README'
   s.author = "Aurelian Oancea"
   s.email = "aurelian@locknet.ro"
   s.homepage = "http://nrr.rubyforge.org"

data/ruby-stemmer.c

@@ -18,6 +18,15 @@ struct sb_stemmer_data {
   const char * enc;
 };
 
+/*
+ * Document-method: new
+ * call-seq: Lingua::Stemmer.new
+ *
+ * Creates a new Stemmer, pass <tt>:language</tt> and <tt>:encoding</tt> as arguments 
+ * to change encoding or language, otherwise english with UTF_8 will be used
+ * 
+ *   s = Lingua::Stemmer.new :language => 'fr'
+ */ 
 static VALUE 
 rb_stemmer_init(int argc, VALUE *argv, VALUE self) { 
   VALUE roptions, rlang, renc;
@@ -51,7 +60,7 @@ rb_stemmer_init(int argc, VALUE *argv, VALUE self) {
       rb_raise(rb_eRuntimeError, "Language %s not available for stemming", RSTRING(rlang)->ptr);
       exit(1);
     } else {
-      rb_raise(rb_eRuntimeError, "Language %s not available for stemming in encoding", 
+      rb_raise(rb_eRuntimeError, "Language %s not available for stemming in encoding %s", 
                     RSTRING(rlang)->ptr, RSTRING(renc)->ptr);
       exit(1);
     }
@@ -66,16 +75,35 @@ rb_stemmer_init(int argc, VALUE *argv, VALUE self) {
   return self;
 }
 
+/*
+ * Document-method: stem
+ * call-seq: stem
+ *
+ * Stems a word
+ *
+ *   s = Lingua::Stemmer.new
+ *   s.stem "installation" # ==> install
+ */ 
 static VALUE
 rb_stemmer_stem(VALUE self, VALUE word) {
   struct sb_stemmer_data * sb_data;
   const  sb_symbol * stemmed;
   GetStemmer(self, sb_data);
   stemmed = sb_stemmer_stem(sb_data->stemmer, (sb_symbol *)RSTRING(word)->ptr, RSTRING(word)->len);
-  /* printf(">>[libstemmer %s/%s]: %s-> %s\n", sb_data->lang, sb_data->enc, RSTRING(word)->ptr, stemmed); */
+  // printf(">>[libstemmer %s/%s]: %s-> %s\n", sb_data->lang, sb_data->enc, RSTRING(word)->ptr, stemmed);
   return rb_str_new2((char *)stemmed);
 }
 
+/*
+ * Document-method: length
+ * call-seq: length
+ *
+ * Gets the length of the last stemmed word
+ *
+ *   s = Lingua::Stemmer.new
+ *   s.stem "installation"
+ *   s.length # ==> 6
+ */ 
 static VALUE
 rb_stemmer_length(VALUE self) {
   struct sb_stemmer_data * sb_data;
@@ -97,6 +125,9 @@ sb_stemmer_alloc(VALUE klass)
   return Data_Wrap_Struct(klass, 0, sb_stemmer_free, 0);
 }
 
+/*
+ * ruby-stemmer, ruby extension to SnowBall API
+ */
 void Init_stemmer() {
   rb_mLingua = rb_define_module("Lingua");
   rb_cStemmer = rb_define_class_under(rb_mLingua, "Stemmer", rb_cObject);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-stemmer
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Aurelian Oancea
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-07 00:00:00 +02:00
+date: 2008-01-08 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -111,11 +111,23 @@ files:
 - libstemmer_c/src_c/stem_UTF_8_swedish.h
 - libstemmer_c/src_c/stem_UTF_8_turkish.c
 - libstemmer_c/src_c/stem_UTF_8_turkish.h
-has_rdoc: false
+has_rdoc: true
 homepage: http://nrr.rubyforge.org
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --title
+- Ruby-Stemmer
+- --exclude
+- libstemmer_c
+- --exclude
+- extconf.rb
+- --exclude
+- test.rb
+- --inline-source
+- ruby-stemmer.c
+- README
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement