RubyGems - pose - Versions diffs - 0.0.2 - Mend

pose 0.0.2

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 (33) hide show

data/MIT-LICENSE +20 -0
data/README.markdown +91 -0
data/Rakefile +26 -0
data/doc/Pose/InstanceMethods.html +341 -0
data/doc/Pose.html +774 -0
data/doc/PoseAssignment.html +125 -0
data/doc/PoseGenerator.html +255 -0
data/doc/PoseMigrations.html +261 -0
data/doc/PoseWord.html +125 -0
data/doc/_index.html +134 -0
data/doc/class_list.html +47 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +55 -0
data/doc/css/style.css +322 -0
data/doc/file_list.html +46 -0
data/doc/frames.html +13 -0
data/doc/index.html +134 -0
data/doc/js/app.js +205 -0
data/doc/js/full_list.js +167 -0
data/doc/js/jquery.js +16 -0
data/doc/method_list.html +150 -0
data/doc/top-level-namespace.html +172 -0
data/lib/generators/pose_generator.rb +15 -0
data/lib/generators/templates/migration.rb +23 -0
data/lib/pose/posifier.rb +13 -0
data/lib/pose/version.rb +3 -0
data/lib/pose.rb +167 -0
data/lib/pose_assignment.rb +5 -0
data/lib/pose_word.rb +4 -0
data/lib/tasks/pose_tasks.rake +18 -0
data/spec/pose_spec.rb +256 -0
data/spec/spec_helper.rb +60 -0
metadata +167 -0

data/doc/method_list.html ADDED Viewed

@@ -0,0 +1,150 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+      <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+      <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) {
+        document.getElementById('base_target').target = 'main';
+        document.body.className = 'frames';
+      }
+    </script>
+    <div id="content">
+      <h1 id="full_list_header">Method List</h1>
+      <div id="nav">
+          <a target="_self" href="class_list.html">Classes</a>
+          <a target="_self" href="method_list.html">Methods</a>
+          <a target="_self" href="file_list.html">Files</a>
+      </div>
+      <div id="search">Search: <input type="text" /></div>
+      <ul id="full_list" class="methods">
+  <li class="r1 ">
+    <span class='object_link'><a href="PoseGenerator.html#create_migration_file-instance_method" title="PoseGenerator#create_migration_file (method)">#create_migration_file</a></span>
+      <small>PoseGenerator</small>
+  </li>
+  <li class="r2 ">
+    <span class='object_link'><a href="Pose/InstanceMethods.html#delete_pose_index-instance_method" title="Pose::InstanceMethods#delete_pose_index (method)">#delete_pose_index</a></span>
+      <small>Pose::InstanceMethods</small>
+  </li>
+  <li class="r1 ">
+    <span class='object_link'><a href="PoseMigrations.html#down-class_method" title="PoseMigrations.down (method)">down</a></span>
+      <small>PoseMigrations</small>
+  </li>
+  <li class="r2 ">
+    <span class='object_link'><a href="Pose.html#get_words_to_add-class_method" title="Pose.get_words_to_add (method)">get_words_to_add</a></span>
+      <small>Pose</small>
+  </li>
+  <li class="r1 ">
+    <span class='object_link'><a href="Pose.html#get_words_to_remove-class_method" title="Pose.get_words_to_remove (method)">get_words_to_remove</a></span>
+      <small>Pose</small>
+  </li>
+  <li class="r2 ">
+    <span class='object_link'><a href="Pose.html#is_url-class_method" title="Pose.is_url (method)">is_url</a></span>
+      <small>Pose</small>
+  </li>
+  <li class="r1 ">
+    <span class='object_link'><a href="PoseGenerator.html#next_migration_number-class_method" title="PoseGenerator.next_migration_number (method)">next_migration_number</a></span>
+      <small>PoseGenerator</small>
+  </li>
+  <li class="r2 ">
+    <span class='object_link'><a href="#posify-instance_method" title="#posify (method)">#posify</a></span>
+      <small>Top Level Namespace</small>
+  </li>
+  <li class="r1 ">
+    <span class='object_link'><a href="Pose.html#root_word-class_method" title="Pose.root_word (method)">root_word</a></span>
+      <small>Pose</small>
+  </li>
+  <li class="r2 ">
+    <span class='object_link'><a href="Pose.html#search-class_method" title="Pose.search (method)">search</a></span>
+      <small>Pose</small>
+  </li>
+  <li class="r1 ">
+    <span class='object_link'><a href="PoseMigrations.html#up-class_method" title="PoseMigrations.up (method)">up</a></span>
+      <small>PoseMigrations</small>
+  </li>
+  <li class="r2 ">
+    <span class='object_link'><a href="Pose/InstanceMethods.html#update_pose_index-instance_method" title="Pose::InstanceMethods#update_pose_index (method)">#update_pose_index</a></span>
+      <small>Pose::InstanceMethods</small>
+  </li>
+  <li class="r1 ">
+    <span class='object_link'><a href="Pose/InstanceMethods.html#update_pose_words-instance_method" title="Pose::InstanceMethods#update_pose_words (method)">#update_pose_words</a></span>
+      <small>Pose::InstanceMethods</small>
+  </li>
+      </ul>
+    </div>
+  </body>
+</html>

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,172 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.7.3
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a id="class_list_link" href="#">Class List</a>
+    <a id="method_list_link" href="#">Method List</a>
+    <a id="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Pose.html" title="Pose (module)">Pose</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="PoseAssignment.html" title="PoseAssignment (class)">PoseAssignment</a></span>, <span class='object_link'><a href="PoseGenerator.html" title="PoseGenerator (class)">PoseGenerator</a></span>, <span class='object_link'><a href="PoseMigrations.html" title="PoseMigrations (class)">PoseMigrations</a></span>, <span class='object_link'><a href="PoseWord.html" title="PoseWord (class)">PoseWord</a></span>
+</p>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#posify-instance_method" title="#posify (instance method)">- (Object) <strong>posify</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <p class="signature first" id="posify-instance_method">
+    - (<tt>Object</tt>) <strong>posify</strong>
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+159
+160
+161</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/pose.rb', line 159</span>
+<span class='def def kw'>def</span> <span class='posify identifier id'>posify</span>
+  <span class='include identifier id'>include</span> <span class='Pose constant id'>Pose</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Nov 16 11:48:27 2011 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.3 (ruby-1.8.7).
+</div>
+  </body>
+</html>

