RubyGems - pose - Versions diffs - 1.3.4 → 2.0.0 - Mend

pose 1.3.4 → 2.0.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 (76) hide show

data/README.md +11 -0
data/Rakefile +4 -2
data/app/models/pose/assignment.rb +34 -0
data/app/models/pose/word.rb +24 -0
data/db/migrate/20130308144915_pose_install.rb +18 -0
data/lib/generators/pose/remove/templates/remove_migration.rb +3 -5
data/lib/generators/pose/upgrade/templates/upgrade_migration.rb +9 -0
data/lib/generators/pose/upgrade/upgrade_generator.rb +35 -0
data/lib/pose/activerecord_base_additions.rb +5 -2
data/lib/pose/engine.rb +5 -0
data/lib/pose/internal_helpers.rb +13 -7
data/lib/pose/{model_additions.rb → model_class_additions.rb} +8 -8
data/lib/pose/railtie.rb +1 -2
data/lib/pose/static_api.rb +5 -6
data/lib/pose/version.rb +1 -1
data/lib/pose.rb +5 -7
data/lib/tasks/pose_tasks.rake +27 -29
data/spec/dummy/Rakefile +7 -0
data/spec/{support/models.rb → dummy/app/models/posable_one.rb} +1 -4
data/spec/dummy/app/models/posable_two.rb +5 -0
data/spec/dummy/config/application.rb +59 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +67 -0
data/spec/dummy/config/environments/test.rb +37 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +2 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/db/migrate/20130308054001_create_posable_one.rb +8 -0
data/spec/dummy/db/migrate/20130308054142_create_posable_two.rb +9 -0
data/spec/dummy/db/schema.rb +41 -0
data/spec/dummy/script/rails +6 -0
data/spec/factories/assignments.rb +8 -0
data/spec/factories/posable_one.rb +5 -0
data/spec/factories/words.rb +7 -0
data/spec/internal_helpers_spec.rb +40 -42
data/spec/models/assignment_spec.rb +46 -0
data/spec/models/word_spec.rb +42 -0
data/spec/pose_api_spec.rb +198 -196
data/spec/spec_helper.rb +21 -77
data/spec/support/matchers.rb +0 -1
metadata +83 -102
data/doc/Pose/InstanceMethods.html +0 -341
data/doc/Pose.html +0 -774
data/doc/PoseAssignment.html +0 -125
data/doc/PoseGenerator.html +0 -255
data/doc/PoseMigrations.html +0 -261
data/doc/PoseWord.html +0 -125
data/doc/_index.html +0 -134
data/doc/class_list.html +0 -47
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -55
data/doc/css/style.css +0 -322
data/doc/file_list.html +0 -46
data/doc/frames.html +0 -13
data/doc/index.html +0 -134
data/doc/js/app.js +0 -205
data/doc/js/full_list.js +0 -167
data/doc/js/jquery.js +0 -16
data/doc/method_list.html +0 -150
data/doc/top-level-namespace.html +0 -172
data/lib/generators/pose/install/install_generator.rb +0 -56
data/lib/generators/pose/install/templates/install_migration.rb +0 -24
data/lib/pose/models/pose_assignment.rb +0 -31
data/lib/pose/models/pose_word.rb +0 -28
data/spec/factories.rb +0 -15
data/spec/pose_assignment_spec.rb +0 -45
data/spec/pose_word_spec.rb +0 -26

data/doc/method_list.html DELETED Viewed

@@ -1,150 +0,0 @@
-<!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 DELETED Viewed

@@ -1,172 +0,0 @@
-<!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/install/install_generator.rb DELETED Viewed

@@ -1,56 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-module Pose
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
-      def create_migration_file
-        say ''
-        say '  Creating database migration for the Pose tables.'
-        say ''
-        migration_template 'install_migration.rb', 'db/migrate/install_pose.rb'
-        say ''
-      end
-      def installation_instructions
-        say ''
-        say '  All done! You need to do two things now:'
-        say ''
-        say '    1. Run the database migration'
-        say ''
-        say '       rake db:migrate', Thor::Shell::Color::BOLD
-        say ''
-        say ''
-        say '    2. Add a posify block to all your models.'
-        say '       Here is an example:'
-        say ''
-        say '         class MyClass < ActiveRecord::Base'
-        say '           ...'
-        say ''
-        say '           posify do', Thor::Shell::Color::BOLD
-        say '             # return searchable text as a string here', Thor::Shell::Color::BOLD
-        say '           end', Thor::Shell::Color::BOLD
-        say ''
-        say '           ...'
-        say '         end'
-        say ''
-        say ''
-        say '  Happy searching! :)'
-        say ''
-      end
-      private
-      # Helper method for creating the migration.
-      def self.next_migration_number(path)
-          Time.now.utc.strftime("%Y%m%d%H%M%S")
-      end
-    end
-  end
-end

data/lib/generators/pose/install/templates/install_migration.rb DELETED Viewed

@@ -1,24 +0,0 @@
-class InstallPose < 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", :pose_word_id
-    add_index "pose_assignments", :posable_id
-    create_table "pose_words" do |t|
-      t.string "text", limit: 80, null: false
-    end
-    add_index "pose_words", :text
-  end
-  def self.down
-    drop_table 'pose_assignments'
-    drop_table 'pose_words'
-  end
-end

data/lib/pose/models/pose_assignment.rb DELETED Viewed

