dnif 0.0.1.alpha.2

data/README.rdoc

@@ -0,0 +1,57 @@
+= dnif
+
+dnif is the new find... for sphinx
+
+dnif is a gem to index data using ActiveRecord finders, letting you index your custom methods and not your table fields
+
+== Usage
+
+  require "dnif"
+
+  class Post < ActiveRecord::Base
+
+    define_index do
+      field :title
+      field :body
+      attribute :published_at, :type => :datetime
+
+      where ["draft = ?", false]
+    end
+
+    def slug
+      self.title.parameterize
+    end
+  end
+
+  Post.search("dnif")
+
+== TODO
+
+- Improve the test suite
+
+== Maintainer
+
+* Rafael Souza - http://rafaelss.com/
+
+== License
+
+(The MIT License)
+
+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/Rakefile

@@ -0,0 +1,38 @@
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "dnif"
+    gemspec.summary = "dnif is the new find... for sphinx"
+    gemspec.description = "dnif is a gem to index data using ActiveRecord finders, letting you index your custom methods and not your table fields "
+    gemspec.email = "me@rafaelss.com"
+    gemspec.homepage = "http://github.com/rafaelss/dnif"
+    gemspec.authors = ["Rafael Souza"]
+
+    gemspec.has_rdoc = false
+    gemspec.files = %w(Rakefile dnif.gemspec README.rdoc) + Dir["{lib,test}/**/*"]
+
+    gemspec.add_dependency "activerecord"
+    gemspec.add_dependency "activesupport"
+    gemspec.add_dependency "riddle"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+desc "Generate gemspec and build gem"
+task :build_gem do
+  Rake::Task["gemspec"].invoke
+  Rake::Task["build"].invoke
+end
+
+Jeweler::GemcutterTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.test_files = FileList.new('test/**/test_*.rb') do |list|
+    list.exclude 'test/test_helper.rb'
+  end
+  test.libs << 'test'
+  test.verbose = true
+end

