index_tree 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 331b4073422929cabfbb5292d94d11bd1aca0e80
-  data.tar.gz: 20958ba592b248ed9137ddac5b72f9f2f1b8cc89
+  metadata.gz: fd82c79ed504406d34114df0b5b9eddbe5b93129
+  data.tar.gz: 4777ebc01c42f0e811cc8603ad327efa8095ffdb
 SHA512:
-  metadata.gz: 7f0b87af9ac9a7d5be4921f588464bec77655f1abb75ebefa7f38bf63fc9c4cf14897b940941defdf89b56c6f79565e9fa4f3c5fab398c35542f9fae0bc3aa4d
-  data.tar.gz: 18ea0a9f0a72749582ba0bd6713e104d7ff577819afc49526070078de54a1353ab40563812f8349c7457d7aa3a071ec07fd8b8af4b1a073c73e0bcf6df2d16b0
+  metadata.gz: 5e3b6a75d319175569f5defccf9968ce8ea398e5e28854970500c167ef7f4c370a984cb45f2988800a02e11ee8ce8849e16e88681ee9759e58260baeb4e52476
+  data.tar.gz: 9d5b9aca049aba6a5fafc90b34da1ec337731cfcd22a859881ab00f99a554acee12cfbf1ccb79d0c26c5ad31f1e9a36ea01aee95824af5e0f406feb1e792121d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /.idea
+/.DS_Store
 /Gemfile.lock
 /_yardoc/
 /coverage/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.2
+
+gemfile:
+  - gemfiles/rails-4.0.gemfile 

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in index-tree.gemspec
 gemspec
