pose 1.3.4 → 2.0.0

data/README.md

@@ -70,6 +70,17 @@ To index all entries of `MyClass`, run `rake pose:reindex_all[MyClass]` on the c
 At this point, you are all set up. Let's perform a search!
 
 
+## Upgrading from version 1.x
+
+Version 2 is a proper Rails engine, and comes with a slightly different database table schema.
+Upgrading is as simple as
+
+```bash
+$ rails generate pose:upgrade
+$ rake db:migrate
+```
+
+
 ## Searching
 
 To search, simply call Pose's `search` method, and tell it the search query as well as in which classes it should search.

data/Rakefile

@@ -1,14 +1,16 @@
 #!/usr/bin/env rake
-require 'rake/dsl_definition' 
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
-require 'rspec/core/rake_task'
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
 # RSpec tasks.
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new :spec
 task :default => :spec

data/app/models/pose/assignment.rb

@@ -0,0 +1,34 @@
+# Assigns searchable objects to words in the search index.
+module Pose
+  class Assignment < ActiveRecord::Base
+    attr_accessible :word, :posable
+
+    belongs_to :word, class_name: 'Pose::Word'
+    belongs_to :posable, polymorphic: true
+
+    # Removes all Assignments for the given class.
+    def self.delete_class_index clazz
+      Assignment.delete_all(posable_type: clazz.name)
+    end
+
+    # Removes all Assignments that aren't used anymore.
+    def self.cleanup_orphaned_pose_assignments progress_bar = nil
+      Assignment.find_each(include: [:posable, :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 Pose::Word for it no longer exists.
+        if assignment.word.nil?
+          puts "deleting assignment '#{assignment.id}' because its word no longer exists."
+          assignment.delete
+        end
+      end
+    end
+  end
+end

data/app/models/pose/word.rb

@@ -0,0 +1,24 @@
+# A single word in the search index.
+module Pose
+  class Word < ActiveRecord::Base
+    attr_accessible :text
+
+    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

@@ -0,0 +1,18 @@
+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/remove/templates/remove_migration.rb

@@ -7,18 +7,16 @@ class AddPoseTables < ActiveRecord::Migration
 
   def self.down
     create_table "pose_assignments" do |t|
-      t.integer "pose_word_id",            null: false
+      t.integer "word_id",                 null: false
       t.integer "posable_id",              null: false
-      t.string  "posable_type", limit: 40, null: false
+      t.string  "posable_type", limit: 60, null: false
     end
-
-    add_index "pose_assignments", :pose_word_id
+    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

@@ -0,0 +1,9 @@
+class PoseUpgrade < ActiveRecord::Migration
+
+  def change
+    change_table 'pose_assignments' do |t|
+      t.rename :pose_word_id, :word_id
+    end
+  end
+
+end

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

@@ -0,0 +1,35 @@
+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/activerecord_base_additions.rb

@@ -2,9 +2,12 @@
 module Pose
   module ActiveRecordBaseAdditions
 
+    # Defines the searchable content in ActiveRecord objects.
     def posify &block
-      raise "You must provide a block that returns the searchable content to 'posify'." unless block_given?
-      include Pose::ModelAdditions
+      raise "Error while posifying class '#{name}': " \
+            "You must provide a block that returns the searchable content to 'posify'." unless block_given?
+
+      include ModelClassAdditions
       self.pose_content = block
     end
 

data/lib/pose/engine.rb

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

data/lib/pose/internal_helpers.rb

@@ -29,6 +29,12 @@ module Pose
       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.
@@ -54,11 +60,11 @@ module Pose
       # Returns a hash mapping classes to ids for the a single given word.
       def search_classes_and_ids_for_word word, class_names
         result = {}.tap { |hash| class_names.each { |class_name| hash[class_name] = [] }}
-        query = PoseAssignment.joins(:pose_word) \
-                              .select('pose_assignments.posable_id, pose_assignments.posable_type') \
-                              .where('pose_words.text LIKE ?', "#{word}%") \
-                              .where('posable_type IN (?)', class_names)
-        PoseAssignment.connection.select_all(query.to_sql).each do |pose_assignment|
+        query = Pose::Assignment.joins(:word) \
+                          .select('pose_assignments.posable_id, pose_assignments.posable_type') \
+                          .where('pose_words.text LIKE ?', "#{word}%") \
+                          .where('posable_type IN (?)', class_names)
+        Pose::Assignment.connection.select_all(query.to_sql).each do |pose_assignment|
           result[pose_assignment['posable_type']] << pose_assignment['posable_id'].to_i
         end
         result
@@ -73,7 +79,7 @@ module Pose
 
       # Returns the search terms that are contained in the given query.
       def query_terms query
-        query.split(' ').map{|query_word| Pose::Helpers.root_word query_word}.flatten.uniq
+        query.split(' ').map{|query_word| Helpers.root_word query_word}.flatten.uniq
       end
 
       # Simplifies the given word to a generic search form.
@@ -88,7 +94,7 @@ module Pose
         raw_word_copy.gsub! /[()*<>'",;\?\-\=&%#]/, ' '
         raw_word_copy.gsub! /\s+/, ' '
         raw_word_copy.split(' ').each do |word|
-          if Pose::Helpers.is_url?(word)
+          if Helpers.is_url?(word)
             result.concat word.split(/[\.\/\:]/).delete_if(&:blank?)
           else
             word.gsub! /[\-\/\._:]/, ' '

data/lib/pose/{model_additions.rb → model_class_additions.rb}

@@ -1,11 +1,11 @@
-# Additions to posified ActiveRecord models.
+# Additions to posified ActiveRecord classes.
 module Pose
-  module ModelAdditions
+  module ModelClassAdditions
     extend ActiveSupport::Concern
 
     included do
-      has_many :pose_assignments, as: :posable, dependent: :delete_all
-      has_many :pose_words, through: :pose_assignments
+      has_many :pose_assignments, class_name: 'Pose::Assignment', as: :posable, dependent: :delete_all
+      has_many :pose_words, through: :pose_assignments, class_name: 'Pose::Word', source: :word
 
       after_save :update_pose_index
       before_destroy :delete_pose_index
@@ -29,15 +29,15 @@ module Pose
 
       # Step 1: get an array of all words for the current object.
       search_text = instance_eval &(self.class.pose_content)
-      new_words = Pose::Helpers.query_terms search_text.to_s
+      new_words = Helpers.query_terms search_text.to_s
 
       # Step 2: Add new words to the search index.
-      Pose::Helpers.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)
+      Helpers.get_words_to_add(self.pose_words, new_words).each do |word_to_add|
+        self.pose_words << Word.find_or_create_by_text(word_to_add)
       end
 
       # Step 3: Remove now obsolete words from search index.
-      Pose::Helpers.get_words_to_remove(self.pose_words, new_words).each do |word_to_remove|
+      Helpers.get_words_to_remove(self.pose_words, new_words).each do |word_to_remove|
         self.pose_words.delete word_to_remove
       end
     end

data/lib/pose/railtie.rb

@@ -7,7 +7,7 @@ module Pose
     # Add the Pose additions to ActiveRecord::Base once it is loaded.
     initializer 'Pose.base_additions' do
       ActiveSupport.on_load :active_record do
-        extend Pose::ActiveRecordBaseAdditions
+        extend ActiveRecordBaseAdditions
       end
     end
 
@@ -16,5 +16,4 @@ module Pose
       load "tasks/pose_tasks.rake"
     end
   end
-
 end

data/lib/pose/static_api.rb

@@ -17,7 +17,7 @@ module Pose
     # @return [Array<String>]
     def autocomplete_words query
       return [] if query.blank?
-      PoseWord.where('text LIKE ?', "#{Pose::Helpers.root_word(query)[0]}%").map(&:text)
+      Word.where('text LIKE ?', "#{Helpers.root_word(query)[0]}%").map(&:text)
     end
 
 
@@ -41,11 +41,11 @@ module Pose
 
 
       # Get the ids of the results.
-      class_names = Pose::Helpers.make_array(classes).map &:name
+      class_names = Helpers.make_array(classes).map &:name
       result_classes_and_ids = {}
-      Pose::Helpers.query_terms(query).each do |query_word|
-        Pose::Helpers.search_classes_and_ids_for_word(query_word, class_names).each do |class_name, ids|
-          Pose::Helpers.merge_search_result_word_matches result_classes_and_ids, class_name, ids
+      Helpers.query_terms(query).each do |query_word|
+        Helpers.search_classes_and_ids_for_word(query_word, class_names).each do |class_name, ids|
+          Helpers.merge_search_result_word_matches result_classes_and_ids, class_name, ids
         end
       end
 
@@ -92,6 +92,5 @@ module Pose
         end
       end
     end
-
   end
 end

data/lib/pose/version.rb

@@ -1,3 +1,3 @@
 module Pose
-  VERSION = "1.3.4"
+  VERSION = "2.0.0"
 end

data/lib/pose.rb

@@ -1,11 +1,9 @@
-# Note (KG): Need to include the rake DSL here to prevent deprecation warnings in the Rakefile.
-require 'rake'
-include Rake::DSL if defined? Rake::DSL
-
+require "pose/engine"
 require 'pose/static_api'
 require 'pose/internal_helpers'
 require 'pose/activerecord_base_additions'
-require 'pose/model_additions'
+require 'pose/model_class_additions'
 require 'pose/railtie' if defined? Rails
-require 'pose/models/pose_assignment'
-require 'pose/models/pose_word'
+
+module Pose
+end

data/lib/tasks/pose_tasks.rake

@@ -1,40 +1,38 @@
 include Rake::DSL if defined?(Rake::DSL)
 require 'ruby-progressbar'
-namespace :pose do
 
-  namespace :index do
+namespace :pose do
 
-    desc "Cleans out unused data from the search index."
-    task :vacuum => :environment do |t, args|
-      puts "Cleaning Pose search index ...\n\n"
-      progress_bar = ProgressBar.create title: '  assignments', total: PoseAssignment.count
-      PoseAssignment.cleanup_orphaned_pose_assignments progress_bar
-      progress_bar.finish
+  desc "Cleans out unused data from the search index."
+  task :vacuum => :environment do |t, args|
+    puts "Cleaning Pose search index ...\n\n"
+    progress_bar = ProgressBar.create title: '  assignments', total: Pose::Assignment.count
+    Pose::Assignment.cleanup_orphaned_pose_assignments progress_bar
+    progress_bar.finish
 
-      progress_bar = ProgressBar.create title: '  words', total: PoseWord.count
-      PoseWord.remove_unused_words progress_bar
-      progress_bar.finish
+    progress_bar = ProgressBar.create title: '  words', total: Pose::Word.count
+    Pose::Word.remove_unused_words progress_bar
+    progress_bar.finish
 
-      puts "\nPose search index cleanup complete.\n\n"
-    end
+    puts "\nPose search index cleanup complete.\n\n"
+  end
 
-    desc "Removes the search index for all instances of the given classes."
-    task :remove, [:class_name] => :environment do |t, args|
-      clazz = args.class_name.constantize
-      PoseAssignment.cleanup_class_index clazz
-      puts "Search index for class #{clazz.name} deleted.\n\n"
-    end
+  desc "Removes the search index for all instances of the given classes."
+  task :remove, [:class_name] => :environment do |t, args|
+    clazz = args.class_name.constantize
+    Pose::Assignment.delete_class_index clazz
+    puts "Search index for class #{clazz.name} deleted.\n\n"
+  end
 
-    desc "Deletes and recreates the search index for all instances of the given class."
-    task :reindex_all, [:class_name] => [:environment] do |t, args|
-      clazz = args.class_name.constantize
-      progress_bar = ProgressBar.create title: "  reindexing", total: clazz.count
-      clazz.find_each do |instance|
-        instance.update_pose_words
-        progress_bar.increment
-      end
-      progress_bar.finish
+  desc "Deletes and recreates the search index for all instances of the given class."
+  task :reindex_all, [:class_name] => [:environment] do |t, args|
+    clazz = args.class_name.constantize
+    progress_bar = ProgressBar.create title: "  reindexing", total: clazz.count
+    clazz.find_each do |instance|
+      instance.update_pose_words
+      progress_bar.increment
     end
-
+    progress_bar.finish
   end
+
 end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/{support/models.rb → dummy/app/models/posable_one.rb}

@@ -1,8 +1,5 @@
 class PosableOne < ActiveRecord::Base
-  posify { text }
-end
+  attr_accessible :text
 
-class PosableTwo < ActiveRecord::Base
   posify { text }
 end
-

data/spec/dummy/app/models/posable_two.rb

@@ -0,0 +1,5 @@
+class PosableTwo < ActiveRecord::Base
+  attr_accessible :text
+
+  posify { text }
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "pose"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end