data/dnif.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dnif}
+  s.version = "0.0.1.alpha.2"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rafael Souza"]
+  s.date = %q{2010-07-01}
+  s.description = %q{dnif is a gem to index data using ActiveRecord finders, letting you index your custom methods and not your table fields }
+  s.email = %q{me@rafaelss.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "README.rdoc",
+     "Rakefile",
+     "dnif.gemspec",
+     "lib/dnif.rb",
+     "lib/dnif/configuration.rb",
+     "lib/dnif/index_builder.rb",
+     "lib/dnif/indexer.rb",
+     "lib/dnif/multi_attribute.rb",
+     "lib/dnif/search.rb",
+     "lib/dnif/tasks.rb",
+     "test/fixtures/db/schema.rb",
+     "test/fixtures/log/searchd.pid",
+     "test/fixtures/models.rb",
+     "test/fixtures/templates/config.erb",
+     "test/test_helper.rb",
+     "test/unit/test_configuration.rb",
+     "test/unit/test_dnif.rb",
+     "test/unit/test_index_builder.rb",
+     "test/unit/test_indexer.rb",
+     "test/unit/test_multi_attribute.rb",
+     "test/unit/test_search.rb"
+  ]
+  s.homepage = %q{http://github.com/rafaelss/dnif}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{dnif is the new find... for sphinx}
+  s.test_files = [
+    "test/fixtures/db/schema.rb",
+     "test/fixtures/models.rb",
+     "test/test_helper.rb",
+     "test/unit/test_configuration.rb",
+     "test/unit/test_dnif.rb",
+     "test/unit/test_index_builder.rb",
+     "test/unit/test_indexer.rb",
+     "test/unit/test_multi_attribute.rb",
+     "test/unit/test_search.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<riddle>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<riddle>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<riddle>, [">= 0"])
+  end
+end
+

data/lib/dnif.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'active_record'
+require 'active_support'
+require 'riddle'
+
+require "dnif/configuration"
+require "dnif/index_builder"
+require "dnif/indexer"
+require "dnif/multi_attribute"
+require "dnif/search"
+
+module Dnif
+
+  def self.root_path
+    @root_path
+  end
+
+  def self.root_path=(value)
+    @root_path = value
+  end
+
+  def self.environment
+    @environment || 'development'
+  end
+
+  def self.environment=(value)
+    @environment = value
+  end
+
+  def self.models_path
+    @models_path
+  end
+
+  def self.models_path=(value)
+    @models_path = value
+  end
+
+  def self.load_models
+    models = Dir["#{self.models_path}/*.rb"]
+    models.map! do |filename|
+      filename = File.basename(filename, '.rb')
+      filename.classify.constantize
+    end
+  end
+end
+
+if defined?(Rails)
+  Dnif.root_path = RAILS_ROOT
+  Dnif.environment = RAILS_ENV
+  Dnif.models_path = File.join(RAILS_ROOT, "app", "models")
+end

data/lib/dnif/configuration.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+require 'tilt'
+require 'dnif'
+
+module Dnif
+
+  class Configuration
+
+    def self.generate(config_path)
+      Tilt.register 'erb', Tilt::ErubisTemplate
+
+      template = Tilt.new(config_path)
+      output = template.render(self)
+
+      # TODO turn "db/sphinx" and "config/sphinx" configurable
+      FileUtils.mkdir_p(File.join(Dnif.root_path, "db", "sphinx", Dnif.environment))
+      File.open(Dnif.root_path + "/config/sphinx/" + Dnif.environment + ".conf", "w") do |f|
+        f.puts output
+      end
+    end
+
+    def self.sources
+      classes = ActiveRecord::Base.classes.keys
+      classes.each do |class_name|
+        name = class_name.underscore.pluralize + "_main"
+        yield name, class_name
+      end
+    end
+  end
+end

data/lib/dnif/index_builder.rb

@@ -0,0 +1,30 @@
+module Dnif
+  class IndexBuilder
+
+    attr_reader :fields
+    attr_reader :attributes
+    attr_reader :conditions
+
+    def initialize(object, &block)
+      @fields = []
+      @attributes = {}
+
+      @object = object
+      self.instance_eval(&block)
+    end
+
+    def field(name)
+      @fields << name
+    end
+
+    def attribute(name, options)
+      raise "You must specify the attribute type (:integer, :datetime, :date, :boolean, :float)" if options[:type].nil?
+
+      @attributes[name] = options[:type]
+    end
+
+    def where(conditions)
+      @conditions = conditions
+    end
+  end
+end

data/lib/dnif/indexer.rb

@@ -0,0 +1,92 @@
+module Dnif
+  module Indexer
+
+    def define_index(&block)
+      classes[self.name] = IndexBuilder.new(self, &block)
+      classes[self.name]
+
+      include InstanceMethods
+    end
+
+    def classes
+      @@classes ||= ActiveSupport::OrderedHash.new
+    end
+
+    def to_sphinx
+      return nil if classes.blank?
+
+      returning('') do |xml|
+        builder = classes[self.name]
+        results = all(:conditions => builder.conditions)
+
+        xml << "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<sphinx:docset>\n"
+
+        xml << "<sphinx:schema>\n"
+        builder.fields.each do |name|
+          xml << "  <sphinx:field name=\"#{name}\"/>\n"
+        end
+
+        xml << "  <sphinx:attr name=\"class_id\" type=\"multi\"/>\n"
+        builder.attributes.each do |name, type|
+          xml << "  <sphinx:attr name=\"#{name}\" "
+
+          case type
+          when :integer
+            xml << "type=\"int\""
+          when :date, :datetime
+            xml << "type=\"timestamp\""
+          when :boolean
+            xml << "type=\"bool\""
+          when :float
+            xml << "type=\"float\""
+          end
+
+          xml << "/>\n"
+        end
+
+        xml << "</sphinx:schema>\n"
+
+        results.each do |object|
+          xml << object.to_sphinx
+        end
+        xml << "</sphinx:docset>"
+      end
+    end
+
+    module InstanceMethods
+
+      def to_sphinx
+        builder = ActiveRecord::Base.classes[self.class.name]
+        if not builder.nil?
+          class_id = Dnif::MultiAttribute.encode(self.class.name)
+          sphinx_id = id + class_id.split(',').sum { |c| c.to_i }
+          xml = "<sphinx:document id=\"#{sphinx_id}\">\n"
+
+          builder.fields.each do |field|
+            xml << "  <#{field}><![CDATA[[#{send(field)}]]></#{field}>\n"
+          end
+
+          xml << "  <class_id>#{class_id}</class_id>\n"
+
+          builder.attributes.each do |name, type|
+            value = send(name)
+
+            if [:date, :datetime].include?(builder.attributes[name])
+              if value.is_a?(Date)
+                value = value.to_datetime
+              end
+
+              value = value.to_i
+            end
+
+            xml << "  <#{name}>#{value}</#{name}>\n"
+          end
+
+          xml << "</sphinx:document>\n"
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend(Dnif::Indexer)

data/lib/dnif/multi_attribute.rb

@@ -0,0 +1,52 @@
+# Code extracted from MongoSphinx
+# http://github.com/burke/mongosphinx/blob/master/lib/multi_attribute.rb
+module Dnif
+
+  # Module MultiAttribute implements helpers to translate back and
+  # forth between Ruby Strings and an array of integers suitable for Sphinx
+  # attributes of type "multi".
+  #
+  # Background: Getting an ID as result for a query is OK, but for example to
+  # allow cast safety, we need an aditional attribute. Sphinx supports
+  # attributes which are returned together with the ID, but they behave a
+  # little different than expected: Instead we can use arrays of integers with
+  # ASCII character codes. These values are returned in ascending (!) order of
+  # value (yes, sounds funny but is reasonable from an internal view to
+  # Sphinx). So we mask each byte with 0x0100++ to keep the order...
+  #
+  # Sample:
+  #
+  #   MongoSphinx::MultiAttribute.encode('Hello')
+  #   => "328,613,876,1132,1391"
+  #   MongoSphinx::MultiAttribute.decode('328,613,876,1132,1391')
+  #   => "Hello"
+
+  module MultiAttribute
+
+    # Returns an numeric representation of a Ruby String suitable for "multi"
+    # attributes of Sphinx.
+    #
+    # Parameters:
+    #
+    # [str] String to translate
+
+    def self.encode(str)
+      offset = 0
+      return str.bytes.collect { |c| (offset+= 0x0100) + c }.join(',')
+    end
+
+    # Returns the original MongoDB ID created from a Sphinx ID. Only works if
+    # the ID was created from a MongoDB ID before!
+    #
+    # Parameters:
+    #
+    # [multi] Sphinx "multi" attribute to translate back
+
+    def self.decode(multi)
+      multi = multi.split(',') if not multi.is_a?(Array)
+
+      offset = 0
+      return multi.collect { |x| (x.to_i - (offset += 0x0100)).chr }.join("")
+    end
+  end
+end

data/lib/dnif/search.rb

@@ -0,0 +1,38 @@
+module Dnif
+
+  def self.search(query, options = {})
+    options.reverse_merge!(:index => '*')
+
+    client = Riddle::Client.new("127.0.0.1", 3313)
+
+    if not options[:class].nil?
+      filter_value = Dnif::MultiAttribute.encode(options[:class]).split(",").map(&:to_i)
+      client.filters << Riddle::Client::Filter.new("class_id", filter_value)
+    end
+
+    results = client.query(query, options[:index])
+    raise results[:error] if results[:error]
+
+    models = results[:matches].inject({}) do |memo, match|
+      class_id = match[:attributes]["class_id"].split(',')
+      class_name = Dnif::MultiAttribute.decode(class_id)
+
+      memo[class_name] ||= []
+      memo[class_name] << (match[:doc] - class_id.sum { |c| c.to_i })
+      memo
+    end
+
+    models.map do |class_name, ids|
+      class_name.constantize.find_all_by_id(ids)
+    end.flatten
+  end
+
+  module Search
+
+    def search(query)
+      Dnif.search(query, :class => self.name)
+    end
+  end
+end
+
+ActiveRecord::Base.extend(Dnif::Search)

data/lib/dnif/tasks.rb

@@ -0,0 +1,76 @@
+require 'active_support'
+require 'fileutils'
+require 'dnif'
+
+def controller
+  require 'riddle'
+
+  root_path = Dnif.root_path || "."
+
+  configuration = Riddle::Configuration.new
+  configuration.searchd.pid_file   = "#{root_path}/log/searchd.#{Dnif.environment}.pid"
+  configuration.searchd.log        = "#{root_path}/log/searchd.log"
+  configuration.searchd.query_log  = "#{root_path}/log/searchd.query.log"
+
+  Riddle::Controller.new(configuration, "#{root_path}/config/sphinx/#{Dnif.environment}.conf")
+end
+
+namespace :dnif do
+
+  task :environment do
+    if task = Rake::Task[:environment]
+      task.invoke
+    end
+  end
+
+  desc "Generates the configuration file needed for sphinx"
+  task :configure => :environment do
+    if Dnif.models_path.nil?
+      puts "You need to specify where are your models (ex: Dnif.models_path = \"path/for/your/models\")"
+      exit
+    end
+
+    Dnif.root_path ||= File.expand_path(File.dirname("."))
+    Dnif.environment ||= "development"
+
+    config_path = File.join(Dnif.root_path, "config/sphinx")
+    if not File.exist?(config_path)
+      FileUtils.mkdir_p(config_path)
+    end
+
+    base_path = File.join(config_path, Dnif.environment + ".erb")
+    if not File.exist?(base_path)
+      FileUtils.cp(File.dirname(__FILE__) + "/../../test/fixtures/templates/config.erb", base_path) # TODO change this path. find out how this kind of stuff is handle in others gems
+    end
+
+    Dnif.load_models
+    Dnif::Configuration.generate(base_path)
+  end
+
+  desc "Generates the XML used by sphinx to create indexes"
+  task :xml => :environment do
+    ::ActiveRecord::Base.logger = Logger.new(StringIO.new)
+    Dnif.load_models
+
+    klass = ENV['MODEL'].constantize
+    puts klass.to_sphinx
+  end
+
+  desc "Index data for sphinx"
+  task :index => :environment do
+    controller.index(:verbose => true)
+  end
+
+  desc "Stop sphinx daemon"
+  task :stop => :environment do
+    controller.stop
+  end
+
+  desc "Start sphinx daemon"
+  task :start => :environment do
+    controller.start
+  end
+
+  desc "Rebuild sphinx index"
+  task :rebuild => [:index, :stop, :start]
+end

data/test/fixtures/db/schema.rb

@@ -0,0 +1,33 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table "comments", :force => true do |t|
+    t.string :author
+  end
+  
+  create_table "users", :force => true do |t|
+    t.string :name
+  end
+
+  create_table "people", :force => true do |t|
+    t.string :first_name
+    t.string :last_name
+  end
+
+  create_table "posts", :force => true do |t|
+    t.string :title
+    t.datetime :published_at
+    t.boolean :draft, :default => true
+  end
+
+  create_table "sales", :force => true do |t|
+    t.datetime :ordered_at
+  end
+
+  create_table "notes", :force => true do |t|
+    t.integer :clicked
+    t.datetime :published_at
+    t.date :expire_at
+    t.boolean :active
+    t.float :points
+  end
+end

data/test/fixtures/models.rb

@@ -0,0 +1,19 @@
+class Post < ActiveRecord::Base
+
+  define_index do
+    field :title
+    attribute :published_at, :type => :datetime
+    attribute :draft, :type => :boolean
+  end
+end
+
+class Comment < ActiveRecord::Base
+
+  define_index do
+    field :full_author
+  end
+
+  def full_author
+    "full author name"
+  end
+end

data/test/fixtures/templates/config.erb

@@ -0,0 +1,38 @@
+# Hand modifications will be overwritten.
+indexer {
+  mem_limit = 512M
+}
+
+searchd {
+  listen = 127.0.0.1:3313
+  seamless_rotate = 1
+  log = <%= Dnif.root_path %>/log/searchd.<%= Dnif.environment %>.log
+  query_log = <%= Dnif.root_path %>/log/query.<%= Dnif.environment %>.log
+  read_timeout = 5
+  max_children = 300
+  pid_file = <%= Dnif.root_path %>/log/searchd.<%= Dnif.environment %>.pid
+  max_matches = 1000
+}
+
+<% sources do |name, model| %>
+source <%= name %>
+{
+  type = xmlpipe2
+  xmlpipe_command = MODEL=<%= model %> rake dnif:xml --silent
+}
+<% end %>
+
+index main
+{
+  <% sources do |name| %>
+    source = <%= name %>
+  <% end %>
+  path = <%= Dnif.root_path %>/db/sphinx/<%= Dnif.environment %>/index_main
+  docinfo = extern
+  morphology = none
+  min_word_len = 1
+  html_strip = 0
+  html_index_attrs = 
+  charset_type = utf-8
+  charset_table = 0..9, A..Z->a..z, -, _, ., &, a..z, U+410..U+42F->U+430..U+44F, U+430..U+44F,U+C5->U+E5, U+E5, U+C4->U+E4, U+E4, U+D6->U+F6, U+F6, U+16B, U+0c1->a, U+0c4->a, U+0c9->e, U+0cd->i, U+0d3->o, U+0d4->o, U+0da->u, U+0dd->y, U+0e1->a, U+0e4->a, U+0e9->e, U+0ed->i, U+0f3->o, U+0f4->o, U+0fa->u, U+0fd->y, U+104->U+105, U+105, U+106->U+107, U+10c->c, U+10d->c, U+10e->d, U+10f->d, U+116->U+117, U+117, U+118->U+119, U+11a->e, U+11b->e, U+12E->U+12F, U+12F, U+139->l, U+13a->l, U+13d->l, U+13e->l, U+141->U+142, U+142, U+143->U+144, U+144,U+147->n, U+148->n, U+154->r, U+155->r, U+158->r, U+159->r, U+15A->U+15B, U+15B, U+160->s, U+160->U+161, U+161->s, U+164->t, U+165->t, U+16A->U+16B, U+16B, U+16e->u, U+16f->u, U+172->U+173, U+173, U+179->U+17A, U+17A, U+17B->U+17C, U+17C, U+17d->z, U+17e->z,
+}

data/test/test_helper.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+# $:.unshift(File.dirname(__FILE__) + "/../../lib/")
+
+require "test/unit"
+require "mocha"
+require "active_record"
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require "dnif"
+
+Dnif.root_path = File.expand_path(File.dirname(__FILE__) + "/fixtures")
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+silence_stream(STDOUT) { load "fixtures/db/schema.rb" }
+
+class Post
+
+  extend Dnif::Search
+end
+
+class Comment
+
+  extend Dnif::Search
+end
+
+class User < ActiveRecord::Base
+
+  define_index do
+    field :name
+  end
+end
+
+class Category < ActiveRecord::Base
+end
+
+class Property < ActiveRecord::Base
+end
+
+class Person < ActiveRecord::Base
+
+  define_index do
+    field :full_name
+  end
+
+  def full_name
+    "#{self.first_name} #{self.last_name}"
+  end
+end
+
+class Order < ActiveRecord::Base
+
+  define_index do
+    field :buyer
+
+    where ["ordered_at >= ?", 2.months.ago]
+  end
+end
+
+class Note < ActiveRecord::Base
+
+  define_index do
+    attribute :clicked, :type => :integer
+    attribute :published_at, :type => :datetime
+    attribute :expire_at, :type => :date
+    attribute :active, :type => :boolean
+    attribute :points, :type => :float
+  end
+end

data/test/unit/test_configuration.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require 'test_helper'
+require 'erb'
+
+class TestConfiguration < Test::Unit::TestCase
+
+  test "generate configuration from default template" do
+    Tilt.expects(:register).with('erb', Tilt::ErubisTemplate)
+
+    template = mock("Template")
+    template.expects(:render).with(Dnif::Configuration).returns('output')
+    Tilt.expects(:new).with("config/path.erb").returns(template)
+
+    file = mock
+    file.expects(:puts).with('output')
+    File.expects(:open).with(Dnif.root_path + "/config/sphinx/development.conf", "w").yields(file)
+
+    Dnif::Configuration.generate("config/path.erb")
+  end
+
+  test "sources should iterate over all indexed classes" do
+    names = []
+    classes = []
+    Dnif::Configuration.sources do |name, class_name|
+      names << name
+      classes << class_name
+    end
+
+    assert_equal ["users_main", "people_main", "orders_main", "notes_main"], names
+    assert_equal ["User", "Person", "Order", "Note"], classes
+  end
+end

data/test/unit/test_dnif.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestDnif < Test::Unit::TestCase
+
+  test ".root_path" do
+    Dnif.root_path = "/root/path"
+    assert_equal "/root/path", Dnif.root_path
+  end
+
+  test ".environment" do
+    assert_equal "development", Dnif.environment
+    Dnif.environment = "production"
+    assert_equal "production", Dnif.environment
+  end
+
+  test ".models_path" do
+    Dnif.models_path = "/models/path"
+    assert_equal "/models/path", Dnif.models_path
+  end
+end

data/test/unit/test_index_builder.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestIndexBuilder < Test::Unit::TestCase
+
+  test "object" do
+    instance = Object.new
+    assert_equal instance, Dnif::IndexBuilder.new(instance, & proc {}).instance_variable_get("@object")
+  end
+
+  test "fields" do
+    builder = Dnif::IndexBuilder.new(Object.new, & proc {})
+    builder.field(:first_name)
+    builder.field(:last_name)
+
+    assert_equal [:first_name, :last_name], builder.fields
+  end
+
+  test "attribute" do
+    builder = Dnif::IndexBuilder.new(Object.new, & proc {})
+    builder.attribute(:ordered_at, :type => :datetime)
+
+    expected =  { :ordered_at => :datetime }
+    assert_equal expected, builder.attributes
+  end
+
+  test "where" do
+    builder = Dnif::IndexBuilder.new(Object.new, & proc {})
+    builder.where("status = 'active'")
+
+    assert_equal "status = 'active'", builder.conditions
+  end
+end

data/test/unit/test_indexer.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestIndexer < Test::Unit::TestCase
+
+  test "objects without index should not have dnif included" do
+    assert_false Post.new.respond_to?(:to_sphinx)
+    assert_false Post.respond_to?(:to_sphinx)
+  end
+
+  test "to_sphinx returns a string with sphinx document" do
+    comment = Person.create!(:first_name => "Rafael", :last_name => "Souza")
+
+    expected = "<sphinx:document id=\"6009\">\n  <full_name><![CDATA[[Rafael Souza]]></full_name>\n  <class_id>336,613,882,1139,1391,1646</class_id>\n</sphinx:document>\n"
+    assert_equal expected, comment.to_sphinx
+  end
+
+  test "attributes" do
+    note = Note.create!(:clicked => 10, :published_at => (now = DateTime.now), :expire_at => (expire = Date.today + 2.days), :active => true, :points => 1000)
+
+    expected = "<sphinx:document id=\"2967\">\n  <class_id>334,623,884,1125</class_id>\n  <clicked>10</clicked>\n  <published_at>#{now.to_i}</published_at>\n  <expire_at>#{expire.to_datetime.to_i}</expire_at>\n  <active>true</active>\n  <points>1000.0</points>\n</sphinx:document>\n"
+    assert_equal expected, note.to_sphinx
+  end
+
+  test ".to_sphinx should generate a full sphinx xml" do
+    comment = Person.create!(:first_name => "Rafael", :last_name => "Souza")
+
+    expected = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<sphinx:docset>\n<sphinx:schema>\n  <sphinx:field name=\"full_name\"/>\n  <sphinx:attr name=\"class_id\" type=\"multi\"/>\n</sphinx:schema>\n#{comment.to_sphinx}</sphinx:docset>"
+    assert_equal expected, Person.to_sphinx
+  end
+  
+  test "return all indexed classes" do
+    assert_equal ["User", "Person", "Order", "Note"], ActiveRecord::Base.classes.keys
+  end
+end

data/test/unit/test_multi_attribute.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestMultiAttribute < Test::Unit::TestCase
+  
+  test ".encode" do
+    assert_equal "324,622,873,1126", Dnif::MultiAttribute.encode("Dnif")
+  end
+
+  test ".decode" do
+    assert_equal "Dnif", Dnif::MultiAttribute.decode("324,622,873,1126")
+  end
+
+  test ".decode as array" do
+    assert_equal "Dnif", Dnif::MultiAttribute.decode(["324", "622", "873", "1126"])
+  end
+end

data/test/unit/test_search.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestSearch < Test::Unit::TestCase
+
+  test "search" do
+    results_for_post = {
+      :matches => [{
+        :doc => 2983,
+        :attributes => {
+          "class_id" => "336,623,883,1140"
+        }
+      }]
+    }
+    results_for_comment = {
+      :matches => [{
+        :doc => 7893,
+        :attributes => {
+          "class_id" => "323,623,877,1133,1381,1646,1908"
+        }
+      }]
+    }
+
+    Riddle::Client.any_instance.expects(:query).times(2).with("post", "*").returns(results_for_post, results_for_comment)
+
+    Post.expects(:find_all_by_id).once.with([1])
+    Comment.expects(:find_all_by_id).once.with([2])
+
+    Post.search("post")
+    Comment.search("post")
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: dnif
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 0
+  - 1
+  - alpha
+  - 2
+  version: 0.0.1.alpha.2
+platform: ruby
+authors: 
+- Rafael Souza
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-01 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: riddle
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: "dnif is a gem to index data using ActiveRecord finders, letting you index your custom methods and not your table fields "
+email: me@rafaelss.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- dnif.gemspec
+- lib/dnif.rb
+- lib/dnif/configuration.rb
+- lib/dnif/index_builder.rb
+- lib/dnif/indexer.rb
+- lib/dnif/multi_attribute.rb
+- lib/dnif/search.rb
+- lib/dnif/tasks.rb
+- test/fixtures/db/schema.rb
+- test/fixtures/log/searchd.pid
+- test/fixtures/models.rb
+- test/fixtures/templates/config.erb
+- test/test_helper.rb
+- test/unit/test_configuration.rb
+- test/unit/test_dnif.rb
+- test/unit/test_index_builder.rb
+- test/unit/test_indexer.rb
+- test/unit/test_multi_attribute.rb
+- test/unit/test_search.rb
+has_rdoc: true
+homepage: http://github.com/rafaelss/dnif
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: dnif is the new find... for sphinx
+test_files: 
+- test/fixtures/db/schema.rb
+- test/fixtures/models.rb
+- test/test_helper.rb
+- test/unit/test_configuration.rb
+- test/unit/test_dnif.rb
+- test/unit/test_index_builder.rb
+- test/unit/test_indexer.rb
+- test/unit/test_multi_attribute.rb
+- test/unit/test_search.rb