relix 2.1.0 → 2.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWRmYWJjZWYxNDM0MmU3OTEzOGE4MzFhODI4Y2RhOWU5ZWY3ZThjMA==
+    OGM4Mzc2ZGI4YjZmNTBlYjczMjM4MjA0ZDE3YzM4ZGQ2ZmU1NTg0ZA==
   data.tar.gz: !binary |-
-    NzJjMDM1MDdmMzM0ZDgyODU1MmMwN2YxZTA0ODgyYzEzOWRiZDYxZg==
+    MWRkMDg2ZTdlOWVmMmY2NWFkNDc1OGRiN2QwNThjZDc5NzQ2MzA2Zg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YTNmNGVjN2U2ZDc5OTQ1Mzk5ZmZkNjlhYjI3MTI3N2RlZjQwZDMyMTJjOTZk
-    NmEyNWExZmEyNWQ4Y2IyMWIzNWFjMThiMmY1MTgwOWQxMDEzYTk5MTE3MDlj
-    Mjg3Y2E4M2EwYmUwMDM4YTNkMmQ1N2JlNzYyNGY4ODE4M2I1YzU=
+    MTU3YjZmNjYxOTEzODAxN2EyM2M3Nzk5ZWVhYTg5M2IyMGFkZDE0ZGIzMmYz
+    NjQyYmQ2MTc3NGU4Zjc1ZmU5ZTE0Yjc5NTNkOGFmN2I0NmYzZGZiZDkxYjYy
+    ZjBjYTY4MDlhYmQ5OTVlM2FiZWQzZWJhMTkyYTBmZTE3NjJiNzM=
   data.tar.gz: !binary |-
-    Y2YwODAwZTRkNDI5MTZkMTlhZGVhYmRiOWNkMWUxMjQ1M2JmMzUwYjg5YzFh
-    ZWI5N2YyMjJjZTQ4MmM3ZGRjMjlhMWQzNjQ2Zjc0NWYyZmQyNzliZjVkOTFi
-    ZTk5MWJiZjAyNjE1ZjJiMTNkYzEyZjNjOWQ4YTQ4NTdmNzFjZDI=
+    NTdkZjBlMTE2YThjNTkyOTRkMWI4YWQ0ZGI4NTM2ZGY5ZDFlOTVhYTc3OWYw
+    MmQ0MmNlMjExZTYyOGU4YjY0ZmJjNGQyNWI1YjMwYmI5N2RlNTI1MDcxN2Fl
+    NTEzY2I4NjljZmU1ZTA3ZDhkYzQ2YjZlODcyNTgzYWZlNjFjNjE=

data/HISTORY.md

@@ -1,3 +1,7 @@
+### 2.2.0
+
+* Add index removal. (ntalbott)
+
 ### 2.1.0
 
 * Make IndexSet lazy-retrieve the Redis client. (ntalbott)

data/README.md

@@ -296,3 +296,28 @@ Keys take up space, and especially since Redis holds the keyset in memory it can
 ### Legacy
 
 This (eventually to be deprecated and removed) strategy exactly mirrors the keying supported by Relix when first released.
+
+
+## Maintenance
+
+### Index removal
+
+Sometimes an index is no longer needed, or is being moved or renamed, and you'll want to clean up the old index data including both the index itself as well as the current values that are tracked for that index.
+
+To remove an index, first change its declaration like so:
+
+    class Transaction
+      relix do
+        obsolete{:multi, :account_key, order: :created_at}
+      end
+    end
+
+This just wraps the original index declaration in an `obsolete` block. Doing this makes it so that the index is no longer updated (though it will still deindex), and also marks the index for removal within Relix.
+
+Second, run `destroy_index` on the index:
+
+    Transaction.relix.destroy_index(:account_key)
+
+This will remove all related data from Redis. Note that `destroy_index` is idempotent, so while it's not recommended you run it multiple times (it iterates through the whole primary key space), it won't hurt anything if you do.
+
+And finally: just delete the whole `obsolete` line from your relix declaration. The index is now dead - long live the index!

data/lib/relix/index_set.rb

@@ -6,6 +6,7 @@ module Relix
       @klass = klass
       @redis_source = redis_source
       @indexes = Hash.new
+      @obsolete_indexes = Hash.new
       @keyer = Keyer.default_for(@klass) unless parent
     end
 
@@ -46,8 +47,63 @@ module Relix
     end
 
     def add_index(index_type, name, options={})
