watson-acts_as_ferret 0.4.8.2

data/doc/demo/config/database.yml

@@ -0,0 +1,38 @@
+# MySQL (default setup).  Versions 4.1 and 5.0 are recommended.
+#
+# Get the fast C bindings:
+#   gem install mysql
+#   (on OS X: gem install mysql -- --include=/usr/local/lib)
+# And be sure to use new-style password hashing:
+#   http://dev.mysql.com/doc/refman/5.0/en/old-client.html
+#
+# mysql config
+development:
+  adapter: mysql
+  database: aaf_dev
+  username: ferret
+  password: ferret
+  
+test:
+  adapter: mysql
+  database: aaf_test
+  username: ferret
+  password: ferret
+
+# since this is a demo, we won't need this one
+#production:
+#  adapter: mysql
+#  database: ferret_production
+#  username: root
+#  password: 
+#  socket: /var/run/mysqld/mysqld.sock
+
+# SQLITE
+#development:
+#  adapter: sqlite3
+#  dbfile: db/dev.sqlite
+
+#test:
+#  adapter: sqlite3
+#  dbfile: db/test.sqlite
+

data/doc/demo/config/environment.rb

@@ -0,0 +1,69 @@
+# Be sure to restart your web server when you modify this file.
+
+# Uncomment below to force Rails into production mode when 
+# you don't control web/app server and can't set it the proper way
+# ENV['RAILS_ENV'] ||= 'production'
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence those specified here
+  
+  config.action_controller.session = { :session_key => "_demo_session", :secret => "aaaaaaaaaaaaaaaabbbbbbbbbbbbbbccccccccccccccsome secret phrase" }
+  
+  # Skip frameworks you're not going to use
+  # config.frameworks -= [ :action_web_service, :action_mailer ]
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Force all environments to use the same logger level 
+  # (by default production uses :info, the others :debug)
+  # config.log_level = :debug
+
+  # Use the database for sessions instead of the file system
+  # (create the session table with 'rake create_sessions_table')
+  # config.action_controller.session_store = :active_record_store
+
+  # Enable page/fragment caching by setting a file-based store
+  # (remember to create the caching directory and make it readable to the application)
+  # config.action_controller.fragment_cache_store = :file_store, "#{RAILS_ROOT}/cache"
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector
+
+  # Make Active Record use UTC-base instead of local time
+  # config.active_record.default_timezone = :utc
+  
+  # Use Active Record's schema dumper instead of SQL when creating the test database
+  # (enables use of different database adapters for development and test environments)
+  # config.active_record.schema_format = :ruby
+
+  # See Rails::Configuration for more options
+end
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# Include your application configuration below
+
+ActsAsFerret::remote = false if ENV['AAF_REMOTE'] != 'true'
+ActsAsFerret::raise_drb_errors = ENV['RAISE_DRB_ERRORS'] == 'true'
+
+# define the index shared by the SharedIndex1 and SharedIndex2 classes
+ActsAsFerret::define_index 'shared', :remote           => ENV['AAF_REMOTE'] == 'true',
+                                     :raise_drb_errors => ENV['RAISE_DRB_ERRORS'] == 'true',
+                                     :fields           => {
+                                       :name => { :store => :yes }
+                                     }, 
+                                     :ferret           => {
+                                       :default_field => [ :name ]
+                                     }
+

data/doc/demo/config/environments/development.rb

@@ -0,0 +1,16 @@
+# Settings specified here will take precedence over those in config/environment.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 webserver 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.action_controller.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

data/doc/demo/config/environments/production.rb

@@ -0,0 +1,19 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Use a different logger for distributed setups
+# config.logger        = SyslogLogger.new
+
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host                  = "http://assets.example.com"
+
+# Disable delivery errors if you bad email addresses should just be ignored
+# config.action_mailer.raise_delivery_errors = false

data/doc/demo/config/environments/test.rb

@@ -0,0 +1,21 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils    = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Tell ActionMailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+#config.log_level = :info

data/doc/demo/config/ferret_server.yml

@@ -0,0 +1,18 @@
+production:
+  host: ferret.yourdomain.com
+  port: 9010
+  pid_file: log/ferret.pid
+development:
+  host: localhost
+  port: 9010
+  pid_file: log/ferret.pid
+  log_file: log/ferret_server_dev.log
+  log_level: info
+test:
+  socket: /tmp/ferret.sock
+#  host: localhost
+#  port: 9009
+  pid_file: log/ferret.pid
+  log_file: log/ferret_server_test.log
+  log_level: debug
+

