RubyGems - Rfizzy - Versions diffs - 0.1.0 - Mend

Rfizzy 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/.document +5 -0
data/.rspec +1 -0
data/Gemfile +16 -0
data/Gemfile.lock +49 -0
data/LICENSE.txt +7 -0
data/README.rdoc +75 -0
data/Rakefile +51 -0
data/Rfizzy.gemspec +92 -0
data/VERSION +1 -0
data/docs/FullTextSearch.html +48 -0
data/docs/Tagging.html +49 -0
data/docs/docco.css +186 -0
data/docs/installation_and_setup.html +23 -0
data/example_usage/FullTextSearch.rb +95 -0
data/example_usage/Tagging.rb +94 -0
data/example_usage/installation_and_setup.rb +55 -0
data/lib/Rfizzy.rb +83 -0
data/spec/.DS_Store +0 -0
data/spec/initialization/rfizzy_searching_initialize_spec.rb +37 -0
data/spec/searching/.DS_Store +0 -0
data/spec/searching/rfizzy_searching_create_spec.rb +43 -0
data/spec/searching/rfizzy_searching_destroy_spec.rb +33 -0
data/spec/searching/rfizzy_searching_search_spec.rb +55 -0
data/spec/spec_helper.rb +33 -0
data/spec/support/.DS_Store +0 -0
data/spec/support/Factories/search_factories.rb +37 -0
data/spec/support/Factories/tagging_factories.rb +37 -0
data/spec/tagging/rfizzy_tagging_create_spec.rb +43 -0
data/spec/tagging/rfizzy_tagging_search_spec.rb +56 -0
metadata +183 -0

data/docs/installation_and_setup.html ADDED

@@ -0,0 +1,23 @@
+<!DOCTYPE html>  <html> <head>   <title>installation_and_setup.rb</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="FullTextSearch.html">                 FullTextSearch.rb               </a>                                           <a class="source" href="Tagging.html">                 Tagging.rb               </a>                                           <a class="source" href="installation_and_setup.html">                 installation_and_setup.rb               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               installation_and_setup.rb             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>               <p>Rfizzy is a ORM agnostic library where full text searching, tagging and social graph can be implemented in very few lines of code and extrmly low learning curve. Basically plug'n'play. </p>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <hr />             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <h2>Installation</h2>
+<h3>Dependency</h3>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <p>In your gemfile.</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="n">gem</span> <span class="s2">&quot;Rfizzy&quot;</span></pre></div>             </td>           </tr>                               <tr id="section-5">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-5">&#182;</a>               </div>               <pre><code> bundle install
+</code></pre>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <h3>Initializer</h3>
+<h4>inside config/initializers/load_rfizzy.rb</h4>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-7">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-7">&#182;</a>               </div>               <p>Create an Rfizzy with your namespace.
+Default namespace is "Rfizzy".</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="no">PostSearcher</span> <span class="o">=</span> <span class="no">Rfizzy</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="ss">:namespace</span> <span class="o">=&gt;</span> <span class="s2">&quot;PostSearcher&quot;</span><span class="p">,</span> <span class="ss">:redis</span> <span class="o">=&gt;</span> <span class="n">R</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-8">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-8">&#182;</a>               </div>               <p>Make sure to pass a reference to the Redis connection.</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="no">FullOfShizzly</span> <span class="o">=</span> <span class="no">Rfizzy</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="ss">:redis</span> <span class="o">=&gt;</span> <span class="n">R</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-9">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-9">&#182;</a>               </div>               <p>This also works (Redis will default to localhost).</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="no">KissMyTizzly</span> <span class="o">=</span> <span class="no">Rfizzy</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="no">Redis</span><span class="o">.</span><span class="n">new</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-10">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-10">&#182;</a>               </div>               <h4>RedisMissingException will be raised if no Redis is passed - that means if the @redis attribute reader is nil.</h4>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-11">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-11">&#182;</a>               </div>               <hr />             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-12">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-12">&#182;</a>               </div>               <h2>But wait! ... there's more</h2>
+<h3>What can I do with this?</h3>
+<ul>
+<li><p><a href="https://github.com/fabrik42/acts_as_api/wiki/">Tagging - find posts through tagging, find tags through posts</a></p></li>
+<li><p><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model">Full text search -through association or attributes</a></p></li>
+<li><p>Social Graph, friends, followers, followees</p></li>
+</ul>
+<p>You can find more advanced examples by using the "Jumper" placed at the upper right corner</p>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-13">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-13">&#182;</a>               </div>               <hr />             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-14">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-14">&#182;</a>               </div>               <h2>Links</h2>
+<ul>
+<li><a href="https://github.com/seivan/Rfizzy">Check out the source code on Github</a></li>
+<li><a href="https://github.com/seivan/Rfizzy/issues">Found a bug or do you have a feature request?</a></li>
+<li><a href="http://travis-ci.org/seivan/Rfizzy">Continues build and testing status</a></li>
+</ul>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html>

