acts_as_ferret 0.4.3 → 0.4.4

data/README

@@ -6,24 +6,51 @@ It is heavily based on the original acts_as_ferret plugin done by
 Kasper Weibel and a modified version done by Thomas Lockney, which 
 both can be found on http://ferret.davebalmain.com/trac/wiki/FerretOnRails
 
+== Project Homepage
+
+http://rm.jkraemer.net/projects/show/aaf
+
 == Installation
 
+Aaf is available via git from rubyforge.org and github.com. Github also offers
+tarball downloads, check out http://github.com/jkraemer/acts_as_ferret/tree/master .
+
+=== Installation inside your Rails > 2.1 project via gem management
+
+Add this to your projects config/environment.rb:
+
+<tt>config.gem 'acts_as_ferret', :version => '~> 0.4.4'</tt>
+
+Or, use github:
+
+<tt>config.gem 'jkraemer-acts_as_ferret', :version => '~> 0.4.4', :lib => 'acts_as_ferret', :source => 'http://gems.github.com'"</tt>
+
 === Installation inside your Rails project via script/plugin
 
-script/plugin install svn://projects.jkraemer.net/acts_as_ferret/trunk/plugin/acts_as_ferret
+script/plugin install git://github.com/jkraemer/acts_as_ferret.git
+
+The rubyforge repository is located at git://rubyforge.org/actsasferret.git
 
+=== Old SVN repository
+
+In november 2008 I stopped updating the svn repository that has been the main
+repository for aaf for several years. In case you want to retrieve any of the
+older versions of the plugin, it's still there at
+
+svn://code.jkraemer.net/acts_as_ferret/
 
 === System-wide installation with Rubygems
 
 <tt>sudo gem install acts_as_ferret</tt>
 
-To use acts_as_ferret in your project, add the following line to your
+To use acts_as_ferret in your project, add the following line to the end of your
 project's config/environment.rb:
 
 <tt>require 'acts_as_ferret'</tt>
 
-Call the aaf_install script inside your project directory to install the sample
-config file and the drb server start/stop script.
+Call the aaf_install script that came with the gem inside your project
+directory to install the sample config file and the drb server start/stop
+script.
 
 
 == Usage