data/lib/generators/pose_generator.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+class PoseGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/pose.rb'
+  end
+  def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+end

data/lib/generators/templates/migration.rb ADDED Viewed

@@ -0,0 +1,23 @@
+class PoseMigrations < ActiveRecord::Migration
+  def self.up
+    create_table "pose_assignments" do |t|
+      t.integer "pose_word_id",               :null => false
+      t.integer "posable_id",                 :null => false
+      t.string  "posable_type", :limit => 40, :null => false
+    end
+    add_index "pose_assignments", :word_id
+    add_index "pose_assignments", :wordable_id
+    create_table "pose_words" do |t|
+      t.string "text", :limit => 80, :null => false
+    end
+    add_index "words", :text
+  end
+  def self.down
+    drop_table 'pose_assignments'
+    drop_table 'pose_words'
+  end
+end

data/lib/pose/posifier.rb ADDED Viewed

@@ -0,0 +1,13 @@
+module Pose
+  module Posifier
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def posify &block
+        include Pose
+        self.pose_content = block_given? ? block : :pose_content.to_proc
+      end
+    end
+  end
+end
+ActiveRecord::Base.send :include, Pose::Posifier

data/lib/pose/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Pose
+  VERSION = "0.0.2"
+end

data/lib/pose.rb ADDED Viewed