data/example_usage/FullTextSearch.rb ADDED

@@ -0,0 +1,95 @@
+### Full Text Searching
+#
+#We are using an ActiveRecord model here.
+class Tweet < ActiveRecord::Base
+  # With it's complimentary callbacks
+  after_create :create_search_index
+  before_destroy :destroy_search_index
+  # But you can just as well use any other orm that gives it's documents/tables unique identifiers (id's)
+  private
+  def create_search_index
+    # So we set the namespace we want the searching to be on by setting it's name :tweet_text_content
+    # We pass the tweets id to it so we can find it
+    #And we pass the tweets text_content, so we can match our search
+    FullTextSearch.create_index :attribute_namespace => :tweet_text_content,
+                                :document_id => id
+  end
+  def destroy_search_index
+    #Same applies here to as to create, except we are removing the records indices
+    #No need to pass the words here, just what records index to remove
+    FullTextSearch.destroy_index  :attribute_namespace => :tweet_text_content,
+                                  :document_id => id
+  end
+end
+#Now you can search through your indices easily
+#By passing what namespace you want to search on with the words you are searching with
+set_of_ids = FullTextSearch.search_index :attribute_namespace => :tweet_text_content,
+                                         :search => "jquery mobile"
+#And no matter if you're using Mongoid, ActiveRecord or DataMapper, you can now query the ID's.
+Article.where(:id => set_of_ids)
+# ***
+### Association
+#Now lets assume we want to limit to who can search what by setting an association
+  def create_search_index
+    #Notice the assoction on the tweets user.id
+    FullTextSearch.create_index :attribute_namespace => :tweet_text_content,
+                                :document_id => id,
+                                :words => text_content,
+                                :association => user.id
+  end
+  def destroy_search_index
+    #Same concept applies here as well
+    FullTextSearch.destroy_index  :attribute_namespace => :tweet_text_content,
+                                  :document_id => id,
+                                  :association => user.id,
+  end
+#And when the current_user searches he will only find on his own associated tweets
+set_of_ids = FullTextSearch.search_index :attribute_namespace => :tweet_text_content,
+                                         :search => "jQuery map",
+                                         :association => current_user.id
+# ***
+### But wait! ... there's more
+#
+#### What can I do with this?
+#
+#
+# * [Tagging - find posts through tagging, find tags through posts][tagging]
+#
+# * [Full text search -through association or attributes][search]
+#
+# * Social Graph, friends, followers, followees
+#
+# You can find more advanced examples by using the "Jumper" placed at the upper right corner
+#
+#  [tagging]: https://github.com/fabrik42/acts_as_api/wiki/
+#  [search]: https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model
+# ***
+### Links
+# * [Check out the source code on Github][source]
+# * [Found a bug or do you have a feature request?][issue]
+# * [Continues build and testing status][build]
+#
+# [source]: https://github.com/seivan/Rfizzy
+# [issue]: https://github.com/seivan/Rfizzy/issues
+# [build]: http://travis-ci.org/seivan/Rfizzy

