watson-acts_as_ferret 0.4.8.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Kasper Weibel, Jens Kraemer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,104 @@
+= acts_as_ferret
+
+This ActiveRecord mixin adds full text search capabilities to any Rails model.
+
+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 Wiki and Issue tracker
+
+http://wiki.github.com/jkraemer/acts_as_ferret/
+http://j-k.lighthouseapp.com/projects/45560-acts-as-ferret
+
+== Installation
+
+Aaf is available as a gem (gem install acts_as_ferret), or via git from github.com.
+Github also offers tarball downloads, check out
+http://github.com/jkraemer/acts_as_ferret/tree/master .
+
+=== Set up your Rails > 2.1 project to use the acts_as_ferret gem.
+
+Add this to your project's config/environment.rb (inside the Rails::Initializer.run block):
+
+<tt>
+  config.gem 'acts_as_ferret', :version => '~> 0.4.8'
+  config.after_initialize { ActsAsFerret::load_config }
+  config.to_prepare       { ActsAsFerret::load_config }  
+</tt>
+
+With the gem installed, change into your RAILS_ROOT and run the supplied aaf_install script.
+This will copy rake tasks, capistrano recipes and the ferret server config and startup script
+into your project.
+
+In order to have the capistrano recipe loaded you'll have to patch your Capfile a bit. I use to have
+a line like that in my Capfiles, loading everything found below RAILS_ROOT/lib/recipes:
+
+<tt>Dir['lib/recipes/**/*.rb'].each { |plugin| load(plugin) }</tt>
+
+
+=== Installation inside your Rails project via script/plugin
+
+script/plugin install git://github.com/jkraemer/acts_as_ferret.git
+
+No additional setup needed.
+
+
+== Usage
+
+There are two ways to make your models searchable with aaf. The option to configure acts_as_ferret with
+a single configuration file has been introduced because it makes more sense when a single index holds multiple
+models - it's simply more logicl to define that index and tell which models should go into it than to call
+acts_as_ferret in each model pointing to the same index every time.
+
+=== central configuration file
+
+With this option, all acts_as_ferret indexes are configured in a single file, RAILS_ROOT/config/aaf.rb:
+
+ActsAsFerret::define_index( 'my_index',
+                            :models => {
+                              SomeModel => {
+                                :fields => {
+                                  :name => { :boost => 4, :store => :yes, :via => :ferret_title },
+                                  :foo => { :store => :no,  :index => :untokenized },
+                                  :baz => { :store => :yes, :via => :ferret_content }
+                                }
+                              }
+                            } )
+
+ActsAsFerret::define_index( 'some_other_index',
+                            :models => {
+                              Foo => { :fields => { ... } },
+                              Bar => { ... },
+                            } )
+
+
+As you can see for every index you want to define there's a single call, and each model that should go
+into the index gets it's own ferret options hash (see the acts_as_ferret class method docs for all available options).
+
+=== In your models (the old fashioned way)
+include the following in your model class (specifiying the fields you want to get indexed):
+
+<tt>acts_as_ferret :fields => [ :title, :description ]</tt>
+
+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 
+less results).
+
+Please see ActsAsFerret::ActMethods#acts_as_ferret for more information.
+
+== Known issues
+
+aaf is not yet ready for Rails3. Feel free to submit patches!
+
+== License
+
+Released under the MIT license.
+
+== Authors
+
+* Kasper Weibel Nielsen-Refs (original author)
+* Jens Kraemer <jk@jkraemer.net> (current maintainer)
+

data/acts_as_ferret.gemspec

