cehoffman-acts_as_ferret 0.4.4

data/doc/demo/app/helpers/admin/backend_helper.rb

@@ -0,0 +1,2 @@
+module Admin::BackendHelper
+end

data/doc/demo/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/doc/demo/app/helpers/content_helper.rb

@@ -0,0 +1,2 @@
+module ContentHelper
+end

data/doc/demo/app/helpers/search_helper.rb

@@ -0,0 +1,2 @@
+module SearchHelper
+end

data/doc/demo/app/models/comment.rb

@@ -0,0 +1,48 @@
+
+class PlainAsciiAnalyzer < ::Ferret::Analysis::Analyzer
+  include ::Ferret::Analysis
+  def token_stream(field, str)
+        StopFilter.new(
+          StandardTokenizer.new(str) ,
+          ["fax", "gsm"]
+        )
+    # raise #<<<----- is never executed when uncommented !!
+  end
+end
+
+
+class Comment < ActiveRecord::Base
+  belongs_to :parent, :class_name => 'Content', :foreign_key => :parent_id
+  
+  # simplest case: just index all fields of this model:
+  # acts_as_ferret
+  
+  # use the :additional_fields property to specify fields you intend 
+  # to add in addition to those fields from your database table (which will be
+  # autodiscovered by acts_as_ferret)
+  # the :ignore flag tells aaf to not try to set this field's value itself (we
+  # do this in our custom to_doc method)
+  acts_as_ferret( :if => Proc.new { |comment| comment.do_index? },
+                  :fields => {
+                    :content => { :store => :yes },
+                    :author  => { },
+                    :added   => { :index => :untokenized, :store => :yes, :ignore => true },
+                    :aliased => { :via => :content }
+                  }, :ferret => { :analyzer => Ferret::Analysis::StandardAnalyzer.new(['fax', 'gsm', 'the', 'or']) } )
+                  #}, :ferret => { :analyzer => PlainAsciiAnalyzer.new(['fax', 'gsm', 'the', 'or']) } )
+
+  def do_index?
+    self.content !~ /do not index/
+  end
+
+  # you can override the default to_doc method 
+  # to customize what gets into your index. 
+  def to_doc
+    # doc now has all the fields of our model instance, we 
+    # just add another field to it:
+    doc = super
+    # add a field containing the current time
+    doc[:added] = Time.now.to_i.to_s
+    return doc
+  end
+end

data/doc/demo/app/models/content.rb

@@ -0,0 +1,12 @@
+class Content < ContentBase #ActiveRecord::Base
+
+  def self.per_page; 10; end
+
+  has_many :comments
+
+  # returns the number of comments attached to this content.
+  # the value returned by this method will be indexed, too.
+  def comment_count
+    comments.size
+  end
+end

data/doc/demo/app/models/content_base.rb

@@ -0,0 +1,28 @@
+# common base class for Content and SpecialContent
+class ContentBase < ActiveRecord::Base
+  set_table_name 'contents'
+
+  # a higher boost means more importance for the field --> documents having a
+  # match in a field with a higher boost value will be ranked higher
+  #
+  # we use the store_class_name flag to be able to retrieve model instances when
+  # searching multiple indexes at once.
+  # the contents of the description field are stored in the index for running
+  # 'more like this' queries to find other content instances with similar
+  # descriptions
+  acts_as_ferret( :fields => { :comment_count => { :index => :untokenized },
+                               :title         => { :boost => :title_boost }, 
+                               :description   => { :boost => 1, :store => :yes },
+                               :special       => {} },
+                  :boost => :record_boost)
+
+  def comment_count; 0 end
+
+  attr_accessor :record_boost
+  attr_writer :title_boost
+  def title_boost
+    @title_boost || 2
+  end
+end
+
+

data/doc/demo/app/models/search.rb

@@ -0,0 +1,19 @@
+# search form model
+class Search
+
+  attr_reader :query
+
+  def initialize(query, page)
+    @query = query
+    @page = page ? page.to_i : 1
+  end
+
+  def valid?
+    !@query.blank?
+  end
+
+  # run the search
+  def run
+    Content.find_with_ferret @query, :page => @page, :per_page => 10, :sort => 'title', :lazy => true
+  end
+end

data/doc/demo/app/models/shared_index1.rb

@@ -0,0 +1,3 @@
+class SharedIndex1 < ActiveRecord::Base
+  acts_as_ferret :index  => 'shared'
+end

data/doc/demo/app/models/shared_index2.rb

@@ -0,0 +1,3 @@
+class SharedIndex2 < ActiveRecord::Base
+  acts_as_ferret :index => 'shared'
+end

data/doc/demo/app/models/special_content.rb

@@ -0,0 +1,3 @@
+class SpecialContent < ContentBase
+
+end

data/doc/demo/app/models/stats.rb

@@ -0,0 +1,20 @@
+class Stats < ActiveRecord::Base
+  def self.compute(kind)
+    start_date = minimum :created_at
+    sql = <<-END
+  select min(processing_time), max(processing_time), avg(processing_time), stddev(processing_time), 
+         concat_ws(':', hour(timediff(created_at, ?)), lpad(minute(timediff(created_at, ?)), 2, '0')) as time,
+         group_concat(processing_time) as data
+      from stats 
+      where kind=? group by time;
+  END
+    result = connection.execute sanitize_sql([sql, start_date, start_date, kind.to_s])
+    returning [] do |res|
+      while row = result.fetch_row
+        data = row.last.split(',').map{|t|t.to_i}
+        median = data.size.odd? ? data[data.size/2] : ((data[data.size/2-1]+data[data.size/2]) / 2.0)
+        res << { :min => row[0].to_f, :max => row[1].to_f, :avg => row[2].to_f, :stddev => row[3].to_f, :time => row[4], :median => median }
+      end
+    end
+  end
+end