data/example_usage/Tagging.rb ADDED

@@ -0,0 +1,94 @@
+### Tagging
+#
+#We are using an ActiveRecord model here.
+class Article < ActiveRecord::Base
+  # With it's complimentary callbacks
+  after_create :create_search_index
+  before_destroy :destroy_search_index
+  # But you can just as well use any other orm that gives it's documents/tables unique identifiers (id's)
+  private
+  def create_search_index
+    # So we set the namespace we want the searching to be on by setting it's name :article_tags
+    # We pass the article's id to it so we can find it
+    #And we pass the articles tags as an array
+    #Naturally the tags can just be a virtual attribute as an array of tags when posting the article
+    TaggyMcFaggy.create_index :attribute_namespace => :article_tags,
+                                :document_id => id,
+                                :words => tags
+  end
+  def destroy_search_index
+    #Same concept applies here, except we don't care about the tags themselves.
+    TaggyMcFaggy.destroy_index  :attribute_namespace => :article_text,
+                                  :document_id => id
+  end
+end
+#Pass in an array of tags, or a single tag as a text
+set_of_ids = TaggyMcFaggy.search_index :attribute_namespace => :article_text,
+                                         :search => "food"
+#And no matter if you're using Mongoid, ActiveRecord or DataMapper, you can now query the ID's.
+Article.where(:id => set_of_ids)
+#Now lets assume we want to limit to who can search what by setting an association
+  def create_search_index
+    #Notice the assoction on article.user.id
+    TaggyMcFaggy.create_index :attribute_namespace => :article_text,
+                                :document_id => id,
+                                :words => text_content,
+                                :association => user.id
+  end
+  def destroy_search_index
+    #Same concept applies here, except we really do not care about the tags when deleting
+    TaggyMcFaggy.destroy_index  :attribute_namespace => :article_text,
+                                  :document_id => id,
+                                  :association => user.id,
+  end
+#And when the current_user searches he will only find on his own associated tweets
+set_of_ids = TaggyMcFaggy.search_index  :attribute_namespace => :article_text,
+                                          :association => current_user.id,
+                                          :search => ["Food", "gaming", "Balls"]
+# ***
+### But wait! ... there's more
+#
+#### What can I do with this?
+#
+#
+# * [Tagging - find posts through tagging, find tags through posts][tagging]
+#
+# * [Full text search -through association or attributes][search]
+#
+# * Social Graph, friends, followers, followees
+#
+# You can find more advanced examples by using the "Jumper" placed at the upper right corner
+#
+#  [tagging]: https://github.com/fabrik42/acts_as_api/wiki/
+#  [search]: https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model
+# ***
+### Links
+# * [Check out the source code on Github][source]
+# * [Found a bug or do you have a feature request?][issue]
+# * [Continues build and testing status][build]
+#
+# [source]: https://github.com/seivan/Rfizzy
+# [issue]: https://github.com/seivan/Rfizzy/issues
+# [build]: http://travis-ci.org/seivan/Rfizzy

data/example_usage/installation_and_setup.rb ADDED

@@ -0,0 +1,55 @@
+#Rfizzy is a ORM agnostic library where full text searching, tagging and social graph can be implemented in very few lines of code and extrmly low learning curve. Basically plug'n'play.
+# ***
+###Installation
+#### Dependency
+#In your gemfile.
+gem "Rfizzy"
+#      bundle install
+#### Initializer
+##### inside config/initializers/load_rfizzy.rb
+#Create an Rfizzy with your namespace.
+# Default namespace is "Rfizzy".
+PostSearcher = Rfizzy.new(:namespace => "PostSearcher", :redis => R)
+#Make sure to pass a reference to the Redis connection.
+FullOfShizzly = Rfizzy.new(:redis => R)
+#This also works (Redis will default to localhost).
+KissMyTizzly = Rfizzy.new(Redis.new)
+##### RedisMissingException will be raised if no Redis is passed - that means if the @redis attribute reader is nil.
+# ***
+### But wait! ... there's more
+#
+#### What can I do with this?
+#
+#
+# * [Tagging - find posts through tagging, find tags through posts][tagging]
+#
+# * [Full text search -through association or attributes][search]
+#
+# * Social Graph, friends, followers, followees
+#
+# You can find more advanced examples by using the "Jumper" placed at the upper right corner
+#
+#  [tagging]: https://github.com/fabrik42/acts_as_api/wiki/
+#  [search]: https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model
+# ***
+### Links
+# * [Check out the source code on Github][source]
+# * [Found a bug or do you have a feature request?][issue]
+# * [Continues build and testing status][build]
+#
+# [source]: https://github.com/seivan/Rfizzy
+# [issue]: https://github.com/seivan/Rfizzy/issues
+# [build]: http://travis-ci.org/seivan/Rfizzy

