dnif 0.0.1.alpha.7 → 0.0.1.beta.1

data/dnif.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dnif}
-  s.version = "0.0.1.alpha.7"
+  s.version = "0.0.1.beta.1"
 
   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-02}
+  s.date = %q{2010-07-14}
   s.description = %q{dnif is a gem to index data using ActiveRecord finders, letting you index your custom methods and not only your table fields}
   s.email = %q{me@rafaelss.com}
   s.extra_rdoc_files = [
@@ -21,21 +21,32 @@ Gem::Specification.new do |s|
      "dnif.gemspec",
      "lib/dnif.rb",
      "lib/dnif/configuration.rb",
+     "lib/dnif/document.rb",
+     "lib/dnif/index.rb",
      "lib/dnif/index_builder.rb",
      "lib/dnif/indexer.rb",
      "lib/dnif/multi_attribute.rb",
+     "lib/dnif/schema.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/sphinx_1.xml",
+     "test/fixtures/sphinx_2.xml",
+     "test/fixtures/sphinx_3.xml",
+     "test/fixtures/sphinx_4.xml",
+     "test/fixtures/sphinx_5.xml",
      "test/fixtures/templates/config.erb",
      "test/test_helper.rb",
      "test/unit/test_configuration.rb",
      "test/unit/test_dnif.rb",
+     "test/unit/test_document.rb",
+     "test/unit/test_index.rb",
      "test/unit/test_index_builder.rb",
      "test/unit/test_indexer.rb",
      "test/unit/test_multi_attribute.rb",
+     "test/unit/test_schema.rb",
      "test/unit/test_search.rb"
   ]
   s.homepage = %q{http://github.com/rafaelss/dnif}
@@ -49,9 +60,12 @@ Gem::Specification.new do |s|
      "test/test_helper.rb",
      "test/unit/test_configuration.rb",
      "test/unit/test_dnif.rb",
+     "test/unit/test_document.rb",
+     "test/unit/test_index.rb",
      "test/unit/test_index_builder.rb",
      "test/unit/test_indexer.rb",
      "test/unit/test_multi_attribute.rb",
+     "test/unit/test_schema.rb",
      "test/unit/test_search.rb"
   ]
 

data/lib/dnif.rb

@@ -5,7 +5,10 @@ require 'active_support'
 require 'riddle'
 
 require "dnif/configuration"
-require "dnif/index_builder"
+require "dnif/index_builder" # TODO remove
+require "dnif/index"
+require "dnif/schema"
+require "dnif/document"
 require "dnif/indexer"
 require "dnif/multi_attribute"
 require "dnif/search"

data/lib/dnif/configuration.rb

@@ -17,8 +17,7 @@ module Dnif
     end
 
     def self.sources
-      classes = ActiveRecord::Base.classes.keys
-      classes.each do |class_name|
+      ActiveRecord::Base.indexes.keys.each do |class_name|
         name = class_name.underscore.pluralize + "_main"
         yield name, class_name
       end

data/lib/dnif/document.rb

@@ -0,0 +1,64 @@
+module Dnif
+  class Document
+
+    def initialize(object)
+      @object = object
+    end
+
+    def generate
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.sphinx(:document, :id => document_id) do
+        fields = []
+        @object.indexes.values.each do |index|
+          (index.fields - fields).each do |name|
+            if @object.index.fields.include?(name)
+              xml.tag!(name) do
+                xml.cdata!(@object.send(name))
+              end
+            else
+              xml.tag!(name, "")
+            end
+
+            fields << name
+          end
+        end
+
+        xml.class_id(class_id)
+
+        attributes = []
+        @object.indexes.values.each do |index|
+          index.attributes.each do |name, type|
+            next if attributes.include?(name)
+
+            if @object.index.attributes.has_key?(name)
+              value = @object.send(name)
+
+              if [:date, :datetime].include?(type)
+                if value.is_a?(Date)
+                  value = value.to_datetime
+                end
+                value = value.to_i
+              end
+            else
+              value = ""
+            end
+
+            xml.tag!(name, value)
+            attributes << name
+          end
+        end
+      end
+      xml.target!
+    end
+
+    private
+
+    def class_id
+      @class_id ||= Dnif::MultiAttribute.encode(@object.class.name)
+    end
+
+    def document_id
+      @object.id + class_id.split(',').sum { |c| c.to_i }
+    end
+  end
+end

