pose 3.0.0 → 3.1.1

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: pose
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Kevin Goslar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-02 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Pose ('Polymorphic Search') allows fulltext search for ActiveRecord objects.
@@ -115,72 +115,54 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/models/pose/assignment.rb
-- app/models/pose/word.rb
-- db/migrate/20130308144915_pose_install.rb
-- lib/generators/pose/install/install_generator.rb
-- lib/generators/pose/install/templates/install_migration.rb
-- lib/generators/pose/remove/remove_generator.rb
-- lib/generators/pose/remove/templates/remove_migration.rb
-- lib/generators/pose/upgrade/templates/upgrade_migration.rb
-- lib/generators/pose/upgrade/upgrade_generator.rb
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/pose.rb
 - lib/pose/activerecord_base_additions.rb
-- lib/pose/engine.rb
-- lib/pose/helpers.rb
+- lib/pose/assignment.rb
+- lib/pose/jobs/install.rb
+- lib/pose/jobs/reindex_all.rb
+- lib/pose/jobs/remove.rb
+- lib/pose/jobs/uninstall.rb
+- lib/pose/jobs/vacuum.rb
 - lib/pose/model_class_additions.rb
 - lib/pose/query.rb
-- lib/pose/railtie.rb
 - lib/pose/search.rb
 - lib/pose/static_api.rb
 - lib/pose/version.rb
-- lib/pose.rb
+- lib/pose/word.rb
 - lib/tasks/pose_tasks.rake
-- MIT-LICENSE
-- Rakefile
-- README.md
-- spec/dummy/app/models/posable_one.rb
-- spec/dummy/app/models/posable_two.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config.ru
-- spec/dummy/db/development.sqlite3
-- spec/dummy/db/migrate/20130308054001_create_posable_one.rb
-- spec/dummy/db/migrate/20130308054142_create_posable_two.rb
-- spec/dummy/db/migrate/20130708084009_create_users.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
-- spec/dummy/Rakefile
-- spec/dummy/script/rails
+- spec/db/pose.sqlite3
 - spec/factories/assignments.rb
 - spec/factories/posable_one.rb
+- spec/factories/posable_three.rb
 - spec/factories/posable_two.rb
 - spec/factories/user.rb
 - spec/factories/words.rb
-- spec/lib/pose/helpers_spec.rb
+- spec/lib/pose/activerecord_base_additions_spec.rb
+- spec/lib/pose/assignment_spec.rb
+- spec/lib/pose/jobs/reindex_all_spec.rb
+- spec/lib/pose/jobs/remove_spec.rb
+- spec/lib/pose/model_class_additions_spec.rb
 - spec/lib/pose/query_spec.rb
 - spec/lib/pose/search_spec.rb
-- spec/models/assignment_spec.rb
-- spec/models/word_spec.rb
+- spec/lib/pose/word_spec.rb
 - spec/pose_api_spec.rb
 - spec/spec_helper.rb
+- spec/support/config/database.yml
+- spec/support/config/database.yml.example
 - spec/support/matchers.rb
+- spec/support/migrations/20130308054001_create_posable_one.rb
+- spec/support/migrations/20130308054142_create_posable_two.rb
+- spec/support/migrations/20130308054143_create_posable_three.rb
+- spec/support/migrations/20130708084009_create_users.rb
+- spec/support/migrations/20130808084009_setup_pose_specs.rb
+- spec/support/models/posable_one.rb
+- spec/support/models/posable_three.rb
+- spec/support/models/posable_two.rb
+- spec/support/models/user.rb
+- spec/support/spec_manager.rb
 homepage: http://github.com/kevgo/pose
 licenses: []
 metadata: {}
@@ -198,61 +180,48 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A polymorphic, storage-system independent search engine for Ruby on Rails.
 test_files:
-- spec/dummy/app/models/posable_one.rb
-- spec/dummy/app/models/posable_two.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config.ru
-- spec/dummy/db/development.sqlite3
-- spec/dummy/db/migrate/20130308054001_create_posable_one.rb
-- spec/dummy/db/migrate/20130308054142_create_posable_two.rb
-- spec/dummy/db/migrate/20130708084009_create_users.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
-- spec/dummy/Rakefile
-- spec/dummy/script/rails
+- spec/db/pose.sqlite3
 - spec/factories/assignments.rb
 - spec/factories/posable_one.rb
+- spec/factories/posable_three.rb
 - spec/factories/posable_two.rb
 - spec/factories/user.rb
 - spec/factories/words.rb
-- spec/lib/pose/helpers_spec.rb
+- spec/lib/pose/activerecord_base_additions_spec.rb
+- spec/lib/pose/assignment_spec.rb
+- spec/lib/pose/jobs/reindex_all_spec.rb
+- spec/lib/pose/jobs/remove_spec.rb
+- spec/lib/pose/model_class_additions_spec.rb
 - spec/lib/pose/query_spec.rb
 - spec/lib/pose/search_spec.rb
-- spec/models/assignment_spec.rb
-- spec/models/word_spec.rb
+- spec/lib/pose/word_spec.rb
 - spec/pose_api_spec.rb
 - spec/spec_helper.rb
+- spec/support/config/database.yml
+- spec/support/config/database.yml.example
 - spec/support/matchers.rb
+- spec/support/migrations/20130308054001_create_posable_one.rb
+- spec/support/migrations/20130308054142_create_posable_two.rb
+- spec/support/migrations/20130308054143_create_posable_three.rb
+- spec/support/migrations/20130708084009_create_users.rb
+- spec/support/migrations/20130808084009_setup_pose_specs.rb
+- spec/support/models/posable_one.rb
+- spec/support/models/posable_three.rb
+- spec/support/models/posable_two.rb
+- spec/support/models/user.rb
+- spec/support/spec_manager.rb