+
+group :test do
+  gem 'rails'
+  gem 'coveralls', require: false
+end

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://secure.travis-ci.org//Natural-Intelligence/index_tree.svg?branch=master)](https://travis-ci.org/Natural-Intelligence/index\_tree)
+[![Coverage Status](https://coveralls.io/repos/AlexStanovsky/index_tree/badge.png)](https://coveralls.io/r/AlexStanovsky/index_tree)
 # IndexTree
 
 This Gem eager loads trees by indexing the nodes of the tree. The number of queries needed to load a tree is N, 
@@ -5,11 +7,11 @@ when N is the number of different models(ActiveRecords) in the tree.
 
 Each inner object in the tree have an index node instance that is connecting it to the root.
 When the root of the tree is loaded, only the objects that are in the tree are fetched(Pruning).
-The index nodes are created when the root element is saved.
+The index nodes are created when the root element is saved and stored in the IndexNode model.
 
 Example:
 
-    class Equation
+    class Equation < ActiveRecord::Base
         acts_as_indexed_node :root => true do
             has_many :expressions
         end
@@ -18,7 +20,7 @@ Example:
     end
     
     
-    class Expression
+    class Expression < ActiveRecord::Base
         acts_as_indexed_node do
             has_many :expressions
         end
@@ -64,7 +66,7 @@ And then execute:
     $ bundle
     $ rake db:migrate 
     
-There is a migration which creates index_tree_index_node table
+There is a migration which creates index_tree_index_node table(IndexNode model)
 
 ## Declaration
 

data/Rakefile

@@ -1,2 +1,33 @@
 require "bundler/gem_tasks"
 
+desc "Run unit tests."
+task :test do
+  $: << "test"
+
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start do
+    add_filter 'test/'
+    add_filter 'db/'
+  end
+
+  Dir["test/*_test.rb"].each { |f| require f[5..-4] }
+end
+
+task :default => :test
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  require "index_tree/version"
+  version = IndexTree::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "index_tree #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/gemfiles/rails-4.0.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem 'coveralls', require: false
+gem "rails", "~> 4.0"
+gem "index_tree", path: "../"
+
+gemspec path: "../"

data/index_tree.gemspec

@@ -22,5 +22,8 @@ The index nodes are created when the root element is saved.}
   spec.files         = `git ls-files`.split($/)
   spec.require_paths = %w(lib app)
 
-  spec.add_dependency "activerecord"
+  spec.add_dependency "activerecord", ">= 3.0.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rdoc"
+  spec.add_development_dependency "minitest"
 end

data/lib/index_tree/engine.rb

@@ -1,14 +1,13 @@
 # Rails Engine copies the migration to the Rails app
-module IndexTree
-  class Engine < Rails::Engine
-    isolate_namespace IndexTree
+class IndexTree::Engine < Rails::Engine
+  isolate_namespace IndexTree
 
-    initializer :append_migrations do |app|
-      unless app.root.to_s.match root.to_s
-        config.paths["db/migrate"].expanded.each do |expanded_path|
-          app.config.paths["db/migrate"] << expanded_path
-        end
+  initializer :append_migrations do |app|
+    unless app.root.to_s.match root.to_s
+      config.paths["db/migrate"].expanded.each do |expanded_path|
+        app.config.paths["db/migrate"] << expanded_path
       end
     end
   end
 end
+

data/lib/index_tree/node_element.rb

@@ -41,10 +41,9 @@ module IndexTree
         return valid_associations
       end
 
-      # Invoke index node creation for children node
+      # Invoke index node creation for children nodes
       # @param [root_element] id of the root element
       def create_index_nodes_for_children(root_element)
-
         self.child_nodes.keys.each do |association_name|
           association_value = send(association_name)
 
@@ -56,4 +55,4 @@ module IndexTree
 
     end
   end
-end
+end

data/lib/index_tree/railtie.rb

@@ -1,8 +1,7 @@
-# Defines the ActsAssTreeNode Method
-module IndexTree
-  class Railtie < Rails::Railtie
-    ActiveSupport.on_load(:active_record) do
-      extend IndexTree::ActsAsIndexedNode
-    end
+# Defines the ActsAsIndexedNode Method
+class IndexTree::Railtie < Rails::Railtie
+  ActiveSupport.on_load(:active_record) do
+    extend IndexTree::ActsAsIndexedNode
   end
-end
+end
+

data/lib/index_tree/root_element.rb

@@ -1,7 +1,7 @@
 require 'active_support/concern'
 
 # Defines the root element of the tree, it invokes the recursive index nodes creation.
-# And Hold the structure of the tree
+# And Holds the structure of the tree
 module IndexTree
   module RootElement
     extend ActiveSupport::Concern
@@ -26,7 +26,8 @@ module IndexTree
 
       # @return [tree_structure] Each Root Element hold the structure of the tree
       def self.tree_structure
-        @@tree_structure ||= create_tree_structure({}, self)
+        @@tree_structure ||= {}
+        @@tree_structure[self] ||= create_tree_structure({}, self)
       end
 
       # Recursive function that create the structure of the tree

data/lib/index_tree/tree_preloader.rb

@@ -1,5 +1,7 @@
 module IndexTree
   module TreePreloader
+    # Reads the loading instruction from the tree structures and load the entities
+    # @param [root_entities] entities to load
     def self.preload_entities(root_entities)
 
       root_entities_array = Array(root_entities)
@@ -28,8 +30,10 @@ module IndexTree
 
     def self.preload_class(cache, root_entity_class, class_to_load)
       unless cache.has_key?(class_to_load)
-        cache[class_to_load] = Hash[class_to_load.joins(:index_tree_index_node).where(:index_tree_index_nodes => {:root_element_type => cache[root_entity_class].values.first.class,
-                                                                                                                  :root_element_id => cache[root_entity_class].keys}).all.map { |t| [t.id, t] }]
+        cache[class_to_load] = Hash[class_to_load.joins(:index_tree_index_node)
+                                    .where(:index_tree_index_nodes => {:root_element_type => root_entity_class,
+                                                                       :root_element_id => cache[root_entity_class].keys})
+                                    .load.map { |entity| [entity.id, entity] }]
       end
     end
 
@@ -41,8 +45,10 @@ module IndexTree
         end
 
         parent_id = source_entity.send(association_name.to_s + '_id')
-        source_entity.association(association_name).target = cache[target_class][parent_id]
-        source_entity.association(association_name).loaded!
+        if (parent_id)
+          source_entity.association(association_name).target = cache[target_class][parent_id]
+          source_entity.association(association_name).loaded!
+        end
       end
     end
 

data/lib/index_tree/version.rb

@@ -1,3 +1,3 @@
 module IndexTree
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/test/base_test.rb

@@ -0,0 +1,101 @@
+require 'minitest/autorun'
+require 'minitest/benchmark'
+require 'active_record'
+require 'rails'
+require 'index_tree'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+class MiniTest::Unit::TestCase
+  def assert_queries(num = 1, &block)
+    query_count, result = count_queries(&block)
+    result
+  ensure
+    assert_equal num, query_count, "#{query_count} instead of #{num} queries were executed."
+  end
+
+  def assert_no_queries(&block)
+    assert_queries(0, &block)
+  end
+
+  def count_queries &block
+    count = 0
+
+    counter_f = ->(name, started, finished, unique_id, payload) {
+      unless %w[ CACHE SCHEMA ].include? payload[:name]
+        count += 1
+      end
+    }
+
+    result = ActiveSupport::Notifications.subscribed(counter_f, "sql.active_record", &block)
+
+    [count, result]
+  end
+end
+
+
+def setup_db
+  ActiveRecord::Schema.define(version: 1) do
+    create_table :index_tree_index_nodes do |t|
+      t.integer :root_element_id, null: false
+      t.string :root_element_type, null: false
+      t.integer :node_element_id, null: false
+      t.string :node_element_type, null: false
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+
+    create_table :equations do |t|
+    end
+
+    create_table :expressions do |t|
+      t.references :equation
+      t.references :expression
+    end
+
+    create_table :poly_equations do |t|
+      t.references :poly_expression
+    end
+
+    create_table :expression_containers do |t|
+      t.references :poly_expression
+      t.references :base_expression, polymorphic: true
+    end
+
+    create_table :poly_expressions do |t|
+    end
+
+    create_table :values do |t|
+    end
+
+    create_table :sti_equations do |t|
+      t.references :sti_expression
+    end
+
+    create_table :sti_expressions do |t|
+      t.string :type, null: false
+      t.references :sti_expression
+    end
+  end
+
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+def preload_tree(class_to_test,num_of_queries)
+  not_load = class_to_test.first
+  assert_queries(num_of_queries) do
+    not_load.traverse
+  end
+
+  loaded = class_to_test.first.preload_tree
+  assert_no_queries do
+    loaded.traverse
+  end
+end
+

data/test/polymorphic_tree_test.rb

@@ -0,0 +1,88 @@
+require 'base_test'
+
+class PolyEquation < ActiveRecord::Base
+  acts_as_indexed_node :root => true do
+    belongs_to :poly_expression
+  end
+
+  def traverse
+    poly_expression.traverse
+  end
+end
+
+class ExpressionContainer < ActiveRecord::Base
+  belongs_to :poly_expression
+
+  acts_as_indexed_node do
+    belongs_to :base_expression, polymorphic: true
+  end
+
+  def traverse
+    base_expression.traverse
+  end
+end
+
+class PolyExpression < ActiveRecord::Base
+  acts_as_indexed_node do
+    has_many :expression_containers
+  end
+
+  has_one :expression_container, as: :base_expression
+
+  def traverse
+    expression_containers.map(&:traverse)
+  end
+end
+
+class Value < ActiveRecord::Base
+  acts_as_indexed_node
+
+  has_one :expression_container, as: :base_expression
+
+  def traverse
+  end
+end
+
+class PolymorphicTreeTest < MiniTest::Unit::TestCase
+
+  def setup
+    # teardown_db
+    setup_db
+
+    value1 = Value.create!()
+    value2 = Value.create!()
+    value3 = Value.create!()
+    value4 = Value.create!()
+
+    expression1 = PolyExpression.create!()
+    ExpressionContainer.create!(poly_expression: expression1, base_expression: value1)
+    ExpressionContainer.create!(poly_expression: expression1, base_expression: value2)
+
+    expression2 = PolyExpression.create!()
+    ExpressionContainer.create!(poly_expression: expression2, base_expression: value3)
+    ExpressionContainer.create!(poly_expression: expression2, base_expression: value4)
+    ExpressionContainer.create!(poly_expression: expression2, base_expression: expression1)
+    ExpressionContainer.create!(poly_expression: expression2, base_expression: expression1)
+
+    PolyEquation.create!(poly_expression: expression2)
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_preload_tree
+    preload_tree(PolyEquation,12)
+    # not_load_equation = PolyEquation.first
+    #
+    # assert_queries(12) do
+    #   not_load_equation.traverse
+    # end
+    #
+    # load_equation = PolyEquation.first.preload_tree
+    #
+    # assert_no_queries do
+    #   load_equation.traverse
+    # end
+  end
+end

data/test/simple_tree_test.rb

@@ -0,0 +1,92 @@
+require 'base_test'
+
+
+class Equation < ActiveRecord::Base
+  acts_as_indexed_node :root => true do
+    has_one :expression, inverse_of: :equation
+  end
+
+  def traverse
+    expression.traverse
+  end
+end
+
+class Expression < ActiveRecord::Base
+  belongs_to :equation, inverse_of: :expression
+  belongs_to :expression
+
+  acts_as_indexed_node do
+    has_many :expressions
+  end
+
+  def traverse
+    expressions.map(&:traverse)
+  end
+end
+
+class SimpleTreeTest < MiniTest::Unit::TestCase
+
+  def setup
+    setup_db
+
+    equation = Equation.create!()
+
+    @expression1 = Expression.create!(equation: equation)
+    expression2 = Expression.create!(expression: @expression1)
+    expression3 = Expression.create!(expression: @expression1)
+    expression4 = Expression.create!(expression: expression2)
+    expression5 = Expression.create!(expression: expression2)
+    expression6 = Expression.create!(expression: expression4)
+    expression7 = Expression.create!(expression: expression4)
+    expression8 = Expression.create!(expression: expression5)
+
+    # Rebuild index tree
+    equation.save
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_preload_tree
+    preload_tree(Equation, 9)
+  end
+
+
+  def test_preload_multi_tree
+    not_load = Equation.all
+    assert_queries(10) do
+      not_load.map(&:traverse)
+    end
+
+    loaded = Equation.all.preload_tree
+    assert_no_queries do
+      loaded.map(&:traverse)
+    end
+
+  end
+
+  def count_nodes(tree_node)
+    num_of_nodes = 0
+
+    tree_node.class.child_nodes.keys.each do |association_name|
+      association_value = tree_node.send(association_name)
+
+      Array(association_value).each do |child_node|
+        num_of_nodes += count_nodes(child_node) + 1
+      end
+    end
+
+    return num_of_nodes
+  end
+
+  def test_index_node_creation
+
+    equation1 = Equation.first
+
+    num_of_tree_nodes = count_nodes(equation1)
+    assert_equal num_of_tree_nodes, equation1.index_tree_index_nodes.size, "#{num_of_tree_nodes} instead of #{equation1.index_tree_index_nodes.size} index node were created."
+  end
+end
+
+

data/test/sti_tree_test.rb

@@ -0,0 +1,59 @@
+require 'base_test'
+
+class StiEquation < ActiveRecord::Base
+  acts_as_indexed_node :root => true do
+    belongs_to :sti_expression
+  end
+
+  def traverse
+    sti_expression.traverse
+  end
+end
+
+class StiExpression < ActiveRecord::Base
+  belongs_to :sti_expression
+
+  acts_as_indexed_node do
+    has_many :sti_expressions
+  end
+
+  def traverse
+    sti_expressions.map(&:traverse)
+  end
+end
+
+class AExpression < StiExpression
+end
+class BExpression < StiExpression
+end
+class CExpression < StiExpression
+end
+class DExpression < StiExpression
+end
+
+
+class StiTreeTest < MiniTest::Unit::TestCase
+
+  def setup
+    setup_db
+
+    expression1 = AExpression.create!
+    expression2 = BExpression.create!(sti_expression: expression1)
+    expression3 = CExpression.create!(sti_expression: expression1)
+    expression4 = DExpression.create!(sti_expression: expression2)
+    expression5 = AExpression.create!(sti_expression: expression2)
+    expression6 = BExpression.create!(sti_expression: expression4)
+    expression7 = CExpression.create!(sti_expression: expression4)
+    expression8 = DExpression.create!(sti_expression: expression5)
+
+    root = StiEquation.create!(sti_expression: expression1)
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_preload_tree
+    preload_tree(StiEquation,9)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: index_tree
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Alex Stanovsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2014-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,9 +16,51 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -33,7 +75,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -42,6 +86,7 @@ files:
 - app/models/index_node.rb
 - db/migrate/20141004075233_create_index_tree_index_nodes.rb
 - db/migrate/20141004075333_add_index_to_tree_index_nodes.rb
+- gemfiles/rails-4.0.gemfile
 - index_tree.gemspec
 - lib/index_tree.rb
 - lib/index_tree/acts_as_indexed_node.rb
@@ -52,6 +97,10 @@ files:
 - lib/index_tree/root_element.rb
 - lib/index_tree/tree_preloader.rb
 - lib/index_tree/version.rb
+- test/base_test.rb
+- test/polymorphic_tree_test.rb
+- test/simple_tree_test.rb
+- test/sti_tree_test.rb
 homepage: http://www.naturalint.com
 licenses: []
 metadata: {}