data/lib/dnif/index.rb

@@ -0,0 +1,29 @@
+module Dnif
+  class Index
+
+    attr_reader :fields
+    attr_reader :attributes
+    attr_reader :conditions
+
+    def initialize(&block)
+      @fields = []
+      @attributes = {}
+
+      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

@@ -2,88 +2,47 @@ module Dnif
   module Indexer
 
     def define_index(&block)
-      classes[self.name] = IndexBuilder.new(self, &block)
-      classes[self.name]
+      @@indexes ||= {}
+      @@indexes[self.name] = Dnif::Index.new(&block)
 
       include InstanceMethods
     end
 
-    def classes
-      @@classes ||= ActiveSupport::OrderedHash.new
+    def indexes
+      @@indexes
     end
 
     def to_sphinx
-      return nil if classes.blank?
+      return nil if indexes.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"
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.instruct!
+      xml.sphinx(:docset) do
+        schema = Schema.new(self)
+        xml << schema.generate
 
+        results = all(:conditions => indexes[self.name].conditions)
         results.each do |object|
-          xml << object.to_sphinx
+          document = Document.new(object)
+          xml << document.generate
         end
-        xml << "</sphinx:docset>"
       end
+      xml.target!
     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
+      def indexes
+        self.class.indexes
+      end
 
-            xml << "  <#{name}>#{value}</#{name}>\n"
-          end
+      def index
+        self.class.indexes[self.class.name]
+      end
 
-          xml << "</sphinx:document>\n"
-        end
+      def to_sphinx
+        document = Document.new(self)
+        document.generate
       end
     end
   end

data/lib/dnif/schema.rb

@@ -0,0 +1,59 @@
+module Dnif
+  class Schema
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def generate
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.sphinx(:schema) do
+        # fields = @klass.indexes[@klass.name].fields.map do |name|
+        #   xml.sphinx(:field, :name => name)
+        #   name
+        # end
+        # 
+        # attributes = @klass.indexes[@klass.name].attributes.map do |name, type|
+        #   xml.sphinx(:attr, :name => name, :type => attribute_type(type))
+        #   name
+        # end
+
+        fields = []
+        @klass.indexes.values.each do |index|
+          (index.fields - fields).each do |name|
+            xml.sphinx(:field, :name => name)
+            fields << name
+          end
+        end
+
+        xml.sphinx(:attr, :name => "class_id", :type => "multi")
+
+        attributes = []
+        @klass.indexes.values.each do |index|
+          index.attributes.each do |name, type|
+            if not attributes.include?(name)
+              xml.sphinx(:attr, :name => name, :type => attribute_type(type))
+              attributes << name
+            end
+          end
+        end
+      end
+      xml.target!
+    end
+
+    private
+
+    def attribute_type(type)
+      case type
+      when :integer
+        "int"
+      when :date, :datetime
+        "timestamp"
+      when :boolean
+        "bool"
+      when :float
+        "float"
+      end
+    end
+  end
+end

data/test/fixtures/db/schema.rb

@@ -3,9 +3,10 @@ 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
+    t.boolean :active
   end
 
   create_table "people", :force => true do |t|
@@ -14,16 +15,17 @@ ActiveRecord::Schema.define(:version => 1) do
   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|
+  create_table "orders", :force => true do |t|
+    t.string :title
     t.datetime :ordered_at
   end
 
   create_table "notes", :force => true do |t|
+    t.string :title
     t.integer :clicked
     t.datetime :published_at
     t.date :expire_at

data/test/fixtures/sphinx_1.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<sphinx:docset>
+<sphinx:schema>
+  <sphinx:field name="name"/>
+  <sphinx:field name="full_name"/>
+  <sphinx:field name="title"/>
+  <sphinx:field name="buyer"/>
+  <sphinx:attr name="class_id" type="multi"/>
+  <sphinx:attr name="active" type="bool"/>
+  <sphinx:attr name="clicked" type="int"/>
+  <sphinx:attr name="published_at" type="timestamp"/>
+  <sphinx:attr name="expire_at" type="timestamp"/>
+  <sphinx:attr name="points" type="float"/>
+</sphinx:schema>
+{comment}</sphinx:docset>