data/app/models/pose/word.rb

@@ -1,22 +0,0 @@
-# A single word in the search index.
-module Pose
-  class Word < ActiveRecord::Base
-    has_many :assignments, class_name: 'Pose::Assignment', dependent: :destroy
-
-    def self.remove_unused_words progress_bar = nil
-      if Helpers.is_sql_database?
-        # SQL database --> use an optimized query.
-        Word.delete_all(id: Word.select("pose_words.id").
-                                 joins("LEFT OUTER JOIN pose_assignments ON pose_assignments.word_id = pose_words.id").
-                                 group("pose_words.id").
-                                 having("COUNT(pose_assignments.id) = 0"))
-      else
-        # Unknown database --> use the standard Rails API.
-        Word.select(:id).find_each(include: [:assignments], batch_size: 100) do |word|
-          word.delete if word.assignments.size == 0
-          progress_bar.increment if progress_bar
-        end
-      end
-    end
-  end
-end

data/db/migrate/20130308144915_pose_install.rb

@@ -1,18 +0,0 @@
-class PoseInstall < ActiveRecord::Migration
-
-  def change
-    create_table "pose_assignments" do |t|
-      t.integer "word_id",                 null: false
-      t.integer "posable_id",              null: false
-      t.string  "posable_type", limit: 60, null: false
-    end
-    add_index "pose_assignments", :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
-
-end

data/lib/generators/pose/install/install_generator.rb

@@ -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

@@ -1,24 +0,0 @@
-class InstallPose < ActiveRecord::Migration
-
-  def self.up
-    create_table "pose_assignments" do |t|
-      t.integer "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", :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/generators/pose/remove/remove_generator.rb

@@ -1,56 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-
-module Pose
-  module Generators
-
-    class RemoveGenerator < 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 to remove the Pose tables.'
-        say ''
-        migration_template 'remove_migration.rb', 'db/migrate/remove_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 to remove the tables from your database.'
-        say ''
-        say '       rake db:migrate', Thor::Shell::Color::BOLD
-        say ''
-        say ''
-        say '    2. Remove the posify block from all your models.'
-        say '       Here is how it looks like:'
-        say ''
-        say '         class MyClass < ActiveRecord::Base'
-        say '           ...'
-        say ''
-        say '           posify do', Thor::Shell::Color::BOLD
-        say '             ...', Thor::Shell::Color::BOLD
-        say '           end', Thor::Shell::Color::BOLD
-        say ''
-        say '           ...'
-        say '         end'
-        say ''
-        say ''
-        say '  Have an excellent day! :)'
-        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/remove/templates/remove_migration.rb

@@ -1,23 +0,0 @@
-class AddPoseTables < ActiveRecord::Migration
-
-  def self.up
-    drop_table 'pose_assignments'
-    drop_table 'pose_words'
-  end
-
-  def self.down
-    create_table "pose_assignments" do |t|
-      t.integer "word_id",                 null: false
-      t.integer "posable_id",              null: false
-      t.string  "posable_type", limit: 60, null: false
-    end
-    add_index "pose_assignments", :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
-end
-

data/lib/generators/pose/upgrade/templates/upgrade_migration.rb

@@ -1,7 +0,0 @@
-class PoseUpgrade < ActiveRecord::Migration
-
-  def change
-    rename_column :pose_assignments, :pose_word_id, :word_id
-  end
-
-end

data/lib/generators/pose/upgrade/upgrade_generator.rb

@@ -1,35 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-
-module Pose
-  module Generators
-
-    class UpgradeGenerator < 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 to upgrade your Pose tables.'
-        say ''
-        migration_template 'upgrade_migration.rb', 'db/migrate/pose_upgrade.rb'
-        say ''
-      end
-
-      def installation_instructions
-        say '  All done! You need to do is run db:migrate!'
-        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/pose/engine.rb

@@ -1,5 +0,0 @@
-module Pose
-  class Engine < ::Rails::Engine
-    isolate_namespace Pose
-  end
-end

data/lib/pose/helpers.rb

@@ -1,89 +0,0 @@
-# Internal helper methods for the Pose module.
-# TODO: remove
-module Pose
-  module Helpers
-    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
-
-
-      def is_sql_database?
-        ['ActiveRecord::ConnectionAdapters::PostgreSQLAdapter',
-         'ActiveRecord::ConnectionAdapters::SQLite3Adapter'].include? ActiveRecord::Base.connection.class.name
-      end
-
-
-      # Returns whether the given string is a URL.
-      #
-      # @param [String] word The string to check.
-      #
-      # @return [Boolean]
-      def is_url? word
-        /https?:\/\/(\w)+\.(\w+)/ =~ word
-      end
-
-
-      # Makes the given input an array.
-      def make_array input
-        [input].flatten
-      end
-
-
-      # Makes the given input an array.
-      def make_array input
-        [input].flatten
-      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! '%20', ' '
-        raw_word_copy.gsub! /[()*<>'",;\?\-\=&%#]/, ' '
-        raw_word_copy.gsub! /\s+/, ' '
-        raw_word_copy.split(' ').each do |word|
-          if Helpers.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
-
-    end
-  end
-end

data/lib/pose/railtie.rb

@@ -1,19 +0,0 @@
-require "rails/railtie"
-
-module Pose
-
-  class Railtie < Rails::Railtie
-
-    # Add the Pose additions to ActiveRecord::Base once it is loaded.
-    initializer 'Pose.base_additions' do
-      ActiveSupport.on_load :active_record do
-        extend ActiveRecordBaseAdditions
-      end
-    end
-
-    # Load the Pose rake tasks.
-    rake_tasks do
-      load "tasks/pose_tasks.rake"
-    end
-  end
-end