pager-ultrasphinx 1.0.20080510

data/lib/ultrasphinx/ultrasphinx.rb

@@ -0,0 +1,199 @@
+
+module Ultrasphinx
+
+  class Error < ::StandardError #:nodoc:
+  end
+  class ConfigurationError < Error #:nodoc:
+  end  
+  class DaemonError < Error #:nodoc:
+  end
+  class UsageError < Error #:nodoc:
+  end
+
+  # Internal file paths
+  
+  SUBDIR = "config/ultrasphinx"
+  
+  DIR = "#{RAILS_ROOT}/#{SUBDIR}"
+  
+  THIS_DIR = File.expand_path(File.dirname(__FILE__))
+
+  CONF_PATH = "#{DIR}/#{RAILS_ENV}.conf"
+  
+  ENV_BASE_PATH = "#{DIR}/#{RAILS_ENV}.base" 
+  
+  GENERIC_BASE_PATH = "#{DIR}/default.base"
+  
+  BASE_PATH = (File.exist?(ENV_BASE_PATH) ? ENV_BASE_PATH : GENERIC_BASE_PATH)
+  
+  raise ConfigurationError, "Please create a '#{SUBDIR}/#{RAILS_ENV}.base' or '#{SUBDIR}/default.base' file in order to use Ultrasphinx in your #{RAILS_ENV} environment." unless File.exist? BASE_PATH # XXX lame
+
+  # Some miscellaneous constants
+
+  MAX_INT = 2**32-1
+
+  MAX_WORDS = 2**16 # The maximum number of stopwords built  
+  
+  MAIN_INDEX = "main"
+  
+  DELTA_INDEX = "delta"
+  
+  INDEXES = [MAIN_INDEX, DELTA_INDEX]
+
+  CONFIG_MAP = {
+    # These must be symbols for key mapping against Rails itself.
+    :username => 'sql_user',
+    :password => 'sql_pass',
+    :host => 'sql_host',
+    :database => 'sql_db',
+    :port => 'sql_port',
+    :socket => 'sql_sock'
+  }
+  
+  CONNECTION_DEFAULTS = {
+    :host => 'localhost',
+    :password => '',
+    :username => 'root'
+  }
+     
+  mattr_accessor :with_rake
+  
+  def self.load_stored_procedure(name)
+    open("#{THIS_DIR}/postgresql/#{name}.sql").read.gsub(/\s+/, ' ')
+  end
+
+  SQL_FUNCTIONS = {
+    'mysql' => {
+      'group_concat' => "CAST(GROUP_CONCAT(DISTINCT ? ? SEPARATOR ' ') AS CHAR)",
+      'delta' => "DATE_SUB(NOW(), INTERVAL ? SECOND)",      
+      'hash' => "CAST(CRC32(?) AS unsigned)",
+      'range_cast' => "?"
+    },
+    'postgresql' => {
+      'group_concat' => "GROUP_CONCAT(?)",
+      'delta' => "(NOW() - '? SECOND'::interval)",
+      'range_cast' => "cast(coalesce(?,1) AS integer)",
+      'hash' => "CRC32(?)"
+    }      
+  }
+  
+  DEFAULTS = {
+    'mysql' => %(
+      type = mysql
+      sql_query_pre = SET SESSION group_concat_max_len = 65535
+      sql_query_pre = SET NAMES utf8
+    ), 
+    'postgresql' => %(
+      type = pgsql
+      sql_query_pre =
+    )
+  }
+    
+  ADAPTER = ActiveRecord::Base.connection.instance_variable_get("@config")[:adapter] rescue 'mysql'
+    
+  # Warn-mode logger. Also called from rake tasks.  
+  def self.say msg
+    # XXX Method name is stupid.
+    if with_rake
+      puts msg[0..0].upcase + msg[1..-1]
+    else
+      msg = "** ultrasphinx: #{msg}"
+      if defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER
+        RAILS_DEFAULT_LOGGER.warn msg
+      else
+        STDERR.puts msg
+      end
+    end        
+    nil # Explicitly return nil
+  end
+  
+  # Debug-mode logger.  
+  def self.log msg
+    # XXX Method name is stupid.
+    if defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER
+      RAILS_DEFAULT_LOGGER.debug msg
+    else
+      STDERR.puts msg
+    end
+  end    
+  
+  # Configuration file parser.
+  def self.options_for(heading, path)
+    # Evaluate ERB
+    template = ERB.new(File.open(path) {|f| f.read})
+    contents = template.result(binding)
+    
+    # Find the correct heading.
+    section = contents[/^#{heading.gsub('/', '__')}\s*?\{(.*?)\}/m, 1]
+    
+    if section
+      # Convert to a hash
+      options = section.split("\n").map do |line|
+        line =~ /\s*(.*?)\s*=\s*([^\#]*)/
+        $1 ? [$1, $2.strip] : []
+      end      
+      Hash[*options.flatten] 
+    else
+      # XXX Is it safe to raise here?
+      Ultrasphinx.say "warning; heading #{heading} not found in #{path}; it may be corrupted. "
+      {}    
+    end    
+  end
+  
+  def self.get_models_to_class_ids #:nodoc:
+    # Reading the conf file makes sure that we are in sync with the actual Sphinx index, not
+    # whatever you happened to change your models to most recently.
+    if File.exist? CONF_PATH
+      lines, hash = open(CONF_PATH).readlines, {}
+      msg = "#{CONF_PATH} file is corrupted. Please run 'rake ultrasphinx:configure'."
+      
+      lines.each_with_index do |line, index| 
+        # Find the main sources
+        if line =~ /^source ([\w\d_-]*)_#{MAIN_INDEX}/
+          # Derive the model name
+          model = $1.gsub('__', '/').classify
+
+          # Get the id modulus out of the adjacent sql_query
+          query = lines[index..-1].detect do |query_line|
+            query_line =~ /^sql_query /
+          end
+          raise ConfigurationError, msg unless query
+          hash[model] = query[/(\d*) AS class_id/, 1].to_i
+        end  
+      end            
+      raise ConfigurationError, msg unless hash.values.size == hash.values.uniq.size      
+      hash          
+    else
+      # We can't raise here because you may be generating the configuration for the first time
+      Ultrasphinx.say "configuration file not found for #{RAILS_ENV.inspect} environment"
+      Ultrasphinx.say "please run 'rake ultrasphinx:configure'"
+    end      
+  end  
+
+  # Introspect on the existing generated conf files.
+  INDEXER_SETTINGS = options_for('indexer', BASE_PATH)
+  CLIENT_SETTINGS = options_for('client', BASE_PATH)
+  DAEMON_SETTINGS = options_for('searchd', BASE_PATH)
+  SOURCE_SETTINGS = options_for('source', BASE_PATH)
+  INDEX_SETTINGS = options_for('index', BASE_PATH)
+  
+  # Make sure there's a trailing slash.
+  INDEX_SETTINGS['path'] = INDEX_SETTINGS['path'].chomp("/") + "/" 
+  
+  DICTIONARY = CLIENT_SETTINGS['dictionary_name'] || 'ap'  
+  raise ConfigurationError, "Aspell does not support dictionary names longer than two letters" if DICTIONARY.size > 2
+
+  STOPWORDS_PATH = "#{Ultrasphinx::INDEX_SETTINGS['path']}/#{DICTIONARY}-stopwords.txt"
+
+  MODEL_CONFIGURATION = {}     
+  
+  # See if a delta index was defined.
+  def self.delta_index_present?
+    if File.exist?(CONF_PATH) 
+      File.open(CONF_PATH).readlines.detect do |line|
+        line =~ /^index delta/
+      end
+    end
+  end
+  
+end

data/lib/ultrasphinx.rb

@@ -0,0 +1,36 @@
+
+require 'fileutils'
+require 'chronic'
+require 'singleton'
+
+if defined? RAILS_ENV and RAILS_ENV == "development"
+  if ENV['USER'] == 'eweaver'
+    require 'ruby-debug'
+    Debugger.start
+  end
+end
+
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../vendor/riddle/lib"
+require 'riddle'
+require 'ultrasphinx/ultrasphinx'
+require 'ultrasphinx/associations'
+require 'ultrasphinx/core_extensions'
+require 'ultrasphinx/is_indexed'
+
+if (ActiveRecord::Base.connection rescue nil) # XXX Not sure why this needed to be wrapped.
+  require 'ultrasphinx/configure'
+  require 'ultrasphinx/autoload'
+  require 'ultrasphinx/fields'
+
+  require 'ultrasphinx/search/internals'
+  require 'ultrasphinx/search/parser'
+  require 'ultrasphinx/search'
+
+  begin
+    require 'raspell'
+  rescue Object => e
+  end
+  
+  require 'ultrasphinx/spell'
+end
+

data/rails/init.rb

@@ -0,0 +1,2 @@
+
+require 'ultrasphinx'

data/tasks/ultrasphinx.rake

@@ -0,0 +1,206 @@
+
+ENV['RAILS_ENV'] ||= "development"
+
+namespace :ultrasphinx do  
+
+  task :_environment => [:environment] do
+    # We can't just chain :environment because we want to make 
+    # sure it's set only for known Sphinx tasks
+    Ultrasphinx.with_rake = true
+  end
+  
+  desc "Bootstrap a full Sphinx environment"
+  task :bootstrap => [:_environment, :configure, :index, :"daemon:restart"] do
+    say "done"
+    say "please restart your application containers"
+  end
+  
+  desc "Rebuild the configuration file for this particular environment."
+  task :configure => [:_environment] do
+    Ultrasphinx::Configure.run
+  end
+  
+  namespace :index do    
+    desc "Reindex and rotate the main index."
+    task :main => [:_environment] do
+      ultrasphinx_index(Ultrasphinx::MAIN_INDEX)
+    end
+
+    desc "Reindex and rotate the delta index."    
+    task :delta => [:_environment] do
+      ultrasphinx_index(Ultrasphinx::DELTA_INDEX)
+    end
+    
+    desc "Merge the delta index into the main index."
+    task :merge =>  [:_environment] do
+      ultrasphinx_merge
+    end
+    
+  end
+
+  desc "Reindex and rotate all indexes."  
+  task :index => [:_environment]  do
+    ultrasphinx_index("--all")
+  end
+  
+  namespace :daemon do
+    desc "Start the search daemon"
+    task :start => [:_environment] do
+      FileUtils.mkdir_p File.dirname(Ultrasphinx::DAEMON_SETTINGS["log"]) rescue nil
+      raise Ultrasphinx::DaemonError, "Already running" if ultrasphinx_daemon_running?
+      system "searchd --config '#{Ultrasphinx::CONF_PATH}'"
+      sleep(4) # give daemon a chance to write the pid file
+      if ultrasphinx_daemon_running?
+        say "started successfully"
+      else
+        say "failed to start"
+      end
+    end
+    
+    desc "Stop the search daemon"
+    task :stop => [:_environment] do
+      raise Ultrasphinx::DaemonError, "Doesn't seem to be running" unless ultrasphinx_daemon_running?
+      system "kill #{pid = ultrasphinx_daemon_pid}"
+      sleep(1)
+      if ultrasphinx_daemon_running?
+        system "kill -9 #{pid}"  
+        sleep(1)
+      end
+      if ultrasphinx_daemon_running?
+        say "#{pid} could not be stopped"
+      else
+        say "stopped #{pid}"
+      end
+    end
+
+    desc "Restart the search daemon"
+    task :restart => [:_environment] do
+      Rake::Task["ultrasphinx:daemon:stop"].invoke if ultrasphinx_daemon_running?
+      sleep(3)
+      Rake::Task["ultrasphinx:daemon:start"].invoke
+    end
+    
+    desc "Check if the search daemon is running"
+    task :status => [:_environment] do
+      if ultrasphinx_daemon_running?
+        say "daemon is running."
+      else
+        say "daemon is stopped."
+      end
+    end      
+  end
+          
+    
+  namespace :spelling do
+    desc "Rebuild the custom spelling dictionary. You may need to use 'sudo' if your Aspell folder is not writable by the app user."
+    task :build => [:_environment] do    
+      ENV['OPTS'] = "--buildstops #{Ultrasphinx::STOPWORDS_PATH} #{Ultrasphinx::MAX_WORDS} --buildfreqs"
+      Rake::Task["ultrasphinx:index"].invoke
+      tmpfile = "/tmp/ultrasphinx-stopwords.txt"
+      words = []
+      say "filtering"
+      File.open(Ultrasphinx::STOPWORDS_PATH).each do |line|
+        if line =~ /^([^\s\d_]{4,}) (\d+)/
+          # XXX should be configurable
+          words << $1 if $2.to_i > 40 
+          # ideally we would also skip words within X edit distance of a correction
+          # by aspell-en, in order to not add typos to the dictionary
+        end
+      end
+      say "writing #{words.size} words"
+      File.open(tmpfile, 'w').write(words.join("\n"))
+      say "loading dictionary '#{Ultrasphinx::DICTIONARY}' into aspell"
+      system("aspell --lang=en create master #{Ultrasphinx::DICTIONARY}.rws < #{tmpfile}")
+    end
+  end
+  
+end
+
+# task shortcuts
+namespace :us do
+  task :start => ["ultrasphinx:daemon:start"]
+  task :restart => ["ultrasphinx:daemon:restart"]
+  task :stop => ["ultrasphinx:daemon:stop"]
+  task :stat => ["ultrasphinx:daemon:status"]
+  task :index => ["ultrasphinx:index"]
+  task :in => ["ultrasphinx:index"]
+  task :main => ["ultrasphinx:index:main"]
+  task :delta => ["ultrasphinx:index:delta"]
+  task :merge => ["ultrasphinx:index:merge"]
+  task :spell => ["ultrasphinx:spelling:build"]
+  task :conf => ["ultrasphinx:configure"]  
+  task :boot => ["ultrasphinx:bootstrap"]  
+end
+
+# Support methods
+
+def ultrasphinx_daemon_pid
+  open(Ultrasphinx::DAEMON_SETTINGS['pid_file']).readline.chomp rescue nil
+end
+
+def ultrasphinx_daemon_running?
+  if ultrasphinx_daemon_pid and `ps -p#{ultrasphinx_daemon_pid} | wc`.to_i > 1 
+    true
+  else
+    # Remove bogus lockfiles.
+    Dir[Ultrasphinx::INDEX_SETTINGS["path"] + "*spl"].each {|file| File.delete(file)}
+    false
+  end  
+end
+
+def ultrasphinx_index(index)
+  rotate = ultrasphinx_daemon_running?
+  ultrasphinx_create_index_path
+  
+  cmd = "indexer --config '#{Ultrasphinx::CONF_PATH}'"
+  cmd << " #{ENV['OPTS']} " if ENV['OPTS']
+  cmd << " --rotate" if rotate
+  cmd << " #{index}"
+  
+  say "$ #{cmd}"
+  system cmd
+    
+  ultrasphinx_check_rotate if rotate    
+end
+
+def ultrasphinx_merge
+  rotate = ultrasphinx_daemon_running?
+
+  indexes = [Ultrasphinx::MAIN_INDEX, Ultrasphinx::DELTA_INDEX]
+  indexes.each do |index|
+    raise "#{index} index is missing" unless File.exist? "#{Ultrasphinx::INDEX_SETTINGS['path']}/sphinx_index_#{index}.spa"
+  end
+  
+  cmd = "indexer --config '#{Ultrasphinx::CONF_PATH}'"
+  cmd << " #{ENV['OPTS']} " if ENV['OPTS']
+  cmd << " --rotate" if rotate
+  cmd << " --merge #{indexes.join(' ')}"
+  
+  say "$ #{cmd}"
+  system cmd
+      
+  ultrasphinx_check_rotate if rotate
+end
+
+def ultrasphinx_check_rotate
+  sleep(4)
+  failed = Dir[Ultrasphinx::INDEX_SETTINGS['path'] + "/*.new.*"]
+  if failed.any?
+    say "warning; index failed to rotate! Deleting new indexes"
+    say "try 'killall searchd' and then 'rake ultrasphinx:daemon:start'"
+    failed.each {|f| File.delete f }
+  else
+    say "index rotated ok"
+  end
+end
+
+def ultrasphinx_create_index_path
+  unless File.directory? Ultrasphinx::INDEX_SETTINGS['path']
+    mkdir_p Ultrasphinx::INDEX_SETTINGS['path'] 
+  end
+end
+
+def say msg
+  Ultrasphinx.say msg
+end
+  

data/vendor/riddle/MIT-LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Pat Allan
+
+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/vendor/riddle/README

@@ -0,0 +1,74 @@
+This client has been written to interface with Sphinx[http://sphinxsearch.com/]. It is written by
+{Pat Allan}[http://freelancing-gods.com], and has been influenced by both Dmytro Shteflyuk's Ruby
+client and the original PHP client - credit where credit's due, after all.
+
+It does not follow the same syntax as those two, though (not much point writing this otherwise) -
+opting for a more Ruby-like structure.
+
+The easiest way to install is to grab the gem (available since 0.9.8r1112 only):
+
+  sudo gem install riddle
+
+However, if you're so inclined, you can grab sourcecode via subversion. If you
+are after a specific release, use the tag as follows:
+
+  svn co http://rails-oceania.googlecode.com/svn/patallan/riddle/tags/0.9.8-rc2 riddle
+
+Or for the most current, just use trunk:
+
+  svn co http://rails-oceania.googlecode.com/svn/patallan/riddle/trunk riddle
+
+Please note that at the time of writing, the following versions are supported (if you get the appropriate tag):
+
+* 0.9.8-r871
+* 0.9.8-r909
+* 0.9.8-r985
+* 0.9.8-r1065
+* 0.9.8-r1112
+* 0.9.8-rc1 (gem version: 0.9.8.1198)
+* 0.9.8-rc2 (gem version: 0.9.8.1231)
+
+To get started, just instantiate a Client object:
+
+  client = Riddle::Client.new # defaults to localhost and port 3312
+  client = Riddle::Client.new "sphinxserver.domain.tld", 3333 # custom settings
+  
+And then set the parameters to what you want, before running a query:
+
+  client.match_mode = :extended
+  client.query "Pat Allan @state Victoria"
+  
+The results from a query are similar to the other clients - but here's the details. It's a hash with
+the following keys:
+
+* :matches
+* :fields
+* :attributes
+* :attribute_names
+* :words
+* :total
+* :total_found
+* :time
+* :status
+* :warning (if appropriate)
+* :error (if appropriate)
+
+The key <tt>:matches</tt> returns an array of hashes - the actual search results. Each hash has the
+document id (<tt>:doc</tt>), the result weighting (<tt>:weight</tt>), and a hash of the attributes for
+the document (<tt>:attributes</tt>).
+
+The <tt>:fields</tt> and <tt>:attribute_names</tt> keys return list of fields and attributes for the
+documents. The key <tt>:attributes</tt> will return a hash of attribute name and type pairs, and
+<tt>:words</tt> returns a hash of hashes representing the words from the search, with the number of
+documents and hits for each, along the lines of:
+
+  results[:words]["Pat"] #=> {:docs => 12, :hits => 15}
+  
+<tt>:total</tt>, <tt>:total_found</tt> and <tt>:time</tt> return the number of matches available, the
+total number of matches (which may be greater than the maximum available), and the time in milliseconds
+that the query took to run.
+
+<tt>:status</tt> is the error code for the query - and if there was a related warning, it will be under
+the <tt>:warning</tt> key. Fatal errors will be described under <tt>:error</tt>.
+
+If you've installed the gem and wondering why there's no tests - check out the svn version. I've kept the specs out of the gem as I have a decent amount of test data in there, which really isn't needed unless you want to submit patches.

data/vendor/riddle/Rakefile

@@ -0,0 +1,117 @@
+require 'rake'
+require 'rake/packagetask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require 'rdoc/rdoc'
+require 'rdoc/generators/html_generator'
+require 'rdoc/generators/template/html/html'
+
+module Generators
+  class HtmlFile < ContextUser
+    alias_method :core_attribute_values, :file_attribute_values
+    
+    def file_attribute_values
+      core_attribute_values
+      
+      @values["analytics"] = @options.analytics if @options.analytics
+    end
+  end
+  
+  class HtmlClass < ContextUser
+    alias_method :core_attribute_values, :class_attribute_values
+    
+    def class_attribute_values
+      core_attribute_values
+      
+      @values["analytics"] = @options.analytics if @options.analytics
+    end
+  end
+end
+
+class Options
+  attr_accessor :analytics
+  
+  module OptionList
+    OPTION_LIST << [
+      "--analytics", "-y", "code", "Google Analytics Code"
+    ]
+  end
+  
+  alias_method :core_parse, :parse
+  
+  def parse(argv, generators)
+    core_parse(argv, generators)
+    
+    old_args = ARGV.dup
+    ARGV.replace(argv)
+        
+    go = GetoptLong.new(*OptionList.options)
+    go.quiet = true
+    
+    go.each do |opt, arg|
+      case opt
+      when "--analytics"
+        @analytics = arg.strip
+      end
+    end
+    
+    ARGV.replace(old_args)
+  end
+    
+end
+
+module RDoc
+  module Page
+    remove_const :FOOTER
+    const_set :FOOTER, %{
+    <div id="validator-badges">
+      <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    </div>
+    <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+    </script>
+    <script type="text/javascript">
+      _uacct = "%analytics%";
+      urchinTracker();
+    </script>
+    
+    </body>
+    </html>
+    }
+    
+    remove_const :BODY
+    const_set :BODY, HEADER + %{
+
+    !INCLUDE!  <!-- banner header -->
+
+      <div id="bodyContent">
+
+    } +  METHOD_LIST + %{
+
+      </div>
+
+    } + FOOTER
+  end
+end
+
+desc 'Generate documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Riddle - Ruby Sphinx Client'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '-y US-2475317-6'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Run Riddle's specs"
+Spec::Rake::SpecTask.new do |t|
+  t.libs << 'lib'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.libs << 'lib'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems']
+end

data/vendor/riddle/lib/riddle/client/filter.rb

@@ -0,0 +1,44 @@
+module Riddle
+  class Client
+    # Used for querying Sphinx.
+    class Filter
+      attr_accessor :attribute, :values, :exclude
+      
+      # Attribute name, values (which can be an array or a range), and whether
+      # the filter should be exclusive.
+      def initialize(attribute, values, exclude=false)
+        @attribute, @values, @exclude = attribute, values, exclude
+      end
+      
+      def exclude?
+        self.exclude
+      end
+      
+      # Returns the message for this filter to send to the Sphinx service
+      def query_message
+        message = Message.new
+        
+        message.append_string self.attribute
+        case self.values
+        when Range
+          if self.values.first.is_a?(Float) && self.values.last.is_a?(Float)
+            message.append_int FilterTypes[:float_range]
+            message.append_floats self.values.first, self.values.last
+          else
+            message.append_int FilterTypes[:range]
+            message.append_ints self.values.first, self.values.last
+          end
+        when Array
+          message.append_int FilterTypes[:values]
+          message.append_int self.values.length
+          # using to_f is a hack from the php client - to workaround 32bit
+          # signed ints on x32 platforms
+          message.append_ints *self.values.collect { |val| val.to_f }
+        end
+        message.append_int self.exclude? ? 1 : 0
+        
+        message.to_s
+      end
+    end
+  end
+end