pose 1.2.4 → 1.2.5

data/README.md

@@ -11,9 +11,9 @@ Pose  ("Polymorphic Search") allows fulltext search for ActiveRecord objects in
 * The search is very fast, doing only simple queries over fully indexed columns.
 
 
-# Installation
+## Installation
 
-## Set up the gem.
+### Set up the gem.
 
 Add the gem to your Gemfile and run `bundle install`
 
@@ -21,7 +21,7 @@ Add the gem to your Gemfile and run `bundle install`
 gem 'pose'
 ```
 
-## Create the database tables for pose.
+### Create the database tables for pose.
 
 ```bash
 $ rails generate pose:install
@@ -34,7 +34,7 @@ Pose creates two tables in your database. These tables are automatically populat
 * _pose_assignments_: lists which word occurs in which document.
 
 
-## Make your ActiveRecord models searchable
+### Make your ActiveRecord models searchable
 
 ```ruby
 class MyClass < ActiveRecord::Base
@@ -60,7 +60,7 @@ not only data from this object, but also data from related objects, class names,
 Now that this class is posified, any `create`, `update`, or `delete` operation on any instance of this class will update the search index automatically.
 
 
-## Index existing records in your database
+### Index existing records in your database
 
 Data that existed in your database before adding Pose isn't automatically included in the search index.
 You have to index those records manually once. Future updates will happen automatically.
@@ -70,7 +70,7 @@ 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!
 
 
-# Searching
+## Searching
 
 To search, simply call Pose's `search` method, and tell it the search query as well as in which classes it should search.
 
@@ -135,13 +135,13 @@ result = Pose.search 'foo', MyClass, where: [ public: true, ['user_id <> ?', @cu
 ```
 
 
-# Maintenance
+## Maintenance
 
 Besides an accasional search index cleanup, Pose is relatively maintenance free. 
 The search index is automatically updated when objects are created, updated, or deleted.
 
 
-## Optimizing the search index
+### Optimizing the search index
 
 For performance reasons, the search index keeps all the words that were ever used around, in order to try to reuse them as much as possible.
 After deleting or changing a large number of objects, you can shrink the memory consumption of Pose's search index by 
@@ -152,7 +152,7 @@ $ rake pose:index:vacuum
 ```
 
 
-## Recreating the search index from scratch
+### Recreating the search index from scratch
 To index existing data in your database, or after loading additional data outside of ActiveRecord into your database,
 you should recreate the search index from scratch.
 
@@ -172,7 +172,7 @@ rails generate pose:remove
 Also don't forget to remove the `posify` block from your models as well as the gem entry from your Gemfile.
 
 
-# Use Pose in your tests
+## Use Pose in your tests
 
 By default, Pose doesn't run in Rails' `test` environment. This is to not slow down tests due to constant updating of the search index when objects are created.
 If you want to test your models search functionality, you need to enable searching in tests:
@@ -184,14 +184,13 @@ Pose::CONFIGURATION[:search_in_tests] = true
 Please don't forget to set this value to `false` when you are done, or your remaining tests will be slow. A good place to enable/disable this flag is in before/after blocks of your test cases.
 
 
-# Development
+## Development
 
 If you find a bug, have a question, or a better idea, please open an issue on the
 <a href="https://github.com/kevgo/pose/issues">Pose issue tracker</a>.
 Or, clone the repository, make your changes, and submit a pull request.
 
-
-## Run the unit tests for the Pose Gem
+### Run the unit tests for the Pose Gem
 
 Pose uses Postgresql for tests, since it is the most strict database.
 To run tests, first, create a test database.
@@ -207,7 +206,7 @@ $ rake spec
 ```
 
 
-## Road Map
+### Road Map
 
 * add `join` to search parameters
 * pagination of search results

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

@@ -0,0 +1,56 @@
+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/remove/remove_generator.rb

@@ -0,0 +1,56 @@
+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/pose/version.rb

@@ -1,3 +1,3 @@
 module Pose
-  VERSION = "1.2.4"
+  VERSION = "1.2.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pose
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -197,10 +197,10 @@ files:
 - doc/PoseMigrations.html
 - doc/PoseWord.html
 - doc/top-level-namespace.html
-- lib/generators/pose_generator.rb
-- lib/generators/remove_pose_generator.rb
-- lib/generators/templates/add_migration.rb
-- lib/generators/templates/remove_migration.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/pose/activerecord_base_additions.rb
 - lib/pose/internal_helpers.rb
 - lib/pose/model_additions.rb
@@ -210,10 +210,6 @@ files:
 - lib/pose/static_api.rb
 - lib/pose/version.rb
 - lib/pose.rb
-- lib/rails/generators/pose/pose_generator.rb
-- lib/rails/generators/pose/remove_pose_generator.rb
-- lib/rails/generators/templates/add_migration.rb
-- lib/rails/generators/templates/remove_migration.rb
 - lib/tasks/pose_tasks.rake
 - MIT-LICENSE
 - Rakefile

data/lib/generators/pose_generator.rb

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

data/lib/generators/remove_pose_generator.rb

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

data/lib/rails/generators/pose/pose_generator.rb

@@ -1,21 +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('../templates', __FILE__)
-
-      def create_migration_file
-        migration_template 'add_migration.rb', 'db/migrate/add_pose.rb'
-      end
-
-      def self.next_migration_number(path)
-          Time.now.utc.strftime("%Y%m%d%H%M%S")
-      end
-    end
-
-  end
-end

data/lib/rails/generators/pose/remove_pose_generator.rb

@@ -1,21 +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('../templates', __FILE__)
-
-      def create_migration_file
-        migration_template 'remove_migration.rb', 'db/migrate/remove_pose.rb'
-      end
-
-      def self.next_migration_number(path)
-          Time.now.utc.strftime("%Y%m%d%H%M%S")
-      end
-    end
-
-  end
-end

data/lib/rails/generators/templates/add_migration.rb

@@ -1,24 +0,0 @@
-class AddPoseTables < 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/rails/generators/templates/remove_migration.rb

@@ -1,25 +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 "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
-end
-