data/test/fixtures/sphinx_2.xml

@@ -0,0 +1,14 @@
+<sphinx:document id="2967">
+  <name></name>
+  <full_name></full_name>
+  <title>
+    <![CDATA[Note Title]]>
+  </title>
+  <buyer></buyer>
+  <class_id>334,623,884,1125</class_id>
+  <active>true</active>
+  <clicked>10</clicked>
+  <published_at>{now}</published_at>
+  <expire_at>{expire}</expire_at>
+  <points>1000.0</points>
+</sphinx:document>

data/test/fixtures/sphinx_3.xml

@@ -0,0 +1,14 @@
+<sphinx:document id="6008">
+  <name></name>
+  <full_name>
+    <![CDATA[Rafael Souza]]>
+  </full_name>
+  <title></title>
+  <buyer></buyer>
+  <class_id>336,613,882,1139,1391,1646</class_id>
+  <active></active>
+  <clicked></clicked>
+  <published_at></published_at>
+  <expire_at></expire_at>
+  <points></points>
+</sphinx:document>

data/test/fixtures/sphinx_4.xml

@@ -0,0 +1,12 @@
+<sphinx:schema>
+  <sphinx:field name="name"/>
+  <sphinx:field name="full_name"/>
+  <sphinx:field name="title"/>
+  <sphinx:field name="buyer"/>
+  <sphinx:attr name="class_id" type="multi"/>
+  <sphinx:attr name="active" type="bool"/>
+  <sphinx:attr name="clicked" type="int"/>
+  <sphinx:attr name="published_at" type="timestamp"/>
+  <sphinx:attr name="expire_at" type="timestamp"/>
+  <sphinx:attr name="points" type="float"/>
+</sphinx:schema>

data/test/fixtures/sphinx_5.xml

@@ -0,0 +1,14 @@
+<sphinx:document id="11">
+  <name>
+    <![CDATA[Rafael Souza]]>
+  </name>
+  <full_name></full_name>
+  <title></title>
+  <buyer></buyer>
+  <class_id>1,2,3,4</class_id>
+  <active>true</active>
+  <clicked></clicked>
+  <published_at></published_at>
+  <expire_at></expire_at>
+  <points></points>
+</sphinx:document>

data/test/test_helper.rb

@@ -6,6 +6,9 @@ require "test/unit"
 require "mocha"
 require "active_record"
 
+require 'database_cleaner'
+DatabaseCleaner.strategy = :transaction
+
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 require "dnif"
 
@@ -28,6 +31,7 @@ class User < ActiveRecord::Base
 
   define_index do
     field :name
+    attribute :active, :type => :boolean
   end
 end
 
@@ -51,6 +55,7 @@ end
 class Order < ActiveRecord::Base
 
   define_index do
+    field :title
     field :buyer
 
     where ["ordered_at >= ?", 2.months.ago]
@@ -60,6 +65,7 @@ end
 class Note < ActiveRecord::Base
 
   define_index do
+    field :title
     attribute :clicked, :type => :integer
     attribute :published_at, :type => :datetime
     attribute :expire_at, :type => :date

data/test/unit/test_document.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestDocument < Test::Unit::TestCase
+
+  def setup
+    DatabaseCleaner.start
+  end
+
+  def teardown
+    DatabaseCleaner.clean
+  end
+
+  test ".generate" do
+    Dnif::MultiAttribute.expects(:encode).with("User").returns("1,2,3,4")
+
+    user = User.create!(:name => "Rafael Souza", :active => true)
+
+    document = Dnif::Document.new(user)
+    expected = File.read(File.dirname(__FILE__) + "/../fixtures/sphinx_5.xml")
+    assert_equal expected, document.generate
+  end
+
+  test "convertion of date/datetime values to timestamp" do
+    now = DateTime.now
+    now.expects(:to_i)
+    expire = Date.today + 2.days
+    expire.expects(:to_i)
+    expire.expects(:to_datetime).returns(expire)
+
+    note = Note.create!(
+      :title => "Note Title",
+      :clicked => 10,
+      :published_at => now,
+      :expire_at => expire,
+      :active => true,
+      :points => 1000
+    )
+    note.to_sphinx
+  end
+end

