cehoffman-acts_as_ferret 0.4.4

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,68 @@
+= 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 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 project via script/plugin
+
+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
+project's config/environment.rb:
+
+<tt>require 'acts_as_ferret'</tt>
+
+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
+
+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.
+
+== License
+
+Released under the MIT license.
+
+== Authors
+
+* Kasper Weibel Nielsen-Refs (original author)
+* Jens Kraemer <jk@jkraemer.net> (current maintainer)
+

data/bin/aaf_install

@@ -0,0 +1,23 @@
+# acts_as_ferret gem install script
+# Use inside the root of your Rails project
+require 'fileutils'
+
+@basedir = File.join(File.dirname(__FILE__), '..')
+
+def install(dir, file, executable=false)
+  puts "Installing: #{file}"
+  target = File.join('.', dir, file)
+  if File.exists?(target)
+    puts "#{target} already exists, skipping"
+  else
+    FileUtils.cp File.join(@basedir, dir, file), target
+    FileUtils.chmod 0755, target if executable
+  end
+end
+
+
+install 'script', 'ferret_server', true
+install 'config', 'ferret_server.yml'
+
+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'

data/doc/demo/app/controllers/admin/backend_controller.rb

@@ -0,0 +1,14 @@
+class Admin::BackendController < AdminAreaController
+
+  def search
+    @query = params[:query] || ''
+    unless @query.blank?
+      @results = Content.find_with_ferret @query
+    end
+  end
+
+  def show
+    @content = Content.find(params[:id])
+    render :template => 'content/show'
+  end
+end

data/doc/demo/app/controllers/admin_area_controller.rb

@@ -0,0 +1,4 @@
+class AdminAreaController < ApplicationController
+
+end
+

data/doc/demo/app/controllers/application.rb

@@ -0,0 +1,5 @@
+# Filters added to this controller will be run for all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+class ApplicationController < ActionController::Base
+end
+

data/doc/demo/app/controllers/contents_controller.rb

@@ -0,0 +1,49 @@
+class ContentsController < ApplicationController
+  before_filter :find_content, :only => [ :show, :edit, :update, :destroy ]
+
+  def index 
+    @contents = Content.paginate :page => params[:page]
+  end
+
+  def show
+  end
+
+  def new
+    @content = Content.new
+  end
+
+  def create
+    @content = Content.new(params[:content])
+    if @content.save
+      flash[:notice] = 'Content was successfully created.'
+      redirect_to contents_url
+    else
+      render :action => 'new'
+    end
+    logger.error "#############{@content.errors.full_messages}"
+  end
+
+  def edit
+  end
+
+  def update
+    if @content.update_attributes(params[:content])
+      flash[:notice] = 'Content was successfully updated.'
+      redirect_to :action => 'show', :id => @content
+    else
+      render :action => 'edit'
+    end
+  end
+
+  def destroy
+    @content.destroy
+    redirect_to :action => 'list'
+  end
+
+  protected
+
+    def find_content
+      @content = Content.find params[:id]
+    end
+
+end

data/doc/demo/app/controllers/searches_controller.rb

@@ -0,0 +1,8 @@
+class SearchesController < ApplicationController
+
+  def search
+    @search = Search.new params[:q], params[:page]
+    @results = @search.run if @search.valid?
+  end
+
+end