@@ -0,0 +1,58 @@
+Gem::Specification.new do |s|
+
+	s.name = 'watson-acts_as_ferret'
+	s.version = '0.4.8.2'
+	s.authors = ['Thomas Watson']
+	s.summary = 'acts_as_ferret - Ferret based full text search for any ActiveRecord model'
+	s.description = 'Rails plugin that adds powerful full text search capabilities to ActiveRecord models. This is a fork of the original acts_as_ferret plugin by Jens Kraemer with some minor custom ajustments.'
+	s.email = 'w@tson.dk'
+	s.homepage = 'http://github.com/watson/acts_as_ferret'
+	
+	s.bindir = 'bin'
+	s.executables = ['aaf_install']
+	s.default_executable = 'aaf_install'
+  s.require_paths = ["lib"]
+	
+	
+	s.platform = Gem::Platform::RUBY 
+  s.required_ruby_version = '>=1.8.6'
+	s.rubygems_version = '1.3.6'
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency('jk-ferret', [">= 0.11.8"])
+    else
+      s.add_dependency('jk-ferret', [">= 0.11.8"])
+    end
+  else
+    s.add_dependency('jk-ferret', [">= 0.11.8"])
+  end
+  
+
+	s.has_rdoc = true
+  s.rdoc_options = ["--charset=UTF-8"]
+	s.extra_rdoc_files = [
+		'LICENSE',
+		'README'
+	]
+	s.test_files = Dir['test/**/*rb']
+	s.files = [
+		'bin/*',
+		'config/*',
+		'doc/**/*',
+		'recipes/*',
+		'script/*',
+		'tasks/*',
+		'lib/**/*rb'
+	].map{|p| Dir[p]}.flatten +
+	[
+		'acts_as_ferret.gemspec',
+		'init.rb',
+		'install.rb',
+		'README',
+		'LICENSE',
+	]
+	
+end

data/bin/aaf_install

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# acts_as_ferret gem install script
+# Use inside the root of your Rails project
+require 'fileutils'
+
+@basedir = File.join(File.dirname(__FILE__), '..')
+
+def install(src, target_dir, executable=false)
+  puts "Installing: #{src}"
+  src = File.join(@basedir, src)
+  fname = File.basename(src)
+  target = File.join(target_dir, fname)
+  if File.exists?(target)
+    puts "#{target} already exists, skipping"
+  else
+    FileUtils.mkdir_p target_dir
+    FileUtils.cp src, target
+    FileUtils.chmod 0755, target if executable
+  end
+end
+
+
+install 'script/ferret_server', 'script', true
+install 'config/ferret_server.yml', 'config'
+install 'tasks/ferret.rake', 'lib/tasks'
+install 'recipes/aaf_recipes.rb', 'lib/recipes'
+
+puts IO.read(File.join(@basedir, 'README'))
+

data/config/ferret_server.yml

@@ -0,0 +1,24 @@
+# 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
+production:
+  host: localhost
+  port: 9010
+  pid_file: log/ferret.pid
+  log_file: log/ferret_server.log
+  log_level: warn
+
+# aaf won't try to use the DRb server in environments that are not 
+# configured here.
+#development:
+#  host: localhost
+#  port: 9010
+#  pid_file: log/ferret.pid
+#test:
+#  host: localhost
+#  port: 9009
+#  pid_file: log/ferret.pid

data/doc/README.win32

@@ -0,0 +1,23 @@
+Credits
+=======
+
+The Win32 service support scripts have been written by
+Herryanto Siatono <herryanto@pluitsolutions.com>. 
+
+See his accompanying blog posting at
+http://www.pluitsolutions.com/2007/07/30/acts-as-ferret-drbserver-win32-service/
+
+
+Usage
+=====
+
+There are two scripts:
+
+script/ferret_service is used to install/remove/start/stop the win32 service.
+
+script/ferret_daemon is to be called by Win32 service to start/stop the
+DRbServer.
+
+Run 'ruby script/ferret_service -h' for more info.
+
+

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.

data/doc/demo/README_DEMO

@@ -0,0 +1,23 @@
+Acts_as_Ferret demo project
+===========================
+
+This project is intended to run with edge rails which can
+be installed with
+
+rake rails:freeze:edge
+
+
+You'll also need to set up a database for it.
+SQL scripts for both SQLite and MySQL are provided in db/ .
+
+Just set up one of these, and configure your db connection 
+in config/database.yml .
+
+after that run 
+rake
+to see the unit tests pass.
+
+
+Please feel free to post bugs/enhancements/patches at 
+http://projects.jkraemer.net/acts_as_ferret .
+

data/doc/demo/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/switchtower.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'