data/doc/demo/config/lighttpd.conf

@@ -0,0 +1,40 @@
+# Default configuration file for the lighttpd web server
+# Start using ./script/server lighttpd
+
+server.port = 3001
+
+server.modules           = ( "mod_rewrite", "mod_accesslog", "mod_fastcgi" )
+server.error-handler-404 = "/dispatch.fcgi"
+server.document-root     = CWD + "/public/"
+
+server.errorlog          = CWD + "/log/lighttpd.error.log"
+accesslog.filename       = CWD + "/log/lighttpd.access.log"
+
+url.rewrite              = ( "^/$" => "index.html", "^([^.]+)$" => "$1.html" )
+
+# Change *-procs to 2 if you need to use Upload Progress or other tasks that
+# *need* to execute a second request while the first is still pending.
+fastcgi.server = ( ".fcgi" =>
+  ( "localhost" =>
+      (
+        "min-procs" => 1, 
+        "max-procs" => 1,
+        "socket"    => CWD + "/tmp/sockets/fcgi.socket",
+        "bin-path"  => CWD + "/public/dispatch.fcgi",
+        "bin-environment" => ( "RAILS_ENV" => "development" )
+      )
+  )
+)
+
+mimetype.assign = (  
+  ".css"        =>  "text/css",
+  ".gif"        =>  "image/gif",
+  ".htm"        =>  "text/html",
+  ".html"       =>  "text/html",
+  ".jpeg"       =>  "image/jpeg",
+  ".jpg"        =>  "image/jpeg",
+  ".js"         =>  "text/javascript",
+  ".png"        =>  "image/png",
+  ".swf"        =>  "application/x-shockwave-flash",
+  ".txt"        =>  "text/plain"
+)

data/doc/demo/config/routes.rb

@@ -0,0 +1,9 @@
+ActionController::Routing::Routes.draw do |map|
+
+  map.resources :contents
+  map.search 'search', :controller => 'searches', :action => 'search'
+
+
+  # Install the default route as the lowest priority.
+  map.connect ':controller/:action/:id'
+end

data/doc/demo/db/development_structure.sql