data/lib/Rfizzy.rb ADDED

@@ -0,0 +1,83 @@
+class Rfizzy
+  attr_reader :namespace, :redis
+  def initialize(params)
+    if params.instance_of? Hash
+      possible_namespace = params[:namespace].match(/[\w]+/).to_s unless blank? params[:namespace]
+      if blank? possible_namespace
+        @namespace = "Rfizzy:"
+      else
+        @namespace = possible_namespace
+      end
+      raise RedisMissingException, "You need to pass a redis driver {:redis => your_driver}" if params[:redis] == nil
+      @redis = params[:redis]
+    else
+      raise RedisMissingException, "You need to pass a redis driver {:redis => your_driver}" if params == nil || !params.instance_of?(Redis)
+      @redis = params
+      @namespace = "Rfizzy:"
+    end
+  end
+  def create_index(params)
+    words = params[:words]
+    words = words.split(" ") if words.instance_of? String
+    @redis.multi do |red|
+      words.each do |word|
+        red.sadd "#{@namespace}:document:#{params[:association]}:#{params[:attribute_namespace]}:#{params[:document_id]}", word
+        red.sadd "#{@namespace}:word:#{params[:association]}:#{params[:attribute_namespace]}:#{word}", params[:document_id]
+      end
+    end
+  end
+  def search_index(params)
+    interstore_cache = Time.now.to_f.to_s
+    results = []
+    search_keys_array = search_keys(params)
+    @redis.multi do |red|
+      red.sinterstore interstore_cache, *search_keys_array
+    end
+    results = @redis.smembers interstore_cache
+    @redis.multi do |red|
+      red.del interstore_cache
+    end
+    # puts @redis.sinterstore interstore_cache, *search_keys_array
+    # puts search_keys_array.inspect
+    # results = @redis.smembers interstore_cache
+    results
+  end
+  def destroy_index(params)
+    document_id = params[:document_id]
+    words_array = @redis.smembers "#{@namespace}:document:#{params[:association]}:#{params[:attribute_namespace]}:#{document_id}"
+    params.merge!({:search => words_array})
+    keys_to_delete = search_keys(params)
+    @redis.multi do |red|
+      keys_to_delete.each do |key|
+        red.srem key, document_id
+     end
+      red.del "#{@namespace}:document:#{params[:association]}:#{params[:attribute_namespace]}:document_id"
+    end
+  end
+  private
+  def search_keys(params)
+    association = params[:association]
+    attribute_namespace = params[:attribute_namespace]
+    search_text = params[:search]
+    search_text = search_text.split(" ") if search_text.instance_of? String
+    search_keys = search_text.map do |word|
+      "#{@namespace}:word:#{association}:#{attribute_namespace}:#{word}"
+    end
+    search_keys
+  end
+  def blank?(obj)
+    obj.strip! if obj.instance_of? String
+    obj.respond_to?(:empty?) ? obj.empty? : !obj
+  end
+end

data/spec/.DS_Store ADDED

Binary file

data/spec/initialization/rfizzy_searching_initialize_spec.rb ADDED

