word_scoop 2.0.0

data/History.txt

@@ -0,0 +1,22 @@
+== 0.0.1 2008-08-30
+
+* 1 major enhancement:
+  * Initial release
+
+== 1.0.1 2009-03-07
+
+* 1 minor enhancement:
+  * move to GitHub from Rubyforge
+
+== 1.0.2 2009-09-27
+* 1 minor enhancement:
+  * bug fix.
+
+== 1.1 2009-10-03
+* 1 major enhancement:
+  * all renewal by C
+ 
+== 2.0 2009-11-21
+* 1 major enhancement:
+  * The library name is changed from Kaerukeyword to WordScoop.
+  * filter_html method : word enclosed with 'a' tag.

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/word_scoop.rb
+ext/extconf.rb
+ext/word_scoop.h
+ext/word_scoop.c

data/README.rdoc

@@ -0,0 +1,199 @@
+= WordScoop
+
+= Description
+WordScoop is a library that searching keyword in text.
+
+= How to
+
+== Register keywords
+ keywords = WordScoop.new(["Ruby", "Rails"])
+
+== Add keyword
+keywords << "Tsukasa"
+
+== Keyword in the text is picked up
+ keywords.search("I Love Ruby") #=> ["Ruby"]
+
+== HTML text support
+
+=== URL is registered
+
+ keyword.link_url = %Q|<a href="http://ja.wikipedia.org/wiki/%s">%s</a>|
+ (Default is %Q|http://www.kaeruspoon.net/keywords/%s>%s</a>|)
+
+=== Keyword in the text is enclosed with HTML 'a' tag
+
+ keywords.filter_html("I Love Ruby") #=> %Q|I Love <a href="http://ja.wikipedia.org/wiki/Ruby">Ruby</a>|
+
+
+== INSTALL:
+
+sudo gem install word_scoop
+
+== LICENSE:
+
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/kaerukeyword'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('word_scoop', WordScoop::VERSION) do |p|
+  p.developer('Tsukasa OISHI', 'tsukasa.oishi@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  pec_extras = {
+    :extensions => ['ext/extconf.rb'],
+  }
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/ext/extconf.rb

@@ -0,0 +1,2 @@
+require "mkmf"
+create_makefile("word_scoop")

data/ext/word_scoop.c

@@ -0,0 +1,311 @@
+//************************************
+//         word_scoop.c
+//
+//         Tsukasa OISHI
+//
+//           2009/11/21
+//************************************
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <ruby.h>
+#include "word_scoop.h"
+
+
+// initialize node
+node initialize_node(char moji)
+{
+    node work = (node)malloc(sizeof(struct _node));
+    if (!work) {
+        // except
+        rb_raise(rb_eStandardError, "memory is not enough");
+    }
+
+    work->moji = moji;
+    work->end_flag = false;
+    work->child_head = NULL;
+    work->next = NULL;
+
+    return work;
+}
+
+// add child node
+void add_child(node parent, node child)
+{
+    if (parent->child_head) {
+        child->next = parent->child_head;
+    }
+    parent->child_head = child;
+}
+
+// search node by use character
+node search_child(node n, char moji)
+{
+    node child;
+    
+    child = n->child_head;
+    while(child) {
+        if (child->moji == moji) {
+            break;
+        }
+        child = child->next;
+    }
+
+    return child;
+}
+
+// search node by use character.
+// if nothing, create new node
+node search_child_or_create(node n, char moji)
+{
+    node child;
+    
+    child = search_child(n, moji);
+    if(!child) {
+        child = initialize_node(moji);
+        add_child(n, child);
+    }
+
+    return child;
+}
+
+// free memory all child and self
+void destroy_node(node n)
+{
+    int i;
+    node now, next;
+
+    now = n->child_head;
+    while(now) {
+        next = now->next;
+        destroy_node(now);
+        now = next;
+    }
+
+    free(n);
+}
+
+//-----------------------------------------------------------
+// Ruby Methods
+// ----------------------------------------------------------
+
+/**
+ * new
+ **/
+static VALUE t_new(int argc, VALUE *argv, VALUE klass)
+{
+    node root;
+    VALUE obj, array, string;
+
+    root = initialize_node(NULL_CHAR);
+
+    obj = Data_Make_Struct(klass, struct _node, NULL, destroy_node, root);
+
+    if (argc == 1) {
+        array = argv[0];
+        while((string = rb_ary_shift(argv[0])) != Qnil) {
+            t_add(obj, string);
+        }
+    }
+
+    return obj;
+}
+
+/**
+ * add
+ **/
+static VALUE t_add(VALUE self, VALUE str)
+{
+    node root, now;
+    char *keyword;
+    int i, len;
+
+    keyword = STR2CSTR(str);
+
+    len = strlen(keyword);
+    while(keyword[len - 1] == CR || keyword[len - 1] == LF ||
+            keyword[len - 1] == TAB ||  keyword[len - 1] == SPACE) {
+        len--;
+    }
+
+    if (len < 1) {
+        return Qfalse;
+    }
+
+    Data_Get_Struct(self, struct _node, root);
+    now = root;
+
+    for(i = 0; i < len; i++) {
+        now = search_child_or_create(now, keyword[i]);
+    }
+
+    now->end_flag = true;
+
+    return str;
+}
+
+/**
+ * search
+ **/
+static VALUE t_search(VALUE self, VALUE str)
+{
+    node root, now, ret;
+    char *text;
+    int i, head_i, tail_i, total_len;
+    VALUE array;
+
+    array = rb_ary_new();
+    text = STR2CSTR(str);
+
+    Data_Get_Struct(self, struct _node, root);
+
+    now = root;
+    total_len = strlen(text);
+    head_i = -1;
+    tail_i = -1;
+
+    for(i = 0; i <= total_len; i++) {
+        ret = search_child(now, text[i]);
+
+        if (ret && i != total_len) {
+            if (head_i == -1) {
+                head_i = i;
+            }
+
+            if (ret->end_flag) {
+                tail_i = i;
+            }
+            now = ret;
+        } else {
+            if (head_i != -1) {
+                if (tail_i != -1) {
+                    rb_funcall(array, rb_intern("push"), 1, rb_str_new(&text[head_i], (tail_i - head_i + 1)));
+                    i = tail_i;
+                    tail_i = -1;
+                } else {
+                    i = head_i;
+                }
+                head_i = -1;
+            }
+            now = root;
+        }
+    }
+
+    return array;
+}
+
+/**
+ * filter_html
+ **/
+static VALUE t_filter_hrml(VALUE self, VALUE str)
+{
+    node root, now, ret;
+    bool in_tag;
+    char *text, *inner_tag;
+    int i, head_i, tail_i, copy_head_i, total_len;
+    VALUE change_str, url_base, word;
+
+    change_str = rb_str_new2(EMPTY_STRING);
+    text = STR2CSTR(str);
+
+    Data_Get_Struct(self, struct _node, root);
+    url_base = rb_iv_get(self, LINK_URL_VARIABLE);
+    if (url_base == Qnil) {
+        url_base = rb_str_new2(DEAULT_LINK_URL);
+    }
+
+    now = root;
+    total_len = strlen(text);
+    head_i = -1;
+    tail_i = -1;
+    copy_head_i = 0;
+    in_tag = false;
+    inner_tag = NULL;
+
+    for(i = 0; i <= total_len; i++) {
+        if (!in_tag && text[i] == BEGIN_TAG) {
+            in_tag = true;
+            if (strncasecmp(&text[i + 1], A_TAG, strlen(A_TAG)) == 0) {
+                inner_tag = A_TAG;
+            } else if (strncasecmp(&text[i + 1], SCRIPT_TAG, strlen(SCRIPT_TAG)) == 0) {
+                inner_tag = SCRIPT_TAG;
+            } else if (strncasecmp(&text[i + 1], PRE_TAG, strlen(PRE_TAG)) == 0) {
+                inner_tag = PRE_TAG;
+            } else if (strncasecmp(&text[i + 1], IFRAME_TAG, strlen(IFRAME_TAG)) == 0) {
+                inner_tag = IFRAME_TAG;
+            } else if (strncasecmp(&text[i + 1], OBJECT_TAG, strlen(OBJECT_TAG)) == 0) {
+                inner_tag = OBJECT_TAG;
+            }
+            continue;
+        }
+
+        if (in_tag && !inner_tag && text[i] == END_TAG) {
+            in_tag = false;
+            continue;
+        }
+
+        if (inner_tag && text[i] == BEGIN_TAG) {
+            if (strncasecmp(&text[i + 2], inner_tag, strlen(inner_tag)) == 0) {
+                inner_tag = NULL;
+                continue;
+            }
+        }
+
+        if (in_tag) {
+            continue;
+        }
+
+        ret = search_child(now, text[i]);
+
+        if (ret && i != total_len) {
+            if (head_i == -1) {
+                head_i = i;
+            }
+
+            if (ret->end_flag) {
+                tail_i = i;
+            }
+            now = ret;
+        } else {
+            if (head_i != -1) {
+                if (tail_i != -1) {
+                    if (copy_head_i < head_i) {
+                        rb_funcall(change_str, rb_intern("concat"), 1, rb_str_new(&text[copy_head_i], (head_i - copy_head_i)));
+                    }
+
+                    word = rb_str_new(&text[head_i], (tail_i - head_i + 1));
+                    rb_funcall(change_str, rb_intern("concat"), 1, rb_funcall(url_base, rb_intern("%"), 1, rb_assoc_new(word, word)));
+                    i = tail_i;
+                    copy_head_i = tail_i + 1;
+                    tail_i = -1;
+                } else {
+                    i = head_i;
+                }
+                head_i = -1;
+            }
+            now = root;
+        }
+    }
+
+    if (copy_head_i == 0) {
+        return str;
+    } else {
+        rb_funcall(change_str, rb_intern("concat"), 1, rb_str_new(&text[copy_head_i], (total_len - copy_head_i)));
+        return change_str;
+    }
+}
+
+/**
+ * define class
+ **/
+void Init_word_scoop() {
+    VALUE cWordScoop;
+
+    cWordScoop = rb_define_class("WordScoop", rb_cObject);
+    rb_define_singleton_method(cWordScoop, "new", t_new, -1);
+    rb_define_method(cWordScoop, "add", t_add, 1);
+    rb_define_method(cWordScoop, "search", t_search, 1);
+    rb_define_method(cWordScoop, "filter_html", t_filter_hrml, 1);
+    rb_define_alias(cWordScoop, "<<", "add");
+}

data/ext/word_scoop.h

@@ -0,0 +1,79 @@
+//************************************
+//          word_scoop.h
+//
+//          Tsukasa OISHI
+//
+//           2009/11/21
+//************************************
+
+
+// bool type
+#define true    1
+#define false   0
+typedef char bool;
+
+#define CR '\r'
+#define LF '\n'
+#define TAB '\t'
+#define SPACE ' '
+#define NULL_CHAR '\0'
+
+#define BEGIN_TAG '<'
+#define END_TAG '>'
+
+#define A_TAG "a"
+#define SCRIPT_TAG "script"
+#define PRE_TAG "pre"
+#define IFRAME_TAG "iframe"
+#define OBJECT_TAG "object"
+
+#define EMPTY_STRING ""
+#define LINK_URL_VARIABLE "@link_url"
+#define DEAULT_LINK_URL "<a href=\"http://www.kaeruspoon.net/keywords/%s\">%s</a>"
+
+// node is 1 byte character
+typedef struct _node {
+    char    moji;               // character
+    bool    end_flag;           // true if end of word
+
+    struct _node    *child_head;// head of child list
+    struct _node    *next;      // pointer of sibling node
+} *node;
+
+
+// initialize node
+node initialize_node(char);
+
+// add child node
+void add_child(node, node);
+
+// search node by use character
+node search_child(node, char);
+
+// search node by use character.
+// if nothing, create new node
+node search_child_or_create(node, char);
+
+// free memory all child and self
+void destroy_node(node);
+
+//-----------------------------------------------------------
+// Ruby Methods
+// ----------------------------------------------------------
+
+// new
+static VALUE t_new(int, VALUE *, VALUE);
+
+// add
+static VALUE t_add(VALUE, VALUE);
+
+// search
+static VALUE t_search(VALUE, VALUE);
+
+//filter_html
+static VALUE t_filter_html(VALUE, VALUE);
+
+
+// defined class
+void Init_word_scoop();
+

data/lib/word_scoop.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'word_scoop.so'
+class WordScoop
+  VERSION = '2.0.0'
+
+  attr_accessor :link_url
+end
+

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: word_scoop
+version: !ruby/object:Gem::Version 
+  version: 2.0.0
+platform: ruby
+authors: 
+- Tsukasa OISHI
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-21 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: WordScoop is a library that searching keyword in text.
+email: 
+- tsukasa.oishi@gmail.com
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/word_scoop.rb
+- ext/extconf.rb
+- ext/word_scoop.c
+- ext/word_scoop.h
+has_rdoc: true
+homepage: http://www.kaeruspoon.net/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+- ext
+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: word_scoop
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: WordScoop is a library that searching keyword in text.
+test_files: []
+