friendly 0.4.5 → 0.5.0

data/CHANGELOG.md

@@ -1,7 +1,11 @@
 Changelog
 =========
 
-### (0.4.4)
+### 0.5
+  
+  * (jamesgolick) Add offline index building.
+
+### 0.4.4
 
   * (jamesgolick) Make it possible to query with order, but no conditions.
   * (jamesgolick) Add change tracking. This is mostly to facilitate arbitrary caches.

data/README.md

@@ -204,6 +204,29 @@ You can also use any other Friendly::Scope method like scope chaining.
 
 See the section above or the Friendly::Scope docs for more details.
 
+Offline Indexing
+================
+
+Friendly includes support for building an index in the background, without taking your app offline.
+
+All you have to do is declare the index in your model. If we wanted to add an index on :name, :created_at in a User model, we'd do it like this:
+
+    class User
+      # ...snip...
+
+      indexes :name, :created_at
+    end
+
+Then, make sure to run Friendly.create_tables! to create the table in the database. This won't overwrite any of your existing tables, so don't worry.
+
+    >> Friendly.create_tables!
+
+Now that the the new table has been created, you need to copy the .rake file included with Friendly (lib/tasks/friendly.rake) to somewhere that will get picked up by your main Rakefile (lib/tasks if it's a rails project). Then, run:
+
+    $ KLASS=User FIELDS=name,created_at rake friendly:build_index
+
+If you're running this in production, you'll probably want to fire up GNU screen so that it'll keep running even if you lose your SSH connection. When this task completes, the index is populated and ready to go!
+
 Installation
 ============
 

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.5.0

data/friendly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{friendly}
-  s.version = "0.4.5"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Golick"]
-  s.date = %q{2010-01-16}
+  s.date = %q{2010-01-25}
   s.description = %q{}
   s.email = %q{jamesgolick@gmail.com}
   s.extra_rdoc_files = [
@@ -47,6 +47,7 @@ Gem::Specification.new do |s|
      "lib/friendly/document/storage.rb",
      "lib/friendly/document_table.rb",
      "lib/friendly/index.rb",
+     "lib/friendly/indexer.rb",
      "lib/friendly/memcached.rb",
      "lib/friendly/newrelic.rb",
      "lib/friendly/query.rb",
@@ -61,6 +62,7 @@ Gem::Specification.new do |s|
      "lib/friendly/time.rb",
      "lib/friendly/translator.rb",
      "lib/friendly/uuid.rb",
+     "lib/tasks/friendly.rake",
      "rails/init.rb",
      "spec/config.yml.example",
      "spec/fakes/data_store_fake.rb",
@@ -81,6 +83,7 @@ Gem::Specification.new do |s|
      "spec/integration/has_many_spec.rb",
      "spec/integration/index_spec.rb",
      "spec/integration/named_scope_spec.rb",
+     "spec/integration/offline_indexing_spec.rb",
      "spec/integration/pagination_spec.rb",
      "spec/integration/scope_chaining_spec.rb",
      "spec/integration/table_creator_spec.rb",
@@ -174,6 +177,7 @@ Gem::Specification.new do |s|
      "spec/integration/has_many_spec.rb",
      "spec/integration/index_spec.rb",
      "spec/integration/named_scope_spec.rb",
+     "spec/integration/offline_indexing_spec.rb",
      "spec/integration/pagination_spec.rb",
      "spec/integration/scope_chaining_spec.rb",
      "spec/integration/table_creator_spec.rb",

data/lib/friendly.rb

@@ -7,6 +7,7 @@ require 'friendly/data_store'
 require 'friendly/document'
 require 'friendly/document_table'
 require 'friendly/index'
+require 'friendly/indexer'
 require 'friendly/memcached'
 require 'friendly/query'
 require 'friendly/sequel_monkey_patches'

data/lib/friendly/indexer.rb

@@ -0,0 +1,50 @@
+module Friendly
+  class Indexer
+    class << self
+      attr_accessor :objects_per_iteration
+
+      def populate(klass, *fields)
+        instance.populate(klass, klass.storage_proxy.index_for_fields(fields))
+      end
+
+      def instance
+        @instance ||= new
+      end
+    end
+
+    self.objects_per_iteration = 100
+
+    attr_reader :datastore, :translator
+
+    def initialize(datastore  = Friendly.datastore, translator = Translator.new)
+      @datastore  = datastore
+      @translator = translator
+    end
+
+    def populate(klass, index)
+      loop do
+        count   = 0
+        rows = datastore.all(klass, Query.new(:offset! => count, 
+                                              :limit!  => objects_per_iteration, 
+                                              :order!  => :added_id.asc))
+        rows.each do |attrs|
+          begin
+            index.create(translator.to_object(klass, attrs))
+          rescue Sequel::DatabaseError
+            # we can safely swallow this exception because if we've gotten
+            # to this point, we can be pretty sure that it's a duplicate
+            # key error, which just means that the object already exists
+            # in the index
+          end
+        end
+        break if rows.length < objects_per_iteration
+        count += objects_per_iteration
+      end
+    end
+
+    protected
+      def objects_per_iteration
+        self.class.objects_per_iteration
+      end
+  end
+end

data/lib/friendly/storage_proxy.rb

@@ -67,6 +67,14 @@ module Friendly
       index
     end
 
+    def index_for_fields(fields)
+      tables.detect do |t|
+        t.respond_to?(:fields) && t.fields == fields
+      end.tap do |i|
+        raise MissingIndex, "No index found matching #{fields.join(", ")}." if i.nil?
+      end
+    end
+
     protected
       def each_store
         stores.each { |s| yield(s) }

data/lib/tasks/friendly.rake

@@ -0,0 +1,7 @@
+namespace :friendly do
+  task :build_index do
+    klass  = ENV['KLASS'].constantize
+    fields = ENV['FIELDS'].split(',').map { |f| f.to_sym }
+    Friendly::Indexer.populate(klass, *fields)
+  end
+end

data/spec/integration/offline_indexing_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe "Building an index offline" do
+  before do
+    $db.drop_table :awesome_things if $db.table_exists?(:awesome_things)
+
+    if $db.table_exists?(:index_awesome_things_on_name)
+      $db.drop_table :index_awesome_things_on_name
+    end
+
+    @klass = Class.new do
+      def self.name; "AwesomeThing"; end
+      def self.table_name; "awesome_things"; end
+
+      include Friendly::Document
+
+      attribute :name, String
+    end
+    @klass.create_tables!
+
+    @jameses = [@klass.create(:name => "James"), @klass.create(:name => "James")]
+
+    @klass.indexes :name
+    @klass.create_tables!
+    Friendly::Indexer.populate(@klass, :name)
+  end
+
+  it "builds the missing index rows for all the rows in the doc table" do
+    @klass.all(:name => "James").should == @jameses
+  end
+
+  it "ignores records that are already in the index" do
+    lambda {
+      Friendly::Indexer.populate(@klass, :name)
+    }.should_not raise_error
+  end
+end

data/spec/unit/storage_proxy_spec.rb

@@ -215,4 +215,30 @@ describe "Friendly::StorageProxy" do
       @storage.count(:x => 1).should == 10
     end
   end
+
+  describe "getting the index that matches a set of fields" do
+    before do
+      @storage_factory = stub(:document_table => @document_table)
+
+      [[:name, :created_at], [:name]].each do |fields|
+        @storage_factory.stubs(:index).
+          with(@klass, *fields).returns(stub(:fields => fields))
+      end
+
+      @storage = Friendly::StorageProxy.new(@klass, @storage_factory)
+      @storage.add(:name, :created_at)
+      @storage.add(:name)
+    end
+
+    it "matches if and only if all the fields are present and in order" do
+      @storage.index_for_fields([:name, :created_at]).fields.should == 
+        [:name, :created_at]
+    end
+
+    it "raises missing index if there's no matching index" do
+      lambda {
+        @storage.index_for_fields([:created_at, :name])
+      }.should raise_error(Friendly::MissingIndex)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: friendly
 version: !ruby/object:Gem::Version 
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors: 
 - James Golick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-16 00:00:00 -08:00
+date: 2010-01-25 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -132,6 +132,7 @@ files:
 - lib/friendly/document/storage.rb
 - lib/friendly/document_table.rb
 - lib/friendly/index.rb
+- lib/friendly/indexer.rb
 - lib/friendly/memcached.rb
 - lib/friendly/newrelic.rb
 - lib/friendly/query.rb
@@ -146,6 +147,7 @@ files:
 - lib/friendly/time.rb
 - lib/friendly/translator.rb
 - lib/friendly/uuid.rb
+- lib/tasks/friendly.rake
 - rails/init.rb
 - spec/config.yml.example
 - spec/fakes/data_store_fake.rb
@@ -166,6 +168,7 @@ files:
 - spec/integration/has_many_spec.rb
 - spec/integration/index_spec.rb
 - spec/integration/named_scope_spec.rb
+- spec/integration/offline_indexing_spec.rb
 - spec/integration/pagination_spec.rb
 - spec/integration/scope_chaining_spec.rb
 - spec/integration/table_creator_spec.rb
@@ -281,6 +284,7 @@ test_files:
 - spec/integration/has_many_spec.rb
 - spec/integration/index_spec.rb
 - spec/integration/named_scope_spec.rb
+- spec/integration/offline_indexing_spec.rb
 - spec/integration/pagination_spec.rb
 - spec/integration/scope_chaining_spec.rb
 - spec/integration/table_creator_spec.rb