-      accessor = (options.delete(:on) || name)
-      @indexes[name.to_s] = Relix.index_types[index_type].new(self, name, accessor, options)
+      raise Relix::InvalidIndexError.new("Index #{name} is already declared as obsolete.") if @obsolete_indexes[name.to_s]
+
+      @indexes[name.to_s] = create_index(self, index_type, name, options)
+    end
+
+    class Obsolater
+      def initialize(index_set)
+        @index_set = index_set
+      end
+
+      def method_missing(m, *args)
+        if Relix.index_types.keys.include?(m.to_sym)
+          @index_set.add_obsolete_index(m, *args)
+        else
+          raise ArgumentError.new("Unknown index type #{m}.")
+        end
+      end
+    end
+
+    def obsolete(&block)
+      raise ArgumentError.new("No block passed.") unless block_given?
+
+      Obsolater.new(self).instance_eval(&block)
+    end
+
+    def add_obsolete_index(index_type, name, options={})
+      raise Relix::InvalidIndexError.new("Primary key indexes cannot be obsoleted.") if(index_type == :primary_key)
+      raise Relix::InvalidIndexError.new("Index #{name} is already declared as non-obsolete.") if @indexes[name.to_s]
+
+      @obsolete_indexes[name.to_s] = create_index(self, index_type, name, options)
+    end
+
+    def destroy_index(name)
+      name = name.to_s
+      index = @obsolete_indexes[name]
+      raise MissingIndexError.new("No obsolete index found for #{name}.") unless index
+      raise InvalidIndexError.new("Indexes built on immutable attributes cannot be destroyed.") if index.attribute_immutable?
+
+      lookup.each do |pk|
+        handle_concurrent_modifications(pk) do
+          current_values_name = current_values_name(pk)
+          redis.watch current_values_name
+          current_values = redis.hgetall(current_values_name)
+
+          old_value = current_values[name]
+
+          ((watch = index.watch(old_value)) && !watch.empty? && redis.watch(*watch))
+          ops = []
+          ops << proc{ index.destroy(redis, pk, old_value) } if index.respond_to?(:destroy)
+          ops << proc{ redis.hdel current_values_name, name }
+          ops
+        end
+      end
+
+      if index.respond_to?(:destroy_all)
+        index.destroy_all(redis)
+      end
     end
 
     def indexes
@@ -114,7 +170,7 @@ module Relix
         redis.watch current_values_name
         current_values = redis.hgetall(current_values_name)
 
-        full_index_list.map do |name, index|
+        full_index_list(:including_obsolete).map do |name, index|
           old_value = if index.attribute_immutable?
             index.read_normalized(object)
           else
@@ -133,7 +189,7 @@ module Relix
         redis.watch current_values_name
         current_values = redis.hgetall(current_values_name)
 
-        full_index_list.map do |name, index|
+        full_index_list(:including_obsolete).map do |name, index|
           old_value = current_values[name]
 
           ((watch = index.watch(old_value)) && !watch.empty? && redis.watch(*watch))
@@ -164,12 +220,21 @@ module Relix
 
     protected
 
-    def full_index_list
-      (parent ? parent.full_index_list.merge(@indexes) : @indexes)
+    def full_index_list(including_obsolete=false)
+      list = (parent ? parent.full_index_list.merge(@indexes) : @indexes)
+      if including_obsolete
+        list = @obsolete_indexes.merge(list)
+      end
+      list
     end
 
     private
 
+    def create_index(index_set, index_type, name, options)
+      accessor = (options.delete(:on) || name)
+      Relix.index_types[index_type].new(index_set, name, accessor, options)
+    end
+
     def handle_concurrent_modifications(primary_key)
       retries = 5
       loop do
@@ -203,4 +268,5 @@ module Relix
   class MissingPrimaryKeyError < Relix::Error; end
   class RedisIndexingError < Relix::Error; end
   class ExceededRetriesForConcurrentWritesError < Relix::Error; end
+  class InvalidIndexError < Relix::Error; end
 end

data/lib/relix/indexes/multi.rb

@@ -20,6 +20,11 @@ module Relix
       deindex_value(r, old_value) if index_values?
     end
 
+    def destroy(r, pk, old_value)
+      r.del(key_for(old_value))
+      r.destroy_values(r) if index_values?
+    end
+
     def eq(r, value, options={})
       r.zrange(key_for(value), *range_from_options(r, options, value))
     end
@@ -59,6 +64,10 @@ module Relix
         return "OK"
       ), [values_key, key_for(old_value)], [old_value]
     end
+
+    def destroy_value(r)
+      r.del(values_key)
+    end
   end
   register_index MultiIndex
 end

data/lib/relix/indexes/ordered.rb

@@ -23,6 +23,10 @@ module Relix
       r.zrem(sorted_set_name, pk)
     end
 
+    def destroy_all(r)
+      r.del(sorted_set_name)
+    end
+
     def create_query_clause(redis)
       QueryClause.new(redis, self)
     end

data/lib/relix/indexes/unique.rb

@@ -38,6 +38,11 @@ module Relix
       r.zrem(sorted_set_name, pk)
     end
 
+    def destroy_all(r)
+      r.del(hash_name)
+      r.del(sorted_set_name)
+    end
+
     def all(r, options={})
       r.zrange(sorted_set_name, *range_from_options(r, options))
     end

data/lib/relix/version.rb

@@ -1,5 +1,5 @@
 module Relix
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
   REDIS_VERSION = "2.6"
 
   class Version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relix
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Nathaniel Talbott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2013-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false