@@ -0,0 +1,167 @@
+# Polymorphic search for ActiveRecord objects.
+module Pose
+  extend ActiveSupport::Concern
+  # By default, doesn't run in tests.
+  # Set this to true to test the search functionality.
+  CONFIGURATION = { :search_in_tests => false }
+  included do
+    has_many :pose_assignments, :as => :posable
+    has_many :pose_words, :through => :pose_assignments
+    after_save :update_pose_index
+    before_destroy :delete_pose_index
+    cattr_accessor :pose_content
+  end
+  # Asks if model should perform search.
+  #
+  # @return [false, true]
+  def perform_search?
+    !(Rails.env == 'test' and !CONFIGURATION[:search_in_tests])
+  end
+  module InstanceMethods
+    # Updates the associated words for this object in the database.
+    def update_pose_index
+      update_pose_words if perform_search?
+    end
+    # Removes this objects from the search index.
+    def delete_pose_index
+      self.words.clear if perform_search?
+    end
+    # Helper method.
+    # Updates the search words with the text returned by search_strings.
+    def update_pose_words
+      # Step 1: get an array of all words for the current object.
+      search_string = instance_eval &(self.class.pose_content)
+      new_words = search_string.to_s.split(' ').map { |word| Pose.root_word(word) }.flatten.uniq
+      # Step 2: Add new words to the search index.
+      Pose.get_words_to_add(self.pose_words, new_words).each do |word_to_add|
+        self.pose_words << PoseWord.find_or_create_by_text(word_to_add)
+      end
+      # Step 3: Remove now obsolete words from search index.
+      Pose.get_words_to_remove(self.pose_words, new_words).each do |word_to_remove|
+        self.pose_words.delete word_to_remove
+      end
+    end
+  end
+  class <<self
+    # Returns all strings that are in new_words, but not in existing_words.
+    # Helper method.
+    #
+    # @param [Array<String>] existing_words The words that are already associated with the object.
+    # @param [Array<String>] new_words The words thet the object should have from now on.
+    #
+    # @return [Array<String>] The words that need to be added to the existing_words array.
+    def get_words_to_add existing_words, new_words
+      new_words - existing_words.map(&:text)
+    end
+    # Helper method.
+    # Returns the id of all word objects that are in existing_words, but not in new_words.
+    #
+    # @param [Array<String>] existing_words The words that are already associated with the object.
+    # @param [Array<String>] new_words The words thet the object should have from now on.
+    #
+    # @return [Array<String>] The words that need to be removed from the existing_words array.
+    def get_words_to_remove existing_words, new_words
+      existing_words.map do |existing_word|
+        existing_word unless new_words.include?(existing_word.text)
+      end.compact
+    end
+    # Returns whether the given string is a URL.
+    #
+    # @param [String] word The string to check.
+    #
+    # @return [Boolean]
+    def is_url? word
+      URI::parse(word).scheme == 'http'
+    rescue URI::InvalidURIError
+      false
+    end
+    # Simplifies the given word to a generic search form.
+    #
+    # @param [String] raw_word The word to make searchable.
+    #
+    # @return [String] The stemmed version of the word.
+    def root_word raw_word
+      result = []
+      raw_word_copy = raw_word[0..-1]
+      raw_word_copy.gsub! /[()*<>'",;]/, ' '
+      raw_word_copy.gsub! /\s+/, ' '
+      raw_word_copy.split(' ').each do |word|
+        if Pose.is_url?(word)
+          result.concat word.split(/[\.\/\:]/).delete_if(&:blank?)
+        else
+          word.gsub! /[\-\/\._:]/, ' '
+          word.gsub! /\s+/, ' '
+          word.split(' ').each do |w|
+            stemmed_word =  w.parameterize.singularize
+            result.concat stemmed_word.split ' '
+          end
+        end
+      end
+      result.uniq
+    end
+    # Returns all objects matching the given query.
+    #
+    # @param [String] query
+    # @param [Array<Class>] classes
+    #
+    # @return [Hash<Class, ActiveRecord::Relation>]
+    def search query, classes
+      # Turn 'classes' into an array.
+      classes = [classes].flatten
+      classes_names = classes.map &:name
+      # Get the ids of the results.
+      result_classes_and_ids = {}
+      query.split(' ').each do |query_word|
+        current_word_classes_and_ids = {}
+        classes.each { |clazz| current_word_classes_and_ids[clazz.name] = [] }
+        PoseAssignment.joins(:pose_word) \
+                      .where(:pose_words => {:text.matches => "#{query_word}%"},
+                             :posable_type => classes_names) \
+                      .each do |pose_assignment|
+          current_word_classes_and_ids[pose_assignment.posable_type] << pose_assignment.posable_id
+        end
+        current_word_classes_and_ids.each do |class_name, ids|
+          if result_classes_and_ids.has_key? class_name
+            result_classes_and_ids[class_name] = result_classes_and_ids[class_name] & ids
+          else
+            result_classes_and_ids[class_name] = ids
+          end
+        end
+      end
+      # Load the results by id.
+      {}.tap do |result|
+        result_classes_and_ids.each do |class_name, ids|
+          result_class = Kernel.const_get class_name
+          if ids.any? && classes.include?(result_class)
+            result[result_class] = result_class.where :id => ids
+          else
+            result[result_class] = []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pose_assignment.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# Assigns searchable objects to words in the search index.
+class PoseAssignment < ActiveRecord::Base
+  belongs_to :pose_word
+  belongs_to :posable, :polymorphic => true
+end

data/lib/pose_word.rb ADDED Viewed

@@ -0,0 +1,4 @@
+# A single word in the search index.
+class PoseWord < ActiveRecord::Base
+  has_many :pose_assignments
+end

data/lib/tasks/pose_tasks.rake ADDED Viewed

@@ -0,0 +1,18 @@
+namespace :pose do
+  desc "Deletes and recreates the search index for all instances of the given class."
+  task :reindex_all, [:class_name] => :environment do
+    clazz = Kernel.const_get class_name
+    clazz.find_each do |instance|
+      instance.update_pose_words
+    end
+  end
+  desc "Removes the search index for all instances of the given classes"
+  task :remove_from_index, [:class_name] => :environment do
+    clazz = Kernel.const_get class_name
+    clazz.find_each do |instance|
+      instance.delete_pose_words
+    end
+  end
+end