@@ -0,0 +1,37 @@
+require "spec_helper"
+describe Rfizzy, "initialize" do
+  context "should raise error if" do
+    it "initialize with no redis passed to it" do
+      lambda { Rfizzy.new() }.should raise_error
+    end
+  end
+  context "initialize with arguments" do
+    subject  {Rfizzy.new(:namespace => namespace, :redis => R) }
+    let(:namespace) { "FullTextSearch" }
+    it { should be_an_instance_of Rfizzy }
+    it { subject.namespace.should  == namespace }
+  end
+  context "initialize with blank namespace" do
+    subject  {Rfizzy.new(:namespace => namespace, :redis => R) }
+    let(:namespace) { "  " }
+    it { subject.namespace.should  == "Rfizzy:" }
+  end
+  context "initialize with no namespace" do
+    context "with hash param for redis" do
+      subject  { Rfizzy.new(:redis => R) }
+      it { subject.namespace.should  == "Rfizzy:" }
+    end
+    context "with just a redis object as param" do
+      before(:each) do
+        lambda { Rfizzy.new(R) }.should_not raise_error
+      end
+      subject {Rfizzy.new(R)}
+      it { subject.namespace.should  == "Rfizzy:" }
+    end
+  end
+end

data/spec/searching/.DS_Store ADDED

Binary file

data/spec/searching/rfizzy_searching_create_spec.rb ADDED

@@ -0,0 +1,43 @@
+require "spec_helper"
+describe Rfizzy, "search create_index" do
+  let(:namespace) { SearchFactory.instance.namespace }
+  let(:tweet) { SearchFactory.instance.tweet }
+  let(:document_key_name) { SearchFactory.instance.document_key_name }
+  let(:word_key_name) {SearchFactory.instance.word_key_name}
+  let(:word_list) { SearchFactory.instance.word_list }
+  let(:word_size) { SearchFactory.instance.word_size }
+  before(:each) do
+    @search = Rfizzy.new({:redis => R, :namespace => namespace })
+    @search.create_index(tweet)
+  end
+context "create an index with" do
+  context "a document that" do
+    it "should exist " do
+      R.exists(document_key_name).should be_true
+    end
+    it "should be of the type set" do
+      R.type(document_key_name).should == "set"
+    end
+    it "should contain words" do
+      R.smembers(document_key_name).should have(word_size).things
+    end
+  end
+  context "a set for each word that" do
+    it "should exist" do
+      word_list.each do |word|
+        R.exists("#{word_key_name}#{word}").should be_true
+      end
+    end
+    it "should refer to the document_id" do
+      word_list.each do |word|
+        R.sismember("#{word_key_name}#{word}", tweet[:document_id])
+      end
+    end
+  end
+  end
+end

data/spec/searching/rfizzy_searching_destroy_spec.rb ADDED

@@ -0,0 +1,33 @@
+require "spec_helper"
+describe Rfizzy, "search destroy_index" do
+  let(:namespace) { SearchFactory.instance.namespace }
+  let(:tweet) { SearchFactory.instance.tweet }
+  let(:document_key_name) { SearchFactory.instance.document_key_name }
+  let(:document_id) { SearchFactory.instance.document_id }
+  let(:word_key_name) {SearchFactory.instance.word_key_name}
+  let(:word_list) { SearchFactory.instance.word_list }
+  let(:word_size) { SearchFactory.instance.word_size }
+  let(:search_parameters) do
+                          {:association => tweet[:association],
+                           :attribute_namespace => tweet[:attribute_namespace],
+                           :search =>"should"}
+                         end
+  before(:each) do
+    @search = Rfizzy.new({:redis => R, :namespace => namespace })
+    @search.create_index(tweet)
+  end
+  context "destroy an index with" do
+    # context "a document that exist" do
+    #   subject { @search.search_index(search_parameters) }
+    #   it { should_not be_empty }
+    #   it { should include(document_id) }
+    # end
+    it "should no longer return results" do
+      @search.destroy_index(tweet)
+      results = @search.search_index(search_parameters)
+      results.should_not include(document_id)
+    end
+  end
+end