data/doc/demo/app/views/admin/backend/search.rhtml

@@ -0,0 +1,18 @@
+<h1>Search Content (backend)</h1>
+<% form_tag :action => 'search' do %>
+  <fieldset>
+    <legend>Search</legend>
+    <input type="text" name="query" value="<%= h @query %>" />
+  </fieldset>
+  <%= submit_tag 'search' %>
+<% end %>
+
+<% if @results -%>
+<p>Your search for <%= h @query %> returned <%= @results.size %> Results:</p>
+<ul>
+  <% @results.each { |result| -%>
+  <li><%= link_to result.title, :action => 'show', :id => result %></li>
+  <% } -%>
+</ul>
+<% end -%>
+

data/doc/demo/app/views/contents/_form.rhtml

@@ -0,0 +1,10 @@
+<%= error_messages_for 'content' %>
+
+<!--[form:content]-->
+<p><label for="content_title">Title</label><br/>
+<%= form.text_field 'title'  %></p>
+
+<p><label for="content_description">Description</label><br/>
+<%= form.text_area 'description'  %></p>
+<!--[eoform:content]-->
+

data/doc/demo/app/views/contents/edit.rhtml

@@ -0,0 +1,9 @@
+<h1>Editing content</h1>
+
+<% form_for :content, @content, content_path(@content), :html => { :method => :put } do |f| %>
+  <%= render :partial => 'form', :object => f %>
+  <%= submit_tag 'Edit' %>
+<% end %>
+
+<%= link_to 'Show', content_path(@content) %> |
+<%= link_to 'Back', contents_path %>

data/doc/demo/app/views/contents/index.rhtml

@@ -0,0 +1,24 @@
+<h1>Listing contents</h1>
+
+<p><%= will_paginate @contents %></p>
+<table>
+  <tr>
+  <% for column in Content.content_columns %>
+    <th><%= column.human_name %></th>
+  <% end %>
+  </tr>
+  
+<% for content in @contents %>
+  <tr>
+  <% for column in Content.content_columns %>
+    <td><%=h content.send(column.name) %></td>
+  <% end %>
+    <td><%= link_to 'Show', :action => 'show', :id => content %></td>
+    <td><%= link_to 'Edit', :action => 'edit', :id => content %></td>
+    <td><%= link_to 'Destroy', { :action => 'destroy', :id => content }, :confirm => 'Are you sure?' %></td>
+  </tr>
+<% end %>
+</table>
+
+<p><%= will_paginate @contents %></p>
+<p><%= link_to 'New content', :action => 'new' %></p>

data/doc/demo/app/views/contents/new.rhtml

@@ -0,0 +1,8 @@
+<h1>New content</h1>
+
+<% form_for :content, @content, :url => contents_path, :html => { :method => :post } do |f| %>
+  <%= render :partial => 'form', :object => f %>
+  <%= submit_tag "Create" %>
+<% end %>
+
+<%= link_to 'Back', :action => 'list' %>

data/doc/demo/app/views/contents/show.rhtml

@@ -0,0 +1,8 @@
+<% for column in Content.content_columns %>
+<p>
+  <b><%= column.human_name %>:</b> <%=h @content.send(column.name) %>
+</p>
+<% end %>
+
+<%= link_to 'Edit', :action => 'edit', :id => @content %> |
+<%= link_to 'Back', :action => 'list' %>

data/doc/demo/app/views/layouts/application.html.erb

@@ -0,0 +1,17 @@
+<html>
+<head>
+  <title>acts_as_ferret demo application</title>
+  <%= stylesheet_link_tag 'scaffold' %>
+</head>
+<body>
+  <ul>
+    <li><%= link_to 'Contents', contents_path %></li>
+    <li><%= link_to 'Search', search_path %></li>
+  </ul>
+
+  <p style="color: green"><%= flash[:notice] %></p>
+
+<%= yield %>
+
+</body>
+</html>

data/doc/demo/app/views/searches/_content.html.erb

@@ -0,0 +1,2 @@
+<li><%= link_to content.title, content_path(content.id) %></li>
+

data/doc/demo/app/views/searches/search.html.erb

@@ -0,0 +1,20 @@
+<h1>Search</h1>
+<% form_tag search_path do %>
+  <fieldset>
+    <legend>Search</legend>
+    <%= text_field_tag 'q', @search.query %>
+  </fieldset>
+  <%= submit_tag 'search' %>
+<% end %>
+
+<% if @results -%>
+
+  <p>Your search for <%= h @search.query %> returned <%= @results.total_hits %> Results:</p>
+
+  <p><%= will_paginate @results %></p>
+  <ul>
+    <%= render :partial => 'content', :collection => @results -%>
+  </ul>
+  <p><%= will_paginate @results %></p>
+
+<% end -%>

data/doc/demo/config/boot.rb

@@ -0,0 +1,109 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion if defined? Gem::RubyGemsVersion
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.1.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

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
+