@@ -0,0 +1,15 @@
+CREATE TABLE `comments` (
+  `id` int(11) NOT NULL auto_increment,
+  `author` varchar(100) NOT NULL default '',
+  `content` text NOT NULL,
+  `content_id` int(11) default NULL,
+  PRIMARY KEY  (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+CREATE TABLE `contents` (
+  `id` int(11) NOT NULL auto_increment,
+  `title` varchar(100) NOT NULL default '',
+  `description` text NOT NULL,
+  PRIMARY KEY  (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+

data/doc/demo/db/migrate/001_initial_migration.rb

@@ -0,0 +1,18 @@
+class InitialMigration < ActiveRecord::Migration
+  def self.up
+    create_table "comments" do |t|
+      t.column "author", :string, :limit => 100
+      t.column "content", :text
+      t.column "content_id", :integer
+    end
+    create_table "contents" do |t|
+      t.column "title", :string, :limit => 100
+      t.column "description", :text
+    end
+  end
+
+  def self.down
+    drop_table "comments"
+    drop_table "contents"
+  end
+end

data/doc/demo/db/migrate/002_add_type_to_contents.rb

@@ -0,0 +1,9 @@
+class AddTypeToContents < ActiveRecord::Migration
+  def self.up
+    add_column :contents, :type, :string
+  end
+
+  def self.down
+    remove_column :contents, :type
+  end
+end

data/doc/demo/db/migrate/003_create_shared_index1s.rb

@@ -0,0 +1,11 @@
+class CreateSharedIndex1s < ActiveRecord::Migration
+  def self.up
+    create_table :shared_index1s do |t|
+      t.column :name, :string
+    end
+  end
+
+  def self.down
+    drop_table :shared_index1s
+  end
+end

data/doc/demo/db/migrate/004_create_shared_index2s.rb

@@ -0,0 +1,11 @@
+class CreateSharedIndex2s < ActiveRecord::Migration
+  def self.up
+    create_table :shared_index2s do |t|
+      t.column :name, :string
+    end
+  end
+
+  def self.down
+    drop_table :shared_index2s
+  end
+end

data/doc/demo/db/migrate/005_special_field.rb

@@ -0,0 +1,9 @@
+class SpecialField < ActiveRecord::Migration
+  def self.up
+    add_column :contents, :special, :string
+  end
+
+  def self.down
+    remove_column :contents, :special
+  end
+end

data/doc/demo/db/migrate/006_create_stats.rb

@@ -0,0 +1,15 @@
+class CreateStats < ActiveRecord::Migration
+  def self.up
+    create_table :stats do |t|
+      t.integer :process_id, :processing_time, :open_connections
+      t.string :kind, :info
+      t.datetime :created_at
+    end
+    add_index :stats, 'kind'
+  end
+
+  def self.down
+ #   remove_index :stats, 'kind'
+    drop_table :stats
+  end
+end

data/doc/demo/db/schema.sql

@@ -0,0 +1,18 @@
+drop table if exists contents;
+create table contents (
+  id int not null auto_increment,
+  type varchar(255) not null,
+  title varchar(100) not null,
+  description text not null,
+  special varchar(255) not null,
+  primary key (id)
+) TYPE=InnoDB DEFAULT CHARSET=utf8;
+
+drop table if exists comments;
+create table comments (
+  id int not null auto_increment,
+  author varchar(100) not null,
+  content text not null,
+  content_id int,
+  primary key (id)
+) TYPE=InnoDB DEFAULT CHARSET=utf8;

data/doc/demo/db/schema.sqlite

@@ -0,0 +1,14 @@
+drop table contents;
+create table contents (
+  id INTEGER PRIMARY KEY,
+  title varchar(100),
+  description text
+);
+
+drop table comments;
+create table comments (
+  id INTEGER PRIMARY KEY,
+  author varchar(100),
+  content text,
+  content_id int
+);

data/doc/demo/doc/README_FOR_APP

@@ -0,0 +1,2 @@
+Use this README file to introduce your application and point to useful places in the API for learning more.
+Run "rake appdoc" to generate API documentation for your models and controllers.

data/doc/demo/doc/howto.txt

@@ -0,0 +1,70 @@
+This is a very minimalistic example of using ferret
+to do full text searches in Rails model data. Tested with 
+  Ruby 1.8.3, Rails 1.0 and Ferret 0.3.2.
+
+You can install the latter with
+  gem install ferret
+
+
+The steps it took me to create this small demo project were:
+
+Rails project setup
+===================
+These steps are pretty common and have nothing to do with ferret.
+
+Create rails project
+  rails ferret
+  cd ferret
+
+Create databases (if you don't use unix and/or sudo, use 'mysql -u root -p')
+  sudo mysql
+
+  create database ferret_development;
+  create database ferret_test;
+  grant all on ferret_development.* to 'ferret'@'localhost' identified by 'ferret';
+  grant all on ferret_test.* to 'ferret'@'localhost' identified by 'ferret';
+ 
+Create database schema
+  mysql -u ferret -pferret ferret_development < db/schema.sql
+
+Edit config/database.yml (user names and passwords)
+
+Create content controller and model
+script/generate scaffold Content
+
+Running rake at this point should yield no errors. 
+Otherwise check your database configuration.
+
+
+Ferret integration
+==================
+Put acs_as_ferret plugin into vendor/plugin
+
+Add ferret to the content model class:
+  acts_as_ferret :fields => [ 'title', 'description' ]
+
+Add unit tests for the find_by_contents method to content_test.rb.
+
+running rake should succeed, and there should be an index in 
+RAILS_ROOT/index/test/Content.
+
+Extend the ContentController with a search method and create the search view
+Add unit tests for the search method to content_controller_test.rb
+Run rake again to see the tests pass. 
+Remember that, as a good programmer, you would've written the tests first, 
+before implementing the feature ;-)
+
+
+Try it out
+==========
+Run the app with script/server and create some content objects. You should 
+see the index in RAILS_ROOT/index/development/Content.
+
+Try searching at http://localhost:3000/content/search
+
+
+Please contact me if you find any bugs/problems within this howto or 
+in the code.
+
+Jens Kraemer <jk@jkraemer.net>
+Feel free to use under the terms of the MIT license.