@@ -1,31 +0,0 @@
-# Assigns searchable objects to words in the search index.
-class PoseAssignment < ActiveRecord::Base
-  belongs_to :pose_word
-  belongs_to :posable, polymorphic: true
-  attr_accessible :pose_word, :posable
-  # Removes all PoseAssignments for the given class.
-  def self.delete_class_index clazz
-    PoseAssignment.delete_all(['posable_type=?', clazz.name])
-  end
-  # Removes all PoseAssignments that aren't used anymore.
-  def self.cleanup_orphaned_pose_assignments progress_bar = nil
-    PoseAssignment.find_each(include: [:posable, :pose_word], batch_size: 5000) do |assignment|
-      progress_bar.increment if progress_bar
-      # Delete the assignment if the posable object no longer exists.
-      if assignment.posable.nil?
-        puts "deleting assignment '#{assignment.id}' because the posable object no longer exists."
-        assignment.delete
-        next
-      end
-      # Delete the assignment if the PoseWord for it no longer exists.
-      if assignment.pose_word.nil?
-        puts "deleting assignment '#{assignment.id}' because its word no longer exists."
-        assignment.delete
-      end
-    end
-  end
-end

data/lib/pose/models/pose_word.rb DELETED Viewed

@@ -1,28 +0,0 @@
-# A single word in the search index.
-class PoseWord < ActiveRecord::Base
-  has_many :pose_assignments
-  attr_accessible :text
-  def self.remove_unused_words progress_bar = nil
-    if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
-      # Will generate something like:
-      #
-      # DELETE FROM "pose_words" WHERE "pose_words"."id" IN
-      # (SELECT "pose_words"."id" FROM "pose_words" INNER JOIN "pose_assignments" ON "pose_assignments"."pose_word_id" = "pose_words"."id"
-      # HAVING.... GROUP BY "pose_words"."id")
-      PoseWord.delete_all(id: PoseWord.select("pose_words.id").
-                          joins("LEFT OUTER JOIN pose_assignments ON pose_assignments.pose_word_id = pose_words.id").
-                          group("pose_words.id").
-                          having("COUNT(pose_assignments.id) = 0"))
-    else
-      # NOTE (SZ): do not use find_each uses batch_size == 100.
-      # Use find_in_batches instead.
-      #
-      PoseWord.select(:id).find_in_batches.each(include: [:pose_assignments], batch_size: 5000) do |pose_word|
-        pose_word.delete if pose_word.pose_assignments.size == 0
-        progress_bar.increment if progress_bar
-      end
-    end
-  end
-end

data/spec/factories.rb DELETED Viewed

@@ -1,15 +0,0 @@
-FactoryGirl.define do
-  factory :pose_word do
-    text { Faker::Lorem.words(1).first }
-  end
-  factory :pose_assignment do
-    pose_word
-    posable factory: :posable_one
-  end
-  factory :posable_one do
-    text { Faker::Lorem.words(3).join ' ' }
-  end
-end

data/spec/pose_assignment_spec.rb DELETED Viewed

@@ -1,45 +0,0 @@
-require 'spec_helper'
-describe PoseAssignment do
-  describe "delete_class_index" do
-    before :each do
-      FactoryGirl.create :pose_assignment, posable_id: 1, posable_type: 'PosableOne'
-      FactoryGirl.create :pose_assignment, posable_id: 2, posable_type: 'PosableTwo'
-      PoseAssignment.delete_class_index PosableOne
-    end
-    it "deletes all PoseAssignments for the given class" do
-      PoseAssignment.where(posable_type: 'PosableOne').should have(0).items
-    end
-    it "doesn't delete PoseAssignments for other classes" do
-      PoseAssignment.where(posable_type: 'PosableTwo').should have(1).items
-    end
-  end
-  describe "cleanup_orphaned_pose_assignments" do
-    it "deletes the assignment if the posable object doesn't exist" do
-      FactoryGirl.create :pose_assignment, posable_id: 2, posable_type: 'PosableOne'
-      PoseAssignment.count.should > 0
-      PoseAssignment.cleanup_orphaned_pose_assignments
-      PoseAssignment.count.should == 0
-    end
-    it "deletes the assignment if the pose_word doesn't exist" do
-      assignment = FactoryGirl.create :pose_assignment, pose_word: nil, pose_word_id: 27
-      PoseAssignment.cleanup_orphaned_pose_assignments
-      PoseAssignment.find_by_id(assignment.id).should be_nil
-    end
-    it "doesn't delete the assignment if it is still used" do
-      assignment = FactoryGirl.create :pose_assignment
-      PoseAssignment.cleanup_orphaned_pose_assignments
-      PoseAssignment.find_by_id(assignment.id).should_not be_nil
-    end
-  end
-end

data/spec/pose_word_spec.rb DELETED Viewed

@@ -1,26 +0,0 @@
-require 'spec_helper'
-describe PoseWord do
-  describe 'class methods' do
-    subject { PoseWord }
-    describe '::remove_unused_words' do
-      before :each do
-        instantiate_objects
-        PoseWord.remove_unused_words
-      end
-      context 'having unused words' do
-        let(:instantiate_objects) { FactoryGirl.create :pose_word }
-        its(:count) { should == 0 }
-      end
-      context 'having used words' do
-        let(:instantiate_objects) { FactoryGirl.create :posable_one }
-        its(:count) { should > 0 }
-      end
-    end
-  end
-end