data/test/unit/test_index.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestIndex < Test::Unit::TestCase
+
+  test "field definition" do
+    index = Dnif::Index.new(&proc { field :name })
+    assert_equal [:name], index.fields
+  end
+
+  test "attribute definition" do
+    index = Dnif::Index.new(&proc { attribute :another, :type => :bool })
+    expected = { :another => :bool }
+    assert_equal expected, index.attributes
+  end
+
+  test "where definition" do
+    index = Dnif::Index.new(&proc { where "field = 'value'" })
+    assert_equal "field = 'value'", index.conditions
+  end
+end

data/test/unit/test_indexer.rb

@@ -3,6 +3,14 @@ require 'test_helper'
 
 class TestIndexer < Test::Unit::TestCase
 
+  def setup
+    DatabaseCleaner.start
+  end
+
+  def teardown
+    DatabaseCleaner.clean
+  end
+
   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)
@@ -11,25 +19,25 @@ class TestIndexer < Test::Unit::TestCase
   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"
+    expected = File.read(File.dirname(__FILE__) + "/../fixtures/sphinx_3.xml")
     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)
+    note = Note.create!(:title => "Note Title", :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
+    expected = File.read(File.dirname(__FILE__) + "/../fixtures/sphinx_2.xml")
+    assert_equal expected.gsub("{now}", now.to_i.to_s).gsub("{expire}", expire.to_datetime.to_i.to_s), 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
+    expected = File.read(File.dirname(__FILE__) + "/../fixtures/sphinx_1.xml")
+    assert_equal expected.gsub("{comment}", comment.to_sphinx), Person.to_sphinx
   end
-  
+
   test "return all indexed classes" do
-    assert_equal ["User", "Person", "Order", "Note"], ActiveRecord::Base.classes.keys
+    assert_equal ["User", "Person", "Order", "Note"], ActiveRecord::Base.indexes.keys
   end
 end

data/test/unit/test_schema.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'test_helper'
+
+class TestSchema < Test::Unit::TestCase
+
+  test ".generate" do
+    schema = Dnif::Schema.new(User)
+    expected = File.read(File.dirname(__FILE__) + "/../fixtures/sphinx_4.xml")
+    assert_equal expected, schema.generate
+  end
+end

metadata

@@ -6,9 +6,9 @@ version: !ruby/object:Gem::Version
   - 0
   - 0
   - 1
-  - alpha
-  - 7
-  version: 0.0.1.alpha.7
+  - beta
+  - 1
+  version: 0.0.1.beta.1
 platform: ruby
 authors: 
 - Rafael Souza
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-02 00:00:00 -03:00
+date: 2010-07-14 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,21 +72,32 @@ files:
 - dnif.gemspec
 - lib/dnif.rb
 - lib/dnif/configuration.rb
+- lib/dnif/document.rb
+- lib/dnif/index.rb
 - lib/dnif/index_builder.rb
 - lib/dnif/indexer.rb
 - lib/dnif/multi_attribute.rb
+- lib/dnif/schema.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/sphinx_1.xml
+- test/fixtures/sphinx_2.xml
+- test/fixtures/sphinx_3.xml
+- test/fixtures/sphinx_4.xml
+- test/fixtures/sphinx_5.xml
 - test/fixtures/templates/config.erb
 - test/test_helper.rb
 - test/unit/test_configuration.rb
 - test/unit/test_dnif.rb
+- test/unit/test_document.rb
+- test/unit/test_index.rb
 - test/unit/test_index_builder.rb
 - test/unit/test_indexer.rb
 - test/unit/test_multi_attribute.rb
+- test/unit/test_schema.rb
 - test/unit/test_search.rb
 has_rdoc: true
 homepage: http://github.com/rafaelss/dnif
@@ -128,7 +139,10 @@ test_files:
 - test/test_helper.rb
 - test/unit/test_configuration.rb
 - test/unit/test_dnif.rb
+- test/unit/test_document.rb
+- test/unit/test_index.rb
 - test/unit/test_index_builder.rb
 - test/unit/test_indexer.rb
 - test/unit/test_multi_attribute.rb
+- test/unit/test_schema.rb
 - test/unit/test_search.rb