@@ -32,7 +59,7 @@ include the following in your model class (specifiying the fields you want to ge
 
 <tt>acts_as_ferret :fields => [ :title, :description ]</tt>
 
-now you can use ModelClass.find_by_contents(query) to find instances of your model
+now you can use ModelClass.find_with_ferret(query) to find instances of your model
 whose indexed fields match a given query. All query terms are required by default, 
 but explicit OR queries are possible. This differs from the ferret default, but 
 imho is the more often needed/expected behaviour (more query terms result in 
@@ -49,4 +76,3 @@ Released under the MIT license.
 * Kasper Weibel Nielsen-Refs (original author)
 * Jens Kraemer <jk@jkraemer.net> (current maintainer)
 
-

data/acts_as_ferret.gemspec

@@ -0,0 +1,260 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_ferret
+version: !ruby/object:Gem::Version 
+  version: 0.4.4
+platform: ruby
+authors: 
+- Jens Kraemer
+autorequire: acts_as_ferret
+bindir: bin
+cert_chain: []
+
+date: 2009-05-28 00:00:00 +02:00
+default_executable: aaf_install
+dependencies: []
+
+description: 
+email: jk@jkraemer.net
+executables: 
+- aaf_install
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- acts_as_ferret.gemspec
+- bin
+- bin/aaf_install
+- config
+- config/ferret_server.yml
+- doc
+- doc/demo
+- doc/demo/app
+- doc/demo/app/controllers
+- doc/demo/app/controllers/admin
+- doc/demo/app/controllers/admin/backend_controller.rb
+- doc/demo/app/controllers/admin_area_controller.rb
+- doc/demo/app/controllers/application.rb
+- doc/demo/app/controllers/contents_controller.rb
+- doc/demo/app/controllers/searches_controller.rb
+- doc/demo/app/helpers
+- doc/demo/app/helpers/admin
+- doc/demo/app/helpers/admin/backend_helper.rb
+- doc/demo/app/helpers/application_helper.rb
+- doc/demo/app/helpers/content_helper.rb
+- doc/demo/app/helpers/search_helper.rb
+- doc/demo/app/models
+- doc/demo/app/models/comment.rb
+- doc/demo/app/models/content.rb
+- doc/demo/app/models/content_base.rb
+- doc/demo/app/models/search.rb
+- doc/demo/app/models/shared_index1.rb
+- doc/demo/app/models/shared_index2.rb
+- doc/demo/app/models/special_content.rb
+- doc/demo/app/models/stats.rb
+- doc/demo/app/views
+- doc/demo/app/views/admin
+- doc/demo/app/views/admin/backend
+- doc/demo/app/views/admin/backend/search.rhtml
+- doc/demo/app/views/contents
+- doc/demo/app/views/contents/_form.rhtml
+- doc/demo/app/views/contents/edit.rhtml
+- doc/demo/app/views/contents/index.rhtml
+- doc/demo/app/views/contents/new.rhtml
+- doc/demo/app/views/contents/show.rhtml
+- doc/demo/app/views/layouts
+- doc/demo/app/views/layouts/application.html.erb
+- doc/demo/app/views/searches
+- doc/demo/app/views/searches/_content.html.erb
+- doc/demo/app/views/searches/search.html.erb
+- doc/demo/config
+- doc/demo/config/boot.rb
+- doc/demo/config/database.yml
+- doc/demo/config/environment.rb
+- doc/demo/config/environments
+- doc/demo/config/environments/development.rb
+- doc/demo/config/environments/production.rb
+- doc/demo/config/environments/test.rb
+- doc/demo/config/ferret_server.yml
+- doc/demo/config/lighttpd.conf
+- doc/demo/config/routes.rb
+- doc/demo/db
+- doc/demo/db/development_structure.sql
+- doc/demo/db/migrate
+- doc/demo/db/migrate/001_initial_migration.rb
+- doc/demo/db/migrate/002_add_type_to_contents.rb
+- doc/demo/db/migrate/003_create_shared_index1s.rb
+- doc/demo/db/migrate/004_create_shared_index2s.rb
+- doc/demo/db/migrate/005_special_field.rb
+- doc/demo/db/migrate/006_create_stats.rb
+- doc/demo/db/schema.sql
+- doc/demo/doc
+- doc/demo/doc/howto.txt
+- doc/demo/doc/README_FOR_APP
+- doc/demo/log
+- doc/demo/public
+- doc/demo/public/.htaccess
+- doc/demo/public/404.html
+- doc/demo/public/500.html
+- doc/demo/public/dispatch.cgi
+- doc/demo/public/dispatch.fcgi
+- doc/demo/public/dispatch.rb
+- doc/demo/public/favicon.ico
+- doc/demo/public/images
+- doc/demo/public/images/rails.png
+- doc/demo/public/index.html
+- doc/demo/public/robots.txt
+- doc/demo/public/stylesheets
+- doc/demo/public/stylesheets/scaffold.css
+- doc/demo/Rakefile
+- doc/demo/README
+- doc/demo/README_DEMO
+- doc/demo/script
+- doc/demo/script/about
+- doc/demo/script/breakpointer
+- doc/demo/script/console
+- doc/demo/script/destroy
+- doc/demo/script/ferret_server
+- doc/demo/script/generate
+- doc/demo/script/performance
+- doc/demo/script/performance/benchmarker
+- doc/demo/script/performance/profiler
+- doc/demo/script/plugin
+- doc/demo/script/process
+- doc/demo/script/process/inspector
+- doc/demo/script/process/reaper
+- doc/demo/script/process/spawner
+- doc/demo/script/process/spinner
+- doc/demo/script/runner
+- doc/demo/script/server
+- doc/demo/test
+- doc/demo/test/fixtures
+- doc/demo/test/fixtures/comments.yml
+- doc/demo/test/fixtures/contents.yml
+- doc/demo/test/fixtures/remote_contents.yml
+- doc/demo/test/fixtures/shared_index1s.yml
+- doc/demo/test/fixtures/shared_index2s.yml
+- doc/demo/test/functional
+- doc/demo/test/functional/admin
+- doc/demo/test/functional/admin/backend_controller_test.rb
+- doc/demo/test/functional/contents_controller_test.rb
+- doc/demo/test/functional/searches_controller_test.rb
+- doc/demo/test/smoke
+- doc/demo/test/smoke/drb_smoke_test.rb
+- doc/demo/test/smoke/process_stats.rb
+- doc/demo/test/test_helper.rb
+- doc/demo/test/unit
+- doc/demo/test/unit/comment_test.rb
+- doc/demo/test/unit/content_test.rb
+- doc/demo/test/unit/ferret_result_test.rb
+- doc/demo/test/unit/multi_index_test.rb
+- doc/demo/test/unit/remote_index_test.rb
+- doc/demo/test/unit/shared_index1_test.rb
+- doc/demo/test/unit/shared_index2_test.rb
+- doc/demo/test/unit/sort_test.rb
+- doc/demo/test/unit/special_content_test.rb
+- doc/demo/vendor
+- doc/demo/vendor/plugins
+- doc/demo/vendor/plugins/will_paginate
+- doc/demo/vendor/plugins/will_paginate/init.rb
+- doc/demo/vendor/plugins/will_paginate/lib
+- doc/demo/vendor/plugins/will_paginate/lib/will_paginate
+- doc/demo/vendor/plugins/will_paginate/lib/will_paginate/collection.rb
+- doc/demo/vendor/plugins/will_paginate/lib/will_paginate/core_ext.rb
+- doc/demo/vendor/plugins/will_paginate/lib/will_paginate/finder.rb
+- doc/demo/vendor/plugins/will_paginate/lib/will_paginate/view_helpers.rb
+- doc/demo/vendor/plugins/will_paginate/LICENSE
+- doc/demo/vendor/plugins/will_paginate/Rakefile
+- doc/demo/vendor/plugins/will_paginate/README
+- doc/demo/vendor/plugins/will_paginate/test
+- doc/demo/vendor/plugins/will_paginate/test/array_pagination_test.rb
+- doc/demo/vendor/plugins/will_paginate/test/boot.rb
+- doc/demo/vendor/plugins/will_paginate/test/console
+- doc/demo/vendor/plugins/will_paginate/test/finder_test.rb
+- doc/demo/vendor/plugins/will_paginate/test/fixtures
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/admin.rb
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/companies.yml
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/company.rb
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/developer.rb
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/developers_projects.yml
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/project.rb
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/projects.yml
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/replies.yml
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/reply.rb
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/schema.sql
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/topic.rb
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/topics.yml
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/user.rb
+- doc/demo/vendor/plugins/will_paginate/test/fixtures/users.yml
+- doc/demo/vendor/plugins/will_paginate/test/helper.rb
+- doc/demo/vendor/plugins/will_paginate/test/lib
+- doc/demo/vendor/plugins/will_paginate/test/lib/activerecord_test_connector.rb
+- doc/demo/vendor/plugins/will_paginate/test/lib/load_fixtures.rb
+- doc/demo/vendor/plugins/will_paginate/test/pagination_test.rb
+- doc/monit-example
+- doc/README.win32
+- init.rb
+- install.rb
+- lib
+- lib/act_methods.rb
+- lib/acts_as_ferret.rb
+- lib/ar_mysql_auto_reconnect_patch.rb
+- lib/blank_slate.rb
+- lib/bulk_indexer.rb
+- lib/class_methods.rb
+- lib/ferret_extensions.rb
+- lib/ferret_find_methods.rb
+- lib/ferret_result.rb
+- lib/ferret_server.rb
+- lib/index.rb
+- lib/instance_methods.rb
+- lib/local_index.rb
+- lib/more_like_this.rb
+- lib/multi_index.rb
+- lib/rdig_adapter.rb
+- lib/remote_functions.rb
+- lib/remote_index.rb
+- lib/remote_multi_index.rb
+- lib/search_results.rb
+- lib/server_manager.rb
+- lib/unix_daemon.rb
+- lib/without_ar.rb
+- LICENSE
+- rakefile
+- README
+- recipes
+- recipes/aaf_recipes.rb
+- script
+- script/ferret_daemon
+- script/ferret_server
+- script/ferret_service
+- tasks
+- tasks/ferret.rake
+has_rdoc: true
+homepage: http://projects.jkraemer.net/acts_as_ferret
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: acts_as_ferret - Ferret based full text search for any ActiveRecord model
+test_files: []
+

data/config/ferret_server.yml

@@ -1,6 +1,7 @@
 # configuration for the acts_as_ferret DRb server
 # host: where to reach the DRb server (used by application processes to contact the server)
 # port: which port the server should listen on
+# socket: where the DRb server should create the socket (absolute path), this setting overrides host:port configuration
 # pid_file: location of the server's pid file (relative to RAILS_ROOT)
 # log_file: log file (default: RAILS_ROOT/log/ferret_server.log
 # log_level: log level for the server's logger

data/doc/demo/README

@@ -0,0 +1,154 @@
+== Welcome to Rails
+
+
+Rails is a web-application and persistence framework that includes everything
+needed to create database-backed web-applications according to the
+Model-View-Control pattern of separation. This pattern splits the view (also
+called the presentation) into "dumb" templates that are primarily responsible
+for inserting pre-built data in between HTML tags. The model contains the
+"smart" domain objects (such as Account, Product, Person, Post) that holds all
+the business logic and knows how to persist themselves to a database. The
+controller handles the incoming requests (such as Save New Account, Update
+Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in 
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in 
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting started
+
+1. Run the WEBrick servlet: <tt>ruby script/server</tt> (run with --help for options)
+   ...or if you have lighttpd installed: <tt>ruby script/lighttpd</tt> (it's faster)
+2. Go to http://localhost:3000/ and get "Congratulations, you've put Ruby on Rails!"
+3. Follow the guidelines on the "Congratulations, you've put Ruby on Rails!" screen
+
+
+== Example for Apache conf
+
+  <VirtualHost *:80>
+    ServerName rails
+    DocumentRoot /path/application/public/
+    ErrorLog /path/application/log/server.log
+  
+    <Directory /path/application/public/>
+      Options ExecCGI FollowSymLinks
+      AllowOverride all
+      Allow from all
+      Order allow,deny
+    </Directory>
+  </VirtualHost>
+
+NOTE: Be sure that CGIs can be executed in that directory as well. So ExecCGI
+should be on and ".cgi" should respond. All requests from 127.0.0.1 go
+through CGI, so no Apache restart is necessary for changes. All other requests
+go through FCGI (or mod_ruby), which requires a restart to show changes.
+
+
+== Debugging Rails
+
+Have "tail -f" commands running on both the server.log, production.log, and
+test.log files. Rails will automatically display debugging and runtime
+information to these files. Debugging info will also be shown in the browser
+on requests from 127.0.0.1.
+
+
+== Breakpoints
+
+Breakpoint support is available through the script/breakpointer client. This
+means that you can break out of execution at any point in the code, investigate
+and change the model, AND then resume execution! Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find_all
+      breakpoint "Breaking out from the list"
+    end
+  end
+  
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the breakpointer window. Here you can do things like:
+
+Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>, 
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a breakpoint"
+  => "hello from a breakpoint"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first 
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you press CTRL-D
+
+
+== Console
+
+You can interact with the domain model by starting the console through script/console. 
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>console production</tt>.
+
+
+== Description of contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblog_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+  
+app/views
+  Holds the template files for the view that should be named like
+  weblog/index.rhtml for the WeblogController#index action. All views use eRuby
+  syntax. This directory can also be used to keep stylesheets, images, and so on
+  that can be symlinked to public.
+  
+app/helpers
+  Holds view helpers that should be named like weblog_helper.rb.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+components
+  Self-contained mini-applications that can bundle together controllers, models, and views.
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+    
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  This directory is in the load path.